From 8bd1fda1a74c978cef56af0256c075d46108ea8d Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Thu, 26 Feb 2026 09:28:59 -0700 Subject: [PATCH 1/2] feat: allow CLI flags in redocly.yaml --- .changeset/yellow-meteors-rush.md | 5 ++ docs/cli.md | 1 + packages/openapi-fetch/test/redocly.yaml | 5 ++ packages/openapi-typescript/bin/cli.js | 101 ++++++++++------------- packages/openapi-typescript/package.json | 1 + pnpm-lock.yaml | 3 + 6 files changed, 60 insertions(+), 56 deletions(-) create mode 100644 .changeset/yellow-meteors-rush.md diff --git a/.changeset/yellow-meteors-rush.md b/.changeset/yellow-meteors-rush.md new file mode 100644 index 000000000..3f09c3637 --- /dev/null +++ b/.changeset/yellow-meteors-rush.md @@ -0,0 +1,5 @@ +--- +"openapi-typescript": minor +--- + +Add ability to set flags in redocly.yaml diff --git a/docs/cli.md b/docs/cli.md index 76e376afb..475f68da5 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -41,6 +41,7 @@ apis: root: ./openapi/external.yaml x-openapi-ts: output: ./openapi/external.ts + additional-properties: true # CLI flags are also supported, either in kebab-case or camelCase format ``` ::: diff --git a/packages/openapi-fetch/test/redocly.yaml b/packages/openapi-fetch/test/redocly.yaml index 6030cfa41..1f211f405 100644 --- a/packages/openapi-fetch/test/redocly.yaml +++ b/packages/openapi-fetch/test/redocly.yaml @@ -53,3 +53,8 @@ apis: root: ../../openapi-typescript/examples/stripe-api.yaml x-openapi-ts: output: ./examples/schemas/stripe.d.ts + read-write-visibility: + root: ./read-write-visibility/schemas/read-write.yaml + x-openapi-ts: + output: ./read-write-visibility/schemas/read-write.d.ts + read-write-markers: true diff --git a/packages/openapi-typescript/bin/cli.js b/packages/openapi-typescript/bin/cli.js index e07ff7b33..3fdaf3181 100755 --- a/packages/openapi-typescript/bin/cli.js +++ b/packages/openapi-typescript/bin/cli.js @@ -4,6 +4,7 @@ import fs from "node:fs"; import path from "node:path"; import { performance } from "node:perf_hooks"; import { createConfig, findConfig, loadConfig } from "@redocly/openapi-core"; +import { kebabCase } from "scule"; import parser from "yargs-parser"; import openapiTS, { astToString, COMMENT_HEADER, c, error, formatTime, warn } from "../dist/index.mjs"; @@ -71,32 +72,34 @@ if (args.includes("--root-types-keep-casing") && !args.includes("--root-types")) console.warn("--root-types-keep-casing has no effect without --root-types flag"); } +const BOOLEAN_FLAGS = [ + "additionalProperties", + "alphabetize", + "arrayLength", + "contentNever", + "defaultNonNullable", + "propertiesRequiredByDefault", + "emptyObjectsUnknown", + "enum", + "enumValues", + "conditionalEnums", + "dedupeEnums", + "check", + "excludeDeprecated", + "exportType", + "help", + "immutable", + "pathParamsAsTypes", + "rootTypes", + "rootTypesNoSchemaPrefix", + "rootTypesKeepCasing", + "makePathsEnum", + "generatePathParams", + "readWriteMarkers", +]; + const flags = parser(args, { - boolean: [ - "additionalProperties", - "alphabetize", - "arrayLength", - "contentNever", - "defaultNonNullable", - "propertiesRequiredByDefault", - "emptyObjectsUnknown", - "enum", - "enumValues", - "conditionalEnums", - "dedupeEnums", - "check", - "excludeDeprecated", - "exportType", - "help", - "immutable", - "pathParamsAsTypes", - "rootTypes", - "rootTypesNoSchemaPrefix", - "rootTypesKeepCasing", - "makePathsEnum", - "generatePathParams", - "readWriteMarkers", - ], + boolean: BOOLEAN_FLAGS, string: ["output", "redocly"], alias: { redocly: ["c"], @@ -136,36 +139,10 @@ function checkStaleOutput(current, outputPath) { /** * @param {string | URL} schema - * @param {@type import('@redocly/openapi-core').Config} redocly + * @param {@type import('@redocly/openapi-core').Config} config */ -async function generateSchema(schema, { redocly, silent = false }) { - return `${COMMENT_HEADER}${astToString( - await openapiTS(schema, { - additionalProperties: flags.additionalProperties, - alphabetize: flags.alphabetize, - arrayLength: flags.arrayLength, - contentNever: flags.contentNever, - propertiesRequiredByDefault: flags.propertiesRequiredByDefault, - defaultNonNullable: flags.defaultNonNullable, - emptyObjectsUnknown: flags.emptyObjectsUnknown, - enum: flags.enum, - enumValues: flags.enumValues, - conditionalEnums: flags.conditionalEnums, - dedupeEnums: flags.dedupeEnums, - excludeDeprecated: flags.excludeDeprecated, - exportType: flags.exportType, - immutable: flags.immutable, - pathParamsAsTypes: flags.pathParamsAsTypes, - rootTypes: flags.rootTypes, - rootTypesNoSchemaPrefix: flags.rootTypesNoSchemaPrefix, - rootTypesKeepCasing: flags.rootTypesKeepCasing, - makePathsEnum: flags.makePathsEnum, - generatePathParams: flags.generatePathParams, - readWriteMarkers: flags.readWriteMarkers, - redocly, - silent, - }), - )}`; +async function generateSchema(schema, config) { + return `${COMMENT_HEADER}${astToString(await openapiTS(schema, config))}`; } /** pretty-format error message but also throw */ @@ -241,9 +218,21 @@ async function main() { `API ${name} is missing an \`${REDOC_CONFIG_KEY}.output\` key. See https://openapi-ts.dev/cli/#multiple-schemas.`, ); } - const result = await generateSchema(new URL(api.root, configRoot), { redocly }); + + const config = { redocly }; + for (const name of BOOLEAN_FLAGS) { + if (typeof api[REDOC_CONFIG_KEY][name] === "boolean") { + config[name] = api[REDOC_CONFIG_KEY][name]; + } else if (typeof api[REDOC_CONFIG_KEY][kebabCase(name)] === "boolean") { + config[name] = api[REDOC_CONFIG_KEY][kebabCase(name)]; + } else if (typeof flags[name] === "boolean") { + config[name] = flags[name]; + } + } + const result = await generateSchema(new URL(api.root, configRoot), config); + const outFile = new URL(api[REDOC_CONFIG_KEY].output, configRoot); - checkStaleOutput(result, outFile); + checkStaleOutput(result, outFile); // check boolean flags fs.mkdirSync(new URL(".", outFile), { recursive: true }); fs.writeFileSync(outFile, result, "utf8"); done(name, api[REDOC_CONFIG_KEY].output, performance.now() - timeStart); diff --git a/packages/openapi-typescript/package.json b/packages/openapi-typescript/package.json index e94c1f3a4..6b8bd51ac 100644 --- a/packages/openapi-typescript/package.json +++ b/packages/openapi-typescript/package.json @@ -66,6 +66,7 @@ "ansi-colors": "^4.1.3", "change-case": "^5.4.4", "parse-json": "^8.3.0", + "scule": "^1.3.0", "supports-color": "^10.2.2", "yargs-parser": "^21.1.1" }, diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index adf55850b..e9a96bd57 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -252,6 +252,9 @@ importers: parse-json: specifier: ^8.3.0 version: 8.3.0 + scule: + specifier: ^1.3.0 + version: 1.3.0 supports-color: specifier: ^10.2.2 version: 10.2.2 From 2d65f08df7824dddcbae2ebd3f4f711eb920f713 Mon Sep 17 00:00:00 2001 From: Drew Powers Date: Thu, 26 Feb 2026 09:30:45 -0700 Subject: [PATCH 2/2] Update examples --- .../examples/digital-ocean-api.ts | 35152 ++-- .../DigitalOcean-public.v2.yaml | 1476 +- .../digital-ocean-api/description.yml | 1 - .../1-clicks/examples/curl/oneClicks.yml | 1 - .../1-clicks/examples/python/oneClicks.yml | 2 +- .../1-clicks/oneClicks_install_kubernetes.yml | 3 +- .../resources/1-clicks/oneClicks_list.yml | 4 +- .../resources/account/models/account.yml | 8 +- .../resources/addons/addons_create.yml | 49 + .../resources/addons/addons_delete.yml | 40 + .../resources/addons/addons_get.yml | 45 + .../resources/addons/addons_get_app.yml | 31 + .../addons/addons_get_app_metadata.yml | 44 + .../resources/addons/addons_list.yml | 32 + .../resources/addons/addons_update.yml | 61 + .../resources/addons/addons_update_plan.yml | 61 + .../addons/examples/curl/addons_create.yml | 7 + .../addons/examples/curl/addons_delete.yml | 6 + .../addons/examples/curl/addons_get.yml | 6 + .../addons/examples/curl/addons_get_app.yml | 6 + .../examples/curl/addons_get_app_metadata.yml | 6 + .../addons/examples/curl/addons_list.yml | 6 + .../addons/examples/curl/addons_update.yml | 7 + .../examples/curl/addons_update_plan.yml | 7 + .../addons/models/addons_app_info.yml | 33 + .../addons/models/addons_app_metadata.yml | 54 + .../addons_dimension_volume_with_price.yml | 32 + .../models/addons_dimension_with_price.yml | 47 + .../addons/models/addons_feature.yml | 74 + .../resources/addons/models/addons_plan.yml | 118 + .../addons/models/addons_resource.yml | 92 + .../models/addons_resource_metadata.yml | 23 + .../addons/models/addons_resource_new.yml | 45 + .../resources/addons/parameters.yml | 18 + .../addons/responses/addons_create.yml | 19 + .../resources/addons/responses/addons_get.yml | 16 + .../addons/responses/addons_get_app.yml | 18 + .../responses/addons_get_app_metadata.yml | 21 + .../addons/responses/addons_list.yml | 18 + .../addons/responses/addons_update.yml | 16 + .../apps/apps_cancel_job_invocation.yml | 41 + .../resources/apps/apps_create.yml | 5 + .../resources/apps/apps_create_deployment.yml | 2 +- .../resources/apps/apps_get_exec.yml | 5 +- .../apps/apps_get_exec_active_deployment.yml | 3 +- .../resources/apps/apps_get_health.yml | 38 + .../resources/apps/apps_get_instances.yml | 37 + .../apps/apps_get_job_invocation.yml | 41 + .../apps/apps_get_job_invocation_logs.yml | 66 + .../resources/apps/apps_list_deployments.yml | 27 + .../apps/apps_list_job_invocations.yml | 49 + .../curl/apps_cancel_job_invocation.yml | 6 + .../apps/examples/curl/apps_get_health.yml | 6 + .../examples/curl/apps_get_job_invocation.yml | 6 + .../curl/apps_get_job_invocation_logs.yml | 6 + .../curl/apps_list_job_invocations.yml | 6 + .../apps/examples/curl/get_app_instances.yml | 6 + .../python/apps_cancel_job_invocation.yml | 8 + .../python/apps_get_job_invocation.yml | 8 + .../python/apps_get_job_invocation_logs.yml | 8 + .../python/apps_list_job_invocations.yml | 8 + .../apps/examples/python/apps_update.yml | 4 +- .../resources/apps/models/app.yml | 3 + .../apps/models/app_alert_spec_rule.yml | 30 +- .../apps/models/app_component_health copy.yml | 29 + .../apps/models/app_component_health.yml | 29 + .../apps/models/app_database_spec.yml | 4 +- .../models/app_functions_component_health.yml | 20 + .../resources/apps/models/app_health.yml | 10 + .../apps/models/app_health_check_spec.yml | 54 + .../apps/models/app_health_response.yml | 4 + .../models/app_ingress_spec_rule_match.yml | 6 +- ...p_ingress_spec_rule_string_match_exact.yml | 9 + ..._ingress_spec_rule_string_match_prefix.yml | 10 + .../resources/apps/models/app_instance.yml | 22 + .../resources/apps/models/app_instances.yml | 6 + .../apps/models/app_instances_response.yml | 4 + .../apps/models/app_job_invocation.yml | 99 + .../apps/models/app_job_invocations.yml | 9 + ...estination_open_search_spec_basic_auth.yml | 1 + .../apps/models/app_maintenance_spec.yml | 2 +- .../apps/models/app_service_spec.yml | 3 + .../resources/apps/models/app_spec.yml | 34 +- .../resources/apps/models/app_worker_spec.yml | 2 + .../apps/models/apps_create_app_request.yml | 4 +- .../resources/apps/models/apps_deployment.yml | 2 +- .../resources/apps/models/apps_vpc.yml | 12 + .../apps/models/apps_vpc_egress_ip.yml | 5 + .../resources/apps/parameters.yml | 76 +- .../apps/responses/apps_get_logs.yml | 18 + .../resources/apps/responses/apps_health.yml | 17 + .../apps/responses/apps_instances.yml | 17 + .../apps/responses/cancel_job_invocation.yml | 17 + .../resources/apps/responses/examples.yml | 114 + .../apps/responses/get_job_invocation.yml | 17 + .../apps/responses/list_job_invocations.yml | 17 + .../autoscale_pool_droplet_template.yml | 16 +- .../billing/billingInsights_list.yml | 44 + .../examples/curl/billingInsights_list.yml | 6 + .../examples/python/billingInsights_list.yml | 14 + .../billing/models/billing_data_point.yml | 38 + .../resources/billing/parameters.yml | 31 +- .../billing/responses/billing_insights.yml | 64 + .../resources/billing/responses/invoice.yml | 5 +- .../byoip_prefix_list_resources.yml | 37 + .../byoip_prefixes/byoip_prefixes_create.yml | 42 + .../byoip_prefixes/byoip_prefixes_delete.yml | 41 + .../byoip_prefixes/byoip_prefixes_get.yml | 38 + .../byoip_prefixes/byoip_prefixes_list.yml | 33 + .../byoip_prefixes/byoip_prefixes_update.yml | 54 + .../curl/byoip_prefix_list_resources.yml | 4 + .../examples/curl/create_byoip_prefix.yml | 7 + .../examples/curl/delete_byoip_prefix.yml | 5 + .../examples/curl/get_byoip_prefix.yml | 4 + .../examples/curl/list_byoip_prefixes.yml | 4 + .../examples/curl/update_byoip_prefix.yml | 7 + .../go/byoip_prefix_list_resources.yml | 23 + .../examples/go/create_byoip_prefix.yml | 27 + .../examples/go/delete_byoip_prefix.yml | 18 + .../examples/go/get_byoip_prefix.yml | 19 + .../examples/go/list_byoip_prefixes.yml | 23 + .../examples/go/update_byoip_prefix.yml | 26 + .../python/byoip_prefix_list_resources.yml | 8 + .../examples/python/create_byoip_prefix.yml | 14 + .../examples/python/delete_byoip_prefix.yml | 8 + .../examples/python/get_byoip_prefix.yml | 8 + .../examples/python/list_byoip_prefixes.yml | 8 + .../examples/python/update_byoip_prefix.yml | 14 + .../byoip_prefixes/models/byoip_prefix.yml | 57 + .../models/byoip_prefix_create.yml | 19 + .../models/byoip_prefix_resource.yml | 25 + .../models/byoip_prefix_update.yml | 7 + .../resources/byoip_prefixes/parameters.yml | 10 + .../responses/byoip_prefix_create.yml | 30 + .../responses/byoip_prefix_delete.yml | 10 + .../responses/byoip_prefix_get.yml | 20 + .../responses/byoip_prefix_list.yml | 25 + .../responses/byoip_prefix_list_resources.yml | 25 + .../responses/byoip_prefix_update.yml | 20 + .../byoip_prefixes/responses/examples.yml | 70 + .../resources/databases/databases_add.yml | 2 +- .../databases/databases_add_user.yml | 19 +- .../databases/databases_create_cluster.yml | 41 +- .../databases_create_kafka_schema.yml | 63 + .../databases/databases_create_logsink.yml | 8 + .../databases/databases_create_replica.yml | 25 +- .../resources/databases/databases_delete.yml | 2 +- .../databases_delete_kafka_schema.yml | 30 + .../databases/databases_delete_user.yml | 2 +- .../databases/databases_destroy_replica.yml | 2 +- .../resources/databases/databases_get.yml | 2 +- .../databases/databases_get_autoscale.yml | 42 + .../databases_get_evictionPolicy.yml | 4 +- .../databases/databases_get_kafka_schema.yml | 29 + .../databases_get_kafka_schema_config.yml | 38 + ...abases_get_kafka_schema_subject_config.yml | 39 + .../databases_get_kafka_schema_version.yml | 29 + .../databases/databases_get_logsink.yml | 6 +- .../databases/databases_get_replica.yml | 2 +- .../databases/databases_get_user.yml | 7 +- .../resources/databases/databases_list.yml | 2 +- .../databases/databases_list_backups.yml | 2 +- .../databases_list_kafka_schemas.yml | 30 + .../databases/databases_list_logsink.yml | 4 +- .../databases/databases_list_replicas.yml | 2 +- .../databases/databases_list_users.yml | 5 +- .../databases/databases_promote_replica.yml | 2 +- .../databases/databases_set_autoscale.yml | 59 + .../databases/databases_update_autoscale.yml | 59 + .../databases_update_evictionPolicy.yml | 4 +- .../databases_update_firewall_rules.yml | 1 + .../databases_update_kafka_schema_config.yml | 59 + ...ses_update_kafka_schema_subject_config.yml | 60 + .../databases_update_onlineMigration.yml | 9 +- .../curl/databases_create_cluster.yml | 2 +- .../curl/databases_create_replica.yml | 2 +- .../examples/curl/databases_get_autoscale.yml | 6 + .../examples/curl/databases_set_autoscale.yml | 7 + .../curl/databases_update_autoscale.yml | 7 + .../examples/go/databases_create_cluster.yml | 3 + .../examples/go/databases_create_replica.yml | 6 +- .../go/databases_update_firewall_rules.yml | 1 + .../python/databases_create_cluster.yml | 8 +- .../python/databases_create_replica.yml | 6 + .../python/databases_get_autoscale.yml | 8 + .../python/databases_set_autoscale.yml | 16 + .../python/databases_update_autoscale.yml | 16 + .../databases_update_firewall_rules.yml | 3 +- .../helpers/mysql_incremental_backup.yml | 13 + .../advanced_config/kafka_advanced_config.yml | 32 +- .../advanced_config/mysql_advanced_config.yml | 4 +- .../opensearch_advanced_config.yml | 23 + .../postgres_advanced_config.yml | 13 + .../advanced_config/redis_advanced_config.yml | 29 +- .../valkey_advanced_config.yml | 121 + .../resources/databases/models/backup.yml | 5 + .../models/database_autoscale_params.yml | 18 + .../databases/models/database_cluster.yml | 28 +- .../models/database_cluster_read.yml | 187 + .../databases/models/database_config.yml | 1 + .../databases/models/database_connection.yml | 4 +- .../models/database_kafka_schema_create.yml | 27 + .../databases/models/database_replica.yml | 7 + .../models/database_replica_read.yml | 84 + .../database_storage_autoscale_params.yml | 29 + .../databases/models/database_user.yml | 2 +- .../databases/models/do_settings.yml | 20 + .../models/eviction_policy_model.yml | 2 +- .../databases/models/firewall_rule.yml | 6 +- .../databases/models/kafka_schema_verbose.yml | 31 + .../models/kafka_schema_version_verbose.yml | 35 + .../models/logsink/datadog_logsink.yml | 16 + .../models/logsink/rsyslog_logsink.yml | 18 + .../databases/models/logsink_base.yml | 9 + .../databases/models/logsink_create.yml | 3 +- .../databases/models/logsink_update.yml | 1 + .../databases/models/logsink_verbose.yml | 1 + .../databases/models/online_migration.yml | 1 + .../models/opensearch_connection.yml | 4 +- .../resources/databases/models/options.yml | 7 + .../models/schema_registry_connection.yml | 34 + .../databases/models/source_database.yml | 3 + .../databases/models/user_settings.yml | 28 + .../resources/databases/parameters.yml | 20 +- .../databases/responses/autoscale.yml | 23 + .../databases/responses/database_backups.yml | 29 + .../databases/responses/database_cluster.yml | 6 +- .../databases/responses/database_clusters.yml | 2 +- .../databases/responses/database_config.yml | 1 + .../databases/responses/database_replica.yml | 6 +- .../databases/responses/database_replicas.yml | 2 +- .../database_schema_registry_config.yml | 30 + ...atabase_schema_registry_subject_config.yml | 35 + .../databases/responses/firewall_rules.yml | 1 + .../databases/responses/kafka_schema.yml | 20 + .../responses/kafka_schema_version.yml | 21 + .../databases/responses/kafka_schemas.yml | 18 + .../resources/databases/responses/logsink.yml | 17 +- .../databases/responses/logsink_data.yml | 43 + .../databases/responses/logsink_schema.yml | 7 + .../databases/responses/logsinks.yml | 8 +- .../resources/databases/responses/options.yml | 128 +- .../domains/domains_create_record.yml | 2 + .../domains/domains_delete_record.yml | 2 + .../droplets/dropletActions_post.yml | 36 +- .../droplets/dropletActions_post_byTag.yml | 4 +- .../droplets/droplets_destroy_byTag.yml | 4 +- ...s_destroy_retryWithAssociatedResources.yml | 4 + ...stroy_withAssociatedResourcesDangerous.yml | 4 + ...stroy_withAssociatedResourcesSelective.yml | 4 + .../droplets_list_associatedResources.yml | 5 +- .../resources/droplets/models/droplet.yml | 14 +- .../droplets/models/droplet_create.yml | 11 +- .../resources/droplets/parameters.yml | 2 +- .../responses/all_droplet_backup_policies.yml | 1 + .../responses/associated_resources_list.yml | 5 + .../resources/firewalls/firewalls_update.yml | 2 + .../resources/firewalls/models/firewall.yml | 2 + .../responses/create_firewall_response.yml | 2 +- .../responses/get_firewall_response.yml | 6 +- .../responses/list_firewalls_response.yml | 4 +- .../floating_ips/floatingIPs_create.yml | 3 - .../floating_ips/models/floating_ip.yml | 3 +- .../resources/gen-ai/definitions.yml | 3475 +- .../examples/curl/genai_attach_agent.yml | 2 +- .../curl/genai_attach_agent_function.yml | 2 +- .../curl/genai_attach_agent_guardrails.yml | 18 + .../curl/genai_attach_knowledge_base.yml | 2 +- .../curl/genai_attach_knowledge_bases.yml | 14 + .../curl/genai_cancel_indexing_job.yml | 2 +- .../examples/curl/genai_create_agent.yml | 2 +- .../curl/genai_create_agent_api_key.yml | 2 +- .../curl/genai_create_anthropic_api_key.yml | 10 + ...data_source_file_upload_presigned_urls.yml | 12 + .../curl/genai_create_evaluation_dataset.yml | 14 + ...ion_dataset_file_upload_presigned_urls.yml | 12 + .../genai_create_evaluation_test_case.yml | 18 + .../curl/genai_create_indexing_job.yml | 2 +- .../curl/genai_create_knowledge_base.yml | 38 +- ...enai_create_knowledge_base_data_source.yml | 19 +- .../curl/genai_create_model_api_key.yml | 9 + .../genai_create_oauth2_dropbox_tokens.yml | 6 + .../genai_create_oauth2_google_tokens.yml | 6 + .../curl/genai_create_openai_api_key.yml | 10 + .../curl/genai_create_scheduled_indexing.yml | 14 + .../examples/curl/genai_create_workspace.yml | 13 + .../examples/curl/genai_delete_agent.yml | 2 +- .../curl/genai_delete_agent_api_key.yml | 2 +- .../curl/genai_delete_anthropic_api_key.yml | 6 + .../curl/genai_delete_knowledge_base.yml | 2 +- ...enai_delete_knowledge_base_data_source.yml | 5 +- .../curl/genai_delete_model_api_key.yml | 7 + .../curl/genai_delete_openai_api_key.yml | 6 + .../curl/genai_delete_scheduled_indexing.yml | 4 + .../examples/curl/genai_delete_workspace.yml | 6 + .../examples/curl/genai_detach_agent.yml | 2 +- .../curl/genai_detach_agent_function.yml | 2 +- .../curl/genai_detach_agent_guardrail.yml | 6 + .../curl/genai_detach_knowledge_base.yml | 2 +- .../gen-ai/examples/curl/genai_get_agent.yml | 2 +- .../curl/genai_get_agent_children.yml | 2 +- .../examples/curl/genai_get_agent_usage.yml | 6 + .../curl/genai_get_anthropic_api_key.yml | 6 + .../curl/genai_get_evaluation_run.yml | 6 + ...enai_get_evaluation_run_prompt_results.yml | 6 + .../curl/genai_get_evaluation_run_results.yml | 6 + .../curl/genai_get_evaluation_test_case.yml | 6 + .../examples/curl/genai_get_indexing_job.yml | 2 +- ...ai_get_indexing_job_details_signed_url.yml | 5 + .../curl/genai_get_knowledge_base.yml | 2 +- .../examples/curl/genai_get_oauth2_url.yml | 6 + .../curl/genai_get_openai_api_key.yml | 6 + .../curl/genai_get_scheduled_indexing.yml | 5 + .../examples/curl/genai_get_workspace.yml | 6 + .../curl/genai_list_agent_api_keys.yml | 2 +- .../curl/genai_list_agent_versions.yml | 6 + .../examples/curl/genai_list_agents.yml | 2 +- .../genai_list_agents_by_anthropic_key.yml | 6 + .../curl/genai_list_agents_by_openai_key.yml | 6 + .../curl/genai_list_agents_by_workspace.yml | 6 + .../curl/genai_list_anthropic_api_keys.yml | 6 + .../curl/genai_list_datacenter_regions.yml | 2 +- .../curl/genai_list_evaluation_metrics.yml | 6 + ...enai_list_evaluation_runs_by_test_case.yml | 6 + .../curl/genai_list_evaluation_test_cases.yml | 6 + ...ist_evaluation_test_cases_by_workspace.yml | 6 + .../genai_list_indexing_job_data_sources.yml | 2 +- .../curl/genai_list_indexing_jobs.yml | 2 +- ...i_list_indexing_jobs_by_knowledge_base.yml | 5 + ...genai_list_knowledge_base_data_sources.yml | 2 +- .../curl/genai_list_knowledge_bases.yml | 2 +- .../curl/genai_list_model_api_keys.yml | 6 + .../examples/curl/genai_list_models.yml | 2 +- .../curl/genai_list_openai_api_keys.yml | 6 + .../examples/curl/genai_list_workspaces.yml | 6 + .../curl/genai_move_agents_to_workspace.yml | 10 + .../curl/genai_regenerate_agent_api_key.yml | 2 +- .../curl/genai_regenerate_model_api_key.yml | 8 + .../curl/genai_rollback_to_agent_version.yml | 11 + .../curl/genai_run_evaluation_test_case.yml | 11 + .../examples/curl/genai_update_agent.yml | 2 +- .../curl/genai_update_agent_api_key.yml | 2 +- ...nai_update_agent_deployment_visibility.yml | 2 +- .../curl/genai_update_agent_function.yml | 2 +- .../curl/genai_update_agents_workspace.yml | 10 + .../curl/genai_update_anthropic_api_key.yml | 10 + .../curl/genai_update_attached_agent.yml | 2 +- .../genai_update_evaluation_test_case.yml | 18 + .../curl/genai_update_knowledge_base.yml | 2 +- ...enai_update_knowledge_base_data_source.yml | 12 + .../curl/genai_update_model_api_key.yml | 10 + .../curl/genai_update_openai_api_key.yml | 10 + .../examples/curl/genai_update_workspace.yml | 11 + .../resources/gen-ai/genai_attach_agent.yml | 2 +- .../gen-ai/genai_attach_agent_function.yml | 2 +- .../gen-ai/genai_attach_agent_guardrails.yml | 47 + .../gen-ai/genai_attach_knowledge_base.yml | 2 +- .../gen-ai/genai_attach_knowledge_bases.yml | 42 + .../gen-ai/genai_cancel_indexing_job.yml | 2 +- .../resources/gen-ai/genai_create_agent.yml | 2 +- .../gen-ai/genai_create_agent_api_key.yml | 2 +- .../gen-ai/genai_create_anthropic_api_key.yml | 39 + ...data_source_file_upload_presigned_urls.yml | 40 + .../genai_create_evaluation_dataset.yml | 39 + ...ion_dataset_file_upload_presigned_urls.yml | 40 + .../genai_create_evaluation_test_case.yml | 39 + .../gen-ai/genai_create_indexing_job.yml | 2 +- .../gen-ai/genai_create_knowledge_base.yml | 2 +- ...enai_create_knowledge_base_data_source.yml | 2 +- .../gen-ai/genai_create_model_api_key.yml | 39 + .../genai_create_oauth2_dropbox_tokens.yml | 41 + .../gen-ai/genai_create_openai_api_key.yml | 39 + .../genai_create_scheduled_indexing.yml | 40 + .../gen-ai/genai_create_workspace.yml | 40 + .../resources/gen-ai/genai_delete_agent.yml | 2 +- .../gen-ai/genai_delete_agent_api_key.yml | 2 +- .../gen-ai/genai_delete_anthropic_api_key.yml | 42 + .../gen-ai/genai_delete_knowledge_base.yml | 2 +- ...enai_delete_knowledge_base_data_source.yml | 2 +- .../gen-ai/genai_delete_model_api_key.yml | 42 + .../gen-ai/genai_delete_openai_api_key.yml | 42 + .../genai_delete_scheduled_indexing.yml | 43 + .../gen-ai/genai_delete_workspace.yml | 42 + .../resources/gen-ai/genai_detach_agent.yml | 2 +- .../gen-ai/genai_detach_agent_function.yml | 2 +- .../gen-ai/genai_detach_agent_guardrail.yml | 49 + .../gen-ai/genai_detach_knowledge_base.yml | 2 +- .../resources/gen-ai/genai_get_agent.yml | 4 +- .../gen-ai/genai_get_agent_children.yml | 2 +- .../gen-ai/genai_get_agent_usage.yml | 56 + .../gen-ai/genai_get_anthropic_api_key.yml | 42 + .../gen-ai/genai_get_evaluation_run.yml | 43 + ...enai_get_evaluation_run_prompt_results.yml | 49 + .../genai_get_evaluation_run_results.yml | 54 + .../gen-ai/genai_get_evaluation_test_case.yml | 49 + .../gen-ai/genai_get_indexing_job.yml | 2 +- ...ai_get_indexing_job_details_signed_url.yml | 42 + .../gen-ai/genai_get_knowledge_base.yml | 2 +- .../genai_get_oauth2_dropbox_tokens.yml | 41 + .../gen-ai/genai_get_oauth2_google_tokens.yml | 41 + .../resources/gen-ai/genai_get_oauth2_url.yml | 48 + .../gen-ai/genai_get_openai_api_key.yml | 42 + .../gen-ai/genai_get_scheduled_indexing.yml | 43 + .../resources/gen-ai/genai_get_workspace.yml | 43 + .../gen-ai/genai_list_agent_api_keys.yml | 2 +- .../gen-ai/genai_list_agent_versions.yml | 54 + .../resources/gen-ai/genai_list_agents.yml | 2 +- .../genai_list_agents_by_anthropic_key.yml | 54 + .../genai_list_agents_by_openai_key.yml | 54 + .../gen-ai/genai_list_agents_by_workspace.yml | 60 + .../gen-ai/genai_list_anthropic_api_keys.yml | 47 + .../gen-ai/genai_list_datacenter_regions.yml | 2 +- .../gen-ai/genai_list_evaluation_metrics.yml | 34 + ...enai_list_evaluation_runs_by_test_case.yml | 48 + .../genai_list_evaluation_test_cases.yml | 34 + ...ist_evaluation_test_cases_by_workspace.yml | 43 + .../genai_list_indexing_job_data_sources.yml | 2 +- .../gen-ai/genai_list_indexing_jobs.yml | 2 +- ...i_list_indexing_jobs_by_knowledge_base.yml | 43 + ...genai_list_knowledge_base_data_sources.yml | 2 +- .../gen-ai/genai_list_knowledge_bases.yml | 4 +- .../gen-ai/genai_list_model_api_keys.yml | 47 + .../resources/gen-ai/genai_list_models.yml | 6 +- .../gen-ai/genai_list_openai_api_keys.yml | 47 + .../gen-ai/genai_list_workspaces.yml | 34 + .../gen-ai/genai_move_agents_to_workspace.yml | 47 + .../gen-ai/genai_regenerate_agent_api_key.yml | 4 +- .../gen-ai/genai_regenerate_model_api_key.yml | 42 + .../genai_rollback_to_agent_version.yml | 47 + .../gen-ai/genai_run_evaluation_test_case.yml | 39 + .../resources/gen-ai/genai_update_agent.yml | 2 +- .../gen-ai/genai_update_agent_api_key.yml | 4 +- ...nai_update_agent_deployment_visibility.yml | 6 +- .../gen-ai/genai_update_agent_function.yml | 2 +- .../gen-ai/genai_update_agents_workspace.yml | 47 + .../gen-ai/genai_update_anthropic_api_key.yml | 47 + .../gen-ai/genai_update_attached_agent.yml | 2 +- .../genai_update_evaluation_test_case.yml | 47 + .../gen-ai/genai_update_knowledge_base.yml | 2 +- ...enai_update_knowledge_base_data_source.yml | 55 + .../gen-ai/genai_update_model_api_key.yml | 47 + .../gen-ai/genai_update_openai_api_key.yml | 47 + .../genai_update_scheduled_indexing.yml | 42 + .../gen-ai/genai_update_workspace.yml | 48 + .../curl/kubernetes_add_registries.yml | 7 + .../curl/kubernetes_get_status_messages.yml | 6 + .../curl/kubernetes_remove_registries.yml | 7 + .../go/kubernetes_get_status_messages.yml | 17 + .../kubernetes/kubernetes_add_nodePool.yml | 2 +- .../kubernetes/kubernetes_add_registries.yml | 39 + .../kubernetes/kubernetes_add_registry.yml | 3 +- .../kubernetes/kubernetes_delete_node.yml | 2 +- .../kubernetes/kubernetes_delete_nodePool.yml | 2 +- .../kubernetes/kubernetes_get_kubeconfig.yml | 6 + .../kubernetes_get_status_messages.yml | 43 + .../kubernetes_remove_registries.yml | 38 + .../kubernetes/kubernetes_remove_registry.yml | 4 +- .../kubernetes/kubernetes_run_clusterLint.yml | 2 +- ...amd_gpu_device_metrics_exporter_plugin.yml | 8 + .../models/amd_gpu_device_plugin.yml | 8 + .../resources/kubernetes/models/cluster.yml | 51 +- .../cluster_autoscaler_configuration.yml | 34 + .../kubernetes/models/cluster_read.yml | 194 + .../kubernetes/models/cluster_registries.yml | 8 + .../kubernetes/models/cluster_registry.yml | 11 + .../kubernetes/models/cluster_update.yml | 18 + .../models/control_plane_firewall.yml | 2 +- .../resources/kubernetes/models/node_pool.yml | 1 + .../models/nvidia_gpu_device_plugin.yml | 8 + .../resources/kubernetes/models/options.yml | 1 + .../models/rdma_shared_dev_plugin.yml | 8 + .../kubernetes/models/routing_agent.yml | 8 + .../kubernetes/models/status_messages.yml | 16 + .../resources/kubernetes/parameters.yml | 11 + .../kubernetes/responses/all_clusters.yml | 4 +- .../kubernetes/responses/examples.yml | 85 + .../kubernetes/responses/existing_cluster.yml | 4 +- .../kubernetes/responses/status_messages.yml | 20 + .../models/load_balancer_base.yml | 28 + .../monitoring/models/destination.yml | 1 + .../models/destination_omit_credentials.yml | 1 + .../monitoring/models/destination_request.yml | 1 + ...onitoring_get_database_mysql_cpu_usage.yml | 34 + ...nitoring_get_database_mysql_disk_usage.yml | 34 + ...tabase_mysql_index_vs_sequential_reads.yml | 33 + .../monitoring_get_database_mysql_load.yml | 36 + ...toring_get_database_mysql_memory_usage.yml | 34 + ...monitoring_get_database_mysql_op_rates.yml | 34 + ...ring_get_database_mysql_schema_latency.yml | 35 + ...g_get_database_mysql_schema_throughput.yml | 35 + ...ring_get_database_mysql_threads_active.yml | 31 + ...g_get_database_mysql_threads_connected.yml | 31 + ...et_database_mysql_threads_created_rate.yml | 31 + .../resources/monitoring/parameters.yml | 89 + .../nfs/examples/curl/nfs_actions_create.yml | 7 + .../nfs/examples/curl/nfs_create.yml | 7 + .../nfs/examples/curl/nfs_delete.yml | 6 + .../resources/nfs/examples/curl/nfs_get.yml | 6 + .../resources/nfs/examples/curl/nfs_list.yml | 6 + .../nfs/examples/curl/nfs_snapshot_delete.yml | 6 + .../nfs/examples/curl/nfs_snapshot_get.yml | 6 + .../nfs/examples/curl/nfs_snapshot_list.yml | 6 + .../resources/nfs/models/nfs_actions.yml | 91 + .../nfs/models/nfs_actions_response.yml | 45 + .../nfs/models/nfs_create_response.yml | 5 + .../resources/nfs/models/nfs_get_response.yml | 5 + .../nfs/models/nfs_list_response.yml | 7 + .../resources/nfs/models/nfs_request.yml | 30 + .../resources/nfs/models/nfs_response.yml | 53 + .../nfs/models/nfs_snapshot_get_response.yml | 5 + .../nfs/models/nfs_snapshot_list_response.yml | 7 + .../nfs/models/nfs_snapshot_response.yml | 44 + .../resources/nfs/nfs_actions_create.yml | 74 + .../resources/nfs/nfs_create.yml | 52 + .../resources/nfs/nfs_delete.yml | 41 + .../resources/nfs/nfs_get.yml | 41 + .../resources/nfs/nfs_list.yml | 40 + .../resources/nfs/nfs_snapshot_delete.yml | 41 + .../resources/nfs/nfs_snapshot_get.yml | 41 + .../resources/nfs/nfs_snapshot_list.yml | 43 + .../resources/nfs/parameters.yml | 61 + .../resources/nfs/responses/bad_request.yml | 17 + .../resources/nfs/responses/nfs_actions.yml | 14 + .../resources/nfs/responses/nfs_create.yml | 14 + .../resources/nfs/responses/nfs_get.yml | 30 + .../resources/nfs/responses/nfs_list.yml | 18 + .../nfs/responses/nfs_snapshot_get.yml | 16 + .../nfs/responses/nfs_snapshot_list.yml | 18 + .../partner_attachment_bgp_auth_key_get.yml | 6 + .../curl/partner_attachment_create.yml | 10 + .../curl/partner_attachment_delete.yml | 6 + .../examples/curl/partner_attachment_get.yml | 6 + .../examples/curl/partner_attachment_list.yml | 6 + .../partner_attachment_service_key_create.yml | 6 + .../partner_attachment_service_key_get.yml | 6 + .../curl/partner_attachment_update.yml | 7 + .../partner_attachment_bgp_auth_key_get.yml | 17 + .../examples/go/partner_attachment_create.yml | 31 + .../examples/go/partner_attachment_delete.yml | 17 + .../examples/go/partner_attachment_get.yml | 17 + .../examples/go/partner_attachment_list.yml | 19 + .../partner_attachment_service_key_create.yml | 15 + .../go/partner_attachment_service_key_get.yml | 15 + .../examples/go/partner_attachment_update.yml | 21 + .../partner_attachment_bgp_auth_key_get.yml | 8 + .../python/partner_attachment_create.yml | 24 + .../python/partner_attachment_delete.yml | 8 + .../python/partner_attachment_get.yml | 8 + .../python/partner_attachment_list.yml | 9 + .../partner_attachment_service_key_create.yml | 6 + .../partner_attachment_service_key_get.yml | 6 + .../python/partner_attachment_update.yml | 11 + .../models/bgp_auth_key.yml | 8 + .../models/partner_attachment.yml | 227 + .../models/remote_route.yml | 8 + .../models/service_key.yml | 20 + .../partner_network_connect/parameters.yml | 10 + .../partner_attachment_bgp_auth_key_get.yml | 41 + .../partner_attachment_create.yml | 48 + .../partner_attachment_delete.yml | 41 + .../partner_attachment_get.yml | 42 + .../partner_attachment_list.yml | 42 + .../partner_attachment_remote_routes_list.yml | 46 + .../partner_attachment_service_key_create.yml | 42 + .../partner_attachment_service_key_get.yml | 41 + .../partner_attachment_update.yml | 48 + .../all_partner_attachment_remote_routes.yml | 31 + .../responses/all_partner_attachments.yml | 57 + .../responses/empty_json_object.yml | 18 + .../responses/single_partner_attachment.yml | 35 + ...single_partner_attachment_bgp_auth_key.yml | 25 + .../single_partner_attachment_deleting.yml | 35 + .../single_partner_attachment_service_key.yml | 27 + .../projects/models/project_assignment.yml | 2 +- .../projects/projects_assign_resources.yml | 6 +- .../projects_assign_resources_default.yml | 6 +- .../projects/projects_list_resources.yml | 6 +- .../projects_list_resources_default.yml | 6 +- .../responses/assigned_resources_list.yml | 6 +- .../projects/responses/resources_list.yml | 6 +- .../resources/regions/models/region.yml | 4 +- .../examples/curl/all_registries_get.yml | 6 + .../examples/curl/registries_create.yml | 7 + .../examples/curl/registries_delete.yml | 6 + .../curl/registries_delete_repository.yml | 6 + .../registries_delete_repositoryManifest.yml | 6 + .../curl/registries_delete_repositoryTag.yml | 6 + .../registry/examples/curl/registries_get.yml | 6 + .../examples/curl/registries_get_all.yml | 6 + .../curl/registries_get_dockerCredentials.yml | 6 + .../curl/registries_get_garbageCollection.yml | 6 + .../examples/curl/registries_get_options.yml | 6 + .../curl/registries_get_subscription.yml | 6 + .../registries_list_garbageCollections.yml | 6 + .../curl/registries_list_repositoriesV2.yml | 6 + ...gistries_list_repositoriesV2_next_page.yml | 6 + .../registries_list_repositoryManifests.yml | 6 + .../curl/registries_list_repositoryTags.yml | 6 + .../curl/registries_run_garbageCollection.yml | 6 + .../registries_update_garbageCollection.yml | 6 + .../curl/registries_update_subscription.yml | 7 + .../curl/registries_validate_name.yml | 7 + .../curl/registry_run_garbageCollection.yml | 1 + .../examples/python/registries_create.yml | 14 + .../examples/python/registries_delete.yml | 8 + .../python/registries_delete_repository.yml | 8 + .../registries_delete_repositoryManifest.yml | 8 + .../registries_delete_repositoryTag.yml | 8 + .../examples/python/registries_get.yml | 8 + .../examples/python/registries_get_all.yml | 8 + .../registries_get_dockerCredentials.yml | 8 + .../registries_get_garbageCollection.yml | 8 + .../python/registries_get_options.yml | 8 + .../python/registries_get_subscription.yml | 8 + .../registries_list_garbageCollections.yml | 8 + .../python/registries_list_repositoriesV2.yml | 8 + .../registries_list_repositoryManifests.yml | 8 + .../python/registries_list_repositoryTags.yml | 8 + .../registries_run_garbageCollection.yml | 8 + .../registries_update_garbageCollection.yml | 8 + .../python/registries_update_subscription.yml | 12 + .../python/registries_validate_name.yml | 12 + .../python/registry_run_garbageCollection.yml | 7 +- .../registry/models/multiregistry.yml | 4 + .../registry/models/multiregistry_create.yml | 38 + .../resources/registry/models/registry.yml | 50 +- .../registry/models/registry_base.yml | 39 + .../registry/models/registry_run_gc.yml | 11 + .../resources/registry/registries_create.yml | 48 + .../resources/registry/registries_delete.yml | 39 + .../registry/registries_delete_repository.yml | 44 + .../registries_delete_repositoryManifest.yml | 52 + .../registries_delete_repositoryTag.yml | 50 + .../resources/registry/registries_get.yml | 39 + .../resources/registry/registries_get_all.yml | 33 + .../registries_get_dockerCredentials.yml | 61 + .../registries_get_garbageCollection.yml | 39 + .../registry/registries_get_options.yml | 44 + .../registry/registries_get_subscription.yml | 34 + .../registries_list_garbageCollections.yml | 41 + .../registries_list_repositoriesV2.yml | 46 + .../registries_list_repositoryManifests.yml | 49 + .../registries_list_repositoryTags.yml | 50 + .../registries_run_garbageCollection.yml | 59 + .../registries_update_garbageCollection.yml | 49 + .../registries_update_subscription.yml | 49 + .../registry/registries_validate_name.yml | 51 + .../resources/registry/registry_create.yml | 5 +- .../resources/registry/registry_delete.yml | 13 +- .../registry_delete_repositoryManifest.yml | 5 +- .../registry_delete_repositoryTag.yml | 5 +- .../resources/registry/registry_get.yml | 13 +- .../registry_get_dockerCredentials.yml | 5 +- .../registry_get_garbageCollection.yml | 8 +- .../registry/registry_get_options.yml | 7 +- .../registry/registry_get_subscription.yml | 8 +- .../registry_list_garbageCollections.yml | 8 +- .../registry/registry_list_repositories.yml | 5 +- .../registry/registry_list_repositoriesV2.yml | 8 +- .../registry_list_repositoryManifests.yml | 5 +- .../registry/registry_list_repositoryTags.yml | 5 +- .../registry_run_garbageCollection.yml | 15 +- .../registry_update_garbageCollection.yml | 8 +- .../registry/registry_update_subscription.yml | 11 +- .../registry/registry_validate_name.yml | 5 +- .../responses/all_registries_info.yml | 20 + .../registry/responses/multiregistry_info.yml | 17 + .../responses/registries_over_limit.yml | 17 + .../registries_precondition_fail.yml | 20 + .../reserved_ips/models/reserved_ip.yml | 5 +- .../reserved_ips/reservedIPs_create.yml | 3 - .../examples/curl/create_reserved_ipv6.yml | 7 + .../examples/curl/delete_reserved_ipv6.yml | 6 + .../examples/curl/get_reserved_ipv6.yml | 6 + .../examples/curl/list_reserved_ipv6s.yml | 6 + .../curl/post_reserved_ipv6_action.yml | 15 + .../examples/go/create_reserved_ipv6.yml | 21 + .../examples/go/delete_reserved_ipv6.yml | 17 + .../examples/go/get_reserved_ipv6.yml | 17 + .../examples/go/list_reserved_ipv6s.yml | 22 + .../examples/go/post_reserved_ipv6_action.yml | 21 + .../examples/python/create_reserved_ipv6.yml | 12 + .../examples/python/delete_reserved_ipv6.yml | 8 + .../examples/python/get_reserved_ipv6.yml | 8 + .../examples/python/list_reserved_ipv6s.yml | 8 + .../python/post_reserved_ipv6_action.yml | 12 + .../reserved_ipv6/models/reserved_ipv6.yml | 32 + .../models/reserved_ipv6_actions.yml | 36 + .../models/reserved_ipv6_create.yml | 9 + .../models/reserved_ipv6_list.yml | 30 + .../resources/reserved_ipv6/parameters.yml | 10 + .../reservedIPv6Actions_post.yml | 64 + .../reserved_ipv6/reservedIPv6_create.yml | 46 + .../reserved_ipv6/reservedIPv6_delete.yml | 47 + .../reserved_ipv6/reservedIPv6_get.yml | 40 + .../reserved_ipv6/reservedIPv6_list.yml | 38 + .../reserved_ipv6/responses/examples.yml | 149 + .../reserved_ipv6/responses/reserved_ipv6.yml | 24 + .../responses/reserved_ipv6_action.yml | 68 + .../responses/reserved_ipv6_create.yml | 40 + .../responses/reserved_ipv6_list.yml | 32 + .../resources/sizes/sizes_list.yml | 1 + .../resources/snapshots/models/snapshots.yml | 4 +- .../examples/curl/spaces_key_create.yml | 7 + .../examples/curl/spaces_key_delete.yml | 6 + .../spaces/examples/curl/spaces_key_get.yml | 6 + .../spaces/examples/curl/spaces_key_list.yml | 6 + .../spaces/examples/curl/spaces_key_patch.yml | 7 + .../examples/curl/spaces_key_update.yml | 7 + .../resources/spaces/key_create.yml | 75 + .../resources/spaces/key_delete.yml | 40 + .../resources/spaces/key_get.yml | 40 + .../resources/spaces/key_list.yml | 41 + .../resources/spaces/key_patch.yml | 55 + .../resources/spaces/key_update.yml | 55 + .../resources/spaces/models/grant.yml | 16 + .../resources/spaces/models/key.yml | 27 + .../spaces/models/key_create_response.yml | 10 + .../resources/spaces/parameters.yml | 55 + .../spaces/responses/bad_request.yml | 17 + .../resources/spaces/responses/key_create.yml | 53 + .../resources/spaces/responses/key_get.yml | 32 + .../resources/spaces/responses/key_list.yml | 35 + .../resources/spaces/responses/key_update.yml | 28 + .../resources/tags/models/tags.yml | 26 +- .../resources/tags/models/tags_resource.yml | 7 +- .../tags/responses/tags_existing.yml | 6 +- .../resources/tags/tags_assign_resources.yml | 5 +- .../resources/tags/tags_get.yml | 5 +- .../resources/tags/tags_list.yml | 6 +- .../tags/tags_unassign_resources.yml | 5 +- .../resources/uptime/create_alert.yml | 1 + .../resources/uptime/delete_alert.yml | 1 + .../resources/volumes/models/volume_base.yml | 2 +- .../volumes/models/volume_base_read.yml | 52 + .../resources/volumes/models/volume_full.yml | 4 +- .../resources/volumes/volumeActions_post.yml | 1 + .../resources/volumes/volumes_create.yml | 1 + .../volumes/volumes_delete_byName.yml | 1 + .../resources/volumes/volumes_list.yml | 2 + .../resources/vpc_nat_gateways/examples.yml | 24 + .../examples/curl/vpc_nat_gateway_create.yml | 21 + .../examples/curl/vpc_nat_gateway_delete.yml | 6 + .../examples/curl/vpc_nat_gateway_get.yml | 6 + .../examples/curl/vpc_nat_gateway_list.yml | 6 + .../examples/curl/vpc_nat_gateway_update.yml | 19 + .../models/vpc_nat_gateway_create.yml | 79 + .../models/vpc_nat_gateway_get.yml | 118 + .../models/vpc_nat_gateway_update.yml | 47 + .../resources/vpc_nat_gateways/parameters.yml | 65 + .../vpc_nat_gateways/responses/examples.yml | 86 + .../responses/vpc_nat_gateway.yml | 21 + .../responses/vpc_nat_gateway_create.yml | 21 + .../responses/vpc_nat_gateway_update.yml | 21 + .../responses/vpc_nat_gateways.yml | 26 + .../vpc_nat_gateway_create.yml | 43 + .../vpc_nat_gateway_delete.yml | 40 + .../vpc_nat_gateways/vpc_nat_gateway_get.yml | 39 + .../vpc_nat_gateways/vpc_nat_gateway_list.yml | 42 + .../vpc_nat_gateway_update.yml | 49 + .../resources/vpcs/attributes/urn.yml | 5 + .../resources/vpcs/models/vpc.yml | 18 +- .../resources/vpcs/responses/all_vpcs.yml | 4 +- .../resources/vpcs/responses/vpc_members.yml | 5 +- .../resources/vpcs/vpcs_list_members.yml | 3 + .../shared/attributes/existing_tags_array.yml | 1 + .../shared/attributes/tags_array.yml | 1 + .../shared/attributes/tags_array_read.yml | 10 + .../shared/responses/accepted.yml | 2 +- .../shared/responses/bad_request.yml | 4 +- .../shared/responses/conflict.yml | 2 +- .../shared/responses/server_error.yml | 2 +- .../shared/responses/too_many_requests.yml | 4 +- .../shared/responses/unauthorized.yml | 2 +- .../shared/responses/unexpected_error.yml | 2 +- .../shared/responses/unprocessable_entity.yml | 17 + .../github-api-export-type-immutable.ts | 138140 ++++++++------- .../examples/github-api-immutable.ts | 138132 +++++++------- .../examples/github-api-next.ts | 21027 ++- .../examples/github-api-next.yaml | 38023 ++-- .../examples/github-api-required.ts | 30440 ++-- .../examples/github-api-root-types.ts | 25511 ++- .../openapi-typescript/examples/github-api.ts | 24484 ++- .../examples/github-api.yaml | 36033 ++-- .../openapi-typescript/examples/stripe-api.ts | 13580 +- .../examples/stripe-api.yaml | 30294 +++- 786 files changed, 339661 insertions(+), 211895 deletions(-) create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app_metadata.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update_plan.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app_metadata.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update_plan.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_info.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_metadata.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_volume_with_price.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_with_price.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_feature.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_plan.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_metadata.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_new.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app_metadata.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_health.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instances.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation_logs.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_job_invocations.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_cancel_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_health.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation_logs.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_list_job_invocations.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/get_app_instances.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_cancel_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation_logs.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_list_job_invocations.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health copy.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_component_health.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_check_spec.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_exact.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instance.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocations.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc_egress_ip.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_get_logs.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_health.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_instances.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/cancel_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_job_invocation.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/list_job_invocations.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingInsights_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/curl/billingInsights_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/python/billingInsights_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/billing_data_point.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/billing_insights.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefix_list_resources.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/byoip_prefix_list_resources.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/create_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/delete_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/get_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/list_byoip_prefixes.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/update_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/byoip_prefix_list_resources.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/create_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/delete_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/get_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/list_byoip_prefixes.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/update_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/byoip_prefix_list_resources.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/create_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/delete_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/get_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/list_byoip_prefixes.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/update_byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_resource.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list_resources.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/examples.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_schema.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_schema.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_subject_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_version.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_schemas.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_set_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_subject_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_set_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_get_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_set_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/helpers/mysql_incremental_backup.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/valkey_advanced_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_autoscale_params.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_read.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_kafka_schema_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica_read.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_storage_autoscale_params.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/do_settings.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_verbose.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_version_verbose.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/datadog_logsink.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/schema_registry_connection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/autoscale.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_subject_config.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema_version.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schemas.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_data.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_schema.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_guardrails.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_bases.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_data_source_file_upload_presigned_urls.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset_file_upload_presigned_urls.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_dropbox_tokens.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_google_tokens.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_guardrail.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_usage.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_prompt_results.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_results.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_oauth2_url.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_versions.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_anthropic_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_anthropic_api_keys.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_metrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_runs_by_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases_by_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_model_api_keys.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_workspaces.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_move_agents_to_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_rollback_to_agent_version.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_run_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base_data_source.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_guardrails.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_bases.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_data_source_file_upload_presigned_urls.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset_file_upload_presigned_urls.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_oauth2_dropbox_tokens.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_guardrail.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_usage.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_prompt_results.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_results.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job_details_signed_url.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_dropbox_tokens.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_google_tokens.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_url.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_versions.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_anthropic_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_openai_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_anthropic_api_keys.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_metrics.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_runs_by_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs_by_knowledge_base.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_model_api_keys.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_openai_api_keys.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_workspaces.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_move_agents_to_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_rollback_to_agent_version.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_run_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agents_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_anthropic_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_evaluation_test_case.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base_data_source.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_model_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_openai_api_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_scheduled_indexing.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_workspace.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_add_registries.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_get_status_messages.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_remove_registries.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/go/kubernetes_get_status_messages.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registries.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_status_messages.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registries.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_metrics_exporter_plugin.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_plugin.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_autoscaler_configuration.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_read.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registry.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/nvidia_gpu_device_plugin.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/rdma_shared_dev_plugin.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/routing_agent.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/status_messages.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/status_messages.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_load.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_op_rates.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_active.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_actions_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_create_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_get_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_list_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_request.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_get_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_list_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_actions_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/bad_request.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_actions.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_bgp_auth_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_bgp_auth_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_bgp_auth_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/bgp_auth_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/partner_attachment.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/remote_route.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/service_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_bgp_auth_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_remote_routes_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachment_remote_routes.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachments.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/empty_json_object.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_bgp_auth_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_deleting.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_service_key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/all_registries_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repository.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryManifest.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryTag.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_all.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_dockerCredentials.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_options.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_subscription.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_garbageCollections.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2_next_page.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryManifests.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryTags.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_run_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_subscription.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_validate_name.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repository.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryManifest.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryTag.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_all.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_dockerCredentials.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_options.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_subscription.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_garbageCollections.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoriesV2.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryManifests.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryTags.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_run_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_subscription.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_validate_name.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_base.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_run_gc.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repository.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryManifest.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryTag.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_all.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_dockerCredentials.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_options.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_subscription.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_garbageCollections.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoriesV2.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryManifests.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryTags.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_run_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_garbageCollection.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_subscription.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_validate_name.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/all_registries_info.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/multiregistry_info.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_over_limit.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_precondition_fail.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/create_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/delete_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/get_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/list_reserved_ipv6s.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/post_reserved_ipv6_action.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/create_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/delete_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/get_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/list_reserved_ipv6s.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/post_reserved_ipv6_action.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/create_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/delete_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/get_reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/list_reserved_ipv6s.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/post_reserved_ipv6_action.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_actions.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6Actions_post.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/examples.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_action.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_patch.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_patch.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/grant.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key_create_response.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/bad_request.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base_read.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/parameters.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/examples.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateways.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_create.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_delete.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_get.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_list.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_update.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/attributes/urn.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array_read.yml create mode 100644 packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unprocessable_entity.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index b0f18c5e8..203efbc60 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -166,6 +166,126 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/add-ons/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Available Add-On Applications + * @description To fetch details of all available Add-On Applications, send a GET request to `/v2/add-ons/apps`. + */ + get: operations["addons_get_app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/add-ons/apps/{app_slug}/metadata": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Metadata for an Add-On Application + * @description To find out what metadata is required for a specific add-on, send a GET request to `/v2/add-ons/apps/{app_slug}/metadata`. + * Metadata varies by application. + */ + get: operations["addons_get_app_metadata"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/add-ons/saas": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List all Add-On Resources + * @description To fetch all Add-On Resources under your team, send a GET request to `/v2/add-ons/saas`. + */ + get: operations["addons_list"]; + put?: never; + /** + * Create/Provision a New Add-on Resource + * @description To create an add-on resource, send a POST request to `/v2/add-ons/saas` with required parameters. + * Some add-ons require additional metadata to be provided in the request body. To find out + * what metadata is required for a specific add-on, send a GET request to `/v2/add-ons/apps/{app_slug}/metadata`. + */ + post: operations["addons_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/add-ons/saas/{resource_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get details on an Add-On Resource + * @description To fetch details of a specific Add-On Resource, send a GET request to `/v2/add-ons/saas/{resource_uuid}`. + * Replace `{resource_uuid}` with the UUID of the resource you want to retrieve. + */ + get: operations["addons_get"]; + put?: never; + post?: never; + /** + * Delete/Deprovision an Add-on Resource + * @description To delete an add-on resource, send a DELETE request to `/v2/add-ons/saas/{resource_uuid}` with the UUID of the resource to delete. + * You cannot retrieve the resource after it has been deleted. The response indicates a request was sent to the 3rd party add-on provider to delete the resource. + * You will no longer be billed for this resource. + */ + delete: operations["addons_delete"]; + options?: never; + head?: never; + /** + * Update the name for an Add-On Resource + * @description To change the name of an Add-On Resource, send a PATCH request to `/v2/add-ons/saas/{resource_uuid}`. + * Replace `{resource_uuid}` with the UUID of the resource for which you want to change the name. + */ + patch: operations["addons_patch"]; + trace?: never; + }; + "/v2/add-ons/saas/{resource_uuid}/plan": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update the plan for an Add-On Resource + * @description To change the plan associated with an Add-On Resource, send a PATCH request to `/v2/add-ons/saas/{resource_uuid}/plan`. + * Replace `{resource_uuid}` with the UUID of the resource for which you want to change the plan. + */ + patch: operations["addons_patch_plan"]; + trace?: never; + }; "/v2/apps": { parameters: { query?: never; @@ -278,6 +398,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/apps/{app_id}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve App Instances + * @description Retrieve the list of running instances for a given application, including instance names and component types. Please note that these instances are ephemeral and may change over time. It is recommended not to make persistent changes or develop scripts that rely on their persistence. + */ + get: operations["apps_get_instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/apps/{app_id}/deployments": { parameters: { query?: never; @@ -391,7 +531,7 @@ export interface paths { }; /** * Retrieve Exec URL for Deployment - * @description Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. + * @description Returns a websocket URL that allows sending/receiving console input and output to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them. */ get: operations["apps_get_exec"]; put?: never; @@ -422,6 +562,86 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/apps/{app_id}/job-invocations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Job Invocations + * @description List all job invocations for an app. + */ + get: operations["apps_list_job_invocations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/apps/{app_id}/job-invocations/{job_invocation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Job Invocations + * @description Get a specific job invocation for an app. + */ + get: operations["apps_get_job_invocation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Cancel Job Invocation + * @description Cancel a specific job invocation for an app. + */ + post: operations["apps_cancel_job_invocation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Job Invocation Logs + * @description Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. If deployment is omitted the active deployment will be selected (if available). The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. + */ + get: operations["apps_get_job_invocation_logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/apps/tiers/instance_sizes": { parameters: { query?: never; @@ -672,6 +892,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/apps/{app_id}/health": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve App Health + * @description Retrieve information like health status, cpu and memory utilization of app components. + */ + get: operations["apps_get_health"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/cdn/endpoints": { parameters: { query?: never; @@ -961,6 +1201,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/billing/{account_urn}/insights/{start_date}/{end_date}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Billing Insights + * @description This endpoint returns day-over-day changes in billing resource usage based on nightly invoice items, including total amount, region, SKU, and description for a specified date range. It is important to note that the daily resource usage may not reflect month-end billing totals when totaled for a given month as nightly invoice item estimates do not necessarily encompass all invoicing factors for the entire month. + */ + get: operations["billingInsights_list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/databases/options": { parameters: { query?: never; @@ -1003,13 +1263,14 @@ export interface paths { put?: never; /** * Create a New Database Cluster - * @description To create a database cluster, send a POST request to `/v2/databases`. - * The response will be a JSON object with a key called `database`. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute will be `creating`. When the cluster is ready to receive traffic, this will transition to `online`. + * @description To create a database cluster, send a POST request to `/v2/databases`. To see a list of options for each engine, such as available regions, size slugs, and versions, send a GET request to the `/v2/databases/options` endpoint. The available sizes for the `storage_size_mib` field depends on the cluster's size. To see a list of available sizes, see [Managed Database Pricing](https://www.digitalocean.com/pricing/managed-databases). * - * The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects will contain the information needed to connect to the cluster's standby node(s). + * The create response returns a JSON object with a key called `database`. The value of this is an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute is `creating`. When the cluster is ready to receive traffic, this changes to `online`. + * + * The embedded `connection` and `private_connection` objects contains the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects contain the information needed to connect to the cluster's standby node(s). * * DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. - * Note: Backups are not supported for Redis clusters. + * Note: Caching cluster creates are no longer supported as of 2025-04-30T00:00:00Z. Backups are also not supported for Caching or Valkey clusters. */ post: operations["databases_create_cluster"]; delete?: never; @@ -1115,7 +1376,8 @@ export interface paths { get: operations["databases_get_migrationStatus"]; /** * Start an Online Migration - * @description To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, and Redis clusters. + * @description To start an online migration, send a PUT request to `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for MySQL, PostgreSQL, Caching, and Valkey clusters. + * If the existing database is continuously being written to, the migration process will continue for up to two weeks unless it is manually stopped. Online migration is only available for [MySQL](https://docs.digitalocean.com/products/databases/mysql/how-to/migrate/#:~:text=To%20migrate%20a%20MySQL%20database,then%20select%20Set%20Up%20Migration), [PostgreSQL](https://docs.digitalocean.com/products/databases/postgresql/how-to/migrate/), [Caching](https://docs.digitalocean.com/products/databases/redis/how-to/migrate/), and [Valkey](https://docs.digitalocean.com/products/databases/valkey/how-to/migrate/) clusters. */ put: operations["databases_update_onlineMigration"]; post?: never; @@ -1273,7 +1535,7 @@ export interface paths { /** * List Backups for a Database Cluster * @description To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/backups`. - * **Note**: Backups are not supported for Redis clusters. + * **Note**: Backups are not supported for Caching or Valkey clusters. * The result will be a JSON object with a `backups key`. This will be set to an array of backup objects, each of which will contain the size of the backup and the timestamp at which it was created. */ get: operations["databases_list_backups"]; @@ -1296,7 +1558,7 @@ export interface paths { * List All Read-only Replicas * @description To list all of the read-only replicas associated with a database cluster, send a GET request to `/v2/databases/$DATABASE_ID/replicas`. * - * **Note**: Read-only replicas are not supported for Redis clusters. + * **Note**: Read-only replicas are not supported for Caching or Valkey clusters. * * The result will be a JSON object with a `replicas` key. This will be set to an array of database replica objects, each of which will contain the standard database replica attributes. */ @@ -1306,7 +1568,7 @@ export interface paths { * Create a Read-only Replica * @description To create a read-only replica for a PostgreSQL or MySQL database cluster, send a POST request to `/v2/databases/$DATABASE_ID/replicas` specifying the name it should be given, the size of the node to be used, and the region where it will be located. * - * **Note**: Read-only replicas are not supported for Redis clusters. + * **Note**: Read-only replicas are not supported for Caching or Valkey clusters. * * The response will be a JSON object with a key called `replica`. The value of this will be an object that contains the standard attributes associated with a database replica. The initial value of the read-only replica's `status` attribute will be `forking`. When the replica is ready to receive traffic, this will transition to `active`. */ @@ -1351,7 +1613,7 @@ export interface paths { * Retrieve an Existing Read-only Replica * @description To show information about an existing database replica, send a GET request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. * - * **Note**: Read-only replicas are not supported for Redis clusters. + * **Note**: Read-only replicas are not supported for Caching or Valkey clusters. * * The response will be a JSON object with a `replica key`. This will be set to an object containing the standard database replica attributes. */ @@ -1362,7 +1624,7 @@ export interface paths { * Destroy a Read-only Replica * @description To destroy a specific read-only replica, send a DELETE request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. * - * **Note**: Read-only replicas are not supported for Redis clusters. + * **Note**: Read-only replicas are not supported for Caching or Valkey clusters. * * A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. */ @@ -1384,7 +1646,7 @@ export interface paths { * Promote a Read-only Replica to become a Primary Cluster * @description To promote a specific read-only replica, send a PUT request to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`. * - * **Note**: Read-only replicas are not supported for Redis clusters. + * **Note**: Read-only replicas are not supported for Caching or Valkey clusters. * * A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. */ @@ -1408,12 +1670,15 @@ export interface paths { * @description To list all of the users for your database cluster, send a GET request to * `/v2/databases/$DATABASE_ID/users`. * - * Note: User management is not supported for Redis clusters. + * Note: User management is not supported for Caching or Valkey clusters. * * The result will be a JSON object with a `users` key. This will be set to an array * of database user objects, each of which will contain the standard database user attributes. + * User passwords will not show without the `database:view_credentials` scope. * * For MySQL clusters, additional options will be contained in the mysql_settings object. + * + * For MongoDB clusters, additional information will be contained in the mongo_user_settings object */ get: operations["databases_list_users"]; put?: never; @@ -1422,7 +1687,7 @@ export interface paths { * @description To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users` * with the desired username. * - * Note: User management is not supported for Redis clusters. + * Note: User management is not supported for Caching or Valkey clusters. * * When adding a user to a MySQL cluster, additional options can be configured in the * `mysql_settings` object. @@ -1430,6 +1695,9 @@ export interface paths { * When adding a user to a Kafka cluster, additional options can be configured in * the `settings` object. * + * When adding a user to a MongoDB cluster, additional options can be configured in + * the `settings.mongo_user_settings` object. + * * The response will be a JSON object with a key called `user`. The value of this will be an * object that contains the standard attributes associated with a database user including * its randomly generated password. @@ -1453,15 +1721,18 @@ export interface paths { * @description To show information about an existing database user, send a GET request to * `/v2/databases/$DATABASE_ID/users/$USERNAME`. * - * Note: User management is not supported for Redis clusters. + * Note: User management is not supported for Caching or Valkey clusters. * * The response will be a JSON object with a `user` key. This will be set to an object - * containing the standard database user attributes. + * containing the standard database user attributes. The user's password will not show + * up unless the `database:view_credentials` scope is present. * * For MySQL clusters, additional options will be contained in the `mysql_settings` * object. * * For Kafka clusters, additional options will be contained in the `settings` object. + * + * For MongoDB clusters, additional information will be contained in the mongo_user_settings object */ get: operations["databases_get_user"]; /** @@ -1486,7 +1757,7 @@ export interface paths { * A status of 204 will be given. This indicates that the request was processed * successfully, but that no response body is needed. * - * Note: User management is not supported for Redis clusters. + * Note: User management is not supported for Caching or Valkey clusters. */ delete: operations["databases_delete_user"]; options?: never; @@ -1537,7 +1808,7 @@ export interface paths { * The result will be a JSON object with a `dbs` key. This will be set to an array * of database objects, each of which will contain the standard database attributes. * - * Note: Database management is not supported for Redis clusters. + * Note: Database management is not supported for Caching or Valkey clusters. */ get: operations["databases_list"]; put?: never; @@ -1546,7 +1817,7 @@ export interface paths { * @description To add a new database to an existing cluster, send a POST request to * `/v2/databases/$DATABASE_ID/dbs`. * - * Note: Database management is not supported for Redis clusters. + * Note: Database management is not supported for Caching or Valkey clusters. * * The response will be a JSON object with a key called `db`. The value of this will be * an object that contains the standard attributes associated with a database. @@ -1570,7 +1841,7 @@ export interface paths { * @description To show information about an existing database cluster, send a GET request to * `/v2/databases/$DATABASE_ID/dbs/$DB_NAME`. * - * Note: Database management is not supported for Redis clusters. + * Note: Database management is not supported for Caching or Valkey clusters. * * The response will be a JSON object with a `db` key. This will be set to an object * containing the standard database attributes. @@ -1586,7 +1857,7 @@ export interface paths { * A status of 204 will be given. This indicates that the request was processed * successfully, but that no response body is needed. * - * Note: Database management is not supported for Redis clusters. + * Note: Database management is not supported for Caching or Valkey clusters. */ delete: operations["databases_delete"]; options?: never; @@ -1669,14 +1940,14 @@ export interface paths { cookie?: never; }; /** - * Retrieve the Eviction Policy for a Redis Cluster - * @description To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`. + * Retrieve the Eviction Policy for a Caching or Valkey Cluster + * @description To retrieve the configured eviction policy for an existing Caching or Valkey cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`. * The response will be a JSON object with an `eviction_policy` key. This will be set to a string representing the eviction policy. */ get: operations["databases_get_evictionPolicy"]; /** - * Configure the Eviction Policy for a Redis Cluster - * @description To configure an eviction policy for an existing Redis cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. + * Configure the Eviction Policy for a Caching or Valkey Cluster + * @description To configure an eviction policy for an existing Caching or Valkey cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. */ put: operations["databases_update_evictionPolicy"]; post?: never; @@ -1733,6 +2004,32 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/{database_cluster_uuid}/autoscale": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Autoscale Configuration for a Database Cluster + * @description To retrieve the autoscale configuration for an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID/autoscale`. + * The response will be a JSON object with autoscaling configuration details. + */ + get: operations["databases_get_autoscale"]; + /** + * Configure Autoscale Settings for a Database Cluster + * @description To configure autoscale settings for an existing database cluster, send a PUT request to `/v2/databases/$DATABASE_ID/autoscale`, specifying the autoscale configuration. + * A successful request will receive a 204 No Content status code with no body in response. + */ + put: operations["databases_update_autoscale"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/databases/{database_cluster_uuid}/topics": { parameters: { query?: never; @@ -1858,6 +2155,139 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/{database_cluster_uuid}/schema-registry": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Schemas for Kafka Cluster + * @description To list all schemas for a Kafka cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/schema-registry`. + */ + get: operations["databases_list_kafka_schemas"]; + put?: never; + /** + * Create Schema Registry for Kafka Cluster + * @description To create a Kafka schema for a database cluster, send a POST request to + * `/v2/databases/$DATABASE_ID/schema-registry`. + */ + post: operations["databases_create_kafka_schema"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/databases/{database_cluster_uuid}/schema-registry/{subject_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a Kafka Schema by Subject Name + * @description To get a specific schema by subject name for a Kafka cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME`. + */ + get: operations["databases_get_kafka_schema"]; + put?: never; + post?: never; + /** + * Delete a Kafka Schema by Subject Name + * @description To delete a specific schema by subject name for a Kafka cluster, send a DELETE request to + * `/v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME`. + */ + delete: operations["databases_delete_kafka_schema"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/databases/{database_cluster_uuid}/schema-registry/{subject_name}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Kafka Schema by Subject Version + * @description To get a specific schema by subject name for a Kafka cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME/versions/$VERSION`. + */ + get: operations["databases_get_kafka_schema_version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/databases/{database_cluster_uuid}/schema-registry/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Schema Registry Configuration for a kafka Cluster + * @description To retrieve the Schema Registry configuration for a Kafka cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/schema-registry/config`. + * The response is a JSON object with a `compatibility_level` key, which is set to an object + * containing any database configuration parameters. + */ + get: operations["databases_get_kafka_schema_config"]; + /** + * Update Schema Registry Configuration for a kafka Cluster + * @description To update the Schema Registry configuration for a Kafka cluster, send a PUT request to + * `/v2/databases/$DATABASE_ID/schema-registry/config`. + * The response is a JSON object with a `compatibility_level` key, which is set to an object + * containing any database configuration parameters. + */ + put: operations["databases_update_kafka_schema_config"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/databases/{database_cluster_uuid}/schema-registry/config/{subject_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Schema Registry Configuration for a Subject of kafka Cluster + * @description To retrieve the Schema Registry configuration for a Subject of a Kafka cluster, send a GET request to + * `/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME`. + * The response is a JSON object with a `compatibility_level` key, which is set to an object + * containing any database configuration parameters. + */ + get: operations["databases_get_kafka_schema_subject_config"]; + /** + * Update Schema Registry Configuration for a Subject of kafka Cluster + * @description To update the Schema Registry configuration for a Subject of a Kafka cluster, send a PUT request to + * `/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME`. + * The response is a JSON object with a `compatibility_level` key, which is set to an object + * containing any database configuration parameters. + */ + put: operations["databases_update_kafka_schema_subject_config"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/databases/metrics/credentials": { parameters: { query?: never; @@ -2120,7 +2550,9 @@ export interface paths { * Deleting Droplets by Tag * @description To delete **all** Droplets assigned to a specific tag, include the `tag_name` * query parameter set to the name of the tag in your DELETE request. For - * example, `/v2/droplets?tag_name=$TAG_NAME`. + * example, `/v2/droplets?tag_name=$TAG_NAME`. + * + * This endpoint requires `tag:read` scope. * * A successful request will receive a 204 status code with no body in response. * This indicates that the request was processed successfully. @@ -2296,24 +2728,24 @@ export interface paths { * `/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request, * set the `type` attribute to on of the supported action types: * - * | Action | Details | - * | ---------------------------------------- | ----------- | - * | `enable_backups` | Enables backups for a Droplet | - * | `disable_backups` | Disables backups for a Droplet | - * | `change_backup_policy` | Update the backup policy for a Droplet | - * | `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | - * | `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | - * | `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | - * | `power_off` | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | - * | `power_on` | Powers on a Droplet. | - * | `restore` | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | - * | `password_reset` | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | - * | `resize` | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | - * | `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | - * | `rename` | Renames a Droplet. | - * | `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | - * | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | - * | `snapshot` | Takes a snapshot of a Droplet. | + * | Action | Details | Additionally Required Permission | + * | ---------------------------------------- | ----------- | ----------- | + * | `enable_backups` | Enables backups for a Droplet | | + * | `disable_backups` | Disables backups for a Droplet | | + * | `change_backup_policy` | Update the backup policy for a Droplet | | + * | `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | | + * | `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | | + * | `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | | + * | `power_off` | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | | + * | `power_on` | Powers on a Droplet. | | + * | `restore` | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin | + * | `password_reset` | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin | + * | `resize` | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | droplet:create | + * | `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | droplet:admin | + * | `rename` | Renames a Droplet. | | + * | `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | | + * | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | | + * | `snapshot` | Takes a snapshot of a Droplet. | image:create | */ post: operations["dropletActions_post"]; delete?: never; @@ -2346,7 +2778,7 @@ export interface paths { * - `enable_ipv6` * - `enable_backups` * - `disable_backups` - * - `snapshot` + * - `snapshot` (also requires `image:create` permission) */ post: operations["dropletActions_post_byTag"]; delete?: never; @@ -2469,6 +2901,9 @@ export interface paths { * Droplet, send a GET request to the * `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint. * + * This endpoint will only return resources that you are authorized to see. For + * example, to see associated Reserved IPs, include the `reserved_ip:read` scope. + * * The response will be a JSON object containing `snapshots`, `volumes`, and * `volume_snapshots` keys. Each will be set to an array of objects containing * information about the associated resources. @@ -2761,6 +3196,8 @@ export interface paths { * `/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation * of the firewall including existing attributes. **Note that any attributes that * are not provided will be reset to their default values.** + *

You must have read access (e.g. `droplet:read`) to all resources attached + * to the firewall to successfully update the firewall. */ put: operations["firewalls_update"]; post?: never; @@ -2909,8 +3346,6 @@ export interface paths { * * * To create a new floating IP reserved to a region, send a POST request to * `/v2/floating_ips` with the `region` attribute. - * - * **Note**: In addition to the standard rate limiting, only 12 floating IPs may be created per 60 seconds. */ post: operations["floatingIPs_create"]; delete?: never; @@ -3406,6 +3841,12 @@ export interface paths { * `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/kubeconfig?expiry_seconds=$DURATION_IN_SECONDS`. * If not set or 0, then the token will have a 7 day expiry. The query parameter * has no impact in certificate-based authentication. + * + * Kubernetes Roles granted to a user with a token-based kubeconfig are derived from that user's + * DigitalOcean role. Predefined roles (Owner, Member, Modifier etc.) have an automatic mapping + * to Kubernetes roles. Custom roles are not automatically mapped to any Kubernetes roles, + * and require [additional configuration](https://docs.digitalocean.com/products/kubernetes/how-to/set-up-custom-rolebindings/) + * by a cluster administrator. */ get: operations["kubernetes_get_kubeconfig"]; put?: never; @@ -3718,6 +4159,51 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/kubernetes/registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add Container Registries to Kubernetes Clusters + * @description To integrate the container registries with Kubernetes clusters, send a POST request to `/v2/kubernetes/registries`. + */ + post: operations["kubernetes_add_registries"]; + /** + * Remove Container Registries from Kubernetes Clusters + * @description To remove the container registries from Kubernetes clusters, send a DELETE request to `/v2/kubernetes/registries`. + */ + delete: operations["kubernetes_remove_registries"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/kubernetes/clusters/{cluster_id}/status_messages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Fetch Status Messages for a Kubernetes Cluster + * @description To retrieve status messages for a Kubernetes cluster, send a GET request to + * `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/status_messages`. Status messages inform users of any issues that come up during the cluster lifecycle. + */ + get: operations["kubernetes_get_status_messages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/load_balancers": { parameters: { query?: never; @@ -4887,6 +5373,226 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/monitoring/metrics/database/mysql/cpu_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL CPU Usage Metrics + * @description Retrieve CPU usage (percent) for a MySQL cluster. Response is a time series of cluster-level CPU usage. Use **aggregate** to get avg, max, or min over the range. + */ + get: operations["monitoring_get_database_mysql_cpu_usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/load": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Load Average Metrics + * @description Retrieve load metrics for a MySQL cluster. Use **metric** for the window: **load1** (1-minute), **load5** (5-minute), or **load15** (15-minute). Use **aggregate** to get either the average (avg) or maximum (max) over that window over the time range. + */ + get: operations["monitoring_get_database_mysql_load"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/memory_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Memory Usage Metrics + * @description Retrieve memory usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, or min) over the time range. + */ + get: operations["monitoring_get_database_mysql_memory_usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/disk_usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Disk Usage Metrics + * @description Retrieve disk usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, or min) over the time range. + */ + get: operations["monitoring_get_database_mysql_disk_usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/threads_connected": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Threads Connected Metrics + * @description Retrieve current threads connected for a MySQL service (gauge). + */ + get: operations["monitoring_get_database_mysql_threads_connected"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/threads_created_rate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Threads Created Rate Metrics + * @description Retrieve threads created rate for a MySQL service (per second). + */ + get: operations["monitoring_get_database_mysql_threads_created_rate"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/threads_active": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Threads Active Metrics + * @description Retrieve active (running) threads for a MySQL service. + */ + get: operations["monitoring_get_database_mysql_threads_active"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/index_vs_sequential_reads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Index vs Sequential Reads Metrics + * @description Retrieve index vs sequential reads ratio (percent) for a MySQL service — i.e. percentage of reads using an index. + */ + get: operations["monitoring_get_database_mysql_index_vs_sequential_reads"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/op_rates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Operations Throughput Metrics + * @description Retrieve operations rate (per second) for a MySQL service. Use **metric** to choose select, insert, update, or delete. + */ + get: operations["monitoring_get_database_mysql_op_rates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/schema_throughput": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Schema Throughput Metrics + * @description Retrieve table I/O throughput (rows per second) for a schema. Requires **schema** and **metric** (insert, fetch, update, delete). + */ + get: operations["monitoring_get_database_mysql_schema_throughput"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/monitoring/metrics/database/mysql/schema_latency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Database MySQL Schema Latency Metrics + * @description Retrieve table I/O latency (seconds) for a schema. Requires **schema** and **metric** (insert, fetch, update, delete). + */ + get: operations["monitoring_get_database_mysql_schema_latency"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/monitoring/sinks/destinations": { parameters: { query?: never; @@ -4988,6 +5694,267 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/nfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List NFS shares per region + * @description To list NFS shares, send a GET request to `/v2/nfs?region=${region}`. + * + * A successful request will return all NFS shares belonging to the authenticated user. + */ + get: operations["nfs_list"]; + put?: never; + /** + * Create a new NFS share + * @description To create a new NFS share, send a POST request to `/v2/nfs`. + */ + post: operations["nfs_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/nfs/{nfs_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an NFS share + * @description To get an NFS share, send a GET request to `/v2/nfs/{nfs_id}?region=${region}`. + * + * A successful request will return the NFS share. + */ + get: operations["nfs_get"]; + put?: never; + post?: never; + /** + * Delete an NFS share + * @description To delete an NFS share, send a DELETE request to `/v2/nfs/{nfs_id}?region=${region}`. + * + * A successful request will return a `204 No Content` status code. + */ + delete: operations["nfs_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/nfs/{nfs_id}/actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Initiate an NFS action + * @description To execute an action (such as resize) on a specified NFS share, + * send a POST request to `/v2/nfs/{nfs_id}/actions`. In the JSON body + * to the request, set the `type` attribute to on of the supported action types: + * + * | Action | Details | + * | -------------------------------- | ----------- | + * | `resize` | Resizes an NFS share. Set the size_gib attribute to a desired value in GiB | + * | `snapshot` | Takes a snapshot of an NFS share | + * | `attach` | Attaches an NFS share to a VPC. Set the vpc_id attribute to the desired VPC ID | + * | `detach` | Detaches an NFS share from a VPC. Set the vpc_id attribute to the desired VPC ID | + * | `switch_performance_tier` | Switches the performance tier of an NFS share. Set the performance_tier attribute to the desired tier (e.g., standard, high) | + */ + post: operations["nfs_create_action"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/nfs/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List NFS snapshots per region + * @description To list all NFS snapshots, send a GET request to `/v2/nfs/snapshots?region=${region}&share_id={share_id}`. + * + * A successful request will return all NFS snapshots belonging to the authenticated user in the specified region. + * + * Optionally, you can filter snapshots by a specific NFS share by including the `share_id` query parameter. + */ + get: operations["nfs_list_snapshot"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/nfs/snapshots/{nfs_snapshot_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an NFS snapshot by ID + * @description To get an NFS snapshot, send a GET request to `/v2/nfs/snapshots/{nfs_snapshot_id}?region=${region}`. + * + * A successful request will return the NFS snapshot. + */ + get: operations["nfs_get_snapshot"]; + put?: never; + post?: never; + /** + * Delete an NFS snapshot + * @description To delete an NFS snapshot, send a DELETE request to `/v2/nfs/snapshots/{nfs_snapshot_id}?region=${region}`. + * + * A successful request will return a `204 No Content` status code. + */ + delete: operations["nfs_delete_snapshot"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/partner_network_connect/attachments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List all partner attachments + * @description To list all of the Partner Attachments on your account, send a `GET` request to `/v2/partner_network_connect/attachments`. + */ + get: operations["partnerAttachments_list"]; + put?: never; + /** + * Create a new partner attachment + * @description To create a new partner attachment, send a `POST` request to + * `/v2/partner_network_connect/attachments` with a JSON object containing the + * required configuration details. + */ + post: operations["partnerAttachments_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/partner_network_connect/attachments/{pa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an existing partner attachment + * @description To get the details of a partner attachment, send a `GET` request to + * `/v2/partner_network_connect/attachments/{pa_id}`. + */ + get: operations["partnerAttachments_get"]; + put?: never; + post?: never; + /** + * Delete an existing partner attachment + * @description To delete an existing partner attachment, send a `DELETE` request to + * `/v2/partner_network_connect/attachments/{pa_id}`. + */ + delete: operations["partnerAttachments_delete"]; + options?: never; + head?: never; + /** + * Update an existing partner attachment + * @description To update an existing partner attachment, send a `PATCH` request to + * `/v2/partner_network_connect/attachments/{pa_id}` with a JSON object containing the + * fields to be updated. + */ + patch: operations["partnerAttachments_patch"]; + trace?: never; + }; + "/v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get current BGP auth key for the partner attachment + * @description To get the current BGP auth key for a partner attachment, send a `GET` request to + * `/v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key`. + */ + get: operations["partnerAttachments_get_bgp_auth_key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/partner_network_connect/attachments/{pa_id}/remote_routes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List remote routes for a partner attachment + * @description To list all remote routes associated with a partner attachment, send a `GET` request to + * `/v2/partner_network_connect/attachments/{pa_id}/remote_routes`. + */ + get: operations["partnerAttachments_list_remote_routes"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/partner_network_connect/attachments/{pa_id}/service_key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the current service key for the partner attachment + * @description To get the current service key for a partner attachment, send a `GET` request to + * `/v2/partner_network_connect/attachments/{pa_id}/service_key`. + */ + get: operations["partnerAttachments_get_service_key"]; + put?: never; + /** + * Regenerate the service key for the partner attachment + * @description This operation generates a new service key for the specified partner attachment. The operation is asynchronous, and the response is an empty JSON object returned with a 202 status code. To poll for the new service key, send a `GET` request to `/v2/partner_network_connect/attachments/{pa_id}/service_key`. + */ + post: operations["partnerAttachments_create_service_key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/projects": { parameters: { query?: never; @@ -5087,12 +6054,16 @@ export interface paths { /** * List Project Resources * @description To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. + * + * This endpoint will only return resources that you are authorized to see. For example, to see Droplets in a project, include the `droplet:read` scope. */ get: operations["projects_list_resources"]; put?: never; /** * Assign Resources to a Project * @description To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. + * + * You must have both `project:update` and `:read` scopes to assign new resources. For example, to assign a Droplet to a project, include both the `project:update` and `droplet:read` scopes. */ post: operations["projects_assign_resources"]; delete?: never; @@ -5111,12 +6082,16 @@ export interface paths { /** * List Default Project Resources * @description To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. + * + * Only resources that you are authorized to see will be returned. For example, to see Droplets in a project, include the `droplet:read` scope. */ get: operations["projects_list_resources_default"]; put?: never; /** * Assign Resources to Default Project * @description To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. + * + * You must have both project:update and :read scopes to assign new resources. For example, to assign a Droplet to the default project, include both the `project:update` and `droplet:read` scopes. */ post: operations["projects_assign_resources_default"]; delete?: never; @@ -5146,6 +6121,417 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Container Registries + * @description To get information about any container registry in your account, send a GET request to `/v2/registries/`. + */ + get: operations["registries_list"]; + put?: never; + /** + * Create Container Registry + * @description To create your container registry, send a POST request to `/v2/registries`. + * + * The `name` becomes part of the URL for images stored in the registry. For + * example, if your registry is called `example`, an image in it will have the + * URL `registry.digitalocean.com/example/image:tag`. + */ + post: operations["registries_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a Container Registry By Name + * @description To get information about any container registry in your account, send a GET request to `/v2/registries/{registry_name}`. + */ + get: operations["registries_get"]; + put?: never; + post?: never; + /** + * Delete Container Registry By Name + * @description To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registries/{registry_name}`. + */ + delete: operations["registries_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/docker-credentials": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Docker Credentials By Registry Name + * @description In order to access your container registry with the Docker client or from a + * Kubernetes cluster, you will need to configure authentication. The necessary + * JSON configuration can be retrieved by sending a GET request to + * `/v2/registries/{registry_name}/docker-credentials`. + * + * The response will be in the format of a Docker `config.json` file. To use the + * config in your Kubernetes cluster, create a Secret with: + * + * kubectl create secret generic docr \ + * --from-file=.dockerconfigjson=config.json \ + * --type=kubernetes.io/dockerconfigjson + * + * By default, the returned credentials have read-only access to your registry + * and cannot be used to push images. This is appropriate for most Kubernetes + * clusters. To retrieve read/write credentials, suitable for use with the Docker + * client or in a CI system, read_write may be provided as query parameter. For + * example: `/v2/registries/{registry_name}/docker-credentials?read_write=true` + * + * By default, the returned credentials will not expire. To retrieve credentials + * with an expiry set, expiry_seconds may be provided as a query parameter. For + * example: `/v2/registries/{registry_name}/docker-credentials?expiry_seconds=3600` will return + * credentials that expire after one hour. + */ + get: operations["registries_get_dockerCredentials"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Subscription Information + * @description A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registries/subscription`. It is similar to GET `/v2/registry/subscription`. + */ + get: operations["registries_get_subscription"]; + put?: never; + /** + * Update Subscription Tier + * @description After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registries/subscription`. It is similar to POST `/v2/registry/subscription`. + */ + post: operations["registries_update_subscription"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/options": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Registry Options (Subscription Tiers and Available Regions) + * @description This endpoint serves to provide additional information as to which option values are available when creating a container registry. + * There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. + * There are multiple regions available for container registry and controls where your data is stored. + * To list the available options, send a GET request to `/v2/registries/options`. This is similar to GET `/v2/registry/options`. + */ + get: operations["registries_get_options"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/garbage-collection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Active Garbage Collection + * @description To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. + */ + get: operations["registries_get_garbageCollection"]; + put?: never; + /** + * Start Garbage Collection + * @description Garbage collection enables users to clear out unreferenced blobs (layer & + * 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://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 + * `/v2/registries/$REGISTRY_NAME/garbage-collection`. This will initiate the + * following sequence of events on your registry. + * + * * Set the registry to read-only mode, meaning no further write-scoped + * JWTs will be issued to registry clients. Existing write-scoped JWTs will + * continue to work until they expire which can take up to 15 minutes. + * * Wait until all existing write-scoped JWTs have expired. + * * Scan all registry manifests to determine which blobs are unreferenced. + * * Delete all unreferenced blobs from the registry. + * * Record the number of blobs deleted and bytes freed, mark the garbage + * collection status as `success`. + * * Remove the read-only mode restriction from the registry, meaning write-scoped + * JWTs will once again be issued to registry clients. + */ + post: operations["registries_run_garbageCollection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/garbage-collections": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Garbage Collections + * @description To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. + */ + get: operations["registries_list_garbageCollections"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/garbage-collection/{garbage_collection_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update Garbage Collection + * @description To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. It is similar to PUT `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID`. + */ + put: operations["registries_update_garbageCollection"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/repositoriesV2": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Container Registry Repositories (V2) + * @description To list all repositories in your container registry, send a GET request to `/v2/registries/$REGISTRY_NAME/repositoriesV2`. It is similar to GET `/v2/registry/$REGISTRY_NAME/repositoriesV2`. + */ + get: operations["registries_list_repositoriesV2"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/repositories/{repository_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete Container Registry Repository + * @description To delete a container repository including all of its tags, send a DELETE request to + * `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. + */ + delete: operations["registries_delete_repository"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/repositories/{repository_name}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Container Registry Repository Tags + * @description To list all tags in one of your container registry's repository, send a GET + * request to `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. + * + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to list tags for + * `registry.digitalocean.com/example/my/repo`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/tags`. + * + * It is similar to GET `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. + */ + get: operations["registries_list_repositoryTags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/repositories/{repository_name}/tags/{repository_tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete Container Registry Repository Tag + * @description To delete a container repository tag in on of our container registries, send a DELETE request to + * `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. + * + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to delete + * `registry.digitalocean.com/example/my/repo:mytag`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/tags/mytag`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. + */ + delete: operations["registries_delete_repositoryTag"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/repositories/{repository_name}/digests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Container Registry Repository Manifests + * @description To list all manifests in your container registry repository, send a GET + * request to `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. + * + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to list manifests for + * `registry.digitalocean.com/example/my/repo`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/digests`. + * + * It is similar to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. + */ + get: operations["registries_list_repositoryManifests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/{registry_name}/repositories/{repository_name}/digests/{manifest_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete Container Registry Repository Manifest + * @description To delete a container repository manifest by digest in one of your registries, send a DELETE request to + * `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. + * + * Note that if your repository name contains `/` characters, it must be + * URL-encoded in the request URL. For example, to delete + * `registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be + * `/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. + * + * It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. + */ + delete: operations["registries_delete_repositoryManifest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/registries/validate-name": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Validate a Container Registry Name + * @description To validate that a container registry name is available for use, send a POST + * request to `/v2/registries/validate-name`. + * + * If the name is both formatted correctly and available, the response code will + * be 204 and contain no body. If the name is already in use, the response will + * be a 409 Conflict. + * + * It is similar to `/v2/registry/validate-name`. + */ + post: operations["registries_validate_name"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/registry": { parameters: { query?: never; @@ -5155,13 +6541,22 @@ export interface paths { }; /** * Get Container Registry Information - * @description To get information about your container registry, send a GET request to `/v2/registry`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To get information about your container registry, send a GET + * request to `/v2/registry`. + * + * This operation is not compatible with multiple registries in a DO account. You should use `/v2/registries/{registry_name}` instead. */ get: operations["registry_get"]; put?: never; /** * Create Container Registry - * @description To create your container registry, send a POST request to `/v2/registry`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To create your container registry, send a POST request to `/v2/registry`. * * The `name` becomes part of the URL for images stored in the registry. For * example, if your registry is called `example`, an image in it will have the @@ -5170,7 +6565,13 @@ export interface paths { post: operations["registry_create"]; /** * Delete Container Registry - * @description To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To delete your container registry, destroying all container image + * data stored in it, send a DELETE request to `/v2/registry`. + * + * This operation is not compatible with multiple registries in a DO account. You should use `/v2/registries/{registry_name}` instead. */ delete: operations["registry_delete"]; options?: never; @@ -5186,14 +6587,24 @@ export interface paths { cookie?: never; }; /** - * Get Subscription Information - * @description A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. + * Get Subscription + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * A subscription is automatically created when you configure your + * container registry. To get information about your subscription, send a GET + * request to `/v2/registry/subscription`. */ get: operations["registry_get_subscription"]; put?: never; /** * Update Subscription Tier - * @description After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * After creating your registry, you can switch to a different + * subscription tier to better suit your needs. To do this, send a POST request + * to `/v2/registry/subscription`. */ post: operations["registry_update_subscription"]; delete?: never; @@ -5211,7 +6622,10 @@ export interface paths { }; /** * Get Docker Credentials for Container Registry - * @description In order to access your container registry with the Docker client or from a + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * In order to access your container registry with the Docker client or from a * Kubernetes cluster, you will need to configure authentication. The necessary * JSON configuration can be retrieved by sending a GET request to * `/v2/registry/docker-credentials`. @@ -5254,12 +6668,15 @@ export interface paths { put?: never; /** * Validate a Container Registry Name - * @description To validate that a container registry name is available for use, send a POST - * request to `/v2/registry/validate-name`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** * - * If the name is both formatted correctly and available, the response code will - * be 204 and contain no body. If the name is already in use, the response will - * be a 409 Conflict. + * To validate that a container registry name is available for use, send a POST + * request to `/v2/registry/validate-name`. + * + * If the name is both formatted correctly and available, the response code will + * be 204 and contain no body. If the name is already in use, the response will + * be a 409 Conflict. */ post: operations["registry_validate_name"]; delete?: never; @@ -5278,7 +6695,9 @@ export interface paths { /** * List All Container Registry Repositories * @deprecated - * @description This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. * * To list all repositories in your container registry, send a GET * request to `/v2/registry/$REGISTRY_NAME/repositories`. @@ -5301,7 +6720,11 @@ export interface paths { }; /** * List All Container Registry Repositories (V2) - * @description To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To list all repositories in your container registry, send a GET + * request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. */ get: operations["registry_list_repositoriesV2"]; put?: never; @@ -5321,7 +6744,10 @@ export interface paths { }; /** * List All Container Registry Repository Tags - * @description To list all tags in your container registry repository, send a GET + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To list all tags in your container registry repository, send a GET * request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. * * Note that if your repository name contains `/` characters, it must be @@ -5350,7 +6776,10 @@ export interface paths { post?: never; /** * Delete Container Registry Repository Tag - * @description To delete a container repository tag, send a DELETE request to + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To delete a container repository tag, send a DELETE request to * `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. * * Note that if your repository name contains `/` characters, it must be @@ -5376,7 +6805,10 @@ export interface paths { }; /** * List All Container Registry Repository Manifests - * @description To list all manifests in your container registry repository, send a GET + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To list all manifests in your container registry repository, send a GET * request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. * * Note that if your repository name contains `/` characters, it must be @@ -5405,7 +6837,10 @@ export interface paths { post?: never; /** * Delete Container Registry Repository Manifest - * @description To delete a container repository manifest by digest, send a DELETE request to + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To delete a container repository manifest by digest, send a DELETE request to * `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. * * Note that if your repository name contains `/` characters, it must be @@ -5431,13 +6866,20 @@ export interface paths { }; /** * Get Active Garbage Collection - * @description To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To get information about the currently-active garbage collection + * for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. */ get: operations["registry_get_garbageCollection"]; put?: never; /** * Start Garbage Collection - * @description Garbage collection enables users to clear out unreferenced blobs (layer & + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * Garbage collection enables users to clear out unreferenced blobs (layer & * 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. @@ -5475,7 +6917,11 @@ export interface paths { }; /** * List Garbage Collections - * @description To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To get information about past garbage collections for a registry, + * send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. */ get: operations["registry_list_garbageCollections"]; put?: never; @@ -5496,7 +6942,12 @@ export interface paths { get?: never; /** * Update Garbage Collection - * @description To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. + * @deprecated + * @description **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * To cancel the currently-active garbage collection for a registry, + * send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` + * and specify one or more of the attributes below. */ put: operations["registry_update_garbageCollection"]; post?: never; @@ -5515,10 +6966,21 @@ export interface paths { }; /** * List Registry Options (Subscription Tiers and Available Regions) - * @description This endpoint serves to provide additional information as to which option values are available when creating a container registry. - * There are multiple subscription tiers available for container registry. Each tier allows a different number of image repositories to be created in your registry, and has a different amount of storage and transfer included. - * There are multiple regions available for container registry and controls where your data is stored. - * To list the available options, send a GET request to `/v2/registry/options`. + * @deprecated + * @description **Note: This endpoint is deprecated and may be removed in a future version. There is no alternative.****Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + * + * This endpoint serves to provide additional information as to which option values + * are available when creating a container registry. + * + * There are multiple subscription tiers available for container registry. Each + * tier allows a different number of image repositories to be created in your + * registry, and has a different amount of storage and transfer included. + * + * There are multiple regions available for container registry and controls + * where your data is stored. + * + * To list the available options, send a GET request to + * `/v2/registry/options`. */ get: operations["registry_get_options"]; put?: never; @@ -5577,8 +7039,6 @@ export interface paths { * * * To create a new reserved IP reserved to a region, send a POST request to * `/v2/reserved_ips` with the `region` attribute. - * - * **Note**: In addition to the standard rate limiting, only 12 reserved IPs may be created per 60 seconds. */ post: operations["reservedIPs_create"]; delete?: never; @@ -5666,7 +7126,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/sizes": { + "/v2/reserved_ipv6": { parameters: { query?: never; header?: never; @@ -5674,20 +7134,25 @@ export interface paths { cookie?: never; }; /** - * List All Droplet Sizes - * @description To list all of available Droplet sizes, send a GET request to `/v2/sizes`. - * The response will be a JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. + * List All Reserved IPv6s + * @description To list all of the reserved IPv6s available on your account, send a GET request to `/v2/reserved_ipv6`. */ - get: operations["sizes_list"]; + get: operations["reservedIPv6_list"]; put?: never; - post?: never; + /** + * Create a New Reserved IPv6 + * @description On creation, a reserved IPv6 must be reserved to a region. + * * To create a new reserved IPv6 reserved to a region, send a POST request to + * `/v2/reserved_ipv6` with the `region_slug` attribute. + */ + post: operations["reservedIPv6_create"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/snapshots": { + "/v2/reserved_ipv6/{reserved_ipv6}": { parameters: { query?: never; header?: never; @@ -5695,71 +7160,54 @@ export interface paths { cookie?: never; }; /** - * List All Snapshots - * @description To list all of the snapshots available on your account, send a GET request to - * `/v2/snapshots`. - * - * The response will be a JSON object with a key called `snapshots`. This will be - * set to an array of `snapshot` objects, each of which will contain the standard - * snapshot attributes. - * - * ### Filtering Results by Resource Type - * - * It's possible to request filtered results by including certain query parameters. - * - * #### List Droplet Snapshots - * - * To retrieve only snapshots based on Droplets, include the `resource_type` - * query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`. - * - * #### List Volume Snapshots - * - * To retrieve only snapshots based on volumes, include the `resource_type` - * query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. + * Retrieve an Existing Reserved IPv6 + * @description To show information about a reserved IPv6, send a GET request to `/v2/reserved_ipv6/$RESERVED_IPV6`. */ - get: operations["snapshots_list"]; + get: operations["reservedIPv6_get"]; put?: never; post?: never; - delete?: never; + /** + * Delete a Reserved IPv6 + * @description To delete a reserved IP and remove it from your account, send a DELETE request + * to `/v2/reserved_ipv6/$RESERVED_IPV6`. + * + * A successful request will receive a 204 status code with no body in response. + * This indicates that the request was processed successfully. + */ + delete: operations["reservedIPv6_delete"]; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/snapshots/{snapshot_id}": { + "/v2/reserved_ipv6/{reserved_ipv6}/actions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * Retrieve an Existing Snapshot - * @description To retrieve information about a snapshot, send a GET request to - * `/v2/snapshots/$SNAPSHOT_ID`. - * - * The response will be a JSON object with a key called `snapshot`. The value of - * this will be an snapshot object containing the standard snapshot attributes. - */ - get: operations["snapshots_get"]; + get?: never; put?: never; - post?: never; /** - * Delete a Snapshot - * @description Both Droplet and volume snapshots are managed through the `/v2/snapshots/` - * endpoint. To delete a snapshot, send a DELETE request to - * `/v2/snapshots/$SNAPSHOT_ID`. + * Initiate a Reserved IPv6 Action + * @description To initiate an action on a reserved IPv6 send a POST request to + * `/v2/reserved_ipv6/$RESERVED_IPV6/actions`. In the JSON body to the request, + * set the `type` attribute to on of the supported action types: * - * A status of 204 will be given. This indicates that the request was processed - * successfully, but that no response body is needed. + * | Action | Details + * |------------|-------- + * | `assign` | Assigns a reserved IPv6 to a Droplet + * | `unassign` | Unassign a reserved IPv6 from a Droplet */ - delete: operations["snapshots_delete"]; + post: operations["reservedIPv6Actions_post"]; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/tags": { + "/v2/byoip_prefixes": { parameters: { query?: never; header?: never; @@ -5767,23 +7215,27 @@ export interface paths { cookie?: never; }; /** - * List All Tags - * @description To list all of your tags, you can send a GET request to `/v2/tags`. + * List BYOIP Prefixes + * @description To list all BYOIP prefixes, send a GET request to `/v2/byoip_prefixes`. + * A successful response will return a list of all BYOIP prefixes associated with the account. */ - get: operations["tags_list"]; + get: operations["byoipPrefixes_list"]; put?: never; /** - * Create a New Tag - * @description To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. + * Create a BYOIP Prefix + * @description To create a BYOIP prefix, send a POST request to `/v2/byoip_prefixes`. + * + * A successful request will initiate the process of bringing your BYOIP Prefix into your account. + * The response will include the details of the created prefix, including its UUID and status. */ - post: operations["tags_create"]; + post: operations["byoipPrefixes_create"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/tags/{tag_id}": { + "/v2/byoip_prefixes/{byoip_prefix_uuid}": { parameters: { query?: never; header?: never; @@ -5791,49 +7243,58 @@ export interface paths { cookie?: never; }; /** - * Retrieve a Tag - * @description To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. + * Get a BYOIP Prefix + * @description To get a BYOIP prefix, send a GET request to `/v2/byoip_prefixes/$byoip_prefix_uuid`. + * + * A successful response will return the details of the specified BYOIP prefix. */ - get: operations["tags_get"]; + get: operations["byoipPrefixes_get"]; put?: never; post?: never; /** - * Delete a Tag - * @description A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag + * Delete a BYOIP Prefix + * @description To delete a BYOIP prefix and remove it from your account, send a DELETE request + * to `/v2/byoip_prefixes/$byoip_prefix_uuid`. + * + * A successful request will receive a 202 status code with no body in response. + * This indicates that the request was accepted and the prefix is being deleted. */ - delete: operations["tags_delete"]; + delete: operations["byoipPrefixes_delete"]; options?: never; head?: never; - patch?: never; + /** + * Update a BYOIP Prefix + * @description To update a BYOIP prefix, send a PATCH request to `/v2/byoip_prefixes/$byoip_prefix_uuid`. + * + * Currently, you can update the advertisement status of the prefix. + * The response will include the updated details of the prefix. + */ + patch: operations["byoipPrefixes_patch"]; trace?: never; }; - "/v2/tags/{tag_id}/resources": { + "/v2/byoip_prefixes/{byoip_prefix_uuid}/ips": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - get?: never; - put?: never; - /** - * Tag a Resource - * @description Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. - * Currently only tagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. - */ - post: operations["tags_assign_resources"]; /** - * Untag a Resource - * @description Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. - * Currently only untagging of Droplets, Databases, Images, Volumes, and Volume Snapshots is supported. `resource_type` is expected to be the string `droplet`, `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + * List BYOIP Prefix Resources + * @description To list resources associated with BYOIP prefixes, send a GET request to `/v2/byoip_prefixes/{byoip_prefix_uuid}/ips`. + * + * A successful response will return a list of resources associated with the specified BYOIP prefix. */ - delete: operations["tags_unassign_resources"]; + get: operations["byoipPrefixes_list_resources"]; + put?: never; + post?: never; + delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; - "/v2/volumes": { + "/v2/sizes": { parameters: { query?: never; header?: never; @@ -5841,16 +7302,272 @@ export interface paths { cookie?: never; }; /** - * List All Block Storage Volumes - * @description To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. - * ## Filtering Results - * ### By Region - * The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` - * ### By Name - * It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. - * **Note:** You can only create one volume per region with the same name. - * ### By Name and Region - * It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. + * List All Droplet Sizes + * @description To list all of available Droplet sizes, send a GET request to `/v2/sizes`. + * The response will be a JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. + */ + get: operations["sizes_list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Snapshots + * @description To list all of the snapshots available on your account, send a GET request to + * `/v2/snapshots`. + * + * The response will be a JSON object with a key called `snapshots`. This will be + * set to an array of `snapshot` objects, each of which will contain the standard + * snapshot attributes. + * + * ### Filtering Results by Resource Type + * + * It's possible to request filtered results by including certain query parameters. + * + * #### List Droplet Snapshots + * + * To retrieve only snapshots based on Droplets, include the `resource_type` + * query parameter set to `droplet`. For example, `/v2/snapshots?resource_type=droplet`. + * + * #### List Volume Snapshots + * + * To retrieve only snapshots based on volumes, include the `resource_type` + * query parameter set to `volume`. For example, `/v2/snapshots?resource_type=volume`. + */ + get: operations["snapshots_list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/snapshots/{snapshot_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Snapshot + * @description To retrieve information about a snapshot, send a GET request to + * `/v2/snapshots/$SNAPSHOT_ID`. + * + * The response will be a JSON object with a key called `snapshot`. The value of + * this will be an snapshot object containing the standard snapshot attributes. + */ + get: operations["snapshots_get"]; + put?: never; + post?: never; + /** + * Delete a Snapshot + * @description Both Droplet and volume snapshots are managed through the `/v2/snapshots/` + * endpoint. To delete a snapshot, send a DELETE request to + * `/v2/snapshots/$SNAPSHOT_ID`. + * + * A status of 204 will be given. This indicates that the request was processed + * successfully, but that no response body is needed. + */ + delete: operations["snapshots_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaces/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Spaces Access Keys + * @description To list Spaces Access Key, send a GET request to `/v2/spaces/keys`. Sort parameter must be used with Sort Direction. + */ + get: operations["spacesKey_list"]; + put?: never; + /** + * Create a New Spaces Access Key + * @description To create a new Spaces Access Key, send a POST request to `/v2/spaces/keys`. + * At the moment, you cannot mix a fullaccess permission with scoped permissions. + * A fullaccess permission will be prioritized if fullaccess and scoped permissions are both added. + */ + post: operations["spacesKey_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/spaces/keys/{access_key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a Spaces Access Key + * @description To get a Spaces Access Key, send a GET request to `/v2/spaces/keys/$ACCESS_KEY`. + * + * A successful request will return the Access Key. + */ + get: operations["spacesKey_get"]; + /** + * Update Spaces Access Keys + * @description To update Spaces Access Key, send a PUT or PATCH request to `/v2/spaces/keys/$ACCESS_KEY`. At the moment, you cannot convert a + * fullaccess key to a scoped key or vice versa. You can only update the name of the key. + */ + put: operations["spacesKey_update"]; + post?: never; + /** + * Delete a Spaces Access Key + * @description To delete a Spaces Access Key, send a DELETE request to `/v2/spaces/keys/$ACCESS_KEY`. + * + * A successful request will return a `204 No Content` status code. + */ + delete: operations["spacesKey_delete"]; + options?: never; + head?: never; + /** + * Update Spaces Access Keys + * @description To update Spaces Access Key, send a PUT or PATCH request to `/v2/spaces/keys/$ACCESS_KEY`. At the moment, you cannot convert a + * fullaccess key to a scoped key or vice versa. You can only update the name of the key. + */ + patch: operations["spacesKey_patch"]; + trace?: never; + }; + "/v2/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Tags + * @description To list all of your tags, you can send a GET request to `/v2/tags`. + * + * This endpoint will only return tagged resources that you are authorized to see + * (e.g. Droplets will only be returned if you have `droplet:read`). + */ + get: operations["tags_list"]; + put?: never; + /** + * Create a New Tag + * @description To create a tag you can send a POST request to `/v2/tags` with a `name` attribute. + */ + post: operations["tags_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/tags/{tag_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve a Tag + * @description To retrieve an individual tag, you can send a `GET` request to + * `/v2/tags/$TAG_NAME`. + * + * This endpoint will only return tagged resources that you are authorized to see. + * For example, to see tagged Droplets, include the `droplet:read` scope. + */ + get: operations["tags_get"]; + put?: never; + post?: never; + /** + * Delete a Tag + * @description A tag can be deleted by sending a `DELETE` request to `/v2/tags/$TAG_NAME`. Deleting a tag also untags all the resources that have previously been tagged by the Tag + */ + delete: operations["tags_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/tags/{tag_id}/resources": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Tag a Resource + * @description Resources can be tagged by sending a POST request to + * `/v2/tags/$TAG_NAME/resources` with an array of json objects containing + * `resource_id` and `resource_type` attributes. + * + * Currently only tagging of Droplets, Databases, Images, Volumes, and Volume + * Snapshots is supported. `resource_type` is expected to be the string `droplet`, + * `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected + * to be the ID of the resource as a string. + * + * In order to tag a resource, you must have both `tag:create` and `:update` scopes. For example, + * to tag a Droplet, you must have `tag:create` and `droplet:update`. + */ + post: operations["tags_assign_resources"]; + /** + * Untag a Resource + * @description Resources can be untagged by sending a DELETE request to + * `/v2/tags/$TAG_NAME/resources` with an array of json objects containing + * `resource_id` and `resource_type` attributes. + * + * Currently only untagging of Droplets, Databases, Images, Volumes, and Volume + * Snapshots is supported. `resource_type` is expected to be the string `droplet`, + * `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected + * to be the ID of the resource as a string. + * + * In order to untag a resource, you must have both `tag:delete` and `:update` scopes. For example, + * to untag a Droplet, you must have `tag:delete` and `droplet:update`. + */ + delete: operations["tags_unassign_resources"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/volumes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All Block Storage Volumes + * @description To list all of the block storage volumes available on your account, send a GET request to `/v2/volumes`. + * ## Filtering Results + * ### By Region + * The `region` may be provided as query parameter in order to restrict results to volumes available in a specific region. For example: `/v2/volumes?region=nyc1` + * ### By Name + * It is also possible to list volumes on your account that match a specified name. To do so, send a GET request with the volume's name as a query parameter to `/v2/volumes?name=$VOLUME_NAME`. + * **Note:** You can only create one volume per region with the same name. + * ### By Name and Region + * It is also possible to retrieve information about a block storage volume by name. To do so, send a GET request with the volume's name and the region slug for the region it is located in as query parameters to `/v2/volumes?name=$VOLUME_NAME®ion=nyc1`. */ get: operations["volumes_list"]; put?: never; @@ -6156,6 +7873,9 @@ export interface paths { * To only list resources of a specific type that are members of the VPC, * included a `resource_type` query parameter. For example, to only list Droplets * in the VPC, send a GET request to `/v2/vpcs/$VPC_ID/members?resource_type=droplet`. + * + * Only resources that you are authorized to see will be returned (e.g. to see Droplets, + * you must have `droplet:read`). */ get: operations["vpcs_list_members"]; put?: never; @@ -6269,6 +7989,67 @@ export interface paths { patch: operations["vpcPeerings_patch"]; trace?: never; }; + "/v2/vpc_nat_gateways": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List All VPC NAT Gateways + * @description To list all VPC NAT gateways in your team, send a GET request to `/v2/vpc_nat_gateways`. + * The response body will be a JSON object with a key of `vpc_nat_gateways` containing an array of VPC NAT gateway objects. + * These each contain the standard VPC NAT gateway attributes. + */ + get: operations["vpcnatgateways_list"]; + put?: never; + /** + * Create a New VPC NAT Gateway + * @description To create a new VPC NAT gateway, send a POST request to `/v2/vpc_nat_gateways` setting the required attributes. + * + * The response body will contain a JSON object with a key called `vpc_nat_gateway` containing the standard attributes for the new VPC NAT gateway. + */ + post: operations["vpcnatgateways_create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/vpc_nat_gateways/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing VPC NAT Gateway + * @description To show information about an individual VPC NAT gateway, send a GET request to + * `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID`. + */ + get: operations["vpcnatgateways_get"]; + /** + * Update VPC NAT Gateway + * @description To update the configuration of an existing VPC NAT Gateway, send a PUT request to + * `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID`. The request must contain a full representation + * of the VPC NAT Gateway including existing attributes. + */ + put: operations["vpcnatgateways_update"]; + post?: never; + /** + * Delete VPC NAT Gateway + * @description To destroy a VPC NAT Gateway, send a DELETE request to the `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID` endpoint. + * + * A successful response will include a 202 response code and no content. + */ + delete: operations["vpcnatgateways_delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/uptime/checks": { parameters: { query?: never; @@ -6536,6 +8317,66 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/gen-ai/agents/{agent_uuid}/guardrails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Attach Guardrails to an Agent + * @description To attach guardrails to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/guardrails`. + */ + post: operations["genai_attach_agent_guardrails"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/guardrails/{guardrail_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Detach a Guardrail from an Agent + * @description To detach a guardrail from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/guardrails/{guardrail_uuid}`. + */ + delete: operations["genai_detach_agent_guardrail"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{agent_uuid}/knowledge_bases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Attach Knowledge Bases to an Agent + * @description To attach knowledge bases to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases` + */ + post: operations["genai_attach_knowledge_bases"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}": { parameters: { query?: never; @@ -6645,8 +8486,8 @@ export interface paths { }; get?: never; /** - * Check Agent Status - * @description Check whether an agent is public or private. To get the agent status, send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. + * Update Agent Status + * @description Check whether an agent is public or private. To update the agent status, send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. */ put: operations["genai_update_agent_deployment_visibility"]; post?: never; @@ -6656,6 +8497,330 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/gen-ai/agents/{uuid}/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Agent Usage + * @description To get agent usage, send a GET request to `/v2/gen-ai/agents/{uuid}/usage`. Returns usage metrics for the specified agent within the provided time range. + */ + get: operations["genai_get_agent_usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/agents/{uuid}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Agent Versions + * @description To list all agent versions, send a GET request to `/v2/gen-ai/agents/{uuid}/versions`. + */ + get: operations["genai_list_agent_versions"]; + /** + * Rollback to Agent Version + * @description To update to a specific agent version, send a PUT request to `/v2/gen-ai/agents/{uuid}/versions`. + */ + put: operations["genai_rollback_to_agent_version"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/anthropic/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Anthropic API Keys + * @description To list all Anthropic API keys, send a GET request to `/v2/gen-ai/anthropic/keys`. + */ + get: operations["genai_list_anthropic_api_keys"]; + put?: never; + /** + * Create Anthropic API Key + * @description To create an Anthropic API key, send a POST request to `/v2/gen-ai/anthropic/keys`. + */ + post: operations["genai_create_anthropic_api_key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/anthropic/keys/{api_key_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Anthropic API Key + * @description To retrieve details of an Anthropic API key, send a GET request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. + */ + get: operations["genai_get_anthropic_api_key"]; + /** + * Update Anthropic API Key + * @description To update an Anthropic API key, send a PUT request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. + */ + put: operations["genai_update_anthropic_api_key"]; + post?: never; + /** + * Delete Anthropic API Key + * @description To delete an Anthropic API key, send a DELETE request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. + */ + delete: operations["genai_delete_anthropic_api_key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/anthropic/keys/{uuid}/agents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List agents by Anthropic key + * @description List Agents by Anthropic Key. + */ + get: operations["genai_list_agents_by_anthropic_key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_datasets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create Evaluation Dataset + * @description To create an evaluation dataset, send a POST request to `/v2/gen-ai/evaluation_datasets`. + */ + post: operations["genai_create_evaluation_dataset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create Presigned URLs for Evaluation Dataset File Upload + * @description To create presigned URLs for evaluation dataset file upload, send a POST request to `/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls`. + */ + post: operations["genai_create_evaluation_dataset_file_upload_presigned_urls"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Evaluation Metrics + * @description To list all evaluation metrics, send a GET request to `/v2/gen-ai/evaluation_metrics`. + */ + get: operations["genai_list_evaluation_metrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Run an Evaluation Test Case + * @description To run an evaluation test case, send a POST request to `/v2/gen-ai/evaluation_runs`. + */ + post: operations["genai_run_evaluation_test_case"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Information About an Existing Evaluation Run + * @description To retrive information about an existing evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}`. + */ + get: operations["genai_get_evaluation_run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Results of an Evaluation Run + * @description To retrieve results of an evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results`. + */ + get: operations["genai_get_evaluation_run_results"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Results of an Evaluation Run Prompt + * @description To retrieve results of an evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}`. + */ + get: operations["genai_get_evaluation_run_prompt_results"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_test_cases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Evaluation Test Cases + * @description To list all evaluation test cases, send a GET request to `/v2/gen-ai/evaluation_test_cases`. + */ + get: operations["genai_list_evaluation_test_cases"]; + put?: never; + /** + * Create Evaluation Test Case. + * @description To create an evaluation test-case send a POST request to `/v2/gen-ai/evaluation_test_cases`. + */ + post: operations["genai_create_evaluation_test_case"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Evaluation Runs by Test Case + * @description To list all evaluation runs by test case, send a GET request to `/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs`. + */ + get: operations["genai_list_evaluation_runs_by_test_case"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/evaluation_test_cases/{test_case_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Information About an Existing Evaluation Test Case + * @description To retrive information about an existing evaluation test case, send a GET request to `/v2/gen-ai/evaluation_test_case/{test_case_uuid}`. + */ + get: operations["genai_get_evaluation_test_case"]; + /** + * Update an Evaluation Test Case. + * @description To update an evaluation test-case send a PUT request to `/v2/gen-ai/evaluation_test_cases/{test_case_uuid}`. + */ + put: operations["genai_update_evaluation_test_case"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/gen-ai/indexing_jobs": { parameters: { query?: never; @@ -6700,6 +8865,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/details_signed_url": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Signed URL for Indexing Job Details + * @description To get a signed URL for indexing job details, send a GET request to `/v2/gen-ai/indexing_jobs/{uuid}/details_signed_url`. + */ + get: operations["genai_get_indexing_job_details_signed_url"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/gen-ai/indexing_jobs/{uuid}": { parameters: { query?: never; @@ -6749,7 +8934,7 @@ export interface paths { }; /** * List Knowledge Bases - * @description To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. + * @description To list all knowledge bases, send a GET request to `/v2/gen-ai/knowledge_bases`. */ get: operations["genai_list_knowledge_bases"]; put?: never; @@ -6764,6 +8949,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create Presigned URLs for Data Source File Upload + * @description To create presigned URLs for knowledge base data source file upload, send a POST request to `/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls`. + */ + post: operations["genai_create_data_source_file_upload_presigned_urls"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources": { parameters: { query?: never; @@ -6796,7 +9001,11 @@ export interface paths { cookie?: never; }; get?: never; - put?: never; + /** + * Update Data Source options + * @description To update a data source (e.g. chunking options), send a PUT request to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}`. + */ + put: operations["genai_update_knowledge_base_data_source"]; post?: never; /** * Delete a Data Source from a Knowledge Base @@ -6808,6 +9017,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Indexing Jobs for a Knowledge Base + * @description To list latest 15 indexing jobs for a knowledge base, send a GET request to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs`. + */ + get: operations["genai_list_indexing_jobs_by_knowledge_base"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/gen-ai/knowledge_bases/{uuid}": { parameters: { query?: never; @@ -6856,7 +9085,7 @@ export interface paths { patch?: never; trace?: never; }; - "/v2/gen-ai/regions": { + "/v2/gen-ai/models/api_keys": { parameters: { query?: never; header?: never; @@ -6864,159 +9093,497 @@ export interface paths { cookie?: never; }; /** - * List Datacenter Regions - * @description To list all datacenter regions, send a GET request to `/v2/gen-ai/regions`. + * List Model API Keys + * @description To list all model API keys, send a GET request to `/v2/gen-ai/models/api_keys`. */ - get: operations["genai_list_datacenter_regions"]; + get: operations["genai_list_model_api_keys"]; put?: never; - post?: never; + /** + * Create a Model API Key + * @description To create a model API key, send a POST request to `/v2/gen-ai/models/api_keys`. + */ + post: operations["genai_create_model_api_key"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; -} -export type webhooks = Record; -export interface components { - schemas: { - error: { - /** - * @description A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found." - * @example not_found - */ - id: string; - /** - * @description A message providing additional information about the error, including details to help resolve it when possible. - * @example The resource you were accessing could not be found. - */ - message: string; - /** - * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. - * @example 4d9d8375-3c56-4925-a3e7-eb137fed17e9 - */ - request_id?: string; + "/v2/gen-ai/models/api_keys/{api_key_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - oneClicks: { - /** - * slug - * @description The slug identifier for the 1-Click application. - * @example monitoring - */ - slug: string; - /** - * type - * @description The type of the 1-Click application. - * @example kubernetes - */ - type: string; + get?: never; + /** + * Update API Key for a Model + * @description To update a model API key, send a PUT request to `/v2/gen-ai/models/api_keys/{api_key_uuid}`. + */ + put: operations["genai_update_model_api_key"]; + post?: never; + /** + * Delete API Key for a Model + * @description To delete an API key for a model, send a DELETE request to `/v2/gen-ai/models/api_keys/{api_key_uuid}`. + */ + delete: operations["genai_delete_model_api_key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - oneClicks_create: { - /** - * addon_slugs - * @description An array of 1-Click Application slugs to be installed to the Kubernetes cluster. - * @default [] - * @example [ - * "kube-state-metrics", - * "loki" - * ] - */ - addon_slugs: string[]; - /** - * cluster_uuid - * @description A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed. - * @example 50a994b6-c303-438f-9495-7e896cfe6b08 - */ - cluster_uuid: string; + get?: never; + /** + * Regenerate API Key for a Model + * @description To regenerate a model API key, send a PUT request to `/v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate`. + */ + put: operations["genai_regenerate_model_api_key"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/oauth2/dropbox/tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - account: { - /** - * @description The total number of Droplets current user or team may have active at one time. - * @example 25 - */ - droplet_limit: number; - /** - * @description The total number of Floating IPs the current user or team may have. - * @example 5 - */ - floating_ip_limit: number; - /** - * @description The email address used by the current user to register for DigitalOcean. - * @example sammy@digitalocean.com - */ - email: string; - /** - * @description The display name for the current user. - * @example Sammy the Shark - */ - name?: string; - /** - * @description The unique universal identifier for the current user. - * @example b6fr89dbf6d9156cace5f3c78dc9851d957381ef - */ - uuid: string; - /** - * @description If true, the user has verified their account via email. False otherwise. - * @default false - * @example true - */ - email_verified: boolean; - /** - * @description This value is one of "active", "warning" or "locked". - * @default active - * @example active - * @enum {string} - */ - status: "active" | "warning" | "locked"; - /** - * @description A human-readable message giving more details about the status of the account. - * @example - */ - status_message: string; - /** @description When authorized in a team context, includes information about the current team. */ - team?: { - /** - * @description The unique universal identifier for the current team. - * @example 5df3e3004a17e242b7c20ca6c9fc25b701a47ece - */ - uuid?: string; - /** - * @description The name for the current team. - * @example My Team - */ - name?: string; - }; + get?: never; + put?: never; + /** + * Get Oauth2 Dropbox Tokens + * @description To obtain the refresh token, needed for creation of data sources, send a GET request to `/v2/gen-ai/oauth2/dropbox/tokens`. Pass the code you obtrained from the oauth flow in the field 'code' + */ + post: operations["genai_create_oauth2_dropbox_tokens"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/oauth2/url": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * @description A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. - * @example 512189 + * Get Oauth2 URL + * @description To generate an Oauth2-URL for use with your localhost, send a GET request to `/v2/gen-ai/oauth2/url`. Pass 'http://localhost:3000 as redirect_url */ - ssh_key_id: number; + get: operations["genai_get_oauth2_url"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/openai/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * @description A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. - * @example 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa + * List OpenAI API Keys + * @description To list all OpenAI API keys, send a GET request to `/v2/gen-ai/openai/keys`. */ - ssh_key_fingerprint: string; + get: operations["genai_list_openai_api_keys"]; + put?: never; /** - * @description A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. - * @example My SSH Public Key + * Create OpenAI API Key + * @description To create an OpenAI API key, send a POST request to `/v2/gen-ai/openai/keys`. */ - ssh_key_name: string; - sshKeys: { - id?: components["schemas"]["ssh_key_id"]; - fingerprint?: components["schemas"]["ssh_key_fingerprint"]; - /** - * @description The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. - * @example ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example - */ - public_key: string; - name: components["schemas"]["ssh_key_name"]; + post: operations["genai_create_openai_api_key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/openai/keys/{api_key_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - link_to_last_page: { - /** - * @description URI of the last page of the results. - * @example https://api.digitalocean.com/v2/images?page=2 - */ + /** + * Get OpenAI API Key + * @description To retrieve details of an OpenAI API key, send a GET request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. + */ + get: operations["genai_get_openai_api_key"]; + /** + * Update OpenAI API Key + * @description To update an OpenAI API key, send a PUT request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. + */ + put: operations["genai_update_openai_api_key"]; + post?: never; + /** + * Delete OpenAI API Key + * @description To delete an OpenAI API key, send a DELETE request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. + */ + delete: operations["genai_delete_openai_api_key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/openai/keys/{uuid}/agents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List agents by OpenAI key + * @description List Agents by OpenAI Key. + */ + get: operations["genai_list_agents_by_openai_key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/regions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Datacenter Regions + * @description To list all datacenter regions, send a GET request to `/v2/gen-ai/regions`. + */ + get: operations["genai_list_datacenter_regions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/scheduled-indexing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create scheduled indexing for knowledge base + * @description To create scheduled indexing for a knowledge base, send a POST request to `/v2/gen-ai/scheduled-indexing`. + */ + post: operations["genai_create_scheduled_indexing"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get Scheduled Indexing for Knowledge Base + * @description Get Scheduled Indexing for knowledge base using knoweldge base uuid, send a GET request to `/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}`. + */ + get: operations["genai_get_scheduled_indexing"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/scheduled-indexing/{uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete Scheduled Indexing + * @description Delete Scheduled Indexing for knowledge base, send a DELETE request to `/v2/gen-ai/scheduled-indexing/{uuid}`. + */ + delete: operations["genai_delete_scheduled_indexing"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/workspaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Workspaces + * @description To list all workspaces, send a GET request to `/v2/gen-ai/workspaces`. + */ + get: operations["genai_list_workspaces"]; + put?: never; + /** + * Create a Workspace + * @description To create a new workspace, send a POST request to `/v2/gen-ai/workspaces`. The response body contains a JSON object with the newly created workspace object. + */ + post: operations["genai_create_workspace"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/workspaces/{workspace_uuid}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an Existing Workspace + * @description To retrieve details of a workspace, GET request to `/v2/gen-ai/workspaces/{workspace_uuid}`. The response body is a JSON object containing the workspace. + */ + get: operations["genai_get_workspace"]; + /** + * Update a Workspace + * @description To update a workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}`. The response body is a JSON object containing the workspace. + */ + put: operations["genai_update_workspace"]; + post?: never; + /** + * Delete a Workspace + * @description To delete a workspace, send a DELETE request to `/v2/gen-ai/workspace/{workspace_uuid}`. + */ + delete: operations["genai_delete_workspace"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/workspaces/{workspace_uuid}/agents": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List agents by Workspace + * @description To list all agents by a Workspace, send a GET request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. + */ + get: operations["genai_list_agents_by_workspace"]; + /** + * Move Agents to a Workspace + * @description To move all listed agents a given workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. + */ + put: operations["genai_update_agents_workspace"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Evaluation Test Cases by Workspace + * @description To list all evaluation test cases by a workspace, send a GET request to `/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases`. + */ + get: operations["genai_list_evaluation_test_cases_by_workspace"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; +} +export type webhooks = Record; +export interface components { + schemas: { + error: { + /** + * @description A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found." + * @example not_found + */ + id: string; + /** + * @description A message providing additional information about the error, including details to help resolve it when possible. + * @example The resource you were accessing could not be found. + */ + message: string; + /** + * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. + * @example 4d9d8375-3c56-4925-a3e7-eb137fed17e9 + */ + request_id?: string; + }; + oneClicks: { + /** + * slug + * @description The slug identifier for the 1-Click application. + * @example monitoring + */ + slug: string; + /** + * type + * @description The type of the 1-Click application. + * @example kubernetes + */ + type: string; + }; + oneClicks_create: { + /** + * addon_slugs + * @description An array of 1-Click Application slugs to be installed to the Kubernetes cluster. + * @default [] + * @example [ + * "kube-state-metrics", + * "loki" + * ] + */ + addon_slugs: string[]; + /** + * cluster_uuid + * @description A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed. + * @example 50a994b6-c303-438f-9495-7e896cfe6b08 + */ + cluster_uuid: string; + }; + account: { + /** + * @description The total number of Droplets current user or team may have active at one time. + *

Requires `droplet:read` scope. + * @example 25 + */ + droplet_limit: number; + /** + * @description The total number of Floating IPs the current user or team may have. + *

Requires `reserved_ip:read` scope. + * @example 5 + */ + floating_ip_limit: number; + /** + * @description The email address used by the current user to register for DigitalOcean. + * @example sammy@digitalocean.com + */ + email: string; + /** + * @description The display name for the current user. + * @example Sammy the Shark + */ + name?: string; + /** + * @description The unique universal identifier for the current user. + * @example b6fr89dbf6d9156cace5f3c78dc9851d957381ef + */ + uuid: string; + /** + * @description If true, the user has verified their account via email. False otherwise. + * @default false + * @example true + */ + email_verified: boolean; + /** + * @description This value is one of "active", "warning" or "locked". + * @default active + * @example active + * @enum {string} + */ + status: "active" | "warning" | "locked"; + /** + * @description A human-readable message giving more details about the status of the account. + * @example + */ + status_message: string; + /** @description When authorized in a team context, includes information about the current team. */ + team?: { + /** + * @description The unique universal identifier for the current team. + * @example 5df3e3004a17e242b7c20ca6c9fc25b701a47ece + */ + uuid?: string; + /** + * @description The name for the current team. + * @example My Team + */ + name?: string; + }; + }; + /** + * @description A unique identification number for this key. Can be used to embed a specific SSH key into a Droplet. + * @example 512189 + */ + ssh_key_id: number; + /** + * @description A unique identifier that differentiates this key from other keys using a format that SSH recognizes. The fingerprint is created when the key is added to your account. + * @example 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa + */ + ssh_key_fingerprint: string; + /** + * @description A human-readable display name for this key, used to easily identify the SSH keys when they are displayed. + * @example My SSH Public Key + */ + ssh_key_name: string; + sshKeys: { + id?: components["schemas"]["ssh_key_id"]; + fingerprint?: components["schemas"]["ssh_key_fingerprint"]; + /** + * @description The entire public key string that was uploaded. Embedded into the root user's `authorized_keys` file if you include this key during Droplet creation. + * @example ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example + */ + public_key: string; + name: components["schemas"]["ssh_key_name"]; + }; + link_to_last_page: { + /** + * @description URI of the last page of the results. + * @example https://api.digitalocean.com/v2/images?page=2 + */ last?: string; }; link_to_next_page: { @@ -7090,14 +9657,14 @@ export interface components { * "image_transfer" * ] */ - features: unknown; + features: string[]; /** * @description This is a boolean value that represents whether new Droplets can be created in this region. * @example true */ available: boolean; /** - * @description This attribute is set to an array which contains the identifying slugs for the sizes available in this region. + * @description This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view. * @example [ * "s-1vcpu-1gb", * "s-1vcpu-2gb", @@ -7115,7 +9682,7 @@ export interface components { * "s-32vcpu-192g" * ] */ - sizes: unknown; + sizes: string[]; }; action: { /** @@ -7164,6 +9731,401 @@ export interface components { */ region_slug?: string | null; }; + addons_feature: { + /** + * id + * @description Unique identifier for the app feature. + * @example 1 + */ + id: number; + /** + * name + * @description Name of the feature. + * @example Support + */ + name: string; + /** + * type + * @description Feature type, indicating the kind of data it holds. + * @example string + * @enum {string} + */ + type: "unknown" | "string" | "boolean" | "allowance"; + /** + * unit + * @description Unit of measurement for the feature, if applicable. Units apply to allowance features. + * @example GB + * @enum {string} + */ + unit?: "unit_unknown" | "GB" | "GIB" | "count" | "byte" | "byte_second"; + /** + * @description Value of the feature, which can vary based on the type. + * @example Unlimited + */ + value: string | boolean; + /** + * created_at + * Format: date-time + * @description Timestamp when the feature was created. + * @example 2023-10-01T12:00:00Z + */ + created_at: string; + /** + * updated_at + * Format: date-time + * @description Timestamp when the feature was last updated. + * @example 2023-10-01T12:00:00Z + */ + updated_at: string; + }; + addons_dimension_volume_with_price: { + /** + * id + * @description Unique identifier for the addon. + * @example 123 + */ + id: number; + /** + * low_volume + * @description The minimum volume for the volume pricing tier. + * @example 1 + */ + low_volume: number; + /** + * max_volume + * @description The maximum volume for the volume pricing tier. + * @example 100 + */ + max_volume: number; + /** + * price_per_unit + * @description The price per unit for the volume tier in US dollars. + * @example 0.10 + */ + price_per_unit: string; + }; + addons_dimension_with_price: { + /** + * id + * @description Unique identifier for the dimension. + * @example 1 + */ + id: number; + /** + * sku + * @description Unique string identifier for the dimension, tied to a price. + * @example addon_sku_123 + */ + sku: string; + /** + * slug + * @description Slug identifier for the dimension. + * @example addon_dimension_slug + */ + slug: string; + /** + * display_name + * @description Display name for the dimension. + * @example Addon Dimension Display Name + */ + display_name: string; + /** + * feature_name + * @description Name of the feature associated with the dimension. + * @example Feature Name + */ + feature_name: string; + /** + * volumes + * @description A list of volumes associated with the dimension, each with its own price. + */ + volumes: components["schemas"]["addons_dimension_volume_with_price"][]; + }; + addons_plan: { + /** + * id + * @description ID of a given plan. + * @example 1 + */ + id: number; + /** + * app_id + * @description ID of the app associated with this plan. + * @example 2 + */ + app_id: number; + /** + * display_name + * @description Display name for a given plan. + * @example Basic Plan + */ + display_name: string; + /** + * description + * @description Description of an app plan. + * @example Description of the app plan. + */ + description?: string; + /** + * slug + * @description Slug identifier for the plan. + * @example plan_basic + */ + slug: string; + /** + * price_per_month + * @description Price of a month's usage of the plan in US dollars. + * @example 10 + */ + price_per_month: number; + /** + * active + * @description Indicates if the plan is currently active. + * @example true + */ + active: boolean; + /** + * state + * @description Current state of the plan. + * @example approved + * @enum {string} + */ + state: "unknown" | "draft" | "in_review" | "approved" | "suspended" | "archived"; + /** + * features + * @description List of features included in the plan. + * @example [] + */ + features?: components["schemas"]["addons_feature"][]; + /** + * created_at + * Format: date-time + * @description Timestamp when the plan was created. + * @example 2023-10-01T12:00:00Z + */ + created_at: string; + /** + * updated_at + * Format: date-time + * @description Timestamp when the plan was last updated. + * @example 2023-10-01T12:00:00Z + */ + updated_at: string; + /** + * available + * @description Indicates if the plan is available for selection. + * @example true + */ + available: boolean; + /** + * uuid + * @description Unique identifier for the plan. + * @example 123e4567-e89b-12d3-a456-426 614174000 + */ + uuid: string; + /** + * by_default + * @description Indicates if this plan is the default option for the app. + * @example false + */ + by_default: boolean; + /** + * dimensions + * @description List of dimensions associated with the plan, each with its own pricing. + */ + dimensions?: components["schemas"]["addons_dimension_with_price"][]; + }; + addons_app_info: { + /** + * app_slug + * @description The slug identifier for the application associated with the resource. + * @example example-app + */ + app_slug: string; + /** + * tos + * @description The Terms of Service URL for the resource. + * @example https://example.com/tos + */ + tos: string; + /** + * eula + * @description The End User License Agreement URL for the resource. + * @example https://example.com/eula + */ + eula: string; + /** + * plans + * @description A list of plans available for the resource. + */ + plans: components["schemas"]["addons_plan"][]; + }; + addons_app_metadata: { + /** + * id + * @description Unique identifier for the addon metadata item. + * @example 1 + */ + id: number; + /** + * name + * @description The name of the metadata item. + * @example country_of_origin + */ + name: string; + /** + * display_name + * @description The display name of the metadata item. + * @example Country of Origin + */ + display_name: string; + /** + * description + * @description A brief description of the metadata item. + * @example Country for localization + */ + description: string; + /** + * type + * @description The data type of the metadata value. + * @example string + * @enum {string} + */ + type: "string" | "boolean"; + /** + * options + * @example [ + * "US", + * "UK", + * "CA" + * ] + */ + options?: string[]; + }; + addons_resource_metadata: { + /** + * name + * @description The name of the metadata item to be set. + * @example property_name + */ + name: string; + /** + * @description The value to be set for the metadata item, which can be a string or boolean. + * @example example_value + */ + value: string | boolean; + }; + addons_resource: { + /** + * uuid + * @description The unique identifier for the addon resource. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid: string; + /** + * name + * @description The name of the addon resource. + * @example my-resource-01 + */ + name: string; + /** + * state + * @description The state the resource is currently in. + * @example provisioned + * @enum {string} + */ + state: "pending" | "provisioning" | "provisioned" | "deprovisioning" | "deprovisioned" | "provisioning-failed" | "deprovisioning-failed" | "suspended"; + /** + * app_name + * @description The name of the application associated with the resource. + * @example Example App + */ + app_name?: string; + /** + * app_slug + * @description The slug identifier for the application associated with the resource. + * @example example_app + */ + app_slug: string; + /** + * plan_name + * @description The name of the plan associated with the resource. + * @example Basic Plan + */ + plan_name?: string; + /** + * plan_slug + * @description The slug identifier for the plan associated with the resource. + * @example basic_plan + */ + plan_slug: string; + /** + * plan_price_per_month + * @description The price of the plan per month in US dollars. + * @example 10 + */ + plan_price_per_month?: number; + /** + * has_config + * @description Indicates if the resource has configuration values set by the vendor. + * @example true + */ + has_config: boolean; + /** + * metadata + * @description Metadata associated with the resource, set by the user. + */ + metadata?: components["schemas"]["addons_resource_metadata"][]; + /** + * sso_url + * @description The Single Sign-On URL for the resource, if applicable. + * @example https://example.com/sso + */ + sso_url?: string; + /** + * message + * @description A message related to the resource, if applicable. + * @example Resource is provisioned successfully. + */ + message?: string; + }; + addons_resource_new: { + /** + * app_slug + * @description The slug identifier for the application associated with the resource. + * @example example-app + */ + app_slug: string; + /** + * plan_slug + * @description The slug identifier for the plan associated with the resource. + * @example basic_plan + */ + plan_slug: string; + /** + * name + * @description The name of the addon resource. + * @example my-resource-01 + */ + name: string; + /** + * metadata + * @description Metadata associated with the resource, set by the user. Metadata expected varies per app, and can be verified with a GET request to "/v2/add-ons/apps/{app_slug}/metadata" + */ + metadata: components["schemas"]["addons_resource_metadata"][]; + /** + * linked_droplet_id + * @description ID of the droplet to be linked to this resource, if applicable. + * @example 12345678 + */ + linked_droplet_id?: number; + /** + * fleet_uuid + * @description UUID of the fleet/project to which this resource will belong. + * @example f1234567-89ab-cdef-0123-456789abcdef01 + */ + fleet_uuid?: string; + }; apps_deployment_job: { /** * The name of this job @@ -7519,7 +10481,7 @@ export interface components { * Cannot be set if using a DigitalOcean DBaaS OpenSearch cluster. * @example password1 */ - password?: unknown; + password?: string; }; /** @description OpenSearch configuration. */ app_log_destination_open_search_spec: { @@ -7748,25 +10710,68 @@ export interface components { */ timeout_seconds?: number; }; - /** A criterion for routing HTTP traffic to a component. */ - app_route_spec: { + app_health_check_spec: { /** - * @description (Deprecated - Use Ingress Rules instead). An HTTP path prefix. Paths must start with / and must be unique across all components within an app. - * @example /api + * Format: int32 + * @description The number of failed health checks before considered unhealthy. + * @example 18 */ - path?: string; + failure_threshold?: number; /** - * @description An optional flag to preserve the path that is forwarded to the backend service. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If this value is `true`, the path will remain `/api/list`. - * @example true + * Format: int64 + * @description The port on which the health check will be performed. + * @example 80 */ - preserve_path_prefix?: boolean; - }; - app_service_spec_termination: { + port?: number; /** - * Format: int32 - * @description The number of seconds to wait between selecting a container instance for termination and issuing the TERM signal. Selecting a container instance for termination begins an asynchronous drain of new requests on upstream load-balancers. (Default 15) - * @example 15 - */ + * @description The route path used for the HTTP health check ping. If not set, the HTTP health check will be disabled and a TCP health check used instead. + * @example /health + */ + http_path?: string; + /** + * Format: int32 + * @description The number of seconds to wait before beginning health checks. + * @example 30 + */ + initial_delay_seconds?: number; + /** + * Format: int32 + * @description The number of seconds to wait between health checks. + * @example 10 + */ + period_seconds?: number; + /** + * Format: int32 + * @description The number of successful health checks before considered healthy. + * @example 1 + */ + success_threshold?: number; + /** + * Format: int32 + * @description The number of seconds after which the check times out. + * @example 1 + */ + timeout_seconds?: number; + }; + /** A criterion for routing HTTP traffic to a component. */ + app_route_spec: { + /** + * @description (Deprecated - Use Ingress Rules instead). An HTTP path prefix. Paths must start with / and must be unique across all components within an app. + * @example /api + */ + path?: string; + /** + * @description An optional flag to preserve the path that is forwarded to the backend service. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If this value is `true`, the path will remain `/api/list`. + * @example true + */ + preserve_path_prefix?: boolean; + }; + app_service_spec_termination: { + /** + * Format: int32 + * @description The number of seconds to wait between selecting a container instance for termination and issuing the TERM signal. Selecting a container instance for termination begins an asynchronous drain of new requests on upstream load-balancers. (Default 15) + * @example 15 + */ drain_seconds?: number; /** * Format: int32 @@ -7778,6 +10783,7 @@ 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"]; + liveness_health_check?: components["schemas"]["app_health_check_spec"]; /** * @description The protocol which the service uses to serve traffic on the http_port. * @@ -7870,13 +10876,14 @@ export interface components { }; app_worker_spec: WithRequired & components["schemas"]["app_component_instance_base"] & { termination?: components["schemas"]["app_worker_spec_termination"]; + liveness_health_check?: components["schemas"]["app_health_check_spec"]; }; /** * @default UNSPECIFIED_RULE * @example CPU_UTILIZATION * @enum {string} */ - app_alert_spec_rule: "UNSPECIFIED_RULE" | "CPU_UTILIZATION" | "MEM_UTILIZATION" | "RESTART_COUNT" | "DEPLOYMENT_FAILED" | "DEPLOYMENT_LIVE" | "DOMAIN_FAILED" | "DOMAIN_LIVE" | "FUNCTIONS_ACTIVATION_COUNT" | "FUNCTIONS_AVERAGE_DURATION_MS" | "FUNCTIONS_ERROR_RATE_PER_MINUTE" | "FUNCTIONS_AVERAGE_WAIT_TIME_MS" | "FUNCTIONS_ERROR_COUNT" | "FUNCTIONS_GB_RATE_PER_SECOND"; + app_alert_spec_rule: "UNSPECIFIED_RULE" | "CPU_UTILIZATION" | "MEM_UTILIZATION" | "RESTART_COUNT" | "DEPLOYMENT_FAILED" | "DEPLOYMENT_LIVE" | "DOMAIN_FAILED" | "DOMAIN_LIVE" | "AUTOSCALE_FAILED" | "AUTOSCALE_SUCCEEDED" | "FUNCTIONS_ACTIVATION_COUNT" | "FUNCTIONS_AVERAGE_DURATION_MS" | "FUNCTIONS_ERROR_RATE_PER_MINUTE" | "FUNCTIONS_AVERAGE_WAIT_TIME_MS" | "FUNCTIONS_ERROR_COUNT" | "FUNCTIONS_GB_RATE_PER_SECOND"; /** * @default UNSPECIFIED_OPERATOR * @example GREATER_THAN @@ -7951,15 +10958,16 @@ export interface components { /** * @description - MYSQL: MySQL * - PG: PostgreSQL - * - REDIS: Redis + * - REDIS: Caching * - MONGODB: MongoDB * - KAFKA: Kafka * - OPENSEARCH: OpenSearch + * - VALKEY: ValKey * @default UNSET * @example PG * @enum {string} */ - engine: "UNSET" | "MYSQL" | "PG" | "REDIS" | "MONGODB" | "KAFKA" | "OPENSEARCH"; + engine: "UNSET" | "MYSQL" | "PG" | "REDIS" | "MONGODB" | "KAFKA" | "OPENSEARCH" | "VALKEY"; /** * @description The database's name. The name must be unique across all components within the same app and cannot use capital letters. * @example prod-db @@ -7977,16 +10985,22 @@ export interface components { version?: string; }; /** @description The path to match on. */ - app_ingress_spec_rule_string_match: { + app_ingress_spec_rule_string_match_prefix: { /** * @description Prefix-based match. For example, `/api` will match `/api`, `/api/`, and any nested paths such as `/api/v1/endpoint`. * @example /api */ prefix: string; }; + /** @description The authority to match on. */ + app_ingress_spec_rule_string_match_exact: { + /** @example example.com */ + exact: string; + }; /** @description The match configuration for the rule. */ app_ingress_spec_rule_match: { - path: components["schemas"]["app_ingress_spec_rule_string_match"]; + path?: components["schemas"]["app_ingress_spec_rule_string_match_prefix"]; + authority?: components["schemas"]["app_ingress_spec_rule_string_match_exact"]; }; /** @description The component to route to. Only one of `component` or `redirect` may be set. */ app_ingress_spec_rule_routing_component: { @@ -8066,7 +11080,7 @@ export interface components { */ 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. + * @description Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. * @example true */ archive?: boolean; @@ -8076,6 +11090,19 @@ export interface components { */ offline_page_url?: string; }; + apps_vpc_egress_ip: { + /** @example 10.0.0.1 */ + ip?: string; + }; + apps_vpc: { + /** + * The ID of the VPC. + * @example c22d8f48-4bc4-49f5-8ca0-58e7164427ac + */ + id?: string; + /** The egress ips associated with the VPC. */ + egress_ips?: components["schemas"]["apps_vpc_egress_ip"][]; + }; /** * AppSpec * @description The desired configuration of an application. @@ -8091,7 +11118,25 @@ export interface components { * @example nyc * @enum {string} */ - region?: "ams" | "nyc" | "fra" | "sfo" | "sgp" | "blr" | "tor" | "lon" | "syd"; + region?: "atl" | "nyc" | "sfo" | "tor" | "ams" | "fra" | "lon" | "blr" | "sgp" | "syd"; + /** + * @description If set to `true`, the app will **not** be cached at the edge (CDN). Enable this option if you want to manage CDN configuration yourself—whether by using an external CDN provider or by handling static content and caching within your app. This setting is also recommended for apps that require real-time data or serve dynamic content, such as those using Server-Sent Events (SSE) over GET, or hosting an MCP (Model Context Protocol) Server that utilizes SSE. + * **Note:** This feature is not available for static site components. + * For more information, see [Disable CDN Cache](https://docs.digitalocean.com/products/app-platform/how-to/cache-content/#disable-cdn-cache). + * @default false + */ + disable_edge_cache: boolean; + /** + * @description If set to `true`, email addresses in the app will not be obfuscated. This is + * useful for apps that require email addresses to be visible (in the HTML markup). + * @default false + */ + disable_email_obfuscation: boolean; + /** + * @description If set to `true`, suspicious requests will go through additional security checks to help mitigate layer 7 DDoS attacks. + * @default false + */ + enhanced_threat_control_enabled: boolean; /** @description A set of hostnames where the application will be available. */ domains?: components["schemas"]["app_domain_spec"][]; /** @description Workloads which expose publicly-accessible HTTP services. */ @@ -8112,6 +11157,7 @@ export interface components { ingress?: components["schemas"]["app_ingress_spec"]; egress?: components["schemas"]["app_egress_spec"]; maintenance?: components["schemas"]["app_maintenance_spec"]; + vpc?: components["schemas"]["apps_vpc"]; }; apps_deployment_static_site: { /** @@ -8349,6 +11395,7 @@ export interface components { pending_deployment?: unknown & components["schemas"]["apps_deployment"]; /** * The ID of the project the app is assigned to. This will be empty if there is a lookup failure. + * @description Requires `project:read` scope. * @example 88b72d1a-b78a-4d9f-9090-b53c4399073f */ readonly project_id?: string; @@ -8368,6 +11415,7 @@ export interface components { pinned_deployment?: unknown & components["schemas"]["apps_deployment"]; /** The dedicated egress IP addresses associated with the app. */ readonly dedicated_ips?: components["schemas"]["apps_dedicated_egress_ip"][]; + vpc?: components["schemas"]["apps_vpc"]; }; apps_response: { /** A list of apps */ @@ -8375,7 +11423,10 @@ export interface components { } & components["schemas"]["pagination"] & components["schemas"]["meta"]; apps_create_app_request: { spec: components["schemas"]["app_spec"]; - /** @description The ID of the project the app should be assigned to. If omitted, it will be assigned to your default project. */ + /** + * @description The ID of the project the app should be assigned to. If omitted, it will be assigned to your default project. + *

Requires `project:update` scope. + */ project_id?: string; }; app_response: { @@ -8426,6 +11477,32 @@ export interface components { */ url?: string; }; + app_instance: { + /** + * @description Name of the component, from the app spec. + * @example sample-golang + */ + component_name?: string; + /** + * @description Supported compute component by DigitalOcean App Platform. + * @example SERVICE + * @enum {string} + */ + component_type?: "SERVICE" | "WORKER" | "JOB"; + /** + * @description Name of the instance, which is a unique identifier for the instance. + * @example sample-golang-76b84c7fb8-6p8kq + */ + instance_name?: string; + /** + * @description Readable identifier, an alias of the instance name, reference for mapping insights to instance names. + * @example sample-golang-0 + */ + instance_alias?: string; + }; + app_instances: { + instances?: components["schemas"]["app_instance"][]; + }; apps_deployments_response: { /** A list of deployments */ deployments?: components["schemas"]["apps_deployment"][]; @@ -8437,6 +11514,116 @@ export interface components { */ force_build?: boolean; }; + schema: string; + app_job_invocation: { + /** + * The ID of the job invocation + * @example ba32b134-569c-4c0c-ba02-8ffdb0492ece + */ + id?: string; + /** + * The name of the job this invocation belongs to. + * @example good-job + */ + job_name?: string; + /** + * The deployment ID this job invocation belongs to. + * @example c020763f-ddb7-4112-a0df-7f01c69fc00b + */ + deployment_id?: string; + /** + * @description The phase of the job invocation + * @example SUCCEEDED + * @enum {string} + */ + phase?: "UNKNOWN" | "PENDING" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "SKIPPED"; + /** The JobInvocation Trigger */ + trigger?: { + /** + * @description The type of trigger that initiated the job invocation. + * @default UNKNOWN + * @example MANUAL + * @enum {string} + */ + type: "MANUAL" | "SCHEDULE" | "UNKNOWN"; + /** + * @description The schedule for the job + * @example { + * "schedule": { + * "cron": "0 0 * * *", + * "time_zone": "America/New_York" + * } + * } + */ + scheduled?: { + schedule?: { + /** + * @description The cron expression defining the schedule + * @example 0 0 * * * + */ + cron?: string; + /** + * @description The time zone for the schedule + * @example America/New_York + */ + time_zone?: string; + }; + }; + /** + * @description Details about the manual trigger, if applicable + * @example { + * "user": { + * "uuid": "550e8400-e29b-41d4-a716-446655440000", + * "email": "user@example.com", + * "full_name": "John Doe" + * } + * } + */ + manual?: { + /** @description The user who triggered the job */ + user?: { + /** + * The ID of the user who triggered the job + * @example 550e8400-e29b-41d4-a716-446655440000 + */ + uuid?: string; + /** + * The email of the user who triggered the job + * Format: email + * @example user@example.com + */ + email?: string; + /** + * The name of the user who triggered the job + * @example John Doe + */ + full_name?: string; + }; + }; + }; + /** + * The time when the job invocation was created + * Format: date-time + * @example 2023-10-01T12:00:00Z + */ + created_at?: string; + /** + * The time when the job invocation started + * Format: date-time + * @example 2023-10-01T12:05:00Z + */ + started_at?: string; + /** + * The time when the job invocation completed + * Format: date-time + * @example 2023-10-01T12:10:00Z + */ + completed_at?: string; + }; + app_job_invocations: { + /** A list of job invocations */ + job_invocations?: components["schemas"]["app_job_invocation"][]; + } & components["schemas"]["pagination"]; /** * - SHARED: Shared vCPU cores * - DEDICATED: Dedicated vCPU cores @@ -8764,6 +11951,58 @@ export interface components { */ date?: string; }; + app_component_health: { + /** @example sample_app */ + name?: string; + /** + * Format: double + * @example 30 + */ + cpu_usage_percent?: number; + /** + * Format: double + * @example 25 + */ + memory_usage_percent?: number; + /** + * Format: int64 + * @example 1 + */ + replicas_desired?: number; + /** + * Format: int64 + * @example 1 + */ + replicas_ready?: number; + /** + * @default UNKNOWN + * @example HEALTHY + * @enum {string} + */ + state: "UNKNOWN" | "HEALTHY" | "UNHEALTHY"; + }; + app_functions_component_health: { + /** @example sample_function */ + name?: string; + functions_component_health_metrics?: { + /** @example activations_count */ + metric_label?: string; + /** + * Format: double + * @example 100 + */ + metric_value?: number; + /** @example 1h */ + time_window?: string; + }[]; + }; + app_health: { + components?: components["schemas"]["app_component_health"][]; + functions_components?: components["schemas"]["app_functions_component_health"][]; + }; + app_health_response: { + app_health?: components["schemas"]["app_health"]; + }; cdn_endpoint: { /** * Format: uuid @@ -9330,6 +12569,44 @@ export interface components { taxes?: unknown & components["schemas"]["simple_charge"]; credits_and_adjustments?: unknown & components["schemas"]["simple_charge"]; }; + billing_data_point: { + /** + * @description URN of the team that incurred the usage + * @example do:team:12345678-1234-1234-1234-123456789012 + */ + usage_team_urn?: string; + /** + * Format: date + * @description Start date of the billing data point in YYYY-MM-DD format + * @example 2025-01-15 + */ + start_date?: string; + /** + * @description Total amount for this data point in USD + * @example 12.45 + */ + total_amount?: string; + /** + * @description Region where the usage occurred + * @example nyc3 + */ + region?: string; + /** + * @description Unique SKU identifier for the billed resource + * @example 1-DO-DROP-0109 + */ + sku?: string; + /** + * @description Description of the billed resource or service as shown on an invoice item + * @example droplet name (c-2-4GiB) + */ + description?: string; + /** + * @description Optional invoice item group name of the billed resource or service, blank when not part an invoice item group + * @example kubernetes cluster name + */ + group_description?: string; + }; database_region_options: { /** * @description An array of strings containing the names of available regions @@ -9392,6 +12669,7 @@ export interface components { pg?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; mysql?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; redis?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; + valkey?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; opensearch?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; }; version_availability?: { @@ -9399,6 +12677,7 @@ export interface components { pg?: components["schemas"]["database_version_availabilities"]; mysql?: components["schemas"]["database_version_availabilities"]; redis?: components["schemas"]["database_version_availabilities"]; + valkey?: components["schemas"]["database_version_availabilities"]; mongodb?: components["schemas"]["database_version_availabilities"]; opensearch?: components["schemas"]["database_version_availabilities"]; }; @@ -9420,12 +12699,44 @@ export interface components { */ readonly port?: number; /** - * @description The default user for the opensearch dashboard. + * @description The default user for the opensearch dashboard.

Requires `database:view_credentials` scope. + * @example doadmin + */ + readonly user?: string; + /** + * @description The randomly generated password for the default user.

Requires `database:view_credentials` scope. + * @example wv78n3zpz42xezdk + */ + readonly password?: string; + /** + * @description A boolean value indicating if the connection should be made over SSL. + * @example true + */ + readonly ssl?: boolean; + }; + schema_registry_connection: { + /** + * @description This is provided as a convenience and should be able to be constructed by the other attributes. + * @example https://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060 + */ + readonly uri?: string; + /** + * @description The FQDN pointing to the schema registry connection uri. + * @example backend-do-user-19081923-0.db.ondigitalocean.com + */ + readonly host?: string; + /** + * @description The port on which the schema registry is listening. + * @example 20835 + */ + readonly port?: number; + /** + * @description The default user for the schema registry.

Requires `database:view_credentials` scope. * @example doadmin */ readonly user?: string; /** - * @description The randomly generated password for the default user. + * @description The randomly generated password for the schema registry.

Requires `database:view_credentials` scope. * @example wv78n3zpz42xezdk */ readonly password?: string; @@ -9457,12 +12768,12 @@ export interface components { */ readonly port?: number; /** - * @description The default user for the database. + * @description The default user for the database.

Requires `database:view_credentials` scope. * @example doadmin */ readonly user?: string; /** - * @description The randomly generated password for the default user. + * @description The randomly generated password for the default user.

Requires `database:view_credentials` scope. * @example wv78n3zpz42xezdk */ readonly password?: string; @@ -9524,6 +12835,23 @@ export interface components { */ permission: "admin" | "consume" | "produce" | "produceconsume"; }[]; + /** @description MongoDB-specific settings for the user. This option is not currently supported for other database engines. */ + mongo_user_settings?: { + /** + * @description A list of databases to which the user should have access. When the database is set to `admin`, the user will have access to all databases based on the user's role i.e. a user with the role `readOnly` assigned to the `admin` database will have read access to all databases. + * @example [ + * "my-db", + * "my-db-2" + * ] + */ + databases?: string[]; + /** + * @description The role to assign to the user with each role mapping to a MongoDB built-in role. `readOnly` maps to a [read](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-read) role. `readWrite` maps to a [readWrite](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-readWrite) role. `dbAdmin` maps to a [dbAdmin](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-dbAdmin) role. + * @example readOnly + * @enum {string} + */ + role?: "readOnly" | "readWrite" | "dbAdmin"; + }; }; database_user: { /** @@ -9539,7 +12867,7 @@ export interface components { */ readonly role?: "primary" | "normal"; /** - * @description A randomly generated password for the database user. + * @description A randomly generated password for the database user.
Requires `database:view_credentials` scope. * @example jge5lfxtzhx42iff */ readonly password?: string; @@ -9665,6 +12993,11 @@ export interface components { * @example 2019-01-11T18:37:36Z */ readonly created_at?: string; + /** + * @description A human-readable description of the rule. + * @example an IP address for local development + */ + description?: string; }; database_service_endpoint: { /** @@ -9678,6 +13011,149 @@ export interface components { */ readonly port?: number; }; + /** @description DigitalOcean-specific settings for the database cluster. */ + do_settings: { + /** + * @description An array of custom CNAMEs for the database cluster. Each CNAME must be a valid RFC 1123 hostname (e.g., "db.example.com"). Maximum of 16 CNAMEs allowed, each up to 253 characters. + * @example [ + * "db.example.com", + * "database.myapp.io" + * ] + */ + service_cnames?: string[]; + }; + database_cluster_read: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + readonly id?: string; + /** + * @description A unique, human-readable name referring to a database cluster. + * @example backend + */ + name: string; + /** + * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB, "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey. + * @example mysql + * @enum {string} + */ + engine: "pg" | "mysql" | "redis" | "valkey" | "mongodb" | "kafka" | "opensearch"; + /** + * @description A string representing the version of the database engine in use for the cluster. + * @example 8 + */ + version?: string; + /** + * @description A string representing the semantic version of the database engine in use for the cluster. + * @example 8.0.28 + */ + readonly semantic_version?: string; + /** + * @description The number of nodes in the database cluster. + * @example 2 + */ + num_nodes: number; + /** + * @description The slug identifier representing the size of the nodes in the database cluster. + * @example db-s-2vcpu-4gb + */ + size: string; + /** + * @description The slug identifier for the region where the database cluster is located. + * @example nyc3 + */ + region: string; + /** + * @description A string representing the current status of the database cluster. + * @example creating + * @enum {string} + */ + readonly status?: "creating" | "online" | "resizing" | "migrating" | "forking"; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the database cluster was created. + * @example 2019-01-11T18:37:36Z + */ + readonly created_at?: string; + /** + * @description A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. + * @example d455e75d-4858-4eec-8c95-da2f0a5f93a7 + */ + private_network_uuid?: string; + /** + * @description An array of tags that have been applied to the database cluster.

Requires `tag:read` scope. + * @example [ + * "production" + * ] + */ + tags?: string[] | null; + /** + * @description An array of strings containing the names of databases created in the database cluster. + * @example [ + * "doadmin" + * ] + */ + readonly db_names?: string[] | null; + /** @description The connection details for OpenSearch dashboard. */ + ui_connection?: components["schemas"]["opensearch_connection"] & unknown; + /** @description The connection details for Schema Registry. */ + schema_registry_connection?: components["schemas"]["schema_registry_connection"] & unknown; + connection?: components["schemas"]["database_connection"] & unknown; + private_connection?: components["schemas"]["database_connection"] & unknown; + standby_connection?: components["schemas"]["database_connection"] & unknown; + standby_private_connection?: components["schemas"]["database_connection"] & unknown; + readonly users?: components["schemas"]["database_user"][] | null; + maintenance_window?: components["schemas"]["database_maintenance_window"] & unknown; + /** + * Format: uuid + * @description The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project.

Requires `project:read` scope. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + project_id?: string; + rules?: components["schemas"]["firewall_rule"][]; + /** + * @description A timestamp referring to the date when the particular version will no longer be supported. If null, the version does not have an end of life timeline. + * @example 2023-11-09T00:00:00Z + */ + readonly version_end_of_life?: string; + /** + * @description A timestamp referring to the date when the particular version will no longer be available for creating new clusters. If null, the version does not have an end of availability timeline. + * @example 2023-05-09T00:00:00Z + */ + readonly version_end_of_availability?: string; + /** + * @description Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. + * @example 61440 + */ + storage_size_mib?: number; + /** @description Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and a second entry for the cluster's standby node(s). */ + readonly metrics_endpoints?: components["schemas"]["database_service_endpoint"][]; + do_settings?: components["schemas"]["do_settings"] & unknown; + }; + /** @description Configuration for database cluster storage autoscaling */ + database_storage_autoscale_params: { + /** + * @description Whether storage autoscaling is enabled for the cluster + * @example true + */ + enabled: boolean; + /** + * @description The storage usage threshold percentage that triggers autoscaling. When storage usage exceeds this percentage, additional storage will be added automatically. + * @example 80 + */ + threshold_percent?: number; + /** + * @description The amount of additional storage to add (in GiB) when autoscaling is triggered + * @example 10 + */ + increment_gib?: number; + }; + /** @description Contains all autoscaling configuration for a database cluster */ + database_autoscale_params: { + storage?: components["schemas"]["database_storage_autoscale_params"] & unknown; + }; database_cluster: { /** * Format: uuid @@ -9691,11 +13167,11 @@ export interface components { */ name: string; /** - * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka, and "opensearch" for OpenSearch. + * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB, "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey. * @example mysql * @enum {string} */ - engine: "pg" | "mysql" | "redis" | "mongodb" | "kafka" | "opensearch"; + engine: "pg" | "mysql" | "redis" | "valkey" | "mongodb" | "kafka" | "opensearch"; /** * @description A string representing the version of the database engine in use for the cluster. * @example 8 @@ -9734,12 +13210,12 @@ export interface components { */ readonly created_at?: string; /** - * @description A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. + * @description A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. * @example d455e75d-4858-4eec-8c95-da2f0a5f93a7 */ private_network_uuid?: string; /** - * @description An array of tags that have been applied to the database cluster. + * @description An array of tags (as strings) to apply to the database cluster.

Requires `tag:create` scope. * @example [ * "production" * ] @@ -9754,6 +13230,8 @@ export interface components { readonly db_names?: string[] | null; /** @description The connection details for OpenSearch dashboard. */ ui_connection?: components["schemas"]["opensearch_connection"] & unknown; + /** @description The connection details for Schema Registry. */ + schema_registry_connection?: components["schemas"]["schema_registry_connection"] & unknown; connection?: components["schemas"]["database_connection"] & unknown; private_connection?: components["schemas"]["database_connection"] & unknown; standby_connection?: components["schemas"]["database_connection"] & unknown; @@ -9762,7 +13240,7 @@ export interface components { maintenance_window?: components["schemas"]["database_maintenance_window"] & unknown; /** * Format: uuid - * @description The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. + * @description The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project.

Requires `project:update` scope. * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ project_id?: string; @@ -9784,6 +13262,9 @@ export interface components { storage_size_mib?: number; /** @description Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and a second entry for the cluster's standby node(s). */ readonly metrics_endpoints?: components["schemas"]["database_service_endpoint"][]; + /** @description Autoscaling configuration for the database cluster. Currently only supports storage autoscaling. If null, autoscaling is not configured for the cluster. */ + autoscale?: components["schemas"]["database_autoscale_params"]; + do_settings?: components["schemas"]["do_settings"] & unknown; }; database_backup: { /** @@ -9798,6 +13279,16 @@ export interface components { */ backup_created_at?: string; }; + /** @description MySQL Incremental Backup configuration settings */ + mysql_incremental_backup: { + /** @description Enable periodic incremental backups. When enabled, full_backup_week_schedule must be set. Incremental backups only store changes since the last backup, making them faster and more storage-efficient than full backups. This is particularly useful for large databases where daily full backups would be too time-consuming or expensive. */ + enabled?: boolean; + /** + * @description Comma-separated list of days of the week when full backups should be created. Valid values: mon, tue, wed, thu, fri, sat, sun. Default is null. Example : "mon,fri,sun". + * @example mon,thu + */ + full_backup_week_schedule?: string; + }; mysql_advanced_config: { /** * @description The hour of day (in UTC) when backup for the service starts. New backup only starts if previous backup has already completed. @@ -9976,6 +13467,7 @@ export interface components { * @enum {string} */ log_output: "INSIGHTS" | "TABLE" | "INSIGHTS,TABLE" | "NONE"; + mysql_incremental_backup?: components["schemas"]["mysql_incremental_backup"]; }; /** @description PGBouncer connection pooling settings */ pgbouncer_advanced_config: { @@ -10308,22 +13800,31 @@ export interface components { * @example 50 */ max_failover_replication_time_lag?: number; + /** + * @description Sets the PostgreSQL maximum number of concurrent connections to the database server. This is a limited-release parameter. Contact your account team to confirm your eligibility. You cannot decrease this parameter value when set. For services with a read replica, first increase the read replica's value. After the change is applied to the replica, you can increase the primary service's value. Changing this parameter causes a service restart. + * @example 75 + */ + max_connections?: number; + /** + * @description PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this. + * @example 100 + */ + max_slot_wal_keep_size?: number; }; - /** - * @description A string specifying the desired eviction policy for the Redis cluster. - * - * - `noeviction`: Don't evict any data, returns error when memory limit is reached. - * - `allkeys_lru:` Evict any key, least recently used (LRU) first. - * - `allkeys_random`: Evict keys in a random order. - * - `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first. - * - `volatile_random`: Evict keys with expiration only in a random order. - * - `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. - * @example allkeys_lru - * @enum {string} - */ - eviction_policy_model: "noeviction" | "allkeys_lru" | "allkeys_random" | "volatile_lru" | "volatile_random" | "volatile_ttl"; redis_advanced_config: { - redis_maxmemory_policy?: components["schemas"]["eviction_policy_model"]; + /** + * @description A string specifying the desired eviction policy for the Caching cluster. + * + * - `noeviction`: Don't evict any data, returns error when memory limit is reached. + * - `allkeys-lru:` Evict any key, least recently used (LRU) first. + * - `allkeys-random`: Evict keys in a random order. + * - `volatile-lru`: Evict keys with expiration only, least recently used (LRU) first. + * - `volatile-random`: Evict keys with expiration only in a random order. + * - `volatile-ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. + * @example allkeys-lru + * @enum {string} + */ + redis_maxmemory_policy?: "noeviction" | "allkeys-lru" | "allkeys-random" | "volatile-lru" | "volatile-random" | "volatile-ttl"; /** * @description Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. * @example 64 @@ -10335,7 +13836,7 @@ export interface components { */ redis_number_of_databases?: number; /** - * @description Redis IO thread count + * @description Caching IO thread count * @example 1 */ redis_io_threads?: number; @@ -10352,15 +13853,15 @@ export interface components { */ redis_lfu_decay_time: number; /** - * @description Require SSL to access Redis. - * - When enabled, Redis accepts only SSL connections on port `25061`. + * @description Require SSL to access Caching. + * - When enabled, Caching 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 */ redis_ssl: boolean; /** - * @description Redis idle connection timeout in seconds + * @description Caching idle connection timeout in seconds * @default 300 * @example 300 */ @@ -10393,12 +13894,114 @@ export interface components { */ redis_persistence?: "off" | "rdb"; /** - * @description Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Redis configuration acl-pubsub-default. + * @description Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Caching configuration acl-pubsub-default. * @example allchannels * @enum {string} */ redis_acl_channels_default?: "allchannels" | "resetchannels"; }; + /** + * @description A string specifying the desired eviction policy for a Caching or Valkey cluster. + * + * - `noeviction`: Don't evict any data, returns error when memory limit is reached. + * - `allkeys_lru:` Evict any key, least recently used (LRU) first. + * - `allkeys_random`: Evict keys in a random order. + * - `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first. + * - `volatile_random`: Evict keys with expiration only in a random order. + * - `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. + * @example allkeys_lru + * @enum {string} + */ + eviction_policy_model: "noeviction" | "allkeys_lru" | "allkeys_random" | "volatile_lru" | "volatile_random" | "volatile_ttl"; + valkey_advanced_config: { + valkey_maxmemory_policy?: components["schemas"]["eviction_policy_model"]; + /** + * @description Set output buffer limit for pub / sub clients in MB. The value is the hard limit, the soft limit is 1/4 of the hard limit. When setting the limit, be mindful of the available memory in the selected service plan. + * @example 64 + */ + valkey_pubsub_client_output_buffer_limit?: number; + /** + * @description Set number of valkey databases. Changing this will cause a restart of valkey service. + * @example 16 + */ + valkey_number_of_databases?: number; + /** + * @description Valkey IO thread count + * @example 1 + */ + valkey_io_threads?: number; + /** + * @description Counter logarithm factor for volatile-lfu and allkeys-lfu maxmemory-policies + * @default 10 + * @example 10 + */ + valkey_lfu_log_factor: number; + /** + * @description LFU maxmemory-policy counter decay time in minutes + * @default 1 + * @example 1 + */ + valkey_lfu_decay_time: number; + /** + * @description Require SSL to access Valkey + * @default true + * @example true + */ + valkey_ssl: boolean; + /** + * @description Valkey idle connection timeout in seconds + * @default 300 + * @example 300 + */ + valkey_timeout: number; + /** + * @description Set notify-keyspace-events option. Requires at least `K` or `E` and accepts any combination of the following options. Setting the parameter to `""` disables notifications. + * - `K` — Keyspace events + * - `E` — Keyevent events + * - `g` — Generic commands (e.g. `DEL`, `EXPIRE`, `RENAME`, ...) + * - `$` — String commands + * - `l` — List commands + * - `s` — Set commands + * - `h` — Hash commands + * - `z` — Sorted set commands + * - `t` — Stream commands + * - `d` — Module key type events + * - `x` — Expired events + * - `e` — Evicted events + * - `m` — Key miss events + * - `n` — New key events + * - `A` — Alias for `"g$lshztxed"` + * @default + * @example K + */ + valkey_notify_keyspace_events: string; + /** + * @description When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key is changed. Also RDB dumps are done according to backup schedule for backup purposes. When persistence is 'off', no RDB dumps and backups are done, so data can be lost at any moment if service is restarted for any reason, or if service is powered off. Also service can't be forked. + * @example rdb + * @enum {string} + */ + valkey_persistence?: "off" | "rdb"; + /** + * @description Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep backward compatibility. This option doesn't affect Valkey configuration acl-pubsub-default. + * @example allchannels + * @enum {string} + */ + valkey_acl_channels_default?: "allchannels" | "resetchannels"; + /** + * @description Frequent RDB snapshots + * When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off. + * @default true + * @example true + */ + frequent_snapshots: boolean; + /** + * @description Active expire effort + * Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency. + * @default 1 + * @example 1 + */ + valkey_active_expire_effort: number; + }; kafka_advanced_config: { /** * @description Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. @@ -10545,9 +14148,10 @@ export interface components { log_segment_delete_delay_ms?: number; /** * @description Enable auto creation of topics + * @default false * @example true */ - auto_create_topics_enable?: boolean; + auto_create_topics_enable: boolean; /** * @description When a producer sets acks to 'all' (or '-1'), min_insync_replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. * @example 1 @@ -10598,6 +14202,12 @@ export interface components { * @example 3600000 */ transaction_remove_expired_transaction_cleanup_interval_ms?: number; + /** + * @description Enable creation of schema registry for the Kafka cluster. Schema_registry only works with General Purpose - Dedicated CPU plans. + * @default false + * @example true + */ + schema_registry: boolean; }; opensearch_advanced_config: { /** @@ -10815,6 +14425,24 @@ export interface components { * @example false */ plugins_alerting_filter_by_backend_roles_enabled: boolean; + /** + * @description Enable or disable KNN memory circuit breaker. + * @default true + * @example true + */ + knn_memory_circuit_breaker_enabled: boolean; + /** + * @description Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches. + * @default 50 + * @example 60 + */ + knn_memory_circuit_breaker_limit: number; + /** + * @description DigitalOcean automatically resets the `index.refresh_interval` to the default value (once per second) to ensure that new documents are quickly available for search queries. If you are setting your own refresh intervals, you can disable this by setting this field to true. + * @default false + * @example true + */ + keep_index_refresh_interval: boolean; }; mongo_advanced_config: { /** @@ -10850,7 +14478,7 @@ export interface components { verbosity: number; }; database_config: { - config?: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["mongo_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"]; + config?: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["valkey_advanced_config"] | components["schemas"]["mongo_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"]; }; ca: { /** @@ -10870,7 +14498,7 @@ export interface components { * @example running * @enum {string} */ - status?: "running" | "canceled" | "error" | "done"; + status?: "running" | "syncing" | "canceled" | "error" | "done"; /** * @description The time the migration was initiated, in ISO 8601 format. * @example 2020-10-29T15:57:38Z @@ -10878,7 +14506,7 @@ export interface components { created_at?: string; }; source_database: { - source?: { + source: { /** * @description The FQDN pointing to the database cluster's current primary node. * @example backend-do-user-19081923-0.db.ondigitalocean.com @@ -10950,6 +14578,66 @@ export interface components { * @example 0.03364864 */ size_gigabytes: number; + /** + * @description Indicates if this backup is a full or an incremental one (available only for MySQL). + * @example false + */ + incremental?: boolean; + }; + database_replica_read: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference a database replica. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + readonly id?: string; + /** + * @description The name to give the read-only replicating + * @example read-nyc3-01 + */ + name: string; + /** + * @description A slug identifier for the region where the read-only replica will be located. If excluded, the replica will be placed in the same region as the cluster. + * @example nyc3 + */ + region?: string; + /** + * @description A slug identifier representing the size of the node for the read-only replica. The size of the replica must be at least as large as the node size for the database cluster from which it is replicating. + * @example db-s-2vcpu-4gb + */ + size?: string; + /** + * @description A string representing the current status of the database cluster. + * @example creating + * @enum {string} + */ + readonly status?: "creating" | "online" | "resizing" | "migrating" | "forking"; + /** + * @description A flat array of tag names as strings applied to the read-only replica.

Requires `tag:read` scope. + * @example [ + * "production" + * ] + */ + tags?: string[]; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the database cluster was created. + * @example 2019-01-11T18:37:36Z + */ + readonly created_at?: string; + /** + * @description A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. + * @example 9423cbad-9211-442f-820b-ef6915e99b5f + */ + private_network_uuid?: string; + connection?: unknown & components["schemas"]["database_connection"]; + private_connection?: unknown & components["schemas"]["database_connection"]; + /** + * @description Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. + * @example 61440 + */ + storage_size_mib?: number; + do_settings?: components["schemas"]["do_settings"] & unknown; }; database_replica: { /** @@ -10980,7 +14668,7 @@ export interface components { */ readonly status?: "creating" | "online" | "resizing" | "migrating" | "forking"; /** - * @description A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags. + * @description A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags.

Requires `tag:create` scope. * @example [ * "production" * ] @@ -10993,7 +14681,7 @@ export interface components { */ readonly created_at?: string; /** - * @description A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region. + * @description A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region.

Requires `vpc:read` scope. * @example 9423cbad-9211-442f-820b-ef6915e99b5f */ private_network_uuid?: string; @@ -11004,6 +14692,7 @@ export interface components { * @example 61440 */ storage_size_mib?: number; + do_settings?: components["schemas"]["do_settings"] & unknown; }; events_logs: { /** @@ -11380,6 +15069,23 @@ export interface components { * @description Conditional (required if `format` == `custom`). * * Syslog log line template for a custom format, supporting limited rsyslog style templating (using `%tag%`). Supported tags are: `HOSTNAME`, `app-name`, `msg`, `msgid`, `pri`, `procid`, `structured-data`, `timestamp` and `timestamp:::date-rfc3339`. + * + * --- + * **Datadog Integration Example for Non-Mongo clusters**: + * ``` + * DD_KEY <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.DB_NAME %app-name% - - - %msg% + * ``` + * - Replace `DD_KEY` with your actual Datadog API key. + * - Replace `DB_NAME` with the actual name of your database cluster. + * - Configure the Server: + * - US Region: Use `intake.logs.datadoghq.com` + * - EU Region: Use `tcp-intake.logs.datadoghq.eu` + * - Configure the Port: + * - US Region: Use port `10516` + * - EU Region: Use port `443` + * - Enable TLS: + * - Ensure the TLS checkbox is enabled. + * - Note: This configuration applies to **non-Mongo clusters only**. For **Mongo clusters**, use the `datadog_logsink` integration instead. * @example <%pri%>%timestamp:::date-rfc3339% %HOSTNAME% %app-name% %msg% */ logline?: string; @@ -11464,6 +15170,19 @@ export interface components { */ ca?: string; }; + /** @description Configuration for Datadog integration **applicable only to MongoDB clusters**. */ + datadog_logsink: { + /** + * @description Datadog connection URL + * @example http-intake.logs.datadoghq.com + */ + site: string; + /** + * @description Datadog API key + * @example xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + */ + datadog_api_key: string; + }; logsink_verbose: components["schemas"]["logsink_base_verbose"] & { /** * @example { @@ -11475,8 +15194,9 @@ export interface components { * } * } */ - config?: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"]; + config?: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"] | components["schemas"]["datadog_logsink"]; }; + logsink_schema: components["schemas"]["logsink_verbose"]; logsink_base: { /** * @description The name of the Logsink @@ -11484,16 +15204,113 @@ export interface components { */ sink_name?: string; /** + * @description Type of logsink integration. + * + * - Use `datadog` for Datadog integration **only with MongoDB clusters**. + * - For non-MongoDB clusters, use `rsyslog` for general syslog forwarding. + * - Other supported types include `elasticsearch` and `opensearch`. + * + * More details about the configuration can be found in the `config` property. * @example rsyslog * @enum {string} */ - sink_type?: "rsyslog" | "elasticsearch" | "opensearch"; + sink_type?: "rsyslog" | "elasticsearch" | "opensearch" | "datadog"; }; logsink_create: components["schemas"]["logsink_base"] & { - config?: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"]; + config?: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"] | components["schemas"]["datadog_logsink"]; }; logsink_update: { - config: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"]; + config: components["schemas"]["rsyslog_logsink"] | components["schemas"]["elasticsearch_logsink"] | components["schemas"]["opensearch_logsink"] | components["schemas"]["datadog_logsink"]; + }; + kafka_schema_verbose: { + /** + * @description The id for schema. + * @example 12345 + */ + schema_id?: number; + /** + * @description The name of the schema subject. + * @example customer-schema + */ + subject_name?: string; + /** + * @description The type of the schema. + * @example AVRO + * @enum {string} + */ + schema_type?: "AVRO" | "JSON" | "PROTOBUF"; + /** + * @description The schema definition in the specified format. + * @example { + * "type": "record", + * "name": "Customer", + * "fields": [ + * {"name": "id", "type": "int"}, + * {"name": "name", "type": "string"} + * ] + * } + */ + schema?: string; + }; + database_kafka_schema_create: { + /** + * @description The name of the schema subject. + * @example customer-schema + */ + subject_name?: string; + /** + * @description The type of the schema. + * @example AVRO + * @enum {string} + */ + schema_type?: "AVRO" | "JSON" | "PROTOBUF"; + /** + * @description The schema definition in the specified format. + * @example { + * "type": "record", + * "name": "Customer", + * "fields": [ + * {"name": "id", "type": "int"}, + * {"name": "name", "type": "string"} + * ] + * } + */ + schema?: string; + }; + kafka_schema_version_verbose: { + /** + * @description The id for schema. + * @example 12345 + */ + schema_id?: number; + /** + * @description The version of the schema. + * @example 1 + */ + version?: string; + /** + * @description The name of the schema subject. + * @example customer-schema + */ + subject_name?: string; + /** + * @description The type of the schema. + * @example AVRO + * @enum {string} + */ + schema_type?: "AVRO" | "JSON" | "PROTOBUF"; + /** + * @description The schema definition in the specified format. + * @example { + * "type": "record", + * "name": "Customer", + * "fields": [ + * {"name": "id", "type": "int"}, + * {"name": "name", "type": "string"} + * ] + * } + */ + schema?: string; }; databases_basic_auth_credentials: { /** @@ -11732,7 +15549,7 @@ export interface components { */ image_description: string; /** - * @description A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. + * @description A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires `tag:create` scope. * @example [ * "base-image", * "prod" @@ -12006,7 +15823,7 @@ export interface components { */ features: string[]; /** - * @description An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation. + * @description An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
Requires `image:read` scope. * @example [ * 53893572 * ] @@ -12014,15 +15831,15 @@ export interface components { backup_ids: number[]; next_backup_window: components["schemas"]["droplet_next_backup_window"] & unknown; /** - * @description An array of snapshot IDs of any snapshots created from the Droplet instance. + * @description An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires `image:read` scope. * @example [ * 67512819 * ] */ snapshot_ids: number[]; - image: components["schemas"]["image"]; + image: components["schemas"]["image"] & unknown; /** - * @description A flat array including the unique identifier for each Block Storage volume attached to the Droplet. + * @description A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires `block_storage:read` scope. * @example [ * "506f78a4-e098-11e5-ad9f-000f53306ae1" * ] @@ -12041,7 +15858,7 @@ export interface components { }; region: components["schemas"]["region"]; /** - * @description An array of Tags the Droplet has been tagged with. + * @description An array of Tags the Droplet has been tagged with.
Requires `tag:read` scope. * @example [ * "web", * "env:prod" @@ -12049,7 +15866,7 @@ export interface components { */ tags: string[]; /** - * @description A string specifying the UUID of the VPC to which the Droplet is assigned. + * @description A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires `vpc:read` scope. * @example 760e09ef-dc84-11e8-981e-3cfdfeaae000 */ vpc_uuid?: string; @@ -12097,12 +15914,12 @@ export interface components { */ size: string; /** - * @description The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for your Droplet. + * @description The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for your Droplet.
Requires `image:read` scope. * @example ubuntu-20-04-x64 */ image: string | number; /** - * @description An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet's root account upon creation. + * @description An array containing the IDs or fingerprints of the SSH keys that you wish to embed in the Droplet's root account upon creation. You must add the keys to your team before they can be embedded on a Droplet.
Requires `ssh_key:read` scope. * @default [] * @example [ * 289794, @@ -12130,7 +15947,7 @@ export interface components { */ monitoring: boolean; /** - * @description A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags. + * @description A flat array of tag names as strings to apply to the Droplet after it is created. Tag names can either be existing or new tags.
Requires `tag:create` scope. * @default [] * @example [ * "env:prod", @@ -12153,7 +15970,7 @@ export interface components { */ private_networking: boolean; /** - * @description An array of IDs for block storage volumes that will be attached to the Droplet once created. The volumes must not already be attached to an existing Droplet. + * @description An array of IDs for block storage volumes that will be attached to the Droplet once created. The volumes must not already be attached to an existing Droplet.
Requires `block_storage:read` scpoe. * @default [] * @example [ * "12e97116-7280-11ed-b3d0-0a58ac146812" @@ -12161,7 +15978,7 @@ export interface components { */ volumes: string[]; /** - * @description A string specifying the UUID of the VPC to which the Droplet will be assigned. If excluded, the Droplet will be assigned to your account's default VPC for the region. + * @description A string specifying the UUID of the VPC to which the Droplet will be assigned. If excluded, the Droplet will be assigned to your account's default VPC for the region.
Requires `vpc:read` scope. * @example 760e09ef-dc84-11e8-981e-3cfdfeaae000 */ vpc_uuid?: string; @@ -12399,7 +16216,7 @@ export interface components { type: "snapshot"; }; /** - * @description A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request. + * @description A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request.

Requires `tag:create` and `tag:read` scopes. * @example [ * "base-image", * "prod" @@ -12501,7 +16318,7 @@ export interface components { */ name?: string; /** - * @description An array containing the IDs of the Droplets assigned to the firewall. + * @description An array containing the IDs of the Droplets assigned to the firewall.

Requires `droplet:read` scope. * @example [ * 8043964 * ] @@ -12674,6 +16491,7 @@ export interface components { image: string; /** * @description The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. + * Requires `ssh_key:read` scope. * @example [ * "88:66:90:d2:68:d5:b5:85:e3:26:26:11:31:57:e6:f8" * ] @@ -12681,6 +16499,7 @@ export interface components { ssh_keys: string[]; /** * @description The tags to apply to each of the Droplets in the autoscale pool. + * Requires `tag:read` scope. * @example [ * "my-tag" * ] @@ -12688,6 +16507,7 @@ export interface components { tags?: string[]; /** * @description The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. + * Requires `vpc:read` scope. * @example 760e09ef-dc84-11e8-981e-3cfdfeaae000 */ vpc_uuid?: string; @@ -12698,6 +16518,7 @@ export interface components { with_droplet_agent?: boolean; /** * @description The project that the Droplets in the autoscale pool will belong to. + * Requires `project:read` scope. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; @@ -12874,7 +16695,7 @@ export interface components { ip?: string; region?: components["schemas"]["region"] & Record; /** - * @description The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. + * @description The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Requires `droplet:read` scope. * @example null */ droplet?: (Record | null) | components["schemas"]["droplet"]; @@ -12885,7 +16706,7 @@ export interface components { locked?: boolean; /** * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. + * @description The UUID of the project to which the reserved IP currently belongs.

Requires `project:read` scope. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; @@ -13205,7 +17026,7 @@ export interface components { */ count?: number; /** - * @description An array containing the tags applied to the node pool. All node pools are automatically tagged `k8s`, `k8s-worker`, and `k8s:$K8S_CLUSTER_ID`. + * @description An array containing the tags applied to the node pool. All node pools are automatically tagged `k8s`, `k8s-worker`, and `k8s:$K8S_CLUSTER_ID`.

Requires `tag:read` scope. * @example [ * "k8s", * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", @@ -13266,7 +17087,7 @@ export interface components { * @description Indicates whether the control plane firewall is enabled. * @example true */ - enable?: boolean; + enabled?: boolean; /** * @description An array of public addresses (IPv4 or CIDR) allowed to access the control plane. * @example [ @@ -13276,7 +17097,77 @@ export interface components { */ allowed_addresses?: string[]; } | null; - cluster: { + /** @description An object specifying custom cluster autoscaler configuration. */ + cluster_autoscaler_configuration: { + /** + * @description Used to customize when cluster autoscaler scales down non-empty nodes by setting the node utilization threshold. + * @example 0.65 + */ + scale_down_utilization_threshold?: number; + /** + * @description Used to customize how long a node is unneeded before being scaled down. + * @example 1m0s + */ + scale_down_unneeded_time?: string; + /** + * @description Customizes expanders used by cluster-autoscaler. + * The autoscaler will apply each expander from the provided list to narrow down the selection of node types created to scale up, + * until either a single node type is left, or the list of expanders is exhausted. + * If this flag is unset, autoscaler will use its default expander `random`. + * Passing an empty list (_not_ `null`) will unset any previous expander customizations. + * + * Available expanders: + * - `random`: Randomly selects a node group to scale. + * - `priority`: Selects the node group with the highest priority as per [user-provided configuration](https://docs.digitalocean.com/products/kubernetes/how-to/autoscale/#configuring-priority-expander) + * - `least_waste`: Selects the node group that will result in the least amount of idle resources. + * @example [ + * "priority", + * "random" + * ] + */ + expanders?: ("random" | "priority" | "least_waste")[]; + } | null; + /** @description An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster. */ + routing_agent: { + /** + * @description Indicates whether the routing-agent component is enabled. + * @example true + */ + enabled?: boolean; + } | null; + /** @description An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an AMD GPU node pool. */ + amd_gpu_device_plugin: { + /** + * @description Indicates whether the AMD GPU Device Plugin is enabled. + * @example true + */ + enabled?: boolean; + } | null; + /** @description An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster. */ + amd_gpu_device_metrics_exporter_plugin: { + /** + * @description Indicates whether the AMD Device Metrics Exporter is enabled. + * @example true + */ + enabled?: boolean; + } | null; + /** @description An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an Nvidia GPU node pool. */ + nvidia_gpu_device_plugin: { + /** + * @description Indicates whether the Nvidia GPU Device Plugin is enabled. + * @example true + */ + enabled?: boolean; + } | null; + /** @description An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster. */ + rdma_shared_dev_plugin: { + /** + * @description Indicates whether the RDMA shared device plugin is enabled. + * @example true + */ + enabled?: boolean; + } | null; + cluster_read: { /** * Format: uuid * @description A unique ID that can be used to identify and reference a Kubernetes cluster. @@ -13312,7 +17203,7 @@ export interface components { service_subnet?: string; /** * Format: uuid - * @description A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned. + * @description A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.

Requires `vpc:read` scope. * @example c33931f2-a26a-4e61-b85c-4e95a2ec431b */ vpc_uuid?: string; @@ -13327,7 +17218,7 @@ export interface components { */ readonly endpoint?: string; /** - * @description An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. + * @description An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`.

Requires `tag:read` scope. * @example [ * "k8s", * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", @@ -13388,7 +17279,141 @@ export interface components { * @example true */ readonly registry_enabled?: boolean; + /** + * @description An array of integrated DOCR registries. + * @example [ + * "registry-a", + * "registry-b" + * ] + */ + registries?: string[] | null; control_plane_firewall?: components["schemas"]["control_plane_firewall"]; + cluster_autoscaler_configuration?: components["schemas"]["cluster_autoscaler_configuration"]; + routing_agent?: components["schemas"]["routing_agent"]; + amd_gpu_device_plugin?: components["schemas"]["amd_gpu_device_plugin"]; + amd_gpu_device_metrics_exporter_plugin?: components["schemas"]["amd_gpu_device_metrics_exporter_plugin"]; + nvidia_gpu_device_plugin?: components["schemas"]["nvidia_gpu_device_plugin"]; + rdma_shared_dev_plugin?: components["schemas"]["rdma_shared_dev_plugin"]; + }; + cluster: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + readonly id?: string; + /** + * @description A human-readable name for a Kubernetes cluster. + * @example prod-cluster-01 + */ + name: string; + /** + * @description The slug identifier for the region where the Kubernetes cluster is located. + * @example nyc1 + */ + region: string; + /** + * @description The slug identifier for the version of Kubernetes used for the cluster. If set to a minor version (e.g. "1.14"), the latest version within it will be used (e.g. "1.14.6-do.1"); if set to "latest", the latest published version will be used. See the `/v2/kubernetes/options` endpoint to find all currently available versions. + * @example 1.18.6-do.0 + */ + version: string; + /** + * Format: cidr + * @description The range of IP addresses for the overlay network of the Kubernetes cluster in CIDR notation. + * @example 192.168.0.0/20 + */ + cluster_subnet?: string; + /** + * Format: cidr + * @description The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation. + * @example 192.168.16.0/24 + */ + service_subnet?: string; + /** + * Format: uuid + * @description A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned.

Requires `vpc:read` scope. + * @example c33931f2-a26a-4e61-b85c-4e95a2ec431b + */ + vpc_uuid?: string; + /** + * @description The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+) + * @example 68.183.121.157 + */ + readonly ipv4?: string; + /** + * @description The base URL of the API server on the Kubernetes master node. + * @example https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com + */ + readonly endpoint?: string; + /** + * @description An array of tags to apply to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`.

Requires `tag:read` and `tag:create` scope, as well as `tag:delete` if existing tags are getting removed. + * @example [ + * "k8s", + * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", + * "production", + * "web-team" + * ] + */ + tags?: string[]; + /** @description An object specifying the details of the worker nodes available to the Kubernetes cluster. */ + node_pools: components["schemas"]["kubernetes_node_pool"][]; + maintenance_policy?: components["schemas"]["maintenance_policy"]; + /** + * @description A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window. + * @default false + * @example true + */ + auto_upgrade: boolean; + /** @description An object containing a `state` attribute whose value is set to a string indicating the current status of the cluster. */ + readonly status?: { + /** + * @description A string indicating the current status of the cluster. + * @example provisioning + * @enum {string} + */ + state?: "running" | "provisioning" | "degraded" | "error" | "deleted" | "upgrading" | "deleting"; + /** + * @description An optional message providing additional information about the current cluster state. + * @example provisioning + */ + message?: string; + }; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created. + * @example 2018-11-15T16:00:11Z + */ + readonly created_at?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated. + * @example 2018-11-15T16:00:11Z + */ + readonly updated_at?: string; + /** + * @description A boolean value indicating whether surge upgrade is enabled/disabled for the cluster. Surge upgrade makes cluster upgrades fast and reliable by bringing up new nodes before destroying the outdated nodes. + * @default false + * @example true + */ + surge_upgrade: boolean; + /** + * @description A boolean value indicating whether the control plane is run in a highly available configuration in the cluster. Highly available control planes incur less downtime. The property cannot be disabled. + * @default false + * @example true + */ + ha: boolean; + /** + * @description A read-only boolean value indicating if a container registry is integrated with the cluster. + * @example true + */ + readonly registry_enabled?: boolean; + control_plane_firewall?: components["schemas"]["control_plane_firewall"]; + cluster_autoscaler_configuration?: components["schemas"]["cluster_autoscaler_configuration"]; + routing_agent?: components["schemas"]["routing_agent"]; + amd_gpu_device_plugin?: components["schemas"]["amd_gpu_device_plugin"]; + amd_gpu_device_metrics_exporter_plugin?: components["schemas"]["amd_gpu_device_metrics_exporter_plugin"]; + nvidia_gpu_device_plugin?: components["schemas"]["nvidia_gpu_device_plugin"]; + rdma_shared_dev_plugin?: components["schemas"]["rdma_shared_dev_plugin"]; }; cluster_update: { /** @@ -13426,6 +17451,12 @@ export interface components { */ ha: boolean; control_plane_firewall?: components["schemas"]["control_plane_firewall"]; + cluster_autoscaler_configuration?: components["schemas"]["cluster_autoscaler_configuration"]; + routing_agent?: components["schemas"]["routing_agent"]; + amd_gpu_device_plugin?: components["schemas"]["amd_gpu_device_plugin"]; + amd_gpu_device_metrics_exporter_plugin?: components["schemas"]["amd_gpu_device_metrics_exporter_plugin"]; + nvidia_gpu_device_plugin?: components["schemas"]["nvidia_gpu_device_plugin"]; + rdma_shared_dev_plugin?: components["schemas"]["rdma_shared_dev_plugin"]; }; associated_kubernetes_resource: { /** @@ -13705,6 +17736,16 @@ export interface components { */ exclude_checks?: string[]; }; + cluster_registry: { + /** + * @description An array containing the UUIDs of Kubernetes clusters. + * @example [ + * "bd5f5959-5e1e-4205-a714-a914373942af", + * "50c2f44c-011d-493e-aee5-361a4a0d1844" + * ] + */ + cluster_uuids?: string[]; + }; cluster_registries: { /** * @description An array containing the UUIDs of Kubernetes clusters. @@ -13714,6 +17755,27 @@ export interface components { * ] */ cluster_uuids?: string[]; + /** + * @description An array containing the registry names. + * @example [ + * "registry-a", + * "registry-b" + * ] + */ + registries?: string[]; + }; + status_messages: { + /** + * @description Status information about the cluster which impacts it's lifecycle. + * @example Resource provisioning may be delayed while our team resolves an incident + */ + readonly message?: string; + /** + * Format: date-time + * @description A timestamp in ISO8601 format that represents when the status message was emitted. + * @example 2018-11-15T16:00:11Z + */ + readonly timestamp?: string; }; /** @description An object specifying a forwarding rule for a load balancer. */ forwarding_rule: { @@ -13915,6 +17977,11 @@ export interface components { * @example 104.131.186.241 */ readonly ip?: string; + /** + * @description An attribute containing the public-facing IPv6 address of the load balancer. + * @example 2604:a880:800:14::85f5:c000 + */ + readonly ipv6?: string; /** * @description How many nodes the load balancer contains. Each additional node increases the load balancer's ability to manage more connections. Load balancers can be scaled up or down, and you can change the number of nodes after creation up to once per hour. This field is currently not available in the AMS2, NYC2, or SFO1 regions. Use the `size` field to scale load balancers that reside in these regions. * @default 1 @@ -14002,6 +18069,13 @@ export interface components { * @enum {string} */ network: "EXTERNAL" | "INTERNAL"; + /** + * @description A string indicating whether the load balancer will support IPv4 or both IPv4 and IPv6 networking. This property cannot be updated after creating the load balancer. + * @default IPV4 + * @example IPV4 + * @enum {string} + */ + network_stack: "IPV4" | "DUALSTACK"; /** * @description A string indicating whether the load balancer should be a standard regional HTTP load balancer, a regional network load balancer that routes traffic at the TCP/UDP transport layer, or a global load balancer. * @default REGIONAL @@ -14020,6 +18094,13 @@ export interface components { * ] */ target_load_balancer_ids?: string[]; + /** + * @description A string indicating the policy for the TLS cipher suites used by the load balancer. The possible values are `DEFAULT` or `STRONG`. The default value is `DEFAULT`. + * @default DEFAULT + * @example STRONG + * @enum {string} + */ + tls_cipher_policy: "DEFAULT" | "STRONG"; }; load_balancer: components["schemas"]["load_balancer_base"] & { region?: unknown & components["schemas"]["region"]; @@ -14256,7 +18337,7 @@ export interface components { * @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} + * @enum {string} */ type?: "opensearch_dbaas" | "opensearch_ext"; config?: components["schemas"]["opensearch_config_omit_credentials"]; @@ -14305,7 +18386,7 @@ export interface components { /** * @description The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch * cluster or `opensearch_ext` for an externally managed one. - * @enum {unknown} + * @enum {string} */ type: "opensearch_dbaas" | "opensearch_ext"; config: components["schemas"]["opensearch_config_request"]; @@ -14369,7 +18450,7 @@ export interface components { * @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} + * @enum {string} */ type?: "opensearch_dbaas" | "opensearch_ext"; config: components["schemas"]["opensearch_config"]; @@ -14391,6 +18472,446 @@ export interface components { /** @description List of resources identified by their URNs. */ resources?: components["schemas"]["sink_resource"][]; }; + nfs_response: { + /** + * @description The unique identifier of the NFS share. + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + */ + readonly id: string; + /** + * @description The human-readable name of the share. + * @example sammy-share-drive + */ + name: string; + /** + * @description The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50. + * @example 1024 + */ + size_gib: number; + /** + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 + */ + region: string; + /** + * @description The current status of the share. + * @example ACTIVE + * @enum {string} + */ + readonly status: "CREATING" | "ACTIVE" | "FAILED" | "DELETED"; + /** + * Format: date-time + * @description Timestamp for when the NFS share was created. + * @example 2023-01-01T00:00:00Z + */ + readonly created_at: string; + /** + * @description List of VPC IDs that should be able to access the share. + * @example [ + * "796c6fe3-2a1d-4da2-9f3e-38239827dc91" + * ] + */ + vpc_ids?: string[]; + /** + * @description Path at which the share will be available, to be mounted at a target of the user's choice within the client + * @example /123456/your-nfs-share-uuid + */ + mount_path?: string; + /** + * @description The host IP of the NFS server that will be accessible from the associated VPC + * @example 10.128.32.2 + */ + host?: string; + }; + nfs_list_response: { + shares?: components["schemas"]["nfs_response"][]; + }; + nfs_request: { + /** + * @description The human-readable name of the share. + * @example my-nfs-share + */ + name: string; + /** + * @description The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50. + * @example 50 + */ + size_gib: number; + /** + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 + */ + region: string; + /** + * @description List of VPC IDs that should be able to access the share. + * @example [ + * "796c6fe3-2a1d-4da2-9f3e-38239827dc91" + * ] + */ + vpc_ids: string[]; + /** + * @description The performance tier of the share. + * @example standard + */ + performance_tier?: string; + }; + nfs_create_response: { + share?: components["schemas"]["nfs_response"]; + }; + nfs_get_response: { + share?: components["schemas"]["nfs_response"]; + }; + /** @description Specifies the action that will be taken on the NFS share. */ + nfs_action: { + /** + * @description The type of action to initiate for the NFS share (such as resize or snapshot). + * @example resize + * @enum {string} + */ + type: "resize" | "snapshot"; + /** + * @description The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. + * @example atl1 + */ + region?: string; + }; + nfs_action_resize: components["schemas"]["nfs_action"] & { + params?: { + /** + * @description The new size for the NFS share. + * @example 2048 + */ + size_gib: number; + }; + }; + nfs_action_snapshot: components["schemas"]["nfs_action"] & { + params?: { + /** + * @description Snapshot name of the NFS share + * @example daily-backup + */ + name: string; + }; + }; + nfs_action_attach: components["schemas"]["nfs_action"] & { + params?: { + /** + * @description The ID of the VPC to which the NFS share will be attached + * @example vpc-id-123 + */ + vpc_id: string; + }; + }; + nfs_action_detach: components["schemas"]["nfs_action"] & { + params?: { + /** + * @description The ID of the VPC from which the NFS share will be detached + * @example vpc-id-123 + */ + vpc_id: string; + }; + }; + nfs_action_switch_performance_tier: components["schemas"]["nfs_action"] & { + params?: { + /** + * @description The performance tier to which the NFS share will be switched (e.g., standard, high). + * @example standard + */ + performance_tier: string; + }; + }; + /** @description Action response of an NFS share. */ + nfs_actions_response: { + /** @description The action that was submitted. */ + action: { + /** + * @description The DigitalOcean region slug where the resource is located. + * @example atl1 + */ + region_slug: string; + /** + * Format: uuid + * @description The unique identifier of the resource on which the action is being performed. + * @example b5eb9e60-6750-4f3f-90b6-8296966eaf35 + */ + resource_id: string; + /** + * @description The type of resource on which the action is being performed. + * @example network_file_share + * @enum {string} + */ + resource_type: "network_file_share" | "network_file_share_snapshot"; + /** + * Format: date-time + * @description The timestamp when the action was started. + * @example 2025-10-14T11:55:31.615157397Z + */ + started_at: string; + /** + * @description The current status of the action. + * @example in-progress + * @enum {string} + */ + status: "in-progress" | "completed" | "errored"; + /** + * @description The type of action being performed. + * @example resize + */ + type: string; + }; + }; + /** @description Represents an NFS snapshot. */ + nfs_snapshot_response: { + /** + * @description The unique identifier of the snapshot. + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + */ + id: string; + /** + * @description The human-readable name of the snapshot. + * @example daily-backup + */ + name: string; + /** + * Format: uint64 + * @description The size of the snapshot in GiB. + * @example 1024 + */ + size_gib: number; + /** + * @description The DigitalOcean region slug where the snapshot is located. + * @example atl1 + */ + region: string; + /** + * @description The current status of the snapshot. + * @example CREATING + * @enum {string} + */ + status: "UNKNOWN" | "CREATING" | "ACTIVE" | "FAILED" | "DELETED"; + /** + * Format: date-time + * @description The timestamp when the snapshot was created. + * @example 2023-11-14T16:29:21Z + */ + created_at: string; + /** + * Format: uuid + * @description The unique identifier of the share from which this snapshot was created. + * @example 1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d + */ + share_id: string; + }; + nfs_snapshot_list_response: { + snapshots?: components["schemas"]["nfs_snapshot_response"][]; + }; + nfs_snapshot_get_response: { + snapshot?: components["schemas"]["nfs_snapshot_response"]; + }; + partner_attachment: { + /** + * Format: string + * @description A unique ID that can be used to identify and reference the partner attachment. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + readonly id?: string; + /** + * @description The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. + * @example env.prod-partner-network-connect + */ + name?: string; + /** + * @description The current operational state of the attachment. + * @example active + */ + readonly state?: string; + /** + * @description The bandwidth (in Mbps) of the connection. + * @example 1000 + */ + connection_bandwidth_in_mbps?: number; + /** + * @description The region where the partner attachment is located. + * @example nyc + */ + region?: string; + /** + * @description The Network as a Service (NaaS) provider for the partner attachment. + * @example megaport + */ + naas_provider?: string; + /** + * @description An array of VPC network IDs. + * @example [ + * "c140286f-e6ce-4131-8b7b-df4590ce8d6a", + * "994a2735-dc84-11e8-80bc-3cfdfea9fba1" + * ] + */ + vpc_ids?: string[]; + /** @description The BGP configuration for the partner attachment. */ + bgp?: { + /** + * @description ASN of the local router. + * @example 64532 + */ + local_asn?: number; + /** + * @description ASN of the peer router + * @example 64532 + */ + peer_asn?: number; + /** + * @description IP of the DigitalOcean router + * @example 169.254.0.1/29 + */ + local_router_ip?: string; + /** + * @description IP of the peer router + * @example 169.254.0.1/29 + */ + peer_router_ip?: 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 Associated partner attachment UUID + * @example 34259a41-0ca6-4a6b-97dd-a22bcab900dd + */ + readonly parent_uuid?: string; + /** + * @description An array of associated partner attachment UUIDs. + * @example [ + * "ee1ad867-7026-44a5-bfcc-2587b52e1291" + * ] + */ + readonly children?: string[]; + }; + partner_attachment_writable: { + /** + * @description The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. + * @example env.prod-partner-network-connect + */ + name: string; + /** + * @description Bandwidth (in Mbps) of the connection. + * @example 1000 + * @enum {integer} + */ + connection_bandwidth_in_mbps: 1000 | 2000 | 5000 | 10000; + /** + * @description The region to create the partner attachment. + * @example nyc + * @enum {string} + */ + region: "nyc" | "sfo" | "fra" | "ams" | "sgp"; + /** @example megaport */ + naas_provider: string; + /** + * @description An array of VPCs IDs. + * @example [ + * "c140286f-e6ce-4131-8b7b-df4590ce8d6a", + * "994a2735-dc84-11e8-80bc-3cfdfea9fba1" + * ] + */ + vpc_ids: string[]; + /** + * @description Optional associated partner attachment UUID + * @example d594cf8d-8c79-4bc5-aec1-6f9b211506b3 + */ + parent_uuid?: string; + /** @description Optional BGP configurations */ + bgp?: { + /** + * @description IP of the DO router + * @example 169.254.0.1/29 + */ + local_router_ip: string; + /** + * @description IP of the Naas Provider router + * @example 169.254.0.6/29 + */ + peer_router_ip: string; + /** + * @description ASN of the peer router + * @example 64532 + */ + peer_router_asn: number; + /** + * @description BGP Auth Key + * @example 0xsNnb1pwQlowdoMySEfWwk4I + */ + auth_key: string; + }; + /** + * @description Optional redundancy zone for the partner attachment. + * @example MEGAPORT_BLUE + * @enum {string} + */ + redundancy_zone?: "MEGAPORT_BLUE" | "MEGAPORT_RED"; + }; + partner_attachment_updatable: { + /** + * @description The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. + * @example env.prod-partner-network-connect + */ + name: string; + } | { + /** + * @description An array of VPCs IDs. + * @example [ + * "c140286f-e6ce-4131-8b7b-df4590ce8d6a", + * "994a2735-dc84-11e8-80bc-3cfdfea9fba1" + * ] + */ + vpc_ids: string[]; + } | { + /** @description BGP configurations */ + bgp?: { + /** + * @description IP of the DO router + * @example 169.254.0.1/29 + */ + local_router_ip: string; + /** + * @description IP of the NaaS provider router + * @example 169.254.0.6/29 + */ + peer_router_ip: string; + /** + * @description ASN of the peer router + * @example 64532 + */ + peer_router_asn: number; + /** + * @description BGP Auth Key + * @example 0xsNnb1pwQlowdoMySEfWwk4I + */ + auth_key: string; + }; + }; + partner_attachment_service_key: { + /** @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 */ + readonly value?: string; + /** + * Format: date-time + * @description A time value given in the ISO 8601 combined date and time format. + * @example 2020-03-13T19:20:47.442049222Z + */ + readonly created_at?: string; + /** @example CREATED */ + readonly state?: string; + }; + partner_attachment_remote_route: { + /** + * @description A CIDR block representing a remote route. + * @example 10.10.10.0/24 + */ + readonly cidr?: string; + }; project_base: { /** * Format: uuid @@ -14489,13 +19010,42 @@ export interface components { }; project_assignment: { /** - * @description A list of uniform resource names (URNs) to be added to a project. + * @description A list of uniform resource names (URNs) to be added to a project. Only resources that you are authorized to see will be returned. * @example [ * "do:droplet:13457723" * ] */ resources?: components["schemas"]["urn"][]; }; + registry_base: { + /** + * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. + * @example example + */ + name?: string; + /** + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the registry was created. + * @example 2020-03-21T16:02:37Z + */ + readonly created_at?: string; + /** + * @description Slug of the region where registry data is stored + * @example fra1 + */ + region?: string; + /** + * @description The amount of storage used in the registry in bytes. + * @example 29393920 + */ + readonly storage_usage_bytes?: number; + /** + * Format: date-time + * @description The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry. + * @example 2020-11-04T21:39:49.530562231Z + */ + readonly storage_usage_bytes_updated_at?: string; + }; subscription_tier_base: { /** * @description The name of the subscription tier. @@ -14553,37 +19103,10 @@ export interface components { */ readonly updated_at?: string; }; - registry: { - /** - * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. - * @example example - */ - name?: string; - /** - * Format: date-time - * @description A time value given in ISO8601 combined date and time format that represents when the registry was created. - * @example 2020-03-21T16:02:37Z - */ - readonly created_at?: string; - /** - * @description Slug of the region where registry data is stored - * @example fra1 - */ - region?: string; - /** - * @description The amount of storage used in the registry in bytes. - * @example 29393920 - */ - readonly storage_usage_bytes?: number; - /** - * Format: date-time - * @description The time at which the storage usage was updated. Storage usage is calculated asynchronously, and may not immediately reflect pushes to the registry. - * @example 2020-11-04T21:39:49.530562231Z - */ - readonly storage_usage_bytes_updated_at?: string; + registry: components["schemas"]["registry_base"] & { subscription?: unknown & components["schemas"]["subscription"]; }; - registry_create: { + multiregistry_create: { /** * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. * @example example @@ -14594,14 +19117,15 @@ export interface components { * @example basic * @enum {string} */ - subscription_tier_slug: "starter" | "basic" | "professional"; + subscription_tier_slug?: "starter" | "basic" | "professional"; /** * @description Slug of the region where registry data is stored. When not provided, a region will be selected. * @example fra1 * @enum {string} */ - region?: "nyc3" | "sfo3" | "ams3" | "sgp1" | "fra1"; + region?: "nyc3" | "sfo3" | "sfo2" | "ams3" | "sgp1" | "fra1" | "blr1" | "syd1"; }; + multiregistry: components["schemas"]["registry_base"]; docker_credentials: { auths?: { "registry.digitalocean.com"?: { @@ -14613,68 +19137,66 @@ export interface components { }; }; }; - validate_registry: { - /** - * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. - * @example example - */ - name: string; - }; - repository_tag: { + subscription_tier_extended: { /** - * @description The name of the container registry. - * @example example + * @description A boolean indicating whether your account it eligible to use a certain subscription tier. + * @example true */ - registry_name?: string; + eligible?: boolean; /** - * @description The name of the repository. - * @example repo-1 + * @description If your account is not eligible to use a certain subscription tier, this will include a list of reasons that prevent you from using the tier. + * @example [ + * "OverRepositoryLimit" + * ] */ - repository?: string; + eligibility_reasons?: ("OverRepositoryLimit" | "OverStorageLimit")[]; + }; + garbage_collection: { /** - * @description The name of the tag. - * @example latest + * @description A string specifying the UUID of the garbage collection. + * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 */ - tag?: string; + uuid?: string; /** - * @description The digest of the manifest associated with the tag. - * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 + * @description The name of the container registry. + * @example example */ - manifest_digest?: string; + registry_name?: string; /** - * @description The compressed size of the tag in bytes. - * @example 2803255 + * @description The current status of this garbage collection. + * @example requested + * @enum {string} */ - compressed_size_bytes?: number; + status?: "requested" | "waiting for write JWTs to expire" | "scanning manifests" | "deleting unreferenced blobs" | "cancelling" | "failed" | "succeeded" | "cancelled"; /** - * @description The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available). - * @example 5861888 + * Format: date-time + * @description The time the garbage collection was created. + * @example 2020-10-30T21:03:24Z */ - size_bytes?: number; + created_at?: string; /** * Format: date-time - * @description The time the tag was last updated. - * @example 2020-04-09T23:54:25Z + * @description The time the garbage collection was last updated. + * @example 2020-10-30T21:03:44Z */ updated_at?: string; - }; - repository: { /** - * @description The name of the container registry. - * @example example + * @description The number of blobs deleted as a result of this garbage collection. + * @example 42 */ - registry_name?: string; + blobs_deleted?: number; /** - * @description The name of the repository. - * @example repo-1 + * @description The number of bytes freed as a result of this garbage collection. + * @example 667 */ - name?: string; - latest_tag?: components["schemas"]["repository_tag"]; + freed_bytes?: number; + }; + update_registry: { /** - * @description The number of tags in the repository. - * @example 1 + * @description A boolean value indicating that the garbage collection should be cancelled. + * @example true */ - tag_count?: number; + cancel?: boolean; }; repository_blob: { /** @@ -14755,66 +19277,95 @@ export interface components { */ manifest_count?: number; }; - garbage_collection: { - /** - * @description A string specifying the UUID of the garbage collection. - * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 - */ - uuid?: string; + repository_tag: { /** * @description The name of the container registry. * @example example */ registry_name?: string; /** - * @description The current status of this garbage collection. - * @example requested - * @enum {string} + * @description The name of the repository. + * @example repo-1 */ - status?: "requested" | "waiting for write JWTs to expire" | "scanning manifests" | "deleting unreferenced blobs" | "cancelling" | "failed" | "succeeded" | "cancelled"; + repository?: string; /** - * Format: date-time - * @description The time the garbage collection was created. - * @example 2020-10-30T21:03:24Z + * @description The name of the tag. + * @example latest */ - created_at?: string; + tag?: string; + /** + * @description The digest of the manifest associated with the tag. + * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 + */ + manifest_digest?: string; + /** + * @description The compressed size of the tag in bytes. + * @example 2803255 + */ + compressed_size_bytes?: number; + /** + * @description The uncompressed size of the tag in bytes (this size is calculated asynchronously so it may not be immediately available). + * @example 5861888 + */ + size_bytes?: number; /** * Format: date-time - * @description The time the garbage collection was last updated. - * @example 2020-10-30T21:03:44Z + * @description The time the tag was last updated. + * @example 2020-04-09T23:54:25Z */ updated_at?: string; + }; + validate_registry: { /** - * @description The number of blobs deleted as a result of this garbage collection. - * @example 42 + * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. + * @example example */ - blobs_deleted?: number; + name: string; + }; + registry_create: { /** - * @description The number of bytes freed as a result of this garbage collection. - * @example 667 + * @description A globally unique name for the container registry. Must be lowercase and be composed only of numbers, letters and `-`, up to a limit of 63 characters. + * @example example */ - freed_bytes?: number; - }; - update_registry: { + name: string; /** - * @description A boolean value indicating that the garbage collection should be cancelled. - * @example true + * @description The slug of the subscription tier to sign up for. Valid values can be retrieved using the options endpoint. + * @example basic + * @enum {string} */ - cancel?: boolean; + subscription_tier_slug: "starter" | "basic" | "professional"; + /** + * @description Slug of the region where registry data is stored. When not provided, a region will be selected. + * @example fra1 + * @enum {string} + */ + region?: "nyc3" | "sfo3" | "ams3" | "sgp1" | "fra1"; }; - subscription_tier_extended: { + repository: { /** - * @description A boolean indicating whether your account it eligible to use a certain subscription tier. - * @example true + * @description The name of the container registry. + * @example example */ - eligible?: boolean; + registry_name?: string; /** - * @description If your account is not eligible to use a certain subscription tier, this will include a list of reasons that prevent you from using the tier. - * @example [ - * "OverRepositoryLimit" - * ] + * @description The name of the repository. + * @example repo-1 */ - eligibility_reasons?: ("OverRepositoryLimit" | "OverStorageLimit")[]; + name?: string; + latest_tag?: components["schemas"]["repository_tag"]; + /** + * @description The number of tags in the repository. + * @example 1 + */ + tag_count?: number; + }; + registry_run_gc: { + /** + * @description Type of the garbage collection to run against this registry + * @example unreferenced blobs only + * @enum {string} + */ + type?: "untagged manifests only" | "unreferenced blobs only" | "untagged manifests and unreferenced blobs"; }; neighbor_ids: { /** @@ -14842,7 +19393,7 @@ export interface components { ip?: string; region?: components["schemas"]["region"] & Record; /** - * @description The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. + * @description The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Requires `droplet:read` scope. * @example null */ droplet?: (Record | null) | components["schemas"]["droplet"]; @@ -14853,7 +19404,7 @@ export interface components { locked?: boolean; /** * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. + * @description The UUID of the project to which the reserved IP currently belongs.

Requires `project:read` scope. * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 */ project_id?: string; @@ -14904,6 +19455,205 @@ export interface components { */ type: "unassign"; }; + reserved_ipv6_list: { + reserved_ipv6s?: { + /** + * Format: ipv6 + * @description The public IP address of the reserved IPv6. It also serves as its identifier. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + */ + ip?: string; + /** + * @description The region that the reserved IPv6 is reserved to. When you query a reserved IPv6,the region_slug will be returned. + * @example nyc3 + */ + region_slug?: string; + /** + * Format: date-time + * @example 2020-01-01T00:00:00Z + */ + reserved_at?: string; + /** + * @description Requires `droplet:read` scope. + * @example null + */ + droplet?: (Record | null) | components["schemas"]["droplet"]; + }[]; + }; + /** Reserve to Region */ + reserved_ipv6_create: { + /** + * @description The slug identifier for the region the reserved IPv6 will be reserved to. + * @example nyc3 + */ + region_slug: string; + }; + reserved_ipv6: { + /** + * Format: ipv6 + * @description The public IP address of the reserved IPv6. It also serves as its identifier. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + */ + ip?: string; + /** + * Format: date-time + * @description The date and time when the reserved IPv6 was reserved. + * @example 2024-11-20T11:08:30Z + */ + reserved_at?: string; + /** + * @description The region that the reserved IPv6 is reserved to. When you query a reserved IPv6,the region_slug will be returned. + * @example nyc3 + */ + region_slug?: string; + /** @example null */ + droplet?: (Record | null) | components["schemas"]["droplet"]; + }; + reserved_ipv6_action_type: { + /** + * @description The type of action to initiate for the reserved IPv6. + * @enum {string} + */ + type: "assign" | "unassign"; + }; + reserved_ipv6_action_assign: Omit & { + /** + * @description The ID of the Droplet that the reserved IPv6 will be assigned to. + * @example 758604968 + */ + droplet_id: number; + } & { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + type: "assign"; + }; + reserved_ipv6_action_unassign: Omit & Record & { + /** + * @description discriminator enum property added by openapi-typescript + * @enum {string} + */ + type: "unassign"; + }; + byoip_prefix: { + /** + * @description Unique identifier for the BYOIP prefix + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 + */ + uuid?: string; + /** + * @description Name of the BYOIP prefix + * @example + */ + name?: string; + /** + * @description The IP prefix in CIDR notation + * @example 203.0.113.0/24 + */ + prefix?: string; + /** + * @description Status of the BYOIP prefix + * @example active + */ + status?: string; + /** + * @description Region where the BYOIP prefix is located + * @example nyc3 + */ + region?: string; + /** @description List of validation statuses for the BYOIP prefix */ + validations?: { + /** + * @description Name of the validation + * @example SIGNATURE HASH + */ + name?: string; + /** + * @description Status of the validation + * @example FAILED + */ + status?: string; + /** + * @description Additional notes or details about the validation + * @example + */ + note?: string; + }[]; + /** + * @description Reason for failure, if applicable + * @example + */ + failure_reason?: string; + /** + * @description Whether the BYOIP prefix is locked + * @example false + */ + locked?: boolean; + /** + * @description Whether the BYOIP prefix is being advertised + * @example true + */ + advertised?: boolean; + /** + * @description The ID of the project associated with the BYOIP prefix + * @example 12345678-1234-1234-1234-123456789012 + */ + project_id?: string; + }; + byoip_prefix_create: { + /** + * @description The IP prefix in CIDR notation to bring + * @example 203.11.13.0/24 + */ + prefix: string; + /** + * @description The region where the prefix will be created + * @example nyc3 + */ + region: string; + /** + * @description The signature hash for the prefix creation request + * @example + */ + signature: string; + }; + byoip_prefix_update: { + /** + * @description Whether the BYOIP prefix should be advertised + * @example true + */ + advertise?: boolean; + }; + byoip_prefix_resource: { + /** + * Format: int64 + * @description Unique identifier for the allocation + * @example 10001 + */ + id?: number; + /** + * @description The BYOIP prefix UUID + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 + */ + byoip?: string; + /** + * @description Region where the allocation is made + * @example nyc3 + */ + region?: string; + /** + * @description The resource associated with the allocation + * @example do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d479 + */ + resource?: string; + /** + * Format: date-time + * @description Time when the allocation was assigned + * @example 2025-06-25T12:00:00Z + */ + assigned_at?: string; + }; snapshots: { /** * @description The unique identifier for the snapshot. @@ -14923,7 +19673,7 @@ export interface components { */ resource_type: "droplet" | "volume"; /** - * @description An array of Tags the snapshot has been tagged with. + * @description An array of Tags the snapshot has been tagged with.

Requires `tag:read` scope. * @example [ * "web", * "env:prod" @@ -14931,6 +19681,48 @@ export interface components { */ tags: string[] | null; }; + grant: { + /** + * @description The name of the bucket. + * @example my-bucket + */ + bucket: string; + /** + * @description The permission to grant to the user. Possible values are `read`, `readwrite`, `fullaccess`, or an empty string. + * @example read + */ + permission: string; + }; + key: { + /** + * @description The access key's name. + * @example my-access-key + */ + name?: string; + /** + * @description The list of permissions for the access key. + * @default [] + */ + grants: components["schemas"]["grant"][]; + /** + * @description The Access Key ID used to access a bucket. + * @example DOACCESSKEYEXAMPLE + */ + readonly access_key?: string; + /** + * Format: date-time + * @description The date and time the key was created. + * @example 2018-07-19T15:04:16Z + */ + readonly created_at?: string; + }; + key_create_response: { + /** + * @description The secret key used to access the bucket. We return secret keys only once upon creation. Make sure to copy the key and securely store it. + * @example DOSECRETKEYEXAMPLE + */ + readonly secret_key?: string; + } & components["schemas"]["key"]; /** @description Tagged Resource Statistics include metadata regarding the resource type that has been tagged. */ tags_metadata: { /** @@ -14962,7 +19754,10 @@ export interface components { */ name?: string; /** - * @description An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag. + * @description An embedded object containing key value pairs of resource type and resource statistics. + * It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag. + * + * This will only include resources that you are authorized to see. For example, to see tagged Droplets, include the `droplet:read` scope. * @example { * "count": 5, * "last_tagged_uri": "https://api.digitalocean.com/v2/images/7555620", @@ -14989,11 +19784,11 @@ export interface components { * } */ readonly resources?: components["schemas"]["tags_metadata"] & { - droplets?: components["schemas"]["tags_metadata"]; - imgages?: components["schemas"]["tags_metadata"]; - volumes?: components["schemas"]["tags_metadata"]; - volume_snapshots?: components["schemas"]["tags_metadata"]; - databases?: components["schemas"]["tags_metadata"]; + droplets?: unknown & components["schemas"]["tags_metadata"]; + imgages?: unknown & components["schemas"]["tags_metadata"]; + volumes?: unknown & components["schemas"]["tags_metadata"]; + volume_snapshots?: unknown & components["schemas"]["tags_metadata"]; + databases?: unknown & components["schemas"]["tags_metadata"]; }; }; error_with_root_causes: { @@ -15015,7 +19810,11 @@ export interface components { }; tags_resource: { /** - * @description An array of objects containing resource_id and resource_type attributes. + * @description An array of objects containing resource_id and resource_type + * attributes. + * + * This response will only include resources that you are authorized to see. + * For example, to see Droplets, include the `droplet:read` scope. * @example [ * { * "resource_id": "9569411", @@ -15045,7 +19844,15 @@ export interface components { resource_type?: "droplet" | "image" | "volume" | "volume_snapshot"; }[]; }; - volume_base: { + /** + * @description A flat array of tag names as strings applied to the resource.

Requires `tag:read` scope. + * @example [ + * "base-image", + * "prod" + * ] + */ + tags_array_read: string[] | null; + volume_base_read: { /** * @description The unique identifier for the block storage volume. * @example 506f78a4-e098-11e5-ad9f-000f53306ae1 @@ -15076,9 +19883,9 @@ export interface components { * @example 2020-03-02T17:00:49Z */ readonly created_at?: string; - tags?: components["schemas"]["tags_array"]; + tags?: components["schemas"]["tags_array_read"]; }; - volume_full: components["schemas"]["volume_base"] & { + volume_full: components["schemas"]["volume_base_read"] & { /** * @example { * "name": "New York 1", @@ -15120,6 +19927,39 @@ export interface components { */ filesystem_label?: string; }; + volume_base: { + /** + * @description The unique identifier for the block storage volume. + * @example 506f78a4-e098-11e5-ad9f-000f53306ae1 + */ + readonly id?: string; + /** + * @description An array containing the IDs of the Droplets the volume is attached to. Note that at this time, a volume can only be attached to a single Droplet. + * @example [] + */ + readonly droplet_ids?: number[] | null; + /** + * @description A human-readable name for the block storage volume. Must be lowercase and be composed only of numbers, letters and "-", up to a limit of 64 characters. The name must begin with a letter. + * @example example + */ + name?: string; + /** + * @description An optional free-form text field to describe a block storage volume. + * @example Block store for examples + */ + description?: string; + /** + * @description The size of the block storage volume in GiB (1024^3). This field does not apply when creating a volume from a snapshot. + * @example 10 + */ + size_gigabytes?: number; + /** + * @description A time value given in ISO8601 combined date and time format that represents when the block storage volume was created. + * @example 2020-03-02T17:00:49Z + */ + readonly created_at?: string; + tags?: components["schemas"]["tags_array"]; + }; volume_snapshot_id: { /** * @description The unique identifier for the volume snapshot from which to create the volume. @@ -15212,6 +20052,11 @@ export interface components { */ default?: boolean; }; + /** + * @description The uniform resource name (URN) for the resource in the format do:resource_type:resource_id. + * @example do:vpc:5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + "urn-2": string; vpc_base: { /** * Format: uuid @@ -15219,7 +20064,7 @@ export interface components { * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 */ readonly id?: string; - urn?: components["schemas"]["urn"]; + urn?: components["schemas"]["urn-2"]; /** * Format: date-time * @description A time value given in ISO8601 combined date and time format. @@ -15279,96 +20124,276 @@ export interface components { name?: string; }; vpc_peering: components["schemas"]["vpc_peering_base"] & components["schemas"]["vpc_peering_create"] & components["schemas"]["vpc_peering_updatable"]; - check_base: { + vpc_nat_gateway_get: { /** - * Format: uuid - * @description A unique ID that can be used to identify and reference the check. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description The unique identifier for the VPC NAT gateway. This is automatically generated upon creation. + * @example 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 */ - readonly id?: string; - }; - check_updatable: { + id?: string; /** - * @description A human-friendly display name. - * @example Landing page check + * @description The human-readable name of the VPC NAT gateway. + * @example my-vpc-nat-gateway */ name?: string; /** - * @description The type of health check to perform. - * @example https + * @description The type of the VPC NAT gateway. + * @example PUBLIC * @enum {string} */ - type?: "ping" | "http" | "https"; + type?: "PUBLIC"; /** - * Format: url - * @description The endpoint to perform healthchecks on. - * @example https://www.landingpage.com + * @description The current state of the VPC NAT gateway. + * @example ACTIVE + * @enum {string} */ - target?: string; + state?: "NEW" | "PROVISIONING" | "ACTIVE" | "DELETING" | "ERROR" | "INVALID"; /** - * @description An array containing the selected regions to perform healthchecks from. - * @example [ - * "us_east", - * "eu_west" - * ] + * @description The region in which the VPC NAT gateway is created. + * @example tor1 + * @enum {string} */ - regions?: ("us_east" | "us_west" | "eu_west" | "se_asia")[]; + region?: "nyc1" | "nyc2" | "nyc3" | "ams2" | "ams3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "lon1" | "fra1" | "tor1" | "blr1" | "syd1" | "atl1"; /** - * @description A boolean value indicating whether the check is enabled/disabled. - * @default true - * @example true + * @description The size of the VPC NAT gateway. + * @example 1 */ - enabled: boolean; - }; - check: components["schemas"]["check_base"] & components["schemas"]["check_updatable"]; - region_state: { + size?: number; + /** @description An array of VPCs associated with the VPC NAT gateway. */ + vpcs?: { + /** + * @description The unique identifier of the VPC to which the NAT gateway is attached. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + vpc_uuid?: string; + /** + * @description The gateway IP address of the VPC NAT gateway. + * @example 10.118.0.35 + */ + gateway_ip?: string; + }[]; + /** @description An object containing egress information for the VPC NAT gateway. */ + egresses?: { + /** @description An array of public gateway IP addresses for the VPC NAT gateway. */ + public_gateways?: { + /** + * @description IPv4 address of the public gateway. + * @example 174.138.113.197 + */ + ipv4?: string; + }[]; + }; /** - * @example UP - * @enum {string} + * @description The UDP timeout in seconds for the VPC NAT gateway. + * @example 30 */ - status?: "DOWN" | "UP" | "CHECKING"; - /** @example 2022-03-17T22:28:51Z */ - status_changed_at?: string; - /** @example 97.99 */ - thirty_day_uptime_percentage?: number; - }; - /** @description A map of region to regional state */ - regional_state: { - us_east?: components["schemas"]["region_state"]; - eu_west?: components["schemas"]["region_state"]; - }; - previous_outage: { - /** @example us_east */ - region?: string; - /** @example 2022-03-17T18:04:55Z */ - started_at?: string; - /** @example 2022-03-17T18:06:55Z */ - ended_at?: string; - /** @example 120 */ - duration_seconds?: number; - }; - state: { - regions?: components["schemas"]["regional_state"]; - previous_outage?: components["schemas"]["previous_outage"]; - }; - alert_base: { + udp_timeout_seconds?: number; /** - * Format: uuid - * @description A unique ID that can be used to identify and reference the alert. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description The ICMP timeout in seconds for the VPC NAT gateway. + * @example 30 */ - readonly id?: string; - }; - /** @description The notification settings for a trigger alert. */ - notification: { + icmp_timeout_seconds?: number; /** - * @description An email to notify on an alert trigger. The Email has to be one that is verified on that DigitalOcean account. - * @example [ - * "bob@example.com" - * ] + * @description The TCP timeout in seconds for the VPC NAT gateway. + * @example 30 */ - email: string[]; - /** @description Slack integration details. */ + tcp_timeout_seconds?: number; + /** + * The creation time of the VPC NAT gateway. + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the VPC NAT gateway was created. + * @example 2020-07-28T18:00:00Z + */ + created_at?: string; + /** + * The last update time of the VPC NAT gateway. + * Format: date-time + * @description A time value given in ISO8601 combined date and time format that represents when the VPC NAT gateway was last updated. + * @example 2020-07-28T18:00:00Z + */ + updated_at?: string; + }; + vpc_nat_gateway_create: { + /** + * @description The human-readable name of the VPC NAT gateway. + * @example my-vpc-nat-gateway + */ + name: string; + /** + * @description The type of the VPC NAT gateway. + * @example PUBLIC + * @enum {string} + */ + type: "PUBLIC"; + /** + * @description The region in which the VPC NAT gateway is created. + * @example tor1 + * @enum {string} + */ + region: "nyc1" | "nyc2" | "nyc3" | "ams2" | "ams3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "lon1" | "fra1" | "tor1" | "blr1" | "syd1" | "atl1"; + /** + * @description The size of the VPC NAT gateway. + * @example 1 + */ + size: number; + /** @description An array of VPCs associated with the VPC NAT gateway. */ + vpcs: { + /** + * @description The unique identifier of the VPC to which the NAT gateway is attached. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + vpc_uuid: string; + /** + * @description The classification of the NAT gateway as the default egress route for the VPC traffic. + * @example true + */ + default_gateway?: boolean; + }[]; + /** + * @description The UDP timeout in seconds for the VPC NAT gateway. + * @example 30 + */ + udp_timeout_seconds?: number; + /** + * @description The ICMP timeout in seconds for the VPC NAT gateway. + * @example 30 + */ + icmp_timeout_seconds?: number; + /** + * @description The TCP timeout in seconds for the VPC NAT gateway. + * @example 30 + */ + tcp_timeout_seconds?: number; + }; + vpc_nat_gateway_update: { + /** + * @description The human-readable name of the VPC NAT gateway. + * @example my-vpc-nat-gateway + */ + name: string; + /** + * @description The size of the VPC NAT gateway. + * @example 1 + */ + size: number; + /** @description An array of VPCs associated with the VPC NAT gateway. */ + vpcs?: { + /** + * @description The unique identifier of the VPC to which the NAT gateway is attached. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + vpc_uuid?: string; + /** + * @description The classification of the NAT gateway as the default egress route for the VPC traffic. + * @example false + */ + default_gateway?: boolean; + }[]; + /** + * @description The UDP timeout in seconds for the VPC NAT gateway. + * @example 30 + */ + udp_timeout_seconds?: number; + /** + * @description The ICMP timeout in seconds for the VPC NAT gateway. + * @example 30 + */ + icmp_timeout_seconds?: number; + /** + * @description The TCP timeout in seconds for the VPC NAT gateway. + * @example 30 + */ + tcp_timeout_seconds?: number; + }; + check_base: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference the check. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + readonly id?: string; + }; + check_updatable: { + /** + * @description A human-friendly display name. + * @example Landing page check + */ + name?: string; + /** + * @description The type of health check to perform. + * @example https + * @enum {string} + */ + type?: "ping" | "http" | "https"; + /** + * Format: url + * @description The endpoint to perform healthchecks on. + * @example https://www.landingpage.com + */ + target?: string; + /** + * @description An array containing the selected regions to perform healthchecks from. + * @example [ + * "us_east", + * "eu_west" + * ] + */ + regions?: ("us_east" | "us_west" | "eu_west" | "se_asia")[]; + /** + * @description A boolean value indicating whether the check is enabled/disabled. + * @default true + * @example true + */ + enabled: boolean; + }; + check: components["schemas"]["check_base"] & components["schemas"]["check_updatable"]; + region_state: { + /** + * @example UP + * @enum {string} + */ + status?: "DOWN" | "UP" | "CHECKING"; + /** @example 2022-03-17T22:28:51Z */ + status_changed_at?: string; + /** @example 97.99 */ + thirty_day_uptime_percentage?: number; + }; + /** @description A map of region to regional state */ + regional_state: { + us_east?: components["schemas"]["region_state"]; + eu_west?: components["schemas"]["region_state"]; + }; + previous_outage: { + /** @example us_east */ + region?: string; + /** @example 2022-03-17T18:04:55Z */ + started_at?: string; + /** @example 2022-03-17T18:06:55Z */ + ended_at?: string; + /** @example 120 */ + duration_seconds?: number; + }; + state: { + regions?: components["schemas"]["regional_state"]; + previous_outage?: components["schemas"]["previous_outage"]; + }; + alert_base: { + /** + * Format: uuid + * @description A unique ID that can be used to identify and reference the alert. + * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + */ + readonly id?: string; + }; + /** @description The notification settings for a trigger alert. */ + notification: { + /** + * @description An email to notify on an alert trigger. The Email has to be one that is verified on that DigitalOcean account. + * @example [ + * "bob@example.com" + * ] + */ + email: string[]; + /** @description Slack integration details. */ slack: { /** * Format: string @@ -15418,27 +20443,33 @@ export interface components { alert: components["schemas"]["alert_base"] & components["schemas"]["alert_updatable"]; /** @description A Chatbot */ apiChatbot: { - /** @example "example string" */ + /** + * @example [ + * "example string" + * ] + */ + allowed_domains?: string[]; + /** @example example string */ button_background_color?: string; - /** @example "example string" */ + /** @example example string */ logo?: string; /** * @description Name of chatbot - * @example "example name" + * @example example name */ name?: string; - /** @example "example string" */ + /** @example example string */ primary_color?: string; - /** @example "example string" */ + /** @example example string */ secondary_color?: string; - /** @example "example string" */ + /** @example example string */ starting_message?: string; }; /** @description Agent Chatbot Identifier */ apiAgentChatbotIdentifier: { /** * @description Agent chatbot identifier - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ agent_chatbot_identifier?: string; }; @@ -15447,7 +20478,7 @@ export interface components { * @example STATUS_UNKNOWN * @enum {string} */ - apiDeploymentStatus: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | "STATUS_RUNNING" | "STATUS_FAILED" | "STATUS_WAITING_FOR_UNDEPLOYMENT" | "STATUS_UNDEPLOYING" | "STATUS_UNDEPLOYMENT_FAILED" | "STATUS_DELETED"; + apiDeploymentStatus: "STATUS_UNKNOWN" | "STATUS_WAITING_FOR_DEPLOYMENT" | "STATUS_DEPLOYING" | "STATUS_RUNNING" | "STATUS_FAILED" | "STATUS_WAITING_FOR_UNDEPLOYMENT" | "STATUS_UNDEPLOYING" | "STATUS_UNDEPLOYMENT_FAILED" | "STATUS_DELETED" | "STATUS_BUILDING"; /** * @description - VISIBILITY_UNKNOWN: The status of the deployment is unknown * - VISIBILITY_DISABLED: The deployment is disabled and will no longer service requests @@ -15469,7 +20500,7 @@ export interface components { created_at?: string; /** * @description Name - * @example "example name" + * @example example name */ name?: string; status?: components["schemas"]["apiDeploymentStatus"]; @@ -15481,25 +20512,25 @@ export interface components { updated_at?: string; /** * @description Access your deployed agent here - * @example "example string" + * @example example string */ url?: string; /** * @description Unique id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; visibility?: components["schemas"]["apiDeploymentVisibility"]; }; /** @description Agreement Description */ apiAgreement: { - /** @example "example string" */ + /** @example example string */ description?: string; - /** @example "example name" */ + /** @example example name */ name?: string; - /** @example "example string" */ + /** @example example string */ url?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; /** @@ -15507,7 +20538,20 @@ export interface components { * @example MODEL_PROVIDER_DIGITALOCEAN * @enum {string} */ - apiModelProvider: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC"; + apiModelProvider: "MODEL_PROVIDER_DIGITALOCEAN" | "MODEL_PROVIDER_ANTHROPIC" | "MODEL_PROVIDER_OPENAI"; + /** + * @description - MODEL_USECASE_UNKNOWN: The use case of the model is unknown + * - MODEL_USECASE_AGENT: The model maybe used in an agent + * - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning + * - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) + * - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + * - MODEL_USECASE_REASONING: The model usecase for reasoning + * - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference + * @default MODEL_USECASE_UNKNOWN + * @example MODEL_USECASE_UNKNOWN + * @enum {string} + */ + apiModelUsecase: "MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | "MODEL_USECASE_KNOWLEDGEBASE" | "MODEL_USECASE_GUARDRAIL" | "MODEL_USECASE_REASONING" | "MODEL_USECASE_SERVERLESS"; /** @description Version Information about a Model */ apiModelVersion: { /** @@ -15540,12 +20584,12 @@ export interface components { created_at?: string; /** * @description Internally used name - * @example "example name" + * @example example name */ inference_name?: string; /** * @description Internally used version - * @example "example string" + * @example example string */ inference_version?: string; /** @@ -15553,16 +20597,34 @@ export interface components { * @example true */ is_foundational?: boolean; + /** + * Format: int64 + * @description Default chunking size limit to show in UI + * @example 123 + */ + kb_default_chunk_size?: number; + /** + * Format: int64 + * @description Maximum chunk size limit of model + * @example 123 + */ + kb_max_chunk_size?: number; + /** + * Format: int64 + * @description Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase + * @example 123 + */ + kb_min_chunk_size?: number; /** @description Additional meta data */ metadata?: Record; /** * @description Name of the model - * @example "example name" + * @example example name */ name?: string; /** * @description Unique id of the model, this model is based on - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ parent_uuid?: string; provider?: components["schemas"]["apiModelProvider"]; @@ -15579,22 +20641,144 @@ export interface components { upload_complete?: boolean; /** * @description Download url - * @example "example string" + * @example example string */ url?: string; + /** + * @description Usecases of the model + * @example [ + * "MODEL_USECASE_AGENT", + * "MODEL_USECASE_GUARDRAIL" + * ] + */ + usecases?: components["schemas"]["apiModelUsecase"][]; /** * @description Unique id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; version?: components["schemas"]["apiModelVersion"]; }; + /** + * @description - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown + * - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite + * - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back + * - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries + * - RETRIEVAL_METHOD_NONE: The retrieval method is none + * @default RETRIEVAL_METHOD_UNKNOWN + * @example RETRIEVAL_METHOD_UNKNOWN + * @enum {string} + */ + apiRetrievalMethod: "RETRIEVAL_METHOD_UNKNOWN" | "RETRIEVAL_METHOD_REWRITE" | "RETRIEVAL_METHOD_STEP_BACK" | "RETRIEVAL_METHOD_SUB_QUERIES" | "RETRIEVAL_METHOD_NONE"; + apiAgentTemplateGuardrail: { + /** + * Format: int32 + * @description Priority of the guardrail + * @example 123 + */ + priority?: number; + /** + * @description Uuid of the guardrail + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + }; + /** + * @default DATA_SOURCE_STATUS_UNKNOWN + * @example DATA_SOURCE_STATUS_UNKNOWN + * @enum {string} + */ + apiIndexedDataSourceStatus: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | "DATA_SOURCE_STATUS_PARTIALLY_UPDATED" | "DATA_SOURCE_STATUS_NOT_UPDATED" | "DATA_SOURCE_STATUS_FAILED" | "DATA_SOURCE_STATUS_CANCELLED"; + apiIndexedDataSource: { + /** + * Format: date-time + * @description Timestamp when data source completed indexing + * @example 2023-01-01T00:00:00Z + */ + completed_at?: string; + /** + * @description Uuid of the indexed data source + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + data_source_uuid?: string; + /** + * @description A detailed error description + * @example example string + */ + error_details?: string; + /** + * @description A string code provinding a hint which part of the system experienced an error + * @example example string + */ + error_msg?: string; + /** + * Format: uint64 + * @description Total count of files that have failed + * @example 12345 + */ + failed_item_count?: string; + /** + * Format: uint64 + * @description Total count of files that have been indexed + * @example 12345 + */ + indexed_file_count?: string; + /** + * Format: uint64 + * @description Total count of files that have been indexed + * @example 12345 + */ + indexed_item_count?: string; + /** + * Format: uint64 + * @description Total count of files that have been removed + * @example 12345 + */ + removed_item_count?: string; + /** + * Format: uint64 + * @description Total count of files that have been skipped + * @example 12345 + */ + skipped_item_count?: string; + /** + * Format: date-time + * @description Timestamp when data source started indexing + * @example 2023-01-01T00:00:00Z + */ + started_at?: string; + status?: components["schemas"]["apiIndexedDataSourceStatus"]; + /** + * Format: uint64 + * @description Total size of files in data source in bytes + * @example 12345 + */ + total_bytes?: string; + /** + * Format: uint64 + * @description Total size of files in data source in bytes that have been indexed + * @example 12345 + */ + total_bytes_indexed?: string; + /** + * Format: uint64 + * @description Total file count in the data source + * @example 12345 + */ + total_file_count?: string; + }; /** * @default BATCH_JOB_PHASE_UNKNOWN * @example BATCH_JOB_PHASE_UNKNOWN * @enum {string} */ - apiBatchJobPhase: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | "BATCH_JOB_PHASE_SUCCEEDED" | "BATCH_JOB_PHASE_FAILED" | "BATCH_JOB_PHASE_ERROR"; + apiBatchJobPhase: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | "BATCH_JOB_PHASE_SUCCEEDED" | "BATCH_JOB_PHASE_FAILED" | "BATCH_JOB_PHASE_ERROR" | "BATCH_JOB_PHASE_CANCELLED"; + /** + * @default INDEX_JOB_STATUS_UNKNOWN + * @example INDEX_JOB_STATUS_UNKNOWN + * @enum {string} + */ + apiIndexJobStatus: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | "INDEX_JOB_STATUS_COMPLETED" | "INDEX_JOB_STATUS_FAILED" | "INDEX_JOB_STATUS_NO_CHANGES" | "INDEX_JOB_STATUS_PENDING" | "INDEX_JOB_STATUS_CANCELLED"; /** @description IndexingJob description */ apiIndexingJob: { /** @@ -15609,6 +20793,8 @@ export interface components { * @example 2023-01-01T00:00:00Z */ created_at?: string; + /** @description Details on Data Sources included in the Indexing Job */ + data_source_jobs?: components["schemas"]["apiIndexedDataSource"][]; /** * @example [ * "example string" @@ -15620,9 +20806,14 @@ export interface components { * @example 2023-01-01T00:00:00Z */ finished_at?: string; + /** + * @description Boolean value to determine if the indexing job details are available + * @example true + */ + is_report_available?: boolean; /** * @description Knowledge base id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ knowledge_base_uuid?: string; phase?: components["schemas"]["apiBatchJobPhase"]; @@ -15631,9 +20822,10 @@ export interface components { * @example 2023-01-01T00:00:00Z */ started_at?: string; + status?: components["schemas"]["apiIndexJobStatus"]; /** * Format: int64 - * @description Number of tokens + * @description Number of tokens [This field is deprecated] * @example 123 */ tokens?: number; @@ -15643,6 +20835,12 @@ export interface components { * @example 123 */ total_datasources?: number; + /** + * Format: uint64 + * @description Total Tokens Consumed By the Indexing Job + * @example 12345 + */ + total_tokens?: string; /** * Format: date-time * @description Last modified @@ -15651,7 +20849,7 @@ export interface components { updated_at?: string; /** * @description Unique id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; @@ -15669,9 +20867,9 @@ export interface components { * @example 2023-01-01T00:00:00Z */ created_at?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ database_id?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ embedding_model_uuid?: string; /** * @description Whether the knowledge base is public or not @@ -15681,14 +20879,14 @@ export interface components { last_indexing_job?: components["schemas"]["apiIndexingJob"]; /** * @description Name of knowledge base - * @example "example name" + * @example example name */ name?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ project_id?: string; /** * @description Region code - * @example "example string" + * @example example string */ region?: string; /** @@ -15707,15 +20905,23 @@ export interface components { /** * Format: int64 * @description Id of user that created the knowledge base - * @example "12345" + * @example 12345 */ user_id?: string; /** * @description Unique id for knowledge base - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; + /** + * @description - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template + * - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template + * @default AGENT_TEMPLATE_TYPE_STANDARD + * @example AGENT_TEMPLATE_TYPE_STANDARD + * @enum {string} + */ + apiAgentTemplateType: "AGENT_TEMPLATE_TYPE_STANDARD" | "AGENT_TEMPLATE_TYPE_ONE_CLICK"; /** @description Represents an AgentTemplate entity */ apiAgentTemplate: { /** @@ -15725,13 +20931,15 @@ export interface components { */ created_at?: string; /** - * @description Description of the agent template - * @example "example string" + * @description Deprecated - Use summary instead + * @example example string */ description?: string; + /** @description List of guardrails associated with the agent template */ + guardrails?: components["schemas"]["apiAgentTemplateGuardrail"][]; /** * @description Instructions for the agent template - * @example "example string" + * @example example string */ instruction?: string; /** @@ -15742,6 +20950,11 @@ export interface components { k?: number; /** @description List of knowledge bases associated with the agent template */ knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; + /** + * @description The long description of the agent template + * @example "Enhance your customer service with an AI agent designed to provide consistent, helpful, and accurate support across multiple channels. This template creates an agent that can answer product questions, troubleshoot common issues, process simple requests, and maintain a friendly, on-brand voice throughout customer interactions. Reduce response times, handle routine inquiries efficiently, and ensure your customers feel heard and helped." + */ + long_description?: string; /** * Format: int64 * @description The max_tokens setting for the agent template @@ -15751,15 +20964,33 @@ export interface components { model?: components["schemas"]["apiModel"]; /** * @description Name of the agent template - * @example "example name" + * @example example name */ name?: string; + /** + * @description The short description of the agent template + * @example "This template has been designed with question-answer and conversational use cases in mind. It comes with validated agent instructions, fine-tuned model settings, and preconfigured guardrails defined for customer support-related use cases." + */ + short_description?: string; + /** + * @description The summary of the agent template + * @example example string + */ + summary?: string; + /** + * @description List of tags associated with the agent template + * @example [ + * "example string" + * ] + */ + tags?: string[]; /** * Format: float * @description The temperature setting for the agent template * @example 123 */ temperature?: number; + template_type?: components["schemas"]["apiAgentTemplateType"]; /** * Format: float * @description The top_p setting for the agent template @@ -15774,7 +21005,7 @@ export interface components { updated_at?: string; /** * @description Unique id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; @@ -15828,11 +21059,17 @@ export interface components { * @example 12345678-1234-1234-1234-123456789012 */ project_id?: string; + /** + * @description Whether the agent should provide in-response citations + * @example true + */ + provide_citations?: boolean; /** * @description Region code * @example "tor1" */ region?: string; + retrieval_method?: components["schemas"]["apiRetrievalMethod"]; /** * Format: date-time * @description Creation of route date / time @@ -15897,27 +21134,32 @@ export interface components { * @example "12345678-1234-1234-1234-123456789012" */ uuid?: string; + /** + * @description The latest version of the agent + * @example example string + */ + version_hash?: string; }; /** @description Information about how to reach other pages */ apiPages: { /** * @description First page - * @example "example string" + * @example example string */ first?: string; /** * @description Last page - * @example "example string" + * @example example string */ last?: string; /** * @description Next page - * @example "example string" + * @example example string */ next?: string; /** * @description Previous page - * @example "example string" + * @example example string */ previous?: string; }; @@ -15955,6 +21197,11 @@ export interface components { }; /** @description Parameters for Agent Creation */ apiCreateAgentInputPublic: { + /** + * @description Optional Anthropic API key ID to use with Anthropic models + * @example "12345678-1234-1234-1234-123456789012" + */ + anthropic_key_uuid?: string; /** * @description A text description of the agent, not used in inference * @example "My Agent Description" @@ -15972,6 +21219,8 @@ export interface components { * ] */ knowledge_base_uuid?: string[]; + /** @example "12345678-1234-1234-1234-123456789012" */ + model_provider_key_uuid?: string; /** * @description Identifier for the foundation model. * @example "12345678-1234-1234-1234-123456789012" @@ -15982,6 +21231,11 @@ export interface components { * @example "My Agent" */ name?: string; + /** + * @description Optional OpenAI API key ID to use with OpenAI models + * @example "12345678-1234-1234-1234-123456789012" + */ + open_ai_key_uuid?: string; /** * @description The id of the DigitalOcean project this agent will belong to * @example "12345678-1234-1234-1234-123456789012" @@ -15999,6 +21253,11 @@ export interface components { * ] */ tags?: string[]; + /** + * @description Identifier for the workspace + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + workspace_uuid?: string; }; /** @description Anthropic API Key Info */ apiAnthropicAPIKeyInfo: { @@ -16011,7 +21270,7 @@ export interface components { /** * Format: uint64 * @description Created by user id from DO - * @example "12345" + * @example 12345 */ created_by?: string; /** @@ -16022,7 +21281,7 @@ export interface components { deleted_at?: string; /** * @description Name - * @example "example name" + * @example example name */ name?: string; /** @@ -16033,7 +21292,7 @@ export interface components { updated_at?: string; /** * @description Uuid - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; @@ -16048,7 +21307,7 @@ export interface components { /** * Format: uint64 * @description Created by - * @example "12345" + * @example 12345 */ created_by?: string; /** @@ -16059,14 +21318,14 @@ export interface components { deleted_at?: string; /** * @description Name - * @example "example name" + * @example example name */ name?: string; - /** @example "example string" */ + /** @example example string */ secret_key?: string; /** * @description Uuid - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; @@ -16074,7 +21333,7 @@ export interface components { apiAgentAPIKey: { /** * @description Api key - * @example "example string" + * @example example string */ api_key?: string; }; @@ -16090,6 +21349,11 @@ export interface components { chatbot_identifiers?: components["schemas"]["apiAgentChatbotIdentifier"][]; /** @description Child agents */ child_agents?: components["schemas"]["apiAgent"][]; + /** + * @description Whether conversation logs are enabled for the agent + * @example true + */ + conversation_logs_enabled?: boolean; /** * Format: date-time * @description Creation date / time @@ -16099,17 +21363,17 @@ export interface components { deployment?: components["schemas"]["apiDeployment"]; /** * @description Description of agent - * @example "example string" + * @example example string */ description?: string; functions?: components["schemas"]["apiAgentFunction"][]; /** @description The guardrails the agent is attached to */ guardrails?: components["schemas"]["apiAgentGuardrail"][]; - /** @example "example string" */ + /** @example example string */ if_case?: string; /** * @description Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - * @example "example string" + * @example example string */ instruction?: string; /** @@ -16119,26 +21383,35 @@ export interface components { k?: number; /** @description Knowledge bases */ knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; + logging_config?: components["schemas"]["apiAgentLoggingConfig"]; /** * Format: int64 * @example 123 */ max_tokens?: number; model?: components["schemas"]["apiModel"]; + model_provider_key?: components["schemas"]["apiModelProviderKeyInfo"]; /** * @description Agent name - * @example "example name" + * @example example name */ name?: string; + openai_api_key?: components["schemas"]["apiOpenAIAPIKeyInfo"]; /** @description Parent agents */ parent_agents?: components["schemas"]["apiAgent"][]; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ project_id?: string; + /** + * @description Whether the agent should provide in-response citations + * @example true + */ + provide_citations?: boolean; /** * @description Region code - * @example "example string" + * @example example string */ region?: string; + retrieval_method?: components["schemas"]["apiRetrievalMethod"]; /** * Format: date-time * @description Creation of route date / time @@ -16147,15 +21420,15 @@ export interface components { route_created_at?: string; /** * Format: uint64 - * @example "12345" + * @example 12345 */ route_created_by?: string; /** * @description Route name - * @example "example name" + * @example example name */ route_name?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ route_uuid?: string; /** * @description Agent tag to organize related resources @@ -16183,26 +21456,41 @@ export interface components { updated_at?: string; /** * @description Access your agent under this url - * @example "example string" + * @example example string */ url?: string; /** * Format: uint64 * @description Id of user that created the agent - * @example "12345" + * @example 12345 */ user_id?: string; /** * @description Unique agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; + /** + * @description The latest version of the agent + * @example example string + */ + version_hash?: string; + /** + * @description VPC Egress IPs + * @example [ + * "example string" + * ] + */ + vpc_egress_ips?: string[]; + /** @example "12345678-1234-1234-1234-123456789012" */ + vpc_uuid?: string; + workspace?: components["schemas"]["apiWorkspace"]; }; /** @description Description missing */ apiAgentFunction: { /** * @description Api key - * @example "example string" + * @example example string */ api_key?: string; /** @@ -16211,19 +21499,25 @@ export interface components { * @example 2023-01-01T00:00:00Z */ created_at?: string; + /** + * Format: uint64 + * @description Created by user id from DO + * @example 12345 + */ + created_by?: string; /** * @description Agent description - * @example "example string" + * @example example string */ description?: string; - /** @example "example name" */ + /** @example example name */ faas_name?: string; - /** @example "example name" */ + /** @example example name */ faas_namespace?: string; input_schema?: Record; /** * @description Name - * @example "example name" + * @example example name */ name?: string; output_schema?: Record; @@ -16235,12 +21529,12 @@ export interface components { updated_at?: string; /** * @description Download your agent here - * @example "example string" + * @example example string */ url?: string; /** * @description Unique id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; @@ -16252,25 +21546,25 @@ export interface components { apiGuardrailType: "GUARDRAIL_TYPE_UNKNOWN" | "GUARDRAIL_TYPE_JAILBREAK" | "GUARDRAIL_TYPE_SENSITIVE_DATA" | "GUARDRAIL_TYPE_CONTENT_MODERATION"; /** @description A Agent Guardrail */ apiAgentGuardrail: { - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ agent_uuid?: string; /** * Format: date-time * @example 2023-01-01T00:00:00Z */ created_at?: string; - /** @example "example string" */ + /** @example example string */ default_response?: string; - /** @example "example string" */ + /** @example example string */ description?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ guardrail_uuid?: string; /** @example true */ is_attached?: boolean; /** @example true */ is_default?: boolean; metadata?: Record; - /** @example "example name" */ + /** @example example name */ name?: string; /** * Format: int32 @@ -16283,7 +21577,335 @@ export interface components { * @example 2023-01-01T00:00:00Z */ updated_at?: string; - /** @example "123e4567-e89b-12d3-a456-426614174000" */ + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + uuid?: string; + }; + apiAgentLoggingConfig: { + /** + * @description Galileo project identifier + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + galileo_project_id?: string; + /** + * @description Name of the Galileo project + * @example example name + */ + galileo_project_name?: string; + /** + * @description Whether insights are enabled + * @example true + */ + insights_enabled?: boolean; + /** + * Format: date-time + * @description Timestamp when insights were enabled + * @example 2023-01-01T00:00:00Z + */ + insights_enabled_at?: string; + /** + * @description Identifier for the log stream + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + log_stream_id?: string; + /** + * @description Name of the log stream + * @example example name + */ + log_stream_name?: string; + }; + apiModelProviderKeyInfo: { + /** + * @description API key ID + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + api_key_uuid?: string; + /** + * Format: date-time + * @description Key creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * Format: uint64 + * @description Created by user id from DO + * @example 12345 + */ + created_by?: string; + /** + * Format: date-time + * @description Key deleted date + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** @description Models supported by the openAI api key */ + models?: components["schemas"]["apiModel"][]; + /** + * @description Name of the key + * @example example name + */ + name?: string; + provider?: components["schemas"]["apiModelProvider"]; + /** + * Format: date-time + * @description Key last updated date + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + }; + /** @description OpenAI API Key Info */ + apiOpenAIAPIKeyInfo: { + /** + * Format: date-time + * @description Key creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * Format: uint64 + * @description Created by user id from DO + * @example 12345 + */ + created_by?: string; + /** + * Format: date-time + * @description Key deleted date + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** @description Models supported by the openAI api key */ + models?: components["schemas"]["apiModel"][]; + /** + * @description Name + * @example example name + */ + name?: string; + /** + * Format: date-time + * @description Key last updated date + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Uuid + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + }; + apiEvaluationDataset: { + /** + * Format: date-time + * @description Time created at. + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description Name of the dataset. + * @example example name + */ + dataset_name?: string; + /** + * @description UUID of the dataset. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + dataset_uuid?: string; + /** + * Format: uint64 + * @description The size of the dataset uploaded file in bytes. + * @example 12345 + */ + file_size?: string; + /** + * @description Does the dataset have a ground truth column? + * @example true + */ + has_ground_truth?: boolean; + /** + * Format: int64 + * @description Number of rows in the dataset. + * @example 123 + */ + row_count?: number; + }; + /** + * @default METRIC_CATEGORY_UNSPECIFIED + * @example METRIC_CATEGORY_UNSPECIFIED + * @enum {string} + */ + apiEvaluationMetricCategory: "METRIC_CATEGORY_UNSPECIFIED" | "METRIC_CATEGORY_CORRECTNESS" | "METRIC_CATEGORY_USER_OUTCOMES" | "METRIC_CATEGORY_SAFETY_AND_SECURITY" | "METRIC_CATEGORY_CONTEXT_QUALITY" | "METRIC_CATEGORY_MODEL_FIT"; + /** + * @default METRIC_TYPE_UNSPECIFIED + * @example METRIC_TYPE_UNSPECIFIED + * @enum {string} + */ + apiEvaluationMetricType: "METRIC_TYPE_UNSPECIFIED" | "METRIC_TYPE_GENERAL_QUALITY" | "METRIC_TYPE_RAG_AND_TOOL"; + /** + * @default METRIC_VALUE_TYPE_UNSPECIFIED + * @example METRIC_VALUE_TYPE_UNSPECIFIED + * @enum {string} + */ + apiEvaluationMetricValueType: "METRIC_VALUE_TYPE_UNSPECIFIED" | "METRIC_VALUE_TYPE_NUMBER" | "METRIC_VALUE_TYPE_STRING" | "METRIC_VALUE_TYPE_PERCENTAGE"; + apiEvaluationMetric: { + category?: components["schemas"]["apiEvaluationMetricCategory"]; + /** @example example string */ + description?: string; + /** + * @description If true, the metric is inverted, meaning that a lower value is better. + * @example true + */ + inverted?: boolean; + /** @example true */ + is_metric_goal?: boolean; + /** @example example name */ + metric_name?: string; + /** + * Format: int64 + * @example 123 + */ + metric_rank?: number; + metric_type?: components["schemas"]["apiEvaluationMetricType"]; + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + metric_uuid?: string; + metric_value_type?: components["schemas"]["apiEvaluationMetricValueType"]; + /** + * Format: float + * @description The maximum value for the metric. + * @example 123 + */ + range_max?: number; + /** + * Format: float + * @description The minimum value for the metric. + * @example 123 + */ + range_min?: number; + }; + apiStarMetric: { + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + metric_uuid?: string; + /** @example example name */ + name?: string; + /** + * Format: float + * @description The success threshold for the star metric. + * This is a value that the metric must reach to be considered successful. + * @example 123 + */ + success_threshold?: number; + /** + * Format: int32 + * @description The success threshold for the star metric. + * This is a percentage value between 0 and 100. + * @example 123 + */ + success_threshold_pct?: number; + }; + apiEvaluationTestCase: { + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + archived_at?: string; + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** @example example@example.com */ + created_by_user_email?: string; + /** + * Format: uint64 + * @example 12345 + */ + created_by_user_id?: string; + dataset?: components["schemas"]["apiEvaluationDataset"]; + /** @example example name */ + dataset_name?: string; + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + dataset_uuid?: string; + /** @example example string */ + description?: string; + /** + * Format: int32 + * @example 123 + */ + latest_version_number_of_runs?: number; + metrics?: components["schemas"]["apiEvaluationMetric"][]; + /** @example example name */ + name?: string; + star_metric?: components["schemas"]["apiStarMetric"]; + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + test_case_uuid?: string; + /** + * Format: int32 + * @example 123 + */ + total_runs?: number; + /** + * Format: date-time + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** @example example@example.com */ + updated_by_user_email?: string; + /** + * Format: uint64 + * @example 12345 + */ + updated_by_user_id?: string; + /** + * Format: int64 + * @example 123 + */ + version?: number; + }; + apiWorkspace: { + /** @description Agents */ + agents?: components["schemas"]["apiAgent"][]; + /** + * Format: date-time + * @description Creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * Format: uint64 + * @description The id of user who created this workspace + * @example 12345 + */ + created_by?: string; + /** + * @description The email of the user who created this workspace + * @example example@example.com + */ + created_by_email?: string; + /** + * Format: date-time + * @description Deleted date + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** + * @description Description of the workspace + * @example example string + */ + description?: string; + /** @description Evaluations */ + evaluation_test_cases?: components["schemas"]["apiEvaluationTestCase"][]; + /** + * @description Name of the workspace + * @example example name + */ + name?: string; + /** + * Format: date-time + * @description Update date + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Unique id + * @example 123e4567-e89b-12d3-a456-426614174000 + */ uuid?: string; }; /** @description Information about a newly created Agent */ @@ -16318,7 +21940,7 @@ export interface components { */ agent_uuid?: string; /** - * @description Api key id + * @description API key ID * @example "12345678-1234-1234-1234-123456789012" */ api_key_uuid?: string; @@ -16418,6 +22040,37 @@ export interface components { apiUnlinkAgentFunctionOutput: { agent?: components["schemas"]["apiAgent"]; }; + apiAgentGuardrailInput: { + /** + * @description Guardrail uuid + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + guardrail_uuid?: string; + /** + * Format: int64 + * @description Priority of the guardrail + * @example 123 + */ + priority?: number; + }; + /** @description Information about linking an agent to a guardrail */ + apiLinkAgentGuardrailsInputPublic: { + /** + * @description The UUID of the agent. + * @example "12345678-1234-1234-1234-123456789012" + */ + agent_uuid?: string; + /** @description The list of guardrails to attach. */ + guardrails?: components["schemas"]["apiAgentGuardrailInput"][]; + }; + /** @description Information about an updated agent */ + apiLinkAgentGuardrailOutput: { + agent?: components["schemas"]["apiAgent"]; + }; + /** @description UnlinkAgentGuardrailOutput description */ + apiUnlinkAgentGuardrailOutput: { + agent?: components["schemas"]["apiAgent"]; + }; /** @description Information about a linked knowledge base */ apiLinkKnowledgeBaseOutput: { agent?: components["schemas"]["apiAgent"]; @@ -16458,17 +22111,19 @@ export interface components { apiUpdateLinkedAgentOutput: { /** * @description Routed agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ child_agent_uuid?: string; /** * @description A unique identifier for the parent agent. - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ parent_agent_uuid?: string; + /** @example true */ + rollback?: boolean; /** * @description Unique id of linkage - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; @@ -16496,12 +22151,12 @@ export interface components { apiLinkAgentOutput: { /** * @description Routed agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ child_agent_uuid?: string; /** * @description A unique identifier for the parent agent. - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ parent_agent_uuid?: string; }; @@ -16509,21 +22164,40 @@ export interface components { apiUnlinkAgentOutput: { /** * @description Routed agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ child_agent_uuid?: string; /** * @description Pagent agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @example 123e4567-e89b-12d3-a456-426614174000 */ parent_agent_uuid?: string; }; /** @description One Agent */ - apiGetAgentOutputPublic: { - agent?: components["schemas"]["apiAgentPublic"]; + apiGetAgentOutput: { + agent?: components["schemas"]["apiAgent"]; }; /** @description Data to modify an existing Agent */ apiUpdateAgentInputPublic: { + /** @example true */ + agent_log_insights_enabled?: boolean; + /** + * @description Optional list of allowed domains for the chatbot - Must use fully qualified domain name (FQDN) such as https://example.com + * @example [ + * "example string" + * ] + */ + allowed_domains?: string[]; + /** + * @description Optional anthropic key uuid for use with anthropic models + * @example "12345678-1234-1234-1234-123456789012" + */ + anthropic_key_uuid?: string; + /** + * @description Optional update of conversation logs enabled + * @example true + */ + conversation_logs_enabled?: boolean; /** * @description Agent description * @example "My Agent Description" @@ -16546,6 +22220,11 @@ export interface components { * @example 100 */ max_tokens?: number; + /** + * @description Optional Model Provider uuid for use with provider models + * @example "12345678-1234-1234-1234-123456789012" + */ + model_provider_key_uuid?: string; /** * @description Identifier for the foundation model. * @example "12345678-1234-1234-1234-123456789012" @@ -16556,11 +22235,19 @@ export interface components { * @example "My New Agent Name" */ name?: string; + /** + * @description Optional OpenAI key uuid for use with OpenAI models + * @example "12345678-1234-1234-1234-123456789012" + */ + open_ai_key_uuid?: string; /** * @description The id of the DigitalOcean project this agent will belong to * @example "12345678-1234-1234-1234-123456789012" */ project_id?: string; + /** @example true */ + provide_citations?: boolean; + retrieval_method?: components["schemas"]["apiRetrievalMethod"]; /** * @description A set of abitrary tags to organize your agent * @example [ @@ -16612,937 +22299,1723 @@ export interface components { apiUpdateAgentDeploymentVisbilityOutput: { agent?: components["schemas"]["apiAgent"]; }; - /** @description Indexing jobs */ - apiListKnowledgeBaseIndexingJobsOutput: { - /** @description The indexing jobs */ - jobs?: components["schemas"]["apiIndexingJob"][]; - links?: components["schemas"]["apiLinks"]; - meta?: components["schemas"]["apiMeta"]; + /** @description Usage Measurement Description */ + apiUsageMeasurement: { + /** + * Format: int64 + * @example 123 + */ + tokens?: number; + /** @example example string */ + usage_type?: string; }; - /** @description StartKnowledgeBaseIndexingJobInputPublic description */ - apiStartKnowledgeBaseIndexingJobInputPublic: { + /** @description Resource Usage Description */ + apiResourceUsage: { + measurements?: components["schemas"]["apiUsageMeasurement"][]; + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + resource_uuid?: string; /** - * @description List of data source ids to index, if none are provided, all data sources will be indexed - * @example [ - * "example string" - * ] + * Format: date-time + * @example 2023-01-01T00:00:00Z */ - data_source_uuids?: string[]; + start?: string; /** - * @description Knowledge base id - * @example "12345678-1234-1234-1234-123456789012" + * Format: date-time + * @example 2023-01-01T00:00:00Z */ - knowledge_base_uuid?: string; + stop?: string; }; - /** @description StartKnowledgeBaseIndexingJobOutput description */ - apiStartKnowledgeBaseIndexingJobOutput: { - job?: components["schemas"]["apiIndexingJob"]; + /** @description Agent usage */ + apiGetAgentUsageOutput: { + log_insights_usage?: components["schemas"]["apiResourceUsage"]; + usage?: components["schemas"]["apiResourceUsage"]; }; - apiIndexedDataSource: { + apiAgentChildRelationshipVerion: { /** - * Format: date-time - * @description Timestamp when data source completed indexing - * @example 2023-01-01T00:00:00Z + * @description Name of the child agent + * @example example name */ - completed_at?: string; + agent_name?: string; /** - * @description Uuid of the indexed data source - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Child agent unique identifier + * @example 123e4567-e89b-12d3-a456-426614174000 */ - data_source_uuid?: string; + child_agent_uuid?: string; /** - * Format: uint64 - * @description Total count of files that have been indexed - * @example "12345" + * @description If case + * @example example string */ - indexed_file_count?: string; + if_case?: string; /** - * Format: date-time - * @description Timestamp when data source started indexing - * @example 2023-01-01T00:00:00Z + * @description Child agent is deleted + * @example true */ - started_at?: string; + is_deleted?: boolean; /** - * Format: uint64 - * @description Total size of files in data source in bytes - * @example "12345" + * @description Route name + * @example example name */ - total_bytes?: string; + route_name?: string; + }; + /** @description Function represents a function configuration for an agent */ + apiAgentFunctionVersion: { /** - * Format: uint64 - * @description Total size of files in data source in bytes that have been indexed - * @example "12345" + * @description Description of the function + * @example example string */ - total_bytes_indexed?: string; + description?: string; /** - * Format: uint64 - * @description Total file count in the data source - * @example "12345" + * @description FaaS name of the function + * @example example name */ - total_file_count?: string; - }; - apiListIndexingJobDataSourcesOutput: { - indexed_data_sources?: components["schemas"]["apiIndexedDataSource"][]; - }; - /** @description GetKnowledgeBaseIndexingJobOutput description */ - apiGetKnowledgeBaseIndexingJobOutput: { - job?: components["schemas"]["apiIndexingJob"]; + faas_name?: string; + /** + * @description FaaS namespace of the function + * @example example name + */ + faas_namespace?: string; + /** + * @description Whether the function is deleted + * @example true + */ + is_deleted?: boolean; + /** + * @description Name of the function + * @example example name + */ + name?: string; }; - /** @description CancelKnowledgeBaseIndexingJobInputPublic description */ - apiCancelKnowledgeBaseIndexingJobInputPublic: { + /** @description Agent Guardrail version */ + apiAgentGuardrailVersion: { /** - * @description A unique identifier for an indexing job. - * @example "12345678-1234-1234-1234-123456789012" + * @description Whether the guardrail is deleted + * @example true + */ + is_deleted?: boolean; + /** + * @description Guardrail Name + * @example example name + */ + name?: string; + /** + * Format: int64 + * @description Guardrail Priority + * @example 123 + */ + priority?: number; + /** + * @description Guardrail UUID + * @example 123e4567-e89b-12d3-a456-426614174000 */ uuid?: string; }; - /** @description CancelKnowledgeBaseIndexingJobOutput description */ - apiCancelKnowledgeBaseIndexingJobOutput: { - job?: components["schemas"]["apiIndexingJob"]; - }; - /** @description List of knowledge bases */ - apiListKnowledgeBasesOutput: { - /** @description The knowledge bases */ - knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; - links?: components["schemas"]["apiLinks"]; - meta?: components["schemas"]["apiMeta"]; - }; - /** @description File to upload as data source for knowledge base. */ - apiFileUploadDataSource: { + apiAgentKnowledgeBaseVersion: { /** - * @description The original file name - * @example "example name" + * @description Deletet at date / time + * @example true */ - original_file_name?: string; + is_deleted?: boolean; /** - * Format: uint64 - * @description The size of the file in bytes - * @example "12345" + * @description Name of the knowledge base + * @example example name */ - size_in_bytes?: string; + name?: string; /** - * @description The object key the file was stored as - * @example "example string" + * @description Unique id of the knowledge base + * @example 123e4567-e89b-12d3-a456-426614174000 */ - stored_object_key?: string; + uuid?: string; }; - /** @description Spaces Bucket Data Source */ - apiSpacesDataSource: { + /** @description Represents an AgentVersion entity */ + apiAgentVersion: { /** - * @description Spaces bucket name - * @example "example name" + * @description Uuid of the agent this version belongs to + * @example 123e4567-e89b-12d3-a456-426614174000 */ - bucket_name?: string; - /** @example "example string" */ - item_path?: string; + agent_uuid?: string; + /** @description List of child agent relationships */ + attached_child_agents?: components["schemas"]["apiAgentChildRelationshipVerion"][]; + /** @description List of function versions */ + attached_functions?: components["schemas"]["apiAgentFunctionVersion"][]; + /** @description List of guardrail version */ + attached_guardrails?: components["schemas"]["apiAgentGuardrailVersion"][]; + /** @description List of knowledge base agent versions */ + attached_knowledgebases?: components["schemas"]["apiAgentKnowledgeBaseVersion"][]; + /** + * @description Whether the version is able to be rolled back to + * @example true + */ + can_rollback?: boolean; /** - * @description Region of bucket - * @example "example string" + * Format: date-time + * @description Creation date + * @example 2023-01-01T00:00:00Z */ - region?: string; - }; - apiKBDataSource: { + created_at?: string; /** - * @description Deprecated, moved to data_source_details - * @example "example name" + * @description User who created this version + * @example example@example.com */ - bucket_name?: string; + created_by_email?: string; /** - * @description Deprecated, moved to data_source_details - * @example "example string" + * @description Whether this is the currently applied configuration + * @example true */ - bucket_region?: string; - file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; - /** @example "example string" */ - item_path?: string; - spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; - }; - /** @description Data to create a new knowledge base. */ - apiCreateKnowledgeBaseInputPublic: { + currently_applied?: boolean; /** - * @description Identifier of the DigitalOcean OpenSearch database this knowledge base will use, optional. - * If not provided, we create a new database for the knowledge base in - * the same region as the knowledge base. - * @example "12345678-1234-1234-1234-123456789012" + * @description Description of the agent + * @example example string */ - database_id?: string; - /** @description The data sources to use for this knowledge base. See [Organize Data Sources](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#spaces-buckets) for more information on data sources best practices. */ - datasources?: components["schemas"]["apiKBDataSource"][]; + description?: string; /** - * @description Identifier for the [embedding model](https://docs.digitalocean.com/products/genai-platform/details/models/#embedding-models). - * @example "12345678-1234-1234-1234-123456789012" + * Format: uint64 + * @description Unique identifier + * @example 12345 */ - embedding_model_uuid?: string; + id?: string; /** - * @description Name of the knowledge base. - * @example "My Knowledge Base" + * @description Instruction for the agent + * @example example string */ - name?: string; + instruction?: string; /** - * @description Identifier of the DigitalOcean project this knowledge base will belong to. - * @example "12345678-1234-1234-1234-123456789012" + * Format: int64 + * @description K value for the agent's configuration + * @example 123 */ - project_id?: string; + k?: number; /** - * @description The datacenter region to deploy the knowledge base in. - * @example "tor1" + * Format: int64 + * @description Max tokens setting for the agent + * @example 123 */ - region?: string; + max_tokens?: number; /** - * @description Tags to organize your knowledge base. - * @example [ - * "example string" - * ] + * @description Name of model associated to the agent version + * @example example name */ - tags?: string[]; + model_name?: string; /** - * @description The VPC to deploy the knowledge base database in - * @example "12345678-1234-1234-1234-123456789012" + * @description Name of the agent + * @example example name */ - vpc_uuid?: string; - }; - /** @description Information about a newly created knowledge base */ - apiCreateKnowledgeBaseOutput: { - knowledge_base?: components["schemas"]["apiKnowledgeBase"]; - }; - /** @description Data Source configuration for Knowledge Bases */ - apiKnowledgeBaseDataSource: { + name?: string; /** - * @description Name of storage bucket - Deprecated, moved to data_source_details - * @example "example name" + * @description Whether the agent should provide in-response citations + * @example true */ - bucket_name?: string; + provide_citations?: boolean; + retrieval_method?: components["schemas"]["apiRetrievalMethod"]; /** - * Format: date-time - * @description Creation date / time - * @example 2023-01-01T00:00:00Z + * @description Tags associated with the agent + * @example [ + * "example string" + * ] */ - created_at?: string; - file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + tags?: string[]; /** - * @description Path of folder or object in bucket - Deprecated, moved to data_source_details - * @example "example string" + * Format: float + * @description Temperature setting for the agent + * @example 123 */ - item_path?: string; - last_indexing_job?: components["schemas"]["apiIndexingJob"]; + temperature?: number; /** - * @description Region code - Deprecated, moved to data_source_details - * @example "example string" + * Format: float + * @description Top_p setting for the agent + * @example 123 */ - region?: string; - spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + top_p?: number; /** - * Format: date-time - * @description Last modified - * @example 2023-01-01T00:00:00Z + * @description Action triggering the configuration update + * @example example string */ - updated_at?: string; + trigger_action?: string; /** - * @description Unique id of knowledge base - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Version hash + * @example example string */ - uuid?: string; + version_hash?: string; }; - /** @description A list of knowledge base data sources */ - apiListKnowledgeBaseDataSourcesOutput: { - /** @description The data sources */ - knowledge_base_data_sources?: components["schemas"]["apiKnowledgeBaseDataSource"][]; + /** @description List of agent versions */ + apiListAgentVersionsOutput: { + /** @description Agents */ + agent_versions?: components["schemas"]["apiAgentVersion"][]; links?: components["schemas"]["apiLinks"]; meta?: components["schemas"]["apiMeta"]; }; - /** @description Data to create a knowledge base data source */ - apiCreateKnowledgeBaseDataSourceInputPublic: { - file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + apiRollbackToAgentVersionInputPublic: { /** - * @description Knowledge base id + * @description Agent unique identifier * @example "12345678-1234-1234-1234-123456789012" */ - knowledge_base_uuid?: string; - spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; - }; - /** @description Information about a newly created knowldege base data source */ - apiCreateKnowledgeBaseDataSourceOutput: { - knowledge_base_data_source?: components["schemas"]["apiKnowledgeBaseDataSource"]; + uuid?: string; + /** + * @description Unique identifier + * @example c3658d8b5c05494cd03ce042926ef08157889ed54b1b74b5ee0b3d66dcee4b73 + */ + version_hash?: string; }; - /** @description Information about a newly deleted knowledge base data source */ - apiDeleteKnowledgeBaseDataSourceOutput: { + /** @description An alternative way to provide auth information. for internal use only. */ + apiAuditHeader: { /** - * @description Data source id - * @example "123e4567-e89b-12d3-a456-426614174000" + * Format: uint64 + * @example 12345 */ - data_source_uuid?: string; + actor_id?: string; + /** @example example string */ + actor_ip?: string; + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + actor_uuid?: string; + /** @example example string */ + context_urn?: string; + /** @example example string */ + origin_application?: string; /** - * @description Knowledge base id - * @example "123e4567-e89b-12d3-a456-426614174000" + * Format: uint64 + * @example 12345 */ - knowledge_base_uuid?: string; + user_id?: string; + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + user_uuid?: string; + }; + apiRollbackToAgentVersionOutput: { + audit_header?: components["schemas"]["apiAuditHeader"]; + /** + * @description Unique identifier + * @example example string + */ + version_hash?: string; + }; + /** @description ListAnthropicAPIKeysOutput is used to return the list of Anthropic API keys for a specific agent. */ + apiListAnthropicAPIKeysOutput: { + /** @description Api key infos */ + api_key_infos?: components["schemas"]["apiAnthropicAPIKeyInfo"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + /** @description CreateAnthropicAPIKeyInputPublic is used to create a new Anthropic API key for a specific agent. */ + apiCreateAnthropicAPIKeyInputPublic: { + /** + * @description Anthropic API key + * @example "sk-ant-12345678901234567890123456789012" + */ + api_key?: string; + /** + * @description Name of the key + * @example "Production Key" + */ + name?: string; + }; + /** @description CreateAnthropicAPIKeyOutput is used to return the newly created Anthropic API key. */ + apiCreateAnthropicAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAnthropicAPIKeyInfo"]; + }; + apiGetAnthropicAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAnthropicAPIKeyInfo"]; + }; + /** @description UpdateAnthropicAPIKeyInputPublic is used to update an existing Anthropic API key for a specific agent. */ + apiUpdateAnthropicAPIKeyInputPublic: { + /** + * @description Anthropic API key + * @example "sk-ant-12345678901234567890123456789012" + */ + api_key?: string; + /** + * @description API key ID + * @example "12345678-1234-1234-1234-123456789012" + */ + api_key_uuid?: string; + /** + * @description Name of the key + * @example "Production Key" + */ + name?: string; + }; + /** @description UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic API key. */ + apiUpdateAnthropicAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAnthropicAPIKeyInfo"]; + }; + /** @description DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic API key. */ + apiDeleteAnthropicAPIKeyOutput: { + api_key_info?: components["schemas"]["apiAnthropicAPIKeyInfo"]; + }; + /** @description List of Agents that linked to a specific Anthropic Key */ + apiListAgentsByAnthropicKeyOutput: { + agents?: components["schemas"]["apiAgent"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; /** - * @default CREATING - * @example CREATING + * @default EVALUATION_DATASET_TYPE_UNKNOWN + * @example EVALUATION_DATASET_TYPE_UNKNOWN * @enum {string} */ - dbaasClusterStatus: "CREATING" | "ONLINE" | "POWEROFF" | "REBUILDING" | "REBALANCING" | "DECOMMISSIONED" | "FORKING" | "MIGRATING" | "RESIZING" | "RESTORING" | "POWERING_ON" | "UNHEALTHY"; - /** @description The knowledge base */ - apiGetKnowledgeBaseOutput: { - database_status?: components["schemas"]["dbaasClusterStatus"]; - knowledge_base?: components["schemas"]["apiKnowledgeBase"]; - }; - /** @description Information about updating a knowledge base */ - apiUpdateKnowledgeBaseInputPublic: { + apiEvaluationDatasetType: "EVALUATION_DATASET_TYPE_UNKNOWN" | "EVALUATION_DATASET_TYPE_ADK" | "EVALUATION_DATASET_TYPE_NON_ADK"; + /** @description File to upload as data source for knowledge base. */ + apiFileUploadDataSource: { /** - * @description The id of the DigitalOcean database this knowledge base will use, optiona. - * @example "12345678-1234-1234-1234-123456789012" + * @description The original file name + * @example example name */ - database_id?: string; + original_file_name?: string; /** - * @description Identifier for the foundation model. - * @example "12345678-1234-1234-1234-123456789012" + * Format: uint64 + * @description The size of the file in bytes + * @example 12345 */ - embedding_model_uuid?: string; + size_in_bytes?: string; /** - * @description Knowledge base name - * @example "My Knowledge Base" + * @description The object key the file was stored as + * @example example string + */ + stored_object_key?: string; + }; + /** @description Creates an evaluation dataset for an agent */ + apiCreateEvaluationDatasetInputPublic: { + dataset_type?: components["schemas"]["apiEvaluationDatasetType"]; + file_upload_dataset?: components["schemas"]["apiFileUploadDataSource"]; + /** + * @description The name of the agent evaluation dataset. + * @example example name */ name?: string; + }; + /** @description Output for creating an agent evaluation dataset */ + apiCreateEvaluationDatasetOutput: { /** - * @description The id of the DigitalOcean project this knowledge base will belong to - * @example "12345678-1234-1234-1234-123456789012" + * @description Evaluation dataset uuid. + * @example 123e4567-e89b-12d3-a456-426614174000 */ - project_id?: string; + evaluation_dataset_uuid?: string; + }; + /** @description A single file’s metadata in the request. */ + apiPresignedUrlFile: { /** - * @description Tags to organize your knowledge base. + * @description Local filename + * @example example name + */ + file_name?: string; + /** + * Format: int64 + * @description The size of the file in bytes. + * @example 12345 + */ + file_size?: string; + }; + /** @description Request for pre-signed URL's to upload files for KB Data Sources */ + apiCreateDataSourceFileUploadPresignedUrlsInputPublic: { + /** @description A list of files to generate presigned URLs for. */ + files?: components["schemas"]["apiPresignedUrlFile"][]; + }; + /** @description Detailed info about each presigned URL returned to the client. */ + apiFilePresignedUrlResponse: { + /** + * Format: date-time + * @description The time the url expires at. + * @example 2023-01-01T00:00:00Z + */ + expires_at?: string; + /** + * @description The unique object key to store the file as. + * @example example string + */ + object_key?: string; + /** + * @description The original file name. + * @example example name + */ + original_file_name?: string; + /** + * @description The actual presigned URL the client can use to upload the file directly. + * @example example string + */ + presigned_url?: string; + }; + /** @description Response with pre-signed urls to upload files. */ + apiCreateDataSourceFileUploadPresignedUrlsOutput: { + /** + * @description The ID generated for the request for Presigned URLs. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + request_id?: string; + /** @description A list of generated presigned URLs and object keys, one per file. */ + uploads?: components["schemas"]["apiFilePresignedUrlResponse"][]; + }; + apiListEvaluationMetricsOutput: { + metrics?: components["schemas"]["apiEvaluationMetric"][]; + }; + /** @description Run an evaluation test case. */ + apiRunEvaluationTestCaseInputPublic: { + /** + * @description Agent deployment names to run the test case against (ADK agent workspaces). * @example [ * "example string" * ] */ - tags?: string[]; + agent_deployment_names?: string[]; /** - * @description Knowledge base id + * @description Agent UUIDs to run the test case against (legacy agents). + * @example [ + * "example string" + * ] + */ + agent_uuids?: string[]; + /** + * @description The name of the run. + * @example Evaluation Run Name + */ + run_name?: string; + /** + * @description Test-case UUID to run * @example "12345678-1234-1234-1234-123456789012" */ - uuid?: string; + test_case_uuid?: string; }; - /** @description Information about an updated knowledge base */ - apiUpdateKnowledgeBaseOutput: { - knowledge_base?: components["schemas"]["apiKnowledgeBase"]; + apiRunEvaluationTestCaseOutput: { + /** + * @example [ + * "example string" + * ] + */ + evaluation_run_uuids?: string[]; }; - /** @description Information about a deleted knowledge base */ - apiDeleteKnowledgeBaseOutput: { + apiEvaluationMetricResult: { /** - * @description The id of the deleted knowledge base - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Error description if the metric could not be calculated. + * @example example string */ - uuid?: string; + error_description?: string; + /** + * @description Metric name + * @example example name + */ + metric_name?: string; + metric_value_type?: components["schemas"]["apiEvaluationMetricValueType"]; + /** + * Format: double + * @description The value of the metric as a number. + * @example 123 + */ + number_value?: number; + /** + * @description Reasoning of the metric result. + * @example example string + */ + reasoning?: string; + /** + * @description The value of the metric as a string. + * @example example string + */ + string_value?: string; }; - /** @description A machine learning model stored on the GenAI platform */ - apiModelPublic: { - agreement?: components["schemas"]["apiAgreement"]; + /** + * @description Evaluation Run Statuses + * @default EVALUATION_RUN_STATUS_UNSPECIFIED + * @example EVALUATION_RUN_STATUS_UNSPECIFIED + * @enum {string} + */ + apiEvaluationRunStatus: "EVALUATION_RUN_STATUS_UNSPECIFIED" | "EVALUATION_RUN_QUEUED" | "EVALUATION_RUN_RUNNING_DATASET" | "EVALUATION_RUN_EVALUATING_RESULTS" | "EVALUATION_RUN_CANCELLING" | "EVALUATION_RUN_CANCELLED" | "EVALUATION_RUN_SUCCESSFUL" | "EVALUATION_RUN_PARTIALLY_SUCCESSFUL" | "EVALUATION_RUN_FAILED"; + apiEvaluationRun: { + /** + * @description Whether agent is deleted + * @example true + */ + agent_deleted?: boolean; + /** + * @description The agent deployment name + * @example example name + */ + agent_deployment_name?: string; + /** + * @description Agent name + * @example example name + */ + agent_name?: string; + /** + * @description Agent UUID. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + agent_uuid?: string; + /** + * @description Version hash + * @example example string + */ + agent_version_hash?: string; + /** + * @description Agent workspace uuid + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + agent_workspace_uuid?: string; + /** @example example@example.com */ + created_by_user_email?: string; + /** + * Format: uint64 + * @example 12345 + */ + created_by_user_id?: string; + /** + * @description The error description + * @example example string + */ + error_description?: string; + /** + * @description Evaluation run UUID. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + evaluation_run_uuid?: string; + /** + * @description Evaluation test case workspace uuid + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + evaluation_test_case_workspace_uuid?: string; /** * Format: date-time - * @description Creation date / time - * @example 2021-01-01T00:00:00Z + * @description Run end time. + * @example 2023-01-01T00:00:00Z */ - created_at?: string; + finished_at?: string; /** - * @description True if it is a foundational model provided by do + * @description The pass status of the evaluation run based on the star metric. * @example true */ - is_foundational?: boolean; + pass_status?: boolean; /** - * @description Name of the model - * @example Llama 3.3 (70b) + * Format: date-time + * @description Run queued time. + * @example 2023-01-01T00:00:00Z */ - name?: string; + queued_at?: string; + run_level_metric_results?: components["schemas"]["apiEvaluationMetricResult"][]; /** - * @description Unique id of the model, this model is based on - * @example "12345678-1234-1234-1234-123456789012" + * @description Run name. + * @example example name */ - parent_uuid?: string; + run_name?: string; + star_metric_result?: components["schemas"]["apiEvaluationMetricResult"]; /** * Format: date-time - * @description Last modified - * @example 2021-01-01T00:00:00Z + * @description Run start time. + * @example 2023-01-01T00:00:00Z */ - updated_at?: string; + started_at?: string; + status?: components["schemas"]["apiEvaluationRunStatus"]; /** - * @description Model has been fully uploaded + * @description Test case description. + * @example example string + */ + test_case_description?: string; + /** + * @description Test case name. + * @example example name + */ + test_case_name?: string; + /** + * @description Test-case UUID. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + test_case_uuid?: string; + /** + * Format: int64 + * @description Test-case-version. + * @example 123 + */ + test_case_version?: number; + }; + apiGetEvaluationRunOutput: { + evaluation_run?: components["schemas"]["apiEvaluationRun"]; + }; + apiPromptChunk: { + /** + * Format: double + * @description The usage percentage of the chunk. + * @example 123 + */ + chunk_usage_pct?: number; + /** + * @description Indicates if the chunk was used in the prompt. * @example true */ - upload_complete?: boolean; + chunk_used?: boolean; /** - * @description Download url - * @example https://example.com/model.zip + * @description The index uuid (Knowledge Base) of the chunk. + * @example 123e4567-e89b-12d3-a456-426614174000 */ - url?: string; + index_uuid?: string; /** - * @description Unique id - * @example "12345678-1234-1234-1234-123456789012" + * @description The source name for the chunk, e.g., the file name or document title. + * @example example name */ - uuid?: string; - version?: components["schemas"]["apiModelVersion"]; + source_name?: string; + /** + * @description Text content of the chunk. + * @example example string + */ + text?: string; }; - /** @description A list of models */ - apiListModelsOutputPublic: { + /** + * @description Types of spans in a trace + * @default TRACE_SPAN_TYPE_UNKNOWN + * @example TRACE_SPAN_TYPE_UNKNOWN + * @enum {string} + */ + apiTraceSpanType: "TRACE_SPAN_TYPE_UNKNOWN" | "TRACE_SPAN_TYPE_LLM" | "TRACE_SPAN_TYPE_RETRIEVER" | "TRACE_SPAN_TYPE_TOOL"; + /** @description Represents a span within an evaluatioin trace (e.g., LLM call, tool call, etc.) */ + apiEvaluationTraceSpan: { + /** + * Format: date-time + * @description When the span was created + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** @description Input data for the span (flexible structure - can be messages array, string, etc.) */ + input?: Record; + /** + * @description Name/identifier for the span + * @example example name + */ + name?: string; + /** @description Output data from the span (flexible structure - can be message, string, etc.) */ + output?: Record; + /** @description Any retriever span chunks that were included as part of the span. */ + retriever_chunks?: components["schemas"]["apiPromptChunk"][]; + /** @description The span-level metric results. */ + span_level_metric_results?: components["schemas"]["apiEvaluationMetricResult"][]; + type?: components["schemas"]["apiTraceSpanType"]; + }; + apiPrompt: { + /** @description The evaluated trace spans. */ + evaluation_trace_spans?: components["schemas"]["apiEvaluationTraceSpan"][]; + /** + * @description The ground truth for the prompt. + * @example example string + */ + ground_truth?: string; + /** @example example string */ + input?: string; + /** + * Format: uint64 + * @description The number of input tokens used in the prompt. + * @example 12345 + */ + input_tokens?: string; + /** @example example string */ + output?: string; + /** + * Format: uint64 + * @description The number of output tokens used in the prompt. + * @example 12345 + */ + output_tokens?: string; + /** @description The list of prompt chunks. */ + prompt_chunks?: components["schemas"]["apiPromptChunk"][]; + /** + * Format: int64 + * @description Prompt ID + * @example 123 + */ + prompt_id?: number; + /** @description The metric results for the prompt. */ + prompt_level_metric_results?: components["schemas"]["apiEvaluationMetricResult"][]; + /** + * @description The trace id for the prompt. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + trace_id?: string; + }; + /** @description Gets the full results of an evaluation run with all prompts. */ + apiGetEvaluationRunResultsOutput: { + evaluation_run?: components["schemas"]["apiEvaluationRun"]; links?: components["schemas"]["apiLinks"]; meta?: components["schemas"]["apiMeta"]; - /** @description The models */ - models?: components["schemas"]["apiModelPublic"][]; + /** @description The prompt level results. */ + prompts?: components["schemas"]["apiPrompt"][]; }; - /** @description Description for a specific Region */ - genaiapiRegion: { + apiGetEvaluationRunPromptResultsOutput: { + prompt?: components["schemas"]["apiPrompt"]; + }; + apiListEvaluationTestCasesOutput: { + /** @description Alternative way of authentication for internal usage only - should not be exposed to public api */ + evaluation_test_cases?: components["schemas"]["apiEvaluationTestCase"][]; + }; + apiCreateEvaluationTestCaseInputPublic: { + /** @example example name */ + agent_workspace_name?: string; /** - * @description Url for inference server - * @example "example string" + * @description Dataset against which the test‑case is executed. + * @example 123e4567-e89b-12d3-a456-426614174000 */ - inference_url?: string; + dataset_uuid?: string; /** - * @description Region code - * @example "example string" + * @description Description of the test case. + * @example example string */ - region?: string; + description?: string; /** - * @description This datacenter is capable of running batch jobs - * @example true + * @description Full metric list to use for evaluation test case. + * @example [ + * "example string" + * ] */ - serves_batch?: boolean; + metrics?: string[]; /** - * @description This datacenter is capable of serving inference - * @example true + * @description Name of the test case. + * @example example name */ - serves_inference?: boolean; + name?: string; + star_metric?: components["schemas"]["apiStarMetric"]; /** - * @description The url for the inference streaming server - * @example "example string" + * @description The workspace uuid. + * @example 123e4567-e89b-12d3-a456-426614174000 */ - stream_inference_url?: string; + workspace_uuid?: string; }; - /** @description Region Codes */ - apiListRegionsOutput: { - /** @description Region code */ - regions?: components["schemas"]["genaiapiRegion"][]; + apiCreateEvaluationTestCaseOutput: { + /** + * @description Test‑case UUID. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + test_case_uuid?: string; }; - }; - responses: { - /** @description Unexpected error */ - unexpected_error: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "id": "example_error", - * "message": "some error message" - * } - */ - "application/json": components["schemas"]["error"]; - }; + apiListEvaluationRunsByTestCaseOutput: { + /** @description List of evaluation runs. */ + evaluation_runs?: components["schemas"]["apiEvaluationRun"][]; }; - /** @description A JSON object with a key of `1_clicks`. */ - oneClicks_all: { - 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": { - "1_clicks"?: components["schemas"]["oneClicks"][]; - }; - }; + apiGetEvaluationTestCaseOutput: { + evaluation_test_case?: components["schemas"]["apiEvaluationTestCase"]; }; - /** @description Unauthorized */ - unauthorized: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "id": "unauthorized", - * "message": "Unable to authenticate you." - * } - */ - "application/json": components["schemas"]["error"]; - }; + apiEvaluationTestCaseMetricList: { + /** + * @example [ + * "example string" + * ] + */ + metric_uuids?: string[]; }; - /** @description API Rate limit exceeded */ - too_many_requests: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "id": "too_many_requests", - * "message": "API Rate limit exceeded." - * } - */ - "application/json": components["schemas"]["error"]; - }; + apiUpdateEvaluationTestCaseInputPublic: { + /** + * @description Dataset against which the test‑case is executed. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + dataset_uuid?: string; + /** + * @description Description of the test case. + * @example example string + */ + description?: string; + metrics?: components["schemas"]["apiEvaluationTestCaseMetricList"]; + /** + * @description Name of the test case. + * @example example name + */ + name?: string; + star_metric?: components["schemas"]["apiStarMetric"]; + /** + * @description Test-case UUID to update + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + test_case_uuid?: string; }; - /** @description Server error. */ - server_error: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "id": "server_error", - * "message": "Unexpected server-side error" - * } - */ - "application/json": components["schemas"]["error"]; - }; + apiUpdateEvaluationTestCaseOutput: { + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + test_case_uuid?: string; + /** + * Format: int32 + * @description The new verson of the test case. + * @example 123 + */ + version?: number; }; - /** - * @description The response will verify that a job has been successfully created to install a 1-Click. The - * post-installation lifecycle of a 1-Click application can not be managed via the DigitalOcean - * API. For additional details specific to the 1-Click, find and view its - * [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. - */ - oneClicks_create: { - 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 A message about the result of the request. - * @example Successfully kicked off addon job. - */ - message?: string; - }; - }; + /** @description Indexing jobs */ + apiListKnowledgeBaseIndexingJobsOutput: { + /** @description The indexing jobs */ + jobs?: components["schemas"]["apiIndexingJob"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; - /** @description A JSON object keyed on account with an excerpt of the current user account data. */ - account: { - 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": { - account?: components["schemas"]["account"]; - }; - }; + /** @description StartKnowledgeBaseIndexingJobInputPublic description */ + apiStartKnowledgeBaseIndexingJobInputPublic: { + /** + * @description List of data source ids to index, if none are provided, all data sources will be indexed + * @example [ + * "example string" + * ] + */ + data_source_uuids?: string[]; + /** + * @description Knowledge base id + * @example "12345678-1234-1234-1234-123456789012" + */ + knowledge_base_uuid?: string; }; - /** @description A JSON object with the key set to `ssh_keys`. The value is an array of `ssh_key` objects, each of which contains the standard `ssh_key` attributes. */ - sshKeys_all: { - 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": { - ssh_keys?: components["schemas"]["sshKeys"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description StartKnowledgeBaseIndexingJobOutput description */ + apiStartKnowledgeBaseIndexingJobOutput: { + job?: components["schemas"]["apiIndexingJob"]; }; - /** @description The response body will be a JSON object with a key set to `ssh_key`. */ - sshKeys_new: { - 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": { - ssh_key?: components["schemas"]["sshKeys"]; - }; - }; + apiListIndexingJobDataSourcesOutput: { + indexed_data_sources?: components["schemas"]["apiIndexedDataSource"][]; }; - /** @description A JSON object with the key set to `ssh_key`. The value is an `ssh_key` object containing the standard `ssh_key` attributes. */ - sshKeys_existing: { - 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": { - ssh_key?: components["schemas"]["sshKeys"]; - }; - }; + apiGetIndexingJobDetailsSignedURLOutput: { + /** + * @description The signed url for downloading the indexing job details + * @example example string + */ + signed_url?: string; }; - /** @description The resource was not found. */ - not_found: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "id": "not_found", - * "message": "The resource you requested could not be found." - * } - */ - "application/json": components["schemas"]["error"]; - }; + /** @description GetKnowledgeBaseIndexingJobOutput description */ + apiGetKnowledgeBaseIndexingJobOutput: { + job?: components["schemas"]["apiIndexingJob"]; }; - /** @description The action was successful and the response body is empty. */ - no_content: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content?: never; + /** @description CancelKnowledgeBaseIndexingJobInputPublic description */ + apiCancelKnowledgeBaseIndexingJobInputPublic: { + /** + * @description A unique identifier for an indexing job. + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; }; - /** @description The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes */ - actions: { - 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": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; - }; - /** @description The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes. */ - action: { - 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": { - action?: components["schemas"]["action"]; - }; - }; - }; - /** @description A JSON object with a `apps` key. This is list of object `apps`. */ - list_apps: { - 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": components["schemas"]["apps_response"]; - }; - }; - /** @description A JSON or YAML of a `spec` object. */ - new_app: { - 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": components["schemas"]["app_response"]; - }; - }; - /** @description A JSON with key `app` */ - apps_get: { - 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": components["schemas"]["app_response"]; - }; + /** @description CancelKnowledgeBaseIndexingJobOutput description */ + apiCancelKnowledgeBaseIndexingJobOutput: { + job?: components["schemas"]["apiIndexingJob"]; }; - /** @description A JSON object of the updated `app` */ - update_app: { - 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": components["schemas"]["app_response"]; - }; + /** @description List of knowledge bases */ + apiListKnowledgeBasesOutput: { + /** @description The knowledge bases */ + knowledge_bases?: components["schemas"]["apiKnowledgeBase"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; - /** @description the ID of the app deleted. */ - delete_app: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "id": "b7d64052-3706-4cb7-b21a-c5a2f44e63b3" - * } - */ - "application/json": components["schemas"]["apps_delete_app_response"]; - }; + /** @description AWS S3 Data Source */ + apiAWSDataSource: { + /** + * @description Spaces bucket name + * @example example name + */ + bucket_name?: string; + /** @example example string */ + item_path?: string; + /** + * @description The AWS Key ID + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + key_id?: string; + /** + * @description Region of bucket + * @example example string + */ + region?: string; + /** + * @description The AWS Secret Key + * @example example string + */ + secret_key?: string; }; - /** @description A JSON object with a `deployment` key. */ - new_app_deployment: { - 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": components["schemas"]["apps_deployment_response"]; - }; + /** + * @description The chunking algorithm to use for processing data sources. + * + * **Note: This feature requires enabling the knowledgebase enhancements feature preview flag.** + * @default CHUNKING_ALGORITHM_SECTION_BASED + * @example CHUNKING_ALGORITHM_SECTION_BASED + * @enum {string} + */ + apiChunkingAlgorithm: "CHUNKING_ALGORITHM_UNKNOWN" | "CHUNKING_ALGORITHM_SECTION_BASED" | "CHUNKING_ALGORITHM_HIERARCHICAL" | "CHUNKING_ALGORITHM_SEMANTIC" | "CHUNKING_ALGORITHM_FIXED_LENGTH"; + /** + * @description Configuration options for the chunking algorithm. + * + * **Note: This feature requires enabling the knowledgebase enhancements feature preview flag.** + */ + apiChunkingOptions: { + /** + * Format: int64 + * @description Hierarchical options + * @example 350 + */ + child_chunk_size?: number; + /** + * Format: int64 + * @description Section_Based and Fixed_Length options + * @example 750 + */ + max_chunk_size?: number; + /** + * Format: int64 + * @description Hierarchical options + * @example 1000 + */ + parent_chunk_size?: number; + /** + * Format: float + * @description Semantic options + * @example 0.5 + */ + semantic_threshold?: number; }; - /** @description A JSON object with urls that point to archived logs */ - list_logs: { - 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": components["schemas"]["apps_get_logs_response"]; - }; + /** @description Dropbox Data Source */ + apiDropboxDataSource: { + /** @example example string */ + folder?: string; + /** + * @description Refresh token. you can obrain a refresh token by following the oauth2 flow. see /v2/gen-ai/oauth2/dropbox/tokens for reference. + * @example example string + */ + refresh_token?: string; }; - /** @description A JSON object with a websocket URL that allows sending/receiving console input and output. */ - get_exec: { - 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": components["schemas"]["apps_get_exec_response"]; - }; + /** @description Google Drive Data Source */ + apiGoogleDriveDataSource: { + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + folder_id?: string; + /** + * @description Refresh token. you can obrain a refresh token by following the oauth2 flow. see /v2/gen-ai/oauth2/google/tokens for reference. + * @example example string + */ + refresh_token?: string; }; - /** @description A JSON object with a `deployments` key. This will be a list of all app deployments */ - existing_deployments: { - 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": components["schemas"]["apps_deployments_response"]; - }; + /** @description Spaces Bucket Data Source */ + apiSpacesDataSource: { + /** + * @description Spaces bucket name + * @example example name + */ + bucket_name?: string; + /** @example example string */ + item_path?: string; + /** + * @description Region of bucket + * @example example string + */ + region?: string; }; - /** @description A JSON of the requested deployment */ - list_deployment: { - 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": components["schemas"]["apps_deployment_response"]; - }; + /** + * @description Options for specifying how URLs found on pages should be handled. + * + * - UNKNOWN: Default unknown value + * - SCOPED: Only include the base URL. + * - PATH: Crawl the base URL and linked pages within the URL path. + * - DOMAIN: Crawl the base URL and linked pages within the same domain. + * - SUBDOMAINS: Crawl the base URL and linked pages for any subdomain. + * - SITEMAP: Crawl URLs discovered in the sitemap. + * @default UNKNOWN + * @example UNKNOWN + * @enum {string} + */ + apiCrawlingOption: "UNKNOWN" | "SCOPED" | "PATH" | "DOMAIN" | "SUBDOMAINS" | "SITEMAP"; + /** @description WebCrawlerDataSource */ + apiWebCrawlerDataSource: { + /** + * @description The base url to crawl. + * @example example string + */ + base_url?: string; + crawling_option?: components["schemas"]["apiCrawlingOption"]; + /** + * @description Whether to ingest and index media (images, etc.) on web pages. + * @example true + */ + embed_media?: boolean; + /** + * @description Declaring which tags to exclude in web pages while webcrawling + * @example [ + * "example string" + * ] + */ + exclude_tags?: string[]; }; - /** @description A JSON the `deployment` that was just cancelled. */ - cancel_deployment: { - 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": components["schemas"]["apps_deployment_response"]; - }; + apiKBDataSource: { + aws_data_source?: components["schemas"]["apiAWSDataSource"]; + /** + * @description Deprecated, moved to data_source_details + * @example example name + */ + bucket_name?: string; + /** + * @description Deprecated, moved to data_source_details + * @example example string + */ + bucket_region?: string; + chunking_algorithm?: components["schemas"]["apiChunkingAlgorithm"]; + chunking_options?: components["schemas"]["apiChunkingOptions"]; + dropbox_data_source?: components["schemas"]["apiDropboxDataSource"]; + file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + google_drive_data_source?: components["schemas"]["apiGoogleDriveDataSource"]; + /** @example example string */ + item_path?: string; + spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + web_crawler_data_source?: components["schemas"]["apiWebCrawlerDataSource"]; }; - /** @description A JSON with key `instance_sizes` */ - list_instance: { - 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": components["schemas"]["apps_list_instance_sizes_response"]; - }; + /** @description Data to create a new knowledge base. */ + apiCreateKnowledgeBaseInputPublic: { + /** + * @description Identifier of the DigitalOcean OpenSearch database this knowledge base will use, optional. + * If not provided, we create a new database for the knowledge base in + * the same region as the knowledge base. + * @example "12345678-1234-1234-1234-123456789012" + */ + database_id?: string; + /** @description The data sources to use for this knowledge base. See [Organize Data Sources](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#spaces-buckets) for more information on data sources best practices. */ + datasources?: components["schemas"]["apiKBDataSource"][]; + /** + * @description Identifier for the [embedding model](https://docs.digitalocean.com/products/genai-platform/details/models/#embedding-models). + * @example "12345678-1234-1234-1234-123456789012" + */ + embedding_model_uuid?: string; + /** + * @description Name of the knowledge base. + * @example "My Knowledge Base" + */ + name?: string; + /** + * @description Identifier of the DigitalOcean project this knowledge base will belong to. + * @example "12345678-1234-1234-1234-123456789012" + */ + project_id?: string; + /** + * @description The datacenter region to deploy the knowledge base in. + * @example "tor1" + */ + region?: string; + /** + * @description Tags to organize your knowledge base. + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * @description The VPC to deploy the knowledge base database in + * @example "12345678-1234-1234-1234-123456789012" + */ + vpc_uuid?: string; }; - /** @description A JSON with key `instance_size` */ - get_instance: { - 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": components["schemas"]["apps_get_instance_size_response"]; - }; + /** @description Information about a newly created knowledge base */ + apiCreateKnowledgeBaseOutput: { + knowledge_base?: components["schemas"]["apiKnowledgeBase"]; }; - /** @description A JSON object with key `regions` */ - list_regions: { - 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": components["schemas"]["apps_list_regions_response"]; - }; + /** @description AWS S3 Data Source for Display */ + apiAWSDataSourceDisplay: { + /** + * @description Spaces bucket name + * @example example name + */ + bucket_name?: string; + /** @example example string */ + item_path?: string; + /** + * @description Region of bucket + * @example example string + */ + region?: string; }; - /** @description A JSON object. */ - propose_app: { - 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": components["schemas"]["app_propose_response"]; - }; + /** @description Dropbox Data Source for Display */ + apiDropboxDataSourceDisplay: { + /** @example example string */ + folder?: string; }; - /** @description A JSON object with a `alerts` key. This is list of object `alerts`. */ - list_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": components["schemas"]["apps_list_alerts_response"]; - }; + /** @description Google Drive Data Source for Display */ + apiGoogleDriveDataSourceDisplay: { + /** @example 123e4567-e89b-12d3-a456-426614174000 */ + folder_id?: string; + /** + * @description Name of the selected folder if available + * @example example name + */ + folder_name?: string; }; - /** @description A JSON object with an `alert` key. This is an object of type `alert`. */ - assign_alert_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": components["schemas"]["apps_alert_response"]; - }; + /** @description Data Source configuration for Knowledge Bases */ + apiKnowledgeBaseDataSource: { + aws_data_source?: components["schemas"]["apiAWSDataSourceDisplay"]; + /** + * @description Name of storage bucket - Deprecated, moved to data_source_details + * @example example name + */ + bucket_name?: string; + chunking_algorithm?: components["schemas"]["apiChunkingAlgorithm"]; + chunking_options?: components["schemas"]["apiChunkingOptions"]; + /** + * Format: date-time + * @description Creation date / time + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + dropbox_data_source?: components["schemas"]["apiDropboxDataSourceDisplay"]; + file_upload_data_source?: components["schemas"]["apiFileUploadDataSource"]; + google_drive_data_source?: components["schemas"]["apiGoogleDriveDataSourceDisplay"]; + /** + * @description Path of folder or object in bucket - Deprecated, moved to data_source_details + * @example example string + */ + item_path?: string; + last_datasource_indexing_job?: components["schemas"]["apiIndexedDataSource"]; + /** + * @description Region code - Deprecated, moved to data_source_details + * @example example string + */ + region?: string; + spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + /** + * Format: date-time + * @description Last modified + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Unique id of knowledge base + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + web_crawler_data_source?: components["schemas"]["apiWebCrawlerDataSource"]; }; - /** @description A JSON object with the validation results. */ - apps_validate_rollback: { - 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 Indicates whether the app can be rolled back to the specified deployment. */ - valid?: boolean; - error?: unknown & components["schemas"]["app_rollback_validation_condition"]; - /** @description Contains a list of warnings that may cause the rollback to run under unideal circumstances. */ - warnings?: components["schemas"]["app_rollback_validation_condition"][]; - }; - }; + /** @description A list of knowledge base data sources */ + apiListKnowledgeBaseDataSourcesOutput: { + /** @description The data sources */ + knowledge_base_data_sources?: components["schemas"]["apiKnowledgeBaseDataSource"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; }; - /** @description A JSON object with a `app_bandwidth_usage` key */ - get_metrics_bandwidth_usage: { - 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": components["schemas"]["app_metrics_bandwidth_usage"]; - }; + /** @description Data to create a knowledge base data source */ + apiCreateKnowledgeBaseDataSourceInputPublic: { + aws_data_source?: components["schemas"]["apiAWSDataSource"]; + chunking_algorithm?: components["schemas"]["apiChunkingAlgorithm"]; + chunking_options?: components["schemas"]["apiChunkingOptions"]; + /** + * @description Knowledge base id + * @example "12345678-1234-1234-1234-123456789012" + */ + knowledge_base_uuid?: string; + spaces_data_source?: components["schemas"]["apiSpacesDataSource"]; + web_crawler_data_source?: components["schemas"]["apiWebCrawlerDataSource"]; }; - /** @description A JSON object with a `app_bandwidth_usage` key */ - list_metrics_bandwidth_usage: { - 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": components["schemas"]["app_metrics_bandwidth_usage"]; - }; + /** @description Information about a newly created knowldege base data source */ + apiCreateKnowledgeBaseDataSourceOutput: { + knowledge_base_data_source?: components["schemas"]["apiKnowledgeBaseDataSource"]; }; - /** @description The result will be a JSON object with an `endpoints` key. This will be set to an array of endpoint objects, each of which will contain the standard CDN endpoint attributes. */ - all_cdn_endpoints: { - 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": { - endpoints?: components["schemas"]["cdn_endpoint"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description Update a data source of a knowledge base with change in chunking algorithm/options */ + apiUpdateKnowledgeBaseDataSourceInputPublic: { + chunking_algorithm?: components["schemas"]["apiChunkingAlgorithm"]; + chunking_options?: components["schemas"]["apiChunkingOptions"]; + /** + * @description Data Source ID (Path Parameter) + * @example 98765432-1234-1234-1234-123456789012 + */ + data_source_uuid?: string; + /** + * @description Knowledge Base ID (Path Parameter) + * @example 12345678-1234-1234-1234-123456789012 + */ + knowledge_base_uuid?: string; }; - /** @description The response will be a JSON object with an `endpoint` key. This will be set to an object containing the standard CDN endpoint attributes. */ - existing_endpoint: { - 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": { - endpoint?: components["schemas"]["cdn_endpoint"]; - }; - }; + /** @description Update a data source of a knowledge base with change in chunking algorithm/options */ + apiUpdateKnowledgeBaseDataSourceOutput: { + knowledge_base_data_source?: components["schemas"]["apiKnowledgeBaseDataSource"]; }; - /** @description The result will be a JSON object with a `certificates` key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes. */ - all_certificates: { - 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": { - certificates?: components["schemas"]["certificate"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + /** @description Information about a newly deleted knowledge base data source */ + apiDeleteKnowledgeBaseDataSourceOutput: { + /** + * @description Data source id + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + data_source_uuid?: string; + /** + * @description Knowledge base id + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + knowledge_base_uuid?: string; }; /** - * @description The response will be a JSON object with a key called `certificate`. The value of this will be an object that contains the standard attributes associated with a certificate. - * When using Let's Encrypt, the initial value of the certificate's `state` attribute will be `pending`. When the certificate has been successfully issued by Let's Encrypt, this will transition to `verified` and be ready for use. + * @default CREATING + * @example CREATING + * @enum {string} */ - new_certificate: { + dbaasClusterStatus: "CREATING" | "ONLINE" | "POWEROFF" | "REBUILDING" | "REBALANCING" | "DECOMMISSIONED" | "FORKING" | "MIGRATING" | "RESIZING" | "RESTORING" | "POWERING_ON" | "UNHEALTHY"; + /** @description The knowledge base */ + apiGetKnowledgeBaseOutput: { + database_status?: components["schemas"]["dbaasClusterStatus"]; + knowledge_base?: components["schemas"]["apiKnowledgeBase"]; + }; + /** @description Information about updating a knowledge base */ + apiUpdateKnowledgeBaseInputPublic: { + /** + * @description The id of the DigitalOcean database this knowledge base will use, optiona. + * @example "12345678-1234-1234-1234-123456789012" + */ + database_id?: string; + /** + * @description Identifier for the foundation model. + * @example "12345678-1234-1234-1234-123456789012" + */ + embedding_model_uuid?: string; + /** + * @description Knowledge base name + * @example "My Knowledge Base" + */ + name?: string; + /** + * @description The id of the DigitalOcean project this knowledge base will belong to + * @example "12345678-1234-1234-1234-123456789012" + */ + project_id?: string; + /** + * @description Tags to organize your knowledge base. + * @example [ + * "example string" + * ] + */ + tags?: string[]; + /** + * @description Knowledge base id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; + }; + /** @description Information about an updated knowledge base */ + apiUpdateKnowledgeBaseOutput: { + knowledge_base?: components["schemas"]["apiKnowledgeBase"]; + }; + /** @description Information about a deleted knowledge base */ + apiDeleteKnowledgeBaseOutput: { + /** + * @description The id of the deleted knowledge base + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + }; + /** @description A machine learning model stored on the GenAI platform */ + apiModelPublic: { + agreement?: components["schemas"]["apiAgreement"]; + /** + * Format: date-time + * @description Creation date / time + * @example 2021-01-01T00:00:00Z + */ + created_at?: string; + /** + * @description Human-readable model identifier + * @example llama3.3-70b-instruct + */ + id?: string; + /** + * @description True if it is a foundational model provided by do + * @example true + */ + is_foundational?: boolean; + /** + * Format: int64 + * @description Default chunking size limit to show in UI + * @example 123 + */ + kb_default_chunk_size?: number; + /** + * Format: int64 + * @description Maximum chunk size limit of model + * @example 123 + */ + kb_max_chunk_size?: number; + /** + * Format: int64 + * @description Minimum chunking size token limits if model supports KNOWLEDGEBASE usecase + * @example 123 + */ + kb_min_chunk_size?: number; + /** + * @description Display name of the model + * @example Llama 3.3 Instruct (70B) + */ + name?: string; + /** + * @description Unique id of the model, this model is based on + * @example "12345678-1234-1234-1234-123456789012" + */ + parent_uuid?: string; + /** + * Format: date-time + * @description Last modified + * @example 2021-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Model has been fully uploaded + * @example true + */ + upload_complete?: boolean; + /** + * @description Download url + * @example https://example.com/model.zip + */ + url?: string; + /** + * @description Unique id + * @example "12345678-1234-1234-1234-123456789012" + */ + uuid?: string; + version?: components["schemas"]["apiModelVersion"]; + }; + /** @description A list of models */ + apiListModelsOutputPublic: { + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + /** @description The models */ + models?: components["schemas"]["apiModelPublic"][]; + }; + /** @description Model API Key Info */ + apiModelAPIKeyInfo: { + /** + * Format: date-time + * @description Creation date + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** + * Format: uint64 + * @description Created by + * @example 12345 + */ + created_by?: string; + /** + * Format: date-time + * @description Deleted date + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** + * @description Name + * @example example name + */ + name?: string; + /** @example example string */ + secret_key?: string; + /** + * @description Uuid + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + }; + apiListModelAPIKeysOutput: { + /** @description Api key infos */ + api_key_infos?: components["schemas"]["apiModelAPIKeyInfo"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + apiCreateModelAPIKeyInputPublic: { + /** + * @description A human friendly name to identify the key + * @example Production Key + */ + name?: string; + }; + apiCreateModelAPIKeyOutput: { + api_key_info?: components["schemas"]["apiModelAPIKeyInfo"]; + }; + apiUpdateModelAPIKeyInputPublic: { + /** + * @description API key ID + * @example "12345678-1234-1234-1234-123456789012" + */ + api_key_uuid?: string; + /** + * @description Name + * @example "Production Key" + */ + name?: string; + }; + apiUpdateModelAPIKeyOutput: { + api_key_info?: components["schemas"]["apiModelAPIKeyInfo"]; + }; + apiDeleteModelAPIKeyOutput: { + api_key_info?: components["schemas"]["apiModelAPIKeyInfo"]; + }; + apiRegenerateModelAPIKeyOutput: { + api_key_info?: components["schemas"]["apiModelAPIKeyInfo"]; + }; + /** @description The oauth2 code from google */ + apiDropboxOauth2GetTokensInput: { + /** + * @description The oauth2 code from google + * @example example string + */ + code?: string; + /** + * @description Redirect url + * @example example string + */ + redirect_url?: string; + }; + /** @description The dropbox oauth2 token and refresh token */ + apiDropboxOauth2GetTokensOutput: { + /** + * @description The refresh token + * @example example string + */ + refresh_token?: string; + /** + * @description The access token + * @example example string + */ + token?: string; + }; + /** @description The url for the oauth2 flow */ + apiGenerateOauth2URLOutput: { + /** + * @description The oauth2 url + * @example example string + */ + url?: string; + }; + /** @description ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys for a specific agent. */ + apiListOpenAIAPIKeysOutput: { + /** @description Api key infos */ + api_key_infos?: components["schemas"]["apiOpenAIAPIKeyInfo"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + /** @description CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key for a specific agent. */ + apiCreateOpenAIAPIKeyInputPublic: { + /** + * @description OpenAI API key + * @example "sk-proj--123456789098765432123456789" + */ + api_key?: string; + /** + * @description Name of the key + * @example "Production Key" + */ + name?: string; + }; + /** @description CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI API key. */ + apiCreateOpenAIAPIKeyOutput: { + api_key_info?: components["schemas"]["apiOpenAIAPIKeyInfo"]; + }; + apiGetOpenAIAPIKeyOutput: { + api_key_info?: components["schemas"]["apiOpenAIAPIKeyInfo"]; + }; + /** @description UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI API key for a specific agent. */ + apiUpdateOpenAIAPIKeyInputPublic: { + /** + * @description OpenAI API key + * @example "sk-ant-12345678901234567890123456789012" + */ + api_key?: string; + /** + * @description API key ID + * @example "12345678-1234-1234-1234-123456789012" + */ + api_key_uuid?: string; + /** + * @description Name of the key + * @example "Production Key" + */ + name?: string; + }; + /** @description UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key. */ + apiUpdateOpenAIAPIKeyOutput: { + api_key_info?: components["schemas"]["apiOpenAIAPIKeyInfo"]; + }; + /** @description DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key. */ + apiDeleteOpenAIAPIKeyOutput: { + api_key_info?: components["schemas"]["apiOpenAIAPIKeyInfo"]; + }; + /** @description List of Agents that are linked to a specific OpenAI Key */ + apiListAgentsByOpenAIKeyOutput: { + agents?: components["schemas"]["apiAgent"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + /** @description Description for a specific Region */ + genaiapiRegion: { + /** + * @description Url for inference server + * @example example string + */ + inference_url?: string; + /** + * @description Region code + * @example example string + */ + region?: string; + /** + * @description This datacenter is capable of running batch jobs + * @example true + */ + serves_batch?: boolean; + /** + * @description This datacenter is capable of serving inference + * @example true + */ + serves_inference?: boolean; + /** + * @description The url for the inference streaming server + * @example example string + */ + stream_inference_url?: string; + }; + /** @description Region Codes */ + apiListRegionsOutput: { + /** @description Region code */ + regions?: components["schemas"]["genaiapiRegion"][]; + }; + apiCreateScheduledIndexingInputPublic: { + /** @description Days for execution (day is represented same as in a cron expression, e.g. Monday begins with 1 ) */ + days?: number[]; + /** + * @description Knowledge base uuid for which the schedule is created + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + knowledge_base_uuid?: string; + /** + * @description Time of execution (HH:MM) UTC + * @example example string + */ + time?: string; + }; + /** @description Metadata for scheduled indexing entries */ + apiScheduledIndexingInfo: { + /** + * Format: date-time + * @description Created at timestamp + * @example 2023-01-01T00:00:00Z + */ + created_at?: string; + /** @description Days for execution (day is represented same as in a cron expression, e.g. Monday begins with 1 ) */ + days?: number[]; + /** + * Format: date-time + * @description Deleted at timestamp (if soft deleted) + * @example 2023-01-01T00:00:00Z + */ + deleted_at?: string; + /** + * @description Whether the schedule is currently active + * @example true + */ + is_active?: boolean; + /** + * @description Knowledge base uuid associated with this schedule + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + knowledge_base_uuid?: string; + /** + * Format: date-time + * @description Last time the schedule was executed + * @example 2023-01-01T00:00:00Z + */ + last_ran_at?: string; + /** + * Format: date-time + * @description Next scheduled run + * @example 2023-01-01T00:00:00Z + */ + next_run_at?: string; + /** + * @description Scheduled time of execution (HH:MM:SS format) + * @example example string + */ + time?: string; + /** + * Format: date-time + * @description Updated at timestamp + * @example 2023-01-01T00:00:00Z + */ + updated_at?: string; + /** + * @description Unique identifier for the scheduled indexing entry + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + }; + apiCreateScheduledIndexingOutput: { + indexing_info?: components["schemas"]["apiScheduledIndexingInfo"]; + }; + apiGetScheduledIndexingOutput: { + indexing_info?: components["schemas"]["apiScheduledIndexingInfo"]; + }; + apiDeleteScheduledIndexingOutput: { + indexing_info?: components["schemas"]["apiScheduledIndexingInfo"]; + }; + apiListWorkspacesOutput: { + /** @description Workspaces */ + workspaces?: components["schemas"]["apiWorkspace"][]; + }; + /** @description Parameters for Workspace Creation */ + apiCreateWorkspaceInputPublic: { + /** + * @description Ids of the agents(s) to attach to the workspace + * @example [ + * "example string" + * ] + */ + agent_uuids?: string[]; + /** + * @description Description of the workspace + * @example example string + */ + description?: string; + /** + * @description Name of the workspace + * @example example name + */ + name?: string; + }; + apiCreateWorkspaceOutput: { + workspace?: components["schemas"]["apiWorkspace"]; + }; + apiGetWorkspaceOutput: { + workspace?: components["schemas"]["apiWorkspace"]; + }; + /** @description Parameters for Update Workspace */ + apiUpdateWorkspaceInputPublic: { + /** + * @description The new description of the workspace + * @example example string + */ + description?: string; + /** + * @description The new name of the workspace + * @example example name + */ + name?: string; + /** + * @description Workspace UUID. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + workspace_uuid?: string; + }; + apiUpdateWorkspaceOutput: { + workspace?: components["schemas"]["apiWorkspace"]; + }; + apiDeleteWorkspaceOutput: { + /** + * @description Workspace + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + workspace_uuid?: string; + }; + apiListAgentsByWorkspaceOutput: { + agents?: components["schemas"]["apiAgent"][]; + links?: components["schemas"]["apiLinks"]; + meta?: components["schemas"]["apiMeta"]; + }; + /** @description Parameters for Moving agents to a Workspace */ + apiMoveAgentsToWorkspaceInputPublic: { + /** + * @description Agent uuids + * @example [ + * "example string" + * ] + */ + agent_uuids?: string[]; + /** + * @description Workspace uuid to move agents to + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + workspace_uuid?: string; + }; + apiMoveAgentsToWorkspaceOutput: { + workspace?: components["schemas"]["apiWorkspace"]; + }; + apiListEvaluationTestCasesByWorkspaceOutput: { + evaluation_test_cases?: components["schemas"]["apiEvaluationTestCase"][]; + }; + }; + responses: { + /** @description There was an unexpected error. */ + unexpected_error: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17550,13 +24023,17 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - certificate?: components["schemas"]["certificate"]; - }; + /** + * @example { + * "id": "example_error", + * "message": "some error message" + * } + */ + "application/json": components["schemas"]["error"]; }; }; - /** @description The response will be a JSON object with a `certificate` key. This will be set to an object containing the standard certificate attributes. */ - existing_certificate: { + /** @description A JSON object with a key of `1_clicks`. */ + oneClicks_all: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17565,12 +24042,12 @@ export interface components { }; content: { "application/json": { - certificate?: components["schemas"]["certificate"]; + "1_clicks"?: components["schemas"]["oneClicks"][]; }; }; }; - /** @description The response will be a JSON object that contains the following attributes */ - balance: { + /** @description Authentication failed due to invalid credentials. */ + unauthorized: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17580,17 +24057,15 @@ export interface components { content: { /** * @example { - * "month_to_date_balance": "23.44", - * "account_balance": "12.23", - * "month_to_date_usage": "11.21", - * "generated_at": "2019-07-09T15:01:12Z" + * "id": "unauthorized", + * "message": "Unable to authenticate you." * } */ - "application/json": components["schemas"]["balance"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description The response will be a JSON object that contains the following attributes */ - billing_history: { + /** @description The API rate limit has been exceeded. */ + too_many_requests: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17598,16 +24073,40 @@ export interface components { [name: string]: unknown; }; content: { - "application/json": { - billing_history?: components["schemas"]["billing_history"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta_optional_total"]; + /** + * @example { + * "id": "too_many_requests", + * "message": "API rate limit exceeded." + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description There was a server error. */ + server_error: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "server_error", + * "message": "Unexpected server-side error" + * } + */ + "application/json": components["schemas"]["error"]; }; }; /** - * @description The response will be a JSON object contains that contains a list of invoices under the `invoices` key, and the invoice preview under the `invoice_preview` key. - * Each element contains the invoice summary attributes. + * @description The response will verify that a job has been successfully created to install a 1-Click. The + * post-installation lifecycle of a 1-Click application can not be managed via the DigitalOcean + * API. For additional details specific to the 1-Click, find and view its + * [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. */ - invoices: { + oneClicks_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17616,13 +24115,16 @@ export interface components { }; content: { "application/json": { - invoices?: components["schemas"]["invoice_preview"][]; - invoice_preview?: components["schemas"]["invoice_preview"]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + /** + * @description A message about the result of the request. + * @example Successfully kicked off addon job. + */ + message?: string; + }; }; }; - /** @description The response will be a JSON object with a key called `invoice_items`. This will be set to an array of invoice item objects. */ - invoice: { + /** @description A JSON object keyed on account with an excerpt of the current user account data. */ + account: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17631,43 +24133,54 @@ export interface components { }; content: { "application/json": { - invoice_items?: components["schemas"]["invoice_item"][]; + account?: components["schemas"]["account"]; + }; + }; + }; + /** @description A JSON object with the key set to `ssh_keys`. The value is an array of `ssh_key` objects, each of which contains the standard `ssh_key` attributes. */ + sshKeys_all: { + 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": { + ssh_keys?: components["schemas"]["sshKeys"][]; } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description The response will be a CSV file. */ - invoice_csv: { + /** @description The response body will be a JSON object with a key set to `ssh_key`. */ + sshKeys_new: { headers: { - "content-disposition": components["headers"]["content-disposition"]; "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; content: { - /** - * @example product,group_description,description,hours,start,end,USD,project_name,category - * Floating IPs,,Unused Floating IP - 1.1.1.1,100,2020-07-01 00:00:00 +0000,2020-07-22 18:14:39 +0000,$3.11,,iaas - * Taxes,,STATE SALES TAX (6.25%),,2020-07-01 00:00:00 +0000,2020-07-31 23:59:59 +0000,$0.16,,iaas - */ - "text/csv": string; + "application/json": { + ssh_key?: components["schemas"]["sshKeys"]; + }; }; }; - /** @description The response will be a PDF file. */ - invoice_pdf: { + /** @description A JSON object with the key set to `ssh_key`. The value is an `ssh_key` object containing the standard `ssh_key` attributes. */ + sshKeys_existing: { headers: { - "content-disposition": components["headers"]["content-disposition"]; "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; content: { - "application/pdf": string; + "application/json": { + ssh_key?: components["schemas"]["sshKeys"]; + }; }; }; - /** @description To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. */ - invoice_summary: { + /** @description The resource was not found. */ + not_found: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -17677,682 +24190,6109 @@ export interface components { content: { /** * @example { - * "invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681", - * "invoice_id": "123456789", - * "billing_period": "2020-01", - * "amount": "27.13", - * "user_name": "Sammy Shark", - * "user_billing_address": { - * "address_line1": "101 Shark Row", - * "city": "Atlantis", - * "region": "OC", - * "postal_code": "12345", - * "country_iso2_code": "US", - * "created_at": "2019-09-03T16:34:46.000+00:00", - * "updated_at": "2019-09-03T16:34:46.000+00:00" - * }, - * "user_company": "DigitalOcean", - * "user_email": "sammy@digitalocean.com", - * "product_charges": { - * "name": "Product usage charges", - * "amount": "12.34", - * "items": [ - * { - * "amount": "10.00", - * "name": "Spaces Subscription", - * "count": "1" - * }, - * { - * "amount": "2.34", - * "name": "Database Clusters", - * "count": "1" - * } - * ] - * }, - * "overages": { - * "name": "Overages", - * "amount": "3.45" - * }, - * "taxes": { - * "name": "Taxes", - * "amount": "4.56" - * }, - * "credits_and_adjustments": { - * "name": "Credits & adjustments", - * "amount": "6.78" - * } + * "id": "not_found", + * "message": "The resource you requested could not be found." * } */ - "application/json": components["schemas"]["invoice_summary"]; + "application/json": components["schemas"]["error"]; }; }; - /** @description A JSON string with a key of `options`. */ - options: { + /** @description The action was successful and the response body is empty. */ + no_content: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; - content: { - /** - * @example { - * "options": { + content?: never; + }; + /** @description The results will be returned as a JSON object with an actions key. This will be set to an array filled with action objects containing the standard action attributes */ + actions: { + 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": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The result will be a JSON object with an action key. This will be set to an action object containing the standard action attributes. */ + action: { + 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": { + action?: components["schemas"]["action"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `apps`. `apps` will be an array of objects. */ + addons_get_app: { + 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": { + apps?: components["schemas"]["addons_app_info"][]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `metadata`. `metadata` will be an array of objects, each representing a metadata item for the app. Each object will contain details such as `id`, `name`, `display_name`, `description`, `type`, and `options`. For additional details specific to the app, find and view its [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. */ + addons_get_app_metadata: { + 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": { + metadata?: components["schemas"]["addons_app_metadata"][]; + }; + }; + }; + /** @description The response will be an array of JSON objects with a key called `resources`. */ + addons_list: { + 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": { + resources?: components["schemas"]["addons_resource"][]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `resource`. The value of this will be the resource created with the given. For additional details specific to the app, find and view its [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. */ + addons_create: { + 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": { + resource?: components["schemas"]["addons_resource"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `resource`. */ + addons_get: { + 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": { + resource?: components["schemas"]["addons_resource"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `resource`, representing the updated resource. */ + addons_update: { + 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": { + resource?: components["schemas"]["addons_resource"]; + }; + }; + }; + /** @description A JSON object with a `apps` key. This is list of object `apps`. */ + list_apps: { + 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": components["schemas"]["apps_response"]; + }; + }; + /** @description A JSON or YAML of a `spec` object. */ + new_app: { + 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": components["schemas"]["app_response"]; + }; + }; + /** @description A JSON with key `app` */ + apps_get: { + 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": components["schemas"]["app_response"]; + }; + }; + /** @description A JSON object of the updated `app` */ + update_app: { + 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": components["schemas"]["app_response"]; + }; + }; + /** @description the ID of the app deleted. */ + delete_app: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "b7d64052-3706-4cb7-b21a-c5a2f44e63b3" + * } + */ + "application/json": components["schemas"]["apps_delete_app_response"]; + }; + }; + /** @description A JSON object with a `deployment` key. */ + new_app_deployment: { + 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": components["schemas"]["apps_deployment_response"]; + }; + }; + /** @description A JSON object with urls that point to archived logs */ + list_logs: { + 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": components["schemas"]["apps_get_logs_response"]; + }; + }; + /** @description A JSON object with a websocket URL that allows sending/receiving console input and output. */ + get_exec: { + 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": components["schemas"]["apps_get_exec_response"]; + }; + }; + /** @description A JSON with key `instances` */ + apps_instances: { + 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": components["schemas"]["app_instances"]; + }; + }; + /** @description A JSON object with a `deployments` key. This will be a list of all app deployments */ + existing_deployments: { + 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": components["schemas"]["apps_deployments_response"]; + }; + }; + /** @description A JSON of the requested deployment */ + list_deployment: { + 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": components["schemas"]["apps_deployment_response"]; + }; + }; + /** @description A JSON the `deployment` that was just cancelled. */ + cancel_deployment: { + 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": components["schemas"]["apps_deployment_response"]; + }; + }; + /** @description A JSON with key `job_invocations` */ + list_job_invocations: { + 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": components["schemas"]["app_job_invocations"]; + }; + }; + /** @description A JSON with key `job_invocation` */ + get_job_invocation: { + 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": components["schemas"]["app_job_invocation"]; + }; + }; + /** @description A JSON with key `job_invocation` */ + cancel_job_invocation: { + 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": components["schemas"]["app_job_invocation"]; + }; + }; + /** @description A JSON object with urls that point to Job Invocation logs */ + apps_get_logs: { + 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": components["schemas"]["apps_get_logs_response"]; + }; + }; + /** @description A JSON with key `instance_sizes` */ + list_instance: { + 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": components["schemas"]["apps_list_instance_sizes_response"]; + }; + }; + /** @description A JSON with key `instance_size` */ + get_instance: { + 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": components["schemas"]["apps_get_instance_size_response"]; + }; + }; + /** @description A JSON object with key `regions` */ + list_regions: { + 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": components["schemas"]["apps_list_regions_response"]; + }; + }; + /** @description A JSON object. */ + propose_app: { + 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": components["schemas"]["app_propose_response"]; + }; + }; + /** @description A JSON object with a `alerts` key. This is list of object `alerts`. */ + list_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": components["schemas"]["apps_list_alerts_response"]; + }; + }; + /** @description A JSON object with an `alert` key. This is an object of type `alert`. */ + assign_alert_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": components["schemas"]["apps_alert_response"]; + }; + }; + /** @description A JSON object with the validation results. */ + apps_validate_rollback: { + 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 Indicates whether the app can be rolled back to the specified deployment. */ + valid?: boolean; + error?: unknown & components["schemas"]["app_rollback_validation_condition"]; + /** @description Contains a list of warnings that may cause the rollback to run under unideal circumstances. */ + warnings?: components["schemas"]["app_rollback_validation_condition"][]; + }; + }; + }; + /** @description A JSON object with a `app_bandwidth_usage` key */ + get_metrics_bandwidth_usage: { + 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": components["schemas"]["app_metrics_bandwidth_usage"]; + }; + }; + /** @description A JSON object with a `app_bandwidth_usage` key */ + list_metrics_bandwidth_usage: { + 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": components["schemas"]["app_metrics_bandwidth_usage"]; + }; + }; + /** @description A JSON with key `app_health` */ + apps_health: { + 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": components["schemas"]["app_health_response"]; + }; + }; + /** @description The result will be a JSON object with an `endpoints` key. This will be set to an array of endpoint objects, each of which will contain the standard CDN endpoint attributes. */ + all_cdn_endpoints: { + 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": { + endpoints?: components["schemas"]["cdn_endpoint"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with an `endpoint` key. This will be set to an object containing the standard CDN endpoint attributes. */ + existing_endpoint: { + 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": { + endpoint?: components["schemas"]["cdn_endpoint"]; + }; + }; + }; + /** @description The result will be a JSON object with a `certificates` key. This will be set to an array of certificate objects, each of which will contain the standard certificate attributes. */ + all_certificates: { + 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": { + certificates?: components["schemas"]["certificate"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `certificate`. The value of this will be an object that contains the standard attributes associated with a certificate. + * When using Let's Encrypt, the initial value of the certificate's `state` attribute will be `pending`. When the certificate has been successfully issued by Let's Encrypt, this will transition to `verified` and be ready for use. + */ + new_certificate: { + 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": { + certificate?: components["schemas"]["certificate"]; + }; + }; + }; + /** @description The response will be a JSON object with a `certificate` key. This will be set to an object containing the standard certificate attributes. */ + existing_certificate: { + 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": { + certificate?: components["schemas"]["certificate"]; + }; + }; + }; + /** @description The response will be a JSON object that contains the following attributes */ + balance: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "month_to_date_balance": "23.44", + * "account_balance": "12.23", + * "month_to_date_usage": "11.21", + * "generated_at": "2019-07-09T15:01:12Z" + * } + */ + "application/json": components["schemas"]["balance"]; + }; + }; + /** @description The response will be a JSON object that contains the following attributes */ + billing_history: { + 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": { + billing_history?: components["schemas"]["billing_history"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta_optional_total"]; + }; + }; + /** + * @description The response will be a JSON object contains that contains a list of invoices under the `invoices` key, and the invoice preview under the `invoice_preview` key. + * Each element contains the invoice summary attributes. + */ + invoices: { + 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": { + invoices?: components["schemas"]["invoice_preview"][]; + invoice_preview?: components["schemas"]["invoice_preview"]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `invoice_items`. This will be set to an array of invoice item objects. All resources will be shown on invoices, regardless of permissions. */ + invoice: { + 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": { + invoice_items?: components["schemas"]["invoice_item"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a CSV file. */ + invoice_csv: { + headers: { + "content-disposition": components["headers"]["content-disposition"]; + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example product,group_description,description,hours,start,end,USD,project_name,category + * Floating IPs,,Unused Floating IP - 1.1.1.1,100,2020-07-01 00:00:00 +0000,2020-07-22 18:14:39 +0000,$3.11,,iaas + * Taxes,,STATE SALES TAX (6.25%),,2020-07-01 00:00:00 +0000,2020-07-31 23:59:59 +0000,$0.16,,iaas + */ + "text/csv": string; + }; + }; + /** @description The response will be a PDF file. */ + invoice_pdf: { + headers: { + "content-disposition": components["headers"]["content-disposition"]; + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/pdf": string; + }; + }; + /** @description To retrieve a summary for an invoice, send a GET request to `/v2/customers/my/invoices/$INVOICE_UUID/summary`. */ + invoice_summary: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "invoice_uuid": "22737513-0ea7-4206-8ceb-98a575af7681", + * "invoice_id": "123456789", + * "billing_period": "2020-01", + * "amount": "27.13", + * "user_name": "Sammy Shark", + * "user_billing_address": { + * "address_line1": "101 Shark Row", + * "city": "Atlantis", + * "region": "OC", + * "postal_code": "12345", + * "country_iso2_code": "US", + * "created_at": "2019-09-03T16:34:46.000+00:00", + * "updated_at": "2019-09-03T16:34:46.000+00:00" + * }, + * "user_company": "DigitalOcean", + * "user_email": "sammy@digitalocean.com", + * "product_charges": { + * "name": "Product usage charges", + * "amount": "12.34", + * "items": [ + * { + * "amount": "10.00", + * "name": "Spaces Subscription", + * "count": "1" + * }, + * { + * "amount": "2.34", + * "name": "Database Clusters", + * "count": "1" + * } + * ] + * }, + * "overages": { + * "name": "Overages", + * "amount": "3.45" + * }, + * "taxes": { + * "name": "Taxes", + * "amount": "4.56" + * }, + * "credits_and_adjustments": { + * "name": "Credits & adjustments", + * "amount": "6.78" + * } + * } + */ + "application/json": components["schemas"]["invoice_summary"]; + }; + }; + /** @description The response will be a JSON object that contains a list of billing data points under the `data_points` key, along with pagination metadata including `total_items`, `total_pages`, and `current_page`. */ + billing_insights: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "data_points": [ + * { + * "usage_team_urn": "do:team:12345678-1234-1234-1234-123456789012", + * "start_date": "2025-01-01", + * "total_amount": "0.86", + * "region": "nyc3", + * "sku": "1-DO-DROP-0109", + * "description": "droplet name (c-2-4GiB)", + * "group_description": "" + * }, + * { + * "usage_team_urn": "do:team:12345678-1234-1234-1234-123456789012", + * "start_date": "2025-01-01", + * "total_amount": "2.57", + * "region": "nyc3", + * "sku": "1-KS-K8SWN-00109", + * "description": "3 nodes - 4 GB / 2 vCPU / 80 GB SSD", + * "group_description": "kubernetes cluster name" + * } + * ], + * "total_items": 2, + * "total_pages": 1, + * "current_page": 1 + * } + */ + "application/json": { + /** @description Array of billing data points, which are day-over-day changes in billing resource usage based on nightly invoice item estimates, for the requested period */ + data_points: components["schemas"]["billing_data_point"][]; + /** + * @description Total number of items available across all pages + * @example 250 + */ + total_items: number; + /** + * @description Total number of pages available + * @example 3 + */ + total_pages: number; + /** + * @description Current page number + * @example 1 + */ + current_page: number; + }; + }; + }; + /** @description A JSON string with a key of `options`. */ + options: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "options": { * "kafka": { * "regions": [ - * "ams3", - * "blr1", - * "fra1", - * "lon1", - * "nyc1", + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc2", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "3.8" + * ], + * "layouts": [ + * { + * "num_nodes": 3, + * "sizes": [ + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "db-s-2vcpu-4gb", + * "db-s-2vcpu-2gb" + * ] + * }, + * { + * "num_nodes": 6, + * "sizes": [ + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb" + * ] + * }, + * { + * "num_nodes": 9, + * "sizes": [ + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb" + * ] + * }, + * { + * "num_nodes": 15, + * "sizes": [ + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb" + * ] + * } + * ], + * "default_version": "3.8" + * }, + * "mongodb": { + * "regions": [ + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc2", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "6.0", + * "7.0" + * ], + * "layouts": [ + * { + * "num_nodes": 1, + * "sizes": [ + * "db-s-1vcpu-1gb", + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb" + * ] + * }, + * { + * "num_nodes": 3, + * "sizes": [ + * "db-s-1vcpu-1gb", + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb" + * ] + * } + * ], + * "default_version": "7.0" + * }, + * "mysql": { + * "regions": [ + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc2", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "8" + * ], + * "layouts": [ + * { + * "num_nodes": 1, + * "sizes": [ + * "db-s-1vcpu-1gb", + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb", + * "db-intel-1vcpu-1gb", + * "db-amd-1vcpu-1gb", + * "db-intel-1vcpu-2gb", + * "db-amd-1vcpu-2gb", + * "db-amd-2vcpu-4gb", + * "db-intel-2vcpu-4gb", + * "db-amd-2vcpu-8gb", + * "db-intel-2vcpu-8gb", + * "db-intel-4vcpu-8gb", + * "db-amd-4vcpu-8gb", + * "db-amd-4vcpu-16gb", + * "db-intel-4vcpu-16gb", + * "db-intel-8vcpu-32gb", + * "db-amd-8vcpu-32gb", + * "db-intel-16vcpu-64gb", + * "db-amd-16vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 2, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb", + * "db-intel-1vcpu-2gb", + * "db-amd-1vcpu-2gb", + * "db-amd-2vcpu-4gb", + * "db-intel-2vcpu-4gb", + * "db-intel-2vcpu-8gb", + * "db-amd-2vcpu-8gb", + * "db-intel-4vcpu-8gb", + * "db-amd-4vcpu-8gb", + * "db-intel-4vcpu-16gb", + * "db-amd-4vcpu-16gb", + * "db-amd-8vcpu-32gb", + * "db-intel-8vcpu-32gb", + * "db-amd-16vcpu-64gb", + * "db-intel-16vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 3, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb", + * "db-intel-1vcpu-2gb", + * "db-amd-1vcpu-2gb", + * "db-amd-2vcpu-4gb", + * "db-intel-2vcpu-4gb", + * "db-intel-2vcpu-8gb", + * "db-amd-2vcpu-8gb", + * "db-intel-4vcpu-8gb", + * "db-amd-4vcpu-8gb", + * "db-intel-4vcpu-16gb", + * "db-amd-4vcpu-16gb", + * "db-amd-8vcpu-32gb", + * "db-intel-8vcpu-32gb", + * "db-amd-16vcpu-64gb", + * "db-intel-16vcpu-64gb" + * ] + * } + * ], + * "default_version": "8" + * }, + * "opensearch": { + * "regions": [ + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc2", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "1", + * "2" + * ], + * "layouts": [ + * { + * "num_nodes": 1, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "gd-2vcpu-8gb", + * "m3-2vcpu-16gb", + * "db-s-4vcpu-8gb", + * "gd-4vcpu-16gb", + * "m3-4vcpu-32gb", + * "m3-8vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 3, + * "sizes": [ + * "db-s-2vcpu-4gb", + * "gd-2vcpu-8gb", + * "m3-2vcpu-16gb", + * "db-s-4vcpu-8gb", + * "gd-4vcpu-16gb", + * "m3-4vcpu-32gb", + * "m3-8vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 6, + * "sizes": [ + * "gd-2vcpu-8gb", + * "m3-2vcpu-16gb", + * "gd-4vcpu-16gb", + * "m3-4vcpu-32gb", + * "m3-8vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 9, + * "sizes": [ + * "gd-2vcpu-8gb", + * "m3-2vcpu-16gb", + * "gd-4vcpu-16gb", + * "m3-4vcpu-32gb", + * "m3-8vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 15, + * "sizes": [ + * "gd-2vcpu-8gb", + * "m3-2vcpu-16gb", + * "gd-4vcpu-16gb", + * "m3-4vcpu-32gb", + * "m3-8vcpu-64gb" + * ] + * } + * ], + * "default_version": "2" + * }, + * "pg": { + * "regions": [ + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc2", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "13", + * "14", + * "15", + * "16", + * "17" + * ], + * "layouts": [ + * { + * "num_nodes": 1, + * "sizes": [ + * "db-s-1vcpu-1gb", + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb", + * "db-intel-1vcpu-1gb", + * "db-amd-1vcpu-1gb", + * "db-intel-1vcpu-2gb", + * "db-amd-1vcpu-2gb", + * "db-amd-2vcpu-4gb", + * "db-intel-2vcpu-4gb", + * "db-amd-2vcpu-8gb", + * "db-intel-2vcpu-8gb", + * "db-intel-4vcpu-8gb", + * "db-amd-4vcpu-8gb", + * "db-amd-4vcpu-16gb", + * "db-intel-4vcpu-16gb", + * "db-intel-8vcpu-32gb", + * "db-amd-8vcpu-32gb", + * "db-intel-16vcpu-64gb", + * "db-amd-16vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 2, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb", + * "db-intel-1vcpu-2gb", + * "db-amd-1vcpu-2gb", + * "db-amd-2vcpu-4gb", + * "db-intel-2vcpu-4gb", + * "db-intel-2vcpu-8gb", + * "db-amd-2vcpu-8gb", + * "db-intel-4vcpu-8gb", + * "db-amd-4vcpu-8gb", + * "db-intel-4vcpu-16gb", + * "db-amd-4vcpu-16gb", + * "db-amd-8vcpu-32gb", + * "db-intel-8vcpu-32gb", + * "db-amd-16vcpu-64gb", + * "db-intel-16vcpu-64gb" + * ] + * }, + * { + * "num_nodes": 3, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "gd-2vcpu-8gb", + * "gd-4vcpu-16gb", + * "gd-8vcpu-32gb", + * "gd-16vcpu-64gb", + * "gd-32vcpu-128gb", + * "gd-40vcpu-160gb", + * "so1_5-2vcpu-16gb", + * "so1_5-4vcpu-32gb", + * "so1_5-8vcpu-64gb", + * "so1_5-16vcpu-128gb", + * "so1_5-24vcpu-192gb", + * "so1_5-32vcpu-256gb", + * "db-intel-1vcpu-2gb", + * "db-amd-1vcpu-2gb", + * "db-amd-2vcpu-4gb", + * "db-intel-2vcpu-4gb", + * "db-intel-2vcpu-8gb", + * "db-amd-2vcpu-8gb", + * "db-intel-4vcpu-8gb", + * "db-amd-4vcpu-8gb", + * "db-intel-4vcpu-16gb", + * "db-amd-4vcpu-16gb", + * "db-amd-8vcpu-32gb", + * "db-intel-8vcpu-32gb", + * "db-amd-16vcpu-64gb", + * "db-intel-16vcpu-64gb" + * ] + * } + * ], + * "default_version": "17" + * }, + * "redis": { + * "regions": [ + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc2", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "7" + * ], + * "layouts": [ + * { + * "num_nodes": 1, + * "sizes": [ + * "db-s-1vcpu-1gb", + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "m-2vcpu-16gb", + * "m-4vcpu-32gb", + * "m-8vcpu-64gb", + * "m-16vcpu-128gb", + * "m-24vcpu-192gb", + * "m-32vcpu-256gb" + * ] + * }, + * { + * "num_nodes": 2, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "m-2vcpu-16gb", + * "m-4vcpu-32gb", + * "m-8vcpu-64gb", + * "m-16vcpu-128gb", + * "m-24vcpu-192gb", + * "m-32vcpu-256gb" + * ] + * }, + * { + * "num_nodes": 3, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "m-2vcpu-16gb", + * "m-4vcpu-32gb", + * "m-8vcpu-64gb", + * "m-16vcpu-128gb", + * "m-24vcpu-192gb", + * "m-32vcpu-256gb" + * ] + * } + * ] + * }, + * "valkey": { + * "regions": [ + * "ams3", + * "blr1", + * "fra1", + * "lon1", + * "nyc1", + * "nyc3", + * "sfo2", + * "sfo3", + * "sgp1", + * "syd1", + * "tor1" + * ], + * "versions": [ + * "8" + * ], + * "layouts": [ + * { + * "num_nodes": 1, + * "sizes": [ + * "db-s-1vcpu-1gb", + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "m-2vcpu-16gb", + * "m-4vcpu-32gb", + * "m-8vcpu-64gb", + * "m-16vcpu-128gb", + * "m-24vcpu-192gb", + * "m-32vcpu-256gb" + * ] + * }, + * { + * "num_nodes": 2, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "m-2vcpu-16gb", + * "m-4vcpu-32gb", + * "m-8vcpu-64gb", + * "m-16vcpu-128gb", + * "m-24vcpu-192gb", + * "m-32vcpu-256gb" + * ] + * }, + * { + * "num_nodes": 3, + * "sizes": [ + * "db-s-1vcpu-2gb", + * "db-s-2vcpu-4gb", + * "db-s-4vcpu-8gb", + * "db-s-6vcpu-16gb", + * "db-s-8vcpu-32gb", + * "db-s-16vcpu-64gb", + * "m-2vcpu-16gb", + * "m-4vcpu-32gb", + * "m-8vcpu-64gb", + * "m-16vcpu-128gb", + * "m-24vcpu-192gb", + * "m-32vcpu-256gb" + * ] + * } + * ], + * "default_version": "8" + * } + * }, + * "version_availability": { + * "kafka": [ + * { + * "end_of_life": null, + * "end_of_availability": "2025-06-03T00:00:00Z", + * "version": "3.8", + * "default": true + * } + * ], + * "mongodb": [ + * { + * "end_of_life": "2025-07-01T07:00:00Z", + * "end_of_availability": null, + * "version": "6.0", + * "default": false + * }, + * { + * "end_of_life": "2026-08-01T07:00:00Z", + * "end_of_availability": null, + * "version": "7.0", + * "default": true + * } + * ], + * "mysql": [ + * { + * "end_of_life": null, + * "end_of_availability": null, + * "version": "8", + * "default": true + * } + * ], + * "opensearch": [ + * { + * "end_of_life": null, + * "end_of_availability": null, + * "version": "1", + * "default": false + * }, + * { + * "end_of_life": null, + * "end_of_availability": null, + * "version": "2", + * "default": true + * } + * ], + * "pg": [ + * { + * "end_of_life": "2025-11-13T00:00:00Z", + * "end_of_availability": "2025-05-13T00:00:00Z", + * "version": "13", + * "default": false + * }, + * { + * "end_of_life": "2026-11-12T00:00:00Z", + * "end_of_availability": "2026-05-12T00:00:00Z", + * "version": "14", + * "default": false + * }, + * { + * "end_of_life": "2027-11-11T00:00:00Z", + * "end_of_availability": "2027-05-12T00:00:00Z", + * "version": "15", + * "default": false + * }, + * { + * "end_of_life": "2028-11-09T00:00:00Z", + * "end_of_availability": "2028-05-09T00:00:00Z", + * "version": "16", + * "default": false + * }, + * { + * "end_of_life": "2029-11-08T00:00:00Z", + * "end_of_availability": "2029-05-08T00:00:00Z", + * "version": "17", + * "default": true + * } + * ], + * "redis": [ + * { + * "end_of_life": "2025-06-30T00:00:00Z", + * "end_of_availability": "2025-04-30T00:00:00Z", + * "version": "7", + * "default": true + * } + * ], + * "valkey": [ + * { + * "end_of_life": null, + * "end_of_availability": null, + * "version": "8", + * "default": true + * } + * ] + * } + * } + */ + "application/json": components["schemas"]["options"]; + }; + }; + /** @description A JSON object with a key of `databases`. */ + database_clusters: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "databases": [ + * { + * "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", + * "name": "backend", + * "engine": "pg", + * "version": "10", + * "connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "private_connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "private-backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "users": [ + * { + * "name": "doadmin", + * "role": "primary", + * "password": "wv78n3zpz42xezdk" + * } + * ], + * "db_names": [ + * "defaultdb" + * ], + * "num_nodes": 1, + * "region": "nyc3", + * "status": "online", + * "created_at": "2019-01-11T18:37:36Z", + * "maintenance_window": { + * "day": "saturday", + * "hour": "08:45:12", + * "pending": true, + * "description": [ + * "Update TimescaleDB to version 1.2.1", + * "Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases" + * ] + * }, + * "size": "db-s-2vcpu-4gb", + * "tags": [ + * "production" + * ], + * "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", + * "version_end_of_life": "2023-11-09T00:00:00Z", + * "version_end_of_availability": "2023-05-09T00:00:00Z", + * "storage_size_mib": 61440 + * } + * ] + * } + */ + "application/json": { + databases?: components["schemas"]["database_cluster_read"][]; + }; + }; + }; + /** @description A JSON object with a key of `database`. */ + database_cluster: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "database": { + * "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", + * "name": "backend", + * "engine": "pg", + * "version": "14", + * "semantic_version": "14.5", + * "connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "private_connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "private-backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "standby_connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "replica-backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "standby_private_connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "private-replica-backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "users": [ + * { + * "name": "doadmin", + * "role": "primary", + * "password": "wv78n3zpz42xezdk" + * } + * ], + * "db_names": [ + * "defaultdb" + * ], + * "num_nodes": 2, + * "region": "nyc3", + * "status": "creating", + * "created_at": "2019-01-11T18:37:36Z", + * "maintenance_window": { + * "day": "saturday", + * "hour": "08:45:12", + * "pending": true, + * "description": [ + * "Update TimescaleDB to version 1.2.1", + * "Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases" + * ] + * }, + * "size": "db-s-2vcpu-4gb", + * "tags": [ + * "production" + * ], + * "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", + * "version_end_of_life": "2023-11-09T00:00:00Z", + * "version_end_of_availability": "2023-05-09T00:00:00Z", + * "storage_size_mib": 61440, + * "do_settings": { + * "service_cnames": [ + * "db.example.com", + * "database.myapp.io" + * ] + * } + * } + * } + */ + "application/json": { + database: components["schemas"]["database_cluster_read"]; + }; + }; + }; + /** @description A JSON object with a key of `config`. */ + database_config: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "config": { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES", + * "sql_require_primary_key": true + * } + * } + */ + "application/json": { + config: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["valkey_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"] | components["schemas"]["mongo_advanced_config"]; + }; + }; + }; + /** @description A JSON object with a key of `ca`. */ + ca: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "ca": { + * "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVRVENDQXFtZ0F3SUJBZ0lVRUZZWTdBWFZQS0Raam9jb1lpMk00Y0dvcU0wd0RRWUpLb1pJaHZjTkFRRU0KQlFBd09qRTRNRFlHQTFVRUF3d3ZOek0zT1RaaE1XRXRaamhrTUMwME9HSmpMV0V4Wm1NdFpqbGhNVFZsWXprdwpORGhsSUZCeWIycGxZM1FnUTBFd0hoY05NakF3TnpFM01UVTFNREEyV2hjTk16QXdOekUxTVRVMU1EQTJXakE2Ck1UZ3dOZ1lEVlFRRERDODNNemM1Tm1FeFlTMW1PR1F3TFRRNFltTXRZVEZtWXkxbU9XRXhOV1ZqT1RBME9HVWcKVUhKdmFtVmpkQ0JEUVRDQ0FhSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnR1BBRENDQVlvQ2dnR0JBTVdScXhycwpMZnpNdHZyUmxKVEw4MldYMVBLZkhKbitvYjNYcmVBY3FZd1dBUUp2Q3IycmhxSXZieVZzMGlaU0NzOHI4c3RGClljQ0R1bkxJNmUwTy9laERZYTBIT2RrMkFFRzE1ckVOVmNha2NSczcyQWlHVHNrdkNXS2VkUjFTUWswVWt0WCsKQUg4S1ExS3F5bzNtZ2Y2cVV1WUpzc3JNTXFselk3YTN1RVpEb2ZqTjN5Q3MvM21pTVJKcVcyNm1JV0IrUUlEbAo5YzdLRVF5MTZvdCtjeHVnd0lLMm9oZHMzaFY1bjBKMFVBM0I3QWRBdXY5aUl5L3JHaHlTNm5CNTdaWm9JZnAyCnFybXdOY0UrVjlIdXhQSGtRVjFOQjUwOFFudWZ4Z0E5VCtqU2VrdGVUbWFORkxqNjFXL3BtcndrTytOaWFXUTIKaGgzVXBKOEozY1BoNkErbHRnUmpSV2NEb2lsYVNwRVVpU09WemNNYVFvalZKYVJlNk9NbnZYc29NaSs3ZzdneApWcittQ0lUcGcvck9DaXpBWWQ2UFAxLzdYTjk1ZXNmU2tBQnM5c3hJakpjTUFqbDBYTEFzRmtGZVdyeHNIajlVCmJnaDNWYXdtcnpUeXhZT0RQcXV1cS9JcGlwc0RRT3Fpb2ZsUStkWEJJL3NUT0NNbVp6K0pNcG5HYXdJREFRQUIKb3o4d1BUQWRCZ05WSFE0RUZnUVVSekdDRlE3WEtUdHRDN3JzNS8ydFlQcExTZGN3RHdZRFZSMFRCQWd3QmdFQgovd0lCQURBTEJnTlZIUThFQkFNQ0FRWXdEUVlKS29aSWh2Y05BUUVNQlFBRGdnR0JBSWFKQ0dSVVNxUExtcmcvCmk3MW10b0NHUDdzeG1BVXVCek1oOEdrU25uaVdaZnZGMTRwSUtqTlkwbzVkWmpHKzZqK1VjalZtK0RIdGE1RjYKOWJPeEk5S0NFeEI1blBjRXpMWjNZYitNOTcrellxbm9zUm85S21DVFJBb2JrNTZ0WU1FS1h1aVJja2tkMm1yUQo4cGw2N2xxdThjM1V4c0dHZEZVT01wMkk3ZTNpdUdWVm5UR0ZWM3JQZUdaQ0J3WGVyUUQyY0F4UjkzS3BnWVZ2ClhUUzk5dnpSbm1HOHhhUm9EVy9FbEdXZ2xWd0Q5a1JrbXhUUkdoYTdDWVZCcjFQVWY2dVVFVjhmVFIxc1hFZnIKLytMR1JoSVVsSUhWT3l2Yzk3YnZYQURPbWF1MWZDVE5lWGtRdTNyZnZFSlBmaFlLeVIwT0V3eWVvdlhRNzl0LwpTV2ZGTjBreU1Pc1UrNVNIdHJKSEh1eWNWcU0yQlVVK083VjM1UnNwOU9MZGRZMFFVbTZldFpEVEhhSUhYYzRRCnl1Rm1OL1NhSFZtNE0wL3BTVlJQdVd6TmpxMnZyRllvSDRtbGhIZk95TUNJMjc2elE2aWhGNkdDSHlkOUJqajcKUm1UWGEyNHM3NWhmSi9YTDV2bnJSdEtpVHJlVHF6V21EOVhnUmNMQ0gyS1hJaVRtSWc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" + * } + * } + */ + "application/json": { + ca: components["schemas"]["ca"]; + }; + }; + }; + /** @description A JSON object. */ + online_migration: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "77b28fc8-19ff-11eb-8c9c-c68e24557488", + * "status": "running", + * "created_at": "2020-10-29T15:57:38Z" + * } + */ + "application/json": components["schemas"]["online_migration"]; + }; + }; + /** @description This does not indicate the success or failure of any operation, just that the request has been accepted for processing. */ + accepted: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content?: never; + }; + /** @description A JSON object with a key of `rules`. */ + firewall_rules: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "rules": [ + * { + * "uuid": "79f26d28-ea8a-41f2-8ad8-8cfcdd020095", + * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", + * "type": "k8s", + * "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61", + * "created_at": "2019-11-14T20:30:28Z" + * }, + * { + * "uuid": "adfe81a8-0fa1-4e2d-973f-06aa5af19b44", + * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", + * "type": "ip_addr", + * "description": "a development IP address", + * "value": "192.168.1.1", + * "created_at": "2019-11-14T20:30:28Z" + * }, + * { + * "uuid": "b9b42276-8295-4313-b40f-74173a7f46e6", + * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", + * "type": "droplet", + * "value": "163973392", + * "created_at": "2019-11-14T20:30:28Z" + * }, + * { + * "uuid": "718d23e0-13d7-4129-8a00-47fb72ee0deb", + * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", + * "type": "tag", + * "value": "backend", + * "created_at": "2019-11-14T20:30:28Z" + * } + * ] + * } + */ + "application/json": { + rules?: components["schemas"]["firewall_rule"][]; + }; + }; + }; + /** @description A JSON object with a key of `database_backups`. */ + database_backups: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "backups": [ + * { + * "created_at": "2019-01-11T18:42:27Z", + * "size_gigabytes": 0.03357696, + * "incremental": false + * }, + * { + * "created_at": "2019-01-12T18:42:29Z", + * "size_gigabytes": 0.03364864, + * "incremental": true + * } + * ], + * "scheduled_backup_time": { + * "backup_hour": 20, + * "backup_minute": 40, + * "backup_interval_hours": 24 + * }, + * "backup_progress": "36" + * } + */ + "application/json": { + backups: components["schemas"]["backup"][]; + scheduled_backup_time?: { + /** + * @description The hour of the day when the backup is scheduled (in UTC). + * @example 20 + */ + backup_hour?: number; + /** + * @description The minute of the hour when the backup is scheduled. + * @example 40 + */ + backup_minute?: number; + /** + * @description The frequency, in hours, at which backups are taken. + * @example 24 + */ + backup_interval_hours?: number; + }; + /** + * @description If a backup is currently in progress, this attribute shows the percentage of completion. If no backup is in progress, this attribute will be hidden. + * @example 36 + */ + backup_progress?: string; + }; + }; + }; + /** @description A JSON object with a key of `replicas`. */ + database_replicas: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "replicas": [ + * { + * "name": "read-nyc3-01", + * "connection": { + * "uri": "", + * "database": "defaultdb", + * "host": "read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "private_connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "region": "nyc3", + * "status": "online", + * "created_at": "2019-01-11T18:37:36Z" + * } + * ] + * } + */ + "application/json": { + replicas?: components["schemas"]["database_replica_read"][]; + }; + }; + }; + /** @description A JSON object with a key of `replica`. */ + database_replica: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "replica": { + * "name": "read-nyc3-01", + * "connection": { + * "uri": "", + * "database": "defaultdb", + * "host": "read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "private_connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", + * "database": "", + * "host": "private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25060, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * }, + * "region": "nyc3", + * "status": "online", + * "created_at": "2019-01-11T18:37:36Z", + * "do_settings": { + * "service_cnames": [ + * "replica-db.example.com", + * "read-replica.myapp.io" + * ] + * } + * } + * } + */ + "application/json": { + replica?: components["schemas"]["database_replica_read"]; + }; + }; + }; + /** @description A JSON object with a key of `events`. */ + events_logs: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "events": [ + * { + * "id": "pe8u2huh", + * "cluster_name": "customer-events", + * "event_type": "cluster_create", + * "create_time": "2020-10-29T15:57:38Z" + * }, + * { + * "id": "pe8ufefuh", + * "cluster_name": "customer-events", + * "event_type": "cluster_update", + * "create_time": "2023-10-30T15:57:38Z" + * } + * ] + * } + */ + "application/json": { + events?: components["schemas"]["events_logs"][]; + }; + }; + }; + /** @description A JSON object with a key of `users`. */ + users: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "users": [ + * { + * "name": "app-01", + * "role": "normal", + * "password": "jge5lfxtzhx42iff" + * }, + * { + * "name": "doadmin", + * "role": "primary", + * "password": "wv78n3zpz42xezd" + * } + * ] + * } + */ + "application/json": { + users?: components["schemas"]["database_user"][]; + }; + }; + }; + /** @description A JSON object with a key of `user`. */ + user: { + 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": { + user: components["schemas"]["database_user"]; + }; + }; + }; + /** @description A JSON object with a key of `databases`. */ + databases: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "dbs": [ + * { + * "name": "alpha" + * }, + * { + * "name": "defaultdb" + * } + * ] + * } + */ + "application/json": { + dbs?: components["schemas"]["database"][]; + }; + }; + }; + /** @description A JSON object with a key of `db`. */ + database: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "db": { + * "name": "alpha" + * } + * } + */ + "application/json": { + db: components["schemas"]["database"]; + }; + }; + }; + /** @description A JSON object with a key of `pools`. */ + connection_pools: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "pools": [ + * { + * "user": "doadmin", + * "name": "reporting-pool", + * "size": 10, + * "db": "defaultdb", + * "mode": "session", + * "connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/foo?sslmode=require", + * "database": "foo", + * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25061, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * } + * }, + * { + * "user": "doadmin", + * "name": "backend-pool", + * "size": 10, + * "db": "defaultdb", + * "mode": "transaction", + * "connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/backend-pool?sslmode=require", + * "database": "backend-pool", + * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25061, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * } + * } + * ] + * } + */ + "application/json": components["schemas"]["connection_pools"]; + }; + }; + /** @description A JSON object with a key of `pool`. */ + connection_pool: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "pool": { + * "user": "doadmin", + * "name": "backend-pool", + * "size": 10, + * "db": "defaultdb", + * "mode": "transaction", + * "connection": { + * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/backend-pool?sslmode=require", + * "database": "backend-pool", + * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", + * "port": 25061, + * "user": "doadmin", + * "password": "wv78n3zpz42xezdk", + * "ssl": true + * } + * } + * } + */ + "application/json": { + pool: components["schemas"]["connection_pool"]; + }; + }; + }; + /** @description A JSON string with a key of `eviction_policy`. */ + eviction_policy_response: { + 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": { + eviction_policy: components["schemas"]["eviction_policy_model"]; + }; + }; + }; + /** @description A JSON string with a key of `sql_mode`. */ + sql_mode: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES" + * } + */ + "application/json": components["schemas"]["sql_mode"]; + }; + }; + /** @description A JSON object with autoscale configuration details. */ + autoscale: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "autoscale": { + * "storage": { + * "enabled": true, + * "threshold_percent": 80, + * "increment_gib": 10 + * } + * } + * } + */ + "application/json": { + autoscale?: components["schemas"]["database_autoscale_params"]; + }; + }; + }; + /** @description Unprocessable Entity */ + unprocessable_entity: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "unprocessable_entity", + * "message": "request payload validation failed", + * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description A JSON object with a key of `topics`. */ + kafka_topics: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "topics": [ + * { + * "name": "customer-events", + * "state": "active", + * "replication_factor": 2, + * "partition_count": 3 + * }, + * { + * "name": "engineering-events", + * "state": "configuring", + * "replication_factor": 2, + * "partition_count": 10 + * } + * ] + * } + */ + "application/json": { + topics?: components["schemas"]["kafka_topic"][]; + }; + }; + }; + /** @description A JSON object with a key of `topic`. */ + kafka_topic: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "topic": { + * "name": "customer-events", + * "partitions": [ + * { + * "size": 4096, + * "id": 0, + * "in_sync_replicas": 3, + * "earliest_offset": 0, + * "consumer_groups": [ + * { + * "name": "consumer-group-1", + * "offset": 0 + * }, + * { + * "name": "consumer-group-2", + * "offset": 1 + * } + * ] + * }, + * { + * "size": 4096, + * "id": 1, + * "in_sync_replicas": 3, + * "earliest_offset": 0, + * "consumer_groups": null + * } + * ], + * "replication_factor": 3, + * "state": "active", + * "config": { + * "cleanup_policy": "delete", + * "compression_type": "producer", + * "delete_retention_ms": 86400000, + * "file_delete_delay_ms": 60000, + * "flush_messages": 9223372036854776000, + * "flush_ms": 9223372036854776000, + * "index_interval_bytes": 4096, + * "max_compaction_lag_ms": 9223372036854776000, + * "max_message_bytes": 1048588, + * "message_down_conversion_enable": true, + * "message_format_version": "3.0-IV1", + * "message_timestamp_difference_max_ms": 9223372036854776000, + * "message_timestamp_type": "create_time", + * "min_cleanable_dirty_ratio": 0.5, + * "min_compaction_lag_ms": 0, + * "min_insync_replicas": 1, + * "preallocate": false, + * "retention_bytes": -1, + * "retention_ms": 604800000, + * "segment_bytes": 209715200, + * "segment_index_bytes": 10485760, + * "segment_jitter_ms": 0, + * "segment_ms": 604800000 + * } + * } + * } + */ + "application/json": { + topic?: components["schemas"]["kafka_topic_verbose"]; + }; + }; + }; + /** @description A JSON object with a key of `sinks`. */ + logsinks: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "sinks": [ + * { + * "sink_id": "799990b6-d551-454b-9ffe-b8618e9d6272", + * "sink_name": "logs-sink-1", + * "sink_type": "rsyslog", + * "config": { + * "server": "192.168.0.1", + * "port": 514, + * "tls": false, + * "format": "rfc5424" + * } + * }, + * { + * "sink_id": "d6e95157-5f58-48d0-9023-8cfb409d102a", + * "sink_name": "logs-sink-2", + * "sink_type": "rsyslog", + * "config": { + * "server": "192.168.10.1", + * "port": 514, + * "tls": false, + * "format": "rfc3164" + * } + * } + * ] + * } + */ + "application/json": { + sinks?: components["schemas"]["logsink_schema"][]; + }; + }; + }; + /** @description A JSON object with a key of `sink`. */ + logsink: { + 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"]["logsink_schema"]; + }; + }; + }; + /** @description A JSON object with logsink properties. */ + logsink_data: { + 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": components["schemas"]["logsink_schema"]; + }; + }; + /** @description A JSON object with a key of `subjects`. */ + kafka_schemas: { + 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": { + subjects?: components["schemas"]["kafka_schema_verbose"][]; + }; + }; + }; + /** @description A JSON object. */ + kafka_schema: { + 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": WithRequired; + }; + }; + /** @description A JSON object. */ + kafka_schema_version: { + 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": WithRequired; + }; + }; + /** @description A JSON object with a key of `compatibility_level`. */ + database_schema_registry_config: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "compatibility_level": "BACKWARD" + * } + */ + "application/json": { + /** + * @description The compatibility level of the schema registry. + * @enum {string} + */ + compatibility_level: "NONE" | "BACKWARD" | "BACKWARD_TRANSITIVE" | "FORWARD" | "FORWARD_TRANSITIVE" | "FULL" | "FULL_TRANSITIVE"; + }; + }; + }; + /** @description A JSON object with a key of `compatibility_level`. */ + database_schema_registry_subject_config: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "subject_name": "my-schema-subject", + * "compatibility_level": "BACKWARD" + * } + */ + "application/json": { + /** @description The name of the schema subject. */ + subject_name: string; + /** + * @description The compatibility level of the schema registry. + * @enum {string} + */ + compatibility_level: "NONE" | "BACKWARD" | "BACKWARD_TRANSITIVE" | "FORWARD" | "FORWARD_TRANSITIVE" | "FULL" | "FULL_TRANSITIVE"; + }; + }; + }; + /** @description A JSON object with a key of `credentials`. */ + database_metrics_auth: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "credentials": { + * "basic_auth_username": "username", + * "basic_auth_password": "password" + * } + * } + */ + "application/json": { + credentials?: components["schemas"]["database_metrics_credentials"]; + }; + }; + }; + /** @description A JSON object with a key of `indexes`. */ + opensearch_indexes: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "indexes": [ + * { + * "index_name": "sample-data", + * "number_of_shards": 2, + * "number_of_replicas": 3, + * "size": 208, + * "created_time": "2021-01-01T00:00:00Z", + * "status": "open", + * "health": "green" + * }, + * { + * "index_name": "logs-*", + * "number_of_shards": 2, + * "number_of_replicas": 3, + * "size": 208, + * "created_time": "2021-01-01T00:00:00Z", + * "status": "open", + * "health": "green" + * } + * ] + * } + */ + "application/json": { + indexes?: components["schemas"]["opensearch_index"][]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `domains`. The value of this will be an array of Domain objects, each of which contain the standard domain attributes. */ + all_domains_response: { + 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 Array of volumes. */ + domains: components["schemas"]["domain"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes associated with a domain. */ + create_domain_response: { + 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": { + domain?: components["schemas"]["domain"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes defined for a domain. */ + existing_domain: { + 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": { + domain?: components["schemas"]["domain"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `domain_records`. The value of this will be an array of domain record objects, each of which contains the standard domain record attributes. For attributes that are not used by a specific record type, a value of `null` will be returned. For instance, all records other than SRV will have `null` for the `weight` and `port` attributes. */ + all_domain_records_response: { + 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": { + domain_records?: components["schemas"]["domain_record"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response body will be a JSON object with a key called `domain_record`. The value of this will be an object representing the new record. Attributes that are not applicable for the record type will be set to `null`. An `id` attribute is generated for each record as part of the object. */ + created_domain_record: { + 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": { + domain_record?: components["schemas"]["domain_record"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `domain_record`. The value of this will be a domain record object which contains the standard domain record attributes. */ + domain_record: { + 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": { + domain_record?: components["schemas"]["domain_record"]; + }; + }; + }; + /** @description A JSON object with a key of `droplets`. */ + all_droplets: { + 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": { + droplets?: components["schemas"]["droplet"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description Accepted */ + droplet_create: { + 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": { + droplet: components["schemas"]["droplet"]; + links: { + actions?: components["schemas"]["action_link"][]; + }; + } | { + droplets: components["schemas"]["droplet"][]; + links: { + actions?: components["schemas"]["action_link"][]; + }; + }; + }; + }; + /** @description The action was successful and the response body is empty. This response has content-type set. */ + no_content_with_content_type: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + "content-type": components["headers"]["content-type"]; + [name: string]: unknown; + }; + content?: never; + }; + /** + * @description The response will be a JSON object with a key called `droplet`. This will be + * set to a JSON object that contains the standard Droplet attributes. + */ + existing_droplet: { + 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": { + droplet?: components["schemas"]["droplet"]; + }; + }; + }; + /** @description A JSON object with an `backups` key. */ + all_droplet_backups: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "backups": [ + * { + * "id": 67539192, + * "name": "web-01- 2020-07-29", + * "distribution": "Ubuntu", + * "slug": null, + * "public": false, + * "regions": [ + * "nyc3" + * ], + * "created_at": "2020-07-29T01:44:35Z", + * "min_disk_size": 50, + * "size_gigabytes": 2.34, + * "type": "backup" + * } + * ], + * "links": {}, + * "meta": { + * "total": 1 + * } + * } + */ + "application/json": { + backups?: components["schemas"]["droplet_snapshot"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `policy`. This will be + * set to a JSON object that contains the standard Droplet backup policy attributes. + */ + droplet_backup_policy: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "policy": { + * "droplet_id": 444909706, + * "backup_enabled": true, + * "backup_policy": { + * "plan": "weekly", + * "weekday": "SUN", + * "hour": 20, + * "window_length_hours": 4, + * "retention_period_days": 28 + * }, + * "next_backup_window": { + * "start": "2024-09-15T20:00:00Z", + * "end": "2024-09-16T00:00:00Z" + * } + * } + * } + */ + "application/json": { + policy?: components["schemas"]["droplet_backup_policy_record"]; + }; + }; + }; + /** @description A JSON object with a `policies` key set to a map. The keys are Droplet IDs and the values are objects containing the backup policy information for each Droplet. */ + all_droplet_backup_policies: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "policies": { + * "436444618": { + * "droplet_id": 436444618, + * "backup_enabled": false + * }, + * "444909314": { + * "droplet_id": 444909314, + * "backup_enabled": true, + * "backup_policy": { + * "plan": "daily", + * "hour": 20, + * "window_length_hours": 4, + * "retention_period_days": 7 + * }, + * "next_backup_window": { + * "start": "2024-09-13T20:00:00Z", + * "end": "2024-09-14T00:00:00Z" + * } + * }, + * "444909706": { + * "droplet_id": 444909706, + * "backup_enabled": true, + * "backup_policy": { + * "plan": "weekly", + * "weekday": "SUN", + * "hour": 20, + * "window_length_hours": 4, + * "retention_period_days": 28 + * }, + * "next_backup_window": { + * "start": "2024-09-15T20:00:00Z", + * "end": "2024-09-16T00:00:00Z" + * } + * } + * }, + * "links": {}, + * "meta": { + * "total": 3 + * } + * } + */ + "application/json": { + /** + * @description A map where the keys are the Droplet IDs and the values are + * objects containing the backup policy information for each Droplet. + */ + policies?: { + [key: string]: components["schemas"]["droplet_backup_policy_record"]; + }; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with an `supported_policies` key set to an array of objects describing each supported backup policy. */ + droplets_supported_backup_policies: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "supported_policies": [ + * { + * "name": "weekly", + * "possible_window_starts": [ + * 0, + * 4, + * 8, + * 12, + * 16, + * 20 + * ], + * "window_length_hours": 4, + * "retention_period_days": 28, + * "possible_days": [ + * "SUN", + * "MON", + * "TUE", + * "WED", + * "THU", + * "FRI", + * "SAT" + * ] + * }, + * { + * "name": "daily", + * "possible_window_starts": [ + * 0, + * 4, + * 8, + * 12, + * 16, + * 20 + * ], + * "window_length_hours": 4, + * "retention_period_days": 7, + * "possible_days": [] + * } + * ] + * } + */ + "application/json": { + supported_policies?: components["schemas"]["supported_droplet_backup_policy"][]; + }; + }; + }; + /** @description A JSON object with an `snapshots` key. */ + all_droplet_snapshots: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "snapshots": [ + * { + * "id": 6372321, + * "name": "web-01-1595954862243", + * "created_at": "2020-07-28T16:47:44Z", + * "regions": [ * "nyc3", - * "sfo2", - * "sfo3", - * "sgp1", - * "syd1", - * "tor1" + * "sfo3" + * ], + * "min_disk_size": 25, + * "size_gigabytes": 2.34, + * "type": "snapshot" + * } + * ], + * "links": {}, + * "meta": { + * "total": 1 + * } + * } + */ + "application/json": { + snapshots?: components["schemas"]["droplet_snapshot"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with an `actions` key. */ + all_droplet_actions: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "actions": [ + * { + * "id": 982864273, + * "status": "completed", + * "type": "create", + * "started_at": "2020-07-20T19:37:30Z", + * "completed_at": "2020-07-20T19:37:45Z", + * "resource_id": 3164444, + * "resource_type": "droplet", + * "region": { + * "name": "New York 3", + * "slug": "nyc3", + * "features": [ + * "private_networking", + * "backups", + * "ipv6", + * "metadata", + * "install_agent", + * "image_transfer" + * ], + * "available": true, + * "sizes": [ + * "s-1vcpu-1gb", + * "s-1vcpu-2gb", + * "s-3vcpu-1gb", + * "s-2vcpu-2gb", + * "s-1vcpu-3gb", + * "s-2vcpu-4gb", + * "s-4vcpu-8gb", + * "m-1vcpu-8gb", + * "s-6vcpu-16gb", + * "s-8vcpu-32gb", + * "s-12vcpu-48gb" + * ] + * }, + * "region_slug": "nyc3" + * } + * ], + * "links": {}, + * "meta": { + * "total": 1 + * } + * } + */ + "application/json": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `action`. */ + droplet_action: { + 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": { + action?: components["schemas"]["action"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `actions`. */ + droplet_actions_response: { + 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": { + actions?: components["schemas"]["action"][]; + }; + }; + }; + /** @description A JSON object that has a key called `kernels`. */ + all_kernels: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "kernels": [ + * { + * "id": 7515, + * "name": "DigitalOcean GrubLoader v0.2 (20160714)", + * "version": "2016.07.13-DigitalOcean_loader_Ubuntu" + * } + * ], + * "links": { + * "pages": { + * "next": "https://api.digitalocean.com/v2/droplets/3164444/kernels?page=2&per_page=1", + * "last": "https://api.digitalocean.com/v2/droplets/3164444/kernels?page=171&per_page=1" + * } + * }, + * "meta": { + * "total": 171 + * } + * } + */ + "application/json": { + kernels?: components["schemas"]["kernel"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object that has a key called `firewalls`. */ + all_firewalls: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "firewalls": [ + * { + * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", + * "status": "succeeded", + * "created_at": "2020-05-23T21:24:00Z", + * "pending_changes": [ + * { + * "droplet_id": 8043964, + * "removing": true, + * "status": "waiting" + * } + * ], + * "name": "firewall", + * "droplet_ids": [ + * 89989, + * 33322 + * ], + * "tags": [ + * "base-image", + * "prod" + * ], + * "inbound_rules": [ + * { + * "protocol": "udp", + * "ports": "8000-9000", + * "sources": { + * "addresses": [ + * "1.2.3.4", + * "18.0.0.0/8" + * ], + * "droplet_ids": [ + * 8282823, + * 3930392 + * ], + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ], + * "tags": [ + * "base-image", + * "dev" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "7000-9000", + * "destinations": { + * "addresses": [ + * "1.2.3.4", + * "18.0.0.0/8" + * ], + * "droplet_ids": [ + * 3827493, + * 213213 + * ], + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ], + * "tags": [ + * "base-image", + * "prod" + * ] + * } + * } + * ] + * } + * ], + * "links": { + * "pages": {} + * }, + * "meta": { + * "total": 1 + * } + * } + */ + "application/json": { + firewalls?: components["schemas"]["firewall"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with an `droplets` key. */ + neighbor_droplets: { + 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": { + droplets?: components["schemas"]["droplet"][]; + }; + }; + }; + /** @description A JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. */ + associated_resources_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "reserved_ips": [ + * { + * "id": "6186916", + * "name": "45.55.96.47", + * "cost": "4.00" + * } + * ], + * "floating_ips": [ + * { + * "id": "6186916", + * "name": "45.55.96.47", + * "cost": "4.00" + * } + * ], + * "snapshots": [ + * { + * "id": "61486916", + * "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", + * "cost": "0.05" + * } + * ], + * "volumes": [ + * { + * "id": "ba49449a-7435-11ea-b89e-0a58ac14480f", + * "name": "volume-nyc1-01", + * "cost": "10.00" + * } + * ], + * "volume_snapshots": [ + * { + * "id": "edb0478d-7436-11ea-86e6-0a58ac144b91", + * "name": "volume-nyc1-01-1585758983629", + * "cost": "0.04" + * } + * ] + * } + */ + "application/json": { + /** @description Reserved IPs that are associated with this Droplet.
Requires `reserved_ip:read` scope. */ + reserved_ips?: components["schemas"]["associated_resource"][]; + /** @description Floating IPs that are associated with this Droplet.
Requires `reserved_ip:read` scope. */ + floating_ips?: components["schemas"]["associated_resource"][]; + /** @description Snapshots that are associated with this Droplet.
Requires `image:read` scope. */ + snapshots?: components["schemas"]["associated_resource"][]; + /** @description Volumes that are associated with this Droplet.
Requires `block_storage:read` scope. */ + volumes?: components["schemas"]["associated_resource"][]; + /** @description Volume Snapshots that are associated with this Droplet.
Requires `block_storage_snapshot:read` scope. */ + volume_snapshots?: components["schemas"]["associated_resource"][]; + }; + }; + }; + /** @description A JSON object containing containing the status of a request to destroy a Droplet and its associated resources. */ + associated_resources_status: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "droplet": { + * "id": "187000742", + * "name": "ubuntu-s-1vcpu-1gb-nyc1-01", + * "destroyed_at": "2020-04-01T18:11:49Z" + * }, + * "resources": { + * "reserved_ips": [ + * { + * "id": "6186916", + * "name": "45.55.96.47", + * "destroyed_at": "2020-04-01T18:11:44Z" + * } + * ], + * "floating_ips": [ + * { + * "id": "6186916", + * "name": "45.55.96.47", + * "destroyed_at": "2020-04-01T18:11:44Z" + * } + * ], + * "snapshots": [ + * { + * "id": "61486916", + * "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", + * "destroyed_at": "2020-04-01T18:11:44Z" + * } + * ], + * "volumes": [], + * "volume_snapshots": [ + * { + * "id": "edb0478d-7436-11ea-86e6-0a58ac144b91", + * "name": "volume-nyc1-01-1585758983629", + * "destroyed_at": "2020-04-01T18:11:44Z" + * } + * ] + * }, + * "completed_at": "2020-04-01T18:11:49Z", + * "failures": 0 + * } + */ + "application/json": components["schemas"]["associated_resource_status"]; + }; + }; + /** @description The request could not be completed due to a conflict. */ + conflict: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "conflict", + * "message": "The request could not be completed due to a conflict." + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description A JSON object with a key of `autoscale_pools`. */ + all_autoscale_pools: { + 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": { + autoscale_pools?: components["schemas"]["autoscale_pool"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description Accepted */ + autoscale_pool_create: { + 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": { + autoscale_pool?: components["schemas"]["autoscale_pool"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `autoscale_pool`. This will be + * set to a JSON object that contains the standard autoscale pool attributes. + */ + existing_autoscale_pool: { + 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": { + autoscale_pool?: components["schemas"]["autoscale_pool"]; + }; + }; + }; + /** @description A JSON object with a key of `droplets`. */ + all_members: { + 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": { + droplets?: components["schemas"]["member"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with a key of `history`. */ + history_events: { + 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": { + history?: components["schemas"]["history"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`.

Firewalls responses will include only the resources that you are granted to see. Ensure that your API token includes all necessary `:read` permissions for requested firewall. */ + list_firewalls_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "firewalls": [ + * { + * "id": "fb6045f1-cf1d-4ca3-bfac-18832663025b", + * "name": "firewall", + * "status": "succeeded", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "created_at": "2017-05-23T21:23:59Z", + * "droplet_ids": [ + * 8043964 + * ], + * "tags": [], + * "pending_changes": [] + * } + * ], + * "links": {}, + * "meta": { + * "total": 1 + * } + * } + */ + "application/json": { + firewalls?: components["schemas"]["firewall"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes. */ + create_firewall_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "firewall": { + * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", + * "name": "firewall", + * "status": "waiting", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "created_at": "2017-05-23T21:24:00Z", + * "droplet_ids": [ + * 8043964 + * ], + * "tags": [], + * "pending_changes": [ + * { + * "droplet_id": 8043964, + * "removing": false, + * "status": "waiting" + * } + * ] + * } + * } + */ + "application/json": { + firewall?: components["schemas"]["firewall"]; + }; + }; + }; + /** @description There was an error parsing the request body. */ + bad_request: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "bad_request", + * "message": "error parsing request body", + * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes.

Firewalls responses will include only the resources that you are granted to see. Ensure that your API token includes all necessary `:read` permissions for requested firewall. */ + get_firewall_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "firewall": { + * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", + * "name": "firewall", + * "status": "succeeded", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "created_at": "2017-05-23T21:24:00Z", + * "droplet_ids": [ + * 8043964 + * ], + * "tags": [], + * "pending_changes": [] + * } + * } + */ + "application/json": { + firewall?: components["schemas"]["firewall"]; + }; + }; + }; + /** @description The response will be a JSON object with a `firewall` key. This will be set to an object containing the standard firewall attributes. */ + put_firewall_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "firewall": { + * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", + * "name": "frontend-firewall", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "created_at": "2020-05-23T21:24:00Z", + * "droplet_ids": [ + * 8043964 + * ], + * "tags": [ + * "frontend" + * ], + * "status": "waiting", + * "pending_changes": [ + * { + * "droplet_id": 8043964, + * "removing": false, + * "status": "waiting" + * } + * ] + * } + * } + */ + "application/json": { + firewall?: components["schemas"]["firewall"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `floating_ips`. This will be set to an array of floating IP objects, each of which will contain the standard floating IP attributes */ + floating_ip_list: { + 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": { + floating_ips?: components["schemas"]["floating_ip"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. + * When assigning a floating IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. + */ + floating_ip_created: { + 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": { + floating_ip?: components["schemas"]["floating_ip"]; + links?: { + droplets?: components["schemas"]["action_link"][]; + actions?: components["schemas"]["action_link"][]; + }; + }; + }; + }; + /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. */ + floating_ip: { + 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": { + floating_ip?: components["schemas"]["floating_ip"]; + }; + }; + }; + /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard floating IP action attributes. */ + floating_ip_actions: { + 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": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard floating IP action attributes. */ + floating_ip_action: { + 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": { + action?: components["schemas"]["action"] & { + /** + * Format: uuid + * @description The UUID of the project to which the reserved IP currently belongs. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + }; + }; + }; + }; + /** + * @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains + * the properties associated with it. + */ + list_namespaces: { + 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": { + namespaces?: components["schemas"]["namespace_info"][]; + }; + }; + }; + /** + * @description A JSON response object with a key called `namespace`. The object contains the properties associated + * with the namespace. + */ + namespace_created: { + 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": { + namespace?: components["schemas"]["namespace_info"]; + }; + }; + }; + /** @description Bad Request. */ + namespace_bad_request: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "bad_request", + * "message": "Invalid request payload: missing label field", + * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description Limit Reached */ + namespace_limit_reached: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "unprocessable_entity", + * "message": "namespace limit reached", + * "request_id": "a3275238-3d04-4405-a123-55c389b406c0" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description Not Allowed. */ + namespace_not_allowed: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "forbidden", + * "message": "not allowed to get namespace", + * "request_id": "b11e45a4-892c-48c9-9001-b6cffe9fe795" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description Bad Request. */ + namespace_not_found: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "not_found", + * "message": "namespace not found", + * "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** + * @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains + * the properties associated with it. + */ + list_triggers: { + 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": { + triggers?: components["schemas"]["trigger_info"][]; + }; + }; + }; + /** + * @description A JSON response object with a key called `trigger`. The object contains the properties associated + * with the trigger. + */ + trigger_response: { + 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": { + trigger?: components["schemas"]["trigger_info"]; + }; + }; + }; + /** @description Bad Request. */ + trigger_bad_request: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "bad_request", + * "message": "validating create trigger: validation error: missing trigger name, missing function name, missing source details", + * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description Limit Reached */ + trigger_limit_reached: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "unprocessable_entity", + * "message": "triggers limit reached", + * "request_id": "7ba99a43-6618-4fe0-9af7-092752ad0d56" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description Bad Request. */ + trigger_not_found: { + 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": components["schemas"]["error"]; + }; + }; + /** @description The response will be a JSON object with a key called `images`. This will be set to an array of image objects, each of which will contain the standard image attributes. */ + all_images: { + 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": { + images: components["schemas"]["image"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing a subset of the standard image attributes as listed below, including the image's `id` and `status`. After initial creation, the `status` will be `NEW`. Using the image's id, you may query the image's status by sending a `GET` request to the `/v2/images/$IMAGE_ID` endpoint. When the `status` changes to `available`, the image will be ready for use. */ + new_custom_image: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "image": { + * "created_at": "2018-09-20T19:28:00Z", + * "description": "Cloud-optimized image w/ small footprint", + * "distribution": "Ubuntu", + * "error_message": "", + * "id": 38413969, + * "name": "ubuntu-18.04-minimal", + * "regions": [], + * "type": "custom", + * "tags": [ + * "base-image", + * "prod" + * ], + * "status": "NEW" + * } + * } + */ + "application/json": { + image?: components["schemas"]["image"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `image`. The value of this will be an image object containing the standard image attributes. */ + existing_image: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "image": { + * "id": 6918990, + * "name": "14.04 x64", + * "distribution": "Ubuntu", + * "slug": "ubuntu-16-04-x64", + * "public": true, + * "regions": [ + * "nyc1", + * "ams1", + * "sfo1", + * "nyc2", + * "ams2", + * "sgp1", + * "lon1", + * "nyc3", + * "ams3", + * "nyc3" + * ], + * "created_at": "2014-10-17T20:24:33Z", + * "min_disk_size": 20, + * "size_gigabytes": 2.34, + * "description": "", + * "tags": [], + * "status": "available", + * "error_message": "" + * } + * } + */ + "application/json": { + image: components["schemas"]["image"]; + }; + }; + }; + /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing the standard image attributes. */ + updated_image: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "image": { + * "id": 7938391, + * "name": "new-image-name", + * "distribution": "Ubuntu", + * "slug": null, + * "public": false, + * "regions": [ + * "nyc3", + * "nyc3" + * ], + * "created_at": "2014-11-14T16:44:03Z", + * "min_disk_size": 20, + * "size_gigabytes": 2.34, + * "description": "", + * "tags": [], + * "status": "available", + * "error_message": "" + * } + * } + */ + "application/json": { + image: components["schemas"]["image"]; + }; + }; + }; + /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard action attributes. */ + get_image_actions_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "actions": [ + * { + * "id": 29410565, + * "status": "completed", + * "type": "transfer", + * "started_at": "2014-07-25T15:04:21Z", + * "completed_at": "2014-07-25T15:10:20Z", + * "resource_id": 7555620, + * "resource_type": "image", + * "region": { + * "name": "New York 2", + * "slug": "nyc2", + * "sizes": [ + * "s-1vcpu-3gb", + * "m-1vcpu-8gb", + * "s-3vcpu-1gb", + * "s-1vcpu-2gb", + * "s-2vcpu-2gb", + * "s-2vcpu-4gb", + * "s-4vcpu-8gb", + * "s-6vcpu-16gb", + * "s-8vcpu-32gb", + * "s-12vcpu-48gb", + * "s-16vcpu-64gb", + * "s-20vcpu-96gb", + * "s-1vcpu-1gb", + * "c-1vcpu-2gb", + * "s-24vcpu-128gb" + * ], + * "features": [ + * "private_networking", + * "backups", + * "ipv6", + * "metadata", + * "server_id", + * "install_agent", + * "storage", + * "image_transfer" + * ], + * "available": true + * }, + * "region_slug": "nyc2" + * } + * ], + * "links": { + * "pages": { + * "last": "https://api.digitalocean.com/v2/images/7555620/actions?page=5&per_page=1", + * "next": "https://api.digitalocean.com/v2/images/7555620/actions?page=2&per_page=1" + * } + * }, + * "meta": { + * "total": 5 + * } + * } + */ + "application/json": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `action`. The value of this will be an object containing the standard image action attributes. */ + post_image_action_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "action": { + * "id": 36805527, + * "status": "in-progress", + * "type": "transfer", + * "started_at": "2014-11-14T16:42:45Z", + * "completed_at": null, + * "resource_id": 7938269, + * "resource_type": "image", + * "region": { + * "name": "New York 3", + * "slug": "nyc3", + * "sizes": [ + * "s-1vcpu-3gb", + * "m-1vcpu-8gb", + * "s-3vcpu-1gb", + * "s-1vcpu-2gb", + * "s-2vcpu-2gb", + * "s-2vcpu-4gb", + * "s-4vcpu-8gb", + * "s-6vcpu-16gb", + * "s-8vcpu-32gb", + * "s-12vcpu-48gb", + * "s-16vcpu-64gb", + * "s-20vcpu-96gb", + * "s-1vcpu-1gb", + * "c-1vcpu-2gb", + * "s-24vcpu-128gb" * ], - * "versions": [ - * "3.6", - * "3.7" + * "features": [ + * "private_networking", + * "backups", + * "ipv6", + * "metadata", + * "server_id", + * "install_agent", + * "storage", + * "image_transfer" * ], - * "layouts": [ - * { - * "num_nodes": 3, - * "sizes": [ - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "db-s-2vcpu-4gb", - * "db-s-2vcpu-2gb" - * ] - * }, - * { - * "num_nodes": 6, - * "sizes": [ - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb" - * ] - * }, - * { - * "num_nodes": 9, - * "sizes": [ - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb" - * ] - * }, - * { - * "num_nodes": 15, - * "sizes": [ - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb" - * ] - * } - * ] + * "available": true * }, - * "mongodb": { - * "regions": [ - * "ams3", - * "blr1", - * "fra1", - * "lon1", - * "nyc1", - * "nyc3", - * "sfo2", - * "sfo3", - * "sgp1", - * "syd1", - * "tor1" + * "region_slug": "nyc3" + * } + * } + */ + "application/json": components["schemas"]["action"]; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard image action attributes. */ + get_image_action_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "action": { + * "id": 36805527, + * "status": "in-progress", + * "type": "transfer", + * "started_at": "2014-11-14T16:42:45Z", + * "completed_at": null, + * "resource_id": 7938269, + * "resource_type": "image", + * "region": { + * "name": "New York 3", + * "slug": "nyc3", + * "sizes": [ + * "s-1vcpu-3gb", + * "m-1vcpu-8gb", + * "s-3vcpu-1gb", + * "s-1vcpu-2gb", + * "s-2vcpu-2gb", + * "s-2vcpu-4gb", + * "s-4vcpu-8gb", + * "s-6vcpu-16gb", + * "s-8vcpu-32gb", + * "s-12vcpu-48gb", + * "s-16vcpu-64gb", + * "s-20vcpu-96gb", + * "s-1vcpu-1gb", + * "c-1vcpu-2gb", + * "s-24vcpu-128gb" * ], - * "versions": [ - * "5.0", - * "6.0", - * "7.0" + * "features": [ + * "private_networking", + * "backups", + * "ipv6", + * "metadata", + * "server_id", + * "install_agent", + * "storage", + * "image_transfer" * ], - * "layouts": [ - * { - * "num_nodes": 1, - * "sizes": [ - * "db-s-1vcpu-1gb", - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "db-s-8vcpu-32gb", - * "db-s-16vcpu-64gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb" - * ] - * }, - * { - * "num_nodes": 3, - * "sizes": [ - * "db-s-1vcpu-1gb", - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "db-s-8vcpu-32gb", - * "db-s-16vcpu-64gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb" - * ] - * } - * ] + * "available": true * }, - * "mysql": { - * "regions": [ - * "ams3", - * "blr1", - * "fra1", - * "lon1", - * "nyc1", - * "nyc3", - * "sfo2", - * "sfo3", - * "sgp1", - * "syd1", - * "tor1" - * ], - * "versions": [ - * "8" + * "region_slug": "nyc3" + * } + * } + */ + "application/json": components["schemas"]["action"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `kubernetes_clusters`. + * This will be set to an array of objects, each of which will contain the + * standard Kubernetes cluster attributes. + */ + all_clusters: { + 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": { + kubernetes_clusters?: components["schemas"]["cluster_read"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `kubernetes_cluster`. The + * value of this will be an object containing the standard attributes of a + * Kubernetes cluster. + * + * The IP address and cluster API server endpoint will not be available until the + * cluster has finished provisioning. The initial value of the cluster's + * `status.state` attribute will be `provisioning`. When the cluster is ready, + * this will transition to `running`. + */ + cluster_create: { + 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": { + kubernetes_cluster?: components["schemas"]["cluster"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `kubernetes_cluster`. The + * value of this will be an object containing the standard attributes of a + * Kubernetes cluster. + */ + existing_cluster: { + 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": { + kubernetes_cluster?: components["schemas"]["cluster_read"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `kubernetes_cluster`. The + * value of this will be an object containing the standard attributes of a + * Kubernetes cluster. + */ + updated_cluster: { + 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": { + kubernetes_cluster?: components["schemas"]["cluster"]; + }; + }; + }; + /** @description The response will be a JSON object containing `load_balancers`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing the standard attributes for associated resources. */ + associated_kubernetes_resources_list: { + 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": components["schemas"]["associated_kubernetes_resources"]; + }; + }; + /** @description A kubeconfig file for the cluster in YAML format. */ + kubeconfig: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example apiVersion: v1 + * clusters: + * - cluster: + * certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURUxCUUF3TXpFVk1CTUdBMVVFQ2ftTVJHbG4KYVhSaGJFOWpaV0Z1TVJvd0dUSREERXhGck9ITmhZWE1nUTJ4MWMzUmxjaUJEUVRBZUZ3MHhPREV4TVRVeApOakF3TWpCYUZ3MHpPREV4TVRVeE5qQXdNakJhTURNeEZUQVRCZ05WQkFvVERFUnBaMmwwWVd4UFkyVmhiakVhCk1CZ0dBMVVFQXhNUmF6aHpZV0Z6SUVOc2RYTjBaWElnUTBFd2dnRWlNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUIKRHdBd2dnRUtBb0lCQVFDK2Z0L05Nd3pNaUxFZlFvTFU2bDgrY0hMbWttZFVKdjl4SmlhZUpIU0dZOGhPZFVEZQpGd1Zoc0pDTnVFWkpJUFh5Y0orcGpkU3pYc1lFSE03WVNKWk9xNkdaYThPMnZHUlJjN2ZQaUFJaFBRK0ZpUmYzCmRhMHNIUkZlM2hCTmU5ZE5SeTliQ2VCSTRSUlQrSEwzRFR3L2I5KytmRkdZQkRoVTEvTTZUWWRhUHR3WU0rdWgKb1pKcWJZVGJZZTFhb3R1ekdnYUpXaXRhdFdHdnNJYU8xYWthdkh0WEIOOHFxa2lPemdrSDdvd3RVY3JYM05iawozdmlVeFU4TW40MmlJaGFyeHNvTnlwdGhHOWZLMi9OdVdKTXJJS2R0Mzhwc0tkdDBFbng0MWg5K0dsMjUzMzhWCk1mdjBDVDF6SG1JanYwblIrakNkcFd0eFVLRyt0YjYzZFhNbkFnTUJBQUdqUlRCRE1BNEdBMVVkRHdFQi93UUUKQXdJQmhqQVNCZ05WSFJNQkFmOEVDREFHQVFIL0FnRUFNQjBHQTFVZERnUVdCQlNQMmJrOXJiUGJpQnZOd1Z1NQpUL0dwTFdvOTdEQU5CZ2txaGtpRzl3MEJBUXNGQUFPQ0FRRUFEVjFMSGZyc1JiYVdONHE5SnBFVDMxMlluRDZ6Cm5rM3BpU1ZSYVEvM09qWG8wdHJ6Z2N4KzlVTUQxeDRHODI1RnYxc0ROWUExZEhFc2dHUmNyRkVmdGZJQWUrUVYKTitOR3NMRnQrOGZrWHdnUlpoNEU4ZUJsSVlrdEprOWptMzFMT25vaDJYZno0aGs3VmZwYkdvVVlsbmVoak1JZApiL3ZMUk05Y2EwVTJlYTB5OTNveE5pdU9PcXdrZGFjU1orczJtb3JNdGZxc3VRSzRKZDA3SENIbUFIeWpXT2k4ClVOQVUyTnZnSnBKY2RiZ3VzN2I5S3ppR1ZERklFUk04cEo4U1Nob1ZvVFFJd3d5Y2xVTU9EUUJreFFHOHNVRk8KRDE3ZjRod1dNbW5qVHY2MEJBM0dxaTZRcjdsWVFSL3drSEtQcnZjMjhoNXB0NndPWEY1b1M4OUZkUT09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K + * server: https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com + * name: do-nyc1-prod-cluster-01 + * contexts: + * - context: + * cluster: do-nyc1-prod-cluster-01 + * user: do-nyc1-prod-cluster-01-admin + * name: do-nyc1-prod-cluster-01 + * current-context: do-nyc1-prod-cluster-01 + * kind: Config + * preferences: {} + * users: + * - name: do-nyc1-prod-cluster-01-admin + * user: + * token: 403d085aaa80102277d8da97ffd2db2b6a4f129d0e2146098fdfb0cec624babc + */ + "application/yaml": unknown; + }; + }; + /** @description A JSON object containing credentials for a cluster. */ + credentials: { + 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": components["schemas"]["credentials"]; + }; + }; + /** + * @description The response will be a JSON object with a key called + * `available_upgrade_versions`. The value of this will be an array of objects, + * representing the upgrade versions currently available for this cluster. + * + * If the cluster is up-to-date (i.e. there are no upgrades currently available) + * `available_upgrade_versions` will be `null`. + */ + available_upgrades: { + 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": { + available_upgrade_versions?: components["schemas"]["kubernetes_version"][] | null; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `node_pools`. This will + * be set to an array of objects, each of which will contain the standard node + * pool attributes. + */ + all_node_pools: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "node_pools": [ + * { + * "id": "cdda885e-7663-40c8-bc74-3a036c66545d", + * "name": "frontend-pool", + * "size": "s-1vcpu-2gb", + * "count": 3, + * "tags": [ + * "production", + * "web-team", + * "k8s", + * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", + * "k8s:worker" * ], - * "layouts": [ + * "labels": null, + * "auto_scale": false, + * "min_nodes": 0, + * "max_nodes": 0, + * "nodes": [ * { - * "num_nodes": 1, - * "sizes": [ - * "db-s-1vcpu-1gb", - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb", - * "db-intel-1vcpu-1gb", - * "db-amd-1vcpu-1gb", - * "db-intel-1vcpu-2gb", - * "db-amd-1vcpu-2gb", - * "db-amd-2vcpu-4gb", - * "db-intel-2vcpu-4gb", - * "db-amd-2vcpu-8gb", - * "db-intel-2vcpu-8gb", - * "db-intel-4vcpu-8gb", - * "db-amd-4vcpu-8gb", - * "db-amd-4vcpu-16gb", - * "db-intel-4vcpu-16gb", - * "db-intel-8vcpu-32gb", - * "db-amd-8vcpu-32gb", - * "db-intel-16vcpu-64gb", - * "db-amd-16vcpu-64gb" - * ] + * "id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", + * "name": "adoring-newton-3niq", + * "status": { + * "state": "running" + * }, + * "droplet_id": "205545370", + * "created_at": "2018-11-15T16:00:11Z", + * "updated_at": "2018-11-15T16:00:11Z" * }, * { - * "num_nodes": 2, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb", - * "db-intel-1vcpu-2gb", - * "db-amd-1vcpu-2gb", - * "db-amd-2vcpu-4gb", - * "db-intel-2vcpu-4gb", - * "db-intel-2vcpu-8gb", - * "db-amd-2vcpu-8gb", - * "db-intel-4vcpu-8gb", - * "db-amd-4vcpu-8gb", - * "db-intel-4vcpu-16gb", - * "db-amd-4vcpu-16gb", - * "db-amd-8vcpu-32gb", - * "db-intel-8vcpu-32gb", - * "db-amd-16vcpu-64gb", - * "db-intel-16vcpu-64gb" - * ] + * "id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", + * "name": "adoring-newton-3nim", + * "status": { + * "state": "running" + * }, + * "droplet_id": "205545371", + * "created_at": "2018-11-15T16:00:11Z", + * "updated_at": "2018-11-15T16:00:11Z" * }, * { - * "num_nodes": 3, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb", - * "db-intel-1vcpu-2gb", - * "db-amd-1vcpu-2gb", - * "db-amd-2vcpu-4gb", - * "db-intel-2vcpu-4gb", - * "db-intel-2vcpu-8gb", - * "db-amd-2vcpu-8gb", - * "db-intel-4vcpu-8gb", - * "db-amd-4vcpu-8gb", - * "db-intel-4vcpu-16gb", - * "db-amd-4vcpu-16gb", - * "db-amd-8vcpu-32gb", - * "db-intel-8vcpu-32gb", - * "db-amd-16vcpu-64gb", - * "db-intel-16vcpu-64gb" - * ] + * "id": "e46e8d07-f58f-4ff1-9737-97246364400e", + * "name": "adoring-newton-3ni7", + * "status": { + * "state": "running" + * }, + * "droplet_id": "205545372", + * "created_at": "2018-11-15T16:00:11Z", + * "updated_at": "2018-11-15T16:00:11Z" * } * ] * }, - * "opensearch": { - * "regions": [ - * "ams3", - * "blr1", - * "fra1", - * "lon1", - * "nyc1", - * "nyc3", - * "sfo2", - * "sfo3", - * "sgp1", - * "syd1", - * "tor1" - * ], - * "versions": [ - * "1", - * "2" + * { + * "id": "f49f4379-7e7f-4af5-aeb6-0354bd840778", + * "name": "backend-pool", + * "size": "g-4vcpu-16gb", + * "count": 2, + * "tags": [ + * "production", + * "web-team", + * "k8s", + * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", + * "k8s:worker" * ], - * "layouts": [ - * { - * "num_nodes": 1, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "gd-2vcpu-8gb", - * "m3-2vcpu-16gb", - * "db-s-4vcpu-8gb", - * "gd-4vcpu-16gb", - * "m3-4vcpu-32gb", - * "m3-8vcpu-64gb" - * ] - * }, - * { - * "num_nodes": 3, - * "sizes": [ - * "db-s-2vcpu-4gb", - * "gd-2vcpu-8gb", - * "m3-2vcpu-16gb", - * "db-s-4vcpu-8gb", - * "gd-4vcpu-16gb", - * "m3-4vcpu-32gb", - * "m3-8vcpu-64gb" - * ] - * }, - * { - * "num_nodes": 6, - * "sizes": [ - * "gd-2vcpu-8gb", - * "m3-2vcpu-16gb", - * "gd-4vcpu-16gb", - * "m3-4vcpu-32gb", - * "m3-8vcpu-64gb" - * ] - * }, + * "labels": { + * "service": "backend", + * "priority": "high" + * }, + * "auto_scale": true, + * "min_nodes": 2, + * "max_nodes": 5, + * "nodes": [ * { - * "num_nodes": 9, - * "sizes": [ - * "gd-2vcpu-8gb", - * "m3-2vcpu-16gb", - * "gd-4vcpu-16gb", - * "m3-4vcpu-32gb", - * "m3-8vcpu-64gb" - * ] + * "id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518", + * "name": "affectionate-nightingale-3nif", + * "status": { + * "state": "running" + * }, + * "droplet_id": "205545373", + * "created_at": "2018-11-15T16:00:11Z", + * "updated_at": "2018-11-15T16:00:11Z" * }, * { - * "num_nodes": 15, - * "sizes": [ - * "gd-2vcpu-8gb", - * "m3-2vcpu-16gb", - * "gd-4vcpu-16gb", - * "m3-4vcpu-32gb", - * "m3-8vcpu-64gb" - * ] + * "id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6", + * "name": "affectionate-nightingale-3niy", + * "status": { + * "state": "running" + * }, + * "droplet_id": "205545374", + * "created_at": "2018-11-15T16:00:11Z", + * "updated_at": "2018-11-15T16:00:11Z" * } * ] + * } + * ] + * } + */ + "application/json": { + node_pools?: components["schemas"]["kubernetes_node_pool"][]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `node_pool`. The value of + * this will be an object containing the standard attributes of a node pool. + */ + node_pool_create: { + 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": { + node_pool?: components["schemas"]["kubernetes_node_pool"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `node_pool`. The value + * of this will be an object containing the standard attributes of a node pool. + */ + existing_node_pool: { + 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": { + node_pool?: components["schemas"]["kubernetes_node_pool"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `node_pool`. The value of + * this will be an object containing the standard attributes of a node pool. + */ + node_pool_update: { + 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": { + node_pool?: components["schemas"]["kubernetes_node_pool"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `kubernetes_cluster_user` + * containing the username and in-cluster groups that it belongs to. + */ + cluster_user: { + 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": components["schemas"]["user"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `options` which contains + * `regions`, `versions`, and `sizes` objects listing the available options and + * the matching slugs for use when creating a new cluster. + */ + all_options: { + 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": components["schemas"]["kubernetes_options"]; + }; + }; + /** + * @description The response is a JSON object which contains the diagnostics on Kubernetes + * objects in the cluster. Each diagnostic will contain some metadata information + * about the object and feedback for users to act upon. + */ + clusterlint_results: { + 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": components["schemas"]["clusterlint_results"]; + }; + }; + /** @description The response is a JSON object with a key called `run_id` that you can later use to fetch the run results. */ + clusterlint_run: { + 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 ID of the clusterlint run that can be used later to fetch the diagnostics. + * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + */ + run_id?: string; + }; + }; + }; + /** @description The response is a JSON object which contains status messages for a Kubernetes cluster. Each message object contains a timestamp and an indication of what issue the cluster is experiencing at a given time. */ + status_messages: { + 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": { + messages?: components["schemas"]["status_messages"][]; + }; + }; + }; + /** @description A JSON object with a key of `load_balancers`. This will be set to an array of objects, each of which will contain the standard load balancer attributes. */ + all_load_balancers: { + 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": { + load_balancers?: components["schemas"]["load_balancer"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description Accepted */ + load_balancer_create: { + 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": { + load_balancer?: components["schemas"]["load_balancer"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `load_balancer`. The + * value of this will be an object that contains the standard attributes + * associated with a load balancer + */ + existing_load_balancer: { + 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": { + load_balancer?: components["schemas"]["load_balancer"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called `load_balancer`. The + * value of this will be an object containing the standard attributes of a + * load balancer. + */ + updated_load_balancer: { + 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": { + load_balancer?: components["schemas"]["load_balancer"]; + }; + }; + }; + /** @description A list of alert policies. */ + list_alert_policy_response: { + 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": components["schemas"]["list_alert_policy"] & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description An alert policy. */ + alert_policy_response: { + 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": { + policy?: components["schemas"]["alert_policy"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `data` and `status`. */ + droplet_bandwidth_metric_response: { + 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": components["schemas"]["metrics"]; + }; + }; + /** @description The response will be a JSON object with a key called `data` and `status`. */ + droplet_cpu_metric_response: { + 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": components["schemas"]["metrics"]; + }; + }; + /** @description The response will be a JSON object with a key called `data` and `status`. */ + droplet_filesystem_metric_response: { + 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": components["schemas"]["metrics"]; + }; + }; + /** @description The response will be a JSON object with a key called `data` and `status`. */ + metric_response: { + 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": components["schemas"]["metrics"]; + }; + }; + /** @description The response will be a JSON object with a key called `data` and `status`. */ + app_metric_response: { + 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": 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 `shares`. The value will be an array of objects, each containing the standard attributes associated with an NFS share. */ + nfs_list: { + 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": components["schemas"]["nfs_list_response"]; + }; + }; + /** @description A JSON response containing details about the new NFS share. */ + nfs_create: { + 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": components["schemas"]["nfs_create_response"]; + }; + }; + /** @description Size must be greater than or equal to 50Gib */ + "bad_request-2": { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "bad_request", + * "message": "The value for 'size_gib' must be greater than or equal to 50Gib." + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description The response will be a JSON object with a key called `share`. The value will be an object containing the standard attributes associated with an NFS share. */ + nfs_get: { + 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": components["schemas"]["nfs_get_response"]; + }; + }; + /** @description The response will be a JSON object with a key called `action`. */ + nfs_actions: { + 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": components["schemas"]["nfs_actions_response"]; + }; + }; + /** @description The response will be a JSON object with a key called `snapshots`. The value will be an array of objects, each containing the standard attributes associated with an NFS snapshot. */ + nfs_snapshot_list: { + 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": components["schemas"]["nfs_snapshot_list_response"]; + }; + }; + /** @description The response will be a JSON object with a key called `snapshot`. The value will be an object containing the standard attributes associated with an NFS snapshot. */ + nfs_snapshot_get: { + 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": components["schemas"]["nfs_snapshot_get_response"]; + }; + }; + /** + * @description The response will be a JSON object with a `partner_attachments` key + * that contains an array of all partner attachments + */ + all_partner_attachments: { + 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": { + partner_attachments?: components["schemas"]["partner_attachment"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with details about the partner attachment + * including attached VPC network IDs and BGP configuration information + */ + single_partner_attachment: { + 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": { + partner_attachment?: components["schemas"]["partner_attachment"]; + }; + }; + }; + /** + * @description The response will be a JSON object with details about the partner attachment + * and `"state": "DELETING"` to indicate that the partner attachment is being deleted. + */ + single_partner_attachment_deleting: { + 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": { + partner_attachment?: components["schemas"]["partner_attachment"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a `bgp_auth_key` object containing a + * `value` field with the BGP auth key value + */ + single_partner_attachment_bgp_auth_key: { + 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": { + bgp_auth_key?: Record; + }; + }; + }; + /** + * @description The response will be a JSON object with a `remote_routes` array containing + * information on all the remote routes associated with the partner attachment + */ + all_partner_attachment_remote_routes: { + 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": { + remote_routes?: components["schemas"]["partner_attachment_remote_route"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a `service_key` object containing + * the service key value and creation information + */ + single_partner_attachment_service_key: { + 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": { + service_key?: Record; + }; + }; + }; + /** @description The response is an empty JSON object. */ + empty_json_object: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** @example {} */ + "application/json": Record; + }; + }; + /** @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: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + projects?: components["schemas"]["project"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ + existing_project: { + 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": { + project?: components["schemas"]["project"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ + default_project: { + 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": { + project?: components["schemas"]["project"]; + }; + }; + }; + /** @description Only an empty project can be deleted. */ + precondition_failed: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "precondition_failed", + * "message": "cannot delete a project with resources. move or remove the resources first" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `resources`. + * The value of this will be an object with the standard resource attributes. + * + * Only resources that you are authorized to see will be returned. + */ + resources_list: { + 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 The resources that are assigned to this project. Only resources that you are authorized to see will be returned. */ + resources?: components["schemas"]["resource"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `resources`. + * The value of this will be an object with the standard resource attributes. + * + * Only resources that you are authorized to see will be returned. + */ + assigned_resources_list: { + 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 All resources, including the ones added in the request, that are assigned to the project. Only resources that you are authorized to see will be returned. */ + resources?: components["schemas"]["resource"][]; + }; + }; + }; + /** @description A JSON object with a key set to `regions`. The value is an array of `region` objects, each of which contain the standard `region` attributes. */ + all_regions: { + 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": { + regions: components["schemas"]["region"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with the key `registry` containing information about your registry. */ + all_registries_info: { + 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": { + registries?: components["schemas"]["registry"][]; + }; + }; + }; + /** @description The response will be a JSON object with the key `registry` containing information about your registry. */ + multiregistry_info: { + 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": { + registry?: components["schemas"]["multiregistry"]; + }; + }; + }; + /** @description A Docker `config.json` file for the container registry. */ + docker_credentials: { + 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": components["schemas"]["docker_credentials"]; + }; + }; + /** @description The response will be a JSON object with a key called `subscription` containing information about your subscription. */ + subscription_response: { + 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": { + subscription?: components["schemas"]["subscription"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `options` which contains a key called `subscription_tiers` listing the available tiers. */ + registry_options_response: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "options": { + * "available_regions": [ + * "nyc3", + * "sfo3", + * "ams3", + * "sgp1", + * "fra1" + * ], + * "subscription_tiers": [ + * { + * "name": "Starter", + * "slug": "starter", + * "included_repositories": 1, + * "included_storage_bytes": 524288000, + * "allow_storage_overage": false, + * "included_bandwidth_bytes": 524288000, + * "monthly_price_in_cents": 0, + * "eligible": false, + * "eligibility_reasons": [ + * "OverRepositoryLimit" + * ] + * }, + * { + * "name": "Basic", + * "slug": "basic", + * "included_repositories": 5, + * "included_storage_bytes": 5368709120, + * "allow_storage_overage": true, + * "included_bandwidth_bytes": 5368709120, + * "monthly_price_in_cents": 500, + * "eligible": true + * }, + * { + * "name": "Professional", + * "slug": "professional", + * "included_repositories": 0, + * "included_storage_bytes": 107374182400, + * "allow_storage_overage": true, + * "included_bandwidth_bytes": 107374182400, + * "monthly_price_in_cents": 2000, + * "eligible": true + * } + * ] + * } + * } + */ + "application/json": { + options?: { + /** + * @example [ + * "nyc3" + * ] + */ + available_regions?: string[]; + subscription_tiers?: (components["schemas"]["subscription_tier_base"] & components["schemas"]["subscription_tier_extended"])[]; + }; + }; + }; + }; + /** @description The response will be a JSON object with a key of `garbage_collection`. This will be a json object with attributes representing the currently-active garbage collection. */ + garbage_collection: { + 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": { + garbage_collection?: components["schemas"]["garbage_collection"]; + }; + }; + }; + /** @description The response will be a JSON object with a key of `garbage_collections`. This will be set to an array containing objects representing each past garbage collection. Each will contain the standard Garbage Collection attributes. */ + garbage_collections: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "garbage_collections": [ + * { + * "uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8", + * "registry_name": "example", + * "status": "requested", + * "created_at": "2020-10-30T21:03:24.000Z", + * "updated_at": "2020-10-30T21:03:44.000Z", + * "blobs_deleted": 42, + * "freed_bytes": 667 + * } + * ], + * "meta": { + * "total": 1 + * } + * } + */ + "application/json": { + garbage_collections?: components["schemas"]["garbage_collection"][]; + }; + }; + }; + /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ + all_repositories_v2: { + 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": { + repositories?: components["schemas"]["repository_v2"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response body will be a JSON object with a key of `tags`. This will be set to an array containing objects each representing a tag. */ + repository_tags: { + 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": { + tags?: components["schemas"]["repository_tag"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response body will be a JSON object with a key of `manifests`. This will be set to an array containing objects each representing a manifest. */ + repository_manifests: { + 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": { + manifests?: components["schemas"]["repository_manifest"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with the key `registry` containing information about your registry. */ + registry_info: { + 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": { + registry?: components["schemas"]["registry"]; + }; + }; + }; + /** @description There are more than one registries in the DO account. */ + registries_precondition_fail: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "precondition_failed", + * "message": "This API is not supported if you have created multiple registries. Please use \n‘/v2/registries/{registry_name}’ instead. Refer to \nhttps://docs.digitalocean.com/reference/api/digitalocean/#tag/Container-Registry for more info." + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description There are more than one registries in the DO account. */ + registries_over_limit: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "precondition_failed", + * "message": "registry is not eligible for tier because: [OverRegistryLimit]" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ + all_repositories: { + 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": { + repositories?: components["schemas"]["repository"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with an `neighbor_ids` key. */ + droplet_neighbors_ids: { + 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": components["schemas"]["neighbor_ids"]; + }; + }; + /** @description The response will be a JSON object with a key called `reserved_ips`. This will be set to an array of reserved IP objects, each of which will contain the standard reserved IP attributes */ + reserved_ip_list: { + 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": { + reserved_ips?: components["schemas"]["reserved_ip"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. + * When assigning a reserved IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. + */ + reserved_ip_created: { + 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": { + reserved_ip?: components["schemas"]["reserved_ip"]; + links?: { + droplets?: components["schemas"]["action_link"][]; + actions?: components["schemas"]["action_link"][]; + }; + }; + }; + }; + /** @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. */ + reserved_ip: { + 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": { + reserved_ip?: components["schemas"]["reserved_ip"]; + }; + }; + }; + /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard reserved IP action attributes. */ + reserved_ip_actions: { + 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": { + actions?: components["schemas"]["action"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard reserved IP action attributes. */ + reserved_ip_action: { + 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": { + action?: components["schemas"]["action"] & { + /** + * Format: uuid + * @description The UUID of the project to which the reserved IP currently belongs. + * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 + */ + project_id?: string; + }; + }; + }; + }; + /** @description The response will be a JSON object with a key called `reserved_ipv6s`. This will be set to an array of reserved IP objects, each of which will contain the standard reserved IP attributes */ + reserved_ipv6_list: { + 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": components["schemas"]["reserved_ipv6_list"] & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with key `reserved_ipv6`. The value of this will be an object that contains the standard attributes associated with a reserved IPv6. */ + reserved_ipv6_create: { + 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": { + reserved_ipv6?: { + /** + * Format: ipv6 + * @description The public IP address of the reserved IPv6. It also serves as its identifier. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + */ + ip?: string; + /** + * @description The region that the reserved IPv6 is reserved to. When you query a reserved IPv6,the region_slug will be returned. + * @example nyc3 + */ + region_slug?: string; + /** + * Format: date-time + * @example 2024-11-20T11:08:30Z + */ + reserved_at?: string; + }; + }; + }; + }; + /** @description The response will be a JSON object with key `reserved_ipv6`. The value of this will be an object that contains the standard attributes associated with a reserved IPv6. */ + reserved_ipv6: { + 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": { + reserved_ipv6?: components["schemas"]["reserved_ipv6"]; + }; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard reserved IP action attributes. */ + reserved_ipv6_action: { + 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": { + action?: components["schemas"]["action"] & { + /** + * @description The ID of the resource that the action is being taken on. + * @example 758604968 + */ + resource_id?: number; + /** + * @description The type of resource that the action is being taken on. + * @example reserved_ipv6 + */ + resource_type?: string; + /** + * @description The slug identifier for the region the resource is located in. + * @example nyc3 + */ + region_slug?: string; + }; + }; + }; + }; + /** @description List of BYOIP prefixes as an array of BYOIP prefix JSON objects */ + byoip_prefix_list: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "byoip_prefixes": [ + * { + * "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + * "status": "active", + * "region": "nyc3", + * "prefix": "203.0.113.0/24", + * "validations": [], + * "failure_reason": "", + * "advertised": true, + * "locked": false, + * "project_id": "12345678-1234-1234-1234-123456789012" * }, - * "pg": { - * "regions": [ - * "ams3", - * "blr1", - * "fra1", - * "lon1", - * "nyc1", - * "nyc3", - * "sfo2", - * "sfo3", - * "sgp1", - * "syd1", - * "tor1" - * ], - * "versions": [ - * "13", - * "14", - * "15", - * "16" - * ], - * "layouts": [ - * { - * "num_nodes": 1, - * "sizes": [ - * "db-s-1vcpu-1gb", - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb", - * "db-intel-1vcpu-1gb", - * "db-amd-1vcpu-1gb", - * "db-intel-1vcpu-2gb", - * "db-amd-1vcpu-2gb", - * "db-amd-2vcpu-4gb", - * "db-intel-2vcpu-4gb", - * "db-amd-2vcpu-8gb", - * "db-intel-2vcpu-8gb", - * "db-intel-4vcpu-8gb", - * "db-amd-4vcpu-8gb", - * "db-amd-4vcpu-16gb", - * "db-intel-4vcpu-16gb", - * "db-intel-8vcpu-32gb", - * "db-amd-8vcpu-32gb", - * "db-intel-16vcpu-64gb", - * "db-amd-16vcpu-64gb" - * ] - * }, - * { - * "num_nodes": 2, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb", - * "db-intel-1vcpu-2gb", - * "db-amd-1vcpu-2gb", - * "db-amd-2vcpu-4gb", - * "db-intel-2vcpu-4gb", - * "db-intel-2vcpu-8gb", - * "db-amd-2vcpu-8gb", - * "db-intel-4vcpu-8gb", - * "db-amd-4vcpu-8gb", - * "db-intel-4vcpu-16gb", - * "db-amd-4vcpu-16gb", - * "db-amd-8vcpu-32gb", - * "db-intel-8vcpu-32gb", - * "db-amd-16vcpu-64gb", - * "db-intel-16vcpu-64gb" - * ] - * }, - * { - * "num_nodes": 3, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "gd-2vcpu-8gb", - * "gd-4vcpu-16gb", - * "gd-8vcpu-32gb", - * "gd-16vcpu-64gb", - * "gd-32vcpu-128gb", - * "gd-40vcpu-160gb", - * "so1_5-2vcpu-16gb", - * "so1_5-4vcpu-32gb", - * "so1_5-8vcpu-64gb", - * "so1_5-16vcpu-128gb", - * "so1_5-24vcpu-192gb", - * "so1_5-32vcpu-256gb", - * "db-intel-1vcpu-2gb", - * "db-amd-1vcpu-2gb", - * "db-amd-2vcpu-4gb", - * "db-intel-2vcpu-4gb", - * "db-intel-2vcpu-8gb", - * "db-amd-2vcpu-8gb", - * "db-intel-4vcpu-8gb", - * "db-amd-4vcpu-8gb", - * "db-intel-4vcpu-16gb", - * "db-amd-4vcpu-16gb", - * "db-amd-8vcpu-32gb", - * "db-intel-8vcpu-32gb", - * "db-amd-16vcpu-64gb", - * "db-intel-16vcpu-64gb" - * ] - * } - * ] + * { + * "uuid": "123e4567-e89b-12d3-a456-426614174001", + * "status": "in_progress", + * "region": "sfo2", + * "prefix": "203.1.113.0/24", + * "validations": [], + * "failure_reason": "", + * "advertised": false, + * "locked": false, + * "project_id": "12345678-1234-1234-1234-123456789012" + * } + * ], + * "links": {}, + * "meta": { + * "total": 2 + * } + * } + */ + "application/json": { + byoip_prefixes?: components["schemas"]["byoip_prefix"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description BYOIP prefix request accepted, response will contain the details of the created prefix. */ + byoip_prefix_create: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "byoip_prefix": { + * "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + * "status": "in_progress", + * "region": "nyc3" + * } + * } + */ + "application/json": { + /** + * @description The unique identifier for the BYOIP prefix + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + uuid?: string; + /** + * @description The region where the prefix is created + * @example nyc3 + */ + region?: string; + /** + * @description The status of the BYOIP prefix + * @example in_progress + */ + status?: string; + }; + }; + }; + /** @description Details of the requested BYOIP prefix */ + byoip_prefix_get: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "byoip_prefix": { + * "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + * "status": "active", + * "region": "nyc3", + * "prefix": "203.0.113.0/24", + * "validations": [], + * "failure_reason": "", + * "advertised": true, + * "locked": false, + * "project_id": "12345678-1234-1234-1234-123456789012" + * } + * } + */ + "application/json": { + byoip_prefix?: components["schemas"]["byoip_prefix"]; + }; + }; + }; + /** @description Details of the updated BYOIP prefix */ + byoip_prefix_update: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "byoip_prefix": { + * "uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479", + * "status": "active", + * "region": "nyc3", + * "prefix": "203.0.113.0/24", + * "validations": [], + * "failure_reason": "", + * "advertised": true, + * "locked": false, + * "project_id": "12345678-1234-1234-1234-123456789012" + * } + * } + */ + "application/json": { + byoip_prefix?: components["schemas"]["byoip_prefix"]; + }; + }; + }; + /** @description List of IP addresses assigned to resources (such as Droplets) in a BYOIP prefix */ + byoip_prefix_list_resources: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "ips": [ + * { + * "id": 11111023, + * "byoip": "203.0.113.2", + * "region": "nyc3", + * "resource": "do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d479", + * "assigned_at": "2025-06-25T12:00:00Z" * }, - * "redis": { - * "regions": [ - * "ams3", - * "blr1", - * "fra1", - * "lon1", - * "nyc1", - * "nyc3", - * "sfo2", - * "sfo3", - * "sgp1", - * "syd1", - * "tor1" - * ], - * "versions": [ - * "7" - * ], - * "layouts": [ - * { - * "num_nodes": 1, - * "sizes": [ - * "db-s-1vcpu-1gb", - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "db-s-8vcpu-32gb", - * "db-s-16vcpu-64gb", - * "m-2vcpu-16gb", - * "m-4vcpu-32gb", - * "m-8vcpu-64gb", - * "m-16vcpu-128gb", - * "m-24vcpu-192gb", - * "m-32vcpu-256gb" - * ] - * }, - * { - * "num_nodes": 2, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "db-s-8vcpu-32gb", - * "db-s-16vcpu-64gb", - * "m-2vcpu-16gb", - * "m-4vcpu-32gb", - * "m-8vcpu-64gb", - * "m-16vcpu-128gb", - * "m-24vcpu-192gb", - * "m-32vcpu-256gb" - * ] - * }, - * { - * "num_nodes": 3, - * "sizes": [ - * "db-s-1vcpu-2gb", - * "db-s-2vcpu-4gb", - * "db-s-4vcpu-8gb", - * "db-s-6vcpu-16gb", - * "db-s-8vcpu-32gb", - * "db-s-16vcpu-64gb", - * "m-2vcpu-16gb", - * "m-4vcpu-32gb", - * "m-8vcpu-64gb", - * "m-16vcpu-128gb", - * "m-24vcpu-192gb", - * "m-32vcpu-256gb" - * ] - * } - * ] + * { + * "id": 11111024, + * "byoip": "203.0.113.3", + * "region": "nyc3", + * "resource": "do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d480", + * "assigned_at": "2025-06-25T13:00:00Z" * } - * }, - * "version_availability": { - * "kafka": [ - * { - * "end_of_life": null, - * "end_of_availability": "2024-07-18T00:00:00Z", - * "version": "3.6" - * }, - * { - * "end_of_life": null, - * "end_of_availability": "2025-01-17T00:00:00Z", - * "version": "3.7" - * } - * ], - * "mongodb": [ - * { - * "end_of_life": "2024-10-01T07:00:00Z", - * "end_of_availability": null, - * "version": "5.0" - * }, - * { - * "end_of_life": "2025-07-01T07:00:00Z", - * "end_of_availability": null, - * "version": "6.0" - * }, - * { - * "end_of_life": "2026-08-01T07:00:00Z", - * "end_of_availability": null, - * "version": "7.0" - * } - * ], - * "mysql": [ - * { - * "end_of_life": null, - * "end_of_availability": null, - * "version": "8" - * } - * ], - * "opensearch": [ - * { - * "end_of_life": null, - * "end_of_availability": null, - * "version": "1" - * }, - * { - * "end_of_life": null, - * "end_of_availability": null, - * "version": "2" - * } - * ], - * "pg": [ - * { - * "end_of_life": "2025-11-13T00:00:00Z", - * "end_of_availability": "2025-05-13T00:00:00Z", - * "version": "13" - * }, - * { - * "end_of_life": "2026-11-12T00:00:00Z", - * "end_of_availability": "2026-05-12T00:00:00Z", - * "version": "14" - * }, - * { - * "end_of_life": "2027-11-11T00:00:00Z", - * "end_of_availability": "2027-05-12T00:00:00Z", - * "version": "15" - * }, - * { - * "end_of_life": "2028-11-09T00:00:00Z", - * "end_of_availability": "2028-05-09T00:00:00Z", - * "version": "16" - * } - * ], - * "redis": [ - * { - * "end_of_life": null, - * "end_of_availability": null, - * "version": "7" - * } - * ] + * ], + * "links": {}, + * "meta": { + * "total": 2 * } * } */ - "application/json": components["schemas"]["options"]; + "application/json": { + ips?: components["schemas"]["byoip_prefix_resource"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. */ + all_sizes: { + 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": { + sizes: components["schemas"]["size"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with a key of `snapshots`. */ + snapshots: { + 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": { + snapshots?: components["schemas"]["snapshots"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON object with a key called `snapshot`. */ + snapshots_existing: { + 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": { + snapshot?: components["schemas"]["snapshots"]; + }; + }; + }; + /** @description Bad Request */ + not_a_snapshot: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "bad_request", + * "message": "the resource is not a snapshot", + * "request_id": "bbd8d7d4-2beb-4be1-a374-338e6165e32d" + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description A JSON response containing a list of keys. */ + key_list: { + 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": { + keys?: components["schemas"]["key"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description A JSON response containing details about the new key. */ + key_create: { + 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": { + key?: components["schemas"]["key_create_response"]; + }; + }; + }; + /** @description Cannot mix fullaccess permission with scoped permissions */ + "bad_request-3": { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + /** + * @example { + * "id": "bad_request", + * "message": "cannot mix fullaccess permission with scoped permissions." + * } + */ + "application/json": components["schemas"]["error"]; + }; + }; + /** @description A JSON response containing details about the key. */ + key_get: { + 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": { + keys?: components["schemas"]["key"][]; + }; + }; + }; + /** @description The response will be a JSON object */ + key_update: { + 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": { + key?: components["schemas"]["key"]; + }; + }; + }; + /** @description To list all of your tags, you can send a `GET` request to `/v2/tags`. */ + tags_all: { + 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": { + tags?: components["schemas"]["tags"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called tag. The value of this will be a tag object containing the standard tag attributes */ + tags_new: { + 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": { + tag?: components["schemas"]["tags"]; + }; + }; + }; + /** @description Bad Request */ + tags_bad_request: { + headers: { + "ratelimit-limit": components["headers"]["ratelimit-limit"]; + "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + "x-request-id": components["headers"]["x-request-id"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error_with_root_causes"]; + }; + }; + /** + * @description The response will be a JSON object with a key called `tag`. + * The value of this will be a tag object containing the standard tag attributes. + * + * Tagged resources will only include resources that you are authorized to see. + */ + tags_existing: { + 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": { + tag?: components["schemas"]["tags"]; + }; + }; + }; + /** @description The response will be a JSON object with a key called `volumes`. This will be set to an array of volume objects, each of which will contain the standard volume attributes. */ + volumes: { + 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 Array of volumes. */ + volumes: components["schemas"]["volume_full"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `volume`. The value will be an object containing the standard attributes associated with a volume. */ + volume: { + 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": { + volume?: components["schemas"]["volume_full"]; + }; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes */ + volumeAction: { + 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": { + action?: components["schemas"]["volumeAction"]; + }; + }; + }; + /** @description You will get back a JSON object that has a `snapshot` key. This will contain the standard snapshot attributes */ + volumeSnapshot: { + 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": { + snapshot?: components["schemas"]["snapshots"]; + }; + }; + }; + /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes. */ + volumeActions: { + 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": { + actions?: components["schemas"]["volumeAction"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description You will get back a JSON object that has a `snapshots` key. This will be set to an array of snapshot objects, each of which contain the standard snapshot attributes */ + volumeSnapshots: { + 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": { + snapshots?: components["schemas"]["snapshots"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `vpcs`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC. */ + all_vpcs: { + 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": { + vpcs?: components["schemas"]["vpc"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + }; + /** @description The response will be a JSON object with a key called `vpc`. The value of this will be an object that contains the standard attributes associated with a VPC. */ + existing_vpc: { + 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?: components["schemas"]["vpc"]; + }; + }; + }; + /** + * @description The response will be a JSON object with a key called members. This will be set + * to an array of objects, each of which will contain the standard attributes + * associated with a VPC member. + * + * Only resources that you are authorized to see will be returned (e.g. to see Droplets, + * you must have `droplet:read`). + */ + vpc_members: { + 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": { + members?: components["schemas"]["vpc_member"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with a key of `databases`. */ - database_clusters: { + /** @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"]; @@ -18360,74 +30300,13 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "databases": [ - * { - * "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", - * "name": "backend", - * "engine": "pg", - * "version": "10", - * "connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "private_connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "private-backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "users": [ - * { - * "name": "doadmin", - * "role": "primary", - * "password": "wv78n3zpz42xezdk" - * } - * ], - * "db_names": [ - * "defaultdb" - * ], - * "num_nodes": 1, - * "region": "nyc3", - * "status": "online", - * "created_at": "2019-01-11T18:37:36Z", - * "maintenance_window": { - * "day": "saturday", - * "hour": "08:45:12", - * "pending": true, - * "description": [ - * "Update TimescaleDB to version 1.2.1", - * "Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases" - * ] - * }, - * "size": "db-s-2vcpu-4gb", - * "tags": [ - * "production" - * ], - * "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", - * "version_end_of_life": "2023-11-09T00:00:00Z", - * "version_end_of_availability": "2023-05-09T00:00:00Z", - * "storage_size_mib": 61440 - * } - * ] - * } - */ "application/json": { - databases?: components["schemas"]["database_cluster"][]; - }; + peerings?: components["schemas"]["vpc_peering"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; }; }; - /** @description A JSON object with a key of `database`. */ - database_cluster: { + /** @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"]; @@ -18435,91 +30314,27 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "database": { - * "id": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", - * "name": "backend", - * "engine": "pg", - * "version": "14", - * "semantic_version": "14.5", - * "connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "private_connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "private-backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "standby_connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "replica-backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "standby_private_connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "private-replica-backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "users": [ - * { - * "name": "doadmin", - * "role": "primary", - * "password": "wv78n3zpz42xezdk" - * } - * ], - * "db_names": [ - * "defaultdb" - * ], - * "num_nodes": 2, - * "region": "nyc3", - * "status": "creating", - * "created_at": "2019-01-11T18:37:36Z", - * "maintenance_window": { - * "day": "saturday", - * "hour": "08:45:12", - * "pending": true, - * "description": [ - * "Update TimescaleDB to version 1.2.1", - * "Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases" - * ] - * }, - * "size": "db-s-2vcpu-4gb", - * "tags": [ - * "production" - * ], - * "private_network_uuid": "d455e75d-4858-4eec-8c95-da2f0a5f93a7", - * "version_end_of_life": "2023-11-09T00:00:00Z", - * "version_end_of_availability": "2023-05-09T00:00:00Z", - * "storage_size_mib": 61440 - * } - * } - */ "application/json": { - database: components["schemas"]["database_cluster"]; + peering?: components["schemas"]["vpc_peering"]; }; }; }; - /** @description A JSON object with a key of `config`. */ - database_config: { + /** @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"]; + "ratelimit-reset": components["headers"]["ratelimit-reset"]; + [name: string]: unknown; + }; + content: { + "application/json": { + 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"]; @@ -18527,21 +30342,13 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "config": { - * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES", - * "sql_require_primary_key": true - * } - * } - */ "application/json": { - config: components["schemas"]["mysql_advanced_config"] | components["schemas"]["postgres_advanced_config"] | components["schemas"]["redis_advanced_config"] | components["schemas"]["kafka_advanced_config"] | components["schemas"]["opensearch_advanced_config"] | components["schemas"]["mongo_advanced_config"]; + vpc_peering?: components["schemas"]["vpc_peering"]; }; }; }; - /** @description A JSON object with a key of `ca`. */ - ca: { + /** @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"]; @@ -18549,20 +30356,13 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "ca": { - * "certificate": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVRVENDQXFtZ0F3SUJBZ0lVRUZZWTdBWFZQS0Raam9jb1lpMk00Y0dvcU0wd0RRWUpLb1pJaHZjTkFRRU0KQlFBd09qRTRNRFlHQTFVRUF3d3ZOek0zT1RaaE1XRXRaamhrTUMwME9HSmpMV0V4Wm1NdFpqbGhNVFZsWXprdwpORGhsSUZCeWIycGxZM1FnUTBFd0hoY05NakF3TnpFM01UVTFNREEyV2hjTk16QXdOekUxTVRVMU1EQTJXakE2Ck1UZ3dOZ1lEVlFRRERDODNNemM1Tm1FeFlTMW1PR1F3TFRRNFltTXRZVEZtWXkxbU9XRXhOV1ZqT1RBME9HVWcKVUhKdmFtVmpkQ0JEUVRDQ0FhSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnR1BBRENDQVlvQ2dnR0JBTVdScXhycwpMZnpNdHZyUmxKVEw4MldYMVBLZkhKbitvYjNYcmVBY3FZd1dBUUp2Q3IycmhxSXZieVZzMGlaU0NzOHI4c3RGClljQ0R1bkxJNmUwTy9laERZYTBIT2RrMkFFRzE1ckVOVmNha2NSczcyQWlHVHNrdkNXS2VkUjFTUWswVWt0WCsKQUg4S1ExS3F5bzNtZ2Y2cVV1WUpzc3JNTXFselk3YTN1RVpEb2ZqTjN5Q3MvM21pTVJKcVcyNm1JV0IrUUlEbAo5YzdLRVF5MTZvdCtjeHVnd0lLMm9oZHMzaFY1bjBKMFVBM0I3QWRBdXY5aUl5L3JHaHlTNm5CNTdaWm9JZnAyCnFybXdOY0UrVjlIdXhQSGtRVjFOQjUwOFFudWZ4Z0E5VCtqU2VrdGVUbWFORkxqNjFXL3BtcndrTytOaWFXUTIKaGgzVXBKOEozY1BoNkErbHRnUmpSV2NEb2lsYVNwRVVpU09WemNNYVFvalZKYVJlNk9NbnZYc29NaSs3ZzdneApWcittQ0lUcGcvck9DaXpBWWQ2UFAxLzdYTjk1ZXNmU2tBQnM5c3hJakpjTUFqbDBYTEFzRmtGZVdyeHNIajlVCmJnaDNWYXdtcnpUeXhZT0RQcXV1cS9JcGlwc0RRT3Fpb2ZsUStkWEJJL3NUT0NNbVp6K0pNcG5HYXdJREFRQUIKb3o4d1BUQWRCZ05WSFE0RUZnUVVSekdDRlE3WEtUdHRDN3JzNS8ydFlQcExTZGN3RHdZRFZSMFRCQWd3QmdFQgovd0lCQURBTEJnTlZIUThFQkFNQ0FRWXdEUVlKS29aSWh2Y05BUUVNQlFBRGdnR0JBSWFKQ0dSVVNxUExtcmcvCmk3MW10b0NHUDdzeG1BVXVCek1oOEdrU25uaVdaZnZGMTRwSUtqTlkwbzVkWmpHKzZqK1VjalZtK0RIdGE1RjYKOWJPeEk5S0NFeEI1blBjRXpMWjNZYitNOTcrellxbm9zUm85S21DVFJBb2JrNTZ0WU1FS1h1aVJja2tkMm1yUQo4cGw2N2xxdThjM1V4c0dHZEZVT01wMkk3ZTNpdUdWVm5UR0ZWM3JQZUdaQ0J3WGVyUUQyY0F4UjkzS3BnWVZ2ClhUUzk5dnpSbm1HOHhhUm9EVy9FbEdXZ2xWd0Q5a1JrbXhUUkdoYTdDWVZCcjFQVWY2dVVFVjhmVFIxc1hFZnIKLytMR1JoSVVsSUhWT3l2Yzk3YnZYQURPbWF1MWZDVE5lWGtRdTNyZnZFSlBmaFlLeVIwT0V3eWVvdlhRNzl0LwpTV2ZGTjBreU1Pc1UrNVNIdHJKSEh1eWNWcU0yQlVVK083VjM1UnNwOU9MZGRZMFFVbTZldFpEVEhhSUhYYzRRCnl1Rm1OL1NhSFZtNE0wL3BTVlJQdVd6TmpxMnZyRllvSDRtbGhIZk95TUNJMjc2elE2aWhGNkdDSHlkOUJqajcKUm1UWGEyNHM3NWhmSi9YTDV2bnJSdEtpVHJlVHF6V21EOVhnUmNMQ0gyS1hJaVRtSWc9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==" - * } - * } - */ "application/json": { - ca: components["schemas"]["ca"]; + vpc_peering?: components["schemas"]["vpc_peering"]; }; }; }; - /** @description A JSON object. */ - online_migration: { + /** @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"]; @@ -18570,28 +30370,30 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "id": "77b28fc8-19ff-11eb-8c9c-c68e24557488", - * "status": "running", - * "created_at": "2020-10-29T15:57:38Z" - * } - */ - "application/json": components["schemas"]["online_migration"]; + "application/json": { + vpc_peering?: components["schemas"]["vpc_peering"]; + }; }; }; - /** @description The does not indicate the success or failure of any operation, just that the request has been accepted for processing. */ - accepted: { + /** @description A JSON object with a key of `vpc_nat_gateways`. */ + vpc_nat_gateways: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; "ratelimit-reset": components["headers"]["ratelimit-reset"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + vpc_nat_gateways?: components["schemas"]["vpc_nat_gateway_get"][]; + } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; }; - /** @description A JSON object with a key of `rules`. */ - firewall_rules: { + /** + * @description The response will be a JSON object with a key called `vpc_nat_gateway`. This will be + * set to a JSON object that contains the standard VPC NAT gateway attributes. + */ + vpc_nat_gateway_create: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -18599,47 +30401,16 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "rules": [ - * { - * "uuid": "79f26d28-ea8a-41f2-8ad8-8cfcdd020095", - * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", - * "type": "k8s", - * "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61", - * "created_at": "2019-11-14T20:30:28Z" - * }, - * { - * "uuid": "adfe81a8-0fa1-4e2d-973f-06aa5af19b44", - * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", - * "type": "ip_addr", - * "value": "192.168.1.1", - * "created_at": "2019-11-14T20:30:28Z" - * }, - * { - * "uuid": "b9b42276-8295-4313-b40f-74173a7f46e6", - * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", - * "type": "droplet", - * "value": "163973392", - * "created_at": "2019-11-14T20:30:28Z" - * }, - * { - * "uuid": "718d23e0-13d7-4129-8a00-47fb72ee0deb", - * "cluster_uuid": "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", - * "type": "tag", - * "value": "backend", - * "created_at": "2019-11-14T20:30:28Z" - * } - * ] - * } - */ "application/json": { - rules?: components["schemas"]["firewall_rule"][]; + vpc_nat_gateway?: components["schemas"]["vpc_nat_gateway_create"]; }; }; }; - /** @description A JSON object with a key of `database_backups`. */ - database_backups: { + /** + * @description The response will be a JSON object with a key called `vpc_nat_gateway`. This will be + * set to a JSON object that contains the standard VPC NAT gateway attributes. + */ + vpc_nat_gateway: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -18647,27 +30418,16 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "backups": [ - * { - * "created_at": "2019-01-11T18:42:27Z", - * "size_gigabytes": 0.03357696 - * }, - * { - * "created_at": "2019-01-12T18:42:29Z", - * "size_gigabytes": 0.03364864 - * } - * ] - * } - */ "application/json": { - backups: components["schemas"]["backup"][]; + vpc_nat_gateway?: components["schemas"]["vpc_nat_gateway_get"]; }; }; }; - /** @description A JSON object with a key of `replicas`. */ - database_replicas: { + /** + * @description The response will be a JSON object with a key called `vpc_nat_gateway`. This will be + * set to a JSON object that contains the standard VPC NAT gateway attributes. + */ + vpc_nat_gateway_update: { headers: { "ratelimit-limit": components["headers"]["ratelimit-limit"]; "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; @@ -18675,43 +30435,27 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "replicas": [ - * { - * "name": "read-nyc3-01", - * "connection": { - * "uri": "", - * "database": "defaultdb", - * "host": "read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "private_connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "region": "nyc3", - * "status": "online", - * "created_at": "2019-01-11T18:37:36Z" - * } - * ] - * } - */ "application/json": { - replicas?: components["schemas"]["database_replica"][]; + vpc_nat_gateway?: components["schemas"]["vpc_nat_gateway_update"]; }; }; }; - /** @description A JSON object with a key of `replica`. */ - database_replica: { + /** @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"]; @@ -18719,41 +30463,13 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "replica": { - * "name": "read-nyc3-01", - * "connection": { - * "uri": "", - * "database": "defaultdb", - * "host": "read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "private_connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require", - * "database": "", - * "host": "private-read-nyc3-01-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25060, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * }, - * "region": "nyc3", - * "status": "online", - * "created_at": "2019-01-11T18:37:36Z" - * } - * } - */ "application/json": { - replica?: components["schemas"]["database_replica"]; + check?: components["schemas"]["check"]; }; }; }; - /** @description A JSON object with a key of `events`. */ - events_logs: { + /** @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"]; @@ -18761,31 +30477,27 @@ export interface components { [name: string]: unknown; }; content: { - /** - * @example { - * "events": [ - * { - * "id": "pe8u2huh", - * "cluster_name": "customer-events", - * "event_type": "cluster_create", - * "create_time": "2020-10-29T15:57:38Z" - * }, - * { - * "id": "pe8ufefuh", - * "cluster_name": "customer-events", - * "event_type": "cluster_update", - * "create_time": "2023-10-30T15:57:38Z" - * } - * ] - * } - */ "application/json": { - events?: components["schemas"]["events_logs"][]; + state?: components["schemas"]["state"]; }; }; }; - /** @description A JSON object with a key of `users`. */ - users: { + /** @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"]; @@ -18793,4107 +30505,5052 @@ export interface components { [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 + */ + ssh_key_identifier: components["schemas"]["ssh_key_id"] | components["schemas"]["ssh_key_fingerprint"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: number; + /** + * @description A unique identifier for the add-on resource. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + resource_uuid: string; + /** + * @description Whether the project_id of listed apps should be fetched and included. + * @example true + */ + with_projects: boolean; + /** + * @description The content-type that should be used by the response. By default, the response will be `application/json`. `application/yaml` is also supported. + * @example application/json + */ + accept: "application/json" | "application/yaml"; + /** + * @description The content-type used for the request. By default, the requests are assumed to use `application/json`. `application/yaml` is also supported. + * @example application/json + */ + "content-type": "application/json" | "application/yaml"; + /** + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + id_app: string; + /** + * @description The name of the app to retrieve. + * @example myApp + */ + app_name: string; + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: string; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component: string; + /** + * @description Whether the logs should follow live updates. + * @example true + */ + live_updates: boolean; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + log_type: "UNSPECIFIED" | "BUILD" | "DEPLOY" | "RUN" | "RUN_RESTARTED"; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + time_wait: string; + /** + * @description The name of the actively running ephemeral compute instance + * @example go-app-d768568df-zz77d + */ + instance_name: string; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: string; + /** + * @description The job names to list job invocations for. + * @example [ + * "component1", + * "component2" + * ] + */ + job_names: components["schemas"]["schema"][]; + /** + * @description The ID of the job invocation to retrieve. + * @example 123e4567-e89b-12d3-a456-426 + */ + job_invocation_id: string; + /** + * @description The job name to list job invocations for. + * @example component + */ + job_name: string; + /** + * @description The number of lines from the end of the logs to retrieve. + * @example 100 + */ + number_lines: string; + /** + * @description The slug of the instance size + * @example apps-s-1vcpu-0.5gb + */ + slug_size: string; + /** + * @description The alert ID + * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d + */ + alert_id: string; + /** + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + */ + cdn_endpoint_id: string; + /** + * @description Name of expected certificate + * @example certificate-name + */ + certificate_name: string; + /** + * @description A unique identifier for a certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + certificate_id: string; + /** + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 + */ + invoice_uuid: string; + /** + * @description URN of the customer account, can be a team (do:team:uuid) or an organization (do:teamgroup:uuid) + * @example do:team:12345678-1234-1234-1234-123456789012 + */ + account_urn: string; + /** + * @description Start date for billing insights in YYYY-MM-DD format + * @example 2025-01-01 + */ + start_date: string; + /** + * @description End date for billing insights in YYYY-MM-DD format. Must be within 31 days of start_date + * @example 2025-01-31 + */ + end_date: string; + /** + * @description Limits the results to database clusters with a specific tag.

Requires `tag:read` scope. + * @example production + */ + tag_name: string; + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: string; + /** + * @description A unique identifier assigned to the online migration. + * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 + */ + migration_id: string; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: string; + /** + * @description The name of the database user. + * @example app-01 + */ + username: string; + /** + * @description The name of the database. + * @example alpha + */ + database_name: string; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: string; + /** + * @description The name used to identify the Kafka topic. + * @example customer-events + */ + kafka_topic_name: string; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: string; + /** + * @description The name of the Kafka schema subject. + * @example customer-schema + */ + kafka_schema_subject_name: string; + /** + * @description The version of the Kafka schema subject. + * @example 1 + */ + kafka_schema_version: string; + /** + * @description The name of the OpenSearch index. + * @example logs-* + */ + opensearch_index_name: string; + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: string; + /** + * @description A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. + * @example sub.example.com + */ + domain_name_query: string; + /** + * @description The type of the DNS record. For example: A, CNAME, TXT, ... + * @example A + */ + domain_type_query: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SOA" | "SRV" | "TXT"; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: number; + /** + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`.
Requires `tag:read` scope. + * @example env:prod + */ + droplet_tag_name: string; + /** + * @description Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with `tag_name`. + * @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 + */ + droplet_delete_tag_name: string; + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: number; + /** + * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. + * @example true + */ + x_dangerous: boolean; + /** + * @description The name of the autoscale pool + * @example my-autoscale-pool + */ + autoscale_pool_name: string; + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: string; + /** + * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. + * @example true + */ + parameters_x_dangerous: boolean; + /** + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c + */ + firewall_id: string; + /** + * @description A floating IP address. + * @example 45.55.96.47 + */ + floating_ip: string; + /** + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + */ + namespace_id: string; + /** + * @description The name of the trigger to be managed. + * @example my trigger + */ + trigger_name: string; + /** + * @description Filters results based on image type which can be either `application` or `distribution`. + * @example distribution + */ + type: "application" | "distribution"; + /** + * @description Used to filter only user images. + * @example true + */ + private: boolean; + /** + * @description Used to filter images by a specific tag. + * @example base-image + */ + tag: string; + /** + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 + */ + image_id: number; + /** + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af + */ + kubernetes_cluster_id: string; + /** + * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. + * @example 300 + */ + kubernetes_expiry_seconds: number; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + kubernetes_node_pool_id: string; + /** + * @description A unique ID that can be used to reference a node in a Kubernetes node pool. + * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f + */ + kubernetes_node_id: string; + /** + * @description Specifies whether or not to drain workloads from a node before it is deleted. Setting it to `1` causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. + * @example 1 + */ + kubernetes_node_skip_drain: number; + /** + * @description Specifies whether or not to replace a node after it has been deleted. Setting it to `1` causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. + * @example 1 + */ + kubernetes_node_replace: number; + /** + * @description Specifies the clusterlint run whose results will be retrieved. + * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + */ + clusterlint_run_id: string; + /** + * @description A timestamp used to return status messages emitted since the specified time. The timestamp should be in ISO8601 format. + * @example 2018-11-15T16:00:11Z + */ + kubernetes_status_messages_since: string; + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + load_balancer_id: string; + /** + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + alert_uuid: string; + /** + * @description The droplet ID. + * @example 17209102 + */ + parameters_droplet_id: string; + /** + * @description The network interface. + * @example private + */ + network_interface: "private" | "public"; + /** + * @description The traffic direction. + * @example inbound + */ + network_direction: "inbound" | "outbound"; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + metric_timestamp_start: string; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + metric_timestamp_end: string; + /** + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 + */ + parameters_app_id: string; + /** + * @description The app component name. + * @example sample-application + */ + app_component: string; + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + parameters_load_balancer_id: string; + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + parameters_autoscale_pool_id: string; + /** + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + db_id: string; + /** + * @description Aggregation over the time range (avg, max, or min). + * @example avg + */ + aggregate_avg_max_min: "avg" | "max" | "min"; + /** + * @description Load window: **load1** (1-minute), **load5** (5-minute), **load15** (15-minute). The value is either average or max over that window, depending on the **aggregate** parameter (avg or max). + * @example load1 + */ + metric_load: "load1" | "load5" | "load15"; + /** + * @description Aggregation over the time range (avg or max). + * @example avg + */ + aggregate_avg_max: "avg" | "max"; + /** + * @description Operation type (select, insert, update, or delete). + * @example select + */ + metric_op_rates: "select" | "insert" | "update" | "delete"; + /** + * @description The schema (database) name. + * @example defaultdb + */ + schema: string; + /** + * @description Table I/O operation (insert, fetch, update, or delete). + * @example insert + */ + metric_schema_io: "insert" | "fetch" | "update" | "delete"; + /** + * @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 The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 + */ + region: string; + /** + * @description The unique ID of the NFS share + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + */ + nfs_id: string; + /** + * @description The unique ID of an NFS share. If provided, only snapshots of this specific share will be returned. + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + */ + share_id: string; + /** + * @description The unique ID of the NFS snapshot + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + */ + nfs_snapshot_id: string; + /** + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + pa_id: string; + /** + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + project_id: string; + /** + * @description The name of a container registry. + * @example example + */ + registry_name: string; + /** + * @description The UUID of a garbage collection run. + * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 + */ + garbage_collection_uuid: string; + /** + * @description Which 'page' of paginated results to return. Ignored when 'page_token' is provided. + * @example 1 + */ + token_pagination_page: number; + /** + * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. + * @example eyJUb2tlbiI6IkNnZGpiMjlz + */ + token_pagination_page_token: string; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + registry_repository_name: string; + /** + * @description The name of a container registry repository tag. + * @example 06a447a + */ + registry_repository_tag: string; + /** + * @description The manifest digest of a container registry repository tag. + * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 + */ + registry_manifest_digest: string; + /** + * @description The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. + * @example 3600 + */ + registry_expiry_seconds: number; + /** + * @description By default, the registry credentials allow for read-only access. Set this query parameter to `true` to obtain read-write credentials. + * @example true + */ + registry_read_write: boolean; + /** + * @description A reserved IP address. + * @example 45.55.96.47 + */ + reserved_ip: string; + /** + * @description A reserved IPv6 address. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + */ + reserved_ipv6: string; + /** + * @description The unique identifier for the BYOIP Prefix. + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 + */ + byoip_prefix: string; + /** + * @description Used to filter snapshots by a resource type. + * @example droplet + */ + snapshot_resource_type: "droplet" | "volume"; + /** + * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. + * @example 6372321 + */ + snapshot_id: number | string; + /** + * @description The field to sort by. + * @example created_at + */ + sort: string; + /** + * @description The direction to sort by. Possible values are `asc` or `desc`. + * @example desc + */ + sort_direction: string; + /** + * @description The access key's name. + * @example my-access-key + */ + name: string; + /** + * @description The bucket's name. + * @example my-bucket + */ + bucket: string; + /** + * @description The permission of the access key. Possible values are `read`, `readwrite`, `fullaccess`, or an empty string. + * @example read + */ + permission: string; + /** + * @description The access key's ID. + * @example DOACCESSKEYEXAMPLE + */ + access_key_id: string; + /** + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome + */ + tag_id: string; + /** + * @description The block storage volume's name. + * @example example + */ + volume_name: string; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + parameters_region: components["schemas"]["region_slug"]; + /** + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 + */ + volume_snapshot_id: string; + /** + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 + */ + volume_id: string; + /** + * @description A unique identifier for a VPC. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + vpc_id: string; + /** + * @description Used to filter VPC members by a resource type. + * @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 The current state of the VPC NAT gateway. + * @example active + */ + vpc_nat_gateway_state: "new" | "provisioning" | "active" | "deleting" | "error" | "invalid"; + /** + * @description The region where the VPC NAT gateway is located. + * @example tor1 + */ + vpc_nat_gateway_region: "nyc1" | "nyc2" | "nyc3" | "ams2" | "ams3" | "sfo1" | "sfo2" | "sfo3" | "sgp1" | "lon1" | "fra1" | "tor1" | "blr1" | "syd1" | "atl1"; + /** + * @description The type of the VPC NAT gateway. + * @example public + */ + vpc_nat_gateway_type: "public"; + /** + * @description The name of the VPC NAT gateway. + * @example my-vpc-nat-gateway + */ + vpc_nat_gateway_name: string; + /** + * @description The unique identifier of the VPC NAT gateway. + * @example 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + */ + vpc_nat_gateway_id: string; + /** + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + check_id: string; + /** + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + */ + parameters_alert_id: string; + }; + requestBodies: never; + headers: { + /** + * @description The default limit on number of requests that can be made per hour and per minute. Current rate limits are 5000 requests per hour and 250 requests per minute. + * @example 5000 + */ + "ratelimit-limit": number; + /** + * @description The number of requests in your hourly quota that remain before you hit your request limit. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. + * @example 4816 + */ + "ratelimit-remaining": number; + /** + * @description The time when the oldest request will expire. The value is given in Unix epoch time. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. + * @example 1444931833 + */ + "ratelimit-reset": number; + /** + * @description Indicates if the content is expected to be displayed *inline* in the browser, that is, as a Web page or as part of a Web page, or as an *attachment*, that is downloaded and saved locally. + * @example attachment; filename="DigitalOcean Invoice 2020 Jul (6173678-418071234).csv" + */ + "content-disposition": string; + /** + * @description The type of data that is returned from a request. + * @example application/json; charset=utf-8 + */ + "content-type": string; + /** + * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. + * @example 515850a0-a812-50bf-aa3c-d0d21d287e40 + */ + "x-request-id": string; + }; + pathItems: never; +} +export type $defs = Record; +export interface operations { + oneClicks_list: { + parameters: { + query?: { /** - * @example { - * "users": [ - * { - * "name": "app-01", - * "role": "normal", - * "password": "jge5lfxtzhx42iff" - * }, - * { - * "name": "doadmin", - * "role": "primary", - * "password": "wv78n3zpz42xezd" - * } - * ] - * } + * @description Restrict results to a certain type of 1-Click. + * @example kubernetes */ - "application/json": { - users?: components["schemas"]["database_user"][]; - }; + type?: components["parameters"]["oneClicks_type"]; }; + header?: never; + path?: never; + cookie?: never; }; - /** @description A JSON object with a key of `user`. */ - user: { - 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": { - user: components["schemas"]["database_user"]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["oneClicks_all"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description A JSON object with a key of `databases`. */ - databases: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "dbs": [ - * { - * "name": "alpha" - * }, - * { - * "name": "defaultdb" - * } - * ] - * } - */ - "application/json": { - dbs?: components["schemas"]["database"][]; - }; - }; + }; + oneClicks_install_kubernetes: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description A JSON object with a key of `db`. */ - database: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - /** - * @example { - * "db": { - * "name": "alpha" - * } - * } - */ - "application/json": { - db: components["schemas"]["database"]; - }; + "application/json": components["schemas"]["oneClicks_create"]; }; }; - /** @description A JSON object with a key of `pools`. */ - connection_pools: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "pools": [ - * { - * "user": "doadmin", - * "name": "reporting-pool", - * "size": 10, - * "db": "defaultdb", - * "mode": "session", - * "connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/foo?sslmode=require", - * "database": "foo", - * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25061, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * } - * }, - * { - * "user": "doadmin", - * "name": "backend-pool", - * "size": 10, - * "db": "defaultdb", - * "mode": "transaction", - * "connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/backend-pool?sslmode=require", - * "database": "backend-pool", - * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25061, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * } - * } - * ] - * } - */ - "application/json": components["schemas"]["connection_pools"]; - }; + responses: { + 200: components["responses"]["oneClicks_create"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description A JSON object with a key of `pool`. */ - connection_pool: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "pool": { - * "user": "doadmin", - * "name": "backend-pool", - * "size": 10, - * "db": "defaultdb", - * "mode": "transaction", - * "connection": { - * "uri": "postgres://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25061/backend-pool?sslmode=require", - * "database": "backend-pool", - * "host": "backend-do-user-19081923-0.db.ondigitalocean.com", - * "port": 25061, - * "user": "doadmin", - * "password": "wv78n3zpz42xezdk", - * "ssl": true - * } - * } - * } - */ - "application/json": { - pool: components["schemas"]["connection_pool"]; - }; - }; + }; + account_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description A JSON string with a key of `eviction_policy`. */ - eviction_policy_response: { - 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": { - eviction_policy: components["schemas"]["eviction_policy_model"]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["account"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description A JSON string with a key of `sql_mode`. */ - sql_mode: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + }; + sshKeys_list: { + parameters: { + query?: { /** - * @example { - * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES" - * } + * @description Number of items returned per page + * @example 2 */ - "application/json": components["schemas"]["sql_mode"]; - }; - }; - /** @description A JSON object with a key of `topics`. */ - kafka_topics: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + per_page?: components["parameters"]["per_page"]; /** - * @example { - * "topics": [ - * { - * "name": "customer-events", - * "state": "active", - * "replication_factor": 2, - * "partition_count": 3 - * }, - * { - * "name": "engineering-events", - * "state": "configuring", - * "replication_factor": 2, - * "partition_count": 10 - * } - * ] - * } + * @description Which 'page' of paginated results to return. + * @example 1 */ - "application/json": { - topics?: components["schemas"]["kafka_topic"][]; - }; + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; - /** @description A JSON object with a key of `topic`. */ - kafka_topic: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "topic": { - * "name": "customer-events", - * "partitions": [ - * { - * "size": 4096, - * "id": 0, - * "in_sync_replicas": 3, - * "earliest_offset": 0, - * "consumer_groups": [ - * { - * "name": "consumer-group-1", - * "offset": 0 - * }, - * { - * "name": "consumer-group-2", - * "offset": 1 - * } - * ] - * }, - * { - * "size": 4096, - * "id": 1, - * "in_sync_replicas": 3, - * "earliest_offset": 0, - * "consumer_groups": null - * } - * ], - * "replication_factor": 3, - * "state": "active", - * "config": { - * "cleanup_policy": "delete", - * "compression_type": "producer", - * "delete_retention_ms": 86400000, - * "file_delete_delay_ms": 60000, - * "flush_messages": 9223372036854776000, - * "flush_ms": 9223372036854776000, - * "index_interval_bytes": 4096, - * "max_compaction_lag_ms": 9223372036854776000, - * "max_message_bytes": 1048588, - * "message_down_conversion_enable": true, - * "message_format_version": "3.0-IV1", - * "message_timestamp_difference_max_ms": 9223372036854776000, - * "message_timestamp_type": "create_time", - * "min_cleanable_dirty_ratio": 0.5, - * "min_compaction_lag_ms": 0, - * "min_insync_replicas": 1, - * "preallocate": false, - * "retention_bytes": -1, - * "retention_ms": 604800000, - * "segment_bytes": 209715200, - * "segment_index_bytes": 10485760, - * "segment_jitter_ms": 0, - * "segment_ms": 604800000 - * } - * } - * } - */ - "application/json": { - topic?: components["schemas"]["kafka_topic_verbose"]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["sshKeys_all"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description A JSON object with a key of `sinks`. */ - logsinks: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "sinks": [ - * { - * "sink_id": "799990b6-d551-454b-9ffe-b8618e9d6272", - * "sink_name": "logs-sink-1", - * "sink_type": "rsyslog", - * "config": { - * "server": "192.168.0.1", - * "port": 514, - * "tls": false, - * "format": "rfc5424" - * } - * }, - * { - * "sink_id": "d6e95157-5f58-48d0-9023-8cfb409d102a", - * "sink_name": "logs-sink-2", - * "sink_type": "rsyslog", - * "config": { - * "server": "192.168.10.1", - * "port": 514, - * "tls": false, - * "format": "rfc3164" - * } - * } - * ] - * } - */ - "application/json": { - sinks?: components["schemas"]["logsink_verbose"][]; - }; - }; + }; + sshKeys_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** @description A JSON object with a key of `sink`. */ - logsink: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": { - sink?: components["schemas"]["logsink_verbose"]; - }; + "application/json": components["schemas"]["sshKeys"]; }; }; - /** @description A JSON object with a key of `credentials`. */ - database_metrics_auth: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - /** - * @example { - * "credentials": { - * "basic_auth_username": "username", - * "basic_auth_password": "password" - * } - * } - */ - "application/json": { - credentials?: components["schemas"]["database_metrics_credentials"]; - }; - }; + responses: { + 201: components["responses"]["sshKeys_new"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description A JSON object with a key of `indexes`. */ - opensearch_indexes: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + }; + sshKeys_get: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "indexes": [ - * { - * "index_name": "sample-data", - * "number_of_shards": 2, - * "number_of_replicas": 3, - * "size": 208, - * "created_time": "2021-01-01T00:00:00Z", - * "status": "open", - * "health": "green" - * }, - * { - * "index_name": "logs-*", - * "number_of_shards": 2, - * "number_of_replicas": 3, - * "size": 208, - * "created_time": "2021-01-01T00:00:00Z", - * "status": "open", - * "health": "green" - * } - * ] - * } + * @description Either the ID or the fingerprint of an existing SSH key. + * @example 512189 */ - "application/json": { - indexes?: components["schemas"]["opensearch_index"][]; - }; - }; - }; - /** @description The response will be a JSON object with a key called `domains`. The value of this will be an array of Domain objects, each of which contain the standard domain attributes. */ - all_domains_response: { - 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 Array of volumes. */ - domains: components["schemas"]["domain"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes associated with a domain. */ - create_domain_response: { - 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": { - domain?: components["schemas"]["domain"]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["sshKeys_existing"]; + 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"]; }; - /** @description The response will be a JSON object with a key called `domain`. The value of this will be an object that contains the standard attributes defined for a domain. */ - existing_domain: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + }; + sshKeys_update: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Either the ID or the fingerprint of an existing SSH key. + * @example 512189 + */ + ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; }; + cookie?: never; + }; + /** @description Set the `name` attribute to the new name you want to use. */ + requestBody: { content: { "application/json": { - domain?: components["schemas"]["domain"]; + name?: components["schemas"]["ssh_key_name"]; }; }; }; - /** @description The response will be a JSON object with a key called `domain_records`. The value of this will be an array of domain record objects, each of which contains the standard domain record attributes. For attributes that are not used by a specific record type, a value of `null` will be returned. For instance, all records other than SRV will have `null` for the `weight` and `port` attributes. */ - all_domain_records_response: { - 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": { - domain_records?: components["schemas"]["domain_record"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + responses: { + 200: components["responses"]["sshKeys_existing"]; + 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"]; }; - /** @description The response body will be a JSON object with a key called `domain_record`. The value of this will be an object representing the new record. Attributes that are not applicable for the record type will be set to `null`. An `id` attribute is generated for each record as part of the object. */ - created_domain_record: { - 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": { - domain_record?: components["schemas"]["domain_record"]; - }; + }; + sshKeys_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description Either the ID or the fingerprint of an existing SSH key. + * @example 512189 + */ + ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `domain_record`. The value of this will be a domain record object which contains the standard domain record attributes. */ - domain_record: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + 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"]; + }; + }; + actions_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"]; }; - content: { - "application/json": { - domain_record?: components["schemas"]["domain_record"]; - }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["actions"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + actions_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; }; + cookie?: never; }; - /** @description A JSON object with a key of `droplets`. */ - all_droplets: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["action"]; + 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"]; + }; + }; + addons_get_app: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["addons_get_app"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + addons_get_app_metadata: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The slug identifier for the application whose metadata is being requested. + * @example example_app + */ + app_slug: string; }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["addons_get_app_metadata"]; + 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"]; + }; + }; + addons_list: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["addons_list"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + addons_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - droplets?: components["schemas"]["droplet"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": WithRequired; }; }; - /** @description Accepted */ - droplet_create: { - 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": { - droplet: components["schemas"]["droplet"]; - links: { - actions?: components["schemas"]["action_link"][]; - }; - } | { - droplets: components["schemas"]["droplet"][]; - links: { - actions?: components["schemas"]["action_link"][]; - }; - }; + responses: { + 200: components["responses"]["addons_create"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + addons_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The UUID of the add-on resource to retrieve. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + resource_uuid: string; }; + cookie?: never; }; - /** @description The action was successful and the response body is empty. This response has content-type set. */ - no_content_with_content_type: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - "content-type": components["headers"]["content-type"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["addons_get"]; + 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"]; + }; + }; + addons_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for the add-on resource. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + resource_uuid: components["parameters"]["resource_uuid"]; }; - content?: never; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `droplet`. This will be - * set to a JSON object that contains the standard Droplet attributes. - */ - existing_droplet: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: 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"]; + }; + }; + addons_patch: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The UUID of the add-on resource to rename. + * @example 123e4567-e89b-12d3-a456-426614174000 + */ + resource_uuid: string; }; + cookie?: never; + }; + requestBody: { content: { "application/json": { - droplet?: components["schemas"]["droplet"]; + /** + * @description The new name for the add-on resource. + * @example new-name + */ + name: string; }; }; }; - /** @description A JSON object with an `backups` key. */ - all_droplet_backups: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + responses: { + 200: components["responses"]["addons_update"]; + 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"]; + }; + }; + addons_patch_plan: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "backups": [ - * { - * "id": 67539192, - * "name": "web-01- 2020-07-29", - * "distribution": "Ubuntu", - * "slug": null, - * "public": false, - * "regions": [ - * "nyc3" - * ], - * "created_at": "2020-07-29T01:44:35Z", - * "min_disk_size": 50, - * "size_gigabytes": 2.34, - * "type": "backup" - * } - * ], - * "links": {}, - * "meta": { - * "total": 1 - * } - * } + * @description The UUID of the add-on resource to update. + * @example 123e4567-e89b-12d3-a456-426614174000 */ - "application/json": { - backups?: components["schemas"]["droplet_snapshot"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + resource_uuid: string; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `policy`. This will be - * set to a JSON object that contains the standard Droplet backup policy attributes. - */ - droplet_backup_policy: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - /** - * @example { - * "policy": { - * "droplet_id": 444909706, - * "backup_enabled": true, - * "backup_policy": { - * "plan": "weekly", - * "weekday": "SUN", - * "hour": 20, - * "window_length_hours": 4, - * "retention_period_days": 28 - * }, - * "next_backup_window": { - * "start": "2024-09-15T20:00:00Z", - * "end": "2024-09-16T00:00:00Z" - * } - * } - * } - */ "application/json": { - policy?: components["schemas"]["droplet_backup_policy_record"]; + /** + * @description The slug identifier for the new plan to apply to the add-on resource. + * @example basic_plan + */ + plan_slug: string; }; }; }; - /** @description A JSON object with a `policies` key set to a map. The keys are Droplet IDs and the values are objects containing the backup policy information for each Droplet. */ - all_droplet_backup_policies: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + responses: { + 200: components["responses"]["addons_update"]; + 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"]; + }; + }; + apps_list: { + parameters: { + query?: { /** - * @example { - * "policies": { - * "436444618": { - * "droplet_id": 436444618, - * "backup_enabled": false - * }, - * "444909314": { - * "droplet_id": 444909314, - * "backup_enabled": true, - * "backup_policy": { - * "plan": "daily", - * "hour": 20, - * "window_length_hours": 4, - * "retention_period_days": 7 - * }, - * "next_backup_window": { - * "start": "2024-09-13T20:00:00Z", - * "end": "2024-09-14T00:00:00Z" - * } - * }, - * "444909706": { - * "droplet_id": 444909706, - * "backup_enabled": true, - * "backup_policy": { - * "plan": "weekly", - * "weekday": "SUN", - * "hour": 20, - * "window_length_hours": 4, - * "retention_period_days": 28 - * }, - * "next_backup_window": { - * "start": "2024-09-15T20:00:00Z", - * "end": "2024-09-16T00:00:00Z" - * } - * } - * }, - * "links": {}, - * "meta": { - * "total": 3 - * } - * } + * @description Which 'page' of paginated results to return. + * @example 1 */ - "application/json": { - /** - * @description A map where the keys are the Droplet IDs and the values are - * objects containing the backup policy information for each Droplet. - */ - policies?: { - [key: string]: components["schemas"]["droplet_backup_policy_record"]; - }; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + page?: components["parameters"]["page"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Whether the project_id of listed apps should be fetched and included. + * @example true + */ + with_projects?: components["parameters"]["with_projects"]; }; + header?: never; + path?: never; + cookie?: never; }; - /** @description A JSON object with an `supported_policies` key set to an array of objects describing each supported backup policy. */ - droplets_supported_backup_policies: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + requestBody?: never; + responses: { + 200: components["responses"]["list_apps"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_create: { + parameters: { + query?: never; + header?: { /** - * @example { - * "supported_policies": [ - * { - * "name": "weekly", - * "possible_window_starts": [ - * 0, - * 4, - * 8, - * 12, - * 16, - * 20 - * ], - * "window_length_hours": 4, - * "retention_period_days": 28, - * "possible_days": [ - * "SUN", - * "MON", - * "TUE", - * "WED", - * "THU", - * "FRI", - * "SAT" - * ] - * }, - * { - * "name": "daily", - * "possible_window_starts": [ - * 0, - * 4, - * 8, - * 12, - * 16, - * 20 - * ], - * "window_length_hours": 4, - * "retention_period_days": 7, - * "possible_days": [] - * } - * ] - * } + * @description The content-type that should be used by the response. By default, the response will be `application/json`. `application/yaml` is also supported. + * @example application/json + */ + Accept?: components["parameters"]["accept"]; + /** + * @description The content-type used for the request. By default, the requests are assumed to use `application/json`. `application/yaml` is also supported. + * @example application/json */ - "application/json": { - supported_policies?: components["schemas"]["supported_droplet_backup_policy"][]; - }; + "Content-Type"?: components["parameters"]["content-type"]; }; + path?: never; + cookie?: never; }; - /** @description A JSON object with an `snapshots` key. */ - all_droplet_snapshots: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { /** * @example { - * "snapshots": [ - * { - * "id": 6372321, - * "name": "web-01-1595954862243", - * "created_at": "2020-07-28T16:47:44Z", - * "regions": [ - * "nyc3", - * "sfo3" - * ], - * "min_disk_size": 25, - * "size_gigabytes": 2.34, - * "type": "snapshot" + * "spec": { + * "name": "web-app", + * "region": "nyc", + * "disable_edge_cache": true, + * "disable_email_obfuscation": false, + * "enhanced_threat_control_enabled": true, + * "services": [ + * { + * "name": "api", + * "github": { + * "branch": "main", + * "deploy_on_push": true, + * "repo": "digitalocean/sample-golang" + * }, + * "run_command": "bin/api", + * "environment_slug": "node-js", + * "instance_count": 2, + * "instance_size_slug": "apps-s-1vcpu-0.5gb", + * "routes": [ + * { + * "path": "/api" + * } + * ] + * } + * ], + * "egress": { + * "type": "DEDICATED_IP" + * }, + * "vpc": { + * "id": "c22d8f48-4bc4-49f5-8ca0-58e7164427ac" * } - * ], - * "links": {}, - * "meta": { - * "total": 1 * } * } */ - "application/json": { - snapshots?: components["schemas"]["droplet_snapshot"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["apps_create_app_request"]; }; }; - /** @description A JSON object with an `actions` key. */ - all_droplet_actions: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["new_app"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_get: { + parameters: { + query?: { + /** + * @description The name of the app to retrieve. + * @example myApp + */ + name?: components["parameters"]["app_name"]; }; - content: { + header?: never; + path: { /** - * @example { - * "actions": [ - * { - * "id": 982864273, - * "status": "completed", - * "type": "create", - * "started_at": "2020-07-20T19:37:30Z", - * "completed_at": "2020-07-20T19:37:45Z", - * "resource_id": 3164444, - * "resource_type": "droplet", - * "region": { - * "name": "New York 3", - * "slug": "nyc3", - * "features": [ - * "private_networking", - * "backups", - * "ipv6", - * "metadata", - * "install_agent", - * "image_transfer" - * ], - * "available": true, - * "sizes": [ - * "s-1vcpu-1gb", - * "s-1vcpu-2gb", - * "s-3vcpu-1gb", - * "s-2vcpu-2gb", - * "s-1vcpu-3gb", - * "s-2vcpu-4gb", - * "s-4vcpu-8gb", - * "m-1vcpu-8gb", - * "s-6vcpu-16gb", - * "s-8vcpu-32gb", - * "s-12vcpu-48gb" - * ] - * }, - * "region_slug": "nyc3" - * } - * ], - * "links": {}, - * "meta": { - * "total": 1 - * } - * } + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + id: components["parameters"]["id_app"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `action`. */ - droplet_action: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["apps_get"]; + 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"]; + }; + }; + apps_update: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + id: components["parameters"]["id_app"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - action?: components["schemas"]["action"]; - }; + "application/json": components["schemas"]["apps_update_app_request"]; }; }; - /** @description The response will be a JSON object with a key called `actions`. */ - droplet_actions_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["update_app"]; + 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"]; + }; + }; + apps_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The ID of the app + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + id: components["parameters"]["id_app"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete_app"]; + 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"]; + }; + }; + apps_restart: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; + cookie?: never; + }; + requestBody?: { content: { - "application/json": { - actions?: components["schemas"]["action"][]; - }; + "application/json": components["schemas"]["apps_restart_request"]; }; }; - /** @description A JSON object that has a key called `kernels`. */ - all_kernels: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["new_app_deployment"]; + 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"]; + }; + }; + apps_get_logs_active_deployment: { + parameters: { + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; }; - content: { + header?: never; + path: { /** - * @example { - * "kernels": [ - * { - * "id": 7515, - * "name": "DigitalOcean GrubLoader v0.2 (20160714)", - * "version": "2016.07.13-DigitalOcean_loader_Ubuntu" - * } - * ], - * "links": { - * "pages": { - * "next": "https://api.digitalocean.com/v2/droplets/3164444/kernels?page=2&per_page=1", - * "last": "https://api.digitalocean.com/v2/droplets/3164444/kernels?page=171&per_page=1" - * } - * }, - * "meta": { - * "total": 171 - * } - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - kernels?: components["schemas"]["kernel"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + app_id: components["parameters"]["app_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; }; + cookie?: never; }; - /** @description A JSON object that has a key called `firewalls`. */ - all_firewalls: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["list_logs"]; + 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"]; + }; + }; + apps_get_exec_active_deployment: { + parameters: { + query?: { + /** + * @description The name of the actively running ephemeral compute instance + * @example go-app-d768568df-zz77d + */ + instance_name?: components["parameters"]["instance_name"]; }; - content: { + header?: never; + path: { /** - * @example { - * "firewalls": [ - * { - * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", - * "status": "succeeded", - * "created_at": "2020-05-23T21:24:00Z", - * "pending_changes": [ - * { - * "droplet_id": 8043964, - * "removing": true, - * "status": "waiting" - * } - * ], - * "name": "firewall", - * "droplet_ids": [ - * 89989, - * 33322 - * ], - * "tags": [ - * "base-image", - * "prod" - * ], - * "inbound_rules": [ - * { - * "protocol": "udp", - * "ports": "8000-9000", - * "sources": { - * "addresses": [ - * "1.2.3.4", - * "18.0.0.0/8" - * ], - * "droplet_ids": [ - * 8282823, - * 3930392 - * ], - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ], - * "tags": [ - * "base-image", - * "dev" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "7000-9000", - * "destinations": { - * "addresses": [ - * "1.2.3.4", - * "18.0.0.0/8" - * ], - * "droplet_ids": [ - * 3827493, - * 213213 - * ], - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ], - * "tags": [ - * "base-image", - * "prod" - * ] - * } - * } - * ] - * } - * ], - * "links": { - * "pages": {} - * }, - * "meta": { - * "total": 1 - * } - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_exec"]; + 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"]; + }; + }; + apps_get_instances: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["apps_instances"]; + 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"]; + }; + }; + apps_list_deployments: { + parameters: { + query?: { + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; + /** + * @description Optional. Filter deployments by deployment_type + * - MANUAL: manual deployment + * - DEPLOY_ON_PUSH: deployment triggered by a push to the app's repository + * - MAINTENANCE: deployment for maintenance purposes + * - MANUAL_ROLLBACK: manual revert to a previous deployment + * - AUTO_ROLLBACK: automatic revert to a previous deployment + * - UPDATE_DATABASE_TRUSTED_SOURCES: update database trusted sources + * - AUTOSCALED: deployment that has been autoscaled + * @example [ + * "MANUAL", + * "AUTOSCALED" + * ] + */ + deployment_types?: ("MANUAL" | "DEPLOY_ON_PUSH" | "MAINTENANCE" | "MANUAL_ROLLBACK" | "AUTO_ROLLBACK" | "UPDATE_DATABASE_TRUSTED_SOURCES" | "AUTOSCALED")[]; + }; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["existing_deployments"]; + 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"]; + }; + }; + apps_create_deployment: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["apps_create_deployment_request"]; + }; + }; + responses: { + 200: components["responses"]["new_app_deployment"]; + 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"]; + }; + }; + apps_get_deployment: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - firewalls?: components["schemas"]["firewall"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; }; + cookie?: never; }; - /** @description A JSON object with an `droplets` key. */ - neighbor_droplets: { - 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": { - droplets?: components["schemas"]["droplet"][]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["list_deployment"]; + 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"]; }; - /** @description A JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. */ - associated_resources_list: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + }; + apps_cancel_deployment: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "reserved_ips": [ - * { - * "id": "6186916", - * "name": "45.55.96.47", - * "cost": "4.00" - * } - * ], - * "floating_ips": [ - * { - * "id": "6186916", - * "name": "45.55.96.47", - * "cost": "4.00" - * } - * ], - * "snapshots": [ - * { - * "id": "61486916", - * "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", - * "cost": "0.05" - * } - * ], - * "volumes": [ - * { - * "id": "ba49449a-7435-11ea-b89e-0a58ac14480f", - * "name": "volume-nyc1-01", - * "cost": "10.00" - * } - * ], - * "volume_snapshots": [ - * { - * "id": "edb0478d-7436-11ea-86e6-0a58ac144b91", - * "name": "volume-nyc1-01-1585758983629", - * "cost": "0.04" - * } - * ] - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - reserved_ips?: components["schemas"]["associated_resource"][]; - floating_ips?: components["schemas"]["associated_resource"][]; - snapshots?: components["schemas"]["associated_resource"][]; - volumes?: components["schemas"]["associated_resource"][]; - volume_snapshots?: components["schemas"]["associated_resource"][]; - }; + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; }; + cookie?: never; }; - /** @description A JSON object containing containing the status of a request to destroy a Droplet and its associated resources. */ - associated_resources_status: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["cancel_deployment"]; + 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"]; + }; + }; + apps_get_logs: { + parameters: { + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; }; - content: { + header?: never; + path: { /** - * @example { - * "droplet": { - * "id": "187000742", - * "name": "ubuntu-s-1vcpu-1gb-nyc1-01", - * "destroyed_at": "2020-04-01T18:11:49Z" - * }, - * "resources": { - * "reserved_ips": [ - * { - * "id": "6186916", - * "name": "45.55.96.47", - * "destroyed_at": "2020-04-01T18:11:44Z" - * } - * ], - * "floating_ips": [ - * { - * "id": "6186916", - * "name": "45.55.96.47", - * "destroyed_at": "2020-04-01T18:11:44Z" - * } - * ], - * "snapshots": [ - * { - * "id": "61486916", - * "name": "ubuntu-s-1vcpu-1gb-nyc1-01-1585758823330", - * "destroyed_at": "2020-04-01T18:11:44Z" - * } - * ], - * "volumes": [], - * "volume_snapshots": [ - * { - * "id": "edb0478d-7436-11ea-86e6-0a58ac144b91", - * "name": "volume-nyc1-01-1585758983629", - * "destroyed_at": "2020-04-01T18:11:44Z" - * } - * ] - * }, - * "completed_at": "2020-04-01T18:11:49Z", - * "failures": 0 - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": components["schemas"]["associated_resource_status"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; }; + cookie?: never; }; - /** @description Conflict */ - conflict: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["list_logs"]; + 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"]; + }; + }; + apps_get_logs_aggregate: { + parameters: { + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; }; - content: { + header?: never; + path: { /** - * @example { - * "id": "conflict", - * "message": "The request could not be completed due to a conflict." - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": components["schemas"]["error"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; }; + cookie?: never; }; - /** @description A JSON object with a key of `autoscale_pools`. */ - all_autoscale_pools: { - 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": { - autoscale_pools?: components["schemas"]["autoscale_pool"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["list_logs"]; + 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"]; }; - /** @description Accepted */ - autoscale_pool_create: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + }; + apps_get_exec: { + parameters: { + query?: { + /** + * @description The name of the actively running ephemeral compute instance + * @example go-app-d768568df-zz77d + */ + instance_name?: components["parameters"]["instance_name"]; }; - content: { - "application/json": { - autoscale_pool?: components["schemas"]["autoscale_pool"]; - }; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id: components["parameters"]["deployment_id"]; + /** + * @description An optional component name. If set, logs will be limited to this component only. + * @example component + */ + component_name: components["parameters"]["component"]; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `autoscale_pool`. This will be - * set to a JSON object that contains the standard autoscale pool attributes. - */ - existing_autoscale_pool: { - 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": { - autoscale_pool?: components["schemas"]["autoscale_pool"]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["get_exec"]; + 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"]; }; - /** @description A JSON object with a key of `droplets`. */ - all_members: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + }; + apps_get_logs_active_deployment_aggregate: { + parameters: { + query: { + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * - BUILD: Build-time logs + * - DEPLOY: Deploy-time logs + * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime + * @example BUILD + */ + type: components["parameters"]["log_type"]; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; }; - content: { - "application/json": { - droplets?: components["schemas"]["member"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** @description A JSON object with a key of `history`. */ - history_events: { - 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": { - history?: components["schemas"]["history"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["list_logs"]; + 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"]; }; - /** @description To list all of the firewalls available on your account, send a GET request to `/v2/firewalls`. */ - list_firewalls_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + }; + apps_list_job_invocations: { + parameters: { + query?: { + /** + * @description The job names to list job invocations for. + * @example [ + * "component1", + * "component2" + * ] + */ + job_names?: components["parameters"]["job_names"]; + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id?: string; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; }; - content: { + header?: never; + path: { /** - * @example { - * "firewalls": [ - * { - * "id": "fb6045f1-cf1d-4ca3-bfac-18832663025b", - * "name": "firewall", - * "status": "succeeded", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "created_at": "2017-05-23T21:23:59Z", - * "droplet_ids": [ - * 8043964 - * ], - * "tags": [], - * "pending_changes": [] - * } - * ], - * "links": {}, - * "meta": { - * "total": 1 - * } - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - firewalls?: components["schemas"]["firewall"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes */ - create_firewall_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["list_job_invocations"]; + 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"]; + }; + }; + apps_get_job_invocation: { + parameters: { + query?: { + /** + * @description The job name to list job invocations for. + * @example component + */ + job_name?: components["parameters"]["job_name"]; }; - content: { + header?: never; + path: { /** - * @example { - * "firewall": { - * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", - * "name": "firewall", - * "status": "waiting", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "created_at": "2017-05-23T21:24:00Z", - * "droplet_ids": [ - * 8043964 - * ], - * "tags": [], - * "pending_changes": [ - * { - * "droplet_id": 8043964, - * "removing": false, - * "status": "waiting" - * } - * ] - * } - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - firewall?: components["schemas"]["firewall"]; - }; + app_id: components["parameters"]["app_id"]; + /** + * @description The ID of the job invocation to retrieve. + * @example 123e4567-e89b-12d3-a456-426 + */ + job_invocation_id: components["parameters"]["job_invocation_id"]; }; + cookie?: never; }; - /** @description Bad Request */ - bad_request: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["get_job_invocation"]; + 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"]; + }; + }; + apps_cancel_job_invocation: { + parameters: { + query?: { + /** + * @description The job name to list job invocations for. + * @example component + */ + job_name?: components["parameters"]["job_name"]; }; - content: { + header?: never; + path: { /** - * @example { - * "id": "bad_request", - * "message": "error parsing request body", - * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": components["schemas"]["error"]; + app_id: components["parameters"]["app_id"]; + /** + * @description The ID of the job invocation to retrieve. + * @example 123e4567-e89b-12d3-a456-426 + */ + job_invocation_id: components["parameters"]["job_invocation_id"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a firewall key. This will be set to an object containing the standard firewall attributes. */ - get_firewall_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["cancel_job_invocation"]; + 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"]; + }; + }; + apps_get_job_invocation_logs: { + parameters: { + query: { + /** + * @description The deployment ID + * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + */ + deployment_id?: string; + /** + * @description Whether the logs should follow live updates. + * @example true + */ + follow?: components["parameters"]["live_updates"]; + /** + * @description The type of logs to retrieve + * @example JOB_INVOCATION + */ + type: "JOB_INVOCATION"; + /** + * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. + * @example 3m + */ + pod_connection_timeout?: components["parameters"]["time_wait"]; + /** + * @description The number of lines from the end of the logs to retrieve. + * @example 100 + */ + tail_lines?: components["parameters"]["number_lines"]; }; - content: { + header?: never; + path: { /** - * @example { - * "firewall": { - * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", - * "name": "firewall", - * "status": "succeeded", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "created_at": "2017-05-23T21:24:00Z", - * "droplet_ids": [ - * 8043964 - * ], - * "tags": [], - * "pending_changes": [] - * } - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": { - firewall?: components["schemas"]["firewall"]; - }; + app_id: components["parameters"]["app_id"]; + /** + * @description The job name to list job invocations for. + * @example component + */ + job_name: string; + /** + * @description The ID of the job invocation to retrieve. + * @example 123e4567-e89b-12d3-a456-426 + */ + job_invocation_id: components["parameters"]["job_invocation_id"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a `firewall` key. This will be set to an object containing the standard firewall attributes. */ - put_firewall_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["apps_get_logs"]; + 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"]; + }; + }; + apps_list_instanceSizes: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_instance"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_get_instanceSize: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The slug of the instance size + * @example apps-s-1vcpu-0.5gb + */ + slug: components["parameters"]["slug_size"]; }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_instance"]; + 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"]; + }; + }; + apps_list_regions: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["list_regions"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + apps_validate_appSpec: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { /** * @example { - * "firewall": { - * "id": "bb4b2611-3d72-467b-8602-280330ecd65c", - * "name": "frontend-firewall", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "created_at": "2020-05-23T21:24:00Z", - * "droplet_ids": [ - * 8043964 - * ], - * "tags": [ - * "frontend" - * ], - * "status": "waiting", - * "pending_changes": [ + * "spec": { + * "name": "web-app", + * "region": "nyc", + * "services": [ * { - * "droplet_id": 8043964, - * "removing": false, - * "status": "waiting" + * "name": "api", + * "github": { + * "branch": "main", + * "deploy_on_push": true, + * "repo": "digitalocean/sample-golang" + * }, + * "run_command": "bin/api", + * "environment_slug": "node-js", + * "instance_count": 2, + * "instance_size_slug": "apps-s-1vcpu-0.5gb", + * "routes": [ + * { + * "path": "/api" + * } + * ] * } * ] - * } + * }, + * "app_id": "b6bdf840-2854-4f87-a36c-5f231c617c84" * } */ - "application/json": { - firewall?: components["schemas"]["firewall"]; - }; + "application/json": components["schemas"]["app_propose"]; }; }; - /** @description The response will be a JSON object with a key called `floating_ips`. This will be set to an array of floating IP objects, each of which will contain the standard floating IP attributes */ - floating_ip_list: { - 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": { - floating_ips?: components["schemas"]["floating_ip"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + responses: { + 200: components["responses"]["propose_app"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** - * @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. - * When assigning a floating IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. - */ - floating_ip_created: { - 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": { - floating_ip?: components["schemas"]["floating_ip"]; - links?: { - droplets?: components["schemas"]["action_link"][]; - actions?: components["schemas"]["action_link"][]; - }; - }; + }; + apps_list_alerts: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `floating_ip`. The value of this will be an object that contains the standard attributes associated with a floating IP. */ - floating_ip: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["list_alerts"]; + 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"]; + }; + }; + apps_assign_alertDestinations: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; + /** + * @description The alert ID + * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d + */ + alert_id: components["parameters"]["alert_id"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - floating_ip?: components["schemas"]["floating_ip"]; - }; + "application/json": components["schemas"]["apps_assign_app_alert_destinations_request"]; }; }; - /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard floating IP action attributes. */ - floating_ip_actions: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["assign_alert_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"]; + }; + }; + apps_create_rollback: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + "application/json": components["schemas"]["apps_rollback_app_request"]; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard floating IP action attributes. */ - floating_ip_action: { - 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": { - action?: components["schemas"]["action"] & { - /** - * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. - * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 - */ - project_id?: string; - }; - }; + responses: { + 200: components["responses"]["new_app_deployment"]; + 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"]; + }; + }; + apps_validate_rollback: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** - * @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains - * the properties associated with it. - */ - list_namespaces: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": { - namespaces?: components["schemas"]["namespace_info"][]; - }; + "application/json": components["schemas"]["apps_rollback_app_request"]; }; }; - /** - * @description A JSON response object with a key called `namespace`. The object contains the properties associated - * with the namespace. - */ - namespace_created: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["apps_validate_rollback"]; + 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"]; + }; + }; + apps_commit_rollback: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; - content: { - "application/json": { - namespace?: components["schemas"]["namespace_info"]; - }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: 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"]; + }; + }; + apps_revert_rollback: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + */ + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** @description Bad Request. */ - namespace_bad_request: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["new_app_deployment"]; + 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"]; + }; + }; + apps_get_metrics_bandwidth_daily: { + parameters: { + query?: { + /** + * @description Optional day to query. Only the date component of the timestamp will be considered. Default: yesterday. + * @example 2023-01-17T00:00:00Z + */ + date?: string; }; - content: { + header?: never; + path: { /** - * @example { - * "id": "bad_request", - * "message": "Invalid request payload: missing label field", - * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": components["schemas"]["error"]; + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** @description Limit Reached */ - namespace_limit_reached: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody?: never; + responses: { + 200: components["responses"]["get_metrics_bandwidth_usage"]; + 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"]; + }; + }; + apps_list_metrics_bandwidth_daily: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { /** * @example { - * "id": "unprocessable_entity", - * "message": "namespace limit reached", - * "request_id": "a3275238-3d04-4405-a123-55c389b406c0" + * "app_ids": [ + * "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", + * "c2a93513-8d9b-4223-9d61-5e7272c81cf5" + * ], + * "date": "2023-01-17T00:00:00Z" * } */ - "application/json": components["schemas"]["error"]; + "application/json": components["schemas"]["app_metrics_bandwidth_usage_request"]; }; }; - /** @description Not Allowed. */ - namespace_not_allowed: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + responses: { + 200: components["responses"]["list_metrics_bandwidth_usage"]; + 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"]; + }; + }; + apps_get_health: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "id": "forbidden", - * "message": "not allowed to get namespace", - * "request_id": "b11e45a4-892c-48c9-9001-b6cffe9fe795" - * } + * @description The app ID + * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf */ - "application/json": components["schemas"]["error"]; + app_id: components["parameters"]["app_id"]; }; + cookie?: never; }; - /** @description Bad Request. */ - namespace_not_found: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["apps_health"]; + 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"]; + }; + }; + cdn_list_endpoints: { + 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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_cdn_endpoints"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + cdn_create_endpoint: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { + "application/json": components["schemas"]["cdn_endpoint"]; + }; + }; + responses: { + 201: components["responses"]["existing_endpoint"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + cdn_get_endpoint: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "id": "not_found", - * "message": "namespace not found", - * "request_id": "88d17b7a-630b-4083-99ce-5b91045efdb4" - * } + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ - "application/json": components["schemas"]["error"]; + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; + cookie?: never; }; - /** - * @description An array of JSON objects with a key called `namespaces`. Each object represents a namespace and contains - * the properties associated with it. - */ - list_triggers: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["existing_endpoint"]; + 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"]; + }; + }; + cdn_update_endpoints: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + */ + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - triggers?: components["schemas"]["trigger_info"][]; - }; + "application/json": components["schemas"]["update_endpoint"]; }; }; - /** - * @description A JSON response object with a key called `trigger`. The object contains the properties associated - * with the trigger. - */ - trigger_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["existing_endpoint"]; + 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"]; + }; + }; + cdn_delete_endpoint: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + */ + cdn_id: components["parameters"]["cdn_endpoint_id"]; + }; + 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"]; + }; + }; + cdn_purge_cache: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a CDN endpoint. + * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + */ + cdn_id: components["parameters"]["cdn_endpoint_id"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - trigger?: components["schemas"]["trigger_info"]; - }; + "application/json": components["schemas"]["purge_cache"]; }; }; - /** @description Bad Request. */ - trigger_bad_request: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + 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"]; + }; + }; + certificates_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 Name of expected certificate + * @example certificate-name + */ + name?: components["parameters"]["certificate_name"]; }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_certificates"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + certificates_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { + "application/json": components["schemas"]["certificate_request_lets_encrypt"] | components["schemas"]["certificate_request_custom"]; + }; + }; + responses: { + 201: components["responses"]["new_certificate"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + certificates_get: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "id": "bad_request", - * "message": "validating create trigger: validation error: missing trigger name, missing function name, missing source details", - * "request_id": "4851a473-1621-42ea-b2f9-5071c0ea8414" - * } + * @description A unique identifier for a certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - "application/json": components["schemas"]["error"]; + certificate_id: components["parameters"]["certificate_id"]; }; + cookie?: never; }; - /** @description Limit Reached */ - trigger_limit_reached: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["existing_certificate"]; + 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"]; + }; + }; + certificates_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a certificate. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + certificate_id: components["parameters"]["certificate_id"]; }; - content: { + 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"]; + }; + }; + balance_get: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["balance"]; + 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"]; + }; + }; + billingHistory_list: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_history"]; + 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"]; + }; + }; + invoices_list: { + parameters: { + query?: { + /** + * @description Number of items returned per page + * @example 2 + */ + per_page?: components["parameters"]["per_page"]; /** - * @example { - * "id": "unprocessable_entity", - * "message": "triggers limit reached", - * "request_id": "7ba99a43-6618-4fe0-9af7-092752ad0d56" - * } + * @description Which 'page' of paginated results to return. + * @example 1 */ - "application/json": components["schemas"]["error"]; - }; - }; - /** @description Bad Request. */ - trigger_not_found: { - 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": components["schemas"]["error"]; + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `images`. This will be set to an array of image objects, each of which will contain the standard image attributes. */ - all_images: { - 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": { - images: components["schemas"]["image"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["invoices"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing a subset of the standard image attributes as listed below, including the image's `id` and `status`. After initial creation, the `status` will be `NEW`. Using the image's id, you may query the image's status by sending a `GET` request to the `/v2/images/$IMAGE_ID` endpoint. When the `status` changes to `available`, the image will be ready for use. */ - new_custom_image: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + }; + invoices_get_byUUID: { + parameters: { + query?: { /** - * @example { - * "image": { - * "created_at": "2018-09-20T19:28:00Z", - * "description": "Cloud-optimized image w/ small footprint", - * "distribution": "Ubuntu", - * "error_message": "", - * "id": 38413969, - * "name": "ubuntu-18.04-minimal", - * "regions": [], - * "type": "custom", - * "tags": [ - * "base-image", - * "prod" - * ], - * "status": "NEW" - * } - * } + * @description Number of items returned per page + * @example 2 */ - "application/json": { - image?: components["schemas"]["image"]; - }; - }; - }; - /** @description The response will be a JSON object with a key called `image`. The value of this will be an image object containing the standard image attributes. */ - existing_image: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; - content: { + header?: never; + path: { /** - * @example { - * "image": { - * "id": 6918990, - * "name": "14.04 x64", - * "distribution": "Ubuntu", - * "slug": "ubuntu-16-04-x64", - * "public": true, - * "regions": [ - * "nyc1", - * "ams1", - * "sfo1", - * "nyc2", - * "ams2", - * "sgp1", - * "lon1", - * "nyc3", - * "ams3", - * "nyc3" - * ], - * "created_at": "2014-10-17T20:24:33Z", - * "min_disk_size": 20, - * "size_gigabytes": 2.34, - * "description": "", - * "tags": [], - * "status": "available", - * "error_message": "" - * } - * } + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - "application/json": { - image: components["schemas"]["image"]; - }; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key set to `image`. The value of this will be an image object containing the standard image attributes. */ - updated_image: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + requestBody?: never; + responses: { + 200: components["responses"]["invoice"]; + 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"]; + }; + }; + invoices_get_csvByUUID: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "image": { - * "id": 7938391, - * "name": "new-image-name", - * "distribution": "Ubuntu", - * "slug": null, - * "public": false, - * "regions": [ - * "nyc3", - * "nyc3" - * ], - * "created_at": "2014-11-14T16:44:03Z", - * "min_disk_size": 20, - * "size_gigabytes": 2.34, - * "description": "", - * "tags": [], - * "status": "available", - * "error_message": "" - * } - * } + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - "application/json": { - image: components["schemas"]["image"]; - }; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; + cookie?: never; }; - /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard action attributes. */ - get_image_actions_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + requestBody?: never; + responses: { + 200: components["responses"]["invoice_csv"]; + 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"]; + }; + }; + invoices_get_pdfByUUID: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "actions": [ - * { - * "id": 29410565, - * "status": "completed", - * "type": "transfer", - * "started_at": "2014-07-25T15:04:21Z", - * "completed_at": "2014-07-25T15:10:20Z", - * "resource_id": 7555620, - * "resource_type": "image", - * "region": { - * "name": "New York 2", - * "slug": "nyc2", - * "sizes": [ - * "s-1vcpu-3gb", - * "m-1vcpu-8gb", - * "s-3vcpu-1gb", - * "s-1vcpu-2gb", - * "s-2vcpu-2gb", - * "s-2vcpu-4gb", - * "s-4vcpu-8gb", - * "s-6vcpu-16gb", - * "s-8vcpu-32gb", - * "s-12vcpu-48gb", - * "s-16vcpu-64gb", - * "s-20vcpu-96gb", - * "s-1vcpu-1gb", - * "c-1vcpu-2gb", - * "s-24vcpu-128gb" - * ], - * "features": [ - * "private_networking", - * "backups", - * "ipv6", - * "metadata", - * "server_id", - * "install_agent", - * "storage", - * "image_transfer" - * ], - * "available": true - * }, - * "region_slug": "nyc2" - * } - * ], - * "links": { - * "pages": { - * "last": "https://api.digitalocean.com/v2/images/7555620/actions?page=5&per_page=1", - * "next": "https://api.digitalocean.com/v2/images/7555620/actions?page=2&per_page=1" - * } - * }, - * "meta": { - * "total": 5 - * } - * } + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - "application/json": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `action`. The value of this will be an object containing the standard image action attributes. */ - post_image_action_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + requestBody?: never; + responses: { + 200: components["responses"]["invoice_pdf"]; + 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"]; + }; + }; + invoices_get_summaryByUUID: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "action": { - * "id": 36805527, - * "status": "in-progress", - * "type": "transfer", - * "started_at": "2014-11-14T16:42:45Z", - * "completed_at": null, - * "resource_id": 7938269, - * "resource_type": "image", - * "region": { - * "name": "New York 3", - * "slug": "nyc3", - * "sizes": [ - * "s-1vcpu-3gb", - * "m-1vcpu-8gb", - * "s-3vcpu-1gb", - * "s-1vcpu-2gb", - * "s-2vcpu-2gb", - * "s-2vcpu-4gb", - * "s-4vcpu-8gb", - * "s-6vcpu-16gb", - * "s-8vcpu-32gb", - * "s-12vcpu-48gb", - * "s-16vcpu-64gb", - * "s-20vcpu-96gb", - * "s-1vcpu-1gb", - * "c-1vcpu-2gb", - * "s-24vcpu-128gb" - * ], - * "features": [ - * "private_networking", - * "backups", - * "ipv6", - * "metadata", - * "server_id", - * "install_agent", - * "storage", - * "image_transfer" - * ], - * "available": true - * }, - * "region_slug": "nyc3" - * } - * } + * @description UUID of the invoice + * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ - "application/json": components["schemas"]["action"]; + invoice_uuid: components["parameters"]["invoice_uuid"]; }; + cookie?: never; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard image action attributes. */ - get_image_action_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["invoice_summary"]; + 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"]; + }; + }; + billingInsights_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"]; }; - content: { + header?: never; + path: { /** - * @example { - * "action": { - * "id": 36805527, - * "status": "in-progress", - * "type": "transfer", - * "started_at": "2014-11-14T16:42:45Z", - * "completed_at": null, - * "resource_id": 7938269, - * "resource_type": "image", - * "region": { - * "name": "New York 3", - * "slug": "nyc3", - * "sizes": [ - * "s-1vcpu-3gb", - * "m-1vcpu-8gb", - * "s-3vcpu-1gb", - * "s-1vcpu-2gb", - * "s-2vcpu-2gb", - * "s-2vcpu-4gb", - * "s-4vcpu-8gb", - * "s-6vcpu-16gb", - * "s-8vcpu-32gb", - * "s-12vcpu-48gb", - * "s-16vcpu-64gb", - * "s-20vcpu-96gb", - * "s-1vcpu-1gb", - * "c-1vcpu-2gb", - * "s-24vcpu-128gb" - * ], - * "features": [ - * "private_networking", - * "backups", - * "ipv6", - * "metadata", - * "server_id", - * "install_agent", - * "storage", - * "image_transfer" - * ], - * "available": true - * }, - * "region_slug": "nyc3" - * } - * } + * @description URN of the customer account, can be a team (do:team:uuid) or an organization (do:teamgroup:uuid) + * @example do:team:12345678-1234-1234-1234-123456789012 */ - "application/json": components["schemas"]["action"]; + account_urn: components["parameters"]["account_urn"]; + /** + * @description Start date for billing insights in YYYY-MM-DD format + * @example 2025-01-01 + */ + start_date: components["parameters"]["start_date"]; + /** + * @description End date for billing insights in YYYY-MM-DD format. Must be within 31 days of start_date + * @example 2025-01-31 + */ + end_date: components["parameters"]["end_date"]; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `kubernetes_clusters`. - * This will be set to an array of objects, each of which will contain the - * standard Kubernetes cluster attributes. - */ - all_clusters: { - 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": { - kubernetes_clusters?: components["schemas"]["cluster"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_insights"]; + 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"]; }; - /** - * @description The response will be a JSON object with a key called `kubernetes_cluster`. The - * value of this will be an object containing the standard attributes of a - * Kubernetes cluster. - * - * The IP address and cluster API server endpoint will not be available until the - * cluster has finished provisioning. The initial value of the cluster's - * `status.state` attribute will be `provisioning`. When the cluster is ready, - * this will transition to `running`. - */ - cluster_create: { - 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": { - kubernetes_cluster?: components["schemas"]["cluster"]; - }; - }; + }; + databases_list_options: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `kubernetes_cluster`. The - * value of this will be an object containing the standard attributes of a - * Kubernetes cluster. - */ - existing_cluster: { - 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": { - kubernetes_cluster?: components["schemas"]["cluster"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["options"]; + 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"]; + }; + }; + databases_list_clusters: { + parameters: { + query?: { + /** + * @description Limits the results to database clusters with a specific tag.

Requires `tag:read` scope. + * @example production + */ + tag_name?: components["parameters"]["tag_name"]; }; + header?: never; + path?: never; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `kubernetes_cluster`. The - * value of this will be an object containing the standard attributes of a - * Kubernetes cluster. - */ - updated_cluster: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody?: never; + responses: { + 200: components["responses"]["database_clusters"]; + 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"]; + }; + }; + databases_create_cluster: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - kubernetes_cluster?: components["schemas"]["cluster"]; + "application/json": components["schemas"]["database_cluster"] & { + backup_restore?: components["schemas"]["database_backup"]; }; }; }; - /** @description The response will be a JSON object containing `load_balancers`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing the standard attributes for associated resources. */ - associated_kubernetes_resources_list: { - 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": components["schemas"]["associated_kubernetes_resources"]; - }; + responses: { + 201: components["responses"]["database_cluster"]; + 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"]; }; - /** @description A kubeconfig file for the cluster in YAML format. */ - kubeconfig: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + }; + databases_get_cluster: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example apiVersion: v1 - * clusters: - * - cluster: - * certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURUxCUUF3TXpFVk1CTUdBMVVFQ2ftTVJHbG4KYVhSaGJFOWpaV0Z1TVJvd0dUSREERXhGck9ITmhZWE1nUTJ4MWMzUmxjaUJEUVRBZUZ3MHhPREV4TVRVeApOakF3TWpCYUZ3MHpPREV4TVRVeE5qQXdNakJhTURNeEZUQVRCZ05WQkFvVERFUnBaMmwwWVd4UFkyVmhiakVhCk1CZ0dBMVVFQXhNUmF6aHpZV0Z6SUVOc2RYTjBaWElnUTBFd2dnRWlNQTBHQ1NxR1NJYjNEUUVCQVFVQUE0SUIKRHdBd2dnRUtBb0lCQVFDK2Z0L05Nd3pNaUxFZlFvTFU2bDgrY0hMbWttZFVKdjl4SmlhZUpIU0dZOGhPZFVEZQpGd1Zoc0pDTnVFWkpJUFh5Y0orcGpkU3pYc1lFSE03WVNKWk9xNkdaYThPMnZHUlJjN2ZQaUFJaFBRK0ZpUmYzCmRhMHNIUkZlM2hCTmU5ZE5SeTliQ2VCSTRSUlQrSEwzRFR3L2I5KytmRkdZQkRoVTEvTTZUWWRhUHR3WU0rdWgKb1pKcWJZVGJZZTFhb3R1ekdnYUpXaXRhdFdHdnNJYU8xYWthdkh0WEIOOHFxa2lPemdrSDdvd3RVY3JYM05iawozdmlVeFU4TW40MmlJaGFyeHNvTnlwdGhHOWZLMi9OdVdKTXJJS2R0Mzhwc0tkdDBFbng0MWg5K0dsMjUzMzhWCk1mdjBDVDF6SG1JanYwblIrakNkcFd0eFVLRyt0YjYzZFhNbkFnTUJBQUdqUlRCRE1BNEdBMVVkRHdFQi93UUUKQXdJQmhqQVNCZ05WSFJNQkFmOEVDREFHQVFIL0FnRUFNQjBHQTFVZERnUVdCQlNQMmJrOXJiUGJpQnZOd1Z1NQpUL0dwTFdvOTdEQU5CZ2txaGtpRzl3MEJBUXNGQUFPQ0FRRUFEVjFMSGZyc1JiYVdONHE5SnBFVDMxMlluRDZ6Cm5rM3BpU1ZSYVEvM09qWG8wdHJ6Z2N4KzlVTUQxeDRHODI1RnYxc0ROWUExZEhFc2dHUmNyRkVmdGZJQWUrUVYKTitOR3NMRnQrOGZrWHdnUlpoNEU4ZUJsSVlrdEprOWptMzFMT25vaDJYZno0aGs3VmZwYkdvVVlsbmVoak1JZApiL3ZMUk05Y2EwVTJlYTB5OTNveE5pdU9PcXdrZGFjU1orczJtb3JNdGZxc3VRSzRKZDA3SENIbUFIeWpXT2k4ClVOQVUyTnZnSnBKY2RiZ3VzN2I5S3ppR1ZERklFUk04cEo4U1Nob1ZvVFFJd3d5Y2xVTU9EUUJreFFHOHNVRk8KRDE3ZjRod1dNbW5qVHY2MEJBM0dxaTZRcjdsWVFSL3drSEtQcnZjMjhoNXB0NndPWEY1b1M4OUZkUT09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K - * server: https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com - * name: do-nyc1-prod-cluster-01 - * contexts: - * - context: - * cluster: do-nyc1-prod-cluster-01 - * user: do-nyc1-prod-cluster-01-admin - * name: do-nyc1-prod-cluster-01 - * current-context: do-nyc1-prod-cluster-01 - * kind: Config - * preferences: {} - * users: - * - name: do-nyc1-prod-cluster-01-admin - * user: - * token: 403d085aaa80102277d8da97ffd2db2b6a4f129d0e2146098fdfb0cec624babc + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - "application/yaml": unknown; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description A JSON object containing credentials for a cluster. */ - credentials: { - 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": components["schemas"]["credentials"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["database_cluster"]; + 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"]; }; - /** - * @description The response will be a JSON object with a key called - * `available_upgrade_versions`. The value of this will be an array of objects, - * representing the upgrade versions currently available for this cluster. - * - * If the cluster is up-to-date (i.e. there are no upgrades currently available) - * `available_upgrade_versions` will be `null`. - */ - available_upgrades: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + }; + databases_destroy_cluster: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; - content: { - "application/json": { - available_upgrade_versions?: components["schemas"]["kubernetes_version"][] | null; - }; + 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"]; + }; + }; + databases_get_config: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `node_pools`. This will - * be set to an array of objects, each of which will contain the standard node - * pool attributes. - */ - all_node_pools: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["database_config"]; + 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"]; + }; + }; + databases_patch_config: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { /** * @example { - * "node_pools": [ - * { - * "id": "cdda885e-7663-40c8-bc74-3a036c66545d", - * "name": "frontend-pool", - * "size": "s-1vcpu-2gb", - * "count": 3, - * "tags": [ - * "production", - * "web-team", - * "k8s", - * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", - * "k8s:worker" - * ], - * "labels": null, - * "auto_scale": false, - * "min_nodes": 0, - * "max_nodes": 0, - * "nodes": [ - * { - * "id": "478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f", - * "name": "adoring-newton-3niq", - * "status": { - * "state": "running" - * }, - * "droplet_id": "205545370", - * "created_at": "2018-11-15T16:00:11Z", - * "updated_at": "2018-11-15T16:00:11Z" - * }, - * { - * "id": "ad12e744-c2a9-473d-8aa9-be5680500eb1", - * "name": "adoring-newton-3nim", - * "status": { - * "state": "running" - * }, - * "droplet_id": "205545371", - * "created_at": "2018-11-15T16:00:11Z", - * "updated_at": "2018-11-15T16:00:11Z" - * }, - * { - * "id": "e46e8d07-f58f-4ff1-9737-97246364400e", - * "name": "adoring-newton-3ni7", - * "status": { - * "state": "running" - * }, - * "droplet_id": "205545372", - * "created_at": "2018-11-15T16:00:11Z", - * "updated_at": "2018-11-15T16:00:11Z" - * } - * ] - * }, - * { - * "id": "f49f4379-7e7f-4af5-aeb6-0354bd840778", - * "name": "backend-pool", - * "size": "g-4vcpu-16gb", - * "count": 2, - * "tags": [ - * "production", - * "web-team", - * "k8s", - * "k8s:bd5f5959-5e1e-4205-a714-a914373942af", - * "k8s:worker" - * ], - * "labels": { - * "service": "backend", - * "priority": "high" - * }, - * "auto_scale": true, - * "min_nodes": 2, - * "max_nodes": 5, - * "nodes": [ - * { - * "id": "3385619f-8ec3-42ba-bb23-8d21b8ba7518", - * "name": "affectionate-nightingale-3nif", - * "status": { - * "state": "running" - * }, - * "droplet_id": "205545373", - * "created_at": "2018-11-15T16:00:11Z", - * "updated_at": "2018-11-15T16:00:11Z" - * }, - * { - * "id": "4b8f60ff-ba06-4523-a6a4-b8148244c7e6", - * "name": "affectionate-nightingale-3niy", - * "status": { - * "state": "running" - * }, - * "droplet_id": "205545374", - * "created_at": "2018-11-15T16:00:11Z", - * "updated_at": "2018-11-15T16:00:11Z" - * } - * ] - * } - * ] + * "config": { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES", + * "sql_require_primary_key": true + * } * } */ - "application/json": { - node_pools?: components["schemas"]["kubernetes_node_pool"][]; - }; + "application/json": components["schemas"]["database_config"]; }; }; - /** - * @description The response will be a JSON object with a key called `node_pool`. The value of - * this will be an object containing the standard attributes of a node pool. - */ - node_pool_create: { - 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": { - node_pool?: components["schemas"]["kubernetes_node_pool"]; - }; - }; + responses: { + 200: 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"]; }; - /** - * @description The response will be a JSON object with a key called `node_pool`. The value - * of this will be an object containing the standard attributes of a node pool. - */ - existing_node_pool: { - 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": { - node_pool?: components["schemas"]["kubernetes_node_pool"]; - }; + }; + databases_get_ca: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `node_pool`. The value of - * this will be an object containing the standard attributes of a node pool. - */ - node_pool_update: { - 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": { - node_pool?: components["schemas"]["kubernetes_node_pool"]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["ca"]; + 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"]; }; - /** - * @description The response will be a JSON object with a key called `kubernetes_cluster_user` - * containing the username and in-cluster groups that it belongs to. - */ - cluster_user: { - 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": components["schemas"]["user"]; + }; + databases_get_migrationStatus: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `options` which contains - * `regions`, `versions`, and `sizes` objects listing the available options and - * the matching slugs for use when creating a new cluster. - */ - all_options: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["online_migration"]; + 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"]; + }; + }; + databases_update_onlineMigration: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": components["schemas"]["kubernetes_options"]; + /** + * @example { + * "source": { + * "host": "source-do-user-6607903-0.b.db.ondigitalocean.com", + * "dbname": "defaultdb", + * "port": 25060, + * "username": "doadmin", + * "password": "paakjnfe10rsrsmf" + * }, + * "disable_ssl": false, + * "ignore_dbs": [ + * "db0", + * "db1" + * ] + * } + */ + "application/json": components["schemas"]["source_database"]; }; }; - /** - * @description The response is a JSON object which contains the diagnostics on Kubernetes - * objects in the cluster. Each diagnostic will contain some metadata information - * about the object and feedback for users to act upon. - */ - clusterlint_results: { - 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": components["schemas"]["clusterlint_results"]; + responses: { + 200: components["responses"]["online_migration"]; + 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"]; + }; + }; + databases_delete_onlineMigration: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier assigned to the online migration. + * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 + */ + migration_id: components["parameters"]["migration_id"]; }; + cookie?: never; }; - /** @description The response is a JSON object with a key called `run_id` that you can later use to fetch the run results. */ - clusterlint_run: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + 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"]; + }; + }; + databases_update_region: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { "application/json": { /** - * @description ID of the clusterlint run that can be used later to fetch the diagnostics. - * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 + * @description A slug identifier for the region to which the database cluster will be migrated. + * @example lon1 */ - run_id?: string; + region: string; }; }; }; - /** @description A JSON object with a key of `load_balancers`. This will be set to an array of objects, each of which will contain the standard load balancer attributes. */ - all_load_balancers: { - 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": { - load_balancers?: components["schemas"]["load_balancer"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + 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"]; }; - /** @description Accepted */ - load_balancer_create: { - 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": { - load_balancer?: components["schemas"]["load_balancer"]; - }; + }; + databases_update_clusterSize: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** - * @description The response will be a JSON object with a key called `load_balancer`. The - * value of this will be an object that contains the standard attributes - * associated with a load balancer - */ - existing_load_balancer: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": { - load_balancer?: components["schemas"]["load_balancer"]; - }; + /** + * @example { + * "size": "db-s-4vcpu-8gb", + * "num_nodes": 3, + * "storage_size_mib": 163840 + * } + */ + "application/json": components["schemas"]["database_cluster_resize"]; }; }; - /** - * @description The response will be a JSON object with a key called `load_balancer`. The - * value of this will be an object containing the standard attributes of a - * load balancer. - */ - updated_load_balancer: { - 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": { - load_balancer?: components["schemas"]["load_balancer"]; - }; - }; + responses: { + 202: 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"]; }; - /** @description A list of alert policies. */ - list_alert_policy_response: { - 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": components["schemas"]["list_alert_policy"] & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + databases_list_firewall_rules: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description An alert policy. */ - alert_policy_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["firewall_rules"]; + 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"]; + }; + }; + databases_update_firewall_rules: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { + /** + * @example { + * "rules": [ + * { + * "type": "ip_addr", + * "value": "192.168.1.1" + * }, + * { + * "type": "k8s", + * "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61" + * }, + * { + * "type": "droplet", + * "value": "163973392" + * }, + * { + * "type": "tag", + * "value": "backend", + * "description": "a backend tag" + * } + * ] + * } + */ "application/json": { - policy?: components["schemas"]["alert_policy"]; + rules?: components["schemas"]["firewall_rule"][]; }; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - droplet_bandwidth_metric_response: { - 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": components["schemas"]["metrics"]; - }; + 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"]; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - droplet_cpu_metric_response: { - 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": components["schemas"]["metrics"]; + }; + databases_update_maintenanceWindow: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - droplet_filesystem_metric_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": components["schemas"]["metrics"]; + /** + * @example { + * "day": "tuesday", + * "hour": "14:00" + * } + */ + "application/json": components["schemas"]["database_maintenance_window"]; }; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - metric_response: { - 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": components["schemas"]["metrics"]; - }; + 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"]; }; - /** @description The response will be a JSON object with a key called `data` and `status`. */ - app_metric_response: { - 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": components["schemas"]["metrics"]; + }; + databases_install_update: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @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"][]; - }; - }; + 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"]; }; - /** @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"]; - }; + }; + databases_list_backups: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @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"][]; - }; - }; + requestBody?: never; + responses: { + 200: components["responses"]["database_backups"]; + 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"]; }; - /** @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"]; - }; + }; + databases_list_replicas: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @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: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - projects?: components["schemas"]["project"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["database_replicas"]; + 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"]; }; - /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ - existing_project: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + }; + databases_create_replica: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody?: { content: { - "application/json": { - project?: components["schemas"]["project"]; - }; + "application/json": WithRequired; }; }; - /** @description The response will be a JSON object with a key called `project`. The value of this will be an object with the standard project attributes */ - default_project: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 201: components["responses"]["database_replica"]; + 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"]; + }; + }; + databases_list_events_logs: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; - content: { - "application/json": { - project?: components["schemas"]["project"]; - }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["events_logs"]; + 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"]; + }; + }; + databases_get_replica: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: components["parameters"]["replica_name"]; }; + cookie?: never; }; - /** @description Only an empty project can be deleted. */ - precondition_failed: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["database_replica"]; + 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"]; + }; + }; + databases_destroy_replica: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: components["parameters"]["replica_name"]; }; - content: { + 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"]; + }; + }; + databases_promote_replica: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "id": "precondition_failed", - * "message": "cannot delete a project with resources. move or remove the resources first" - * } + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - "application/json": components["schemas"]["error"]; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database replica. + * @example read-nyc3-01 + */ + replica_name: components["parameters"]["replica_name"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. */ - resources_list: { - 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": { - resources?: components["schemas"]["resource"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + 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"]; }; - /** @description The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. */ - assigned_resources_list: { - 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": { - resources?: components["schemas"]["resource"][]; - }; + }; + databases_list_users: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description A JSON object with a key set to `regions`. The value is an array of `region` objects, each of which contain the standard `region` attributes. */ - all_regions: { - 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": { - regions: components["schemas"]["region"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["users"]; + 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"]; }; - /** @description The response will be a JSON object with the key `registry` containing information about your registry. */ - registry_info: { - 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": { - registry?: components["schemas"]["registry"]; - }; + }; + databases_add_user: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `subscription` containing information about your subscription. */ - subscription_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": { - subscription?: components["schemas"]["subscription"]; + "application/json": components["schemas"]["database_user"] & { + /** + * @description (To be deprecated: use settings.mongo_user_settings.role instead for access controls to MongoDB databases). + * For MongoDB clusters, set to `true` to create a read-only user. + * This option is not currently supported for other database engines. + * @example true + */ + readonly?: boolean; }; }; }; - /** @description A Docker `config.json` file for the container registry. */ - docker_credentials: { - 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": components["schemas"]["docker_credentials"]; - }; - }; - /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ - all_repositories: { - 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": { - repositories?: components["schemas"]["repository"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + responses: { + 201: components["responses"]["user"]; + 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"]; }; - /** @description The response body will be a JSON object with a key of `repositories`. This will be set to an array containing objects each representing a repository. */ - all_repositories_v2: { - 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": { - repositories?: components["schemas"]["repository_v2"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + databases_get_user: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; + cookie?: never; }; - /** @description The response body will be a JSON object with a key of `tags`. This will be set to an array containing objects each representing a tag. */ - repository_tags: { - 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": { - tags?: components["schemas"]["repository_tag"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["user"]; + 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"]; }; - /** @description The response body will be a JSON object with a key of `manifests`. This will be set to an array containing objects each representing a manifest. */ - repository_manifests: { - 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": { - manifests?: components["schemas"]["repository_manifest"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + databases_update_user: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key of `garbage_collection`. This will be a json object with attributes representing the currently-active garbage collection. */ - garbage_collection: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { "application/json": { - garbage_collection?: components["schemas"]["garbage_collection"]; + settings: components["schemas"]["user_settings"]; }; }; }; - /** @description The response will be a JSON object with a key of `garbage_collections`. This will be set to an array containing objects representing each past garbage collection. Each will contain the standard Garbage Collection attributes. */ - garbage_collections: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { + responses: { + 201: components["responses"]["user"]; + 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"]; + }; + }; + databases_delete_user: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "garbage_collections": [ - * { - * "uuid": "eff0feee-49c7-4e8f-ba5c-a320c109c8a8", - * "registry_name": "example", - * "status": "requested", - * "created_at": "2020-10-30T21:03:24.000Z", - * "updated_at": "2020-10-30T21:03:44.000Z", - * "blobs_deleted": 42, - * "freed_bytes": 667 - * } - * ], - * "meta": { - * "total": 1 - * } - * } + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - "application/json": { - garbage_collections?: components["schemas"]["garbage_collection"][]; - }; + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `options` which contains a key called `subscription_tiers` listing the available tiers. */ - registry_options_response: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + 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"]; + }; + }; + databases_reset_auth: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; }; + cookie?: never; + }; + requestBody: { content: { /** * @example { - * "options": { - * "available_regions": [ - * "nyc3", - * "sfo3", - * "ams3", - * "sgp1", - * "fra1" - * ], - * "subscription_tiers": [ - * { - * "name": "Starter", - * "slug": "starter", - * "included_repositories": 1, - * "included_storage_bytes": 524288000, - * "allow_storage_overage": false, - * "included_bandwidth_bytes": 524288000, - * "monthly_price_in_cents": 0, - * "eligible": false, - * "eligibility_reasons": [ - * "OverRepositoryLimit" - * ] - * }, - * { - * "name": "Basic", - * "slug": "basic", - * "included_repositories": 5, - * "included_storage_bytes": 5368709120, - * "allow_storage_overage": true, - * "included_bandwidth_bytes": 5368709120, - * "monthly_price_in_cents": 500, - * "eligible": true - * }, - * { - * "name": "Professional", - * "slug": "professional", - * "included_repositories": 0, - * "included_storage_bytes": 107374182400, - * "allow_storage_overage": true, - * "included_bandwidth_bytes": 107374182400, - * "monthly_price_in_cents": 2000, - * "eligible": true - * } - * ] + * "mysql_settings": { + * "auth_plugin": "caching_sha2_password" * } * } */ "application/json": { - options?: { - /** - * @example [ - * "nyc3" - * ] - */ - available_regions?: string[]; - subscription_tiers?: (components["schemas"]["subscription_tier_base"] & components["schemas"]["subscription_tier_extended"])[]; - }; + mysql_settings?: components["schemas"]["mysql_settings"]; }; }; }; - /** @description A JSON object with an `neighbor_ids` key. */ - droplet_neighbors_ids: { - 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": components["schemas"]["neighbor_ids"]; - }; - }; - /** @description The response will be a JSON object with a key called `reserved_ips`. This will be set to an array of reserved IP objects, each of which will contain the standard reserved IP attributes */ - reserved_ip_list: { - 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": { - reserved_ips?: components["schemas"]["reserved_ip"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; - }; - /** - * @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. - * When assigning a reserved IP to a Droplet at same time as it created, the response's `links` object will contain links to both the Droplet and the assignment action. The latter can be used to check the status of the action. - */ - reserved_ip_created: { - 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": { - reserved_ip?: components["schemas"]["reserved_ip"]; - links?: { - droplets?: components["schemas"]["action_link"][]; - actions?: components["schemas"]["action_link"][]; - }; - }; - }; + responses: { + 200: components["responses"]["user"]; + 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"]; }; - /** @description The response will be a JSON object with a key called `reserved_ip`. The value of this will be an object that contains the standard attributes associated with a reserved IP. */ - reserved_ip: { - 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": { - reserved_ip?: components["schemas"]["reserved_ip"]; - }; + }; + databases_list: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description The results will be returned as a JSON object with an `actions` key. This will be set to an array filled with action objects containing the standard reserved IP action attributes. */ - reserved_ip_actions: { - 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": { - actions?: components["schemas"]["action"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["databases"]; + 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"]; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard reserved IP action attributes. */ - reserved_ip_action: { - 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": { - action?: components["schemas"]["action"] & { - /** - * Format: uuid - * @description The UUID of the project to which the reserved IP currently belongs. - * @example 746c6152-2fa2-11ed-92d3-27aaa54e4988 - */ - project_id?: string; - }; - }; + }; + databases_add: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description A JSON object with a key called `sizes`. The value of this will be an array of `size` objects each of which contain the standard size attributes. */ - all_sizes: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": { - sizes: components["schemas"]["size"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + /** + * @example { + * "name": "alpha" + * } + */ + "application/json": components["schemas"]["database"]; }; }; - /** @description A JSON object with a key of `snapshots`. */ - snapshots: { - 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": { - snapshots?: components["schemas"]["snapshots"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + responses: { + 201: components["responses"]["database"]; + 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"]; + }; + }; + databases_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database. + * @example alpha + */ + database_name: components["parameters"]["database_name"]; }; + cookie?: never; }; - /** @description A JSON object with a key called `snapshot`. */ - snapshots_existing: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["database"]; + 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"]; + }; + }; + databases_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database. + * @example alpha + */ + database_name: components["parameters"]["database_name"]; }; - content: { - "application/json": { - snapshot?: components["schemas"]["snapshots"]; - }; + 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"]; + }; + }; + databases_list_connectionPools: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description Bad Request */ - not_a_snapshot: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["connection_pools"]; + 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"]; + }; + }; + databases_add_connectionPool: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { /** * @example { - * "id": "bad_request", - * "message": "the resource is not a snapshot", - * "request_id": "bbd8d7d4-2beb-4be1-a374-338e6165e32d" + * "name": "backend-pool", + * "mode": "transaction", + * "size": 10, + * "db": "defaultdb", + * "user": "doadmin" * } */ - "application/json": components["schemas"]["error"]; + "application/json": components["schemas"]["connection_pool"]; }; }; - /** @description To list all of your tags, you can send a `GET` request to `/v2/tags`. */ - tags_all: { - 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": { - tags?: components["schemas"]["tags"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + responses: { + 201: components["responses"]["connection_pool"]; + 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"]; + }; + }; + databases_get_connectionPool: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: components["parameters"]["pool_name"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called tag. The value of this will be a tag object containing the standard tag attributes */ - tags_new: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["connection_pool"]; + 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"]; + }; + }; + databases_update_connectionPool: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: components["parameters"]["pool_name"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - tag?: components["schemas"]["tags"]; - }; + /** + * @example { + * "mode": "transaction", + * "size": 10, + * "db": "defaultdb", + * "user": "doadmin" + * } + */ + "application/json": components["schemas"]["connection_pool_update"]; }; }; - /** @description Bad Request */ - tags_bad_request: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - "x-request-id": components["headers"]["x-request-id"]; - [name: string]: unknown; + 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"]; + }; + }; + databases_delete_connectionPool: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the connection pool. + * @example backend-pool + */ + pool_name: components["parameters"]["pool_name"]; }; - content: { - "application/json": components["schemas"]["error_with_root_causes"]; + 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"]; + }; + }; + databases_get_evictionPolicy: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called `tag`. The value of this will be a tag object containing the standard tag attributes. */ - tags_existing: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["eviction_policy_response"]; + 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"]; + }; + }; + databases_update_evictionPolicy: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { + /** + * @example { + * "eviction_policy": "allkeys_lru" + * } + */ "application/json": { - tag?: components["schemas"]["tags"]; + eviction_policy: components["schemas"]["eviction_policy_model"]; }; }; }; - /** @description The response will be a JSON object with a key called `volumes`. This will be set to an array of volume objects, each of which will contain the standard volume attributes. */ - volumes: { - 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 Array of volumes. */ - volumes: components["schemas"]["volume_full"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + 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"]; }; - /** @description The response will be a JSON object with a key called `volume`. The value will be an object containing the standard attributes associated with a volume. */ - volume: { - 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": { - volume?: components["schemas"]["volume_full"]; - }; + }; + databases_get_sql_mode: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes */ - volumeAction: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["sql_mode"]; + 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"]; + }; + }; + databases_update_sql_mode: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - action?: components["schemas"]["volumeAction"]; - }; + /** + * @example { + * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE" + * } + */ + "application/json": components["schemas"]["sql_mode"]; }; }; - /** @description You will get back a JSON object that has a `snapshot` key. This will contain the standard snapshot attributes */ - volumeSnapshot: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + 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"]; + }; + }; + databases_update_major_version: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - snapshot?: components["schemas"]["snapshots"]; - }; + /** + * @example { + * "version": "14" + * } + */ + "application/json": components["schemas"]["version-2"]; }; }; - /** @description The response will be an object with a key called `action`. The value of this will be an object that contains the standard volume action attributes. */ - volumeActions: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + 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"]; + }; + }; + databases_get_autoscale: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; - content: { - "application/json": { - actions?: components["schemas"]["volumeAction"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["autoscale"]; + 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"]; + }; + }; + databases_update_autoscale: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description You will get back a JSON object that has a `snapshots` key. This will be set to an array of snapshot objects, each of which contain the standard snapshot attributes */ - volumeSnapshots: { - headers: { - "ratelimit-limit": components["headers"]["ratelimit-limit"]; - "ratelimit-remaining": components["headers"]["ratelimit-remaining"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody: { content: { - "application/json": { - snapshots?: components["schemas"]["snapshots"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + /** + * @example { + * "storage": { + * "enabled": true, + * "threshold_percent": 80, + * "increment_gib": 10 + * } + * } + */ + "application/json": components["schemas"]["database_autoscale_params"]; }; }; - /** @description The response will be a JSON object with a key called `vpcs`. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC */ - all_vpcs: { - 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": { - vpcs?: components["schemas"]["vpc"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_entity"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; }; - /** @description The response will be a JSON object with a key called `vpc`. The value of this will be an object that contains the standard attributes associated with a VPC. */ - existing_vpc: { - 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?: components["schemas"]["vpc"]; - }; + }; + databases_list_kafka_topics: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @description The response will be a JSON object with a key called members. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC member. */ - vpc_members: { - 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": { - members?: components["schemas"]["vpc_member"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; - }; + requestBody?: never; + responses: { + 200: components["responses"]["kafka_topics"]; + 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"]; }; - /** @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"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - peerings?: components["schemas"]["vpc_peering"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + }; + databases_create_kafka_topic: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @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"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; + requestBody?: { content: { - "application/json": { - peering?: components["schemas"]["vpc_peering"]; - }; + /** + * @example { + * "name": "customer-events", + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 + * } + * } + */ + "application/json": components["schemas"]["kafka_topic_create"]; }; }; - /** @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"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; - }; - content: { - "application/json": { - vpc_peerings?: components["schemas"]["vpc_peering"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + responses: { + 201: components["responses"]["kafka_topic"]; + 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"]; + }; + }; + databases_get_kafka_topic: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the Kafka topic. + * @example customer-events + */ + topic_name: components["parameters"]["kafka_topic_name"]; }; + cookie?: never; }; - /** @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; + requestBody?: never; + responses: { + 200: components["responses"]["kafka_topic"]; + 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"]; + }; + }; + databases_update_kafka_topic: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the Kafka topic. + * @example customer-events + */ + topic_name: components["parameters"]["kafka_topic_name"]; }; + cookie?: never; + }; + requestBody?: { content: { - "application/json": { - vpc_peering?: components["schemas"]["vpc_peering"]; - }; + /** + * @example { + * "partitions": 3, + * "replication": 2, + * "config": { + * "retention_bytes": -1, + * "retention_ms": 100000 + * } + * } + */ + "application/json": components["schemas"]["kafka_topic_update"]; }; }; - /** @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"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + responses: { + 200: components["responses"]["kafka_topic"]; + 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"]; + }; + }; + databases_delete_kafka_topic: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name used to identify the Kafka topic. + * @example customer-events + */ + topic_name: components["parameters"]["kafka_topic_name"]; }; - content: { - "application/json": { - vpc_peering?: components["schemas"]["vpc_peering"]; - }; + 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"]; + }; + }; + databases_list_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @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"]; - "ratelimit-reset": components["headers"]["ratelimit-reset"]; - [name: string]: unknown; + requestBody?: never; + responses: { + 200: components["responses"]["logsinks"]; + 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"]; + }; + }; + databases_create_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - vpc_peering?: components["schemas"]["vpc_peering"]; - }; + "application/json": components["schemas"]["logsink_create"]; }; }; - /** @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"]; + responses: { + 201: components["responses"]["logsink"]; + 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"]; + }; + }; + databases_get_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; }; + cookie?: never; }; - /** @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; + requestBody?: never; + responses: { + 200: components["responses"]["logsink_data"]; + 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"]; + }; + }; + databases_update_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - check?: components["schemas"]["check"]; - }; + /** + * @example { + * "config": { + * "server": "192.168.0.1", + * "port": 514, + * "tls": false, + * "format": "rfc3164" + * } + * } + */ + "application/json": components["schemas"]["logsink_update"]; }; }; - /** @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; + responses: { + 200: 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"]; + }; + }; + databases_delete_logsink: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description A unique identifier for a logsink of a database cluster + * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + */ + logsink_id: components["parameters"]["logsink_id"]; }; - content: { - "application/json": { - state?: components["schemas"]["state"]; - }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: 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"]; + }; + }; + databases_list_kafka_schemas: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; }; - /** @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; + requestBody?: never; + responses: { + 200: components["responses"]["kafka_schemas"]; + 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"]; + }; + }; + databases_create_kafka_schema: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; }; + cookie?: never; + }; + requestBody: { content: { - "application/json": { - alerts?: components["schemas"]["alert"][]; - } & components["schemas"]["pagination"] & components["schemas"]["meta"]; + /** + * @example { + * "subject_name": "customer-schema", + * "schema_type": "AVRO", + * "schema": "{\n \"type\": \"record\",\n \"name\": \"Customer\",\n \"fields\": [\n {\"name\": \"id\", \"type\": \"string\"},\n {\"name\": \"name\", \"type\": \"string\"},\n {\"name\": \"email\", \"type\": \"string\"},\n {\"name\": \"created_at\", \"type\": \"long\"}\n ]\n}\n" + * } + */ + "application/json": WithRequired; }; }; - /** @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"]; - }; + responses: { + 201: components["responses"]["kafka_schema"]; + 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"]; + }; + }; + databases_get_kafka_schema: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the Kafka schema subject. + * @example customer-schema + */ + subject_name: components["parameters"]["kafka_schema_subject_name"]; }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["kafka_schema_version"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; }; }; - 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 - */ - ssh_key_identifier: components["schemas"]["ssh_key_id"] | components["schemas"]["ssh_key_fingerprint"]; - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 - */ - action_id: number; - /** - * @description Whether the project_id of listed apps should be fetched and included. - * @example true - */ - with_projects: boolean; - /** - * @description The content-type that should be used by the response. By default, the response will be `application/json`. `application/yaml` is also supported. - * @example application/json - */ - accept: "application/json" | "application/yaml"; - /** - * @description The content-type used for the request. By default, the requests are assumed to use `application/json`. `application/yaml` is also supported. - * @example application/json - */ - "content-type": "application/json" | "application/yaml"; - /** - * @description The ID of the app - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - id_app: string; - /** - * @description The name of the app to retrieve. - * @example myApp - */ - app_name: string; - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: string; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component - */ - component: string; - /** - * @description Whether the logs should follow live updates. - * @example true - */ - live_updates: boolean; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - log_type: "UNSPECIFIED" | "BUILD" | "DEPLOY" | "RUN" | "RUN_RESTARTED"; - /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m - */ - time_wait: string; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a - */ - deployment_id: string; - /** - * @description The slug of the instance size - * @example apps-s-1vcpu-0.5gb - */ - slug_size: string; - /** - * @description The alert ID - * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d - */ - alert_id: string; - /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 - */ - cdn_endpoint_id: string; - /** - * @description Name of expected certificate - * @example certificate-name - */ - certificate_name: string; - /** - * @description A unique identifier for a certificate. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - certificate_id: string; - /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 - */ - invoice_uuid: string; - /** - * @description Limits the results to database clusters with a specific tag. - * @example production - */ - tag_name: string; - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: string; - /** - * @description A unique identifier assigned to the online migration. - * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 - */ - migration_id: string; - /** - * @description The name of the database replica. - * @example read-nyc3-01 - */ - replica_name: string; - /** - * @description The name of the database user. - * @example app-01 - */ - username: string; - /** - * @description The name of the database. - * @example alpha - */ - database_name: string; - /** - * @description The name used to identify the connection pool. - * @example backend-pool - */ - pool_name: string; - /** - * @description The name used to identify the Kafka topic. - * @example customer-events - */ - kafka_topic_name: string; - /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 - */ - logsink_id: string; - /** - * @description The name of the OpenSearch index. - * @example logs-* - */ - opensearch_index_name: string; - /** - * @description The name of the domain itself. - * @example example.com - */ - domain_name: string; - /** - * @description A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. - * @example sub.example.com - */ - domain_name_query: string; - /** - * @description The type of the DNS record. For example: A, CNAME, TXT, ... - * @example A - */ - domain_type_query: "A" | "AAAA" | "CAA" | "CNAME" | "MX" | "NS" | "SOA" | "SRV" | "TXT"; - /** - * @description The unique identifier of the domain record. - * @example 3352896 - */ - domain_record_id: number; - /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. - * @example env:prod - */ - droplet_tag_name: string; - /** - * @description Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with `tag_name`. - * @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 - */ - droplet_delete_tag_name: string; - /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 - */ - droplet_id: number; - /** - * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. - * @example true - */ - x_dangerous: boolean; - /** - * @description The name of the autoscale pool - * @example my-autoscale-pool - */ - autoscale_pool_name: string; - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: string; - /** - * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. - * @example true - */ - parameters_x_dangerous: boolean; - /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c - */ - firewall_id: string; - /** - * @description A floating IP address. - * @example 45.55.96.47 - */ - floating_ip: string; - /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx - */ - namespace_id: string; - /** - * @description The name of the trigger to be managed. - * @example my trigger - */ - trigger_name: string; - /** - * @description Filters results based on image type which can be either `application` or `distribution`. - * @example distribution - */ - type: "application" | "distribution"; - /** - * @description Used to filter only user images. - * @example true - */ - private: boolean; - /** - * @description Used to filter images by a specific tag. - * @example base-image - */ - tag: string; - /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 - */ - image_id: number; - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - kubernetes_cluster_id: string; - /** - * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. - * @example 300 - */ - kubernetes_expiry_seconds: number; - /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d - */ - kubernetes_node_pool_id: string; - /** - * @description A unique ID that can be used to reference a node in a Kubernetes node pool. - * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f - */ - kubernetes_node_id: string; - /** - * @description Specifies whether or not to drain workloads from a node before it is deleted. Setting it to `1` causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. - * @example 1 - */ - kubernetes_node_skip_drain: number; - /** - * @description Specifies whether or not to replace a node after it has been deleted. Setting it to `1` causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. - * @example 1 - */ - kubernetes_node_replace: number; - /** - * @description Specifies the clusterlint run whose results will be retrieved. - * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 - */ - clusterlint_run_id: string; - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - load_balancer_id: string; - /** - * @description A unique identifier for an alert policy. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - alert_uuid: string; - /** - * @description The droplet ID. - * @example 17209102 - */ - parameters_droplet_id: string; - /** - * @description The network interface. - * @example private - */ - network_interface: "private" | "public"; - /** - * @description The traffic direction. - * @example inbound - */ - network_direction: "inbound" | "outbound"; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - metric_timestamp_start: string; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - metric_timestamp_end: string; - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - parameters_app_id: string; - /** - * @description The app component name. - * @example sample-application - */ - app_component: string; - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - parameters_load_balancer_id: string; - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - parameters_autoscale_pool_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 - */ - project_id: string; - /** - * @description The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. - * @example 3600 - */ - registry_expiry_seconds: number; - /** - * @description By default, the registry credentials allow for read-only access. Set this query parameter to `true` to obtain read-write credentials. - * @example true - */ - registry_read_write: boolean; - /** - * @description The name of a container registry. - * @example example - */ - registry_name: string; - /** - * @description Which 'page' of paginated results to return. Ignored when 'page_token' is provided. - * @example 1 - */ - token_pagination_page: number; - /** - * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. - * @example eyJUb2tlbiI6IkNnZGpiMjlz - */ - token_pagination_page_token: string; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 - */ - registry_repository_name: string; - /** - * @description The name of a container registry repository tag. - * @example 06a447a - */ - registry_repository_tag: string; - /** - * @description The manifest digest of a container registry repository tag. - * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 - */ - registry_manifest_digest: string; - /** - * @description The UUID of a garbage collection run. - * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 - */ - garbage_collection_uuid: string; - /** - * @description A reserved IP address. - * @example 45.55.96.47 - */ - reserved_ip: string; - /** - * @description Used to filter snapshots by a resource type. - * @example droplet - */ - snapshot_resource_type: "droplet" | "volume"; - /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 - */ - snapshot_id: number | string; - /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome - */ - tag_id: string; - /** - * @description The block storage volume's name. - * @example example - */ - volume_name: string; - /** - * @description The slug identifier for the region where the resource is available. - * @example nyc3 - */ - region: components["schemas"]["region_slug"]; - /** - * @description The unique identifier for the snapshot. - * @example fbe805e8-866b-11e6-96bf-000f53315a41 - */ - volume_snapshot_id: string; - /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 - */ - volume_id: string; - /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - vpc_id: string; - /** - * @description Used to filter VPC members by a resource type. - * @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 - */ - check_id: string; - /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 - */ - parameters_alert_id: string; + databases_delete_kafka_schema: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the Kafka schema subject. + * @example customer-schema + */ + subject_name: components["parameters"]["kafka_schema_subject_name"]; + }; + 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"]; + }; }; - requestBodies: never; - headers: { - /** - * @description The default limit on number of requests that can be made per hour and per minute. Current rate limits are 5000 requests per hour and 250 requests per minute. - * @example 5000 - */ - "ratelimit-limit": number; - /** - * @description The number of requests in your hourly quota that remain before you hit your request limit. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. - * @example 4816 - */ - "ratelimit-remaining": number; - /** - * @description The time when the oldest request will expire. The value is given in Unix epoch time. See https://developers.digitalocean.com/documentation/v2/#rate-limit for information about how requests expire. - * @example 1444931833 - */ - "ratelimit-reset": number; - /** - * @description Indicates if the content is expected to be displayed *inline* in the browser, that is, as a Web page or as part of a Web page, or as an *attachment*, that is downloaded and saved locally. - * @example attachment; filename="DigitalOcean Invoice 2020 Jul (6173678-418071234).csv" - */ - "content-disposition": string; - /** - * @description The type of data that is returned from a request. - * @example application/json; charset=utf-8 - */ - "content-type": string; - /** - * @description Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue. - * @example 515850a0-a812-50bf-aa3c-d0d21d287e40 - */ - "x-request-id": string; + databases_get_kafka_schema_version: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the Kafka schema subject. + * @example customer-schema + */ + subject_name: components["parameters"]["kafka_schema_subject_name"]; + /** + * @description The version of the Kafka schema subject. + * @example 1 + */ + version: components["parameters"]["kafka_schema_version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["kafka_schema_version"]; + 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + }; }; - pathItems: never; -} -export type $defs = Record; -export interface operations { - oneClicks_list: { + databases_get_kafka_schema_config: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["database_schema_registry_config"]; + 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"]; + }; + }; + databases_update_kafka_schema_config: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "compatibility_level": "BACKWARD" + * } + */ + "application/json": { + /** + * @description The compatibility level of the schema registry. + * @enum {string} + */ + compatibility_level: "NONE" | "BACKWARD" | "BACKWARD_TRANSITIVE" | "FORWARD" | "FORWARD_TRANSITIVE" | "FULL" | "FULL_TRANSITIVE"; + }; + }; + }; + responses: { + 200: components["responses"]["database_schema_registry_config"]; + 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"]; + }; + }; + databases_get_kafka_schema_subject_config: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the Kafka schema subject. + * @example customer-schema + */ + subject_name: components["parameters"]["kafka_schema_subject_name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["database_schema_registry_subject_config"]; + 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"]; + }; + }; + databases_update_kafka_schema_subject_config: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the Kafka schema subject. + * @example customer-schema + */ + subject_name: components["parameters"]["kafka_schema_subject_name"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "compatibility_level": "BACKWARD" + * } + */ + "application/json": { + /** + * @description The compatibility level of the schema registry. + * @enum {string} + */ + compatibility_level: "NONE" | "BACKWARD" | "BACKWARD_TRANSITIVE" | "FORWARD" | "FORWARD_TRANSITIVE" | "FULL" | "FULL_TRANSITIVE"; + }; + }; + }; + responses: { + 200: components["responses"]["database_schema_registry_subject_config"]; + 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"]; + }; + }; + databases_get_cluster_metrics_credentials: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["database_metrics_auth"]; + 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"]; + }; + }; + databases_update_cluster_metrics_credentials: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "credentials": { + * "basic_auth_username": "new_username", + * "basic_auth_password": "new_password" + * } + * } + */ + "application/json": components["schemas"]["database_metrics_credentials"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + databases_list_opeasearch_indexes: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["opensearch_indexes"]; + 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"]; + }; + }; + databases_delete_opensearch_index: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the OpenSearch index. + * @example logs-* + */ + index_name: components["parameters"]["opensearch_index_name"]; + }; + 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"]; + }; + }; + domains_list: { parameters: { query?: { /** - * @description Restrict results to a certain type of 1-Click. - * @example kubernetes + * @description Number of items returned per page + * @example 2 */ - type?: components["parameters"]["oneClicks_type"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_domains_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + domains_create: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "name": "example.com" + * } + */ + "application/json": components["schemas"]["domain"]; + }; + }; + responses: { + 201: components["responses"]["create_domain_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + domains_get: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["existing_domain"]; + 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"]; + }; + }; + domains_delete: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + }; + 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"]; + }; + }; + domains_list_records: { + parameters: { + query?: { + /** + * @description A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. + * @example sub.example.com + */ + name?: components["parameters"]["domain_name_query"]; + /** + * @description The type of the DNS record. For example: A, CNAME, TXT, ... + * @example A + */ + type?: components["parameters"]["domain_type_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 The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_domain_records_response"]; + 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"]; + }; + }; + domains_create_record: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "type": "A", + * "name": "www", + * "data": "162.10.66.0", + * "priority": null, + * "port": null, + * "ttl": 1800, + * "weight": null, + * "flags": null, + * "tag": null + * } + */ + "application/json": components["schemas"]["domain_record_a"] | components["schemas"]["domain_record_aaaa"] | components["schemas"]["domain_record_caa"] | components["schemas"]["domain_record_cname"] | components["schemas"]["domain_record_mx"] | components["schemas"]["domain_record_ns"] | components["schemas"]["domain_record_soa"] | components["schemas"]["domain_record_srv"] | components["schemas"]["domain_record_txt"]; + }; + }; + responses: { + 201: components["responses"]["created_domain_record"]; + 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"]; + }; + }; + domains_get_record: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: components["parameters"]["domain_record_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["domain_record"]; + 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"]; + }; + }; + domains_update_record: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: components["parameters"]["domain_record_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + /** + * @example { + * "name": "blog", + * "type": "CNAME" + * } + */ + "application/json": components["schemas"]["domain_record"]; }; - header?: never; - path?: never; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["oneClicks_all"]; + 200: components["responses"]["domain_record"]; 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"]; }; }; - oneClicks_install_kubernetes: { + domains_delete_record: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["oneClicks_create"]; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: components["parameters"]["domain_record_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["oneClicks_create"]; + 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"]; }; }; - account_get: { + domains_patch_record: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The name of the domain itself. + * @example example.com + */ + domain_name: components["parameters"]["domain_name"]; + /** + * @description The unique identifier of the domain record. + * @example 3352896 + */ + domain_record_id: components["parameters"]["domain_record_id"]; + }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** + * @example { + * "name": "blog", + * "type": "A" + * } + */ + "application/json": components["schemas"]["domain_record"]; + }; + }; responses: { - 200: components["responses"]["account"]; + 200: components["responses"]["domain_record"]; 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"]; }; }; - sshKeys_list: { + droplets_list: { parameters: { query?: { /** @@ -22906,6 +35563,21 @@ export interface operations { * @example 1 */ page?: components["parameters"]["page"]; + /** + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`.
Requires `tag:read` scope. + * @example env:prod + */ + tag_name?: components["parameters"]["droplet_tag_name"]; + /** + * @description Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with `tag_name`. + * @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; @@ -22913,49 +35585,72 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["sshKeys_all"]; + 200: components["responses"]["all_droplets"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - sshKeys_create: { + droplets_create: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["sshKeys"]; + "application/json": components["schemas"]["droplet_single_create"] | components["schemas"]["droplet_multi_create"]; }; }; responses: { - 201: components["responses"]["sshKeys_new"]; + 202: components["responses"]["droplet_create"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - sshKeys_get: { + droplets_destroy_byTag: { + parameters: { + query: { + /** + * @description Specifies Droplets to be deleted by tag. + * @example env:test + */ + tag_name: components["parameters"]["droplet_delete_tag_name"]; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content_with_content_type"]; + 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"]; + }; + }; + droplets_get: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID or the fingerprint of an existing SSH key. - * @example 512189 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["sshKeys_existing"]; + 200: components["responses"]["existing_droplet"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22963,29 +35658,56 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sshKeys_update: { + droplets_destroy: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID or the fingerprint of an existing SSH key. - * @example 512189 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; - /** @description Set the `name` attribute to the new name you want to use. */ - requestBody: { - content: { - "application/json": { - name?: components["schemas"]["ssh_key_name"]; - }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content_with_content_type"]; + 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"]; + }; + }; + droplets_list_backups: { + 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 Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["sshKeys_existing"]; + 200: components["responses"]["all_droplet_backups"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22993,22 +35715,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sshKeys_delete: { + droplets_get_backup_policy: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID or the fingerprint of an existing SSH key. - * @example 512189 + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - ssh_key_identifier: components["parameters"]["ssh_key_identifier"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["droplet_backup_policy"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23016,7 +35738,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - actions_list: { + droplets_list_backup_policies: { parameters: { query?: { /** @@ -23036,29 +35758,24 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["actions"]; + 200: components["responses"]["all_droplet_backup_policies"]; 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"]; }; }; - actions_get: { + droplets_list_supported_backup_policies: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 - */ - action_id: components["parameters"]["action_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["action"]; + 200: components["responses"]["droplets_supported_backup_policies"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23066,121 +35783,192 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list: { + droplets_list_snapshots: { 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 Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["all_droplet_snapshots"]; + 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"]; + }; + }; + dropletActions_list: { + parameters: { + query?: { /** * @description Number of items returned per page * @example 2 */ per_page?: components["parameters"]["per_page"]; /** - * @description Whether the project_id of listed apps should be fetched and included. - * @example true + * @description Which 'page' of paginated results to return. + * @example 1 */ - with_projects?: components["parameters"]["with_projects"]; + page?: components["parameters"]["page"]; }; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_apps"]; + 200: components["responses"]["all_droplet_actions"]; 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"]; }; }; - apps_create: { + dropletActions_post: { parameters: { query?: never; - header?: { + header?: never; + path: { /** - * @description The content-type that should be used by the response. By default, the response will be `application/json`. `application/yaml` is also supported. - * @example application/json + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - Accept?: components["parameters"]["accept"]; + droplet_id: components["parameters"]["droplet_id"]; + }; + cookie?: never; + }; + /** + * @description The `type` attribute set in the request body will specify the action that + * will be taken on the Droplet. Some actions will require additional + * attributes to be set as well. + */ + requestBody?: { + content: { + "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_enable_backups"] | components["schemas"]["droplet_action_change_backup_policy"] | components["schemas"]["droplet_action_restore"] | components["schemas"]["droplet_action_resize"] | components["schemas"]["droplet_action_rebuild"] | components["schemas"]["droplet_action_rename"] | components["schemas"]["droplet_action_change_kernel"] | components["schemas"]["droplet_action_snapshot"]; + }; + }; + responses: { + 201: components["responses"]["droplet_action"]; + 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"]; + }; + }; + dropletActions_post_byTag: { + parameters: { + query?: { /** - * @description The content-type used for the request. By default, the requests are assumed to use `application/json`. `application/yaml` is also supported. - * @example application/json + * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`.
Requires `tag:read` scope. + * @example env:prod */ - "Content-Type"?: components["parameters"]["content-type"]; + tag_name?: components["parameters"]["droplet_tag_name"]; }; + header?: never; path?: never; cookie?: never; }; - requestBody: { + /** + * @description The `type` attribute set in the request body will specify the action that + * will be taken on the Droplet. Some actions will require additional + * attributes to be set as well. + */ + requestBody?: { content: { + "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_snapshot"]; + }; + }; + responses: { + 201: components["responses"]["droplet_actions_response"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + dropletActions_get: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "spec": { - * "name": "web-app", - * "region": "nyc", - * "services": [ - * { - * "name": "api", - * "github": { - * "branch": "main", - * "deploy_on_push": true, - * "repo": "digitalocean/sample-golang" - * }, - * "run_command": "bin/api", - * "environment_slug": "node-js", - * "instance_count": 2, - * "instance_size_slug": "apps-s-1vcpu-0.5gb", - * "routes": [ - * { - * "path": "/api" - * } - * ] - * } - * ], - * "egress": { - * "type": "DEDICATED_IP" - * } - * } - * } + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - "application/json": components["schemas"]["apps_create_app_request"]; + droplet_id: components["parameters"]["droplet_id"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["new_app"]; + 200: components["responses"]["action"]; 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"]; }; }; - apps_get: { + droplets_list_kernels: { parameters: { query?: { /** - * @description The name of the app to retrieve. - * @example myApp + * @description Number of items returned per page + * @example 2 */ - name?: components["parameters"]["app_name"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; header?: never; path: { /** - * @description The ID of the app - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - id: components["parameters"]["id_app"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["apps_get"]; + 200: components["responses"]["all_kernels"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23188,26 +35976,56 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_update: { + droplets_list_firewalls: { 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: { /** - * @description The ID of the app - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - id: components["parameters"]["id_app"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["apps_update_app_request"]; + requestBody?: never; + responses: { + 200: components["responses"]["all_firewalls"]; + 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"]; + }; + }; + droplets_list_neighbors: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a Droplet instance. + * @example 3164444 + */ + droplet_id: components["parameters"]["droplet_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["update_app"]; + 200: components["responses"]["neighbor_droplets"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23215,22 +36033,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_delete: { + droplets_list_associatedResources: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the app - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - id: components["parameters"]["id_app"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["delete_app"]; + 200: components["responses"]["associated_resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23238,26 +36056,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_restart: { + droplets_destroy_withAssociatedResourcesSelective: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - app_id: components["parameters"]["app_id"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apps_restart_request"]; + "application/json": components["schemas"]["selective_destroy_associated_resource"]; }; }; responses: { - 200: components["responses"]["new_app_deployment"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23265,47 +36083,51 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_active_deployment: { + droplets_destroy_withAssociatedResourcesDangerous: { parameters: { - query: { + query?: never; + header: { /** - * @description Whether the logs should follow live updates. + * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. * @example true */ - follow?: components["parameters"]["live_updates"]; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - type: components["parameters"]["log_type"]; + "X-Dangerous": components["parameters"]["x_dangerous"]; + }; + path: { /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - pod_connection_timeout?: components["parameters"]["time_wait"]; + droplet_id: components["parameters"]["droplet_id"]; }; + cookie?: never; + }; + requestBody?: never; + 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"]; + }; + }; + droplets_get_DestroyAssociatedResourcesStatus: { + parameters: { + query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - component_name: components["parameters"]["component"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 200: components["responses"]["associated_resources_status"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23313,116 +36135,98 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_exec_active_deployment: { + droplets_destroy_retryWithAssociatedResources: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component + * @description A unique identifier for a Droplet instance. + * @example 3164444 */ - component_name: components["parameters"]["component"]; + droplet_id: components["parameters"]["droplet_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_exec"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_list_deployments: { + autoscalepools_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 Number of items returned per page - * @example 2 + * @description The name of the autoscale pool + * @example my-autoscale-pool */ - per_page?: components["parameters"]["per_page"]; + name?: components["parameters"]["autoscale_pool_name"]; }; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_deployments"]; + 200: components["responses"]["all_autoscale_pools"]; 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"]; }; }; - apps_create_deployment: { + autoscalepools_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["apps_create_deployment_request"]; + "application/json": components["schemas"]["autoscale_pool_create"]; }; }; responses: { - 200: components["responses"]["new_app_deployment"]; + 202: components["responses"]["autoscale_pool_create"]; 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"]; }; }; - apps_get_deployment: { + autoscalepools_get: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - deployment_id: components["parameters"]["deployment_id"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_deployment"]; + 200: components["responses"]["existing_autoscale_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23430,27 +36234,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_cancel_deployment: { + autoscalepools_update: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - deployment_id: components["parameters"]["deployment_id"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["autoscale_pool_create"]; + }; + }; responses: { - 200: components["responses"]["cancel_deployment"]; + 200: components["responses"]["autoscale_pool_create"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23458,52 +36261,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs: { + autoscalepools_delete: { parameters: { - query: { - /** - * @description Whether the logs should follow live updates. - * @example true - */ - follow?: components["parameters"]["live_updates"]; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - type: components["parameters"]["log_type"]; - /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m - */ - pod_connection_timeout?: components["parameters"]["time_wait"]; - }; + query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a - */ - deployment_id: components["parameters"]["deployment_id"]; - /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - component_name: components["parameters"]["component"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23511,47 +36284,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_aggregate: { + autoscalepools_delete_dangerous: { parameters: { - query: { + query?: never; + header: { /** - * @description Whether the logs should follow live updates. + * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. * @example true */ - follow?: components["parameters"]["live_updates"]; - /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD - */ - type: components["parameters"]["log_type"]; - /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m - */ - pod_connection_timeout?: components["parameters"]["time_wait"]; + "X-Dangerous": components["parameters"]["parameters_x_dangerous"]; }; - header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - deployment_id: components["parameters"]["deployment_id"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23559,32 +36313,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_exec: { + autoscalepools_list_members: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description Number of items returned per page + * @example 2 */ - app_id: components["parameters"]["app_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The deployment ID - * @example 3aa4d20e-5527-4c00-b496-601fbd22520a + * @description Which 'page' of paginated results to return. + * @example 1 */ - deployment_id: components["parameters"]["deployment_id"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description An optional component name. If set, logs will be limited to this component only. - * @example component + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - component_name: components["parameters"]["component"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_exec"]; + 200: components["responses"]["all_members"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23592,42 +36347,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_get_logs_active_deployment_aggregate: { + autoscalepools_list_history: { parameters: { - query: { - /** - * @description Whether the logs should follow live updates. - * @example true - */ - follow?: components["parameters"]["live_updates"]; + query?: { /** - * @description The type of logs to retrieve - * - BUILD: Build-time logs - * - DEPLOY: Deploy-time logs - * - RUN: Live run-time logs - * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime - * @example BUILD + * @description Number of items returned per page + * @example 2 */ - type: components["parameters"]["log_type"]; + per_page?: components["parameters"]["per_page"]; /** - * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. - * @example 3m + * @description Which 'page' of paginated results to return. + * @example 1 */ - pod_connection_timeout?: components["parameters"]["time_wait"]; + page?: components["parameters"]["page"]; }; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - app_id: components["parameters"]["app_id"]; + autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_logs"]; + 200: components["responses"]["history_events"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23635,125 +36381,210 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_instanceSizes: { + firewalls_list: { 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?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_instance"]; + 200: components["responses"]["list_firewalls_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - apps_get_instanceSize: { + firewalls_create: { parameters: { query?: never; header?: never; - path: { + path?: never; + cookie?: never; + }; + requestBody?: { + content: { /** - * @description The slug of the instance size - * @example apps-s-1vcpu-0.5gb + * @example { + * "name": "firewall", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" + * ] + * } + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "80", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "droplet_ids": [ + * 8043964 + * ] + * } */ - slug: components["parameters"]["slug_size"]; + "application/json": components["schemas"]["firewall"] & unknown & (unknown | unknown); }; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["get_instance"]; + 202: components["responses"]["create_firewall_response"]; + 400: components["responses"]["bad_request"]; 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"]; }; }; - apps_list_regions: { + firewalls_get: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c + */ + firewall_id: components["parameters"]["firewall_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_regions"]; + 200: components["responses"]["get_firewall_response"]; 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"]; }; }; - apps_validate_appSpec: { + firewalls_update: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c + */ + firewall_id: components["parameters"]["firewall_id"]; + }; cookie?: never; }; - requestBody: { + requestBody?: { content: { /** * @example { - * "spec": { - * "name": "web-app", - * "region": "nyc", - * "services": [ - * { - * "name": "api", - * "github": { - * "branch": "main", - * "deploy_on_push": true, - * "repo": "digitalocean/sample-golang" - * }, - * "run_command": "bin/api", - * "environment_slug": "node-js", - * "instance_count": 2, - * "instance_size_slug": "apps-s-1vcpu-0.5gb", - * "routes": [ - * { - * "path": "/api" - * } + * "name": "frontend-firewall", + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "8080", + * "sources": { + * "load_balancer_uids": [ + * "4de7ac8b-495b-4884-9a69-1050c6793cd6" * ] * } - * ] - * }, - * "app_id": "b6bdf840-2854-4f87-a36c-5f231c617c84" + * }, + * { + * "protocol": "tcp", + * "ports": "22", + * "sources": { + * "tags": [ + * "gateway" + * ], + * "addresses": [ + * "18.0.0.0/8" + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "8080", + * "destinations": { + * "addresses": [ + * "0.0.0.0/0", + * "::/0" + * ] + * } + * } + * ], + * "droplet_ids": [ + * 8043964 + * ], + * "tags": [ + * "frontend" + * ] * } */ - "application/json": components["schemas"]["app_propose"]; + "application/json": components["schemas"]["firewall"] & (unknown | unknown); }; }; responses: { - 200: components["responses"]["propose_app"]; + 200: components["responses"]["put_firewall_response"]; + 400: components["responses"]["bad_request"]; 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"]; }; }; - apps_list_alerts: { + firewalls_delete: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - app_id: components["parameters"]["app_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_alerts"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23761,31 +36592,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_assign_alertDestinations: { + firewalls_assign_droplets: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf - */ - app_id: components["parameters"]["app_id"]; - /** - * @description The alert ID - * @example 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - alert_id: components["parameters"]["alert_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["apps_assign_app_alert_destinations_request"]; + /** + * @example { + * "droplet_ids": [ + * 49696269 + * ] + * } + */ + "application/json": { + /** + * @description An array containing the IDs of the Droplets to be assigned to the firewall. + * @example [ + * 49696269 + * ] + */ + droplet_ids: number[]; + }; }; }; responses: { - 200: components["responses"]["assign_alert_destinations"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23793,26 +36635,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_create_rollback: { + firewalls_delete_droplets: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - app_id: components["parameters"]["app_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["apps_rollback_app_request"]; + /** + * @example { + * "droplet_ids": [ + * 49696269 + * ] + * } + */ + "application/json": { + /** + * @description An array containing the IDs of the Droplets to be removed from the firewall. + * @example [ + * 49696269 + * ] + */ + droplet_ids: number[]; + }; }; }; responses: { - 200: components["responses"]["new_app_deployment"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23820,26 +36678,36 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_validate_rollback: { + firewalls_add_tags: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - app_id: components["parameters"]["app_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["apps_rollback_app_request"]; + /** + * @example { + * "tags": [ + * "frontend" + * ] + * } + */ + "application/json": { + tags: components["schemas"]["existing_tags_array"] & unknown; + }; }; }; responses: { - 200: components["responses"]["apps_validate_rollback"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23847,22 +36715,36 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_commit_rollback: { + firewalls_delete_tags: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - app_id: components["parameters"]["app_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + /** + * @example { + * "tags": [ + * "frontend" + * ] + * } + */ + "application/json": { + tags: components["schemas"]["existing_tags_array"] & unknown; + }; + }; + }; responses: { - 200: components["responses"]["no_content"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23870,51 +36752,53 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_revert_rollback: { + firewalls_add_rules: { parameters: { query?: never; header?: never; path: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c */ - app_id: components["parameters"]["app_id"]; + firewall_id: components["parameters"]["firewall_id"]; }; cookie?: never; }; - requestBody?: never; - responses: { - 200: components["responses"]["new_app_deployment"]; - 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"]; - }; - }; - apps_get_metrics_bandwidth_daily: { - parameters: { - query?: { - /** - * @description Optional day to query. Only the date component of the timestamp will be considered. Default: yesterday. - * @example 2023-01-17T00:00:00Z - */ - date?: string; - }; - header?: never; - path: { + requestBody?: { + content: { /** - * @description The app ID - * @example 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf + * @example { + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "sources": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ], + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "destinations": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ] + * } */ - app_id: components["parameters"]["app_id"]; + "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); }; - cookie?: never; }; - requestBody?: never; responses: { - 200: components["responses"]["get_metrics_bandwidth_usage"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23922,29 +36806,53 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - apps_list_metrics_bandwidth_daily: { + firewalls_delete_rules: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique ID that can be used to identify and reference a firewall. + * @example bb4b2611-3d72-467b-8602-280330ecd65c + */ + firewall_id: components["parameters"]["firewall_id"]; + }; cookie?: never; }; - requestBody: { + requestBody?: { content: { /** * @example { - * "app_ids": [ - * "4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf", - * "c2a93513-8d9b-4223-9d61-5e7272c81cf5" + * "inbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "sources": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } * ], - * "date": "2023-01-17T00:00:00Z" + * "outbound_rules": [ + * { + * "protocol": "tcp", + * "ports": "3306", + * "destinations": { + * "droplet_ids": [ + * 49696269 + * ] + * } + * } + * ] * } */ - "application/json": components["schemas"]["app_metrics_bandwidth_usage_request"]; + "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); }; }; responses: { - 200: components["responses"]["list_metrics_bandwidth_usage"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -23952,7 +36860,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_list_endpoints: { + floatingIPs_list: { parameters: { query?: { /** @@ -23972,14 +36880,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_cdn_endpoints"]; + 200: components["responses"]["floating_ip_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - cdn_create_endpoint: { + floatingIPs_create: { parameters: { query?: never; header?: never; @@ -23988,33 +36896,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["cdn_endpoint"]; + "application/json": components["schemas"]["floating_ip_create"]; }; }; responses: { - 201: components["responses"]["existing_endpoint"]; + 202: components["responses"]["floating_ip_created"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - cdn_get_endpoint: { + floatingIPs_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A floating IP address. + * @example 45.55.96.47 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_endpoint"]; + 200: components["responses"]["floating_ip"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24022,26 +36930,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_update_endpoints: { + floatingIPs_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A floating IP address. + * @example 45.55.96.47 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["update_endpoint"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_endpoint"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24049,22 +36953,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_delete_endpoint: { + floatingIPsAction_list: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A floating IP address. + * @example 45.55.96.47 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["floating_ip_actions"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24072,26 +36976,30 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - cdn_purge_cache: { + floatingIPsAction_post: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a CDN endpoint. - * @example 19f06b6a-3ace-4315-b086-499a0e521b76 + * @description A floating IP address. + * @example 45.55.96.47 */ - cdn_id: components["parameters"]["cdn_endpoint_id"]; + floating_ip: components["parameters"]["floating_ip"]; }; cookie?: never; }; - requestBody: { + /** + * @description The `type` attribute set in the request body will specify the action that + * will be taken on the floating IP. + */ + requestBody?: { content: { - "application/json": components["schemas"]["purge_cache"]; + "application/json": components["schemas"]["floating_ip_action_unassign"] | components["schemas"]["floating_ip_action_assign"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["floating_ip_action"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24099,293 +37007,288 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - certificates_list: { + floatingIPsAction_get: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A floating IP address. + * @example 45.55.96.47 */ - page?: components["parameters"]["page"]; + floating_ip: components["parameters"]["floating_ip"]; /** - * @description Name of expected certificate - * @example certificate-name + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 */ - name?: components["parameters"]["certificate_name"]; + action_id: components["parameters"]["action_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_certificates"]; + 200: components["responses"]["floating_ip_action"]; 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"]; }; }; - certificates_create: { + functions_list_namespaces: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["certificate_request_lets_encrypt"] | components["schemas"]["certificate_request_custom"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["new_certificate"]; + 200: components["responses"]["list_namespaces"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - certificates_get: { + functions_create_namespace: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a certificate. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - certificate_id: components["parameters"]["certificate_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["create_namespace"]; + }; + }; responses: { - 200: components["responses"]["existing_certificate"]; + 200: components["responses"]["namespace_created"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["namespace_bad_request"]; + 422: components["responses"]["namespace_limit_reached"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - certificates_delete: { + functions_get_namespace: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a certificate. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - certificate_id: components["parameters"]["certificate_id"]; + namespace_id: components["parameters"]["namespace_id"]; }; 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"]; - }; - }; - balance_get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["balance"]; + 200: components["responses"]["namespace_created"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 403: components["responses"]["namespace_not_allowed"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - billingHistory_list: { + functions_delete_namespace: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["billing_history"]; - 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"]; - }; - }; - invoices_list: { - parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - page?: components["parameters"]["page"]; + namespace_id: components["parameters"]["namespace_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["invoices"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - invoices_get_byUUID: { + functions_list_triggers: { 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"]; - }; + query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + namespace_id: components["parameters"]["namespace_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["invoice"]; + 200: components["responses"]["list_triggers"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["namespace_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - invoices_get_csvByUUID: { + functions_create_trigger: { parameters: { query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + namespace_id: components["parameters"]["namespace_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["create_trigger"]; + }; + }; responses: { - 200: components["responses"]["invoice_csv"]; + 200: components["responses"]["trigger_response"]; + 400: components["responses"]["trigger_bad_request"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["namespace_not_found"]; + 422: components["responses"]["trigger_limit_reached"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - invoices_get_pdfByUUID: { + functions_get_trigger: { parameters: { query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + namespace_id: components["parameters"]["namespace_id"]; + /** + * @description The name of the trigger to be managed. + * @example my trigger + */ + trigger_name: components["parameters"]["trigger_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["invoice_pdf"]; + 200: components["responses"]["trigger_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - invoices_get_summaryByUUID: { + functions_update_trigger: { parameters: { query?: never; header?: never; path: { /** - * @description UUID of the invoice - * @example 22737513-0ea7-4206-8ceb-98a575af7681 + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx */ - invoice_uuid: components["parameters"]["invoice_uuid"]; + namespace_id: components["parameters"]["namespace_id"]; + /** + * @description The name of the trigger to be managed. + * @example my trigger + */ + trigger_name: components["parameters"]["trigger_name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["update_trigger"]; + }; + }; responses: { - 200: components["responses"]["invoice_summary"]; + 200: components["responses"]["trigger_response"]; + 400: components["responses"]["trigger_bad_request"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_list_options: { + functions_delete_trigger: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The ID of the namespace to be managed. + * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + */ + namespace_id: components["parameters"]["namespace_id"]; + /** + * @description The name of the trigger to be managed. + * @example my trigger + */ + trigger_name: components["parameters"]["trigger_name"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["options"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 404: components["responses"]["trigger_not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - databases_list_clusters: { + images_list: { parameters: { query?: { /** - * @description Limits the results to database clusters with a specific tag. - * @example production + * @description Filters results based on image type which can be either `application` or `distribution`. + * @example distribution */ - tag_name?: components["parameters"]["tag_name"]; + type?: components["parameters"]["type"]; + /** + * @description Used to filter only user images. + * @example true + */ + private?: components["parameters"]["private"]; + /** + * @description Used to filter images by a specific tag. + * @example base-image + */ + tag_name?: components["parameters"]["tag"]; + /** + * @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?: never; @@ -24393,15 +37296,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["database_clusters"]; + 200: components["responses"]["all_images"]; 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"]; }; }; - databases_create_cluster: { + images_create_custom: { parameters: { query?: never; header?: never; @@ -24410,36 +37312,37 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["database_cluster"] & { - backup_restore?: components["schemas"]["database_backup"]; - }; + "application/json": components["schemas"]["image_new_custom"]; }; }; responses: { - 201: components["responses"]["database_cluster"]; + 202: components["responses"]["new_custom_image"]; 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"]; }; }; - databases_get_cluster: { + images_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique number (id) or string (slug) used to identify and reference a + * specific image. + * + * **Public** images can be identified by image `id` or `slug`. + * + * **Private** images *must* be identified by image `id`. */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + image_id: number | string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_cluster"]; + 200: components["responses"]["existing_image"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24447,22 +37350,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_destroy_cluster: { + images_update: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + image_id: components["parameters"]["image_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["image_update"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["updated_image"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24470,22 +37377,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_config: { + images_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + image_id: components["parameters"]["image_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_config"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24493,34 +37400,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_patch_config: { + imageActions_list: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + image_id: components["parameters"]["image_id"]; }; cookie?: never; }; - requestBody: { - content: { + requestBody?: never; + responses: { + 200: components["responses"]["get_image_actions_response"]; + 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"]; + }; + }; + imageActions_post: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "config": { - * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES", - * "sql_require_primary_key": true - * } - * } + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - "application/json": components["schemas"]["database_config"]; + image_id: components["parameters"]["image_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["image_action_base"] | components["schemas"]["image_action_transfer"]; }; }; responses: { - 200: components["responses"]["no_content"]; + 201: components["responses"]["post_image_action_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24528,22 +37450,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_ca: { + imageActions_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique number that can be used to identify and reference a specific image. + * @example 62137902 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + image_id: components["parameters"]["image_id"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["ca"]; + 200: components["responses"]["get_image_action_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24551,93 +37478,69 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_migrationStatus: { + kubernetes_list_clusters: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Number of items returned per page + * @example 2 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["online_migration"]; + 200: components["responses"]["all_clusters"]; 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"]; }; }; - databases_update_onlineMigration: { + kubernetes_create_cluster: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "source": { - * "host": "source-do-user-6607903-0.b.db.ondigitalocean.com", - * "dbname": "defaultdb", - * "port": 25060, - * "username": "doadmin", - * "password": "paakjnfe10rsrsmf" - * }, - * "disable_ssl": false, - * "ignore_dbs": [ - * "db0", - * "db1" - * ] - * } - */ - "application/json": components["schemas"]["source_database"]; + "application/json": components["schemas"]["cluster"]; }; }; responses: { - 200: components["responses"]["online_migration"]; + 201: components["responses"]["cluster_create"]; 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"]; }; }; - databases_delete_onlineMigration: { + kubernetes_get_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description A unique identifier assigned to the online migration. - * @example 77b28fc8-19ff-11eb-8c9c-c68e24557488 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - migration_id: components["parameters"]["migration_id"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24645,32 +37548,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_region: { + kubernetes_update_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description A slug identifier for the region to which the database cluster will be migrated. - * @example lon1 - */ - region: string; - }; + "application/json": components["schemas"]["cluster_update"]; }; }; responses: { - 202: components["responses"]["accepted"]; + 202: components["responses"]["updated_cluster"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24678,33 +37575,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_clusterSize: { + kubernetes_delete_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody: { - content: { - /** - * @example { - * "size": "db-s-4vcpu-8gb", - * "num_nodes": 3, - * "storage_size_mib": 163840 - * } - */ - "application/json": components["schemas"]["database_cluster_resize"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["no_content"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24712,22 +37598,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_firewall_rules: { + kubernetes_list_associatedResources: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["firewall_rules"]; + 200: components["responses"]["associated_kubernetes_resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24735,46 +37621,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_firewall_rules: { + kubernetes_destroy_associatedResourcesSelective: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "rules": [ - * { - * "type": "ip_addr", - * "value": "192.168.1.1" - * }, - * { - * "type": "k8s", - * "value": "ff2a6c52-5a44-4b63-b99c-0e98e7a63d61" - * }, - * { - * "type": "droplet", - * "value": "163973392" - * }, - * { - * "type": "tag", - * "value": "backend" - * } - * ] - * } - */ - "application/json": { - rules?: components["schemas"]["firewall_rule"][]; - }; + "application/json": components["schemas"]["destroy_associated_kubernetes_resources"]; }; }; responses: { @@ -24786,30 +37648,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_maintenanceWindow: { + kubernetes_destroy_associatedResourcesDangerous: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody: { - content: { - /** - * @example { - * "day": "tuesday", - * "hour": "14:00" - * } - */ - "application/json": components["schemas"]["database_maintenance_window"]; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -24819,22 +37671,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_install_update: { + kubernetes_get_kubeconfig: { parameters: { - query?: never; + query?: { + /** + * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. + * @example 300 + */ + expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; + }; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["kubeconfig"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24842,22 +37700,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_backups: { + kubernetes_get_credentials: { parameters: { - query?: never; + query?: { + /** + * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. + * @example 300 + */ + expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; + }; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_backups"]; + 200: components["responses"]["credentials"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24865,22 +37729,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_replicas: { + kubernetes_get_availableUpgrades: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_replicas"]; + 200: components["responses"]["available_upgrades"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24888,34 +37752,55 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_create_replica: { + kubernetes_upgrade_cluster: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { + "application/json": { + /** + * @description The slug identifier for the version of Kubernetes that the cluster will be upgraded to. + * @example 1.16.13-do.0 + */ + version?: string; + }; + }; + }; + 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"]; + }; + }; + kubernetes_list_nodePools: { + parameters: { + query?: never; + header?: never; + path: { /** - * @example { - * "name": "read-nyc3-01", - * "region": "nyc3", - * "size": "db-s-2vcpu-4gb", - * "storage_size_mib": 61440 - * } + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - "application/json": WithRequired; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 201: components["responses"]["database_replica"]; + 200: components["responses"]["all_node_pools"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24923,22 +37808,39 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_events_logs: { + kubernetes_add_nodePool: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** + * @example { + * "size": "s-1vcpu-2gb", + * "count": 3, + * "name": "new-pool", + * "tags": [ + * "frontend" + * ], + * "auto_scale": true, + * "min_nodes": 3, + * "max_nodes": 6 + * } + */ + "application/json": components["schemas"]["kubernetes_node_pool"]; + }; + }; responses: { - 200: components["responses"]["events_logs"]; + 201: components["responses"]["node_pool_create"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24946,27 +37848,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_replica: { + kubernetes_get_nodePool: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; /** - * @description The name of the database replica. - * @example read-nyc3-01 + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - replica_name: components["parameters"]["replica_name"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_replica"]; + 200: components["responses"]["existing_node_pool"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -24974,27 +37876,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_destroy_replica: { + kubernetes_update_nodePool: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; /** - * @description The name of the database replica. - * @example read-nyc3-01 + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - replica_name: components["parameters"]["replica_name"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["kubernetes_node_pool_update"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["node_pool_update"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25002,21 +37908,21 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_promote_replica: { + kubernetes_delete_nodePool: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; /** - * @description The name of the database replica. - * @example read-nyc3-01 + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d */ - replica_name: components["parameters"]["replica_name"]; + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; @@ -25030,22 +37936,43 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_users: { + kubernetes_delete_node: { parameters: { - query?: never; + query?: { + /** + * @description Specifies whether or not to drain workloads from a node before it is deleted. Setting it to `1` causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. + * @example 1 + */ + skip_drain?: components["parameters"]["kubernetes_node_skip_drain"]; + /** + * @description Specifies whether or not to replace a node after it has been deleted. Setting it to `1` causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. + * @example 1 + */ + replace?: components["parameters"]["kubernetes_node_replace"]; + }; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + /** + * @description A unique ID that can be used to reference a node in a Kubernetes node pool. + * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f + */ + node_id: components["parameters"]["kubernetes_node_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["users"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25053,33 +37980,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_add_user: { + kubernetes_recycle_node_pool: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; + /** + * @description A unique ID that can be used to reference a Kubernetes node pool. + * @example cdda885e-7663-40c8-bc74-3a036c66545d + */ + node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["database_user"] & { + "application/json": { /** - * @description For MongoDB clusters, set to `true` to create a read-only user. - * This option is not currently supported for other database engines. - * @example true + * @example [ + * "d8db5e1a-6103-43b5-a7b3-8a948210a9fc" + * ] */ - readonly?: boolean; + nodes?: string[]; }; }; }; responses: { - 201: components["responses"]["user"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25087,27 +38019,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_user: { + kubernetes_get_clusterUser: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database user. - * @example app-01 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - username: components["parameters"]["username"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["user"]; + 200: components["responses"]["cluster_user"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25115,33 +38042,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_user: { + kubernetes_list_options: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database user. - * @example app-01 - */ - username: components["parameters"]["username"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - settings: components["schemas"]["user_settings"]; - }; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["user"]; + 200: components["responses"]["all_options"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25149,27 +38059,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_user: { + kubernetes_get_clusterLintResults: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Specifies the clusterlint run whose results will be retrieved. + * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + run_id?: components["parameters"]["clusterlint_run_id"]; + }; + header?: never; + path: { /** - * @description The name of the database user. - * @example app-01 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - username: components["parameters"]["username"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["clusterlint_results"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25177,40 +38088,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_reset_auth: { + kubernetes_run_clusterLint: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database user. - * @example app-01 + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - username: components["parameters"]["username"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; - requestBody: { - content: { - /** - * @example { - * "mysql_settings": { - * "auth_plugin": "caching_sha2_password" - * } - * } - */ - "application/json": { - mysql_settings?: components["schemas"]["mysql_settings"]; - }; + requestBody?: { + content: { + "application/json": components["schemas"]["clusterlint_request"]; }; }; responses: { - 200: components["responses"]["user"]; + 202: components["responses"]["clusterlint_run"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25218,110 +38115,108 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list: { + kubernetes_add_registry: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["cluster_registry"]; + }; + }; responses: { - 200: components["responses"]["databases"]; + 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"]; }; }; - databases_add: { + kubernetes_remove_registry: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - /** - * @example { - * "name": "alpha" - * } - */ - "application/json": components["schemas"]["database"]; + "application/json": components["schemas"]["cluster_registry"]; }; }; responses: { - 201: components["responses"]["database"]; + 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"]; }; }; - databases_get: { + kubernetes_add_registries: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name of the database. - * @example alpha - */ - database_name: components["parameters"]["database_name"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["cluster_registries"]; + }; + }; responses: { - 200: components["responses"]["database"]; + 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"]; }; }; - databases_delete: { + kubernetes_remove_registries: { parameters: { query?: never; header?: never; - path: { + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["cluster_registries"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; + kubernetes_get_status_messages: { + parameters: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A timestamp used to return status messages emitted since the specified time. The timestamp should be in ISO8601 format. + * @example 2018-11-15T16:00:11Z */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + since?: components["parameters"]["kubernetes_status_messages_since"]; + }; + header?: never; + path: { /** - * @description The name of the database. - * @example alpha + * @description A unique ID that can be used to reference a Kubernetes cluster. + * @example bd5f5959-5e1e-4205-a714-a914373942af */ - database_name: components["parameters"]["database_name"]; + cluster_id: components["parameters"]["kubernetes_cluster_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["status_messages"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25329,86 +38224,69 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_connectionPools: { + loadBalancers_list: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Number of items returned per page + * @example 2 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["connection_pools"]; + 200: components["responses"]["all_load_balancers"]; 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"]; }; }; - databases_add_connectionPool: { + loadBalancers_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "name": "backend-pool", - * "mode": "transaction", - * "size": 10, - * "db": "defaultdb", - * "user": "doadmin" - * } - */ - "application/json": components["schemas"]["connection_pool"]; + "application/json": components["schemas"]["load_balancer_create"]; }; }; responses: { - 201: components["responses"]["connection_pool"]; + 202: components["responses"]["load_balancer_create"]; 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"]; }; }; - databases_get_connectionPool: { + loadBalancers_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the connection pool. - * @example backend-pool + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - pool_name: components["parameters"]["pool_name"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["connection_pool"]; + 200: components["responses"]["existing_load_balancer"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25416,39 +38294,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_connectionPool: { + loadBalancers_update: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the connection pool. - * @example backend-pool + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - pool_name: components["parameters"]["pool_name"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "mode": "transaction", - * "size": 10, - * "db": "defaultdb", - * "user": "doadmin" - * } - */ - "application/json": components["schemas"]["connection_pool_update"]; + "application/json": components["schemas"]["load_balancer_create"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["updated_load_balancer"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25456,21 +38321,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_connectionPool: { + loadBalancers_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the connection pool. - * @example backend-pool + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - pool_name: components["parameters"]["pool_name"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; @@ -25484,22 +38344,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_evictionPolicy: { + loadBalancers_delete_cache: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["eviction_policy_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25507,28 +38367,30 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_evictionPolicy: { + loadBalancers_add_droplets: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "eviction_policy": "allkeys_lru" - * } - */ "application/json": { - eviction_policy: components["schemas"]["eviction_policy_model"]; + /** + * @description An array containing the IDs of the Droplets assigned to the load balancer. + * @example [ + * 3164444, + * 3164445 + * ] + */ + droplet_ids: number[]; }; }; }; @@ -25541,22 +38403,35 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_get_sql_mode: { + loadBalancers_remove_droplets: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description An array containing the IDs of the Droplets assigned to the load balancer. + * @example [ + * 3164444, + * 3164445 + * ] + */ + droplet_ids: number[]; + }; + }; + }; responses: { - 200: components["responses"]["sql_mode"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25564,27 +38439,24 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_sql_mode: { + loadBalancers_add_forwardingRules: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "sql_mode": "ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE" - * } - */ - "application/json": components["schemas"]["sql_mode"]; + "application/json": { + forwarding_rules: components["schemas"]["forwarding_rule"][]; + }; }; }; responses: { @@ -25596,27 +38468,24 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_major_version: { + loadBalancers_remove_forwardingRules: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + lb_id: components["parameters"]["load_balancer_id"]; }; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "version": "14" - * } - */ - "application/json": components["schemas"]["version-2"]; + "application/json": { + forwarding_rules: components["schemas"]["forwarding_rule"][]; + }; }; }; responses: { @@ -25628,88 +38497,111 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_list_kafka_topics: { + monitoring_list_alertPolicy: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description Number of items returned per page + * @example 2 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["kafka_topics"]; + 200: components["responses"]["list_alert_policy_response"]; 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"]; }; }; - databases_create_kafka_topic: { + monitoring_create_alertPolicy: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - }; + path?: never; cookie?: never; }; - requestBody?: { + /** + * @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: + * + * Type | Description | Valid Entity Type + * -----|-------------|-------------------- + * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID + * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID + * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID + * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID + * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID + * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID + * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID + * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID + * `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 (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 + * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID + * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID + * `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID + */ + requestBody: { content: { - /** - * @example { - * "name": "customer-events", - * "partitions": 3, - * "replication": 2, - * "config": { - * "retention_bytes": -1, - * "retention_ms": 100000 - * } - * } - */ - "application/json": components["schemas"]["kafka_topic_create"]; + "application/json": components["schemas"]["alert_policy_request"]; }; }; responses: { - 201: components["responses"]["kafka_topic"]; + 200: components["responses"]["alert_policy_response"]; 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"]; }; }; - databases_get_kafka_topic: { + monitoring_get_alertPolicy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the Kafka topic. - * @example customer-events + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - topic_name: components["parameters"]["kafka_topic_name"]; + alert_uuid: components["parameters"]["alert_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["kafka_topic"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25717,41 +38609,68 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_update_kafka_topic: { + monitoring_update_alertPolicy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; - /** - * @description The name used to identify the Kafka topic. - * @example customer-events + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - topic_name: components["parameters"]["kafka_topic_name"]; + alert_uuid: components["parameters"]["alert_uuid"]; }; cookie?: never; }; - requestBody?: { + /** + * @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: + * + * Type | Description | Valid Entity Type + * -----|-------------|-------------------- + * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID + * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID + * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID + * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID + * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID + * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID + * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID + * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID + * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID + * `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 (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 + * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID + * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID + * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID + * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID + * `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID + * `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID + */ + requestBody: { content: { - /** - * @example { - * "partitions": 3, - * "replication": 2, - * "config": { - * "retention_bytes": -1, - * "retention_ms": 100000 - * } - * } - */ - "application/json": components["schemas"]["kafka_topic_update"]; + "application/json": components["schemas"]["alert_policy_request"]; }; }; responses: { - 200: components["responses"]["kafka_topic"]; + 200: components["responses"]["alert_policy_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -25759,291 +38678,345 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - databases_delete_kafka_topic: { + monitoring_delete_alertPolicy: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description A unique identifier for an alert policy. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + alert_uuid: components["parameters"]["alert_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_get_dropletBandwidthMetrics: { + parameters: { + query: { /** - * @description The name used to identify the Kafka topic. - * @example customer-events + * @description The droplet ID. + * @example 17209102 + */ + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description The network interface. + * @example private + */ + interface: components["parameters"]["network_interface"]; + /** + * @description The traffic direction. + * @example inbound + */ + direction: components["parameters"]["network_direction"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - topic_name: components["parameters"]["kafka_topic_name"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["droplet_bandwidth_metric_response"]; 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"]; }; }; - databases_list_logsink: { + monitoring_get_DropletCpuMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The droplet ID. + * @example 17209102 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 201: components["responses"]["logsinks"]; + 200: components["responses"]["droplet_cpu_metric_response"]; 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"]; }; }; - databases_create_logsink: { + monitoring_get_dropletFilesystemFreeMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The droplet ID. + * @example 17209102 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["logsink_create"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["logsink"]; + 200: components["responses"]["droplet_filesystem_metric_response"]; 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"]; }; }; - databases_get_logsink: { + monitoring_get_dropletFilesystemSizeMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The droplet ID. + * @example 17209102 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - logsink_id: components["parameters"]["logsink_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 201: components["responses"]["logsink"]; + 200: components["responses"]["droplet_filesystem_metric_response"]; 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"]; }; }; - databases_update_logsink: { + monitoring_get_dropletLoad1Metrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The droplet ID. + * @example 17209102 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - logsink_id: components["parameters"]["logsink_id"]; - }; - cookie?: never; - }; - requestBody: { - content: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @example { - * "config": { - * "server": "192.168.0.1", - * "port": 514, - * "tls": false, - * "format": "rfc3164" - * } - * } + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - "application/json": components["schemas"]["logsink_update"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - databases_delete_logsink: { + monitoring_get_dropletLoad5Metrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The droplet ID. + * @example 17209102 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description A unique identifier for a logsink of a database cluster - * @example 50484ec3-19d6-4cd3-b56f-3b0381c289a6 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - logsink_id: components["parameters"]["logsink_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - databases_get_cluster_metrics_credentials: { + monitoring_get_dropletLoad15Metrics: { parameters: { - query?: never; + query: { + /** + * @description The droplet ID. + * @example 17209102 + */ + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["database_metrics_auth"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - databases_update_cluster_metrics_credentials: { + monitoring_get_dropletMemoryCachedMetrics: { parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { + query: { /** - * @example { - * "credentials": { - * "basic_auth_username": "new_username", - * "basic_auth_password": "new_password" - * } - * } + * @description The droplet ID. + * @example 17209102 */ - "application/json": components["schemas"]["database_metrics_credentials"]; - }; - }; - responses: { - 204: components["responses"]["no_content"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - databases_list_opeasearch_indexes: { - parameters: { - query?: never; - header?: never; - path: { + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["opensearch_indexes"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - databases_delete_opensearch_index: { + monitoring_get_dropletMemoryFreeMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a database cluster. - * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + * @description The droplet ID. + * @example 17209102 */ - database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description The name of the OpenSearch index. - * @example logs-* + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - index_name: components["parameters"]["opensearch_index_name"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - domains_list: { + monitoring_get_dropletMemoryTotalMetrics: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description The droplet ID. + * @example 17209102 */ - per_page?: components["parameters"]["per_page"]; + host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -26051,328 +39024,334 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_domains_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - domains_create: { + monitoring_get_dropletMemoryAvailableMetrics: { parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { + query: { /** - * @example { - * "name": "example.com" - * } + * @description The droplet ID. + * @example 17209102 */ - "application/json": components["schemas"]["domain"]; + host_id: components["parameters"]["parameters_droplet_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 201: components["responses"]["create_domain_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - domains_get: { + monitoring_get_appMemoryPercentageMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - domain_name: components["parameters"]["domain_name"]; + app_id: components["parameters"]["parameters_app_id"]; + /** + * @description The app component name. + * @example sample-application + */ + app_component?: components["parameters"]["app_component"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_domain"]; + 200: components["responses"]["app_metric_response"]; 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"]; }; }; - domains_delete: { + monitoring_get_appCPUPercentageMetrics: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - domain_name: components["parameters"]["domain_name"]; + app_id: components["parameters"]["parameters_app_id"]; + /** + * @description The app component name. + * @example sample-application + */ + app_component?: components["parameters"]["app_component"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["app_metric_response"]; 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"]; }; }; - domains_list_records: { + "monitoring_get_appRestartCountMetrics.yml": { parameters: { - query?: { + query: { /** - * @description A fully qualified record name. For example, to only include records matching sub.example.com, send a GET request to `/v2/domains/$DOMAIN_NAME/records?name=sub.example.com`. - * @example sub.example.com + * @description The app UUID. + * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 */ - name?: components["parameters"]["domain_name_query"]; + app_id: components["parameters"]["parameters_app_id"]; /** - * @description The type of the DNS record. For example: A, CNAME, TXT, ... - * @example A + * @description The app component name. + * @example sample-application */ - type?: components["parameters"]["domain_type_query"]; + app_component?: components["parameters"]["app_component"]; /** - * @description Number of items returned per page - * @example 2 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - per_page?: components["parameters"]["per_page"]; + start: components["parameters"]["metric_timestamp_start"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - page?: components["parameters"]["page"]; + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; - path: { - /** - * @description The name of the domain itself. - * @example example.com - */ - domain_name: components["parameters"]["domain_name"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_domain_records_response"]; + 200: components["responses"]["app_metric_response"]; 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"]; }; }; - domains_create_record: { + monitoring_get_lb_frontend_connections_current: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - domain_name: components["parameters"]["domain_name"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @example { - * "type": "A", - * "name": "www", - * "data": "162.10.66.0", - * "priority": null, - * "port": null, - * "ttl": 1800, - * "weight": null, - * "flags": null, - * "tag": null - * } + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - "application/json": components["schemas"]["domain_record_a"] | components["schemas"]["domain_record_aaaa"] | components["schemas"]["domain_record_caa"] | components["schemas"]["domain_record_cname"] | components["schemas"]["domain_record_mx"] | components["schemas"]["domain_record_ns"] | components["schemas"]["domain_record_soa"] | components["schemas"]["domain_record_srv"] | components["schemas"]["domain_record_txt"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 201: components["responses"]["created_domain_record"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - domains_get_record: { + monitoring_get_lb_frontend_connections_limit: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - domain_name: components["parameters"]["domain_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - domain_record_id: components["parameters"]["domain_record_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["domain_record"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - domains_update_record: { + monitoring_get_lb_frontend_cpu_utilization: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - domain_name: components["parameters"]["domain_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - domain_record_id: components["parameters"]["domain_record_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @example { - * "name": "blog", - * "type": "CNAME" - * } + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - "application/json": components["schemas"]["domain_record"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["domain_record"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - domains_delete_record: { + monitoring_get_lb_frontend_firewall_dropped_bytes: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - domain_name: components["parameters"]["domain_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - domain_record_id: components["parameters"]["domain_record_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - domains_patch_record: { + monitoring_get_lb_frontend_firewall_dropped_packets: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description The name of the domain itself. - * @example example.com + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - domain_name: components["parameters"]["domain_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description The unique identifier of the domain record. - * @example 3352896 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - domain_record_id: components["parameters"]["domain_record_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @example { - * "name": "blog", - * "type": "A" - * } + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - "application/json": components["schemas"]["domain_record"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["domain_record"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list: { + monitoring_get_lb_frontend_http_responses: { 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"]; + query: { /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. - * @example env:prod + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_name?: components["parameters"]["droplet_tag_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Used to filter list response by Droplet name returning only exact matches. It is case-insensitive and can not be combined with `tag_name`. - * @example web-01 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - name?: components["parameters"]["droplet_name"]; + start: components["parameters"]["metric_timestamp_start"]; /** - * @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 + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - type?: components["parameters"]["droplet_type"]; + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -26380,41 +39359,63 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_droplets"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_create: { + monitoring_get_lb_frontend_http_requests_per_second: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["droplet_single_create"] | components["schemas"]["droplet_multi_create"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["droplet_create"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - droplets_destroy_byTag: { + monitoring_get_lb_frontend_network_throughput_http: { parameters: { query: { /** - * @description Specifies Droplets to be deleted by tag. - * @example env:test + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_name: components["parameters"]["droplet_delete_tag_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -26422,130 +39423,159 @@ export interface operations { }; requestBody?: never; responses: { - 204: components["responses"]["no_content_with_content_type"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_get: { + monitoring_get_lb_frontend_network_throughput_udp: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_droplet"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_destroy: { + monitoring_get_lb_frontend_network_throughput_tcp: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content_with_content_type"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_backups: { + monitoring_get_lb_frontend_nlb_tcp_network_throughput: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - droplet_id: components["parameters"]["droplet_id"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_droplet_backups"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_get_backup_policy: { + monitoring_get_lb_frontend_nlb_udp_network_throughput: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["droplet_backup_policy"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_backup_policies: { + monitoring_get_lb_frontend_tls_connections_current: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -26553,425 +39583,479 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_droplet_backup_policies"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_supported_backup_policies: { + monitoring_get_lb_frontend_tls_connections_limit: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["droplets_supported_backup_policies"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_snapshots: { + monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - droplet_id: components["parameters"]["droplet_id"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_droplet_snapshots"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - dropletActions_list: { + monitoring_get_lb_droplets_http_session_duration_avg: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - droplet_id: components["parameters"]["droplet_id"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_droplet_actions"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - dropletActions_post: { + monitoring_get_lb_droplets_http_session_duration_50p: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - /** - * @description The `type` attribute set in the request body will specify the action that - * will be taken on the Droplet. Some actions will require additional - * attributes to be set as well. - */ - requestBody?: { - content: { - "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_enable_backups"] | components["schemas"]["droplet_action_change_backup_policy"] | components["schemas"]["droplet_action_restore"] | components["schemas"]["droplet_action_resize"] | components["schemas"]["droplet_action_rebuild"] | components["schemas"]["droplet_action_rename"] | components["schemas"]["droplet_action_change_kernel"] | components["schemas"]["droplet_action_snapshot"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["droplet_action"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - dropletActions_post_byTag: { + monitoring_get_lb_droplets_http_session_duration_95p: { parameters: { - query?: { + query: { /** - * @description Used to filter Droplets by a specific tag. Can not be combined with `name` or `type`. - * @example env:prod + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - tag_name?: components["parameters"]["droplet_tag_name"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; cookie?: never; }; - /** - * @description The `type` attribute set in the request body will specify the action that - * will be taken on the Droplet. Some actions will require additional - * attributes to be set as well. - */ - requestBody?: { - content: { - "application/json": components["schemas"]["droplet_action"] | components["schemas"]["droplet_action_snapshot"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["droplet_actions_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - dropletActions_get: { + monitoring_get_lb_droplets_http_response_time_avg: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - action_id: components["parameters"]["action_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["action"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_kernels: { + monitoring_get_lb_droplets_http_response_time_50p: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - droplet_id: components["parameters"]["droplet_id"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_kernels"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_firewalls: { + monitoring_get_lb_droplets_http_response_time_95p: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { + start: components["parameters"]["metric_timestamp_start"]; /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - droplet_id: components["parameters"]["droplet_id"]; + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_firewalls"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_neighbors: { + monitoring_get_lb_droplets_http_response_time_99p: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["neighbor_droplets"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_list_associatedResources: { + monitoring_get_lb_droplets_queue_size: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["associated_resources_list"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_destroy_withAssociatedResourcesSelective: { + monitoring_get_lb_droplets_http_responses: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["selective_destroy_associated_resource"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_destroy_withAssociatedResourcesDangerous: { + monitoring_get_lb_droplets_connections: { parameters: { - query?: never; - header: { + query: { /** - * @description Acknowledge this action will destroy the Droplet and all associated resources and _can not_ be reversed. - * @example true + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - "X-Dangerous": components["parameters"]["x_dangerous"]; - }; - path: { + lb_id: components["parameters"]["parameters_load_balancer_id"]; /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - droplet_id: components["parameters"]["droplet_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_get_DestroyAssociatedResourcesStatus: { + monitoring_get_lb_droplets_health_checks: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["associated_resources_status"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - droplets_destroy_retryWithAssociatedResources: { + monitoring_get_lb_droplets_downtime: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique identifier for a Droplet instance. - * @example 3164444 + * @description A unique identifier for a load balancer. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - droplet_id: components["parameters"]["droplet_id"]; + lb_id: components["parameters"]["parameters_load_balancer_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_list: { + monitoring_get_droplet_autoscale_current_instances: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - per_page?: components["parameters"]["per_page"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - page?: components["parameters"]["page"]; + start: components["parameters"]["metric_timestamp_start"]; /** - * @description The name of the autoscale pool - * @example my-autoscale-pool + * @description UNIX timestamp to end metric window. + * @example 1620705417 */ - name?: components["parameters"]["autoscale_pool_name"]; + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -26979,162 +40063,204 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_autoscale_pools"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_create: { + monitoring_get_droplet_autoscale_target_instances: { parameters: { - query?: never; + query: { + /** + * @description A unique identifier for an autoscale pool. + * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + */ + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; + }; header?: never; path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["autoscale_pool_create"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["autoscale_pool_create"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_get: { + "monitoring_get_droplet_autoscale_current_cpu_utilization.yml": { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for an autoscale pool. * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_autoscale_pool"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - autoscalepools_update: { + monitoring_get_droplet_autoscale_target_cpu_utilization: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for an autoscale pool. * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["autoscale_pool_create"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["autoscale_pool_create"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - autoscalepools_delete: { + monitoring_get_droplet_autoscale_current_memory_utilization: { parameters: { - query?: never; - header?: never; - path: { + query: { /** * @description A unique identifier for an autoscale pool. * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - autoscalepools_delete_dangerous: { + monitoring_get_droplet_autoscale_target_memory_utilization: { parameters: { - query?: never; - header: { - /** - * @description Acknowledge this action will destroy the autoscale pool and its associated resources and _can not_ be reversed. - * @example true - */ - "X-Dangerous": components["parameters"]["parameters_x_dangerous"]; - }; - path: { + query: { /** * @description A unique identifier for an autoscale pool. * @example 0d3db13e-a604-4944-9827-7ec2642d32ac */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - autoscalepools_list_members: { + monitoring_get_database_mysql_cpu_usage: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - per_page?: components["parameters"]["per_page"]; + db_id: components["parameters"]["db_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Aggregation over the time range (avg, max, or min). + * @example avg */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { + aggregate: components["parameters"]["aggregate_avg_max_min"]; /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_members"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27142,33 +40268,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - autoscalepools_list_history: { + monitoring_get_database_mysql_load: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - per_page?: components["parameters"]["per_page"]; + db_id: components["parameters"]["db_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Load window: **load1** (1-minute), **load5** (5-minute), **load15** (15-minute). The value is either average or max over that window, depending on the **aggregate** parameter (avg or max). + * @example load1 */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { + metric: components["parameters"]["metric_load"]; /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description Aggregation over the time range (avg or max). + * @example avg */ - autoscale_pool_id: components["parameters"]["autoscale_pool_id"]; + aggregate: components["parameters"]["aggregate_avg_max"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["history_events"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27176,19 +40311,29 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_list: { + monitoring_get_database_mysql_memory_usage: { parameters: { - query?: { + query: { /** - * @description Number of items returned per page - * @example 2 + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - per_page?: components["parameters"]["per_page"]; + db_id: components["parameters"]["db_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Aggregation over the time range (avg, max, or min). + * @example avg */ - page?: components["parameters"]["page"]; + aggregate: components["parameters"]["aggregate_avg_max_min"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; header?: never; path?: never; @@ -27196,93 +40341,78 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["list_firewalls_response"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - firewalls_create: { + monitoring_get_database_mysql_disk_usage: { parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { + query: { /** - * @example { - * "name": "firewall", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "80", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "droplet_ids": [ - * 8043964 - * ] - * } + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - "application/json": components["schemas"]["firewall"] & unknown & (unknown | unknown); + db_id: components["parameters"]["db_id"]; + /** + * @description Aggregation over the time range (avg, max, or min). + * @example avg + */ + aggregate: components["parameters"]["aggregate_avg_max_min"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["create_firewall_response"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["metric_response"]; 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"]; }; }; - firewalls_get: { + monitoring_get_database_mysql_threads_connected: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; + db_id: components["parameters"]["db_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_firewall_response"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27290,73 +40420,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_update: { + monitoring_get_database_mysql_threads_created_rate: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + db_id: components["parameters"]["db_id"]; /** - * @example { - * "name": "frontend-firewall", - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "8080", - * "sources": { - * "load_balancer_uids": [ - * "4de7ac8b-495b-4884-9a69-1050c6793cd6" - * ] - * } - * }, - * { - * "protocol": "tcp", - * "ports": "22", - * "sources": { - * "tags": [ - * "gateway" - * ], - * "addresses": [ - * "18.0.0.0/8" - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "8080", - * "destinations": { - * "addresses": [ - * "0.0.0.0/0", - * "::/0" - * ] - * } - * } - * ], - * "droplet_ids": [ - * 8043964 - * ], - * "tags": [ - * "frontend" - * ] - * } + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - "application/json": components["schemas"]["firewall"] & (unknown | unknown); + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 200: components["responses"]["put_firewall_response"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27364,22 +40453,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete: { + monitoring_get_database_mysql_threads_active: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; + db_id: components["parameters"]["db_id"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27387,42 +40486,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_assign_droplets: { + monitoring_get_database_mysql_index_vs_sequential_reads: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + db_id: components["parameters"]["db_id"]; /** - * @example { - * "droplet_ids": [ - * 49696269 - * ] - * } + * @description UNIX timestamp to start metric window. + * @example 1620683817 */ - "application/json": { - /** - * @description An array containing the IDs of the Droplets to be assigned to the firewall. - * @example [ - * 49696269 - * ] - */ - droplet_ids: number[]; - }; + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27430,42 +40519,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_droplets: { + monitoring_get_database_mysql_op_rates: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + db_id: components["parameters"]["db_id"]; /** - * @example { - * "droplet_ids": [ - * 49696269 - * ] - * } + * @description Operation type (select, insert, update, or delete). + * @example select */ - "application/json": { - /** - * @description An array containing the IDs of the Droplets to be removed from the firewall. - * @example [ - * 49696269 - * ] - */ - droplet_ids: number[]; - }; + metric: components["parameters"]["metric_op_rates"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27473,36 +40557,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_add_tags: { + monitoring_get_database_mysql_schema_throughput: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + db_id: components["parameters"]["db_id"]; /** - * @example { - * "tags": [ - * "frontend" - * ] - * } + * @description The schema (database) name. + * @example defaultdb */ - "application/json": { - tags: components["schemas"]["existing_tags_array"] & unknown; - }; + schema: components["parameters"]["schema"]; + /** + * @description Table I/O operation (insert, fetch, update, or delete). + * @example insert + */ + metric: components["parameters"]["metric_schema_io"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27510,36 +40600,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_tags: { + monitoring_get_database_mysql_schema_latency: { parameters: { - query?: never; - header?: never; - path: { + query: { /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c + * @description The DBaaS cluster UUID (database ID). + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 */ - firewall_id: components["parameters"]["firewall_id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { + db_id: components["parameters"]["db_id"]; /** - * @example { - * "tags": [ - * "frontend" - * ] - * } + * @description The schema (database) name. + * @example defaultdb */ - "application/json": { - tags: components["schemas"]["existing_tags_array"] & unknown; - }; + schema: components["parameters"]["schema"]; + /** + * @description Table I/O operation (insert, fetch, update, or delete). + * @example insert + */ + metric: components["parameters"]["metric_schema_io"]; + /** + * @description UNIX timestamp to start metric window. + * @example 1620683817 + */ + start: components["parameters"]["metric_timestamp_start"]; + /** + * @description UNIX timestamp to end metric window. + * @example 1620705417 + */ + end: components["parameters"]["metric_timestamp_end"]; }; + header?: never; + path?: never; + cookie?: never; }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["metric_response"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27547,53 +40643,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_add_rules: { + monitoring_list_destinations: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c - */ - firewall_id: components["parameters"]["firewall_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: { - content: { - /** - * @example { - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "sources": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "destinations": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ] - * } - */ - "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["monitoring_list_destinations"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27601,53 +40660,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - firewalls_delete_rules: { + monitoring_create_destination: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to identify and reference a firewall. - * @example bb4b2611-3d72-467b-8602-280330ecd65c - */ - firewall_id: components["parameters"]["firewall_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { - /** - * @example { - * "inbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "sources": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ], - * "outbound_rules": [ - * { - * "protocol": "tcp", - * "ports": "3306", - * "destinations": { - * "droplet_ids": [ - * 49696269 - * ] - * } - * } - * ] - * } - */ - "application/json": components["schemas"]["firewall_rules"] & (unknown | unknown); + "application/json": components["schemas"]["destination_request"]; }; }; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + 200: components["responses"]["destination"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27655,69 +40681,72 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_list: { + monitoring_get_destination: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 */ - page?: components["parameters"]["page"]; + destination_uuid: components["parameters"]["destination_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_list"]; + 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"]; }; }; - floatingIPs_create: { + monitoring_update_destination: { parameters: { query?: never; header?: never; - path?: 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"]["floating_ip_create"]; + "application/json": components["schemas"]["destination_request"]; }; }; responses: { - 202: components["responses"]["floating_ip_created"]; + 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"]; }; }; - floatingIPs_get: { + monitoring_delete_destination: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique identifier for a destination. + * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 */ - floating_ip: components["parameters"]["floating_ip"]; + destination_uuid: components["parameters"]["destination_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27725,22 +40754,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPs_delete: { + monitoring_list_sinks: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique URN for a resource. + * @example do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 */ - floating_ip: components["parameters"]["floating_ip"]; + resource_id?: components["parameters"]["resource_id"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["list_sinks"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27748,22 +40777,28 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_list: { + monitoring_create_sink: { parameters: { query?: never; header?: never; - path: { - /** - * @description A floating IP address. - * @example 45.55.96.47 - */ - floating_ip: components["parameters"]["floating_ip"]; - }; + path?: never; cookie?: never; }; - requestBody?: 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: { - 200: components["responses"]["floating_ip_actions"]; + 202: components["responses"]["accepted"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27771,30 +40806,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_post: { + monitoring_get_sink: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c */ - floating_ip: components["parameters"]["floating_ip"]; + sink_uuid: components["parameters"]["sink_uuid"]; }; cookie?: never; }; - /** - * @description The `type` attribute set in the request body will specify the action that - * will be taken on the floating IP. - */ - requestBody?: { - content: { - "application/json": components["schemas"]["floating_ip_action_unassign"] | components["schemas"]["floating_ip_action_assign"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["floating_ip_action"]; + 200: components["responses"]["sinks"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27802,27 +40829,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - floatingIPsAction_get: { + monitoring_delete_sink: { parameters: { query?: never; header?: never; path: { /** - * @description A floating IP address. - * @example 45.55.96.47 - */ - floating_ip: components["parameters"]["floating_ip"]; - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A unique identifier for a sink. + * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c */ - action_id: components["parameters"]["action_id"]; + sink_uuid: components["parameters"]["sink_uuid"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["floating_ip_action"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -27830,23 +40852,30 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - functions_list_namespaces: { + nfs_list: { parameters: { - query?: never; + query?: { + /** + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 + */ + region?: components["parameters"]["region"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_namespaces"]; + 200: components["responses"]["nfs_list"]; 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"]; }; }; - functions_create_namespace: { + nfs_create: { parameters: { query?: never; header?: never; @@ -27855,194 +40884,181 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["create_namespace"]; + "application/json": components["schemas"]["nfs_request"]; }; }; responses: { - 200: components["responses"]["namespace_created"]; + 201: components["responses"]["nfs_create"]; + 400: components["responses"]["bad_request-2"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_bad_request"]; - 422: components["responses"]["namespace_limit_reached"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_get_namespace: { + nfs_get: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 */ - namespace_id: components["parameters"]["namespace_id"]; + region?: components["parameters"]["region"]; }; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["namespace_created"]; - 401: components["responses"]["unauthorized"]; - 403: components["responses"]["namespace_not_allowed"]; - 404: components["responses"]["namespace_not_found"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - functions_delete_namespace: { - parameters: { - query?: never; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The unique ID of the NFS share + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d */ - namespace_id: components["parameters"]["namespace_id"]; + nfs_id: components["parameters"]["nfs_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["nfs_get"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_list_triggers: { + nfs_delete: { parameters: { - query?: never; + query?: { + /** + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 + */ + region?: components["parameters"]["region"]; + }; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The unique ID of the NFS share + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d */ - namespace_id: components["parameters"]["namespace_id"]; + nfs_id: components["parameters"]["nfs_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_triggers"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_create_trigger: { + nfs_create_action: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The unique ID of the NFS share + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d */ - namespace_id: components["parameters"]["namespace_id"]; + nfs_id: components["parameters"]["nfs_id"]; }; cookie?: never; }; + /** + * @description The `type` attribute set in the request body will specify the action that + * will be taken on the NFS share. Some actions will require additional + * attributes to be set as well. + */ requestBody: { content: { - "application/json": components["schemas"]["create_trigger"]; + "application/json": components["schemas"]["nfs_action_resize"] | components["schemas"]["nfs_action_snapshot"] | components["schemas"]["nfs_action_attach"] | components["schemas"]["nfs_action_detach"] | components["schemas"]["nfs_action_switch_performance_tier"]; }; }; responses: { - 200: components["responses"]["trigger_response"]; - 400: components["responses"]["trigger_bad_request"]; + 201: components["responses"]["nfs_actions"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["namespace_not_found"]; - 422: components["responses"]["trigger_limit_reached"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_get_trigger: { + nfs_list_snapshot: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 */ - namespace_id: components["parameters"]["namespace_id"]; + region?: components["parameters"]["region"]; /** - * @description The name of the trigger to be managed. - * @example my trigger + * @description The unique ID of an NFS share. If provided, only snapshots of this specific share will be returned. + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d */ - trigger_name: components["parameters"]["trigger_name"]; + share_id?: components["parameters"]["share_id"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["trigger_response"]; + 200: components["responses"]["nfs_snapshot_list"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["trigger_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_update_trigger: { + nfs_get_snapshot: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 */ - namespace_id: components["parameters"]["namespace_id"]; + region?: components["parameters"]["region"]; + }; + header?: never; + path: { /** - * @description The name of the trigger to be managed. - * @example my trigger + * @description The unique ID of the NFS snapshot + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d */ - trigger_name: components["parameters"]["trigger_name"]; + nfs_snapshot_id: components["parameters"]["nfs_snapshot_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["update_trigger"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["trigger_response"]; - 400: components["responses"]["trigger_bad_request"]; + 200: components["responses"]["nfs_snapshot_get"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["trigger_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - functions_delete_trigger: { + nfs_delete_snapshot: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description The ID of the namespace to be managed. - * @example fn-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx + * @description The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + * @example atl1 */ - namespace_id: components["parameters"]["namespace_id"]; + region?: components["parameters"]["region"]; + }; + header?: never; + path: { /** - * @description The name of the trigger to be managed. - * @example my trigger + * @description The unique ID of the NFS snapshot + * @example 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d */ - trigger_name: components["parameters"]["trigger_name"]; + nfs_snapshot_id: components["parameters"]["nfs_snapshot_id"]; }; cookie?: never; }; @@ -28050,30 +41066,15 @@ export interface operations { responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["trigger_not_found"]; + 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - images_list: { + partnerAttachments_list: { parameters: { query?: { - /** - * @description Filters results based on image type which can be either `application` or `distribution`. - * @example distribution - */ - type?: components["parameters"]["type"]; - /** - * @description Used to filter only user images. - * @example true - */ - private?: components["parameters"]["private"]; - /** - * @description Used to filter images by a specific tag. - * @example base-image - */ - tag_name?: components["parameters"]["tag"]; /** * @description Number of items returned per page * @example 2 @@ -28091,53 +41092,52 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_images"]; + 200: components["responses"]["all_partner_attachments"]; 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"]; }; }; - images_create_custom: { + partnerAttachments_create: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["image_new_custom"]; + "application/json": components["schemas"]["partner_attachment_writable"]; }; }; responses: { - 202: components["responses"]["new_custom_image"]; + 202: components["responses"]["single_partner_attachment"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_entity"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - images_get: { + partnerAttachments_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number (id) or string (slug) used to identify and reference a - * specific image. - * - * **Public** images can be identified by image `id` or `slug`. - * - * **Private** images *must* be identified by image `id`. + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: number | string; + pa_id: components["parameters"]["pa_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_image"]; + 200: components["responses"]["single_partner_attachment"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28145,26 +41145,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - images_update: { + partnerAttachments_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + pa_id: components["parameters"]["pa_id"]; }; cookie?: never; }; - requestBody: { + requestBody?: never; + responses: { + 202: components["responses"]["single_partner_attachment_deleting"]; + 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"]; + }; + }; + partnerAttachments_patch: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + pa_id: components["parameters"]["pa_id"]; + }; + cookie?: never; + }; + requestBody?: { content: { - "application/json": components["schemas"]["image_update"]; + "application/json": components["schemas"]["partner_attachment_updatable"]; }; }; responses: { - 200: components["responses"]["updated_image"]; + 202: components["responses"]["single_partner_attachment"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28172,22 +41195,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - images_delete: { + partnerAttachments_get_bgp_auth_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + pa_id: components["parameters"]["pa_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["single_partner_attachment_bgp_auth_key"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28195,22 +41218,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_list: { + partnerAttachments_list_remote_routes: { 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: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + pa_id: components["parameters"]["pa_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_image_actions_response"]; + 200: components["responses"]["all_partner_attachment_remote_routes"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28218,26 +41252,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_post: { + partnerAttachments_get_service_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - image_id: components["parameters"]["image_id"]; + pa_id: components["parameters"]["pa_id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["image_action_base"] | components["schemas"]["image_action_transfer"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["post_image_action_response"]; + 200: components["responses"]["single_partner_attachment_service_key"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28245,27 +41275,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - imageActions_get: { + partnerAttachments_create_service_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique number that can be used to identify and reference a specific image. - * @example 62137902 - */ - image_id: components["parameters"]["image_id"]; - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description A unique identifier for a partner attachment. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - action_id: components["parameters"]["action_id"]; + pa_id: components["parameters"]["pa_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["get_image_action_response"]; + 202: components["responses"]["empty_json_object"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28273,7 +41298,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_clusters: { + projects_list: { parameters: { query?: { /** @@ -28293,14 +41318,14 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_clusters"]; + 200: components["responses"]["projects_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_create_cluster: { + projects_create: { parameters: { query?: never; header?: never; @@ -28309,33 +41334,27 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["cluster"]; + "application/json": WithRequired; }; }; responses: { - 201: components["responses"]["cluster_create"]; + 201: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_cluster: { + projects_get_default: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_cluster"]; + 200: components["responses"]["default_project"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28343,26 +41362,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_update_cluster: { + projects_update_default: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["cluster_update"]; + "application/json": components["schemas"]["project"]; }; }; responses: { - 202: components["responses"]["updated_cluster"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28370,22 +41383,25 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_cluster: { + projects_patch_default: { parameters: { query?: never; header?: never; - path: { + path?: never; + cookie?: never; + }; + requestBody: { + content: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @example { + * "name": "my-web-api" + * } */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + "application/json": components["schemas"]["project"]; }; - cookie?: never; }; - requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28393,22 +41409,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_associatedResources: { + projects_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + project_id: components["parameters"]["project_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["associated_kubernetes_resources_list"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28416,26 +41432,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_destroy_associatedResourcesSelective: { + projects_update: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + project_id: components["parameters"]["project_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["destroy_associated_kubernetes_resources"]; + "application/json": components["schemas"]["project"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28443,16 +41459,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_destroy_associatedResourcesDangerous: { + projects_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + project_id: components["parameters"]["project_id"]; }; cookie?: never; }; @@ -28461,33 +41477,37 @@ export interface operations { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; + 412: components["responses"]["precondition_failed"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_kubeconfig: { + projects_patch: { parameters: { - query?: { - /** - * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. - * @example 300 - */ - expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; - }; + query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + project_id: components["parameters"]["project_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + /** + * @example { + * "name": "my-web-api" + * } + */ + "application/json": components["schemas"]["project"]; + }; + }; responses: { - 200: components["responses"]["kubeconfig"]; + 200: components["responses"]["existing_project"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28495,28 +41515,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_credentials: { + projects_list_resources: { parameters: { query?: { /** - * @description The duration in seconds that the returned Kubernetes credentials will be valid. If not set or 0, the credentials will have a 7 day expiry. - * @example 300 + * @description Number of items returned per page + * @example 2 */ - expiry_seconds?: components["parameters"]["kubernetes_expiry_seconds"]; + 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 ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + project_id: components["parameters"]["project_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["credentials"]; + 200: components["responses"]["resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28524,22 +41549,43 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_get_availableUpgrades: { + projects_assign_resources: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description A unique identifier for a project. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + project_id: components["parameters"]["project_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["project_assignment"]; }; + }; + responses: { + 200: components["responses"]["assigned_resources_list"]; + 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_resources_default: { + parameters: { + query?: never; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["available_upgrades"]; + 200: components["responses"]["resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28547,32 +41593,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_upgrade_cluster: { + projects_assign_resources_default: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description The slug identifier for the version of Kubernetes that the cluster will be upgraded to. - * @example 1.16.13-do.0 - */ - version?: string; - }; + "application/json": components["schemas"]["project_assignment"]; }; }; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["assigned_resources_list"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28580,90 +41614,63 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_list_nodePools: { + regions_list: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description Number of items returned per page + * @example 2 */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_node_pools"]; + 200: components["responses"]["all_regions"]; 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"]; }; }; - kubernetes_add_nodePool: { + registries_list: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - /** - * @example { - * "size": "s-1vcpu-2gb", - * "count": 3, - * "name": "new-pool", - * "tags": [ - * "frontend" - * ], - * "auto_scale": true, - * "min_nodes": 3, - * "max_nodes": 6 - * } - */ - "application/json": components["schemas"]["kubernetes_node_pool"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["node_pool_create"]; + 200: components["responses"]["all_registries_info"]; 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"]; }; }; - kubernetes_get_nodePool: { + registries_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d - */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["multiregistry_create"]; + }; + }; responses: { - 200: components["responses"]["existing_node_pool"]; + 201: components["responses"]["multiregistry_info"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28671,31 +41678,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_update_nodePool: { + registries_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description The name of a container registry. + * @example example */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + registry_name: components["parameters"]["registry_name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["kubernetes_node_pool_update"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["node_pool_update"]; + 200: components["responses"]["multiregistry_info"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28703,21 +41701,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_nodePool: { + registries_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d + * @description The name of a container registry. + * @example example */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; + registry_name: components["parameters"]["registry_name"]; }; cookie?: never; }; @@ -28731,43 +41724,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_delete_node: { + registries_get_dockerCredentials: { parameters: { - query?: { - /** - * @description Specifies whether or not to drain workloads from a node before it is deleted. Setting it to `1` causes node draining to be skipped. Omitting the query parameter or setting its value to `0` carries out draining prior to deletion. - * @example 1 - */ - skip_drain?: components["parameters"]["kubernetes_node_skip_drain"]; - /** - * @description Specifies whether or not to replace a node after it has been deleted. Setting it to `1` causes the node to be replaced by a new one after deletion. Omitting the query parameter or setting its value to `0` deletes without replacement. - * @example 1 - */ - replace?: components["parameters"]["kubernetes_node_replace"]; - }; + query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d - */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; - /** - * @description A unique ID that can be used to reference a node in a Kubernetes node pool. - * @example 478247f8-b1bb-4f7a-8db9-2a5f8d4b8f8f + * @description The name of a container registry. + * @example example */ - node_id: components["parameters"]["kubernetes_node_id"]; + registry_name: components["parameters"]["registry_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["docker_credentials"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28775,69 +41747,50 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_recycle_node_pool: { + registries_get_subscription: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - /** - * @description A unique ID that can be used to reference a Kubernetes node pool. - * @example cdda885e-7663-40c8-bc74-3a036c66545d - */ - node_pool_id: components["parameters"]["kubernetes_node_pool_id"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @example [ - * "d8db5e1a-6103-43b5-a7b3-8a948210a9fc" - * ] - */ - nodes?: string[]; - }; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["subscription_response"]; 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"]; }; }; - kubernetes_get_clusterUser: { + registries_update_subscription: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af - */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description The slug of the subscription tier to sign up for. + * @example basic + * @enum {string} + */ + tier_slug?: "starter" | "basic" | "professional"; + }; + }; + }; responses: { - 200: components["responses"]["cluster_user"]; + 200: components["responses"]["subscription_response"]; 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"]; }; }; - kubernetes_list_options: { + registries_get_options: { parameters: { query?: never; header?: never; @@ -28846,36 +41799,29 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_options"]; + 200: components["responses"]["registry_options_response"]; 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"]; }; }; - kubernetes_get_clusterLintResults: { + registries_get_garbageCollection: { parameters: { - query?: { - /** - * @description Specifies the clusterlint run whose results will be retrieved. - * @example 50c2f44c-011d-493e-aee5-361a4a0d1844 - */ - run_id?: components["parameters"]["clusterlint_run_id"]; - }; + query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The name of a container registry. + * @example example */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + registry_name: components["parameters"]["registry_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["clusterlint_results"]; + 200: components["responses"]["garbage_collection"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28883,26 +41829,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_run_clusterLint: { + registries_run_garbageCollection: { parameters: { query?: never; header?: never; path: { /** - * @description A unique ID that can be used to reference a Kubernetes cluster. - * @example bd5f5959-5e1e-4205-a714-a914373942af + * @description The name of a container registry. + * @example example */ - cluster_id: components["parameters"]["kubernetes_cluster_id"]; + registry_name: components["parameters"]["registry_name"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["clusterlint_request"]; - }; - }; + requestBody?: never; responses: { - 202: components["responses"]["clusterlint_run"]; + 201: components["responses"]["garbage_collection"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -28910,47 +41852,73 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - kubernetes_add_registry: { + registries_list_garbageCollections: { 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?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": components["schemas"]["cluster_registries"]; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["garbage_collections"]; 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"]; }; }; - kubernetes_remove_registry: { + registries_update_garbageCollection: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + /** + * @description The UUID of a garbage collection run. + * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 + */ + garbage_collection_uuid: components["parameters"]["garbage_collection_uuid"]; + }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/json": components["schemas"]["cluster_registries"]; + "application/json": components["schemas"]["update_registry"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["garbage_collection"]; 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"]; }; }; - loadBalancers_list: { + registries_list_repositoriesV2: { parameters: { query?: { /** @@ -28959,60 +41927,97 @@ export interface operations { */ per_page?: components["parameters"]["per_page"]; /** - * @description Which 'page' of paginated results to return. + * @description Which 'page' of paginated results to return. Ignored when 'page_token' is provided. * @example 1 */ - page?: components["parameters"]["page"]; + page?: components["parameters"]["token_pagination_page"]; + /** + * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. + * @example eyJUb2tlbiI6IkNnZGpiMjlz + */ + page_token?: components["parameters"]["token_pagination_page_token"]; }; header?: never; - path?: never; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_load_balancers"]; + 200: components["responses"]["all_repositories_v2"]; + 400: components["responses"]["bad_request"]; 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"]; }; }; - loadBalancers_create: { + registries_delete_repository: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["load_balancer_create"]; + path: { + /** + * @description The name of a container registry. + * @example example + */ + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["load_balancer_create"]; + 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"]; }; }; - loadBalancers_get: { + registries_list_repositoryTags: { 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: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - lb_id: components["parameters"]["load_balancer_id"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_load_balancer"]; + 200: components["responses"]["repository_tags"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -29020,26 +42025,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_update: { + registries_delete_repositoryTag: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - lb_id: components["parameters"]["load_balancer_id"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; + /** + * @description The name of a container registry repository tag. + * @example 06a447a + */ + repository_tag: components["parameters"]["registry_repository_tag"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["load_balancer_create"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["updated_load_balancer"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -29047,22 +42058,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_delete: { + registries_list_repositoryManifests: { 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: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - lb_id: components["parameters"]["load_balancer_id"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["repository_manifests"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -29070,16 +42097,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_delete_cache: { + registries_delete_repositoryManifest: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - lb_id: components["parameters"]["load_balancer_id"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; + /** + * @description The manifest digest of a container registry repository tag. + * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 + */ + manifest_digest: components["parameters"]["registry_manifest_digest"]; }; cookie?: never; }; @@ -29093,333 +42130,201 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_add_droplets: { + registries_validate_name: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["load_balancer_id"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": { - /** - * @description An array containing the IDs of the Droplets assigned to the load balancer. - * @example [ - * 3164444, - * 3164445 - * ] - */ - droplet_ids: number[]; - }; + "application/json": components["schemas"]["validate_registry"]; }; }; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_remove_droplets: { + registry_get: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["load_balancer_id"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description An array containing the IDs of the Droplets assigned to the load balancer. - * @example [ - * 3164444, - * 3164445 - * ] - */ - droplet_ids: number[]; - }; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["registry_info"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 412: components["responses"]["registries_precondition_fail"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - loadBalancers_add_forwardingRules: { + registry_create: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["load_balancer_id"]; - }; + path?: never; cookie?: never; }; requestBody: { content: { - "application/json": { - forwarding_rules: components["schemas"]["forwarding_rule"][]; - }; + "application/json": components["schemas"]["registry_create"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["registry_info"]; 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"]; }; }; - loadBalancers_remove_forwardingRules: { + registry_delete: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["load_balancer_id"]; - }; + path?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": { - forwarding_rules: components["schemas"]["forwarding_rule"][]; - }; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; + 412: components["responses"]["registries_precondition_fail"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_list_alertPolicy: { + registry_get_subscription: { 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"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_alert_policy_response"]; + 200: components["responses"]["subscription_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_create_alertPolicy: { + registry_update_subscription: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - /** - * @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: - * - * Type | Description | Valid Entity Type - * -----|-------------|-------------------- - * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID - * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID - * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID - * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID - * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID - * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID - * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID - * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID - * `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 (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 - * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID - * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID - * `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID - * `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID - * `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID - * `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID - */ - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["alert_policy_request"]; + "application/json": { + /** + * @description The slug of the subscription tier to sign up for. + * @example basic + * @enum {string} + */ + tier_slug?: "starter" | "basic" | "professional"; + }; }; }; responses: { - 200: components["responses"]["alert_policy_response"]; + 200: components["responses"]["subscription_response"]; 401: components["responses"]["unauthorized"]; + 412: components["responses"]["registries_over_limit"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_alertPolicy: { + registry_get_dockerCredentials: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for an alert policy. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. + * @example 3600 */ - alert_uuid: components["parameters"]["alert_uuid"]; + expiry_seconds?: components["parameters"]["registry_expiry_seconds"]; + /** + * @description By default, the registry credentials allow for read-only access. Set this query parameter to `true` to obtain read-write credentials. + * @example true + */ + read_write?: components["parameters"]["registry_read_write"]; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["alert_policy_response"]; + 200: components["responses"]["docker_credentials"]; 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_alertPolicy: { + registry_validate_name: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for an alert policy. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - alert_uuid: components["parameters"]["alert_uuid"]; - }; + path?: never; cookie?: never; }; - /** - * @description The `type` field dictates what type of entity that the alert policy applies to and hence what type of entity is passed in the `entities` array. If both the `tags` array and `entities` array are empty the alert policy applies to all entities of the relevant type that are owned by the user account. Otherwise the following table shows the valid entity types for each type of alert policy: - * - * Type | Description | Valid Entity Type - * -----|-------------|-------------------- - * `v1/insights/droplet/memory_utilization_percent` | alert on the percent of memory utilization | Droplet ID - * `v1/insights/droplet/disk_read` | alert on the rate of disk read I/O in MBps | Droplet ID - * `v1/insights/droplet/load_5` | alert on the 5 minute load average | Droplet ID - * `v1/insights/droplet/load_15` | alert on the 15 minute load average | Droplet ID - * `v1/insights/droplet/disk_utilization_percent` | alert on the percent of disk utilization | Droplet ID - * `v1/insights/droplet/cpu` | alert on the percent of CPU utilization | Droplet ID - * `v1/insights/droplet/disk_write` | alert on the rate of disk write I/O in MBps | Droplet ID - * `v1/insights/droplet/public_outbound_bandwidth` | alert on the rate of public outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/public_inbound_bandwidth` | alert on the rate of public inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_outbound_bandwidth` | alert on the rate of private outbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/private_inbound_bandwidth` | alert on the rate of private inbound bandwidth in Mbps | Droplet ID - * `v1/insights/droplet/load_1` | alert on the 1 minute load average | Droplet ID - * `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 (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 - * `v1/insights/lbaas/increase_in_http_error_rate_count_4xx`|alert on the count of 4xx level http errors over 5m|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time`|alert on high average http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_50p`|alert on high 50th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_95p`|alert on high 95th percentile http response time|load balancer ID - * `v1/insights/lbaas/high_http_request_response_time_99p`|alert on high 99th percentile http response time|load balancer ID - * `v1/dbaas/alerts/load_15_alerts` | alert on 15 minute load average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/memory_utilization_alerts` | alert on the percent memory utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/disk_utilization_alerts` | alert on the percent disk utilization average across the database cluster | database cluster UUID - * `v1/dbaas/alerts/cpu_alerts` | alert on the percent CPU usage average across the database cluster | database cluster UUID - * `v1/droplet/autoscale_alerts/current_instances` | alert on current pool size | autoscale pool ID - * `v1/droplet/autoscale_alerts/target_instances` | alert on target pool size | autoscale pool ID - * `v1/droplet/autoscale_alerts/current_cpu_utilization` | alert on current average CPU utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/target_cpu_utilization` | alert on target average CPU utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/current_memory_utilization` | alert on current average memory utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/target_memory_utilization` | alert on target average memory utilization | autoscale pool ID - * `v1/droplet/autoscale_alerts/scale_up` | alert on scale up event | autoscale pool ID - * `v1/droplet/autoscale_alerts/scale_down` | alert on scale down event | autoscale pool ID - */ requestBody: { content: { - "application/json": components["schemas"]["alert_policy_request"]; + "application/json": components["schemas"]["validate_registry"]; }; }; responses: { - 200: components["responses"]["alert_policy_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; - 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_delete_alertPolicy: { + registry_list_repositories: { 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: { /** - * @description A unique identifier for an alert policy. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The name of a container registry. + * @example example */ - alert_uuid: components["parameters"]["alert_uuid"]; + registry_name: components["parameters"]["registry_name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["all_repositories"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -29427,391 +42332,352 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletBandwidthMetrics: { + registry_list_repositoriesV2: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; + query?: { /** - * @description The network interface. - * @example private + * @description Number of items returned per page + * @example 2 */ - interface: components["parameters"]["network_interface"]; + per_page?: components["parameters"]["per_page"]; /** - * @description The traffic direction. - * @example inbound + * @description Which 'page' of paginated results to return. Ignored when 'page_token' is provided. + * @example 1 */ - direction: components["parameters"]["network_direction"]; + page?: components["parameters"]["token_pagination_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. + * @example eyJUb2tlbiI6IkNnZGpiMjlz */ - start: components["parameters"]["metric_timestamp_start"]; + page_token?: components["parameters"]["token_pagination_page_token"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["droplet_bandwidth_metric_response"]; + 200: components["responses"]["all_repositories_v2"]; + 400: components["responses"]["bad_request"]; 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_DropletCpuMetrics: { + registry_list_repositoryTags: { parameters: { - query: { + query?: { /** - * @description The droplet ID. - * @example 17209102 + * @description Number of items returned per page + * @example 2 */ - host_id: components["parameters"]["parameters_droplet_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["droplet_cpu_metric_response"]; + 200: components["responses"]["repository_tags"]; 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_dropletFilesystemFreeMetrics: { + registry_delete_repositoryTag: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description The droplet ID. - * @example 17209102 + * @description The name of a container registry. + * @example example */ - host_id: components["parameters"]["parameters_droplet_id"]; + registry_name: components["parameters"]["registry_name"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 */ - start: components["parameters"]["metric_timestamp_start"]; + repository_name: components["parameters"]["registry_repository_name"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry repository tag. + * @example 06a447a */ - end: components["parameters"]["metric_timestamp_end"]; + repository_tag: components["parameters"]["registry_repository_tag"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["droplet_filesystem_metric_response"]; + 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_get_dropletFilesystemSizeMetrics: { + registry_list_repositoryManifests: { parameters: { - query: { + query?: { /** - * @description The droplet ID. - * @example 17209102 + * @description Number of items returned per page + * @example 2 */ - host_id: components["parameters"]["parameters_droplet_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; + /** + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 + */ + repository_name: components["parameters"]["registry_repository_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["droplet_filesystem_metric_response"]; + 200: components["responses"]["repository_manifests"]; 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_dropletLoad1Metrics: { + registry_delete_repositoryManifest: { parameters: { - query: { + query?: never; + header?: never; + path: { /** - * @description The droplet ID. - * @example 17209102 + * @description The name of a container registry. + * @example example */ - host_id: components["parameters"]["parameters_droplet_id"]; + registry_name: components["parameters"]["registry_name"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. + * @example repo-1 */ - start: components["parameters"]["metric_timestamp_start"]; + repository_name: components["parameters"]["registry_repository_name"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The manifest digest of a container registry repository tag. + * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 */ - end: components["parameters"]["metric_timestamp_end"]; + manifest_digest: components["parameters"]["registry_manifest_digest"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 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_get_dropletLoad5Metrics: { + registry_get_garbageCollection: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["garbage_collection"]; 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_dropletLoad15Metrics: { + registry_run_garbageCollection: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["registry_run_gc"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["garbage_collection"]; 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_dropletMemoryCachedMetrics: { + registry_list_garbageCollections: { parameters: { - query: { + query?: { /** - * @description The droplet ID. - * @example 17209102 + * @description Number of items returned per page + * @example 2 */ - host_id: components["parameters"]["parameters_droplet_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of a container registry. + * @example example */ - end: components["parameters"]["metric_timestamp_end"]; + registry_name: components["parameters"]["registry_name"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["garbage_collections"]; 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_dropletMemoryFreeMetrics: { + registry_update_garbageCollection: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The name of a container registry. + * @example example */ - start: components["parameters"]["metric_timestamp_start"]; + registry_name: components["parameters"]["registry_name"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The UUID of a garbage collection run. + * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 */ - end: components["parameters"]["metric_timestamp_end"]; + garbage_collection_uuid: components["parameters"]["garbage_collection_uuid"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["update_registry"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["garbage_collection"]; 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_dropletMemoryTotalMetrics: { + registry_get_options: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["registry_options_response"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_dropletMemoryAvailableMetrics: { + droplets_list_neighborsIds: { parameters: { - query: { - /** - * @description The droplet ID. - * @example 17209102 - */ - host_id: components["parameters"]["parameters_droplet_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["droplet_neighbors_ids"]; 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_appMemoryPercentageMetrics: { + reservedIPs_list: { parameters: { - query: { - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - app_id: components["parameters"]["parameters_app_id"]; - /** - * @description The app component name. - * @example sample-application - */ - app_component?: components["parameters"]["app_component"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -29819,233 +42685,174 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["app_metric_response"]; + 200: components["responses"]["reserved_ip_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_appCPUPercentageMetrics: { + reservedIPs_create: { parameters: { - query: { - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - app_id: components["parameters"]["parameters_app_id"]; - /** - * @description The app component name. - * @example sample-application - */ - app_component?: components["parameters"]["app_component"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["reserved_ip_create"]; + }; + }; responses: { - 200: components["responses"]["app_metric_response"]; + 202: components["responses"]["reserved_ip_created"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - "monitoring_get_appRestartCountMetrics.yml": { + reservedIPs_get: { parameters: { - query: { - /** - * @description The app UUID. - * @example 2db3c021-15ad-4088-bfe8-99dc972b9cf6 - */ - app_id: components["parameters"]["parameters_app_id"]; - /** - * @description The app component name. - * @example sample-application - */ - app_component?: components["parameters"]["app_component"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IP address. + * @example 45.55.96.47 */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["app_metric_response"]; + 200: components["responses"]["reserved_ip"]; 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_lb_frontend_connections_current: { + reservedIPs_delete: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IP address. + * @example 45.55.96.47 */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 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_get_lb_frontend_connections_limit: { + reservedIPsActions_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IP address. + * @example 45.55.96.47 */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["reserved_ip_actions"]; 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_lb_frontend_cpu_utilization: { + reservedIPsActions_post: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IP address. + * @example 45.55.96.47 */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ip: components["parameters"]["reserved_ip"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + /** + * @description The `type` attribute set in the request body will specify the action that + * will be taken on the reserved IP. + */ + requestBody?: { + content: { + "application/json": components["schemas"]["reserved_ip_action_unassign"] | components["schemas"]["reserved_ip_action_assign"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["reserved_ip_action"]; 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_lb_frontend_firewall_dropped_bytes: { + reservedIPsActions_get: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description A reserved IP address. + * @example 45.55.96.47 */ - start: components["parameters"]["metric_timestamp_start"]; + reserved_ip: components["parameters"]["reserved_ip"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 */ - end: components["parameters"]["metric_timestamp_end"]; + action_id: components["parameters"]["action_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["reserved_ip_action"]; 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_lb_frontend_firewall_dropped_packets: { + reservedIPv6_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -30053,159 +42860,124 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["reserved_ipv6_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_http_responses: { + reservedIPv6_create: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["reserved_ipv6_create"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["reserved_ipv6_create"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_http_requests_per_second: { + reservedIPv6_get: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IPv6 address. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ipv6: components["parameters"]["reserved_ipv6"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["reserved_ipv6"]; 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_lb_frontend_network_throughput_http: { + reservedIPv6_delete: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IPv6 address. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ipv6: components["parameters"]["reserved_ipv6"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_entity"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_network_throughput_udp: { + reservedIPv6Actions_post: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A reserved IPv6 address. + * @example 2409:40d0:f7:1017:74b4:3a96:105e:4c6e */ - end: components["parameters"]["metric_timestamp_end"]; + reserved_ipv6: components["parameters"]["reserved_ipv6"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + /** + * @description The `type` attribute set in the request body will specify the action that + * will be taken on the reserved IPv6. + */ + requestBody?: { + content: { + "application/json": components["schemas"]["reserved_ipv6_action_unassign"] | components["schemas"]["reserved_ipv6_action_assign"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["reserved_ipv6_action"]; 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_lb_frontend_network_throughput_tcp: { + byoipPrefixes_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -30213,191 +42985,157 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["byoip_prefix_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_nlb_tcp_network_throughput: { + byoipPrefixes_create: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["byoip_prefix_create"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 202: components["responses"]["byoip_prefix_create"]; 401: components["responses"]["unauthorized"]; + 422: components["responses"]["unprocessable_entity"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_nlb_udp_network_throughput: { + byoipPrefixes_get: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The unique identifier for the BYOIP Prefix. + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ - end: components["parameters"]["metric_timestamp_end"]; + byoip_prefix_uuid: components["parameters"]["byoip_prefix"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["byoip_prefix_get"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_entity"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_tls_connections_current: { + byoipPrefixes_delete: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The unique identifier for the BYOIP Prefix. + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ - end: components["parameters"]["metric_timestamp_end"]; + byoip_prefix_uuid: components["parameters"]["byoip_prefix"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_entity"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_tls_connections_limit: { + byoipPrefixes_patch: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description A unique identifier for a BYOIP prefix. + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ - end: components["parameters"]["metric_timestamp_end"]; + byoip_prefix_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["byoip_prefix_update"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 202: components["responses"]["byoip_prefix_update"]; 401: components["responses"]["unauthorized"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_entity"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit: { + byoipPrefixes_list_resources: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The unique identifier for the BYOIP Prefix. + * @example f47ac10b-58cc-4372-a567-0e02b2c3d479 */ - end: components["parameters"]["metric_timestamp_end"]; + byoip_prefix_uuid: components["parameters"]["byoip_prefix"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["byoip_prefix_list_resources"]; 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_lb_droplets_http_session_duration_avg: { + sizes_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -30405,31 +43143,31 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["all_sizes"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_session_duration_50p: { + snapshots_list: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 */ - start: components["parameters"]["metric_timestamp_start"]; + page?: components["parameters"]["page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Used to filter snapshots by a resource type. + * @example droplet */ - end: components["parameters"]["metric_timestamp_end"]; + resource_type?: components["parameters"]["snapshot_resource_type"]; }; header?: never; path?: never; @@ -30437,95 +43175,99 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["snapshots"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_session_duration_95p: { + snapshots_get: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. + * @example 6372321 */ - end: components["parameters"]["metric_timestamp_end"]; + snapshot_id: components["parameters"]["snapshot_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["snapshots_existing"]; + 400: components["responses"]["not_a_snapshot"]; 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_lb_droplets_http_response_time_avg: { + snapshots_delete: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. + * @example 6372321 */ - end: components["parameters"]["metric_timestamp_end"]; + snapshot_id: components["parameters"]["snapshot_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 204: components["responses"]["no_content"]; + 400: components["responses"]["not_a_snapshot"]; 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_lb_droplets_http_response_time_50p: { + spacesKey_list: { parameters: { - query: { + query?: { /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Number of items returned per page + * @example 2 */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; + /** + * @description The field to sort by. + * @example created_at + */ + sort?: components["parameters"]["sort"]; + /** + * @description The direction to sort by. Possible values are `asc` or `desc`. + * @example desc + */ + sort_direction?: components["parameters"]["sort_direction"]; + /** + * @description The access key's name. + * @example my-access-key + */ + name?: components["parameters"]["name"]; + /** + * @description The bucket's name. + * @example my-bucket */ - start: components["parameters"]["metric_timestamp_start"]; + bucket?: components["parameters"]["bucket"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The permission of the access key. Possible values are `read`, `readwrite`, `fullaccess`, or an empty string. + * @example read */ - end: components["parameters"]["metric_timestamp_end"]; + permission?: components["parameters"]["permission"]; }; header?: never; path?: never; @@ -30533,191 +43275,149 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["key_list"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_response_time_95p: { + spacesKey_create: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["key"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["key_create"]; + 400: components["responses"]["bad_request-3"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_http_response_time_99p: { + spacesKey_get: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The access key's ID. + * @example DOACCESSKEYEXAMPLE */ - end: components["parameters"]["metric_timestamp_end"]; + access_key: components["parameters"]["access_key_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["key_get"]; 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_lb_droplets_queue_size: { + spacesKey_update: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The access key's ID. + * @example DOACCESSKEYEXAMPLE */ - end: components["parameters"]["metric_timestamp_end"]; + access_key: components["parameters"]["access_key_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["key"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["key_update"]; + 400: components["responses"]["bad_request-3"]; 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_lb_droplets_http_responses: { + spacesKey_delete: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The access key's ID. + * @example DOACCESSKEYEXAMPLE */ - end: components["parameters"]["metric_timestamp_end"]; + access_key: components["parameters"]["access_key_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 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_get_lb_droplets_connections: { + spacesKey_patch: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The access key's ID. + * @example DOACCESSKEYEXAMPLE */ - end: components["parameters"]["metric_timestamp_end"]; + access_key: components["parameters"]["access_key_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["key"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["key_update"]; + 400: components["responses"]["bad_request-3"]; 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_lb_droplets_health_checks: { + tags_list: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; + query?: { /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description Number of items returned per page + * @example 2 */ - start: components["parameters"]["metric_timestamp_start"]; + per_page?: components["parameters"]["per_page"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Which 'page' of paginated results to return. + * @example 1 */ - end: components["parameters"]["metric_timestamp_end"]; + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -30725,191 +43425,157 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["tags_all"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_lb_droplets_downtime: { + tags_create: { parameters: { - query: { - /** - * @description A unique identifier for a load balancer. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - lb_id: components["parameters"]["parameters_load_balancer_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["tags"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["tags_new"]; + 400: components["responses"]["tags_bad_request"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_droplet_autoscale_current_instances: { + tags_get: { parameters: { - query: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome */ - end: components["parameters"]["metric_timestamp_end"]; + tag_id: components["parameters"]["tag_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["tags_existing"]; 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_droplet_autoscale_target_instances: { + tags_delete: { parameters: { - query: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome */ - end: components["parameters"]["metric_timestamp_end"]; + tag_id: components["parameters"]["tag_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 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_get_droplet_autoscale_current_cpu_utilization.yml": { + tags_assign_resources: { parameters: { - query: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome */ - end: components["parameters"]["metric_timestamp_end"]; + tag_id: components["parameters"]["tag_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["tags_resource"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 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_get_droplet_autoscale_target_cpu_utilization: { + tags_unassign_resources: { parameters: { - query: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; + query?: never; + header?: never; + path: { /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. + * @example awesome */ - end: components["parameters"]["metric_timestamp_end"]; + tag_id: components["parameters"]["tag_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["tags_resource"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 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_get_droplet_autoscale_current_memory_utilization: { + volumes_list: { parameters: { - query: { + query?: { /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac + * @description The block storage volume's name. + * @example example */ - autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; + name?: components["parameters"]["volume_name"]; /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 + * @description The slug identifier for the region where the resource is available. + * @example nyc3 */ - start: components["parameters"]["metric_timestamp_start"]; + region?: components["parameters"]["parameters_region"]; /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 + * @description Number of items returned per page + * @example 2 */ - end: components["parameters"]["metric_timestamp_end"]; + per_page?: components["parameters"]["per_page"]; + /** + * @description Which 'page' of paginated results to return. + * @example 1 + */ + page?: components["parameters"]["page"]; }; header?: never; path?: never; @@ -30917,55 +43583,56 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["metric_response"]; + 200: components["responses"]["volumes"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_droplet_autoscale_target_memory_utilization: { + volumes_create: { parameters: { - query: { - /** - * @description A unique identifier for an autoscale pool. - * @example 0d3db13e-a604-4944-9827-7ec2642d32ac - */ - autoscale_pool_id: components["parameters"]["parameters_autoscale_pool_id"]; - /** - * @description UNIX timestamp to start metric window. - * @example 1620683817 - */ - start: components["parameters"]["metric_timestamp_start"]; - /** - * @description UNIX timestamp to end metric window. - * @example 1620705417 - */ - end: components["parameters"]["metric_timestamp_end"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["volumes_ext4"] | components["schemas"]["volumes_xfs"]; + }; + }; responses: { - 200: components["responses"]["metric_response"]; + 201: components["responses"]["volume"]; + 400: components["responses"]["bad_request"]; 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_destinations: { + volumes_delete_byName: { parameters: { - query?: never; + query?: { + /** + * @description The block storage volume's name. + * @example example + */ + name?: components["parameters"]["volume_name"]; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + region?: components["parameters"]["parameters_region"]; + }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["monitoring_list_destinations"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -30973,20 +43640,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_create_destination: { + volumeActions_post: { 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?: never; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["destination_request"]; + "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"]; }; }; responses: { - 200: components["responses"]["destination"]; + 202: components["responses"]["volumeAction"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -30994,22 +43672,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_destination: { + volumeSnapshots_get_byId: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a destination. - * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 */ - destination_uuid: components["parameters"]["destination_uuid"]; + snapshot_id: components["parameters"]["volume_snapshot_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["destination"]; + 200: components["responses"]["volumeSnapshot"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31017,24 +43695,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_update_destination: { + volumeSnapshots_delete_byId: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a destination. - * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 */ - destination_uuid: components["parameters"]["destination_uuid"]; + snapshot_id: components["parameters"]["volume_snapshot_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["destination_request"]; - }; - }; + requestBody?: never; responses: { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; @@ -31044,22 +43718,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_delete_destination: { + volumes_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a destination. - * @example 1a64809f-1708-48ee-a742-dec8d481b8d1 + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - destination_uuid: components["parameters"]["destination_uuid"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["volume"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31067,22 +43741,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_list_sinks: { + volumes_delete: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description A unique URN for a resource. - * @example do:kubernetes:5ba4518b-b9e2-4978-aa92-2d4c727e8824 + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - resource_id?: components["parameters"]["resource_id"]; + volume_id: components["parameters"]["volume_id"]; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["list_sinks"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31090,28 +43764,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_create_sink: { + volumeActions_list: { 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?: 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"][]; - }; + path: { + /** + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 + */ + volume_id: components["parameters"]["volume_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["accepted"]; + 200: components["responses"]["volumeActions"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31119,22 +43798,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_get_sink: { + volumeActions_post_byId: { 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: { /** - * @description A unique identifier for a sink. - * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - sink_uuid: components["parameters"]["sink_uuid"]; + volume_id: components["parameters"]["volume_id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"] | components["schemas"]["volume_action_post_resize"]; + }; + }; responses: { - 200: components["responses"]["sinks"]; + 202: components["responses"]["volumeAction"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31142,22 +43836,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - monitoring_delete_sink: { + volumeActions_get: { 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: { /** - * @description A unique identifier for a sink. - * @example 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 */ - sink_uuid: components["parameters"]["sink_uuid"]; + volume_id: components["parameters"]["volume_id"]; + /** + * @description A unique numeric ID that can be used to identify and reference an action. + * @example 36804636 + */ + action_id: components["parameters"]["action_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["volumeAction"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31165,7 +43875,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_list: { + volumeSnapshots_list: { parameters: { query?: { /** @@ -31180,48 +43890,58 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path?: never; + path: { + /** + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 + */ + volume_id: components["parameters"]["volume_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["projects_list"]; + 200: components["responses"]["volumeSnapshots"]; 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_create: { + volumeSnapshots_create: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description The ID of the block storage volume. + * @example 7724db7c-e098-11e5-b522-000f53304e51 + */ + volume_id: components["parameters"]["volume_id"]; + }; cookie?: never; }; requestBody: { content: { - "application/json": WithRequired; + /** + * @example { + * "name": "big-data-snapshot1475261774" + * } + */ + "application/json": { + /** + * @description A human-readable name for the volume snapshot. + * @example big-data-snapshot1475261774 + */ + name: string; + tags?: components["schemas"]["tags_array"]; + }; }; }; responses: { - 201: components["responses"]["existing_project"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - projects_get_default: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["default_project"]; + 201: components["responses"]["volumeSnapshot"]; + 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31229,20 +43949,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_update_default: { + vpcs_list: { 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?: never; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["project"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["all_vpcs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31250,7 +43977,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_patch_default: { + vpcs_create: { parameters: { query?: never; header?: never; @@ -31259,39 +43986,33 @@ export interface operations { }; requestBody: { content: { - /** - * @example { - * "name": "my-web-api" - * } - */ - "application/json": components["schemas"]["project"]; + "application/json": WithRequired & WithRequired; }; }; responses: { - 200: components["responses"]["existing_project"]; + 201: components["responses"]["existing_vpc"]; 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_get: { + vpcs_get: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. + * @description A unique identifier for a VPC. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - project_id: components["parameters"]["project_id"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31299,26 +44020,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_update: { + vpcs_update: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. + * @description A unique identifier for a VPC. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - project_id: components["parameters"]["project_id"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; requestBody: { content: { - "application/json": components["schemas"]["project"]; + "application/json": WithRequired & components["schemas"]["vpc_default"]; }; }; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31326,16 +44047,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_delete: { + vpcs_delete: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. + * @description A unique identifier for a VPC. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - project_id: components["parameters"]["project_id"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; @@ -31344,37 +44065,31 @@ export interface operations { 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; - 412: components["responses"]["precondition_failed"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - projects_patch: { + vpcs_patch: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a project. + * @description A unique identifier for a VPC. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - project_id: components["parameters"]["project_id"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; requestBody: { content: { - /** - * @example { - * "name": "my-web-api" - * } - */ - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["vpc_updatable"] & components["schemas"]["vpc_default"]; }; }; responses: { - 200: components["responses"]["existing_project"]; + 200: components["responses"]["existing_vpc"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31382,9 +44097,14 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_list_resources: { + vpcs_list_members: { parameters: { query?: { + /** + * @description Used to filter VPC members by a resource type. + * @example droplet + */ + resource_type?: components["parameters"]["vpc_resource_type"]; /** * @description Number of items returned per page * @example 2 @@ -31399,16 +44119,16 @@ export interface operations { header?: never; path: { /** - * @description A unique identifier for a project. + * @description A unique identifier for a VPC. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - project_id: components["parameters"]["project_id"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["resources_list"]; + 200: components["responses"]["vpc_members"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31416,26 +44136,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_assign_resources: { + vpcs_list_peerings: { 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: { /** - * @description A unique identifier for a project. + * @description A unique identifier for a VPC. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - project_id: components["parameters"]["project_id"]; + vpc_id: components["parameters"]["vpc_id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["project_assignment"]; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["assigned_resources_list"]; + 200: components["responses"]["vpc_peerings"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31443,16 +44170,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_list_resources_default: { + vpcs_create_peerings: { parameters: { query?: never; header?: never; - path?: 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; + 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: { - 200: components["responses"]["resources_list"]; + 202: components["responses"]["vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31460,20 +44209,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - projects_assign_resources_default: { + vpcs_patch_peerings: { parameters: { query?: never; header?: never; - path?: 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": components["schemas"]["project_assignment"]; + "application/json": WithRequired; }; }; responses: { - 200: components["responses"]["assigned_resources_list"]; + 200: components["responses"]["vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31481,7 +44241,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - regions_list: { + vpcPeerings_list: { parameters: { query?: { /** @@ -31494,6 +44254,11 @@ export interface operations { * @example 1 */ page?: components["parameters"]["page"]; + /** + * @description The slug identifier for the region where the resource is available. + * @example nyc3 + */ + region?: components["parameters"]["parameters_region"]; }; header?: never; path?: never; @@ -31501,30 +44266,15 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["all_regions"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - registry_get: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["registry_info"]; + 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"]; }; }; - registry_create: { + vpcPeerings_create: { parameters: { query?: never; header?: never; @@ -31533,27 +44283,33 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["registry_create"]; + "application/json": WithRequired & WithRequired; }; }; responses: { - 201: components["responses"]["registry_info"]; + 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"]; }; }; - registry_delete: { + vpcPeerings_get: { parameters: { query?: never; header?: never; - path?: 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: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["active_vpc_peering"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31561,62 +44317,89 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_get_subscription: { + vpcPeerings_delete: { parameters: { query?: never; header?: never; - path?: 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"]["subscription_response"]; + 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"]; }; }; - registry_update_subscription: { + vpcPeerings_patch: { parameters: { query?: never; header?: never; - path?: 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?: { + requestBody: { content: { - "application/json": { - /** - * @description The slug of the subscription tier to sign up for. - * @example basic - * @enum {string} - */ - tier_slug?: "starter" | "basic" | "professional"; - }; + "application/json": WithRequired; }; }; responses: { - 200: components["responses"]["subscription_response"]; + 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"]; }; }; - registry_get_dockerCredentials: { + vpcnatgateways_list: { parameters: { query?: { /** - * @description The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. - * @example 3600 + * @description Number of items returned per page + * @example 2 */ - expiry_seconds?: components["parameters"]["registry_expiry_seconds"]; + per_page?: components["parameters"]["per_page"]; /** - * @description By default, the registry credentials allow for read-only access. Set this query parameter to `true` to obtain read-write credentials. - * @example true + * @description Which 'page' of paginated results to return. + * @example 1 */ - read_write?: components["parameters"]["registry_read_write"]; + page?: components["parameters"]["page"]; + /** + * @description The current state of the VPC NAT gateway. + * @example active + */ + state?: components["parameters"]["vpc_nat_gateway_state"]; + /** + * @description The region where the VPC NAT gateway is located. + * @example tor1 + */ + region?: components["parameters"]["vpc_nat_gateway_region"]; + /** + * @description The type of the VPC NAT gateway. + * @example public + */ + type?: components["parameters"]["vpc_nat_gateway_type"]; + /** + * @description The name of the VPC NAT gateway. + * @example my-vpc-nat-gateway + */ + name?: components["parameters"]["vpc_nat_gateway_name"]; }; header?: never; path?: never; @@ -31624,61 +44407,49 @@ export interface operations { }; requestBody?: never; responses: { - 200: components["responses"]["docker_credentials"]; + 200: components["responses"]["vpc_nat_gateways"]; 401: components["responses"]["unauthorized"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_validate_name: { + vpcnatgateways_create: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["validate_registry"]; + "application/json": components["schemas"]["vpc_nat_gateway_create"]; }; }; responses: { - 204: components["responses"]["no_content"]; + 202: components["responses"]["vpc_nat_gateway_create"]; 401: components["responses"]["unauthorized"]; - 409: components["responses"]["conflict"]; 429: components["responses"]["too_many_requests"]; 500: components["responses"]["server_error"]; default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositories: { + vpcnatgateways_get: { 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"]; - }; + query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The unique identifier of the VPC NAT gateway. + * @example 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 */ - registry_name: components["parameters"]["registry_name"]; + id: components["parameters"]["vpc_nat_gateway_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_repositories"]; + 200: components["responses"]["vpc_nat_gateway"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31686,39 +44457,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositoriesV2: { + vpcnatgateways_update: { 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. Ignored when 'page_token' is provided. - * @example 1 - */ - page?: components["parameters"]["token_pagination_page"]; + query?: never; + header?: never; + path: { /** - * @description Token to retrieve of the next or previous set of results more quickly than using 'page'. - * @example eyJUb2tlbiI6IkNnZGpiMjlz + * @description The unique identifier of the VPC NAT gateway. + * @example 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 */ - page_token?: components["parameters"]["token_pagination_page_token"]; + id: components["parameters"]["vpc_nat_gateway_id"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["vpc_nat_gateway_update"]; }; + }; + responses: { + 200: components["responses"]["vpc_nat_gateway_update"]; + 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"]; + }; + }; + vpcnatgateways_delete: { + parameters: { + query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description The unique identifier of the VPC NAT gateway. + * @example 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 */ - registry_name: components["parameters"]["registry_name"]; + id: components["parameters"]["vpc_nat_gateway_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_repositories_v2"]; - 400: components["responses"]["bad_request"]; + 202: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31726,7 +44507,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_repositoryTags: { + uptime_list_checks: { parameters: { query?: { /** @@ -31741,23 +44522,12 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; - path: { - /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 - */ - repository_name: components["parameters"]["registry_repository_name"]; - }; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["repository_tags"]; + 200: components["responses"]["all_checks"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31765,71 +44535,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_delete_repositoryTag: { + uptime_create_check: { parameters: { query?: never; header?: never; - path: { - /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 - */ - repository_name: components["parameters"]["registry_repository_name"]; - /** - * @description The name of a container registry repository tag. - * @example 06a447a - */ - repository_tag: components["parameters"]["registry_repository_tag"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": WithRequired; + }; + }; responses: { - 204: components["responses"]["no_content"]; + 201: components["responses"]["existing_check"]; 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"]; }; }; - registry_list_repositoryManifests: { + uptime_get_check: { 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"]; - }; + query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - repository_name: components["parameters"]["registry_repository_name"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["repository_manifests"]; + 200: components["responses"]["existing_check"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31837,32 +44578,26 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_delete_repositoryManifest: { + uptime_update_check: { parameters: { query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The name of a container registry repository. If the name contains `/` characters, they must be URL-encoded, e.g. `%2F`. - * @example repo-1 - */ - repository_name: components["parameters"]["registry_repository_name"]; - /** - * @description The manifest digest of a container registry repository tag. - * @example sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221 + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - manifest_digest: components["parameters"]["registry_manifest_digest"]; + check_id: components["parameters"]["check_id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["check_updatable"]; }; - cookie?: never; }; - requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + 200: components["responses"]["existing_check"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31870,22 +44605,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_get_garbageCollection: { + uptime_delete_check: { parameters: { query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - registry_name: components["parameters"]["registry_name"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["garbage_collection"]; + 204: components["responses"]["no_content"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31893,22 +44628,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_run_garbageCollection: { + uptime_get_checkState: { parameters: { query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - registry_name: components["parameters"]["registry_name"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 201: components["responses"]["garbage_collection"]; + 200: components["responses"]["existing_check_state"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31916,7 +44651,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_list_garbageCollections: { + uptime_list_alerts: { parameters: { query?: { /** @@ -31933,16 +44668,16 @@ export interface operations { header?: never; path: { /** - * @description The name of a container registry. - * @example example + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - registry_name: components["parameters"]["registry_name"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["garbage_collections"]; + 200: components["responses"]["all_alerts"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31950,31 +44685,35 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_update_garbageCollection: { + uptime_create_alert: { parameters: { query?: never; header?: never; path: { /** - * @description The name of a container registry. - * @example example - */ - registry_name: components["parameters"]["registry_name"]; - /** - * @description The UUID of a garbage collection run. - * @example eff0feee-49c7-4e8f-ba5c-a320c109c8a8 + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - garbage_collection_uuid: components["parameters"]["garbage_collection_uuid"]; + check_id: components["parameters"]["check_id"]; }; cookie?: never; }; + /** + * @description The ''type'' field dictates the type of alert, and hence what type of value to pass into the threshold property. + * Type | Description | Threshold Value + * -----|-------------|-------------------- + * `latency` | alerts on the response latency | milliseconds + * `down` | alerts on a target registering as down in any region | N/A (Not required) + * `down_global` | alerts on a target registering as down globally | N/A (Not required) + * `ssl_expiry` | alerts on a SSL certificate expiring within $threshold days | days + */ requestBody: { content: { - "application/json": components["schemas"]["update_registry"]; + "application/json": components["schemas"]["alert"]; }; }; responses: { - 200: components["responses"]["garbage_collection"]; + 201: components["responses"]["existing_alert"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -31982,102 +44721,131 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - registry_get_options: { + uptime_get_alert: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + check_id: components["parameters"]["check_id"]; + /** + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + */ + alert_id: components["parameters"]["parameters_alert_id"]; + }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["registry_options_response"]; + 200: components["responses"]["existing_alert"]; 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"]; }; }; - droplets_list_neighborsIds: { + uptime_update_alert: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["droplet_neighbors_ids"]; - 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"]; - }; - }; - reservedIPs_list: { - parameters: { - query?: { + path: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 */ - per_page?: components["parameters"]["per_page"]; + check_id: components["parameters"]["check_id"]; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 */ - page?: components["parameters"]["page"]; + alert_id: components["parameters"]["parameters_alert_id"]; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": WithRequired; + }; + }; responses: { - 200: components["responses"]["reserved_ip_list"]; + 200: components["responses"]["existing_alert"]; 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"]; }; }; - reservedIPs_create: { + uptime_delete_alert: { parameters: { query?: never; header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["reserved_ip_create"]; + path: { + /** + * @description A unique identifier for a check. + * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + */ + check_id: components["parameters"]["check_id"]; + /** + * @description A unique identifier for an alert. + * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + */ + alert_id: components["parameters"]["parameters_alert_id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - 202: components["responses"]["reserved_ip_created"]; + 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"]; }; }; - reservedIPs_get: { + genai_list_agents: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description Only list agents that are deployed. + * @example true */ - reserved_ip: components["parameters"]["reserved_ip"]; + only_deployed?: boolean; + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["reserved_ip"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListAgentsOutputPublic"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32085,22 +44853,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPs_delete: { + genai_create_agent: { parameters: { query?: never; header?: never; - path: { - /** - * @description A reserved IP address. - * @example 45.55.96.47 - */ - reserved_ip: components["parameters"]["reserved_ip"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiCreateAgentInputPublic"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32108,22 +44885,44 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPsActions_list: { + genai_list_agent_api_keys: { parameters: { - query?: never; + query?: { + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; + }; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - reserved_ip: components["parameters"]["reserved_ip"]; + agent_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["reserved_ip_actions"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListAgentAPIKeysOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32131,30 +44930,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPsActions_post: { + genai_create_agent_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - reserved_ip: components["parameters"]["reserved_ip"]; + agent_uuid: string; }; cookie?: never; }; - /** - * @description The `type` attribute set in the request body will specify the action that - * will be taken on the reserved IP. - */ requestBody?: { content: { - "application/json": components["schemas"]["reserved_ip_action_unassign"] | components["schemas"]["reserved_ip_action_assign"]; + "application/json": components["schemas"]["apiCreateAgentAPIKeyInputPublic"]; }; }; responses: { - 201: components["responses"]["reserved_ip_action"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateAgentAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32162,27 +44968,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - reservedIPsActions_get: { + genai_update_agent_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description A reserved IP address. - * @example 45.55.96.47 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - reserved_ip: components["parameters"]["reserved_ip"]; + agent_uuid: string; /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description API key ID + * @example "123e4567-e89b-12d3-a456-426614174000" */ - action_id: components["parameters"]["action_id"]; + api_key_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateAgentAPIKeyInputPublic"]; + }; + }; responses: { - 200: components["responses"]["reserved_ip_action"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateAgentAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32190,82 +45011,115 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - sizes_list: { + genai_delete_agent_api_key: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for your agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - per_page?: components["parameters"]["per_page"]; + agent_uuid: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description API key for an agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + api_key_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_sizes"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiDeleteAgentAPIKeyOutput"]; + }; + }; 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"]; }; }; - snapshots_list: { + genai_regenerate_agent_api_key: { parameters: { - query?: { - /** - * @description Number of items returned per page - * @example 2 - */ - per_page?: components["parameters"]["per_page"]; + query?: never; + header?: never; + path: { /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + agent_uuid: string; /** - * @description Used to filter snapshots by a resource type. - * @example droplet + * @description API key ID + * @example "123e4567-e89b-12d3-a456-426614174000" */ - resource_type?: components["parameters"]["snapshot_resource_type"]; + api_key_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["snapshots"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiRegenerateAgentAPIKeyOutput"]; + }; + }; 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"]; }; }; - snapshots_get: { + genai_attach_agent_function: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - snapshot_id: components["parameters"]["snapshot_id"]; + agent_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiLinkAgentFunctionInputPublic"]; + }; + }; responses: { - 200: components["responses"]["snapshots_existing"]; - 400: components["responses"]["not_a_snapshot"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiLinkAgentFunctionOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32273,23 +45127,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - snapshots_delete: { + genai_update_agent_function: { parameters: { query?: never; header?: never; path: { /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - snapshot_id: components["parameters"]["snapshot_id"]; + agent_uuid: string; + /** + * @description Function id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + function_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateAgentFunctionInputPublic"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["not_a_snapshot"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateAgentFunctionOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32297,70 +45170,76 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_list: { + genai_detach_agent_function: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description The id of the agent the function route belongs to. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - per_page?: components["parameters"]["per_page"]; + agent_uuid: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description The function route to be destroyed. This does not destroy the function itself. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + function_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["tags_all"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - tags_create: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["tags"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUnlinkAgentFunctionOutput"]; + }; }; - }; - responses: { - 201: components["responses"]["tags_new"]; - 400: components["responses"]["tags_bad_request"]; 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"]; }; }; - tags_get: { + genai_attach_agent_guardrails: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description The UUID of the agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - tag_id: components["parameters"]["tag_id"]; + agent_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiLinkAgentGuardrailsInputPublic"]; + }; + }; responses: { - 200: components["responses"]["tags_existing"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiLinkAgentGuardrailOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32368,22 +45247,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_delete: { + genai_detach_agent_guardrail: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description The UUID of the agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - tag_id: components["parameters"]["tag_id"]; + agent_uuid: string; + /** + * @description The UUID of the guardrail to detach. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + guardrail_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUnlinkAgentGuardrailOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32391,26 +45286,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_assign_resources: { + genai_attach_knowledge_bases: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description A unique identifier for an agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - tag_id: components["parameters"]["tag_id"]; + agent_uuid: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["tags_resource"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiLinkKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32418,26 +45320,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - tags_unassign_resources: { + genai_attach_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description The name of the tag. Tags may contain letters, numbers, colons, dashes, and underscores. There is a limit of 255 characters per tag. - * @example awesome + * @description A unique identifier for an agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - tag_id: components["parameters"]["tag_id"]; + agent_uuid: string; + /** + * @description A unique identifier for a knowledge base. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + knowledge_base_uuid: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["tags_resource"]; - }; - }; + requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiLinkKnowledgeBaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32445,58 +45359,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_list: { + genai_detach_knowledge_base: { parameters: { - query?: { - /** - * @description The block storage volume's name. - * @example example - */ - name?: components["parameters"]["volume_name"]; - /** - * @description The slug identifier for the region where the resource is available. - * @example nyc3 - */ - region?: components["parameters"]["region"]; + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - per_page?: components["parameters"]["per_page"]; + agent_uuid: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Knowledge base id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + knowledge_base_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumes"]; - 401: components["responses"]["unauthorized"]; - 429: components["responses"]["too_many_requests"]; - 500: components["responses"]["server_error"]; - default: components["responses"]["unexpected_error"]; - }; - }; - volumes_create: { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": components["schemas"]["volumes_ext4"] | components["schemas"]["volumes_xfs"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUnlinkKnowledgeBaseOutput"]; + }; }; - }; - responses: { - 201: components["responses"]["volume"]; - 400: components["responses"]["bad_request"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32504,27 +45398,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_delete_byName: { + genai_update_attached_agent: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description The block storage volume's name. - * @example example + * @description A unique identifier for the parent agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - name?: components["parameters"]["volume_name"]; + parent_agent_uuid: string; /** - * @description The slug identifier for the region where the resource is available. - * @example nyc3 + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - region?: components["parameters"]["region"]; + child_agent_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateLinkedAgentInputPublic"]; + }; + }; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateLinkedAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32532,31 +45441,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_post: { + genai_attach_agent: { parameters: { - query?: { + query?: never; + header?: never; + path: { /** - * @description Number of items returned per page - * @example 2 + * @description A unique identifier for the parent agent. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - per_page?: components["parameters"]["per_page"]; + parent_agent_uuid: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - page?: components["parameters"]["page"]; + child_agent_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"]; + "application/json": components["schemas"]["apiLinkAgentInputPublic"]; }; }; responses: { - 202: components["responses"]["volumeAction"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiLinkAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32564,22 +45484,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_get_byId: { + genai_detach_agent: { parameters: { query?: never; header?: never; path: { /** - * @description The unique identifier for the snapshot. - * @example fbe805e8-866b-11e6-96bf-000f53315a41 + * @description Pagent agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - snapshot_id: components["parameters"]["volume_snapshot_id"]; + parent_agent_uuid: string; + /** + * @description Routed agent id + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + child_agent_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumeSnapshot"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUnlinkAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32587,22 +45523,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_delete_byId: { + genai_get_agent: { parameters: { query?: never; header?: never; path: { /** - * @description The unique identifier for the snapshot. - * @example fbe805e8-866b-11e6-96bf-000f53315a41 + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - snapshot_id: components["parameters"]["volume_snapshot_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32610,22 +45557,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_get: { + genai_update_agent: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateAgentInputPublic"]; + }; + }; responses: { - 200: components["responses"]["volume"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32633,22 +45595,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumes_delete: { + genai_delete_agent: { parameters: { query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Unique agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiDeleteAgentOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32656,33 +45629,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_list: { + genai_get_agent_children: { 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"]; - }; + query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumeActions"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetChildrenOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32690,37 +45663,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_post_byId: { + genai_update_agent_deployment_visibility: { 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"]; - }; + query?: never; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Unique id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["volume_action_post_attach"] | components["schemas"]["volume_action_post_detach"] | components["schemas"]["volume_action_post_resize"]; + "application/json": components["schemas"]["apiUpdateAgentDeploymentVisibilityInputPublic"]; }; }; responses: { - 202: components["responses"]["volumeAction"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateAgentDeploymentVisbilityOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32728,38 +45701,44 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeActions_get: { + genai_get_agent_usage: { parameters: { query?: { /** - * @description Number of items returned per page - * @example 2 + * @description Return all usage data from this date. + * @example "example string" */ - per_page?: components["parameters"]["per_page"]; + start?: string; /** - * @description Which 'page' of paginated results to return. - * @example 1 + * @description Return all usage data up to this date, if omitted, will return up to the current date. + * @example "example string" */ - page?: components["parameters"]["page"]; + stop?: string; }; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 - */ - volume_id: components["parameters"]["volume_id"]; - /** - * @description A unique numeric ID that can be used to identify and reference an action. - * @example 36804636 + * @description Agent id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - action_id: components["parameters"]["action_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumeAction"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetAgentUsageOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32767,101 +45746,44 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - volumeSnapshots_list: { + genai_list_agent_versions: { parameters: { query?: { /** - * @description Number of items returned per page - * @example 2 + * @description Page number. + * @example 1 */ - per_page?: components["parameters"]["per_page"]; + page?: number; /** - * @description Which 'page' of paginated results to return. + * @description Items per page. * @example 1 */ - page?: components["parameters"]["page"]; + per_page?: number; }; header?: never; path: { /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 + * @description Agent uuid + * @example "123e4567-e89b-12d3-a456-426614174000" */ - volume_id: components["parameters"]["volume_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["volumeSnapshots"]; - 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"]; - }; - }; - volumeSnapshots_create: { - parameters: { - query?: never; - header?: never; - path: { - /** - * @description The ID of the block storage volume. - * @example 7724db7c-e098-11e5-b522-000f53304e51 - */ - volume_id: components["parameters"]["volume_id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - /** - * @example { - * "name": "big-data-snapshot1475261774" - * } - */ - "application/json": { - /** - * @description A human-readable name for the volume snapshot. - * @example big-data-snapshot1475261774 - */ - name: string; - tags?: components["schemas"]["tags_array"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListAgentVersionsOutput"]; }; }; - }; - responses: { - 201: components["responses"]["volumeSnapshot"]; - 400: components["responses"]["bad_request"]; - 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_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"]; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - 200: components["responses"]["all_vpcs"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32869,42 +45791,76 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_create: { + genai_rollback_to_agent_version: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** + * @description Agent unique identifier + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid: string; + }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired & WithRequired; + "application/json": components["schemas"]["apiRollbackToAgentVersionInputPublic"]; }; }; responses: { - 201: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiRollbackToAgentVersionOutput"]; + }; + }; 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_get: { + genai_list_anthropic_api_keys: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Page number. + * @example 1 */ - vpc_id: components["parameters"]["vpc_id"]; + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListAnthropicAPIKeysOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32912,26 +45868,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_update: { + genai_create_anthropic_api_key: { 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"]; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired & components["schemas"]["vpc_default"]; + "application/json": components["schemas"]["apiCreateAnthropicAPIKeyInputPublic"]; }; }; responses: { - 200: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateAnthropicAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32939,22 +45900,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_delete: { + genai_get_anthropic_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description API key ID + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + api_key_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetAnthropicAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32962,26 +45934,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_patch: { + genai_update_anthropic_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description API key ID + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + api_key_uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["vpc_updatable"] & components["schemas"]["vpc_default"]; + "application/json": components["schemas"]["apiUpdateAnthropicAPIKeyInputPublic"]; }; }; responses: { - 200: components["responses"]["existing_vpc"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateAnthropicAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -32989,38 +45972,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_list_members: { + genai_delete_anthropic_api_key: { parameters: { - query?: { - /** - * @description Used to filter VPC members by a resource type. - * @example droplet - */ - resource_type?: components["parameters"]["vpc_resource_type"]; - /** - * @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"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description API key ID + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + api_key_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["vpc_members"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiDeleteAnthropicAPIKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33028,33 +46006,44 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_list_peerings: { + genai_list_agents_by_anthropic_key: { parameters: { query?: { /** - * @description Number of items returned per page - * @example 2 + * @description Page number. + * @example 1 */ - per_page?: components["parameters"]["per_page"]; + page?: number; /** - * @description Which 'page' of paginated results to return. + * @description Items per page. * @example 1 */ - page?: components["parameters"]["page"]; + per_page?: number; }; header?: never; path: { /** - * @description A unique identifier for a VPC. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Unique ID of Anthropic key + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_id: components["parameters"]["vpc_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["vpc_peerings"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListAgentsByAnthropicKeyOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33062,38 +46051,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_create_peerings: { + genai_create_evaluation_dataset: { 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"]; - }; + path?: never; cookie?: never; }; - requestBody: { + 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; - }; + "application/json": components["schemas"]["apiCreateEvaluationDatasetInputPublic"]; }; }; responses: { - 202: components["responses"]["vpc_peering"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateEvaluationDatasetOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33101,31 +46083,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcs_patch_peerings: { + genai_create_evaluation_dataset_file_upload_presigned_urls: { 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"]; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["apiCreateDataSourceFileUploadPresignedUrlsInputPublic"]; }; }; responses: { - 200: components["responses"]["vpc_peering"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateDataSourceFileUploadPresignedUrlsOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33133,32 +46115,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_list: { + genai_list_evaluation_metrics: { 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"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_vpc_peerings"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListEvaluationMetricsOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33166,42 +46143,65 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_create: { + genai_run_evaluation_test_case: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired & WithRequired; + "application/json": components["schemas"]["apiRunEvaluationTestCaseInputPublic"]; }; }; responses: { - 202: components["responses"]["provisioning_vpc_peering"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiRunEvaluationTestCaseOutput"]; + }; + }; 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_get: { + genai_get_evaluation_run: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description Evaluation run UUID. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + evaluation_run_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["active_vpc_peering"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetEvaluationRunOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33209,22 +46209,44 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_delete: { + genai_get_evaluation_run_results: { parameters: { - query?: never; + query?: { + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; + }; header?: never; path: { /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description Evaluation run UUID. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + evaluation_run_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 202: components["responses"]["deleting_vpc_peering"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetEvaluationRunResultsOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33232,26 +46254,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - vpcPeerings_patch: { + genai_get_evaluation_run_prompt_results: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a VPC peering. - * @example 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + * @description Evaluation run UUID. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - vpc_peering_id: components["parameters"]["vpc_peering_id"]; + evaluation_run_uuid: string; + /** + * @description Prompt ID to get results for. + * @example 1 + */ + prompt_id: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": WithRequired; - }; - }; + requestBody?: never; responses: { - 200: components["responses"]["active_vpc_peering"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetEvaluationRunPromptResultsOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33259,27 +46293,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_list_checks: { + genai_list_evaluation_test_cases: { 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"]; - }; + query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_checks"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListEvaluationTestCasesOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33287,42 +46321,71 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_create_check: { + genai_create_evaluation_test_case: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["apiCreateEvaluationTestCaseInputPublic"]; }; }; responses: { - 201: components["responses"]["existing_check"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateEvaluationTestCaseOutput"]; + }; + }; 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_get_check: { + genai_list_evaluation_runs_by_test_case: { parameters: { - query?: never; + query?: { + /** + * @description Version of the test case. + * @example 1 + */ + evaluation_test_case_version?: number; + }; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Evaluation run UUID. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + evaluation_test_case_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_check"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListEvaluationRunsByTestCaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33330,26 +46393,77 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_update_check: { + genai_get_evaluation_test_case: { + parameters: { + query?: { + /** + * @description Version of the test case. + * @example 1 + */ + evaluation_test_case_version?: number; + }; + header?: never; + path: { + /** + * @description The test case uuid to retrieve. + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + test_case_uuid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetEvaluationTestCaseOutput"]; + }; + }; + 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"]; + }; + }; + genai_update_evaluation_test_case: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Test-case UUID to update + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + test_case_uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": components["schemas"]["check_updatable"]; + "application/json": components["schemas"]["apiUpdateEvaluationTestCaseInputPublic"]; }; }; responses: { - 200: components["responses"]["existing_check"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiUpdateEvaluationTestCaseOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33357,22 +46471,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_delete_check: { + genai_list_indexing_jobs: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Page number. + * @example 1 */ - check_id: components["parameters"]["check_id"]; + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListKnowledgeBaseIndexingJobsOutput"]; + }; }; - 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"]; @@ -33380,22 +46510,31 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_get_checkState: { + genai_create_indexing_job: { parameters: { query?: never; header?: never; - path: { - /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - check_id: components["parameters"]["check_id"]; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiStartKnowledgeBaseIndexingJobInputPublic"]; + }; + }; responses: { - 200: components["responses"]["existing_check_state"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiStartKnowledgeBaseIndexingJobOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33403,33 +46542,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_list_alerts: { + genai_list_indexing_job_data_sources: { 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"]; - }; + query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Uuid of the indexing job + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + indexing_job_uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["all_alerts"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListIndexingJobDataSourcesOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33437,35 +46576,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_create_alert: { + genai_get_indexing_job_details_signed_url: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description The uuid of the indexing job + * @example "123e4567-e89b-12d3-a456-426614174000" */ - check_id: components["parameters"]["check_id"]; + indexing_job_uuid: string; }; cookie?: never; }; - /** - * @description The ''type'' field dictates the type of alert, and hence what type of value to pass into the threshold property. - * Type | Description | Threshold Value - * -----|-------------|-------------------- - * `latency` | alerts on the response latency | milliseconds - * `down` | alerts on a target registering as down in any region | N/A (Not required) - * `down_global` | alerts on a target registering as down globally | N/A (Not required) - * `ssl_expiry` | alerts on a SSL certificate expiring within $threshold days | days - */ - requestBody: { - content: { - "application/json": components["schemas"]["alert"]; - }; - }; + requestBody?: never; responses: { - 201: components["responses"]["existing_alert"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetIndexingJobDetailsSignedURLOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33473,27 +46610,33 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_get_alert: { + genai_get_indexing_job: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - check_id: components["parameters"]["check_id"]; - /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + * @description Indexing job id + * @example "123e4567-e89b-12d3-a456-426614174000" */ - alert_id: components["parameters"]["parameters_alert_id"]; + uuid: string; }; cookie?: never; }; requestBody?: never; responses: { - 200: components["responses"]["existing_alert"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiGetKnowledgeBaseIndexingJobOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33501,31 +46644,37 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_update_alert: { + genai_cancel_indexing_job: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 - */ - check_id: components["parameters"]["check_id"]; - /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + * @description A unique identifier for an indexing job. + * @example "123e4567-e89b-12d3-a456-426614174000" */ - alert_id: components["parameters"]["parameters_alert_id"]; + uuid: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/json": WithRequired; + "application/json": components["schemas"]["apiCancelKnowledgeBaseIndexingJobInputPublic"]; }; }; responses: { - 200: components["responses"]["existing_alert"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCancelKnowledgeBaseIndexingJobOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33533,27 +46682,38 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - uptime_delete_alert: { + genai_list_knowledge_bases: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for a check. - * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 + * @description Page number. + * @example 1 */ - check_id: components["parameters"]["check_id"]; + page?: number; /** - * @description A unique identifier for an alert. - * @example 17f0f0ae-b7e5-4ef6-86e3-aa569db58284 + * @description Items per page. + * @example 1 */ - alert_id: components["parameters"]["parameters_alert_id"]; + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiListKnowledgeBasesOutput"]; + }; + }; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -33561,30 +46721,18 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_list_agents: { + genai_create_knowledge_base: { parameters: { - query?: { - /** - * @description Only list agents that are deployed. - * @example true - */ - only_deployed?: boolean; - /** - * @description Page number. - * @example 1 - */ - page?: number; - /** - * @description Items per page. - * @example 1 - */ - per_page?: number; - }; + query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiCreateKnowledgeBaseInputPublic"]; + }; + }; responses: { /** @description A successful response. */ 200: { @@ -33595,7 +46743,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListAgentsOutputPublic"]; + "application/json": components["schemas"]["apiCreateKnowledgeBaseOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33605,7 +46753,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_create_agent: { + genai_create_data_source_file_upload_presigned_urls: { parameters: { query?: never; header?: never; @@ -33614,7 +46762,7 @@ export interface operations { }; requestBody?: { content: { - "application/json": components["schemas"]["apiCreateAgentInputPublic"]; + "application/json": components["schemas"]["apiCreateDataSourceFileUploadPresignedUrlsInputPublic"]; }; }; responses: { @@ -33627,7 +46775,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiCreateAgentOutput"]; + "application/json": components["schemas"]["apiCreateDataSourceFileUploadPresignedUrlsOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33637,7 +46785,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_list_agent_api_keys: { + genai_list_knowledge_base_data_sources: { parameters: { query?: { /** @@ -33654,10 +46802,10 @@ export interface operations { header?: never; path: { /** - * @description Agent id + * @description Knowledge base id * @example "123e4567-e89b-12d3-a456-426614174000" */ - agent_uuid: string; + knowledge_base_uuid: string; }; cookie?: never; }; @@ -33672,7 +46820,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListAgentAPIKeysOutput"]; + "application/json": components["schemas"]["apiListKnowledgeBaseDataSourcesOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33682,22 +46830,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_create_agent_api_key: { + genai_create_knowledge_base_data_source: { parameters: { query?: never; header?: never; path: { /** - * @description Agent id + * @description Knowledge base id * @example "123e4567-e89b-12d3-a456-426614174000" */ - agent_uuid: string; + knowledge_base_uuid: string; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiCreateAgentAPIKeyInputPublic"]; + "application/json": components["schemas"]["apiCreateKnowledgeBaseDataSourceInputPublic"]; }; }; responses: { @@ -33710,7 +46858,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiCreateAgentAPIKeyOutput"]; + "application/json": components["schemas"]["apiCreateKnowledgeBaseDataSourceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33720,27 +46868,27 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_update_agent_api_key: { + genai_update_knowledge_base_data_source: { parameters: { query?: never; header?: never; path: { /** - * @description Agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Knowledge Base ID (Path Parameter) + * @example 123e4567-e89b-12d3-a456-426614174000 */ - agent_uuid: string; + knowledge_base_uuid: string; /** - * @description Api key id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Data Source ID (Path Parameter) + * @example 123e4567-e89b-12d3-a456-426614174000 */ - api_key_uuid: string; + data_source_uuid: string; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiUpdateAgentAPIKeyInputPublic"]; + "application/json": components["schemas"]["apiUpdateKnowledgeBaseDataSourceInputPublic"]; }; }; responses: { @@ -33753,7 +46901,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUpdateAgentAPIKeyOutput"]; + "application/json": components["schemas"]["apiUpdateKnowledgeBaseDataSourceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33763,21 +46911,21 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_delete_agent_api_key: { + genai_delete_knowledge_base_data_source: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for your agent. + * @description Knowledge base id * @example "123e4567-e89b-12d3-a456-426614174000" */ - agent_uuid: string; + knowledge_base_uuid: string; /** - * @description API key for an agent. + * @description Data source id * @example "123e4567-e89b-12d3-a456-426614174000" */ - api_key_uuid: string; + data_source_uuid: string; }; cookie?: never; }; @@ -33792,7 +46940,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiDeleteAgentAPIKeyOutput"]; + "application/json": components["schemas"]["apiDeleteKnowledgeBaseDataSourceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33802,21 +46950,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_regenerate_agent_api_key: { + genai_list_indexing_jobs_by_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description Agent id - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - agent_uuid: string; - /** - * @description Api key id + * @description Knowledge base uuid in string * @example "123e4567-e89b-12d3-a456-426614174000" */ - api_key_uuid: string; + knowledge_base_uuid: string; }; cookie?: never; }; @@ -33831,7 +46974,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiRegenerateAgentAPIKeyOutput"]; + "application/json": components["schemas"]["apiListKnowledgeBaseIndexingJobsOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33841,24 +46984,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_attach_agent_function: { + genai_get_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description Agent id + * @description Knowledge base id * @example "123e4567-e89b-12d3-a456-426614174000" */ - agent_uuid: string; + uuid: string; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["apiLinkAgentFunctionInputPublic"]; - }; - }; + requestBody?: never; responses: { /** @description A successful response. */ 200: { @@ -33869,7 +47008,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiLinkAgentFunctionOutput"]; + "application/json": components["schemas"]["apiGetKnowledgeBaseOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33879,27 +47018,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_update_agent_function: { + genai_update_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description Agent id - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - agent_uuid: string; - /** - * @description Function id + * @description Knowledge base id * @example "123e4567-e89b-12d3-a456-426614174000" */ - function_uuid: string; + uuid: string; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiUpdateAgentFunctionInputPublic"]; + "application/json": components["schemas"]["apiUpdateKnowledgeBaseInputPublic"]; }; }; responses: { @@ -33912,7 +47046,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUpdateAgentFunctionOutput"]; + "application/json": components["schemas"]["apiUpdateKnowledgeBaseOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33922,21 +47056,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_detach_agent_function: { + genai_delete_knowledge_base: { parameters: { query?: never; header?: never; path: { /** - * @description The id of the agent the function route belongs to. - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - agent_uuid: string; - /** - * @description The function route to be destroyed. This does not destroy the function itself. + * @description Knowledge base id * @example "123e4567-e89b-12d3-a456-426614174000" */ - function_uuid: string; + uuid: string; }; cookie?: never; }; @@ -33951,7 +47080,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUnlinkAgentFunctionOutput"]; + "application/json": components["schemas"]["apiDeleteKnowledgeBaseOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -33961,22 +47090,42 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_attach_knowledge_base: { + genai_list_models: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description A unique identifier for an agent. - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Include only models defined for the listed usecases. + * + * - MODEL_USECASE_UNKNOWN: The use case of the model is unknown + * - MODEL_USECASE_AGENT: The model maybe used in an agent + * - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning + * - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) + * - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + * - MODEL_USECASE_REASONING: The model usecase for reasoning + * - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference + * @example [ + * "MODEL_USECASE_UNKNOWN" + * ] */ - agent_uuid: string; + usecases?: ("MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | "MODEL_USECASE_KNOWLEDGEBASE" | "MODEL_USECASE_GUARDRAIL" | "MODEL_USECASE_REASONING" | "MODEL_USECASE_SERVERLESS")[]; /** - * @description A unique identifier for a knowledge base. - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Only include models that are publicly available. + * @example true */ - knowledge_base_uuid: string; + public_only?: boolean; + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; @@ -33990,7 +47139,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiLinkKnowledgeBaseOutput"]; + "application/json": components["schemas"]["apiListModelsOutputPublic"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34000,22 +47149,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_detach_knowledge_base: { + genai_list_model_api_keys: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description Agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Page number. + * @example 1 */ - agent_uuid: string; + page?: number; /** - * @description Knowledge base id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Items per page. + * @example 1 */ - knowledge_base_uuid: string; + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; @@ -34029,7 +47178,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUnlinkKnowledgeBaseOutput"]; + "application/json": components["schemas"]["apiListModelAPIKeysOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34039,27 +47188,54 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_update_attached_agent: { + genai_create_model_api_key: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["apiCreateModelAPIKeyInputPublic"]; + }; + }; + responses: { + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiCreateModelAPIKeyOutput"]; + }; + }; + 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"]; + }; + }; + genai_update_model_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for the parent agent. - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - parent_agent_uuid: string; - /** - * @description Routed agent id + * @description API key ID * @example "123e4567-e89b-12d3-a456-426614174000" */ - child_agent_uuid: string; + api_key_uuid: string; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiUpdateLinkedAgentInputPublic"]; + "application/json": components["schemas"]["apiUpdateModelAPIKeyInputPublic"]; }; }; responses: { @@ -34072,7 +47248,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUpdateLinkedAgentOutput"]; + "application/json": components["schemas"]["apiUpdateModelAPIKeyOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34082,27 +47258,84 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_attach_agent: { + genai_delete_model_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for the parent agent. + * @description API key for an agent. * @example "123e4567-e89b-12d3-a456-426614174000" */ - parent_agent_uuid: string; + api_key_uuid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiDeleteModelAPIKeyOutput"]; + }; + }; + 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"]; + }; + }; + genai_regenerate_model_api_key: { + parameters: { + query?: never; + header?: never; + path: { /** - * @description Routed agent id + * @description API key ID * @example "123e4567-e89b-12d3-a456-426614174000" */ - child_agent_uuid: string; + api_key_uuid: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description A successful response. */ + 200: { + 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": components["schemas"]["apiRegenerateModelAPIKeyOutput"]; + }; }; + 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"]; + }; + }; + genai_create_oauth2_dropbox_tokens: { + parameters: { + query?: never; + header?: never; + path?: never; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiLinkAgentInputPublic"]; + "application/json": components["schemas"]["apiDropboxOauth2GetTokensInput"]; }; }; responses: { @@ -34115,7 +47348,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiLinkAgentOutput"]; + "application/json": components["schemas"]["apiDropboxOauth2GetTokensOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34125,22 +47358,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_detach_agent: { + genai_get_oauth2_url: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description Pagent agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Type "google" / "dropbox". + * @example "example string" */ - parent_agent_uuid: string; + type?: string; /** - * @description Routed agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description The redirect url. + * @example "example string" */ - child_agent_uuid: string; + redirect_url?: string; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; @@ -34154,7 +47387,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUnlinkAgentOutput"]; + "application/json": components["schemas"]["apiGenerateOauth2URLOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34164,17 +47397,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_get_agent: { + genai_list_openai_api_keys: { parameters: { - query?: never; - header?: never; - path: { + query?: { /** - * @description Unique agent id - * @example "123e4567-e89b-12d3-a456-426614174000" + * @description Page number. + * @example 1 */ - uuid: string; + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; }; + header?: never; + path?: never; cookie?: never; }; requestBody?: never; @@ -34188,7 +47426,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiGetAgentOutputPublic"]; + "application/json": components["schemas"]["apiListOpenAIAPIKeysOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34198,22 +47436,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_update_agent: { + genai_create_openai_api_key: { parameters: { query?: never; header?: never; - path: { - /** - * @description Unique agent id - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - uuid: string; - }; + path?: never; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiUpdateAgentInputPublic"]; + "application/json": components["schemas"]["apiCreateOpenAIAPIKeyInputPublic"]; }; }; responses: { @@ -34226,7 +47458,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUpdateAgentOutput"]; + "application/json": components["schemas"]["apiCreateOpenAIAPIKeyOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34236,16 +47468,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_delete_agent: { + genai_get_openai_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description Unique agent id + * @description API key ID * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; + api_key_uuid: string; }; cookie?: never; }; @@ -34260,7 +47492,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiDeleteAgentOutput"]; + "application/json": components["schemas"]["apiGetOpenAIAPIKeyOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34270,20 +47502,24 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_get_agent_children: { + genai_update_openai_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description Agent id + * @description API key ID * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; + api_key_uuid: string; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiUpdateOpenAIAPIKeyInputPublic"]; + }; + }; responses: { /** @description A successful response. */ 200: { @@ -34294,7 +47530,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiGetChildrenOutput"]; + "application/json": components["schemas"]["apiUpdateOpenAIAPIKeyOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34304,24 +47540,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_update_agent_deployment_visibility: { + genai_delete_openai_api_key: { parameters: { query?: never; header?: never; path: { /** - * @description Unique id + * @description API key ID * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; + api_key_uuid: string; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["apiUpdateAgentDeploymentVisibilityInputPublic"]; - }; - }; + requestBody?: never; responses: { /** @description A successful response. */ 200: { @@ -34332,7 +47564,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUpdateAgentDeploymentVisbilityOutput"]; + "application/json": components["schemas"]["apiDeleteOpenAIAPIKeyOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34342,7 +47574,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_list_indexing_jobs: { + genai_list_agents_by_openai_key: { parameters: { query?: { /** @@ -34357,7 +47589,13 @@ export interface operations { per_page?: number; }; header?: never; - path?: never; + path: { + /** + * @description Unique ID of OpenAI key + * @example "123e4567-e89b-12d3-a456-426614174000" + */ + uuid: string; + }; cookie?: never; }; requestBody?: never; @@ -34371,7 +47609,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListKnowledgeBaseIndexingJobsOutput"]; + "application/json": components["schemas"]["apiListAgentsByOpenAIKeyOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34381,18 +47619,25 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_create_indexing_job: { + genai_list_datacenter_regions: { parameters: { - query?: never; + query?: { + /** + * @description Include datacenters that serve inference. + * @example true + */ + serves_inference?: boolean; + /** + * @description Include datacenters that are capable of running batch jobs. + * @example true + */ + serves_batch?: boolean; + }; header?: never; path?: never; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["apiStartKnowledgeBaseIndexingJobInputPublic"]; - }; - }; + requestBody?: never; responses: { /** @description A successful response. */ 200: { @@ -34403,7 +47648,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiStartKnowledgeBaseIndexingJobOutput"]; + "application/json": components["schemas"]["apiListRegionsOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34413,20 +47658,18 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_list_indexing_job_data_sources: { + genai_create_scheduled_indexing: { parameters: { query?: never; header?: never; - path: { - /** - * @description Uuid of the indexing job - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - indexing_job_uuid: string; - }; + path?: never; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": components["schemas"]["apiCreateScheduledIndexingInputPublic"]; + }; + }; responses: { /** @description A successful response. */ 200: { @@ -34437,7 +47680,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListIndexingJobDataSourcesOutput"]; + "application/json": components["schemas"]["apiCreateScheduledIndexingOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34447,16 +47690,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_get_indexing_job: { + genai_get_scheduled_indexing: { parameters: { query?: never; header?: never; path: { /** - * @description Indexing job id + * @description UUID of the scheduled indexing entry * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; + knowledge_base_uuid: string; }; cookie?: never; }; @@ -34471,7 +47714,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiGetKnowledgeBaseIndexingJobOutput"]; + "application/json": components["schemas"]["apiGetScheduledIndexingOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34481,24 +47724,20 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_cancel_indexing_job: { + genai_delete_scheduled_indexing: { parameters: { query?: never; header?: never; path: { /** - * @description A unique identifier for an indexing job. + * @description UUID of the scheduled indexing * @example "123e4567-e89b-12d3-a456-426614174000" */ uuid: string; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": components["schemas"]["apiCancelKnowledgeBaseIndexingJobInputPublic"]; - }; - }; + requestBody?: never; responses: { /** @description A successful response. */ 200: { @@ -34509,7 +47748,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiCancelKnowledgeBaseIndexingJobOutput"]; + "application/json": components["schemas"]["apiDeleteScheduledIndexingOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34519,20 +47758,9 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_list_knowledge_bases: { + genai_list_workspaces: { parameters: { - query?: { - /** - * @description Page number. - * @example 1 - */ - page?: number; - /** - * @description Items per page. - * @example 1 - */ - per_page?: number; - }; + query?: never; header?: never; path?: never; cookie?: never; @@ -34548,7 +47776,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListKnowledgeBasesOutput"]; + "application/json": components["schemas"]["apiListWorkspacesOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34558,7 +47786,7 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_create_knowledge_base: { + genai_create_workspace: { parameters: { query?: never; header?: never; @@ -34567,7 +47795,7 @@ export interface operations { }; requestBody?: { content: { - "application/json": components["schemas"]["apiCreateKnowledgeBaseInputPublic"]; + "application/json": components["schemas"]["apiCreateWorkspaceInputPublic"]; }; }; responses: { @@ -34580,7 +47808,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiCreateKnowledgeBaseOutput"]; + "application/json": components["schemas"]["apiCreateWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34590,27 +47818,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_list_knowledge_base_data_sources: { + genai_get_workspace: { parameters: { - query?: { - /** - * @description Page number. - * @example 1 - */ - page?: number; - /** - * @description Items per page. - * @example 1 - */ - per_page?: number; - }; + query?: never; header?: never; path: { /** - * @description Knowledge base id + * @description Workspace UUID. * @example "123e4567-e89b-12d3-a456-426614174000" */ - knowledge_base_uuid: string; + workspace_uuid: string; }; cookie?: never; }; @@ -34625,7 +47842,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListKnowledgeBaseDataSourcesOutput"]; + "application/json": components["schemas"]["apiGetWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34635,22 +47852,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_create_knowledge_base_data_source: { + genai_update_workspace: { parameters: { query?: never; header?: never; path: { /** - * @description Knowledge base id + * @description Workspace UUID. * @example "123e4567-e89b-12d3-a456-426614174000" */ - knowledge_base_uuid: string; + workspace_uuid: string; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiCreateKnowledgeBaseDataSourceInputPublic"]; + "application/json": components["schemas"]["apiUpdateWorkspaceInputPublic"]; }; }; responses: { @@ -34663,7 +47880,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiCreateKnowledgeBaseDataSourceOutput"]; + "application/json": components["schemas"]["apiUpdateWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34673,21 +47890,16 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_delete_knowledge_base_data_source: { + genai_delete_workspace: { parameters: { query?: never; header?: never; path: { /** - * @description Knowledge base id + * @description Workspace UUID. * @example "123e4567-e89b-12d3-a456-426614174000" */ - knowledge_base_uuid: string; - /** - * @description Data source id - * @example "123e4567-e89b-12d3-a456-426614174000" - */ - data_source_uuid: string; + workspace_uuid: string; }; cookie?: never; }; @@ -34702,7 +47914,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiDeleteKnowledgeBaseDataSourceOutput"]; + "application/json": components["schemas"]["apiDeleteWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34712,16 +47924,32 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_get_knowledge_base: { + genai_list_agents_by_workspace: { parameters: { - query?: never; + query?: { + /** + * @description Only list agents that are deployed. + * @example true + */ + only_deployed?: boolean; + /** + * @description Page number. + * @example 1 + */ + page?: number; + /** + * @description Items per page. + * @example 1 + */ + per_page?: number; + }; header?: never; path: { /** - * @description Knowledge base id + * @description Workspace UUID. * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; + workspace_uuid: string; }; cookie?: never; }; @@ -34736,7 +47964,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiGetKnowledgeBaseOutput"]; + "application/json": components["schemas"]["apiListAgentsByWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34746,22 +47974,22 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_update_knowledge_base: { + genai_update_agents_workspace: { parameters: { query?: never; header?: never; path: { /** - * @description Knowledge base id + * @description Workspace uuid to move agents to * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; + workspace_uuid: string; }; cookie?: never; }; requestBody?: { content: { - "application/json": components["schemas"]["apiUpdateKnowledgeBaseInputPublic"]; + "application/json": components["schemas"]["apiMoveAgentsToWorkspaceInputPublic"]; }; }; responses: { @@ -34774,7 +48002,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiUpdateKnowledgeBaseOutput"]; + "application/json": components["schemas"]["apiMoveAgentsToWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; @@ -34784,113 +48012,17 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; - genai_delete_knowledge_base: { + genai_list_evaluation_test_cases_by_workspace: { parameters: { query?: never; header?: never; path: { /** - * @description Knowledge base id + * @description Workspace UUID. * @example "123e4567-e89b-12d3-a456-426614174000" */ - uuid: string; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description A successful response. */ - 200: { - 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": components["schemas"]["apiDeleteKnowledgeBaseOutput"]; - }; - }; - 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"]; - }; - }; - genai_list_models: { - parameters: { - query?: { - /** - * @description Include only models defined for the listed usecases. - * - * - MODEL_USECASE_UNKNOWN: The use case of the model is unknown - * - MODEL_USECASE_AGENT: The model maybe used in an agent - * - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - * - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - * - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails - * @example [ - * "MODEL_USECASE_UNKNOWN" - * ] - */ - usecases?: ("MODEL_USECASE_UNKNOWN" | "MODEL_USECASE_AGENT" | "MODEL_USECASE_FINETUNED" | "MODEL_USECASE_KNOWLEDGEBASE" | "MODEL_USECASE_GUARDRAIL")[]; - /** - * @description Only include models that are publicly available. - * @example true - */ - public_only?: boolean; - /** - * @description Page number. - * @example 1 - */ - page?: number; - /** - * @description Items per page. - * @example 1 - */ - per_page?: number; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description A successful response. */ - 200: { - 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": components["schemas"]["apiListModelsOutputPublic"]; - }; - }; - 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"]; - }; - }; - genai_list_datacenter_regions: { - parameters: { - query?: { - /** - * @description Include datacenters that serve inference. - * @example true - */ - serves_inference?: boolean; - /** - * @description Include datacenters that are capable of running batch jobs. - * @example true - */ - serves_batch?: boolean; + workspace_uuid: string; }; - header?: never; - path?: never; cookie?: never; }; requestBody?: never; @@ -34904,7 +48036,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["apiListRegionsOutput"]; + "application/json": components["schemas"]["apiListEvaluationTestCasesByWorkspaceOutput"]; }; }; 401: components["responses"]["unauthorized"]; 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 f5dfdfa43..94c931203 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 @@ -1,21 +1,21 @@ -openapi: '3.0.0' +openapi: "3.0.0" info: title: DigitalOcean API - version: '2.0' + version: "2.0" description: - $ref: 'description.yml#/introduction' + $ref: "description.yml#/introduction" license: name: Apache 2.0 - url: 'https://www.apache.org/licenses/LICENSE-2.0.html' + url: "https://www.apache.org/licenses/LICENSE-2.0.html" contact: name: DigitalOcean API Team email: api-engineering@digitalocean.com - termsOfService: 'https://www.digitalocean.com/legal/terms-of-service-agreement/' + termsOfService: "https://www.digitalocean.com/legal/terms-of-service-agreement/" servers: - - url: 'https://api.digitalocean.com' + - url: "https://api.digitalocean.com" description: production tags: @@ -45,6 +45,16 @@ tags: - `Accept: application/vnd.digitalocean.reserveip+json` + - name: Add-Ons + description: |- + Add-ons are third-party applications that can be added to your DigitalOcean account. + They are available through the [DigitalOcean Marketplace](https://marketplace.digitalocean.com/). + Add-ons can be used to enhance the functionality of your existing resources or to provide + additional services. + + The Add-Ons API allows you to manage these resources, including creating, listing, and retrieving + details about specific add-on resources. + - name: Apps description: |- App Platform is a Platform-as-a-Service (PaaS) offering from DigitalOcean that allows @@ -60,8 +70,8 @@ tags: - name: Billing description: |- - The billing endpoints allow you to retrieve your account balance, invoices - and billing history. + The billing endpoints allow you to retrieve your account balance, invoices, + billing history, and insights. **Balance:** By sending requests to the `/v2/customers/my/balance` endpoint, you can retrieve the balance information for the requested customer account. @@ -78,6 +88,14 @@ tags: issued, or credits granted. To interact with invoices, you will generally send requests to the invoices endpoint at `/v2/customers/my/billing_history`. + + **Billing Insights:** Day-over-day changes in billing resource usage based on nightly invoice items, + including total amount, region, SKU, and description for a specified date range. + It is important to note that the daily resource usage may not reflect month-end billing totals when totaled for + a given month as nightly invoice items do not necessarily encompass all invoicing factors for the entire month. + `v2/billing/{account_urn}/insights/{start_date}/{end_date}` where account_urn is the URN of the customer + account, can be a team (do:team:uuid) or an organization (do:teamgroup:uuid). The date range specified by + start_date and end_date must be in YYYY-MM-DD format. - name: Block Storage description: |- @@ -112,7 +130,7 @@ tags: 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. @@ -140,13 +158,22 @@ tags: You can only create one registry per DigitalOcean account, but you can use that registry to create as many repositories as you wish. + - name: Container Registries + description: |- + DigitalOcean now supports up to nine additional registries (for a total maximum of 10) per team + if your container registry uses the Professional subscription plan. The storage is shared among + the registries. This set of new APIs is backward compatible with `/v2/registry`. However, if you + create more than one registry under a Professional plan, some of the `/v2/registry` APIs would not work. + Hence, it is recommended to use `/v2/registries` for multiple registries. + - name: Databases description: |- 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://docs.digitalocean.com/products/databases/postgresql/), - [Redis](https://docs.digitalocean.com/products/databases/redis/), - [MySQL](https://docs.digitalocean.com/products/databases/mysql/), + [Caching](https://docs.digitalocean.com/products/databases/redis/), + [Valkey](https://docs.digitalocean.com/products/databases/valkey/), + [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/). @@ -162,7 +189,7 @@ tags: which is used in some of the following requests. Each slug denotes the node's identifier, CPU count, and amount of RAM, in that order. - For a list of currently available database slugs and options, use the `/v2/databases/options` endpoint or use the + For a list of currently available database slugs and options, use the `/v2/databases/options` endpoint or use the `doctl databases options` [command](https://docs.digitalocean.com/reference/doctl/reference/databases/options). - name: Domain Records @@ -291,14 +318,10 @@ tags: The Serverless Functions API currently only supports creating and managing namespaces. - - - name: GenAI Platform (Public Preview) + - name: GradientAI Platform description: |- - **The GenAI Platform API is in [public preview](https://docs.digitalocean.com/platform/product-lifecycle/#public-preview) for select customers.** - The API lets you build GPU-powered AI agents with pre-built or custom foundation models, function and agent routes, and RAG pipelines with knowledge bases. - - name: Image Actions description: |- Image actions are commands that can be given to a DigitalOcean image. In @@ -358,6 +381,22 @@ tags: policies based on these metrics. The Monitoring API can help you gain insight into how your apps are performing and consuming resources. + - name: NFS + description: |- + NFS lets you create fully managed, POSIX-compliant network file storage that delivers secure, + high-performance shared storage right inside your VPC. This enables seamless data sharing across Droplets in a VPC. + + - name: NFS Actions + description: |- + NFS actions are tasks that can be executed on an NFS share. These can be + things like resizing, snapshotting, etc. + + - name: Partner Network Connect + description: |- + Partner Network Connect lets you establish high-bandwidth, low-latency + network connections directly between DigitalOcean VPC networks and other + public cloud providers or on-premises datacenters. + - name: Project Resources description: |- Project Resources are resources that can be grouped into your projects. @@ -450,6 +489,31 @@ tags: Reserved IPs are bound to a specific region. + - name: "Reserved IPv6" + description: |- + DigitalOcean Reserved IPv6s 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. + + Reserved IPv6s are bound to a specific region. + - name: "Reserved IPv6 Actions" + description: |- + Reserved IPv6 actions requests are made on the actions endpoint of a specific + reserved IPv6. + + An action object is returned. These objects hold the current status of the + requested action. + + - name: "BYOIP Prefixes" + description: |- + Bring your own IP (BYOIP) lets you provision your own IPv4 network prefixes + to your account, then assign those IPs to your DigitalOcean resources. + BYOIP supports the following features: + * IPv4 addresses + * Network sizes of anywhere from `/24` (256 addresses) to `/18` (16,384 addresses) + * Same API and management interface as our existing reserved IPs feature + * Assignable to Droplets only + - name: Sizes description: |- The sizes objects represent different packages of hardware resources that @@ -473,6 +537,12 @@ tags: To interact with snapshots, you will generally send requests to the snapshots endpoint at `/v2/snapshots`. + - name: Spaces Keys + description: |- + Spaces keys authenticate requests to DigitalOcean Spaces Buckets. + You can create, list, update, or delete Spaces keys by sending requests to + to the `/v2/spaces/keys` endpoint. + - name: SSH Keys description: Manage SSH keys available on your account. @@ -485,18 +555,27 @@ tags: Tags have two attributes: a user defined `name` attribute and an embedded `resources` attribute with information about resources that have been tagged. - - name: Uptime description: >- - [DigitalOcean Uptime Checks](https://docs.digitalocean.com/products/uptime/) provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring. + [DigitalOcean Uptime Checks](https://docs.digitalocean.com/products/uptime/) provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring. + + To interact with Uptime, you will generally send requests to the Uptime endpoint at `/v2/uptime/`. - To interact with Uptime, you will generally send requests to the Uptime endpoint at `/v2/uptime/`. + - name: "VPC NAT Gateways" + description: |- + [VPC NAT Gateways](https://docs.digitalocean.com/products/networking/vpc/how-to/create-nat-gateway/) + allow resources in a private VPC to access the public internet without + exposing them to incoming traffic. + + By sending requests to the `/v2/vpc_nat_gateways` endpoint, you can create, + configure, list, and delete VPC NAT Gateways as well as retrieve information + about the resources assigned to them. - 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 + [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 @@ -512,1309 +591,1651 @@ tags: paths: /v2/1-clicks: get: - $ref: 'resources/1-clicks/oneClicks_list.yml' + $ref: "resources/1-clicks/oneClicks_list.yml" /v2/1-clicks/kubernetes: post: - $ref: 'resources/1-clicks/oneClicks_install_kubernetes.yml' + $ref: "resources/1-clicks/oneClicks_install_kubernetes.yml" /v2/account: get: - $ref: 'resources/account/account_get.yml' + $ref: "resources/account/account_get.yml" /v2/account/keys: get: - $ref: 'resources/ssh_keys/sshKeys_list.yml' + $ref: "resources/ssh_keys/sshKeys_list.yml" post: - $ref: 'resources/ssh_keys/sshKeys_create.yml' + $ref: "resources/ssh_keys/sshKeys_create.yml" /v2/account/keys/{ssh_key_identifier}: get: - $ref: 'resources/ssh_keys/sshKeys_get.yml' + $ref: "resources/ssh_keys/sshKeys_get.yml" put: - $ref: 'resources/ssh_keys/sshKeys_update.yml' + $ref: "resources/ssh_keys/sshKeys_update.yml" delete: - $ref: 'resources/ssh_keys/sshKeys_delete.yml' + $ref: "resources/ssh_keys/sshKeys_delete.yml" /v2/actions: get: - $ref: 'resources/actions/actions_list.yml' + $ref: "resources/actions/actions_list.yml" /v2/actions/{action_id}: get: - $ref: 'resources/actions/actions_get.yml' + $ref: "resources/actions/actions_get.yml" + + /v2/add-ons/apps: + get: + $ref: "resources/addons/addons_get_app.yml" + + /v2/add-ons/apps/{app_slug}/metadata: + get: + $ref: "resources/addons/addons_get_app_metadata.yml" + + /v2/add-ons/saas: + get: + $ref: "resources/addons/addons_list.yml" + post: + $ref: "resources/addons/addons_create.yml" + + /v2/add-ons/saas/{resource_uuid}: + get: + $ref: "resources/addons/addons_get.yml" + delete: + $ref: "resources/addons/addons_delete.yml" + patch: + $ref: "resources/addons/addons_update.yml" + + /v2/add-ons/saas/{resource_uuid}/plan: + patch: + $ref: "resources/addons/addons_update_plan.yml" /v2/apps: get: - $ref: 'resources/apps/apps_list.yml' + $ref: "resources/apps/apps_list.yml" post: - $ref: 'resources/apps/apps_create.yml' + $ref: "resources/apps/apps_create.yml" /v2/apps/{id}: delete: - $ref: 'resources/apps/apps_delete.yml' + $ref: "resources/apps/apps_delete.yml" get: - $ref: 'resources/apps/apps_get.yml' + $ref: "resources/apps/apps_get.yml" put: - $ref: 'resources/apps/apps_update.yml' + $ref: "resources/apps/apps_update.yml" /v2/apps/{app_id}/restart: post: - $ref: 'resources/apps/apps_restart.yml' + $ref: "resources/apps/apps_restart.yml" /v2/apps/{app_id}/components/{component_name}/logs: get: - $ref: 'resources/apps/apps_get_logs_active_deployment.yml' + $ref: "resources/apps/apps_get_logs_active_deployment.yml" /v2/apps/{app_id}/components/{component_name}/exec: get: - $ref: 'resources/apps/apps_get_exec_active_deployment.yml' + $ref: "resources/apps/apps_get_exec_active_deployment.yml" + + /v2/apps/{app_id}/instances: + get: + $ref: "resources/apps/apps_get_instances.yml" /v2/apps/{app_id}/deployments: get: - $ref: 'resources/apps/apps_list_deployments.yml' + $ref: "resources/apps/apps_list_deployments.yml" post: - $ref: 'resources/apps/apps_create_deployment.yml' + $ref: "resources/apps/apps_create_deployment.yml" /v2/apps/{app_id}/deployments/{deployment_id}: get: - $ref: 'resources/apps/apps_get_deployment.yml' + $ref: "resources/apps/apps_get_deployment.yml" /v2/apps/{app_id}/deployments/{deployment_id}/cancel: post: - $ref: 'resources/apps/apps_cancel_deployment.yml' + $ref: "resources/apps/apps_cancel_deployment.yml" /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs: get: - $ref: 'resources/apps/apps_get_logs.yml' + $ref: "resources/apps/apps_get_logs.yml" /v2/apps/{app_id}/deployments/{deployment_id}/logs: get: - $ref: 'resources/apps/apps_get_logs_aggregate.yml' + $ref: "resources/apps/apps_get_logs_aggregate.yml" /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec: get: - $ref: 'resources/apps/apps_get_exec.yml' + $ref: "resources/apps/apps_get_exec.yml" /v2/apps/{app_id}/logs: get: - $ref: 'resources/apps/apps_get_logs_active_deployment_aggregate.yml' + $ref: "resources/apps/apps_get_logs_active_deployment_aggregate.yml" + + /v2/apps/{app_id}/job-invocations: + get: + $ref: "resources/apps/apps_list_job_invocations.yml" + + /v2/apps/{app_id}/job-invocations/{job_invocation_id}: + get: + $ref: "resources/apps/apps_get_job_invocation.yml" + + /v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancel: + post: + $ref: "resources/apps/apps_cancel_job_invocation.yml" + + /v2/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs: + get: + $ref: "resources/apps/apps_get_job_invocation_logs.yml" /v2/apps/tiers/instance_sizes: get: - $ref: 'resources/apps/apps_list_instanceSizes.yml' + $ref: "resources/apps/apps_list_instanceSizes.yml" /v2/apps/tiers/instance_sizes/{slug}: get: - $ref: 'resources/apps/apps_get_instanceSize.yml' + $ref: "resources/apps/apps_get_instanceSize.yml" /v2/apps/regions: get: - $ref: 'resources/apps/apps_list_regions.yml' + $ref: "resources/apps/apps_list_regions.yml" /v2/apps/propose: post: - $ref: 'resources/apps/apps_validate_appSpec.yml' + $ref: "resources/apps/apps_validate_appSpec.yml" /v2/apps/{app_id}/alerts: get: - $ref: 'resources/apps/apps_list_alerts.yml' + $ref: "resources/apps/apps_list_alerts.yml" /v2/apps/{app_id}/alerts/{alert_id}/destinations: post: - $ref: 'resources/apps/apps_assign_alertDestinations.yml' + $ref: "resources/apps/apps_assign_alertDestinations.yml" /v2/apps/{app_id}/rollback: post: - $ref: 'resources/apps/apps_create_rollback.yml' + $ref: "resources/apps/apps_create_rollback.yml" /v2/apps/{app_id}/rollback/validate: post: - $ref: 'resources/apps/apps_validate_rollback.yml' + $ref: "resources/apps/apps_validate_rollback.yml" /v2/apps/{app_id}/rollback/commit: post: - $ref: 'resources/apps/apps_commit_rollback.yml' + $ref: "resources/apps/apps_commit_rollback.yml" /v2/apps/{app_id}/rollback/revert: post: - $ref: 'resources/apps/apps_revert_rollback.yml' + $ref: "resources/apps/apps_revert_rollback.yml" /v2/apps/{app_id}/metrics/bandwidth_daily: get: - $ref: 'resources/apps/apps_get_metrics_bandwidth_usage.yml' + $ref: "resources/apps/apps_get_metrics_bandwidth_usage.yml" /v2/apps/metrics/bandwidth_daily: post: - $ref: 'resources/apps/apps_list_metrics_bandwidth_usage.yml' + $ref: "resources/apps/apps_list_metrics_bandwidth_usage.yml" + + /v2/apps/{app_id}/health: + get: + $ref: "resources/apps/apps_get_health.yml" /v2/cdn/endpoints: get: - $ref: 'resources/cdn/cdn_list_endpoints.yml' + $ref: "resources/cdn/cdn_list_endpoints.yml" post: - $ref: 'resources/cdn/cdn_create_endpoint.yml' + $ref: "resources/cdn/cdn_create_endpoint.yml" /v2/cdn/endpoints/{cdn_id}: get: - $ref: 'resources/cdn/cdn_get_endpoint.yml' + $ref: "resources/cdn/cdn_get_endpoint.yml" put: - $ref: 'resources/cdn/cdn_update_endpoint.yml' + $ref: "resources/cdn/cdn_update_endpoint.yml" delete: - $ref: 'resources/cdn/cdn_delete_endpoint.yml' + $ref: "resources/cdn/cdn_delete_endpoint.yml" /v2/cdn/endpoints/{cdn_id}/cache: delete: - $ref: 'resources/cdn/cdn_purge_cache.yml' + $ref: "resources/cdn/cdn_purge_cache.yml" /v2/certificates: get: - $ref: 'resources/certificates/certificates_list.yml' + $ref: "resources/certificates/certificates_list.yml" post: - $ref: 'resources/certificates/certificates_create.yml' + $ref: "resources/certificates/certificates_create.yml" /v2/certificates/{certificate_id}: get: - $ref: 'resources/certificates/certificates_get.yml' + $ref: "resources/certificates/certificates_get.yml" delete: - $ref: 'resources/certificates/certificates_delete.yml' + $ref: "resources/certificates/certificates_delete.yml" /v2/customers/my/balance: get: - $ref: 'resources/billing/balance_get.yml' + $ref: "resources/billing/balance_get.yml" /v2/customers/my/billing_history: get: - $ref: 'resources/billing/billingHistory_list.yml' + $ref: "resources/billing/billingHistory_list.yml" /v2/customers/my/invoices: get: - $ref: 'resources/billing/invoices_list.yml' + $ref: "resources/billing/invoices_list.yml" /v2/customers/my/invoices/{invoice_uuid}: get: - $ref: 'resources/billing/invoices_get_byUUID.yml' + $ref: "resources/billing/invoices_get_byUUID.yml" /v2/customers/my/invoices/{invoice_uuid}/csv: get: - $ref: 'resources/billing/invoices_get_csvByUUID.yml' + $ref: "resources/billing/invoices_get_csvByUUID.yml" /v2/customers/my/invoices/{invoice_uuid}/pdf: get: - $ref: 'resources/billing/invoices_get_pdfByUUID.yml' + $ref: "resources/billing/invoices_get_pdfByUUID.yml" /v2/customers/my/invoices/{invoice_uuid}/summary: get: - $ref: 'resources/billing/invoices_get_summaryByUUID.yml' + $ref: "resources/billing/invoices_get_summaryByUUID.yml" + + /v2/billing/{account_urn}/insights/{start_date}/{end_date}: + get: + $ref: "resources/billing/billingInsights_list.yml" /v2/databases/options: get: - $ref: 'resources/databases/databases_list_options.yml' + $ref: "resources/databases/databases_list_options.yml" /v2/databases: get: - $ref: 'resources/databases/databases_list_clusters.yml' + $ref: "resources/databases/databases_list_clusters.yml" post: - $ref: 'resources/databases/databases_create_cluster.yml' + $ref: "resources/databases/databases_create_cluster.yml" /v2/databases/{database_cluster_uuid}: get: - $ref: 'resources/databases/databases_get_cluster.yml' + $ref: "resources/databases/databases_get_cluster.yml" delete: - $ref: 'resources/databases/databases_destroy_cluster.yml' + $ref: "resources/databases/databases_destroy_cluster.yml" /v2/databases/{database_cluster_uuid}/config: get: - $ref: 'resources/databases/databases_get_config.yml' + $ref: "resources/databases/databases_get_config.yml" patch: - $ref: 'resources/databases/databases_patch_config.yml' + $ref: "resources/databases/databases_patch_config.yml" /v2/databases/{database_cluster_uuid}/ca: get: - $ref: 'resources/databases/databases_get_ca.yml' + $ref: "resources/databases/databases_get_ca.yml" /v2/databases/{database_cluster_uuid}/online-migration: get: - $ref: 'resources/databases/databases_get_migrationStatus.yml' + $ref: "resources/databases/databases_get_migrationStatus.yml" put: - $ref: 'resources/databases/databases_update_onlineMigration.yml' + $ref: "resources/databases/databases_update_onlineMigration.yml" /v2/databases/{database_cluster_uuid}/online-migration/{migration_id}: delete: - $ref: 'resources/databases/databases_delete_onlineMigration.yml' + $ref: "resources/databases/databases_delete_onlineMigration.yml" /v2/databases/{database_cluster_uuid}/migrate: put: - $ref: 'resources/databases/databases_update_region.yml' + $ref: "resources/databases/databases_update_region.yml" /v2/databases/{database_cluster_uuid}/resize: put: - $ref: 'resources/databases/databases_update_clusterSize.yml' + $ref: "resources/databases/databases_update_clusterSize.yml" /v2/databases/{database_cluster_uuid}/firewall: get: - $ref: 'resources/databases/databases_list_firewall_rules.yml' + $ref: "resources/databases/databases_list_firewall_rules.yml" put: - $ref: 'resources/databases/databases_update_firewall_rules.yml' + $ref: "resources/databases/databases_update_firewall_rules.yml" /v2/databases/{database_cluster_uuid}/maintenance: put: - $ref: 'resources/databases/databases_update_maintenanceWindow.yml' + $ref: "resources/databases/databases_update_maintenanceWindow.yml" /v2/databases/{database_cluster_uuid}/install_update: put: - $ref: 'resources/databases/databases_update_installUpdate.yml' + $ref: "resources/databases/databases_update_installUpdate.yml" /v2/databases/{database_cluster_uuid}/backups: get: - $ref: 'resources/databases/databases_list_backups.yml' + $ref: "resources/databases/databases_list_backups.yml" /v2/databases/{database_cluster_uuid}/replicas: get: - $ref: 'resources/databases/databases_list_replicas.yml' + $ref: "resources/databases/databases_list_replicas.yml" post: - $ref: 'resources/databases/databases_create_replica.yml' - + $ref: "resources/databases/databases_create_replica.yml" + /v2/databases/{database_cluster_uuid}/events: get: - $ref: 'resources/databases/databases_events_logs.yml' + $ref: "resources/databases/databases_events_logs.yml" /v2/databases/{database_cluster_uuid}/replicas/{replica_name}: get: - $ref: 'resources/databases/databases_get_replica.yml' + $ref: "resources/databases/databases_get_replica.yml" delete: - $ref: 'resources/databases/databases_destroy_replica.yml' + $ref: "resources/databases/databases_destroy_replica.yml" /v2/databases/{database_cluster_uuid}/replicas/{replica_name}/promote: put: - $ref: 'resources/databases/databases_promote_replica.yml' + $ref: "resources/databases/databases_promote_replica.yml" /v2/databases/{database_cluster_uuid}/users: get: - $ref: 'resources/databases/databases_list_users.yml' + $ref: "resources/databases/databases_list_users.yml" post: - $ref: 'resources/databases/databases_add_user.yml' + $ref: "resources/databases/databases_add_user.yml" /v2/databases/{database_cluster_uuid}/users/{username}: get: - $ref: 'resources/databases/databases_get_user.yml' + $ref: "resources/databases/databases_get_user.yml" delete: - $ref: 'resources/databases/databases_delete_user.yml' + $ref: "resources/databases/databases_delete_user.yml" put: - $ref: 'resources/databases/databases_update_user.yml' + $ref: "resources/databases/databases_update_user.yml" /v2/databases/{database_cluster_uuid}/users/{username}/reset_auth: post: - $ref: 'resources/databases/databases_reset_auth.yml' + $ref: "resources/databases/databases_reset_auth.yml" /v2/databases/{database_cluster_uuid}/dbs: get: - $ref: 'resources/databases/databases_list.yml' + $ref: "resources/databases/databases_list.yml" post: - $ref: 'resources/databases/databases_add.yml' + $ref: "resources/databases/databases_add.yml" /v2/databases/{database_cluster_uuid}/dbs/{database_name}: get: - $ref: 'resources/databases/databases_get.yml' + $ref: "resources/databases/databases_get.yml" delete: - $ref: 'resources/databases/databases_delete.yml' + $ref: "resources/databases/databases_delete.yml" /v2/databases/{database_cluster_uuid}/pools: get: - $ref: 'resources/databases/databases_list_connectionPools.yml' + $ref: "resources/databases/databases_list_connectionPools.yml" post: - $ref: 'resources/databases/databases_add_connectionPool.yml' + $ref: "resources/databases/databases_add_connectionPool.yml" /v2/databases/{database_cluster_uuid}/pools/{pool_name}: get: - $ref: 'resources/databases/databases_get_connectionPool.yml' + $ref: "resources/databases/databases_get_connectionPool.yml" put: - $ref: 'resources/databases/databases_update_connectionPool.yml' + $ref: "resources/databases/databases_update_connectionPool.yml" delete: - $ref: 'resources/databases/databases_delete_connectionPool.yml' + $ref: "resources/databases/databases_delete_connectionPool.yml" /v2/databases/{database_cluster_uuid}/eviction_policy: get: - $ref: 'resources/databases/databases_get_evictionPolicy.yml' + $ref: "resources/databases/databases_get_evictionPolicy.yml" put: - $ref: 'resources/databases/databases_update_evictionPolicy.yml' + $ref: "resources/databases/databases_update_evictionPolicy.yml" /v2/databases/{database_cluster_uuid}/sql_mode: get: - $ref: 'resources/databases/databases_get_sql_mode.yml' + $ref: "resources/databases/databases_get_sql_mode.yml" put: - $ref: 'resources/databases/databases_update_sql_mode.yml' + $ref: "resources/databases/databases_update_sql_mode.yml" /v2/databases/{database_cluster_uuid}/upgrade: put: - $ref: 'resources/databases/databases_upgrade_major_version.yml' + $ref: "resources/databases/databases_upgrade_major_version.yml" + + /v2/databases/{database_cluster_uuid}/autoscale: + get: + $ref: "resources/databases/databases_get_autoscale.yml" + put: + $ref: "resources/databases/databases_update_autoscale.yml" /v2/databases/{database_cluster_uuid}/topics: get: - $ref: 'resources/databases/databases_list_kafka_topics.yml' + $ref: "resources/databases/databases_list_kafka_topics.yml" post: - $ref: 'resources/databases/databases_create_kafka_topic.yml' + $ref: "resources/databases/databases_create_kafka_topic.yml" /v2/databases/{database_cluster_uuid}/topics/{topic_name}: get: - $ref: 'resources/databases/databases_get_kafka_topic.yml' + $ref: "resources/databases/databases_get_kafka_topic.yml" put: - $ref: 'resources/databases/databases_update_kafka_topic.yml' + $ref: "resources/databases/databases_update_kafka_topic.yml" delete: - $ref: 'resources/databases/databases_delete_kafka_topic.yml' - + $ref: "resources/databases/databases_delete_kafka_topic.yml" + /v2/databases/{database_cluster_uuid}/logsink: get: - $ref: 'resources/databases/databases_list_logsink.yml' + $ref: "resources/databases/databases_list_logsink.yml" post: - $ref: 'resources/databases/databases_create_logsink.yml' + $ref: "resources/databases/databases_create_logsink.yml" /v2/databases/{database_cluster_uuid}/logsink/{logsink_id}: get: - $ref: 'resources/databases/databases_get_logsink.yml' + $ref: "resources/databases/databases_get_logsink.yml" put: - $ref: 'resources/databases/databases_update_logsink.yml' + $ref: "resources/databases/databases_update_logsink.yml" + delete: + $ref: "resources/databases/databases_delete_logsink.yml" + + /v2/databases/{database_cluster_uuid}/schema-registry: + get: + $ref: "resources/databases/databases_list_kafka_schemas.yml" + post: + $ref: "resources/databases/databases_create_kafka_schema.yml" + + /v2/databases/{database_cluster_uuid}/schema-registry/{subject_name}: + get: + $ref: "resources/databases/databases_get_kafka_schema.yml" delete: - $ref: 'resources/databases/databases_delete_logsink.yml' + $ref: "resources/databases/databases_delete_kafka_schema.yml" + + /v2/databases/{database_cluster_uuid}/schema-registry/{subject_name}/versions/{version}: + get: + $ref: "resources/databases/databases_get_kafka_schema_version.yml" + + /v2/databases/{database_cluster_uuid}/schema-registry/config: + get: + $ref: "resources/databases/databases_get_kafka_schema_config.yml" + put: + $ref: "resources/databases/databases_update_kafka_schema_config.yml" + /v2/databases/{database_cluster_uuid}/schema-registry/config/{subject_name}: + get: + $ref: "resources/databases/databases_get_kafka_schema_subject_config.yml" + put: + $ref: "resources/databases/databases_update_kafka_schema_subject_config.yml" /v2/databases/metrics/credentials: get: - $ref: 'resources/databases/databases_get_cluster_metrics_credentials.yml' + $ref: "resources/databases/databases_get_cluster_metrics_credentials.yml" put: - $ref: 'resources/databases/databases_update_cluster_metrics_credentials.yml' - + $ref: "resources/databases/databases_update_cluster_metrics_credentials.yml" + /v2/databases/{database_cluster_uuid}/indexes: get: - $ref: 'resources/databases/databases_list_opensearch_indexes.yml' - + $ref: "resources/databases/databases_list_opensearch_indexes.yml" + /v2/databases/{database_cluster_uuid}/indexes/{index_name}: delete: - $ref: 'resources/databases/databases_delete_opensearch_index.yml' - + $ref: "resources/databases/databases_delete_opensearch_index.yml" + /v2/domains: get: - $ref: 'resources/domains/domains_list.yml' + $ref: "resources/domains/domains_list.yml" post: - $ref: 'resources/domains/domains_create.yml' + $ref: "resources/domains/domains_create.yml" /v2/domains/{domain_name}: get: - $ref: 'resources/domains/domains_get.yml' + $ref: "resources/domains/domains_get.yml" delete: - $ref: 'resources/domains/domains_delete.yml' + $ref: "resources/domains/domains_delete.yml" /v2/domains/{domain_name}/records: get: - $ref: 'resources/domains/domains_list_records.yml' + $ref: "resources/domains/domains_list_records.yml" post: - $ref: 'resources/domains/domains_create_record.yml' + $ref: "resources/domains/domains_create_record.yml" /v2/domains/{domain_name}/records/{domain_record_id}: get: - $ref: 'resources/domains/domains_get_record.yml' + $ref: "resources/domains/domains_get_record.yml" patch: - $ref: 'resources/domains/domains_patch_record.yml' + $ref: "resources/domains/domains_patch_record.yml" put: - $ref: 'resources/domains/domains_update_record.yml' + $ref: "resources/domains/domains_update_record.yml" delete: - $ref: 'resources/domains/domains_delete_record.yml' + $ref: "resources/domains/domains_delete_record.yml" /v2/droplets: get: - $ref: 'resources/droplets/droplets_list.yml' + $ref: "resources/droplets/droplets_list.yml" post: - $ref: 'resources/droplets/droplets_create.yml' + $ref: "resources/droplets/droplets_create.yml" delete: - $ref: 'resources/droplets/droplets_destroy_byTag.yml' + $ref: "resources/droplets/droplets_destroy_byTag.yml" /v2/droplets/{droplet_id}: get: - $ref: 'resources/droplets/droplets_get.yml' + $ref: "resources/droplets/droplets_get.yml" delete: - $ref: 'resources/droplets/droplets_destroy.yml' + $ref: "resources/droplets/droplets_destroy.yml" /v2/droplets/{droplet_id}/backups: get: - $ref: 'resources/droplets/droplets_list_backups.yml' + $ref: "resources/droplets/droplets_list_backups.yml" /v2/droplets/{droplet_id}/backups/policy: get: - $ref: 'resources/droplets/droplets_get_backup_policy.yml' + $ref: "resources/droplets/droplets_get_backup_policy.yml" /v2/droplets/backups/policies: get: - $ref: 'resources/droplets/droplets_list_backup_policies.yml' + $ref: "resources/droplets/droplets_list_backup_policies.yml" /v2/droplets/backups/supported_policies: get: - $ref: 'resources/droplets/droplets_list_supported_backup_policies.yml' + $ref: "resources/droplets/droplets_list_supported_backup_policies.yml" /v2/droplets/{droplet_id}/snapshots: get: - $ref: 'resources/droplets/droplets_list_snapshots.yml' + $ref: "resources/droplets/droplets_list_snapshots.yml" /v2/droplets/{droplet_id}/actions: get: - $ref: 'resources/droplets/dropletActions_list.yml' + $ref: "resources/droplets/dropletActions_list.yml" post: - $ref: 'resources/droplets/dropletActions_post.yml' + $ref: "resources/droplets/dropletActions_post.yml" /v2/droplets/actions: post: - $ref: 'resources/droplets/dropletActions_post_byTag.yml' + $ref: "resources/droplets/dropletActions_post_byTag.yml" /v2/droplets/{droplet_id}/actions/{action_id}: get: - $ref: 'resources/droplets/dropletActions_get.yml' + $ref: "resources/droplets/dropletActions_get.yml" /v2/droplets/{droplet_id}/kernels: get: - $ref: 'resources/droplets/droplets_list_kernels.yml' + $ref: "resources/droplets/droplets_list_kernels.yml" /v2/droplets/{droplet_id}/firewalls: get: - $ref: 'resources/droplets/droplets_list_firewalls.yml' + $ref: "resources/droplets/droplets_list_firewalls.yml" /v2/droplets/{droplet_id}/neighbors: get: - $ref: 'resources/droplets/droplets_list_neighbors.yml' + $ref: "resources/droplets/droplets_list_neighbors.yml" /v2/droplets/{droplet_id}/destroy_with_associated_resources: get: - $ref: 'resources/droplets/droplets_list_associatedResources.yml' + $ref: "resources/droplets/droplets_list_associatedResources.yml" /v2/droplets/{droplet_id}/destroy_with_associated_resources/selective: delete: - $ref: 'resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml' + $ref: "resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml" /v2/droplets/{droplet_id}/destroy_with_associated_resources/dangerous: delete: - $ref: 'resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml' + $ref: "resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml" /v2/droplets/{droplet_id}/destroy_with_associated_resources/status: get: - $ref: 'resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml' + $ref: "resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml" /v2/droplets/{droplet_id}/destroy_with_associated_resources/retry: post: - $ref: 'resources/droplets/droplets_destroy_retryWithAssociatedResources.yml' + $ref: "resources/droplets/droplets_destroy_retryWithAssociatedResources.yml" /v2/droplets/autoscale: get: - $ref: 'resources/autoscale_pools/autoscale_pool_list.yml' + $ref: "resources/autoscale_pools/autoscale_pool_list.yml" post: - $ref: 'resources/autoscale_pools/autoscale_pool_create.yml' + $ref: "resources/autoscale_pools/autoscale_pool_create.yml" /v2/droplets/autoscale/{autoscale_pool_id}: get: - $ref: 'resources/autoscale_pools/autoscale_pool_get.yml' + $ref: "resources/autoscale_pools/autoscale_pool_get.yml" put: - $ref: 'resources/autoscale_pools/autoscale_pool_update.yml' + $ref: "resources/autoscale_pools/autoscale_pool_update.yml" delete: - $ref: 'resources/autoscale_pools/autoscale_pool_delete.yml' + $ref: "resources/autoscale_pools/autoscale_pool_delete.yml" /v2/droplets/autoscale/{autoscale_pool_id}/dangerous: delete: - $ref: 'resources/autoscale_pools/autoscale_pool_delete_dangerous.yml' + $ref: "resources/autoscale_pools/autoscale_pool_delete_dangerous.yml" /v2/droplets/autoscale/{autoscale_pool_id}/members: get: - $ref: 'resources/autoscale_pools/autoscale_pool_list_members.yml' + $ref: "resources/autoscale_pools/autoscale_pool_list_members.yml" /v2/droplets/autoscale/{autoscale_pool_id}/history: get: - $ref: 'resources/autoscale_pools/autoscale_pool_list_history.yml' + $ref: "resources/autoscale_pools/autoscale_pool_list_history.yml" /v2/firewalls: get: - $ref: 'resources/firewalls/firewalls_list.yml' + $ref: "resources/firewalls/firewalls_list.yml" post: - $ref: 'resources/firewalls/firewalls_create.yml' + $ref: "resources/firewalls/firewalls_create.yml" /v2/firewalls/{firewall_id}: get: - $ref: 'resources/firewalls/firewalls_get.yml' + $ref: "resources/firewalls/firewalls_get.yml" put: - $ref: 'resources/firewalls/firewalls_update.yml' + $ref: "resources/firewalls/firewalls_update.yml" delete: - $ref: 'resources/firewalls/firewalls_delete.yml' + $ref: "resources/firewalls/firewalls_delete.yml" /v2/firewalls/{firewall_id}/droplets: post: - $ref: 'resources/firewalls/firewalls_assign_droplets.yml' + $ref: "resources/firewalls/firewalls_assign_droplets.yml" delete: - $ref: 'resources/firewalls/firewalls_delete_droplets.yml' + $ref: "resources/firewalls/firewalls_delete_droplets.yml" /v2/firewalls/{firewall_id}/tags: post: - $ref: 'resources/firewalls/firewalls_add_tags.yml' + $ref: "resources/firewalls/firewalls_add_tags.yml" delete: - $ref: 'resources/firewalls/firewalls_delete_tags.yml' + $ref: "resources/firewalls/firewalls_delete_tags.yml" /v2/firewalls/{firewall_id}/rules: post: - $ref: 'resources/firewalls/firewalls_add_rules.yml' + $ref: "resources/firewalls/firewalls_add_rules.yml" delete: - $ref: 'resources/firewalls/firewalls_delete_rules.yml' + $ref: "resources/firewalls/firewalls_delete_rules.yml" /v2/floating_ips: get: - $ref: 'resources/floating_ips/floatingIPs_list.yml' + $ref: "resources/floating_ips/floatingIPs_list.yml" post: - $ref: 'resources/floating_ips/floatingIPs_create.yml' + $ref: "resources/floating_ips/floatingIPs_create.yml" /v2/floating_ips/{floating_ip}: get: - $ref: 'resources/floating_ips/floatingIPs_get.yml' + $ref: "resources/floating_ips/floatingIPs_get.yml" delete: - $ref: 'resources/floating_ips/floatingIPs_delete.yml' + $ref: "resources/floating_ips/floatingIPs_delete.yml" /v2/floating_ips/{floating_ip}/actions: get: - $ref: 'resources/floating_ips/floatingIPsAction_list.yml' + $ref: "resources/floating_ips/floatingIPsAction_list.yml" post: - $ref: 'resources/floating_ips/floatingIPsAction_post.yml' + $ref: "resources/floating_ips/floatingIPsAction_post.yml" /v2/floating_ips/{floating_ip}/actions/{action_id}: get: - $ref: 'resources/floating_ips/floatingIPsAction_get.yml' + $ref: "resources/floating_ips/floatingIPsAction_get.yml" /v2/functions/namespaces: get: - $ref: 'resources/functions/functions_list_namespaces.yml' + $ref: "resources/functions/functions_list_namespaces.yml" post: - $ref: 'resources/functions/functions_create_namespace.yml' + $ref: "resources/functions/functions_create_namespace.yml" /v2/functions/namespaces/{namespace_id}: get: - $ref: 'resources/functions/functions_get_namespace.yml' + $ref: "resources/functions/functions_get_namespace.yml" delete: - $ref: 'resources/functions/functions_delete_namespace.yml' + $ref: "resources/functions/functions_delete_namespace.yml" /v2/functions/namespaces/{namespace_id}/triggers: get: - $ref: 'resources/functions/functions_list_triggers.yml' + $ref: "resources/functions/functions_list_triggers.yml" post: - $ref: 'resources/functions/functions_create_trigger.yml' + $ref: "resources/functions/functions_create_trigger.yml" /v2/functions/namespaces/{namespace_id}/triggers/{trigger_name}: get: - $ref: 'resources/functions/functions_get_trigger.yml' + $ref: "resources/functions/functions_get_trigger.yml" put: - $ref: 'resources/functions/functions_update_trigger.yml' + $ref: "resources/functions/functions_update_trigger.yml" delete: - $ref: 'resources/functions/functions_delete_trigger.yml' + $ref: "resources/functions/functions_delete_trigger.yml" /v2/images: get: - $ref: 'resources/images/images_list.yml' + $ref: "resources/images/images_list.yml" post: - $ref: 'resources/images/images_create_custom.yml' + $ref: "resources/images/images_create_custom.yml" /v2/images/{image_id}: get: - $ref: 'resources/images/images_get.yml' + $ref: "resources/images/images_get.yml" put: - $ref: 'resources/images/images_update.yml' + $ref: "resources/images/images_update.yml" delete: - $ref: 'resources/images/images_delete.yml' + $ref: "resources/images/images_delete.yml" /v2/images/{image_id}/actions: get: - $ref: 'resources/images/imageActions_list.yml' + $ref: "resources/images/imageActions_list.yml" post: - $ref: 'resources/images/imageActions_post.yml' + $ref: "resources/images/imageActions_post.yml" /v2/images/{image_id}/actions/{action_id}: get: - $ref: 'resources/images/imageActions_get.yml' + $ref: "resources/images/imageActions_get.yml" /v2/kubernetes/clusters: get: - $ref: 'resources/kubernetes/kubernetes_list_clusters.yml' + $ref: "resources/kubernetes/kubernetes_list_clusters.yml" post: - $ref: 'resources/kubernetes/kubernetes_create_cluster.yml' + $ref: "resources/kubernetes/kubernetes_create_cluster.yml" /v2/kubernetes/clusters/{cluster_id}: get: - $ref: 'resources/kubernetes/kubernetes_get_cluster.yml' + $ref: "resources/kubernetes/kubernetes_get_cluster.yml" put: - $ref: 'resources/kubernetes/kubernetes_update_cluster.yml' + $ref: "resources/kubernetes/kubernetes_update_cluster.yml" delete: - $ref: 'resources/kubernetes/kubernetes_delete_cluster.yml' + $ref: "resources/kubernetes/kubernetes_delete_cluster.yml" /v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources: get: - $ref: 'resources/kubernetes/kubernetes_list_associatedResources.yml' + $ref: "resources/kubernetes/kubernetes_list_associatedResources.yml" /v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources/selective: delete: - $ref: 'resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml' + $ref: "resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml" /v2/kubernetes/clusters/{cluster_id}/destroy_with_associated_resources/dangerous: delete: - $ref: 'resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml' + $ref: "resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml" /v2/kubernetes/clusters/{cluster_id}/kubeconfig: get: - $ref: 'resources/kubernetes/kubernetes_get_kubeconfig.yml' + $ref: "resources/kubernetes/kubernetes_get_kubeconfig.yml" /v2/kubernetes/clusters/{cluster_id}/credentials: get: - $ref: 'resources/kubernetes/kubernetes_get_credentials.yml' + $ref: "resources/kubernetes/kubernetes_get_credentials.yml" /v2/kubernetes/clusters/{cluster_id}/upgrades: get: - $ref: 'resources/kubernetes/kubernetes_get_availableUpgrades.yml' + $ref: "resources/kubernetes/kubernetes_get_availableUpgrades.yml" /v2/kubernetes/clusters/{cluster_id}/upgrade: post: - $ref: 'resources/kubernetes/kubernetes_upgrade_cluster.yml' + $ref: "resources/kubernetes/kubernetes_upgrade_cluster.yml" /v2/kubernetes/clusters/{cluster_id}/node_pools: get: - $ref: 'resources/kubernetes/kubernetes_list_nodePools.yml' + $ref: "resources/kubernetes/kubernetes_list_nodePools.yml" post: - $ref: 'resources/kubernetes/kubernetes_add_nodePool.yml' + $ref: "resources/kubernetes/kubernetes_add_nodePool.yml" /v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}: get: - $ref: 'resources/kubernetes/kubernetes_get_nodePool.yml' + $ref: "resources/kubernetes/kubernetes_get_nodePool.yml" put: - $ref: 'resources/kubernetes/kubernetes_update_nodePool.yml' + $ref: "resources/kubernetes/kubernetes_update_nodePool.yml" delete: - $ref: 'resources/kubernetes/kubernetes_delete_nodePool.yml' + $ref: "resources/kubernetes/kubernetes_delete_nodePool.yml" /v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/nodes/{node_id}: delete: - $ref: 'resources/kubernetes/kubernetes_delete_node.yml' + $ref: "resources/kubernetes/kubernetes_delete_node.yml" /v2/kubernetes/clusters/{cluster_id}/node_pools/{node_pool_id}/recycle: post: - $ref: 'resources/kubernetes/kubernetes_recycle_nodePool.yml' + $ref: "resources/kubernetes/kubernetes_recycle_nodePool.yml" /v2/kubernetes/clusters/{cluster_id}/user: get: - $ref: 'resources/kubernetes/kubernetes_get_clusterUser.yml' + $ref: "resources/kubernetes/kubernetes_get_clusterUser.yml" /v2/kubernetes/options: get: - $ref: 'resources/kubernetes/kubernetes_list_options.yml' + $ref: "resources/kubernetes/kubernetes_list_options.yml" /v2/kubernetes/clusters/{cluster_id}/clusterlint: post: - $ref: 'resources/kubernetes/kubernetes_run_clusterLint.yml' + $ref: "resources/kubernetes/kubernetes_run_clusterLint.yml" get: - $ref: 'resources/kubernetes/kubernetes_get_clusterLintResults.yml' + $ref: "resources/kubernetes/kubernetes_get_clusterLintResults.yml" /v2/kubernetes/registry: post: - $ref: 'resources/kubernetes/kubernetes_add_registry.yml' + $ref: "resources/kubernetes/kubernetes_add_registry.yml" delete: - $ref: 'resources/kubernetes/kubernetes_remove_registry.yml' + $ref: "resources/kubernetes/kubernetes_remove_registry.yml" + + /v2/kubernetes/registries: + post: + $ref: "resources/kubernetes/kubernetes_add_registries.yml" + + delete: + $ref: "resources/kubernetes/kubernetes_remove_registries.yml" + + /v2/kubernetes/clusters/{cluster_id}/status_messages: + get: + $ref: "resources/kubernetes/kubernetes_get_status_messages.yml" /v2/load_balancers: post: - $ref: 'resources/load_balancers/loadBalancers_create.yml' + $ref: "resources/load_balancers/loadBalancers_create.yml" get: - $ref: 'resources/load_balancers/loadBalancers_list.yml' + $ref: "resources/load_balancers/loadBalancers_list.yml" /v2/load_balancers/{lb_id}: get: - $ref: 'resources/load_balancers/loadBalancers_get.yml' + $ref: "resources/load_balancers/loadBalancers_get.yml" put: - $ref: 'resources/load_balancers/loadBalancers_update.yml' + $ref: "resources/load_balancers/loadBalancers_update.yml" delete: - $ref: 'resources/load_balancers/loadBalancers_delete.yml' + $ref: "resources/load_balancers/loadBalancers_delete.yml" /v2/load_balancers/{lb_id}/cache: delete: - $ref: 'resources/load_balancers/loadBalancers_delete_cache.yml' + $ref: "resources/load_balancers/loadBalancers_delete_cache.yml" /v2/load_balancers/{lb_id}/droplets: post: - $ref: 'resources/load_balancers/loadBalancers_add_droplets.yml' + $ref: "resources/load_balancers/loadBalancers_add_droplets.yml" delete: - $ref: 'resources/load_balancers/loadBalancers_remove_droplets.yml' + $ref: "resources/load_balancers/loadBalancers_remove_droplets.yml" /v2/load_balancers/{lb_id}/forwarding_rules: post: - $ref: 'resources/load_balancers/loadBalancers_add_forwardingRules.yml' + $ref: "resources/load_balancers/loadBalancers_add_forwardingRules.yml" delete: - $ref: 'resources/load_balancers/loadBalancers_remove_forwardingRules.yml' + $ref: "resources/load_balancers/loadBalancers_remove_forwardingRules.yml" /v2/monitoring/alerts: get: - $ref: 'resources/monitoring/monitoring_list_alertPolicy.yml' + $ref: "resources/monitoring/monitoring_list_alertPolicy.yml" post: - $ref: 'resources/monitoring/monitoring_create_alertPolicy.yml' + $ref: "resources/monitoring/monitoring_create_alertPolicy.yml" /v2/monitoring/alerts/{alert_uuid}: get: - $ref: 'resources/monitoring/monitoring_get_alertPolicy.yml' + $ref: "resources/monitoring/monitoring_get_alertPolicy.yml" put: - $ref: 'resources/monitoring/monitoring_update_alertPolicy.yml' + $ref: "resources/monitoring/monitoring_update_alertPolicy.yml" delete: - $ref: 'resources/monitoring/monitoring_delete_alertPolicy.yml' + $ref: "resources/monitoring/monitoring_delete_alertPolicy.yml" /v2/monitoring/metrics/droplet/bandwidth: get: - $ref: 'resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml" /v2/monitoring/metrics/droplet/cpu: get: - $ref: 'resources/monitoring/monitoring_get_DropletCpuMetrics.yml' + $ref: "resources/monitoring/monitoring_get_DropletCpuMetrics.yml" /v2/monitoring/metrics/droplet/filesystem_free: get: - $ref: 'resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml" /v2/monitoring/metrics/droplet/filesystem_size: get: - $ref: 'resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml" /v2/monitoring/metrics/droplet/load_1: get: - $ref: 'resources/monitoring/monitoring_get_dropletLoad1Metrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletLoad1Metrics.yml" /v2/monitoring/metrics/droplet/load_5: get: - $ref: 'resources/monitoring/monitoring_get_dropletLoad5Metrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletLoad5Metrics.yml" /v2/monitoring/metrics/droplet/load_15: get: - $ref: 'resources/monitoring/monitoring_get_dropletLoad15Metrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletLoad15Metrics.yml" /v2/monitoring/metrics/droplet/memory_cached: get: - $ref: 'resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml" /v2/monitoring/metrics/droplet/memory_free: get: - $ref: 'resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml" /v2/monitoring/metrics/droplet/memory_total: get: - $ref: 'resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml" /v2/monitoring/metrics/droplet/memory_available: get: - $ref: 'resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml' + $ref: "resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml" /v2/monitoring/metrics/apps/memory_percentage: get: - $ref: 'resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml' + $ref: "resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml" /v2/monitoring/metrics/apps/cpu_percentage: get: - $ref: 'resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml' + $ref: "resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml" /v2/monitoring/metrics/apps/restart_count: get: - $ref: 'resources/monitoring/monitoring_get_appRestartCountMetrics.yml' + $ref: "resources/monitoring/monitoring_get_appRestartCountMetrics.yml" /v2/monitoring/metrics/load_balancer/frontend_connections_current: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_connections_current.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_connections_current.yml" /v2/monitoring/metrics/load_balancer/frontend_connections_limit: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_connections_limit.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_connections_limit.yml" /v2/monitoring/metrics/load_balancer/frontend_cpu_utilization: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_cpu_utilization.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_cpu_utilization.yml" /v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_bytes: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_bytes.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_bytes.yml" /v2/monitoring/metrics/load_balancer/frontend_firewall_dropped_packets: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_packets.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_firewall_dropped_packets.yml" /v2/monitoring/metrics/load_balancer/frontend_http_responses: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_http_responses.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_http_responses.yml" /v2/monitoring/metrics/load_balancer/frontend_http_requests_per_second: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_http_requests_per_second.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_http_requests_per_second.yml" /v2/monitoring/metrics/load_balancer/frontend_network_throughput_http: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_network_throughput_http.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_network_throughput_http.yml" /v2/monitoring/metrics/load_balancer/frontend_network_throughput_udp: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_network_throughput_udp.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_network_throughput_udp.yml" /v2/monitoring/metrics/load_balancer/frontend_network_throughput_tcp: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_network_throughput_tcp.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_network_throughput_tcp.yml" /v2/monitoring/metrics/load_balancer/frontend_nlb_tcp_network_throughput: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_nlb_tcp_network_throughput.yml" /v2/monitoring/metrics/load_balancer/frontend_nlb_udp_network_throughput: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_nlb_udp_network_throughput.yml" /v2/monitoring/metrics/load_balancer/frontend_tls_connections_current: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_tls_connections_current.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_tls_connections_current.yml" /v2/monitoring/metrics/load_balancer/frontend_tls_connections_limit: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_tls_connections_limit.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_tls_connections_limit.yml" /v2/monitoring/metrics/load_balancer/frontend_tls_connections_exceeding_rate_limit: get: - $ref: 'resources/monitoring/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml' + $ref: "resources/monitoring/monitoring_get_lb_frontend_tls_connections_exceeding_rate_limit.yml" /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_avg: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_session_duration_avg.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_session_duration_avg.yml" /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_50p: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_session_duration_50p.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_session_duration_50p.yml" /v2/monitoring/metrics/load_balancer/droplets_http_session_duration_95p: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_session_duration_95p.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_session_duration_95p.yml" /v2/monitoring/metrics/load_balancer/droplets_http_response_time_avg: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_avg.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_response_time_avg.yml" /v2/monitoring/metrics/load_balancer/droplets_http_response_time_50p: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_50p.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_response_time_50p.yml" /v2/monitoring/metrics/load_balancer/droplets_http_response_time_95p: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_95p.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_response_time_95p.yml" /v2/monitoring/metrics/load_balancer/droplets_http_response_time_99p: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_response_time_99p.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_response_time_99p.yml" /v2/monitoring/metrics/load_balancer/droplets_queue_size: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_queue_size.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_queue_size.yml" /v2/monitoring/metrics/load_balancer/droplets_http_responses: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_http_responses.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_http_responses.yml" /v2/monitoring/metrics/load_balancer/droplets_connections: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_connections.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_connections.yml" /v2/monitoring/metrics/load_balancer/droplets_health_checks: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_health_checks.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_health_checks.yml" /v2/monitoring/metrics/load_balancer/droplets_downtime: get: - $ref: 'resources/monitoring/monitoring_get_lb_droplets_downtime.yml' + $ref: "resources/monitoring/monitoring_get_lb_droplets_downtime.yml" /v2/monitoring/metrics/droplet_autoscale/current_instances: get: - $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_current_instances.yml' + $ref: "resources/monitoring/monitoring_get_droplet_autoscale_current_instances.yml" /v2/monitoring/metrics/droplet_autoscale/target_instances: get: - $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_target_instances.yml' + $ref: "resources/monitoring/monitoring_get_droplet_autoscale_target_instances.yml" /v2/monitoring/metrics/droplet_autoscale/current_cpu_utilization: get: - $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_current_cpu_utilization.yml' + $ref: "resources/monitoring/monitoring_get_droplet_autoscale_current_cpu_utilization.yml" /v2/monitoring/metrics/droplet_autoscale/target_cpu_utilization: get: - $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_target_cpu_utilization.yml' + $ref: "resources/monitoring/monitoring_get_droplet_autoscale_target_cpu_utilization.yml" /v2/monitoring/metrics/droplet_autoscale/current_memory_utilization: get: - $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_current_memory_utilization.yml' + $ref: "resources/monitoring/monitoring_get_droplet_autoscale_current_memory_utilization.yml" /v2/monitoring/metrics/droplet_autoscale/target_memory_utilization: get: - $ref: 'resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml' + $ref: "resources/monitoring/monitoring_get_droplet_autoscale_target_memory_utilization.yml" + + /v2/monitoring/metrics/database/mysql/cpu_usage: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml" + + /v2/monitoring/metrics/database/mysql/load: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_load.yml" + + /v2/monitoring/metrics/database/mysql/memory_usage: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_memory_usage.yml" + + /v2/monitoring/metrics/database/mysql/disk_usage: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_disk_usage.yml" + + /v2/monitoring/metrics/database/mysql/threads_connected: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_threads_connected.yml" + + /v2/monitoring/metrics/database/mysql/threads_created_rate: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml" + + /v2/monitoring/metrics/database/mysql/threads_active: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_threads_active.yml" + + /v2/monitoring/metrics/database/mysql/index_vs_sequential_reads: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml" + + /v2/monitoring/metrics/database/mysql/op_rates: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_op_rates.yml" + + /v2/monitoring/metrics/database/mysql/schema_throughput: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml" + + /v2/monitoring/metrics/database/mysql/schema_latency: + get: + $ref: "resources/monitoring/monitoring_get_database_mysql_schema_latency.yml" /v2/monitoring/sinks/destinations: post: - $ref: 'resources/monitoring/monitoring_create_destination.yml' + $ref: "resources/monitoring/monitoring_create_destination.yml" get: - $ref: 'resources/monitoring/monitoring_list_destinations.yml' + $ref: "resources/monitoring/monitoring_list_destinations.yml" /v2/monitoring/sinks/destinations/{destination_uuid}: get: - $ref: 'resources/monitoring/monitoring_get_destination.yml' + $ref: "resources/monitoring/monitoring_get_destination.yml" post: - $ref: 'resources/monitoring/monitoring_update_destination.yml' + $ref: "resources/monitoring/monitoring_update_destination.yml" delete: - $ref: 'resources/monitoring/monitoring_delete_destination.yml' + $ref: "resources/monitoring/monitoring_delete_destination.yml" /v2/monitoring/sinks: post: - $ref: 'resources/monitoring/monitoring_create_sink.yml' + $ref: "resources/monitoring/monitoring_create_sink.yml" get: - $ref: 'resources/monitoring/monitoring_list_sinks.yml' + $ref: "resources/monitoring/monitoring_list_sinks.yml" /v2/monitoring/sinks/{sink_uuid}: get: - $ref: 'resources/monitoring/monitoring_get_sink.yml' + $ref: "resources/monitoring/monitoring_get_sink.yml" + delete: + $ref: "resources/monitoring/monitoring_delete_sink.yml" + + /v2/nfs: + post: + $ref: "resources/nfs/nfs_create.yml" + + get: + $ref: "resources/nfs/nfs_list.yml" + + /v2/nfs/{nfs_id}: + get: + $ref: "resources/nfs/nfs_get.yml" + + delete: + $ref: "resources/nfs/nfs_delete.yml" + + /v2/nfs/{nfs_id}/actions: + post: + $ref: "resources/nfs/nfs_actions_create.yml" + + /v2/nfs/snapshots: + get: + $ref: "resources/nfs/nfs_snapshot_list.yml" + + /v2/nfs/snapshots/{nfs_snapshot_id}: + get: + $ref: "resources/nfs/nfs_snapshot_get.yml" + + delete: + $ref: "resources/nfs/nfs_snapshot_delete.yml" + + /v2/partner_network_connect/attachments: + get: + $ref: "resources/partner_network_connect/partner_attachment_list.yml" + post: + $ref: "resources/partner_network_connect/partner_attachment_create.yml" + + /v2/partner_network_connect/attachments/{pa_id}: + get: + $ref: "resources/partner_network_connect/partner_attachment_get.yml" + patch: + $ref: "resources/partner_network_connect/partner_attachment_update.yml" delete: - $ref: 'resources/monitoring/monitoring_delete_sink.yml' + $ref: "resources/partner_network_connect/partner_attachment_delete.yml" + + /v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key: + get: + $ref: "resources/partner_network_connect/partner_attachment_bgp_auth_key_get.yml" + + /v2/partner_network_connect/attachments/{pa_id}/remote_routes: + get: + $ref: "resources/partner_network_connect/partner_attachment_remote_routes_list.yml" + + /v2/partner_network_connect/attachments/{pa_id}/service_key: + get: + $ref: "resources/partner_network_connect/partner_attachment_service_key_get.yml" + post: + $ref: "resources/partner_network_connect/partner_attachment_service_key_create.yml" /v2/projects: get: - $ref: 'resources/projects/projects_list.yml' + $ref: "resources/projects/projects_list.yml" post: - $ref: 'resources/projects/projects_create.yml' + $ref: "resources/projects/projects_create.yml" /v2/projects/default: get: - $ref: 'resources/projects/projects_get_default.yml' + $ref: "resources/projects/projects_get_default.yml" put: - $ref: 'resources/projects/projects_update_default.yml' + $ref: "resources/projects/projects_update_default.yml" patch: - $ref: 'resources/projects/projects_patch_default.yml' + $ref: "resources/projects/projects_patch_default.yml" /v2/projects/{project_id}: get: - $ref: 'resources/projects/projects_get.yml' + $ref: "resources/projects/projects_get.yml" put: - $ref: 'resources/projects/projects_update.yml' + $ref: "resources/projects/projects_update.yml" patch: - $ref: 'resources/projects/projects_patch.yml' + $ref: "resources/projects/projects_patch.yml" delete: - $ref: 'resources/projects/projects_delete.yml' + $ref: "resources/projects/projects_delete.yml" /v2/projects/{project_id}/resources: get: - $ref: 'resources/projects/projects_list_resources.yml' + $ref: "resources/projects/projects_list_resources.yml" post: - $ref: 'resources/projects/projects_assign_resources.yml' + $ref: "resources/projects/projects_assign_resources.yml" /v2/projects/default/resources: get: - $ref: 'resources/projects/projects_list_resources_default.yml' + $ref: "resources/projects/projects_list_resources_default.yml" post: - $ref: 'resources/projects/projects_assign_resources_default.yml' + $ref: "resources/projects/projects_assign_resources_default.yml" /v2/regions: get: - $ref: 'resources/regions/regions_list.yml' + $ref: "resources/regions/regions_list.yml" + + /v2/registries: + get: + $ref: "resources/registry/registries_get_all.yml" + + post: + $ref: "resources/registry/registries_create.yml" + + /v2/registries/{registry_name}: + get: + $ref: "resources/registry/registries_get.yml" + + delete: + $ref: "resources/registry/registries_delete.yml" + + /v2/registries/{registry_name}/docker-credentials: + get: + $ref: "resources/registry/registries_get_dockerCredentials.yml" + + /v2/registries/subscription: + get: + $ref: "resources/registry/registries_get_subscription.yml" + + post: + $ref: "resources/registry/registries_update_subscription.yml" + + /v2/registries/options: + get: + $ref: "resources/registry/registries_get_options.yml" + + /v2/registries/{registry_name}/garbage-collection: + get: + $ref: "resources/registry/registries_get_garbageCollection.yml" + + post: + $ref: "resources/registry/registries_run_garbageCollection.yml" + + /v2/registries/{registry_name}/garbage-collections: + get: + $ref: "resources/registry/registries_list_garbageCollections.yml" + + /v2/registries/{registry_name}/garbage-collection/{garbage_collection_uuid}: + put: + $ref: "resources/registry/registries_update_garbageCollection.yml" + + /v2/registries/{registry_name}/repositoriesV2: + get: + $ref: "resources/registry/registries_list_repositoriesV2.yml" + + /v2/registries/{registry_name}/repositories/{repository_name}: + delete: + $ref: "resources/registry/registries_delete_repository.yml" + + /v2/registries/{registry_name}/repositories/{repository_name}/tags: + get: + $ref: "resources/registry/registries_list_repositoryTags.yml" + + /v2/registries/{registry_name}/repositories/{repository_name}/tags/{repository_tag}: + delete: + $ref: "resources/registry/registries_delete_repositoryTag.yml" + + /v2/registries/{registry_name}/repositories/{repository_name}/digests: + get: + $ref: "resources/registry/registries_list_repositoryManifests.yml" + + /v2/registries/{registry_name}/repositories/{repository_name}/digests/{manifest_digest}: + delete: + $ref: "resources/registry/registries_delete_repositoryManifest.yml" + + /v2/registries/validate-name: + post: + $ref: "resources/registry/registries_validate_name.yml" /v2/registry: get: - $ref: 'resources/registry/registry_get.yml' + $ref: "resources/registry/registry_get.yml" post: - $ref: 'resources/registry/registry_create.yml' + $ref: "resources/registry/registry_create.yml" delete: - $ref: 'resources/registry/registry_delete.yml' + $ref: "resources/registry/registry_delete.yml" /v2/registry/subscription: get: - $ref: 'resources/registry/registry_get_subscription.yml' + $ref: "resources/registry/registry_get_subscription.yml" post: - $ref: 'resources/registry/registry_update_subscription.yml' + $ref: "resources/registry/registry_update_subscription.yml" /v2/registry/docker-credentials: get: - $ref: 'resources/registry/registry_get_dockerCredentials.yml' + $ref: "resources/registry/registry_get_dockerCredentials.yml" /v2/registry/validate-name: post: - $ref: 'resources/registry/registry_validate_name.yml' + $ref: "resources/registry/registry_validate_name.yml" /v2/registry/{registry_name}/repositories: get: - $ref: 'resources/registry/registry_list_repositories.yml' + $ref: "resources/registry/registry_list_repositories.yml" /v2/registry/{registry_name}/repositoriesV2: get: - $ref: 'resources/registry/registry_list_repositoriesV2.yml' + $ref: "resources/registry/registry_list_repositoriesV2.yml" /v2/registry/{registry_name}/repositories/{repository_name}/tags: get: - $ref: 'resources/registry/registry_list_repositoryTags.yml' + $ref: "resources/registry/registry_list_repositoryTags.yml" /v2/registry/{registry_name}/repositories/{repository_name}/tags/{repository_tag}: delete: - $ref: 'resources/registry/registry_delete_repositoryTag.yml' + $ref: "resources/registry/registry_delete_repositoryTag.yml" /v2/registry/{registry_name}/repositories/{repository_name}/digests: get: - $ref: 'resources/registry/registry_list_repositoryManifests.yml' + $ref: "resources/registry/registry_list_repositoryManifests.yml" /v2/registry/{registry_name}/repositories/{repository_name}/digests/{manifest_digest}: delete: - $ref: 'resources/registry/registry_delete_repositoryManifest.yml' + $ref: "resources/registry/registry_delete_repositoryManifest.yml" /v2/registry/{registry_name}/garbage-collection: post: - $ref: 'resources/registry/registry_run_garbageCollection.yml' + $ref: "resources/registry/registry_run_garbageCollection.yml" get: - $ref: 'resources/registry/registry_get_garbageCollection.yml' + $ref: "resources/registry/registry_get_garbageCollection.yml" /v2/registry/{registry_name}/garbage-collections: get: - $ref: 'resources/registry/registry_list_garbageCollections.yml' + $ref: "resources/registry/registry_list_garbageCollections.yml" /v2/registry/{registry_name}/garbage-collection/{garbage_collection_uuid}: put: - $ref: 'resources/registry/registry_update_garbageCollection.yml' + $ref: "resources/registry/registry_update_garbageCollection.yml" /v2/registry/options: get: - $ref: 'resources/registry/registry_get_options.yml' + $ref: "resources/registry/registry_get_options.yml" /v2/reports/droplet_neighbors_ids: get: - $ref: 'resources/droplets/droplets_list_neighborsIds.yml' + $ref: "resources/droplets/droplets_list_neighborsIds.yml" /v2/reserved_ips: get: - $ref: 'resources/reserved_ips/reservedIPs_list.yml' + $ref: "resources/reserved_ips/reservedIPs_list.yml" post: - $ref: 'resources/reserved_ips/reservedIPs_create.yml' + $ref: "resources/reserved_ips/reservedIPs_create.yml" /v2/reserved_ips/{reserved_ip}: get: - $ref: 'resources/reserved_ips/reservedIPs_get.yml' + $ref: "resources/reserved_ips/reservedIPs_get.yml" delete: - $ref: 'resources/reserved_ips/reservedIPs_delete.yml' + $ref: "resources/reserved_ips/reservedIPs_delete.yml" /v2/reserved_ips/{reserved_ip}/actions: get: - $ref: 'resources/reserved_ips/reservedIPsActions_list.yml' + $ref: "resources/reserved_ips/reservedIPsActions_list.yml" post: - $ref: 'resources/reserved_ips/reservedIPsActions_post.yml' + $ref: "resources/reserved_ips/reservedIPsActions_post.yml" /v2/reserved_ips/{reserved_ip}/actions/{action_id}: get: - $ref: 'resources/reserved_ips/reservedIPsActions_get.yml' + $ref: "resources/reserved_ips/reservedIPsActions_get.yml" + + /v2/reserved_ipv6: + get: + $ref: "resources/reserved_ipv6/reservedIPv6_list.yml" + + post: + $ref: "resources/reserved_ipv6/reservedIPv6_create.yml" + + /v2/reserved_ipv6/{reserved_ipv6}: + get: + $ref: "resources/reserved_ipv6/reservedIPv6_get.yml" + + delete: + $ref: "resources/reserved_ipv6/reservedIPv6_delete.yml" + + /v2/reserved_ipv6/{reserved_ipv6}/actions: + post: + $ref: "resources/reserved_ipv6/reservedIPv6Actions_post.yml" + + /v2/byoip_prefixes: + post: + $ref: "resources/byoip_prefixes/byoip_prefixes_create.yml" + get: + $ref: "resources/byoip_prefixes/byoip_prefixes_list.yml" + + /v2/byoip_prefixes/{byoip_prefix_uuid}: + get: + $ref: "resources/byoip_prefixes/byoip_prefixes_get.yml" + delete: + $ref: "resources/byoip_prefixes/byoip_prefixes_delete.yml" + patch: + $ref: "resources/byoip_prefixes/byoip_prefixes_update.yml" + + /v2/byoip_prefixes/{byoip_prefix_uuid}/ips: + get: + $ref: "resources/byoip_prefixes/byoip_prefix_list_resources.yml" /v2/sizes: get: - $ref: 'resources/sizes/sizes_list.yml' + $ref: "resources/sizes/sizes_list.yml" /v2/snapshots: get: - $ref: 'resources/snapshots/snapshots_list.yml' + $ref: "resources/snapshots/snapshots_list.yml" /v2/snapshots/{snapshot_id}: get: - $ref: 'resources/snapshots/snapshots_get.yml' + $ref: "resources/snapshots/snapshots_get.yml" + + delete: + $ref: "resources/snapshots/snapshots_delete.yml" + + /v2/spaces/keys: + get: + $ref: "resources/spaces/key_list.yml" + + post: + $ref: "resources/spaces/key_create.yml" + + /v2/spaces/keys/{access_key}: + get: + $ref: "resources/spaces/key_get.yml" delete: - $ref: 'resources/snapshots/snapshots_delete.yml' + $ref: "resources/spaces/key_delete.yml" + + put: + $ref: "resources/spaces/key_update.yml" + + patch: + $ref: "resources/spaces/key_patch.yml" /v2/tags: get: - $ref: 'resources/tags/tags_list.yml' + $ref: "resources/tags/tags_list.yml" post: - $ref: 'resources/tags/tags_create.yml' + $ref: "resources/tags/tags_create.yml" /v2/tags/{tag_id}: get: - $ref: 'resources/tags/tags_get.yml' + $ref: "resources/tags/tags_get.yml" delete: - $ref: 'resources/tags/tags_delete.yml' + $ref: "resources/tags/tags_delete.yml" /v2/tags/{tag_id}/resources: post: - $ref: 'resources/tags/tags_assign_resources.yml' + $ref: "resources/tags/tags_assign_resources.yml" delete: - $ref: 'resources/tags/tags_unassign_resources.yml' + $ref: "resources/tags/tags_unassign_resources.yml" /v2/volumes: get: - $ref: 'resources/volumes/volumes_list.yml' + $ref: "resources/volumes/volumes_list.yml" post: - $ref: 'resources/volumes/volumes_create.yml' + $ref: "resources/volumes/volumes_create.yml" delete: - $ref: 'resources/volumes/volumes_delete_byName.yml' + $ref: "resources/volumes/volumes_delete_byName.yml" /v2/volumes/actions: post: - $ref: 'resources/volumes/volumeActions_post.yml' + $ref: "resources/volumes/volumeActions_post.yml" /v2/volumes/snapshots/{snapshot_id}: get: - $ref: 'resources/volumes/volumeSnapshots_get_byId.yml' + $ref: "resources/volumes/volumeSnapshots_get_byId.yml" delete: - $ref: 'resources/volumes/volumeSnapshots_delete_byId.yml' + $ref: "resources/volumes/volumeSnapshots_delete_byId.yml" /v2/volumes/{volume_id}: get: - $ref: 'resources/volumes/volumes_get.yml' + $ref: "resources/volumes/volumes_get.yml" delete: - $ref: 'resources/volumes/volumes_delete.yml' + $ref: "resources/volumes/volumes_delete.yml" /v2/volumes/{volume_id}/actions: get: - $ref: 'resources/volumes/volumeActions_list.yml' + $ref: "resources/volumes/volumeActions_list.yml" post: - $ref: 'resources/volumes/volumeActions_post_byId.yml' + $ref: "resources/volumes/volumeActions_post_byId.yml" /v2/volumes/{volume_id}/actions/{action_id}: get: - $ref: 'resources/volumes/volumeActions_get.yml' + $ref: "resources/volumes/volumeActions_get.yml" /v2/volumes/{volume_id}/snapshots: get: - $ref: 'resources/volumes/volumeSnapshots_list.yml' + $ref: "resources/volumes/volumeSnapshots_list.yml" post: - $ref: 'resources/volumes/volumeSnapshots_create.yml' + $ref: "resources/volumes/volumeSnapshots_create.yml" /v2/vpcs: get: - $ref: 'resources/vpcs/vpcs_list.yml' + $ref: "resources/vpcs/vpcs_list.yml" post: - $ref: 'resources/vpcs/vpcs_create.yml' + $ref: "resources/vpcs/vpcs_create.yml" /v2/vpcs/{vpc_id}: get: - $ref: 'resources/vpcs/vpcs_get.yml' + $ref: "resources/vpcs/vpcs_get.yml" put: - $ref: 'resources/vpcs/vpcs_update.yml' + $ref: "resources/vpcs/vpcs_update.yml" patch: - $ref: 'resources/vpcs/vpcs_patch.yml' + $ref: "resources/vpcs/vpcs_patch.yml" delete: - $ref: 'resources/vpcs/vpcs_delete.yml' + $ref: "resources/vpcs/vpcs_delete.yml" /v2/vpcs/{vpc_id}/members: get: - $ref: 'resources/vpcs/vpcs_list_members.yml' + $ref: "resources/vpcs/vpcs_list_members.yml" /v2/vpcs/{vpc_id}/peerings: get: - $ref: 'resources/vpcs/vpcs_list_peerings.yml' + $ref: "resources/vpcs/vpcs_list_peerings.yml" post: - $ref: 'resources/vpcs/vpcs_create_peerings.yml' + $ref: "resources/vpcs/vpcs_create_peerings.yml" /v2/vpcs/{vpc_id}/peerings/{vpc_peering_id}: patch: - $ref: 'resources/vpcs/vpcs_update_peerings.yml' + $ref: "resources/vpcs/vpcs_update_peerings.yml" /v2/vpc_peerings: get: - $ref: 'resources/vpc_peerings/vpc_peerings_list.yml' + $ref: "resources/vpc_peerings/vpc_peerings_list.yml" post: - $ref: 'resources/vpc_peerings/vpc_peerings_create.yml' + $ref: "resources/vpc_peerings/vpc_peerings_create.yml" /v2/vpc_peerings/{vpc_peering_id}: get: - $ref: 'resources/vpc_peerings/vpc_peerings_get.yml' + $ref: "resources/vpc_peerings/vpc_peerings_get.yml" patch: - $ref: 'resources/vpc_peerings/vpc_peerings_update.yml' + $ref: "resources/vpc_peerings/vpc_peerings_update.yml" + + delete: + $ref: "resources/vpc_peerings/vpc_peerings_delete.yml" + + /v2/vpc_nat_gateways: + get: + $ref: "resources/vpc_nat_gateways/vpc_nat_gateway_list.yml" + + post: + $ref: "resources/vpc_nat_gateways/vpc_nat_gateway_create.yml" + + /v2/vpc_nat_gateways/{id}: + get: + $ref: "resources/vpc_nat_gateways/vpc_nat_gateway_get.yml" + + put: + $ref: "resources/vpc_nat_gateways/vpc_nat_gateway_update.yml" delete: - $ref: 'resources/vpc_peerings/vpc_peerings_delete.yml' + $ref: "resources/vpc_nat_gateways/vpc_nat_gateway_delete.yml" /v2/uptime/checks: get: - $ref: 'resources/uptime/list_checks.yml' + $ref: "resources/uptime/list_checks.yml" post: - $ref: 'resources/uptime/create_check.yml' + $ref: "resources/uptime/create_check.yml" /v2/uptime/checks/{check_id}: get: - $ref: 'resources/uptime/get_check.yml' + $ref: "resources/uptime/get_check.yml" put: - $ref: 'resources/uptime/update_check.yml' + $ref: "resources/uptime/update_check.yml" delete: - $ref: 'resources/uptime/delete_check.yml' + $ref: "resources/uptime/delete_check.yml" /v2/uptime/checks/{check_id}/state: get: - $ref: 'resources/uptime/get_check_state.yml' + $ref: "resources/uptime/get_check_state.yml" /v2/uptime/checks/{check_id}/alerts: get: - $ref: 'resources/uptime/list_alerts.yml' + $ref: "resources/uptime/list_alerts.yml" post: - $ref: 'resources/uptime/create_alert.yml' + $ref: "resources/uptime/create_alert.yml" /v2/uptime/checks/{check_id}/alerts/{alert_id}: get: - $ref: 'resources/uptime/get_alert.yml' + $ref: "resources/uptime/get_alert.yml" put: - $ref: 'resources/uptime/update_alert.yml' + $ref: "resources/uptime/update_alert.yml" delete: - $ref: 'resources/uptime/delete_alert.yml' - - + $ref: "resources/uptime/delete_alert.yml" /v2/gen-ai/agents: get: @@ -1851,42 +2272,54 @@ paths: /v2/gen-ai/agents/{agent_uuid}/functions/{function_uuid}: - delete: - $ref: 'resources/gen-ai/genai_detach_agent_function.yml' - put: $ref: 'resources/gen-ai/genai_update_agent_function.yml' + delete: + $ref: 'resources/gen-ai/genai_detach_agent_function.yml' - /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}: + /v2/gen-ai/agents/{agent_uuid}/guardrails: + post: + $ref: 'resources/gen-ai/genai_attach_agent_guardrails.yml' + + /v2/gen-ai/agents/{agent_uuid}/guardrails/{guardrail_uuid}: delete: - $ref: 'resources/gen-ai/genai_detach_knowledge_base.yml' + $ref: 'resources/gen-ai/genai_detach_agent_guardrail.yml' + /v2/gen-ai/agents/{agent_uuid}/knowledge_bases: post: - $ref: 'resources/gen-ai/genai_attach_knowledge_base.yml' + $ref: 'resources/gen-ai/genai_attach_knowledge_bases.yml' - /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}: + /v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}: + post: + $ref: 'resources/gen-ai/genai_attach_knowledge_base.yml' + delete: - $ref: 'resources/gen-ai/genai_detach_agent.yml' + $ref: 'resources/gen-ai/genai_detach_knowledge_base.yml' + + /v2/gen-ai/agents/{parent_agent_uuid}/child_agents/{child_agent_uuid}: post: $ref: 'resources/gen-ai/genai_attach_agent.yml' put: $ref: 'resources/gen-ai/genai_update_attached_agent.yml' - - /v2/gen-ai/agents/{uuid}: delete: - $ref: 'resources/gen-ai/genai_delete_agent.yml' + $ref: 'resources/gen-ai/genai_detach_agent.yml' + + /v2/gen-ai/agents/{uuid}: get: $ref: 'resources/gen-ai/genai_get_agent.yml' put: $ref: 'resources/gen-ai/genai_update_agent.yml' + delete: + $ref: 'resources/gen-ai/genai_delete_agent.yml' + /v2/gen-ai/agents/{uuid}/child_agents: get: @@ -1898,6 +2331,99 @@ paths: $ref: 'resources/gen-ai/genai_update_agent_deployment_visibility.yml' + /v2/gen-ai/agents/{uuid}/usage: + get: + $ref: 'resources/gen-ai/genai_get_agent_usage.yml' + + + /v2/gen-ai/agents/{uuid}/versions: + get: + $ref: 'resources/gen-ai/genai_list_agent_versions.yml' + + put: + $ref: 'resources/gen-ai/genai_rollback_to_agent_version.yml' + + + /v2/gen-ai/anthropic/keys: + get: + $ref: 'resources/gen-ai/genai_list_anthropic_api_keys.yml' + + post: + $ref: 'resources/gen-ai/genai_create_anthropic_api_key.yml' + + + /v2/gen-ai/anthropic/keys/{api_key_uuid}: + get: + $ref: 'resources/gen-ai/genai_get_anthropic_api_key.yml' + + put: + $ref: 'resources/gen-ai/genai_update_anthropic_api_key.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_anthropic_api_key.yml' + + + /v2/gen-ai/anthropic/keys/{uuid}/agents: + get: + $ref: 'resources/gen-ai/genai_list_agents_by_anthropic_key.yml' + + + /v2/gen-ai/evaluation_datasets: + post: + $ref: 'resources/gen-ai/genai_create_evaluation_dataset.yml' + + + /v2/gen-ai/evaluation_datasets/file_upload_presigned_urls: + post: + $ref: 'resources/gen-ai/genai_create_evaluation_dataset_file_upload_presigned_urls.yml' + + + /v2/gen-ai/evaluation_metrics: + get: + $ref: 'resources/gen-ai/genai_list_evaluation_metrics.yml' + + + /v2/gen-ai/evaluation_runs: + post: + $ref: 'resources/gen-ai/genai_run_evaluation_test_case.yml' + + + /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}: + get: + $ref: 'resources/gen-ai/genai_get_evaluation_run.yml' + + + /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results: + get: + $ref: 'resources/gen-ai/genai_get_evaluation_run_results.yml' + + + /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}: + get: + $ref: 'resources/gen-ai/genai_get_evaluation_run_prompt_results.yml' + + + /v2/gen-ai/evaluation_test_cases: + get: + $ref: 'resources/gen-ai/genai_list_evaluation_test_cases.yml' + + post: + $ref: 'resources/gen-ai/genai_create_evaluation_test_case.yml' + + + /v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs: + get: + $ref: 'resources/gen-ai/genai_list_evaluation_runs_by_test_case.yml' + + + /v2/gen-ai/evaluation_test_cases/{test_case_uuid}: + get: + $ref: 'resources/gen-ai/genai_get_evaluation_test_case.yml' + + put: + $ref: 'resources/gen-ai/genai_update_evaluation_test_case.yml' + + /v2/gen-ai/indexing_jobs: get: $ref: 'resources/gen-ai/genai_list_indexing_jobs.yml' @@ -1911,6 +2437,11 @@ paths: $ref: 'resources/gen-ai/genai_list_indexing_job_data_sources.yml' + /v2/gen-ai/indexing_jobs/{indexing_job_uuid}/details_signed_url: + get: + $ref: 'resources/gen-ai/genai_get_indexing_job_details_signed_url.yml' + + /v2/gen-ai/indexing_jobs/{uuid}: get: $ref: 'resources/gen-ai/genai_get_indexing_job.yml' @@ -1929,19 +2460,32 @@ paths: $ref: 'resources/gen-ai/genai_create_knowledge_base.yml' - /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources: + /v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls: post: - $ref: 'resources/gen-ai/genai_create_knowledge_base_data_source.yml' + $ref: 'resources/gen-ai/genai_create_data_source_file_upload_presigned_urls.yml' + + /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources: get: $ref: 'resources/gen-ai/genai_list_knowledge_base_data_sources.yml' + post: + $ref: 'resources/gen-ai/genai_create_knowledge_base_data_source.yml' + /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}: + put: + $ref: 'resources/gen-ai/genai_update_knowledge_base_data_source.yml' + delete: $ref: 'resources/gen-ai/genai_delete_knowledge_base_data_source.yml' + /v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs: + get: + $ref: 'resources/gen-ai/genai_list_indexing_jobs_by_knowledge_base.yml' + + /v2/gen-ai/knowledge_bases/{uuid}: get: $ref: 'resources/gen-ai/genai_get_knowledge_base.yml' @@ -1958,11 +2502,111 @@ paths: $ref: 'resources/gen-ai/genai_list_models.yml' + /v2/gen-ai/models/api_keys: + get: + $ref: 'resources/gen-ai/genai_list_model_api_keys.yml' + + post: + $ref: 'resources/gen-ai/genai_create_model_api_key.yml' + + + /v2/gen-ai/models/api_keys/{api_key_uuid}: + put: + $ref: 'resources/gen-ai/genai_update_model_api_key.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_model_api_key.yml' + + + /v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate: + put: + $ref: 'resources/gen-ai/genai_regenerate_model_api_key.yml' + + /v2/gen-ai/oauth2/dropbox/tokens: + post: + $ref: 'resources/gen-ai/genai_create_oauth2_dropbox_tokens.yml' + + + /v2/gen-ai/oauth2/url: + get: + $ref: 'resources/gen-ai/genai_get_oauth2_url.yml' + + + /v2/gen-ai/openai/keys: + get: + $ref: 'resources/gen-ai/genai_list_openai_api_keys.yml' + + post: + $ref: 'resources/gen-ai/genai_create_openai_api_key.yml' + + + /v2/gen-ai/openai/keys/{api_key_uuid}: + get: + $ref: 'resources/gen-ai/genai_get_openai_api_key.yml' + + put: + $ref: 'resources/gen-ai/genai_update_openai_api_key.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_openai_api_key.yml' + + + /v2/gen-ai/openai/keys/{uuid}/agents: + get: + $ref: 'resources/gen-ai/genai_list_agents_by_openai_key.yml' + + /v2/gen-ai/regions: get: $ref: 'resources/gen-ai/genai_list_datacenter_regions.yml' + /v2/gen-ai/scheduled-indexing: + post: + $ref: 'resources/gen-ai/genai_create_scheduled_indexing.yml' + + + /v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}: + get: + $ref: 'resources/gen-ai/genai_get_scheduled_indexing.yml' + + + /v2/gen-ai/scheduled-indexing/{uuid}: + delete: + $ref: 'resources/gen-ai/genai_delete_scheduled_indexing.yml' + + + + /v2/gen-ai/workspaces: + get: + $ref: 'resources/gen-ai/genai_list_workspaces.yml' + + post: + $ref: 'resources/gen-ai/genai_create_workspace.yml' + + + /v2/gen-ai/workspaces/{workspace_uuid}: + get: + $ref: 'resources/gen-ai/genai_get_workspace.yml' + + put: + $ref: 'resources/gen-ai/genai_update_workspace.yml' + + delete: + $ref: 'resources/gen-ai/genai_delete_workspace.yml' + + + /v2/gen-ai/workspaces/{workspace_uuid}/agents: + get: + $ref: 'resources/gen-ai/genai_list_agents_by_workspace.yml' + + put: + $ref: 'resources/gen-ai/genai_update_agents_workspace.yml' + + + /v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases: + get: + $ref: 'resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml' components: securitySchemes: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/description.yml b/packages/openapi-typescript/examples/digital-ocean-api/description.yml index ab35c817a..fb6ebddcc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/description.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/description.yml @@ -241,7 +241,6 @@ introduction: | **Note:** The following endpoints have special rate limit requirements that are independent of the limits defined above. - * Only 12 `POST` requests to the `/v2/floating_ips` endpoint to create Floating IPs can be made per 60 seconds. * Only 10 `GET` requests to the `/v2/account/keys` endpoint to list SSH keys can be made per 60 seconds. * Only 5 requests to any and all `v2/cdn/endpoints` can be made per 10 seconds. This includes `v2/cdn/endpoints`, `v2/cdn/endpoints/$ENDPOINT_ID`, and `v2/cdn/endpoints/$ENDPOINT_ID/cache`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/curl/oneClicks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/curl/oneClicks.yml index f2f7de659..570bf6aaa 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/curl/oneClicks.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/curl/oneClicks.yml @@ -2,5 +2,4 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/1-clicks" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/python/oneClicks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/python/oneClicks.yml index 32ee00c88..d44c8cb59 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/python/oneClicks.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/python/oneClicks.yml @@ -3,6 +3,6 @@ source: |- import os from pydo import Client - client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + client = Client(token="") one_click_apps = client.one_clicks.list() \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml index 2ae54f7d6..eefbbad7a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml @@ -40,4 +40,5 @@ x-codeSamples: security: - bearer_auth: - - '1click:create' + - 'kubernetes:update' + - 'addon:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml index 56c2319ef..0b74fa810 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml @@ -37,6 +37,4 @@ x-codeSamples: - $ref: 'examples/python/oneClicks.yml' security: - - bearer_auth: - - '1click:read' - + - bearer_auth: [] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/account/models/account.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/account/models/account.yml index 5004902f0..5c5c133be 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/account/models/account.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/account/models/account.yml @@ -2,12 +2,16 @@ type: object properties: droplet_limit: - description: The total number of Droplets current user or team may have active at one time. + description: | + The total number of Droplets current user or team may have active at one time. +

Requires `droplet:read` scope. type: integer example: 25 floating_ip_limit: - description: The total number of Floating IPs the current user or team may have. + description: | + The total number of Floating IPs the current user or team may have. +

Requires `reserved_ip:read` scope. type: integer example: 5 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_create.yml new file mode 100644 index 000000000..3b01ea6a4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_create.yml @@ -0,0 +1,49 @@ +operationId: addons_create + +summary: Create/Provision a New Add-on Resource + +description: | + To create an add-on resource, send a POST request to `/v2/add-ons/saas` with required parameters. + Some add-ons require additional metadata to be provided in the request body. To find out + what metadata is required for a specific add-on, send a GET request to `/v2/add-ons/apps/{app_slug}/metadata`. + +tags: + - Add-Ons + +requestBody: + required: true + + content: + application/json: + schema: + allOf: + - $ref: 'models/addons_resource_new.yml' + + required: + - name + - app_slug + - plan_slug + - metadata + +responses: + '200': + $ref: 'responses/addons_create.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/addons_create.yml' + +security: + - bearer_auth: + - 'addon:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_delete.yml new file mode 100644 index 000000000..cc26b1b24 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_delete.yml @@ -0,0 +1,40 @@ +operationId: addons_delete + +summary: Delete/Deprovision an Add-on Resource + +description: | + To delete an add-on resource, send a DELETE request to `/v2/add-ons/saas/{resource_uuid}` with the UUID of the resource to delete. + You cannot retrieve the resource after it has been deleted. The response indicates a request was sent to the 3rd party add-on provider to delete the resource. + You will no longer be billed for this resource. + +tags: + - Add-Ons + +parameters: + - $ref: 'parameters.yml#/resource_uuid' + +responses: + '200': + $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/addons_delete.yml' + +security: + - bearer_auth: + - 'addon:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get.yml new file mode 100644 index 000000000..d34c3a54f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get.yml @@ -0,0 +1,45 @@ +operationId: addons_get + +summary: Get details on an Add-On Resource + +description: | + To fetch details of a specific Add-On Resource, send a GET request to `/v2/add-ons/saas/{resource_uuid}`. + Replace `{resource_uuid}` with the UUID of the resource you want to retrieve. + +tags: + - Add-Ons + +parameters: + - name: resource_uuid + in: path + required: true + example: "123e4567-e89b-12d3-a456-426614174000" + schema: + type: string + description: The UUID of the add-on resource to retrieve. + +responses: + '200': + $ref: 'responses/addons_get.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/addons_get.yml' + +security: + - bearer_auth: + - 'addon:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app.yml new file mode 100644 index 000000000..764d4589e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app.yml @@ -0,0 +1,31 @@ +operationId: addons_get_app + +summary: List Available Add-On Applications + +description: | + To fetch details of all available Add-On Applications, send a GET request to `/v2/add-ons/apps`. + +tags: + - Add-Ons + +responses: + '200': + $ref: 'responses/addons_get_app.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/addons_get_app.yml' + +security: + - bearer_auth: [] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app_metadata.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app_metadata.yml new file mode 100644 index 000000000..f3ec3a9b8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_get_app_metadata.yml @@ -0,0 +1,44 @@ +operationId: addons_get_app_metadata + +summary: Get Metadata for an Add-On Application + +description: | + To find out what metadata is required for a specific add-on, send a GET request to `/v2/add-ons/apps/{app_slug}/metadata`. + Metadata varies by application. + +tags: + - Add-Ons + +parameters: + - name: app_slug + in: path + required: true + example: example_app + schema: + type: string + description: The slug identifier for the application whose metadata is being requested. + +responses: + '200': + $ref: 'responses/addons_get_app_metadata.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/addons_get_app_metadata.yml' + +security: + - bearer_auth: [] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_list.yml new file mode 100644 index 000000000..640bf8e54 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_list.yml @@ -0,0 +1,32 @@ +operationId: addons_list + +summary: List all Add-On Resources + +description: | + To fetch all Add-On Resources under your team, send a GET request to `/v2/add-ons/saas`. + +tags: + - Add-Ons + +responses: + '200': + $ref: 'responses/addons_list.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/addons_list.yml' + +security: + - bearer_auth: + - 'addon:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update.yml new file mode 100644 index 000000000..c80a4445e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update.yml @@ -0,0 +1,61 @@ +operationId: addons_patch + +summary: Update the name for an Add-On Resource + +description: | + To change the name of an Add-On Resource, send a PATCH request to `/v2/add-ons/saas/{resource_uuid}`. + Replace `{resource_uuid}` with the UUID of the resource for which you want to change the name. + +tags: + - Add-Ons + +parameters: + - name: resource_uuid + in: path + required: true + example: "123e4567-e89b-12d3-a456-426614174000" + schema: + type: string + description: The UUID of the add-on resource to rename. + +requestBody: + required: true + + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The new name for the add-on resource. + example: "new-name" + + required: + - name + +responses: + '200': + $ref: 'responses/addons_update.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/addons_update.yml' + +security: + - bearer_auth: + - 'addon:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update_plan.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update_plan.yml new file mode 100644 index 000000000..df227d396 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/addons_update_plan.yml @@ -0,0 +1,61 @@ +operationId: addons_patch_plan + +summary: Update the plan for an Add-On Resource + +description: | + To change the plan associated with an Add-On Resource, send a PATCH request to `/v2/add-ons/saas/{resource_uuid}/plan`. + Replace `{resource_uuid}` with the UUID of the resource for which you want to change the plan. + +tags: + - Add-Ons + +parameters: + - name: resource_uuid + in: path + required: true + example: "123e4567-e89b-12d3-a456-426614174000" + schema: + type: string + description: The UUID of the add-on resource to update. + +requestBody: + required: true + + content: + application/json: + schema: + type: object + properties: + plan_slug: + type: string + description: The slug identifier for the new plan to apply to the add-on resource. + example: basic_plan + + required: + - plan_slug + +responses: + '200': + $ref: 'responses/addons_update.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/addons_update_plan.yml' + +security: + - bearer_auth: + - 'addon:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_create.yml new file mode 100644 index 000000000..edb74d59d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_create.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name":"my-addon-resource", "app_slug": "example-app", "plan_slug": "basic_plan", "metadata": [{"name": "company_name", "value": "Sample Company"}]}' \ + "https://api.digitalocean.com/v2/add-ons/saas" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_delete.yml new file mode 100644 index 000000000..8c6230be9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_delete.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/add-ons/saas/123e4567-e89b-12d3-a456-426614174000" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get.yml new file mode 100644 index 000000000..8be1bbb7d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/add-ons/saas/123e4567-e89b-12d3-a456-4266141" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app.yml new file mode 100644 index 000000000..7fcbf1132 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/add-ons/apps" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app_metadata.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app_metadata.yml new file mode 100644 index 000000000..ecd21274a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_get_app_metadata.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/add-ons/apps/example-app/metadata" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_list.yml new file mode 100644 index 000000000..e66753c01 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_list.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/add-ons/saas" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update.yml new file mode 100644 index 000000000..d36f9a9ec --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name":"new-name"}' \ + "https://api.digitalocean.com/v2/add-ons/saas/abc12345-6789-0123-4567-89abcdef0123" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update_plan.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update_plan.yml new file mode 100644 index 000000000..f79ee6b9f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/examples/curl/addons_update_plan.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"plan_slug":"new-plan"}' \ + "https://api.digitalocean.com/v2/add-ons/saas/abc12345-6789-0123-4567-89abcdef0123/plan" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_info.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_info.yml new file mode 100644 index 000000000..ca2d68335 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_info.yml @@ -0,0 +1,33 @@ +type: object + +properties: + app_slug: + title: app_slug + type: string + example: example-app + description: The slug identifier for the application associated with the resource. + + tos: + title: tos + type: string + example: "https://example.com/tos" + description: The Terms of Service URL for the resource. + + eula: + title: eula + type: string + example: "https://example.com/eula" + description: The End User License Agreement URL for the resource. + + plans: + title: plans + type: array + description: A list of plans available for the resource. + items: + $ref: addons_plan.yml + +required: + - app_slug + - tos + - eula + - plans diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_metadata.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_metadata.yml new file mode 100644 index 000000000..389804102 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_app_metadata.yml @@ -0,0 +1,54 @@ +type: object + +properties: + id: + title: id + type: integer + example: 1 + description: Unique identifier for the addon metadata item. + + name: + title: name + type: string + example: "country_of_origin" + description: The name of the metadata item. + + display_name: + title: display_name + type: string + example: "Country of Origin" + description: The display name of the metadata item. + + description: + title: description + type: string + example: "Country for localization" + description: A brief description of the metadata item. + + type: + title: type + type: string + enum: + - string + - boolean + example: "string" + description: The data type of the metadata value. + + options: + title: options + type: array + example: + - "US" + - "UK" + - "CA" + items: + type: string + example: "UK" + description: An option available for the addon metadata, if applicable. + +required: + - id + - name + - display_name + - description + - type diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_volume_with_price.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_volume_with_price.yml new file mode 100644 index 000000000..473f31afc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_volume_with_price.yml @@ -0,0 +1,32 @@ +type: object + +properties: + id: + title: id + type: integer + example: 123 + description: Unique identifier for the addon. + + low_volume: + title: low_volume + type: integer + example: 1 + description: The minimum volume for the volume pricing tier. + + max_volume: + title: max_volume + type: integer + example: 100 + description: The maximum volume for the volume pricing tier. + + price_per_unit: + title: price_per_unit + type: string + example: "0.10" + description: The price per unit for the volume tier in US dollars. + +required: + - id + - low_volume + - max_volume + - price_per_unit diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_with_price.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_with_price.yml new file mode 100644 index 000000000..c8b2ba27a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_dimension_with_price.yml @@ -0,0 +1,47 @@ +type: object + +properties: + id: + title: id + type: integer + example: 1 + description: Unique identifier for the dimension. + + sku: + title: sku + type: string + example: "addon_sku_123" + description: Unique string identifier for the dimension, tied to a price. + + slug: + title: slug + type: string + example: "addon_dimension_slug" + description: Slug identifier for the dimension. + + display_name: + title: display_name + type: string + example: "Addon Dimension Display Name" + description: Display name for the dimension. + + feature_name: + title: feature_name + type: string + example: "Feature Name" + description: Name of the feature associated with the dimension. + + volumes: + title: volumes + type: array + description: A list of volumes associated with the dimension, each with its own price. + items: + $ref: addons_dimension_volume_with_price.yml + +required: + - id + - sku + - slug + - display_name + - feature_name + - volumes diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_feature.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_feature.yml new file mode 100644 index 000000000..0c58fcfff --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_feature.yml @@ -0,0 +1,74 @@ +type: object + +properties: + id: + title: id + type: integer + example: 1 + description: Unique identifier for the app feature. + + name: + title: name + type: string + example: "Support" + description: Name of the feature. + + type: + title: type + type: string + enum: + - unknown + - string + - boolean + - allowance + example: "string" + description: Feature type, indicating the kind of data it holds. + + unit: + title: unit + type: string + enum: + - unit_unknown + - GB + - GIB + - count + - byte + - byte_second + example: "GB" + description: Unit of measurement for the feature, if applicable. Units apply to allowance features. + + value: + example: "Unlimited" + oneOf: + - title: string_value + type: string + example: "Unlimited" + - title: boolean_value + type: boolean + example: true + - title: allowance_value + type: string + example: "1000" + description: Value of the feature, which can vary based on the type. + + created_at: + title: created_at + type: string + format: date-time + example: "2023-10-01T12:00:00Z" + description: Timestamp when the feature was created. + + updated_at: + title: updated_at + type: string + format: date-time + example: "2023-10-01T12:00:00Z" + description: Timestamp when the feature was last updated. + +required: + - id + - name + - type + - value + - created_at + - updated_at diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_plan.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_plan.yml new file mode 100644 index 000000000..501814b79 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_plan.yml @@ -0,0 +1,118 @@ +type: object + +properties: + id: + title: id + type: integer + example: 1 + description: ID of a given plan. + + app_id: + title: app_id + type: integer + example: 2 + description: ID of the app associated with this plan. + + display_name: + title: display_name + type: string + example: "Basic Plan" + description: Display name for a given plan. + + description: + title: description + type: string + example: "Description of the app plan." + description: Description of an app plan. + + slug: + title: slug + type: string + example: "plan_basic" + description: Slug identifier for the plan. + + price_per_month: + title: price_per_month + type: integer + example: 10 + description: Price of a month's usage of the plan in US dollars. + + active: + title: active + type: boolean + example: true + description: Indicates if the plan is currently active. + + state: + title: state + type: string + enum: + - unknown + - draft + - in_review + - approved + - suspended + - archived + example: "approved" + description: Current state of the plan. + + features: + title: features + type: array + items: + $ref: addons_feature.yml + example: [] + description: List of features included in the plan. + + created_at: + title: created_at + type: string + format: date-time + example: "2023-10-01T12:00:00Z" + description: Timestamp when the plan was created. + + updated_at: + title: updated_at + type: string + format: date-time + example: "2023-10-01T12:00:00Z" + description: Timestamp when the plan was last updated. + + available: + title: available + type: boolean + example: true + description: Indicates if the plan is available for selection. + + uuid: + title: uuid + type: string + example: "123e4567-e89b-12d3-a456-426 614174000" + description: Unique identifier for the plan. + + by_default: + title: by_default + type: boolean + example: false + description: Indicates if this plan is the default option for the app. + + dimensions: + title: dimensions + type: array + description: List of dimensions associated with the plan, each with its own pricing. + items: + $ref: addons_dimension_with_price.yml + +required: + - id + - app_id + - display_name + - slug + - price_per_month + - active + - state + - created_at + - updated_at + - available + - uuid + - by_default diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource.yml new file mode 100644 index 000000000..793c894db --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource.yml @@ -0,0 +1,92 @@ +type: object + +properties: + uuid: + title: uuid + type: string + example: "123e4567-e89b-12d3-a456-426614174000" + description: The unique identifier for the addon resource. + + name: + title: name + type: string + example: "my-resource-01" + description: The name of the addon resource. + + state: + title: state + type: string + enum: + - pending + - provisioning + - provisioned + - deprovisioning + - deprovisioned + - provisioning-failed + - deprovisioning-failed + - suspended + example: "provisioned" + description: The state the resource is currently in. + + app_name: + title: app_name + type: string + example: "Example App" + description: The name of the application associated with the resource. + + app_slug: + title: app_slug + type: string + example: "example_app" + description: The slug identifier for the application associated with the resource. + + plan_name: + title: plan_name + type: string + example: "Basic Plan" + description: The name of the plan associated with the resource. + + plan_slug: + title: plan_slug + type: string + example: "basic_plan" + description: The slug identifier for the plan associated with the resource. + + plan_price_per_month: + title: plan_price_per_month + type: integer + example: 10 + description: The price of the plan per month in US dollars. + + has_config: + title: has_config + type: boolean + example: true + description: Indicates if the resource has configuration values set by the vendor. + + metadata: + title: metadata + type: array + description: Metadata associated with the resource, set by the user. + items: + $ref: './addons_resource_metadata.yml' + + sso_url: + title: sso_url + type: string + example: "https://example.com/sso" + description: The Single Sign-On URL for the resource, if applicable. + + message: + title: message + type: string + example: "Resource is provisioned successfully." + description: A message related to the resource, if applicable. + +required: + - uuid + - name + - state + - app_slug + - plan_slug + - has_config diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_metadata.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_metadata.yml new file mode 100644 index 000000000..ac0bd9b7f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_metadata.yml @@ -0,0 +1,23 @@ +type: object + +properties: + name: + title: name + type: string + example: "property_name" + description: The name of the metadata item to be set. + + value: + example: "example_value" + oneOf: + - title: string_value + type: string + example: "example_value" + - title: boolean_value + type: boolean + example: true + description: The value to be set for the metadata item, which can be a string or boolean. + +required: + - name + - value diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_new.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_new.yml new file mode 100644 index 000000000..d76a3e8a5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/models/addons_resource_new.yml @@ -0,0 +1,45 @@ +type: object + +properties: + app_slug: + title: app_slug + type: string + example: example-app + description: The slug identifier for the application associated with the resource. + + plan_slug: + title: plan_slug + type: string + example: basic_plan + description: The slug identifier for the plan associated with the resource. + + name: + title: name + type: string + example: my-resource-01 + description: The name of the addon resource. + + metadata: + title: metadata + type: array + items: + $ref: addons_resource_metadata.yml + description: Metadata associated with the resource, set by the user. Metadata expected varies per app, and can be verified with a GET request to "/v2/add-ons/apps/{app_slug}/metadata" + + linked_droplet_id: + title: linked_droplet_id + type: integer + example: 12345678 + description: ID of the droplet to be linked to this resource, if applicable. + + fleet_uuid: + title: fleet_uuid + type: string + example: "f1234567-89ab-cdef-0123-456789abcdef01" + description: UUID of the fleet/project to which this resource will belong. + +required: + - app_slug + - plan_slug + - name + - metadata diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/parameters.yml new file mode 100644 index 000000000..3c46e4743 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/parameters.yml @@ -0,0 +1,18 @@ +app_slug: + name: app_slug + in: path + description: The slug identifier for an application. + required: true + schema: + type: string + example: example-app + +resource_uuid: + name: resource_uuid + in: path + description: A unique identifier for the add-on resource. + required: true + schema: + type: string + format: uuid + example: "4de7ac8b-495b-4884-9a69-1050c6793cd6" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_create.yml new file mode 100644 index 000000000..c9a8e1caf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_create.yml @@ -0,0 +1,19 @@ +description: The response will be a JSON object with a key called `resource`. The + value of this will be the resource created with the given. + For additional details specific to the app, find and view its + [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. + +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: + resource: + $ref: '../models/addons_resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get.yml new file mode 100644 index 000000000..277c971aa --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get.yml @@ -0,0 +1,16 @@ +description: The response will be a JSON object with a key called `resource`. + +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: + resource: + $ref: '../models/addons_resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app.yml new file mode 100644 index 000000000..ea5d2dccf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app.yml @@ -0,0 +1,18 @@ +description: The response will be a JSON object with a key called `apps`. `apps` will be an array of objects. + +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: + apps: + type: array + items: + $ref: '../models/addons_app_info.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app_metadata.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app_metadata.yml new file mode 100644 index 000000000..8b9c1e729 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_get_app_metadata.yml @@ -0,0 +1,21 @@ +description: The response will be a JSON object with a key called `metadata`. `metadata` will be an array of objects, each representing a metadata item for the app. + Each object will contain details such as `id`, `name`, `display_name`, `description`, `type`, and `options`. + For additional details specific to the app, find and view its + [DigitalOcean Marketplace](https://marketplace.digitalocean.com) page. + +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: + metadata: + type: array + items: + $ref: '../models/addons_app_metadata.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_list.yml new file mode 100644 index 000000000..1eda84c09 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_list.yml @@ -0,0 +1,18 @@ +description: The response will be an array of JSON objects with a key called `resources`. + +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: + resources: + type: array + items: + $ref: '../models/addons_resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_update.yml new file mode 100644 index 000000000..56e7a7c12 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/addons/responses/addons_update.yml @@ -0,0 +1,16 @@ +description: The response will be a JSON object with a key called `resource`, representing the updated resource. + +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: + resource: + $ref: '../models/addons_resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_job_invocation.yml new file mode 100644 index 000000000..8894dd09b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_job_invocation.yml @@ -0,0 +1,41 @@ +operationId: apps_cancel_job_invocation + +summary: Cancel Job Invocation + +description: Cancel a specific job invocation for an app. + +tags: +- Apps + +parameters: + - $ref: parameters.yml#/app_id + - $ref: parameters.yml#/job_invocation_id + - $ref: parameters.yml#/job_name + +responses: + "200": + $ref: responses/cancel_job_invocation.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/apps_cancel_job_invocation.yml' + - $ref: 'examples/python/apps_cancel_job_invocation.yml' + +security: + - bearer_auth: + - 'app:update' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml index 9a2e90e57..6c00555ac 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml @@ -22,6 +22,9 @@ requestBody: spec: name: web-app region: nyc + disable_edge_cache: true + disable_email_obfuscation: false + enhanced_threat_control_enabled: true services: - name: api github: @@ -36,6 +39,8 @@ requestBody: - path: /api egress: type: DEDICATED_IP + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac required: true responses: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml index 2532d595b..98c31e005 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'app:create' + - 'app:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml index 5baea4905..9d462f866 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml @@ -4,7 +4,7 @@ summary: Retrieve Exec URL for Deployment description: Returns a websocket URL that allows sending/receiving console input and output - to a component of the specified deployment if one exists. + to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them. tags: - Apps @@ -13,6 +13,7 @@ parameters: - $ref: parameters.yml#/app_id - $ref: parameters.yml#/deployment_id - $ref: parameters.yml#/component + - $ref: parameters.yml#/instance_name responses: "200": @@ -39,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - "app:update" + - "app:access_console" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml index 0bba438f2..1f0657238 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml @@ -12,6 +12,7 @@ tags: parameters: - $ref: parameters.yml#/app_id - $ref: parameters.yml#/component + - $ref: parameters.yml#/instance_name responses: "200": @@ -38,4 +39,4 @@ x-codeSamples: security: - bearer_auth: - - "app:update" + - "app:access_console" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_health.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_health.yml new file mode 100644 index 000000000..fc4d77ed8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_health.yml @@ -0,0 +1,38 @@ +operationId: apps_get_health + +summary: Retrieve App Health + +description: Retrieve information like health status, cpu and memory utilization of app components. + +parameters: + - $ref: parameters.yml#/app_id + +tags: +- Apps + +responses: + "200": + $ref: responses/apps_health.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/apps_get_health.yml' + +security: + - bearer_auth: + - 'app:read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instances.yml new file mode 100644 index 000000000..c4c2e2cba --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instances.yml @@ -0,0 +1,37 @@ +operationId: apps_get_instances + +summary: Retrieve App Instances + +description: Retrieve the list of running instances for a given application, including instance names and component types. Please note that these instances are ephemeral and may change over time. It is recommended not to make persistent changes or develop scripts that rely on their persistence. + +parameters: + - $ref: parameters.yml#/app_id + +tags: + - Apps + +responses: + "200": + $ref: responses/apps_instances.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/get_app_instances.yml" + +security: + - bearer_auth: + - "app:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation.yml new file mode 100644 index 000000000..f25ef075f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation.yml @@ -0,0 +1,41 @@ +operationId: apps_get_job_invocation + +summary: Get Job Invocations + +description: Get a specific job invocation for an app. + +tags: +- Apps + +parameters: + - $ref: parameters.yml#/app_id + - $ref: parameters.yml#/job_invocation_id + - $ref: parameters.yml#/job_name + +responses: + "200": + $ref: responses/get_job_invocation.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/apps_get_job_invocation.yml' + - $ref: 'examples/python/apps_get_job_invocation.yml' + +security: + - bearer_auth: + - 'app:read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation_logs.yml new file mode 100644 index 000000000..70722ca27 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_job_invocation_logs.yml @@ -0,0 +1,66 @@ +operationId: apps_get_job_invocation_logs + +summary: Retrieve Job Invocation Logs + +description: Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. If deployment is omitted the active deployment will be selected (if available). The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. + +tags: +- Apps + +parameters: + - $ref: parameters.yml#/app_id + - description: The job name to list job invocations for. + in: path + name: job_name + required: true + schema: + type: string + example: component + - $ref: parameters.yml#/job_invocation_id + - description: The deployment ID + in: query + name: deployment_id + required: false + schema: + type: string + example: 3aa4d20e-5527-4c00-b496-601fbd22520a + - $ref: parameters.yml#/live_updates + - description: The type of logs to retrieve + in: query + name: type + required: true + schema: + type: string + enum: + - JOB_INVOCATION + example: JOB_INVOCATION + - $ref: parameters.yml#/time_wait + - $ref: parameters.yml#/number_lines + +responses: + "200": + $ref: responses/apps_get_logs.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/apps_get_job_invocation_logs.yml' + - $ref: 'examples/python/apps_get_job_invocation_logs.yml' + +security: + - bearer_auth: + - 'app:read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml index 4549855d4..fe6a7796b 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml @@ -11,6 +11,33 @@ parameters: - $ref: parameters.yml#/app_id - $ref: ../../shared/parameters.yml#/page - $ref: ../../shared/parameters.yml#/per_page + - name: deployment_types + description: |- + Optional. Filter deployments by deployment_type + - MANUAL: manual deployment + - DEPLOY_ON_PUSH: deployment triggered by a push to the app's repository + - MAINTENANCE: deployment for maintenance purposes + - MANUAL_ROLLBACK: manual revert to a previous deployment + - AUTO_ROLLBACK: automatic revert to a previous deployment + - UPDATE_DATABASE_TRUSTED_SOURCES: update database trusted sources + - AUTOSCALED: deployment that has been autoscaled + in: query + required: false + schema: + type: array + items: + type: string + enum: + - MANUAL + - DEPLOY_ON_PUSH + - MAINTENANCE + - MANUAL_ROLLBACK + - AUTO_ROLLBACK + - UPDATE_DATABASE_TRUSTED_SOURCES + - AUTOSCALED + example: + - MANUAL + - AUTOSCALED responses: "200": diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_job_invocations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_job_invocations.yml new file mode 100644 index 000000000..ee3f4dd76 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_job_invocations.yml @@ -0,0 +1,49 @@ +operationId: apps_list_job_invocations + +summary: List Job Invocations + +description: List all job invocations for an app. + +tags: +- Apps + +parameters: + - $ref: parameters.yml#/app_id + - $ref: parameters.yml#/job_names + - description: The deployment ID + in: query + name: deployment_id + required: false + schema: + type: string + example: 3aa4d20e-5527-4c00-b496-601fbd22520a + - $ref: ../../shared/parameters.yml#/page + - $ref: ../../shared/parameters.yml#/per_page + +responses: + "200": + $ref: responses/list_job_invocations.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/apps_list_job_invocations.yml' + - $ref: 'examples/python/apps_list_job_invocations.yml' + +security: + - bearer_auth: + - 'app:read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_cancel_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_cancel_job_invocation.yml new file mode 100644 index 000000000..a3fe6193f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_cancel_job_invocation.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancel" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_health.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_health.yml new file mode 100644 index 000000000..1efeb772d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_health.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/apps/{id}/health" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation.yml new file mode 100644 index 000000000..320cfca82 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation.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/apps/{app_id}/job-invocations/{job_invocation_id}" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation_logs.yml new file mode 100644 index 000000000..54c1d0640 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_job_invocation_logs.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/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_list_job_invocations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_list_job_invocations.yml new file mode 100644 index 000000000..575f33493 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_list_job_invocations.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/apps/{app_id}/job-invocations" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/get_app_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/get_app_instances.yml new file mode 100644 index 000000000..d5fa71053 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/get_app_instances.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/apps/{id}/instances" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_cancel_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_cancel_job_invocation.yml new file mode 100644 index 000000000..4ccda7e51 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_cancel_job_invocation.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.apps.cancel_job_invocation(app_id="4f6c71e2", job_invocation_id="3aa4d20e") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation.yml new file mode 100644 index 000000000..0083ff1c9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.apps.get_job_invocation(app_id="4f6c71e2", job_invocation_id="3aa4d20e") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation_logs.yml new file mode 100644 index 000000000..953b6097a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_get_job_invocation_logs.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.apps.get_job_invocation_logs(app_id="4f6c71e2", job_name="component", job_invocation_id="3aa4d20e") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_list_job_invocations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_list_job_invocations.yml new file mode 100644 index 000000000..d7d14e35b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_list_job_invocations.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.apps.list_job_invocations(app_id="4f6c71e2") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml index 712c9ddb8..f22010e89 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/python/apps_update.yml @@ -225,6 +225,8 @@ source: |- "version": "12", } ], - } + “vpc”: { + “id”: “c22d8f48-4bc4-49f5-8ca0-58e7164427ac”, + } } update_resp = client.apps.update(id="bb245ba", body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app.yml index d08ab726b..51812a452 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app.yml @@ -61,6 +61,7 @@ properties: type: string example: 88b72d1a-b78a-4d9f-9090-b53c4399073f title: The ID of the project the app is assigned to. This will be empty if there is a lookup failure. + description: Requires `project:read` scope. region: $ref: apps_region.yml spec: @@ -86,6 +87,8 @@ properties: type: array items: $ref: apps_dedicated_egress_ip.yml + vpc: + $ref: apps_vpc.yml required: - spec type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_alert_spec_rule.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_alert_spec_rule.yml index f8bb9c0f1..ea5199744 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_alert_spec_rule.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_alert_spec_rule.yml @@ -1,18 +1,20 @@ default: UNSPECIFIED_RULE enum: -- UNSPECIFIED_RULE -- CPU_UTILIZATION -- MEM_UTILIZATION -- RESTART_COUNT -- DEPLOYMENT_FAILED -- DEPLOYMENT_LIVE -- DOMAIN_FAILED -- DOMAIN_LIVE -- FUNCTIONS_ACTIVATION_COUNT -- FUNCTIONS_AVERAGE_DURATION_MS -- FUNCTIONS_ERROR_RATE_PER_MINUTE -- FUNCTIONS_AVERAGE_WAIT_TIME_MS -- FUNCTIONS_ERROR_COUNT -- FUNCTIONS_GB_RATE_PER_SECOND + - UNSPECIFIED_RULE + - CPU_UTILIZATION + - MEM_UTILIZATION + - RESTART_COUNT + - DEPLOYMENT_FAILED + - DEPLOYMENT_LIVE + - DOMAIN_FAILED + - DOMAIN_LIVE + - AUTOSCALE_FAILED + - AUTOSCALE_SUCCEEDED + - FUNCTIONS_ACTIVATION_COUNT + - FUNCTIONS_AVERAGE_DURATION_MS + - FUNCTIONS_ERROR_RATE_PER_MINUTE + - FUNCTIONS_AVERAGE_WAIT_TIME_MS + - FUNCTIONS_ERROR_COUNT + - FUNCTIONS_GB_RATE_PER_SECOND type: string example: CPU_UTILIZATION diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health copy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health copy.yml new file mode 100644 index 000000000..1160b67be --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health copy.yml @@ -0,0 +1,29 @@ +type: object +properties: + name: + type: string + example: sample_app + cpu_usage_percent: + type: number + format: double + example: 30 + memory_usage_percent: + type: number + format: double + example: 25 + replicas_desired: + type: integer + format: int64 + example: 1 + replicas_ready: + type: integer + format: int64 + example: 1 + state: + type: string + enum: + - UNKNOWN + - HEALTHY + - UNHEALTHY + default: UNKNOWN + example: HEALTHY diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health.yml new file mode 100644 index 000000000..1160b67be --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health.yml @@ -0,0 +1,29 @@ +type: object +properties: + name: + type: string + example: sample_app + cpu_usage_percent: + type: number + format: double + example: 30 + memory_usage_percent: + type: number + format: double + example: 25 + replicas_desired: + type: integer + format: int64 + example: 1 + replicas_ready: + type: integer + format: int64 + example: 1 + state: + type: string + enum: + - UNKNOWN + - HEALTHY + - UNHEALTHY + default: UNKNOWN + example: HEALTHY diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml index 6b7deba03..38e235e50 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml @@ -29,13 +29,15 @@ properties: - MONGODB - KAFKA - OPENSEARCH + - VALKEY description: |- - MYSQL: MySQL - PG: PostgreSQL - - REDIS: Redis + - REDIS: Caching - MONGODB: MongoDB - KAFKA: Kafka - OPENSEARCH: OpenSearch + - VALKEY: ValKey example: PG name: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_component_health.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_component_health.yml new file mode 100644 index 000000000..ebf99a33b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_component_health.yml @@ -0,0 +1,20 @@ +type: object +properties: + name: + type: string + example: sample_function + functions_component_health_metrics: + type: array + items: + type: object + properties: + metric_label: + type: string + example: activations_count + metric_value: + type: number + format: double + example: 100 + time_window: + type: string + example: 1h diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health.yml new file mode 100644 index 000000000..5693c15c4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health.yml @@ -0,0 +1,10 @@ +type: object +properties: + components: + type: array + items: + "$ref": app_component_health.yml + functions_components: + type: array + items: + "$ref": app_functions_component_health.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_check_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_check_spec.yml new file mode 100644 index 000000000..62e895cf3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_check_spec.yml @@ -0,0 +1,54 @@ +type: object +properties: + failure_threshold: + type: integer + format: int32 + description: The number of failed health checks before considered unhealthy. + minimum: 1 + maximum: 50 + example: 18 + + port: + type: integer + format: int64 + description: The port on which the health check will be performed. + example: 80 + maximum: 65535 + minimum: 1 + + http_path: + type: string + description: The route path used for the HTTP health check ping. If not set, the HTTP health check will be disabled and a TCP health check used instead. + example: /health + + initial_delay_seconds: + type: integer + format: int32 + description: The number of seconds to wait before beginning health checks. + minimum: 0 + maximum: 3600 + example: 30 + + period_seconds: + type: integer + format: int32 + description: The number of seconds to wait between health checks. + minimum: 1 + maximum: 300 + example: 10 + + success_threshold: + type: integer + format: int32 + description: The number of successful health checks before considered healthy. + example: 1 + minimum: 1 + maximum: 1 + + timeout_seconds: + type: integer + format: int32 + description: The number of seconds after which the check times out. + minimum: 1 + maximum: 120 + example: 1 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_response.yml new file mode 100644 index 000000000..551b816c7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_response.yml @@ -0,0 +1,4 @@ +properties: + app_health: + "$ref": app_health.yml +type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_match.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_match.yml index e72750fba..049b79c46 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_match.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_match.yml @@ -1,7 +1,7 @@ type: object properties: path: - $ref: app_ingress_spec_rule_string_match.yml + $ref: app_ingress_spec_rule_string_match_prefix.yml + authority: + $ref: app_ingress_spec_rule_string_match_exact.yml description: The match configuration for the rule. -required: - - path diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_exact.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_exact.yml new file mode 100644 index 000000000..083ff070a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_exact.yml @@ -0,0 +1,9 @@ +type: object +properties: + exact: + type: string + maxLength: 256 + example: "example.com" +description: The authority to match on. +required: + - exact diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_prefix.yml new file mode 100644 index 000000000..3158e91c8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_prefix.yml @@ -0,0 +1,10 @@ +type: object +properties: + prefix: + type: string + description: Prefix-based match. For example, `/api` will match `/api`, `/api/`, and any nested paths such as `/api/v1/endpoint`. + maxLength: 256 + example: /api +description: The path to match on. +required: + - prefix diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instance.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instance.yml new file mode 100644 index 000000000..33e44532e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instance.yml @@ -0,0 +1,22 @@ +type: object +properties: + component_name: + type: string + example: sample-golang + description: Name of the component, from the app spec. + component_type: + type: string + description: Supported compute component by DigitalOcean App Platform. + enum: + - SERVICE + - WORKER + - JOB + example: SERVICE + instance_name: + type: string + description: Name of the instance, which is a unique identifier for the instance. + example: sample-golang-76b84c7fb8-6p8kq + instance_alias: + type: string + description: Readable identifier, an alias of the instance name, reference for mapping insights to instance names. + example: sample-golang-0 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances.yml new file mode 100644 index 000000000..8971d95b9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances.yml @@ -0,0 +1,6 @@ +type: object +properties: + instances: + type: array + items: + "$ref": app_instance.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances_response.yml new file mode 100644 index 000000000..18232beb1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_instances_response.yml @@ -0,0 +1,4 @@ +properties: + instances: + "$ref": app_instances.yml +type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocation.yml new file mode 100644 index 000000000..c777973d2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocation.yml @@ -0,0 +1,99 @@ +type: object +properties: + id: + type: string + title: The ID of the job invocation + example: "ba32b134-569c-4c0c-ba02-8ffdb0492ece" + job_name: + type: string + title: The name of the job this invocation belongs to. + example: "good-job" + deployment_id: + type: string + title: The deployment ID this job invocation belongs to. + example: "c020763f-ddb7-4112-a0df-7f01c69fc00b" + phase: + type: string + description: The phase of the job invocation + enum: + - UNKNOWN + - PENDING + - RUNNING + - SUCCEEDED + - FAILED + - CANCELED + - SKIPPED + example: SUCCEEDED + trigger: + title: The JobInvocation Trigger + type: object + properties: + type: + type: string + description: The type of trigger that initiated the job invocation. + default: UNKNOWN + enum: + - MANUAL + - SCHEDULE + - UNKNOWN + example: MANUAL + scheduled: + type: object + description: The schedule for the job + properties: + schedule: + type: object + properties: + cron: + type: string + description: The cron expression defining the schedule + example: "0 0 * * *" + time_zone: + type: string + description: The time zone for the schedule + example: "America/New_York" + example: + schedule: + cron: "0 0 * * *" + time_zone: "America/New_York" + manual: + type: object + description: Details about the manual trigger, if applicable + properties: + user: + type: object + properties: + uuid: + type: string + title: The ID of the user who triggered the job + example: "550e8400-e29b-41d4-a716-446655440000" + email: + type: string + format: email + title: The email of the user who triggered the job + example: "user@example.com" + full_name: + type: string + title: The name of the user who triggered the job + example: "John Doe" + description: The user who triggered the job + example: + user: + uuid: "550e8400-e29b-41d4-a716-446655440000" + email: "user@example.com" + full_name: "John Doe" + created_at: + type: string + format: date-time + title: The time when the job invocation was created + example: "2023-10-01T12:00:00Z" + started_at: + type: string + format: date-time + title: The time when the job invocation started + example: "2023-10-01T12:05:00Z" + completed_at: + type: string + format: date-time + title: The time when the job invocation completed + example: "2023-10-01T12:10:00Z" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocations.yml new file mode 100644 index 000000000..2f32a1800 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_job_invocations.yml @@ -0,0 +1,9 @@ +allOf: + - type: object + properties: + job_invocations: + title: A list of job invocations + type: array + items: + $ref: app_job_invocation.yml + - $ref: ../../../shared/pages.yml#/pagination \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml index 275198b8b..083a74a9b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_log_destination_open_search_spec_basic_auth.yml @@ -7,6 +7,7 @@ properties: Defaults to `doadmin` when `cluster_name` is set. example: apps_user password: + type: string description: |- Password for user defined in User. Is required when `endpoint` is set. Cannot be set if using a DigitalOcean DBaaS OpenSearch cluster. 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 index af01cb0b3..624c59879 100644 --- 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 @@ -7,7 +7,7 @@ properties: 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. + description: Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. example: true offline_page_url: type: string 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 c91d26469..8ecc4ccfb 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,9 @@ allOf: health_check: $ref: app_service_spec_health_check.yml + liveness_health_check: + $ref: app_health_check_spec.yml + protocol: type: string 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 07a38ba19..2c89ced09 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 @@ -15,17 +15,40 @@ properties: available`' type: string enum: - - ams + - atl - nyc - - fra - sfo - - sgp - - blr - tor + - ams + - fra - lon + - blr + - sgp - syd example: nyc + disable_edge_cache: + description: |- + If set to `true`, the app will **not** be cached at the edge (CDN). Enable this option if you want to manage CDN configuration yourself—whether by using an external CDN provider or by handling static content and caching within your app. This setting is also recommended for apps that require real-time data or serve dynamic content, such as those using Server-Sent Events (SSE) over GET, or hosting an MCP (Model Context Protocol) Server that utilizes SSE. + **Note:** This feature is not available for static site components. + For more information, see [Disable CDN Cache](https://docs.digitalocean.com/products/app-platform/how-to/cache-content/#disable-cdn-cache). + + type: boolean + default: false + + disable_email_obfuscation: + description: |- + If set to `true`, email addresses in the app will not be obfuscated. This is + useful for apps that require email addresses to be visible (in the HTML markup). + type: boolean + default: false + + enhanced_threat_control_enabled: + description: |- + If set to `true`, suspicious requests will go through additional security checks to help mitigate layer 7 DDoS attacks. + type: boolean + default: false + domains: description: A set of hostnames where the application will be available. type: array @@ -79,6 +102,9 @@ properties: maintenance: $ref: app_maintenance_spec.yml + + vpc: + $ref: apps_vpc.yml required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_worker_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_worker_spec.yml index d1e554d61..84a460ec7 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_worker_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_worker_spec.yml @@ -5,6 +5,8 @@ allOf: properties: termination: $ref: app_worker_spec_termination.yml + liveness_health_check: + $ref: app_health_check_spec.yml required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_create_app_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_create_app_request.yml index ec9d92fbf..ae66f1e38 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_create_app_request.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_create_app_request.yml @@ -3,7 +3,9 @@ properties: $ref: app_spec.yml project_id: type: string - description: The ID of the project the app should be assigned to. If omitted, it will be assigned to your default project. + description: | + The ID of the project the app should be assigned to. If omitted, it will be assigned to your default project. +

Requires `project:update` scope. required: - spec type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_deployment.yml index 5d8b76212..4afe449cb 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_deployment.yml @@ -51,7 +51,7 @@ properties: readOnly: true title: The current pricing tier slug of the deployment type: string - example: basic + example: basic updated_at: format: date-time title: When the deployment was last updated diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc.yml new file mode 100644 index 000000000..c65054f06 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc.yml @@ -0,0 +1,12 @@ +type: object +readOnly: true +properties: + id: + title: The ID of the VPC. + type: string + example: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + title: The egress ips associated with the VPC. + type: array + items: + $ref: apps_vpc_egress_ip.yml \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc_egress_ip.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc_egress_ip.yml new file mode 100644 index 000000000..e9921b1c7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_vpc_egress_ip.yml @@ -0,0 +1,5 @@ +type: object +properties: + ip: + type: string + example: 10.0.0.1 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml index 47be6d308..19cf10671 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml @@ -6,8 +6,8 @@ accept: schema: type: string enum: - - application/json - - application/yaml + - application/json + - application/yaml example: application/json content-type: @@ -18,8 +18,8 @@ content-type: schema: type: string enum: - - application/json - - application/yaml + - application/json + - application/yaml example: application/json app_id: @@ -67,7 +67,8 @@ slug_size: example: apps-s-1vcpu-0.5gb component: - description: An optional component name. If set, logs will be limited to this component + description: + An optional component name. If set, logs will be limited to this component only. in: path name: component_name @@ -105,17 +106,18 @@ log_type: schema: default: UNSPECIFIED enum: - - UNSPECIFIED - - BUILD - - DEPLOY - - RUN - - RUN_RESTARTED + - UNSPECIFIED + - BUILD + - DEPLOY + - RUN + - RUN_RESTARTED type: string example: BUILD time_wait: - description: 'An optional time duration to wait if the underlying component instance - is not immediately available. Default: `3m`.' + description: + "An optional time duration to wait if the underlying component instance + is not immediately available. Default: `3m`." in: query name: pod_connection_timeout schema: @@ -139,3 +141,53 @@ alert_id: schema: type: string example: 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d + +instance_name: + description: The name of the actively running ephemeral compute instance + in: query + name: instance_name + required: false + schema: + type: string + example: go-app-d768568df-zz77d + +job_name: + description: The job name to list job invocations for. + in: query + name: job_name + required: false + schema: + type: string + example: component + +job_names: + description: + The job names to list job invocations for. + in: query + name: job_names + required: false + schema: + type: array + items: + $ref: '#/job_name/schema' + example: [component1, component2] + +job_invocation_id: + description: + The ID of the job invocation to retrieve. + in: path + name: job_invocation_id + required: true + schema: + type: string + example: 123e4567-e89b-12d3-a456-426 + +number_lines: + description: The number of lines from the end of the logs to retrieve. + in: query + name: tail_lines + required: false + schema: + type: string + format: int64 + example: "100" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_get_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_get_logs.yml new file mode 100644 index 000000000..7ca3867fb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_get_logs.yml @@ -0,0 +1,18 @@ +description: A JSON object with urls that point to Job Invocation logs + +content: + application/json: + schema: + $ref: ../models/apps_get_logs_response.yml + examples: + logs: + $ref: examples.yml#/logs + +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 + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_health.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_health.yml new file mode 100644 index 000000000..283cc8d61 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_health.yml @@ -0,0 +1,17 @@ +description: A JSON with key `app_health` + +content: + application/json: + schema: + $ref: ../models/app_health_response.yml + examples: + app_health: + $ref: examples.yml#/app_health + +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 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_instances.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_instances.yml new file mode 100644 index 000000000..10d5991a5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/apps_instances.yml @@ -0,0 +1,17 @@ +description: A JSON with key `instances` + +content: + application/json: + schema: + $ref: ../models/app_instances.yml + examples: + app_instances: + $ref: examples.yml#/app_instances + +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 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/cancel_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/cancel_job_invocation.yml new file mode 100644 index 000000000..1b146458d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/cancel_job_invocation.yml @@ -0,0 +1,17 @@ +description: A JSON with key `job_invocation` + +content: + application/json: + schema: + $ref: ../models/app_job_invocation.yml + examples: + job_invocation: + $ref: examples.yml#/job_invocation + +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 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml index a5994aeca..a293f772b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/examples.yml @@ -22,6 +22,10 @@ apps: type: "PRIMARY" zone: "example.com" minimum_tls_version: "1.3" + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 default_ingress: https://sample-php-iaj87.ondigitalocean.app created_at: 2020-11-19T20:27:18Z updated_at: 2020-12-01T00:42:16Z @@ -47,6 +51,10 @@ apps: type: "PRIMARY" zone: "example.com" minimum_tls_version: "1.3" + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 services: - name: sample-php source_commit_hash: 54d4a727f457231062439895000d45437c7bb405 @@ -76,6 +84,10 @@ apps: type: "PRIMARY" zone: "example.com" minimum_tls_version: "1.3" + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 services: - name: sample-php source_commit_hash: 54d4a727f457231062439895000d45437c7bb405 @@ -199,6 +211,10 @@ apps: - ip: 192.168.1.2 id: 4768fb15-2837-4dda-9be5-3951df4bc3d0 status: ASSIGNED + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 links: pages: {} meta: @@ -212,6 +228,8 @@ app: owner_uuid: a4e16f25-cdd1-4483-b246-d77f283c9209 spec: name: sample-golang + disable_edge_cache: true + enhanced_threat_control_enabled: true services: - name: web github: @@ -229,6 +247,10 @@ app: - domain: "sample-golang.example.com" zone: "example.com" minimum_tls_version: "1.3" + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 default_ingress: https://sample-golang-zyhgn.ondigitalocean.app created_at: '2021-02-10T16:45:14Z' updated_at: '2021-02-10T17:06:56Z' @@ -253,6 +275,10 @@ app: - domain: "sample-golang.example.com" zone: "example.com" minimum_tls_version: "1.3" + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 services: - name: web source_commit_hash: db6936cb46047c576962962eed81ad52c21f35d7 @@ -338,6 +364,10 @@ app: type: "PRIMARY" zone: "example.com" minimum_tls_version: "1.3" + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 region: slug: ams label: Amsterdam @@ -428,6 +458,10 @@ app: - ip: 192.168.1.2 id: 4768fb15-2837-4dda-9be5-3951df4bc3d0 status: ASSIGNED + vpc: + id: c22d8f48-4bc4-49f5-8ca0-58e7164427ac + egress_ips: + - ip: 10.0.0.1 deployments: @@ -436,6 +470,9 @@ deployments: - id: b6bdf840-2854-4f87-a36c-5f231c617c84 spec: name: sample-golang + disable_edge_cache: true + disable_email_obfuscation: true + enhanced_threat_control_enabled: true services: - name: web github: @@ -507,6 +544,9 @@ deployment: id: b6bdf840-2854-4f87-a36c-5f231c617c84 spec: name: sample-golang + disable_edge_cache: true + disable_email_obfuscation: true + enhanced_threat_control_enabled: true services: - name: web github: @@ -912,3 +952,77 @@ app_bandwidth_usage_multiple: - app_id: c2a93513-8d9b-4223-9d61-5e7272c81cf5 bandwidth_bytes: '254847' date: 2023-01-17T00:00:00Z + +app_health: + value: + components: + - name: sample-expressjs + cpu_usage_percent: 5.555 + memory_usage_percent: 20.32 + replicas_desired: 1 + replicas_ready: 2 + state: HEALTHY +app_instances: + value: + instances: + - component_name: sample-golang + instance_name: sample-golang-76b84c7fb8-6p8kq + instance_alias: sample-golang-0 + component_type: SERVICE + - component_name: sample-golang + instance_name: sample-golang-76b84c7fb8-ngvpc + instance_alias: sample-golang-1 + component_type: SERVICE + - component_name: sample-php + instance_name: sample-php-767c6b49c4-dkgpt + instance_alias: sample-php-0 + component_type: SERVICE + - component_name: sample-php + instance_name: sample-php-767c6b49c4-z8dll + instance_alias: sample-php-1 + component_type: SERVICE + +job_invocations: + value: + job_invocations: + - id: ba32b134-569c-4c0c-ba02-8ffdb0492ece + job_name: good-job + deployment_id: c020763f-ddb7-4112-a0df-7f01c69fc00b + phase: SUCCEEDED + created_at: "2025-09-11T11:04:05Z" + started_at: "2025-09-11T11:04:10Z" + completed_at: "2025-09-11T11:04:40Z" + trigger: + type: SCHEDULE + properties: + type: + type: string + scheduled: + type: object + properties: + schedule: + type: object + properties: + cron: + type: string + example: "*/2 * * * *" + time_zone: + type: string + example: "UTC" + +job_invocation: + value: + job_invocation: + - id: ba32b134-569c-4c0c-ba02-8ffdb0492ece + job_name: good-job + deployment_id: c020763f-ddb7-4112-a0df-7f01c69fc00b + phase: SUCCEEDED + created_at: "2025-09-11T11:04:05Z" + started_at: "2025-09-11T11:04:10Z" + completed_at: "2025-09-11T11:04:40Z" + trigger: + - type: SCHEDULED + scheduled: + - schedule: + cron: "*/2 * * * *" + time_zone: UTC \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_job_invocation.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_job_invocation.yml new file mode 100644 index 000000000..1b146458d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/get_job_invocation.yml @@ -0,0 +1,17 @@ +description: A JSON with key `job_invocation` + +content: + application/json: + schema: + $ref: ../models/app_job_invocation.yml + examples: + job_invocation: + $ref: examples.yml#/job_invocation + +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 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/list_job_invocations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/list_job_invocations.yml new file mode 100644 index 000000000..5fb3338b1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/responses/list_job_invocations.yml @@ -0,0 +1,17 @@ +description: A JSON with key `job_invocations` + +content: + application/json: + schema: + $ref: ../models/app_job_invocations.yml + examples: + job_invocations: + $ref: examples.yml#/job_invocations + +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 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml index 990d132b7..1c5ba4fd5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/autoscale_pools/models/autoscale_pool_droplet_template.yml @@ -43,7 +43,9 @@ properties: type: string example: - "88:66:90:d2:68:d5:b5:85:e3:26:26:11:31:57:e6:f8" - description: The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. + description: | + The SSH keys to be installed on the Droplets in the autoscale pool. You can either specify the key ID or the fingerprint. + Requires `ssh_key:read` scope. tags: type: array @@ -51,11 +53,15 @@ properties: type: string example: - my-tag - description: The tags to apply to each of the Droplets in the autoscale pool. + description: | + The tags to apply to each of the Droplets in the autoscale pool. + Requires `tag:read` scope. vpc_uuid: type: string - description: The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. + description: | + The VPC where the Droplets in the autoscale pool will be created. The VPC must be in the region where you want to create the Droplets. + Requires `vpc:read` scope. example: 760e09ef-dc84-11e8-981e-3cfdfeaae000 with_droplet_agent: @@ -65,7 +71,9 @@ properties: project_id: type: string - description: The project that the Droplets in the autoscale pool will belong to. + description: | + The project that the Droplets in the autoscale pool will belong to. + Requires `project:read` scope. example: 746c6152-2fa2-11ed-92d3-27aaa54e4988 ipv6: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingInsights_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingInsights_list.yml new file mode 100644 index 000000000..39d0df9fe --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingInsights_list.yml @@ -0,0 +1,44 @@ +operationId: billingInsights_list + +summary: List Billing Insights + +description: >- + + This endpoint returns day-over-day changes in billing resource usage based on nightly invoice items, including total amount, region, SKU, and description for a specified date range. It is important to note that the daily resource usage may not reflect month-end billing totals when totaled for a given month as nightly invoice item estimates do not necessarily encompass all invoicing factors for the entire month. + +tags: + - Billing + +parameters: + - $ref: 'parameters.yml#/account_urn' + - $ref: 'parameters.yml#/start_date' + - $ref: 'parameters.yml#/end_date' + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/billing_insights.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/billingInsights_list.yml' + - $ref: 'examples/python/billingInsights_list.yml' + +security: + - bearer_auth: + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/curl/billingInsights_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/curl/billingInsights_list.yml new file mode 100644 index 000000000..3e6c4a1ca --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/curl/billingInsights_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/billing/do:team:12345678-1234-1234-1234-123456789012/insights/2025-01-01/2025-01-31?per_page=20&page=1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/python/billingInsights_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/python/billingInsights_list.yml new file mode 100644 index 000000000..5a9dca032 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/examples/python/billingInsights_list.yml @@ -0,0 +1,14 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + insights = client.billing.list_insights( + account_urn="do:team:12345678-1234-1234-1234-123456789012", + start_date="2025-01-01", + end_date="2025-01-31", + per_page=100, + page=1 + ) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/billing_data_point.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/billing_data_point.yml new file mode 100644 index 000000000..da2ae64e6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/billing_data_point.yml @@ -0,0 +1,38 @@ +type: object + +properties: + usage_team_urn: + type: string + description: URN of the team that incurred the usage + example: 'do:team:12345678-1234-1234-1234-123456789012' + + start_date: + type: string + format: date + description: Start date of the billing data point in YYYY-MM-DD format + example: '2025-01-15' + + total_amount: + type: string + description: Total amount for this data point in USD + example: '12.45' + + region: + type: string + description: Region where the usage occurred + example: 'nyc3' + + sku: + type: string + description: Unique SKU identifier for the billed resource + example: '1-DO-DROP-0109' + + description: + type: string + description: Description of the billed resource or service as shown on an invoice item + example: 'droplet name (c-2-4GiB)' + + group_description: + type: string + description: Optional invoice item group name of the billed resource or service, blank when not part an invoice item group + example: 'kubernetes cluster name' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/parameters.yml index eeb55bfda..4e8d901de 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/parameters.yml @@ -5,4 +5,33 @@ invoice_uuid: schema: type: string example: 22737513-0ea7-4206-8ceb-98a575af7681 - required: true \ No newline at end of file + required: true + +account_urn: + name: account_urn + description: URN of the customer account, can be a team (do:team:uuid) or an organization (do:teamgroup:uuid) + in: path + schema: + type: string + example: do:team:12345678-1234-1234-1234-123456789012 + required: true + +start_date: + name: start_date + description: Start date for billing insights in YYYY-MM-DD format + in: path + schema: + type: string + format: date + example: '2025-01-01' + required: true + +end_date: + name: end_date + description: End date for billing insights in YYYY-MM-DD format. Must be within 31 days of start_date + in: path + schema: + type: string + format: date + example: '2025-01-31' + required: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/billing_insights.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/billing_insights.yml new file mode 100644 index 000000000..7ed98ae8a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/billing_insights.yml @@ -0,0 +1,64 @@ +description: >- + The response will be a JSON object that contains a list of billing data points + under the `data_points` key, along with pagination metadata including + `total_items`, `total_pages`, and `current_page`. + +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: + data_points: + type: array + description: Array of billing data points, which are day-over-day changes in billing resource usage based on nightly invoice item estimates, for the requested period + items: + $ref: '../models/billing_data_point.yml' + + total_items: + type: integer + description: Total number of items available across all pages + example: 250 + + total_pages: + type: integer + description: Total number of pages available + example: 3 + + current_page: + type: integer + description: Current page number + example: 1 + + required: + - data_points + - total_items + - total_pages + - current_page + + example: + data_points: + - usage_team_urn: 'do:team:12345678-1234-1234-1234-123456789012' + start_date: '2025-01-01' + total_amount: '0.86' + region: 'nyc3' + sku: '1-DO-DROP-0109' + description: 'droplet name (c-2-4GiB)' + group_description: '' + - usage_team_urn: 'do:team:12345678-1234-1234-1234-123456789012' + start_date: '2025-01-01' + total_amount: '2.57' + region: 'nyc3' + sku: '1-KS-K8SWN-00109' + description: '3 nodes - 4 GB / 2 vCPU / 80 GB SSD' + group_description: 'kubernetes cluster name' + total_items: 2 + total_pages: 1 + current_page: 1 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice.yml index 2e7c74655..bc74ca9b5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice.yml @@ -1,6 +1,7 @@ description: >- The response will be a JSON object with a key called `invoice_items`. - This will be set to an array of invoice item objects. + This will be set to an array of invoice item objects. All resources will + be shown on invoices, regardless of permissions. headers: ratelimit-limit: @@ -51,4 +52,4 @@ content: next: https://api.digitalocean.com/v2/customers/my/invoices/22737513-0ea7-4206-8ceb-98a575af7681?page=2&per_page=2 last: https://api.digitalocean.com/v2/customers/my/invoices/22737513-0ea7-4206-8ceb-98a575af7681?page=3&per_page=2 meta: - total: 6 \ No newline at end of file + total: 6 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefix_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefix_list_resources.yml new file mode 100644 index 000000000..80cbe3c6c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefix_list_resources.yml @@ -0,0 +1,37 @@ +operationId: byoipPrefixes_list_resources + +summary: "List BYOIP Prefix Resources" + +description: | + To list resources associated with BYOIP prefixes, send a GET request to `/v2/byoip_prefixes/{byoip_prefix_uuid}/ips`. + + A successful response will return a list of resources associated with the specified BYOIP prefix. + +tags: + - "BYOIP Prefixes" + +parameters: + - $ref: "parameters.yml#/byoip_prefix" + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + "200": + $ref: "responses/byoip_prefix_list_resources.yml#/byoip_prefix_list_resources" + "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/byoip_prefix_list_resources.yml" + - $ref: "examples/go/byoip_prefix_list_resources.yml" + - $ref: "examples/python/byoip_prefix_list_resources.yml" +security: + - bearer_auth: + - "byoip_prefix:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_create.yml new file mode 100644 index 000000000..a3acdc769 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_create.yml @@ -0,0 +1,42 @@ +operationId: byoipPrefixes_create + +summary: "Create a BYOIP Prefix" + +description: | + To create a BYOIP prefix, send a POST request to `/v2/byoip_prefixes`. + + A successful request will initiate the process of bringing your BYOIP Prefix into your account. + The response will include the details of the created prefix, including its UUID and status. + +tags: + - "BYOIP Prefixes" + +requestBody: + required: true + content: + application/json: + schema: + $ref: "models/byoip_prefix_create.yml#/byoip_prefix_create" + +responses: + "202": + $ref: "responses/byoip_prefix_create.yml#/byoip_prefix_create" + "401": + $ref: "../../shared/responses/unauthorized.yml" + "422": + $ref: "../../shared/responses/unprocessable_entity.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/create_byoip_prefix.yml" + - $ref: "examples/go/create_byoip_prefix.yml" + - $ref: "examples/python/create_byoip_prefix.yml" + +security: + - bearer_auth: + - "byoip_prefix:create" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_delete.yml new file mode 100644 index 000000000..53e0ad1be --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_delete.yml @@ -0,0 +1,41 @@ +operationId: byoipPrefixes_delete + +summary: "Delete a BYOIP Prefix" + +description: | + To delete a BYOIP prefix and remove it from your account, send a DELETE request + to `/v2/byoip_prefixes/$byoip_prefix_uuid`. + + A successful request will receive a 202 status code with no body in response. + This indicates that the request was accepted and the prefix is being deleted. + +tags: + - "BYOIP Prefixes" + +parameters: + - $ref: "parameters.yml#/byoip_prefix" + +responses: + "202": + $ref: "../../shared/responses/no_content.yml" + "401": + $ref: "../../shared/responses/unauthorized.yml" + "404": + $ref: "../../shared/responses/not_found.yml" + "422": + $ref: "../../shared/responses/unprocessable_entity.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/delete_byoip_prefix.yml" + - $ref: "examples/go/delete_byoip_prefix.yml" + - $ref: "examples/python/delete_byoip_prefix.yml" + +security: + - bearer_auth: + - "byoip_prefix:delete" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_get.yml new file mode 100644 index 000000000..c16e72329 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_get.yml @@ -0,0 +1,38 @@ +operationId: byoipPrefixes_get + +summary: "Get a BYOIP Prefix" + +description: | + To get a BYOIP prefix, send a GET request to `/v2/byoip_prefixes/$byoip_prefix_uuid`. + + A successful response will return the details of the specified BYOIP prefix. +tags: + - "BYOIP Prefixes" + +parameters: + - $ref: "parameters.yml#/byoip_prefix" + +responses: + "200": + $ref: "responses/byoip_prefix_get.yml#/byoip_prefix_get" + "401": + $ref: "../../shared/responses/unauthorized.yml" + "404": + $ref: "../../shared/responses/not_found.yml" + "422": + $ref: "../../shared/responses/unprocessable_entity.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/get_byoip_prefix.yml" + - $ref: "examples/go/get_byoip_prefix.yml" + - $ref: "examples/python/get_byoip_prefix.yml" + +security: + - bearer_auth: + - "byoip_prefix:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_list.yml new file mode 100644 index 000000000..cd7cd8dbc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_list.yml @@ -0,0 +1,33 @@ +operationId: byoipPrefixes_list +summary: "List BYOIP Prefixes" +description: | + To list all BYOIP prefixes, send a GET request to `/v2/byoip_prefixes`. + A successful response will return a list of all BYOIP prefixes associated with the account. + +tags: + - "BYOIP Prefixes" + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + "200": + $ref: "responses/byoip_prefix_list.yml#/byoip_prefix_list" + "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/list_byoip_prefixes.yml" + - $ref: "examples/go/list_byoip_prefixes.yml" + - $ref: "examples/python/list_byoip_prefixes.yml" + +security: + - bearer_auth: + - "byoip_prefix:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_update.yml new file mode 100644 index 000000000..e87e9fccc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/byoip_prefixes_update.yml @@ -0,0 +1,54 @@ +operationId: byoipPrefixes_patch + +summary: "Update a BYOIP Prefix" + +description: | + To update a BYOIP prefix, send a PATCH request to `/v2/byoip_prefixes/$byoip_prefix_uuid`. + + Currently, you can update the advertisement status of the prefix. + The response will include the updated details of the prefix. + +tags: + - "BYOIP Prefixes" + +parameters: + - in: path + name: byoip_prefix_uuid + schema: + type: string + format: uuid + required: true + description: A unique identifier for a BYOIP prefix. + example: "f47ac10b-58cc-4372-a567-0e02b2c3d479" + +requestBody: + required: true + content: + application/json: + schema: + $ref: "models/byoip_prefix_update.yml#/byoip_prefix_update" + +responses: + "202": + $ref: "responses/byoip_prefix_update.yml#/byoip_prefix_update" + "401": + $ref: "../../shared/responses/unauthorized.yml" + "404": + $ref: "../../shared/responses/not_found.yml" + "422": + $ref: "../../shared/responses/unprocessable_entity.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/update_byoip_prefix.yml" + - $ref: "examples/go/update_byoip_prefix.yml" + - $ref: "examples/python/update_byoip_prefix.yml" + +security: + - bearer_auth: + - "byoip_prefix:write" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/byoip_prefix_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/byoip_prefix_list_resources.yml new file mode 100644 index 000000000..8c040b3bf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/byoip_prefix_list_resources.yml @@ -0,0 +1,4 @@ +lang: cURL +source: |- + curl -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/byoip_prefixes/fa3b-1234-5678-90ab-cdef01234567/ips" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/create_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/create_byoip_prefix.yml new file mode 100644 index 000000000..0a407a395 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/create_byoip_prefix.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"prefix": "203.0.113.0/24", "region": "nyc3", "signature": "$SIGNATURE"}' \ + "https://api.digitalocean.com/v2/byoip_prefixes" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/delete_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/delete_byoip_prefix.yml new file mode 100644 index 000000000..1cec23a47 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/delete_byoip_prefix.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/byoip_prefixes/fa3b-1234-5678-90ab-cdef01234567" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/get_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/get_byoip_prefix.yml new file mode 100644 index 000000000..594acf309 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/get_byoip_prefix.yml @@ -0,0 +1,4 @@ +lang: cURL +source: |- + curl -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/byoip_prefixes/fa3b-1234-5678-90ab-cdef01234567" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/list_byoip_prefixes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/list_byoip_prefixes.yml new file mode 100644 index 000000000..b418fe7e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/list_byoip_prefixes.yml @@ -0,0 +1,4 @@ +lang: cURL +source: |- + curl -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/byoip_prefixes" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/update_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/update_byoip_prefix.yml new file mode 100644 index 000000000..52e3307e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/curl/update_byoip_prefix.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"advertise": true}' \ + "https://api.digitalocean.com/v2/byoip_prefixes/$BYOIP_PREFIX_UUID" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/byoip_prefix_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/byoip_prefix_list_resources.yml new file mode 100644 index 000000000..f701f0e00 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/byoip_prefix_list_resources.yml @@ -0,0 +1,23 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + + resources, _, err := client.BYOIPPrefixes.GetResources(ctx, "fa3b-1234-5678-90ab-cdef01234567", &godo.ListOptions{ + Page: 1, + PerPage: 20, + }) + if err != nil { + panic(err) + } + // use resources + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/create_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/create_byoip_prefix.yml new file mode 100644 index 000000000..5fff1248d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/create_byoip_prefix.yml @@ -0,0 +1,27 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + signatureHash := "" + + createRequest := &godo.BYOIPPrefixCreateReq{ + Prefix: "203.0.113.0/24", + Region: "nyc3", + Signature: signatureHash, + } + + byoipPrefix, _, err := client.BYOIPPrefixes.Create(ctx, createRequest) + if err != nil { + panic(err) + } + // use byoipPrefix + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/delete_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/delete_byoip_prefix.yml new file mode 100644 index 000000000..dfe5d8812 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/delete_byoip_prefix.yml @@ -0,0 +1,18 @@ +lang: Go +source: |- + import ( + "context" + "os" + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + + _, err := client.BYOIPPrefixes.Delete(ctx, "fa3b-1234-5678-90ab-cdef01234567") + if err != nil { + panic(err) + } + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/get_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/get_byoip_prefix.yml new file mode 100644 index 000000000..f7c1a8bb5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/get_byoip_prefix.yml @@ -0,0 +1,19 @@ +lang: Go +source: |- + import ( + "context" + "os" + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + + byoipPrefix, _, err := client.BYOIPPrefixes.Get(ctx, "fa3b-1234-5678-90ab-cdef01234567") + if err != nil { + panic(err) + } + // use byoipPrefix + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/list_byoip_prefixes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/list_byoip_prefixes.yml new file mode 100644 index 000000000..799b7ff7c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/list_byoip_prefixes.yml @@ -0,0 +1,23 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + + byoipPrefixes, _, err := client.BYOIPPrefixes.List(ctx, &godo.ListOptions{ + Page: 1, + PerPage: 10, + }) + if err != nil { + panic(err) + } + // use byoipPrefixes + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/update_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/update_byoip_prefix.yml new file mode 100644 index 000000000..c606f5310 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/go/update_byoip_prefix.yml @@ -0,0 +1,26 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + byoipPrefixUUID := "f47ac10b-58cc-4372-a567-0e02b2c3d479" + + advertise := true + updateRequest := &godo.BYOIPPrefixUpdateReq{ + Advertise: &advertise, + } + + byoipPrefix, _, err := client.BYOIPPrefixes.Update(ctx, byoipPrefixUUID, updateRequest) + if err != nil { + panic(err) + } + // use byoipPrefix + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/byoip_prefix_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/byoip_prefix_list_resources.yml new file mode 100644 index 000000000..784857869 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/byoip_prefix_list_resources.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.byoip_prefixes.resources_list(byoip_prefix_uuid="fa3b-1234-5678-90ab-cdef01234567") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/create_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/create_byoip_prefix.yml new file mode 100644 index 000000000..0b89ca2b8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/create_byoip_prefix.yml @@ -0,0 +1,14 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "prefix": "203.0.113.0/24", + "region": "nyc3", + "signature": "", + } + + resp = client.byoip_prefixes.create(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/delete_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/delete_byoip_prefix.yml new file mode 100644 index 000000000..36372a54c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/delete_byoip_prefix.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.byoip_prefixes.delete(byoip_prefix_uuid="fa3b-1234-5678-90ab-cdef01234567") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/get_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/get_byoip_prefix.yml new file mode 100644 index 000000000..b12b33f28 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/get_byoip_prefix.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.byoip_prefixes.get(byoip_prefix_uuid="fa3b-1234-5678-90ab-cdef01234567") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/list_byoip_prefixes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/list_byoip_prefixes.yml new file mode 100644 index 000000000..af412e61f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/list_byoip_prefixes.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.byoip_prefixes.list() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/update_byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/update_byoip_prefix.yml new file mode 100644 index 000000000..cf8621bf0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/examples/python/update_byoip_prefix.yml @@ -0,0 +1,14 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + byoip_prefix_uuid = "f47ac10b-58cc-4372-a567-0e02b2c3d479" + + req = { + "advertise": True, + } + + resp = client.byoip_prefixes.update(byoip_prefix_uuid=byoip_prefix_uuid, body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix.yml new file mode 100644 index 000000000..fe4d370c1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix.yml @@ -0,0 +1,57 @@ +byoip_prefix: + type: object + properties: + uuid: + type: string + description: Unique identifier for the BYOIP prefix + example: "f47ac10b-58cc-4372-a567-0e02b2c3d479" + name: + type: string + description: Name of the BYOIP prefix + example: "" + prefix: + type: string + description: The IP prefix in CIDR notation + example: "203.0.113.0/24" + status: + type: string + description: Status of the BYOIP prefix + example: "active" + region: + type: string + description: Region where the BYOIP prefix is located + example: "nyc3" + validations: + type: array + description: List of validation statuses for the BYOIP prefix + items: + type: object + properties: + name: + type: string + description: Name of the validation + example: "SIGNATURE HASH" + status: + type: string + description: Status of the validation + example: "FAILED" + note: + type: string + description: Additional notes or details about the validation + example: "" + failure_reason: + type: string + description: Reason for failure, if applicable + example: "" + locked: + type: boolean + description: Whether the BYOIP prefix is locked + example: false + advertised: + type: boolean + description: Whether the BYOIP prefix is being advertised + example: true + project_id: + type: string + description: The ID of the project associated with the BYOIP prefix + example: "12345678-1234-1234-1234-123456789012" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_create.yml new file mode 100644 index 000000000..29da60ced --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_create.yml @@ -0,0 +1,19 @@ +byoip_prefix_create: + type: object + properties: + prefix: + type: string + description: The IP prefix in CIDR notation to bring + example: '203.11.13.0/24' + region: + type: string + description: The region where the prefix will be created + example: 'nyc3' + signature: + type: string + description: The signature hash for the prefix creation request + example: '' + required: + - prefix + - region + - signature diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_resource.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_resource.yml new file mode 100644 index 000000000..866cfde3d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_resource.yml @@ -0,0 +1,25 @@ +byoip_prefix_resource: + type: object + properties: + id: + type: integer + format: int64 + description: Unique identifier for the allocation + example: 10001 + byoip: + type: string + description: The BYOIP prefix UUID + example: "f47ac10b-58cc-4372-a567-0e02b2c3d479" + region: + type: string + description: Region where the allocation is made + example: "nyc3" + resource: + type: string + description: The resource associated with the allocation + example: "do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d479" + assigned_at: + type: string + format: date-time + description: Time when the allocation was assigned + example: 2025-06-25T12:00:00Z diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_update.yml new file mode 100644 index 000000000..a177ff9bc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/models/byoip_prefix_update.yml @@ -0,0 +1,7 @@ +byoip_prefix_update: + type: object + properties: + advertise: + type: boolean + description: Whether the BYOIP prefix should be advertised + example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/parameters.yml new file mode 100644 index 000000000..93c6d75e6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/parameters.yml @@ -0,0 +1,10 @@ +byoip_prefix: + in: path + name: byoip_prefix_uuid + description: The unique identifier for the BYOIP Prefix. + required: true + schema: + type: string + format: uuid + minimum: 1 + example: 'f47ac10b-58cc-4372-a567-0e02b2c3d479' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_create.yml new file mode 100644 index 000000000..7eb6097b3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_create.yml @@ -0,0 +1,30 @@ +byoip_prefix_create: + description: BYOIP prefix request accepted, response will contain the details of the created prefix. + + 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: + example: + $ref: 'examples.yml#/byoip_prefix_create' + schema: + type: object + properties: + uuid: + type: string + description: The unique identifier for the BYOIP prefix + example: "123e4567-e89b-12d3-a456-426614174000" + region: + type: string + description: The region where the prefix is created + example: "nyc3" + status: + type: string + description: The status of the BYOIP prefix + example: "in_progress" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_delete.yml new file mode 100644 index 000000000..26dbacfe2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_delete.yml @@ -0,0 +1,10 @@ +byoip_prefix_delete: + description: BYOIP prefix deletion request accepted + + 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' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_get.yml new file mode 100644 index 000000000..97d6c1952 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_get.yml @@ -0,0 +1,20 @@ +byoip_prefix_get: + description: Details of the requested BYOIP prefix + + 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: + example: + $ref: 'examples.yml#/byoip_prefix_get' + schema: + type: object + properties: + byoip_prefix: + $ref: '../models/byoip_prefix.yml#/byoip_prefix' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list.yml new file mode 100644 index 000000000..cf8f50410 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list.yml @@ -0,0 +1,25 @@ +byoip_prefix_list: + description: List of BYOIP prefixes as an array of BYOIP prefix JSON objects + + 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: + example: + $ref: 'examples.yml#/byoip_prefix_list' + schema: + allOf: + - type: object + properties: + byoip_prefixes: + type: array + items: + $ref: '../models/byoip_prefix.yml#/byoip_prefix' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list_resources.yml new file mode 100644 index 000000000..ce47085fe --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_list_resources.yml @@ -0,0 +1,25 @@ +byoip_prefix_list_resources: + description: List of IP addresses assigned to resources (such as Droplets) in a BYOIP prefix + + 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: + example: + $ref: 'examples.yml#/byoip_prefix_resources_list' + schema: + allOf: + - type: object + properties: + ips: + type: array + items: + $ref: '../models/byoip_prefix_resource.yml#/byoip_prefix_resource' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_update.yml new file mode 100644 index 000000000..ff14f34df --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/byoip_prefix_update.yml @@ -0,0 +1,20 @@ +byoip_prefix_update: + description: Details of the updated BYOIP prefix + + 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: + example: + $ref: 'examples.yml#/byoip_prefix_update' + schema: + type: object + properties: + byoip_prefix: + $ref: '../models/byoip_prefix.yml#/byoip_prefix' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/examples.yml new file mode 100644 index 000000000..52a71f9da --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/byoip_prefixes/responses/examples.yml @@ -0,0 +1,70 @@ +byoip_prefix_create: + byoip_prefix: + uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: in_progress + region: nyc3 + +byoip_prefix_get: + byoip_prefix: + uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: active + region: nyc3 + prefix: "203.0.113.0/24" + validations: [] + failure_reason: "" + advertised: true + locked: false + project_id: "12345678-1234-1234-1234-123456789012" + +byoip_prefix_update: + byoip_prefix: + uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: active + region: nyc3 + prefix: "203.0.113.0/24" + validations: [] + failure_reason: "" + advertised: true + locked: false + project_id: "12345678-1234-1234-1234-123456789012" + +byoip_prefix_list: + byoip_prefixes: + - uuid: f47ac10b-58cc-4372-a567-0e02b2c3d479 + status: active + region: nyc3 + prefix: "203.0.113.0/24" + validations: [] + failure_reason: "" + advertised: true + locked: false + project_id: "12345678-1234-1234-1234-123456789012" + + - uuid: 123e4567-e89b-12d3-a456-426614174001 + status: in_progress + region: sfo2 + prefix: "203.1.113.0/24" + validations: [] + failure_reason: "" + advertised: false + locked: false + project_id: "12345678-1234-1234-1234-123456789012" + links: {} + meta: + total: 2 + +byoip_prefix_resources_list: + ips: + - id: 11111023 + byoip: "203.0.113.2" + region: nyc3 + resource: "do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d479" + assigned_at: 2025-06-25T12:00:00Z + - id: 11111024 + byoip: "203.0.113.3" + region: nyc3 + resource: "do:droplet:fa3c10b-58cc-4372-a567-0e02b2c3d480" + assigned_at: 2025-06-25T13:00:00Z + links: {} + meta: + total: 2 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml index 6dff7e48d..2b28e78ec 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml @@ -6,7 +6,7 @@ description: | To add a new database to an existing cluster, send a POST request to `/v2/databases/$DATABASE_ID/dbs`. - Note: Database management is not supported for Redis clusters. + Note: Database management is not supported for Caching or Valkey clusters. The response will be a JSON object with a key called `db`. The value of this will be an object that contains the standard attributes associated with a database. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml index 6c73a9c4b..c5d3b9f03 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml @@ -6,7 +6,7 @@ description: | To add a new database user, send a POST request to `/v2/databases/$DATABASE_ID/users` with the desired username. - Note: User management is not supported for Redis clusters. + Note: User management is not supported for Caching or Valkey clusters. When adding a user to a MySQL cluster, additional options can be configured in the `mysql_settings` object. @@ -14,6 +14,9 @@ description: | When adding a user to a Kafka cluster, additional options can be configured in the `settings` object. + When adding a user to a MongoDB cluster, additional options can be configured in + the `settings.mongo_user_settings` object. + The response will be a JSON object with a key called `user`. The value of this will be an object that contains the standard attributes associated with a database user including its randomly generated password. @@ -37,8 +40,10 @@ requestBody: type: boolean example: true description: | + (To be deprecated: use settings.mongo_user_settings.role instead for access controls to MongoDB databases). For MongoDB clusters, set to `true` to create a read-only user. - This option is not currently supported for other database engines. + This option is not currently supported for other database engines. + examples: Add New User: @@ -55,6 +60,16 @@ requestBody: value: name: my-readonly readonly: true + + Add New User that is restricted to a database (MongoDB Only): + value: + name: my-readWrite + settings: + mongo_user_settings: + databases: + - my-db + - my-db-2 + role: readWrite Add New User for Postgres with replication rights: value: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml index 11868c762..5761d5e7b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml @@ -3,18 +3,23 @@ operationId: databases_create_cluster summary: Create a New Database Cluster description: >- - To create a database cluster, send a POST request to `/v2/databases`. - - The response will be a JSON object with a key called `database`. The value of this - will be an object that contains the standard attributes associated with a database - cluster. The initial value of the database cluster's `status` attribute will be - `creating`. When the cluster is ready to receive traffic, this will transition to + To create a database cluster, send a POST request to `/v2/databases`. To see a list + of options for each engine, such as available regions, size slugs, and versions, + send a GET request to the `/v2/databases/options` endpoint. The available sizes for + the `storage_size_mib` field depends on the cluster's size. To see a list of available + sizes, see [Managed Database Pricing](https://www.digitalocean.com/pricing/managed-databases). + + + The create response returns a JSON object with a key called `database`. The value of this + is an object that contains the standard attributes associated with a database + cluster. The initial value of the database cluster's `status` attribute is + `creating`. When the cluster is ready to receive traffic, this changes to `online`. - The embedded `connection` and `private_connection` objects will contain the + The embedded `connection` and `private_connection` objects contains the information needed to access the database cluster. For multi-node clusters, the - `standby_connection` and `standby_private_connection` objects will contain the information + `standby_connection` and `standby_private_connection` objects contain the information needed to connect to the cluster's standby node(s). @@ -25,7 +30,8 @@ description: >- database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. - Note: Backups are not supported for Redis clusters. + Note: Caching cluster creates are no longer supported as of 2025-04-30T00:00:00Z. + Backups are also not supported for Caching or Valkey clusters. tags: - Databases @@ -74,6 +80,7 @@ requestBody: value: "163973392" - type: tag value: test + description: "a test tag" Restore from a Database Cluster Backup: value: @@ -87,6 +94,22 @@ requestBody: size: db-s-2vcpu-4gb num_nodes: 2 + Create a New Database Cluster with service CNAMEs: + value: + name: backend + engine: pg + version: "14" + region: nyc3 + size: db-s-2vcpu-4gb + num_nodes: 2 + storage_size_mib: 61440 + tags: + - production + do_settings: + service_cnames: + - "db.example.com" + - "database.myapp.io" + responses: "201": $ref: "responses/database_cluster.yml" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_schema.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_schema.yml new file mode 100644 index 000000000..606829377 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_schema.yml @@ -0,0 +1,63 @@ +operationId: databases_create_kafka_schema + +summary: > + Create Schema Registry for Kafka Cluster + +description: | + To create a Kafka schema for a database cluster, send a POST request to + `/v2/databases/$DATABASE_ID/schema-registry`. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + +requestBody: + required: true + content: + application/json: + schema: + allOf: + - $ref: 'models/database_kafka_schema_create.yml' + required: + - subject_name + - schema_type + - schema + example: + subject_name: customer-schema + schema_type: AVRO + schema: | + { + "type": "record", + "name": "Customer", + "fields": [ + {"name": "id", "type": "string"}, + {"name": "name", "type": "string"}, + {"name": "email", "type": "string"}, + {"name": "created_at", "type": "long"} + ] + } + +responses: + '201': + $ref: 'responses/kafka_schema.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' + +security: + - bearer_auth: + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml index 9971a95e1..72eacf0a4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_logsink.yml @@ -50,6 +50,14 @@ requestBody: port: 514 tls: false format: rfc5424 + Create a datadog logsink: + value: + sink_name: "logs-sink" + sink_type: "datadog" + config: + datadog_api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + site: http-intake.logs.datadoghq.com + responses: "201": diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml index 5a71d1872..5659bc9bd 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml @@ -9,7 +9,7 @@ description: >- where it will be located. - **Note**: Read-only replicas are not supported for Redis clusters. + **Note**: Read-only replicas are not supported for Caching or Valkey clusters. The response will be a JSON object with a key called `replica`. The value of @@ -34,11 +34,24 @@ requestBody: - name - size - example: - name: read-nyc3-01 - region: nyc3 - size: db-s-2vcpu-4gb - storage_size_mib: 61440 + examples: + Create a Read-only Replica: + value: + name: read-nyc3-01 + region: nyc3 + size: db-s-2vcpu-4gb + storage_size_mib: 61440 + + Create a Read-only Replica with service CNAMEs: + value: + name: read-nyc3-01 + region: nyc3 + size: db-s-2vcpu-4gb + storage_size_mib: 61440 + do_settings: + service_cnames: + - "replica-db.example.com" + - "read-replica.myapp.io" responses: '201': diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml index adb2bf8a5..531f4fd3f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml @@ -9,7 +9,7 @@ description: | A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. - Note: Database management is not supported for Redis clusters. + Note: Database management is not supported for Caching or Valkey clusters. tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_schema.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_schema.yml new file mode 100644 index 000000000..1bd75aba9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_schema.yml @@ -0,0 +1,30 @@ +operationId: databases_delete_kafka_schema + +summary: > + Delete a Kafka Schema by Subject Name + +description: | + To delete a specific schema by subject name for a Kafka cluster, send a DELETE request to + `/v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME`. +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/kafka_schema_subject_name" + +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' + +security: + - bearer_auth: + - 'database:delete' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml index 432c6d38f..c0e9be6a4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml @@ -9,7 +9,7 @@ description: | A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. - Note: User management is not supported for Redis clusters. + Note: User management is not supported for Caching or Valkey clusters. tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml index 105ae1152..cf88b78d1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml @@ -7,7 +7,7 @@ description: >- `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. - **Note**: Read-only replicas are not supported for Redis clusters. + **Note**: Read-only replicas are not supported for Caching or Valkey clusters. A status of 204 will be given. This indicates that the request was processed diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml index 92e5f2d8b..8336ac9df 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml @@ -6,7 +6,7 @@ description: | To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID/dbs/$DB_NAME`. - Note: Database management is not supported for Redis clusters. + Note: Database management is not supported for Caching or Valkey clusters. The response will be a JSON object with a `db` key. This will be set to an object containing the standard database attributes. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_autoscale.yml new file mode 100644 index 000000000..e64ff09ea --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_autoscale.yml @@ -0,0 +1,42 @@ +operationId: databases_get_autoscale + +summary: Retrieve Autoscale Configuration for a Database Cluster + +description: >- + To retrieve the autoscale configuration for an existing database cluster, send a GET + request to `/v2/databases/$DATABASE_ID/autoscale`. + + The response will be a JSON object with autoscaling configuration details. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + +responses: + '200': + $ref: 'responses/autoscale.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/databases_get_autoscale.yml' + - $ref: 'examples/python/databases_get_autoscale.yml' + +security: + - bearer_auth: + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml index b4cb5bcdc..39b3f240a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml @@ -1,9 +1,9 @@ operationId: databases_get_evictionPolicy -summary: Retrieve the Eviction Policy for a Redis Cluster +summary: Retrieve the Eviction Policy for a Caching or Valkey Cluster description: >- - To retrieve the configured eviction policy for an existing Redis cluster, + To retrieve the configured eviction policy for an existing Caching or Valkey cluster, send a GET request to `/v2/databases/$DATABASE_ID/eviction_policy`. The response will be a JSON object with an `eviction_policy` key. This will diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema.yml new file mode 100644 index 000000000..fc2360037 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema.yml @@ -0,0 +1,29 @@ +operationId: databases_get_kafka_schema + +summary: > + Get a Kafka Schema by Subject Name +description: | + To get a specific schema by subject name for a Kafka cluster, send a GET request to + `/v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME`. + +tags: + - Databases +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/kafka_schema_subject_name" + +responses: + '200': + $ref: 'responses/kafka_schema_version.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' + +security: + - bearer_auth: + - 'database:read' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_config.yml new file mode 100644 index 000000000..84ec8ccbb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_config.yml @@ -0,0 +1,38 @@ +operationId: databases_get_kafka_schema_config + +summary: Retrieve Schema Registry Configuration for a kafka Cluster + +description: | + To retrieve the Schema Registry configuration for a Kafka cluster, send a GET request to + `/v2/databases/$DATABASE_ID/schema-registry/config`. + The response is a JSON object with a `compatibility_level` key, which is set to an object + containing any database configuration parameters. +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + +responses: + '200': + $ref: 'responses/database_schema_registry_config.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' + + +security: + - bearer_auth: + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_subject_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_subject_config.yml new file mode 100644 index 000000000..7762f2ce5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_subject_config.yml @@ -0,0 +1,39 @@ +operationId: databases_get_kafka_schema_subject_config + +summary: Retrieve Schema Registry Configuration for a Subject of kafka Cluster + +description: | + To retrieve the Schema Registry configuration for a Subject of a Kafka cluster, send a GET request to + `/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME`. + The response is a JSON object with a `compatibility_level` key, which is set to an object + containing any database configuration parameters. +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + - $ref: "parameters.yml#/kafka_schema_subject_name" + +responses: + '200': + $ref: 'responses/database_schema_registry_subject_config.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' + + +security: + - bearer_auth: + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_version.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_version.yml new file mode 100644 index 000000000..b7b1723aa --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_schema_version.yml @@ -0,0 +1,29 @@ +operationId: databases_get_kafka_schema_version + +summary: Get Kafka Schema by Subject Version +description: | + To get a specific schema by subject name for a Kafka cluster, send a GET request to + `/v2/databases/$DATABASE_ID/schema-registry/$SUBJECT_NAME/versions/$VERSION`. + +tags: + - Databases +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/kafka_schema_subject_name" + - $ref: "parameters.yml#/kafka_schema_version" + +responses: + '200': + $ref: 'responses/kafka_schema_version.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' + +security: + - bearer_auth: + - 'database:read' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml index e87955b57..91dacdb2b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_logsink.yml @@ -15,8 +15,8 @@ parameters: - $ref: "parameters.yml#/logsink_id" responses: - "201": - $ref: "responses/logsink.yml" + "200": + $ref: "responses/logsink_data.yml" "401": $ref: "../../shared/responses/unauthorized.yml" @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'database:read' + - "database:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml index daf063597..14e137a84 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml @@ -7,7 +7,7 @@ description: >- to `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME`. - **Note**: Read-only replicas are not supported for Redis clusters. + **Note**: Read-only replicas are not supported for Caching or Valkey clusters. The response will be a JSON object with a `replica key`. This will be set to diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml index 126562fe6..38fc5a1b6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml @@ -6,16 +6,19 @@ description: | To show information about an existing database user, send a GET request to `/v2/databases/$DATABASE_ID/users/$USERNAME`. - Note: User management is not supported for Redis clusters. + Note: User management is not supported for Caching or Valkey clusters. The response will be a JSON object with a `user` key. This will be set to an object - containing the standard database user attributes. + containing the standard database user attributes. The user's password will not show + up unless the `database:view_credentials` scope is present. For MySQL clusters, additional options will be contained in the `mysql_settings` object. For Kafka clusters, additional options will be contained in the `settings` object. + For MongoDB clusters, additional information will be contained in the mongo_user_settings object + tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml index 0b79b2981..3dbceb7ce 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml @@ -9,7 +9,7 @@ description: | The result will be a JSON object with a `dbs` key. This will be set to an array of database objects, each of which will contain the standard database attributes. - Note: Database management is not supported for Redis clusters. + Note: Database management is not supported for Caching or Valkey clusters. tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml index b01fff1dc..a029d566c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml @@ -6,7 +6,7 @@ description: >- To list all of the available backups of a PostgreSQL or MySQL database cluster, send a GET request to `/v2/databases/$DATABASE_ID/backups`. - **Note**: Backups are not supported for Redis clusters. + **Note**: Backups are not supported for Caching or Valkey clusters. The result will be a JSON object with a `backups key`. This will be set to an array of backup objects, each of which will contain the size of the diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_schemas.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_schemas.yml new file mode 100644 index 000000000..ce65f268b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_schemas.yml @@ -0,0 +1,30 @@ +operationId: databases_list_kafka_schemas + +summary: > + List Schemas for Kafka Cluster + +description: | + To list all schemas for a Kafka cluster, send a GET request to + `/v2/databases/$DATABASE_ID/schema-registry`. + +tags: + - Databases +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" +responses: + '200': + $ref: 'responses/kafka_schemas.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' + +security: + - bearer_auth: + - 'database:read' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml index 5164d82de..760a91862 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_logsink.yml @@ -14,7 +14,7 @@ parameters: - $ref: "parameters.yml#/database_cluster_uuid" responses: - "201": + "200": $ref: "responses/logsinks.yml" "401": @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'database:read' + - "database:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml index 236d48b11..2641f6056 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml @@ -7,7 +7,7 @@ description: >- send a GET request to `/v2/databases/$DATABASE_ID/replicas`. - **Note**: Read-only replicas are not supported for Redis clusters. + **Note**: Read-only replicas are not supported for Caching or Valkey clusters. The result will be a JSON object with a `replicas` key. This will be set to diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml index 256caef8d..9c695e0fb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml @@ -6,13 +6,16 @@ description: | To list all of the users for your database cluster, send a GET request to `/v2/databases/$DATABASE_ID/users`. - Note: User management is not supported for Redis clusters. + Note: User management is not supported for Caching or Valkey clusters. The result will be a JSON object with a `users` key. This will be set to an array of database user objects, each of which will contain the standard database user attributes. + User passwords will not show without the `database:view_credentials` scope. For MySQL clusters, additional options will be contained in the mysql_settings object. + For MongoDB clusters, additional information will be contained in the mongo_user_settings object + tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml index c961e3610..bfc595410 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml @@ -7,7 +7,7 @@ description: >- `/v2/databases/$DATABASE_ID/replicas/$REPLICA_NAME/promote`. - **Note**: Read-only replicas are not supported for Redis clusters. + **Note**: Read-only replicas are not supported for Caching or Valkey clusters. A status of 204 will be given. This indicates that the request was processed diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_set_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_set_autoscale.yml new file mode 100644 index 000000000..166a13a13 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_set_autoscale.yml @@ -0,0 +1,59 @@ +operationId: databases_update_autoscale + +summary: Configure Autoscale Settings for a Database Cluster + +description: >- + To configure autoscale settings for an existing database cluster, send a PUT + request to `/v2/databases/$DATABASE_ID/autoscale`, specifying the autoscale + configuration. + + A successful request will receive a 204 No Content status code with no body + in response. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + +requestBody: + required: true + content: + application/json: + schema: + $ref: 'models/database_autoscale_params.yml' + example: + storage: + enabled: true + threshold_percent: 80 + increment_gib: 10 + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '422': + $ref: '../../shared/responses/unprocessable_entity.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/databases_set_autoscale.yml' + - $ref: 'examples/python/databases_set_autoscale.yml' + +security: + - bearer_auth: + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_autoscale.yml new file mode 100644 index 000000000..a7c1a25a3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_autoscale.yml @@ -0,0 +1,59 @@ +operationId: databases_update_autoscale + +summary: Configure Autoscale Settings for a Database Cluster + +description: >- + To configure autoscale settings for an existing database cluster, send a PUT + request to `/v2/databases/$DATABASE_ID/autoscale`, specifying the autoscale + configuration. + + A successful request will receive a 204 No Content status code with no body + in response. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + +requestBody: + required: true + content: + application/json: + schema: + $ref: 'models/database_autoscale_params.yml' + example: + storage: + enabled: true + threshold_percent: 80 + increment_gib: 10 + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '422': + $ref: '../../shared/responses/unprocessable_entity.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/databases_update_autoscale.yml' + - $ref: 'examples/python/databases_update_autoscale.yml' + +security: + - bearer_auth: + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml index e6e8f92b1..f8e32431d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml @@ -1,9 +1,9 @@ operationId: databases_update_evictionPolicy -summary: Configure the Eviction Policy for a Redis Cluster +summary: Configure the Eviction Policy for a Caching or Valkey Cluster description: >- - To configure an eviction policy for an existing Redis cluster, send a PUT + To configure an eviction policy for an existing Caching or Valkey cluster, send a PUT request to `/v2/databases/$DATABASE_ID/eviction_policy` specifying the desired policy. 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 6b6125fe5..ea49be267 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 @@ -41,6 +41,7 @@ requestBody: value: '163973392' - type: tag value: backend + description: 'a backend tag' parameters: - $ref: 'parameters.yml#/database_cluster_uuid' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_config.yml new file mode 100644 index 000000000..62bbf8864 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_config.yml @@ -0,0 +1,59 @@ +operationId: databases_update_kafka_schema_config + +summary: Update Schema Registry Configuration for a kafka Cluster + +description: | + To update the Schema Registry configuration for a Kafka cluster, send a PUT request to + `/v2/databases/$DATABASE_ID/schema-registry/config`. + The response is a JSON object with a `compatibility_level` key, which is set to an object + containing any database configuration parameters. +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + +requestBody: + content: + application/json: + schema: + type: object + properties: + compatibility_level: + type: string + enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + description: The compatibility level of the schema registry. + required: + - compatibility_level + example: + compatibility_level: BACKWARD + +responses: + "200": + $ref: "responses/database_schema_registry_config.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" + +security: + - bearer_auth: + - "database:write" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_subject_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_subject_config.yml new file mode 100644 index 000000000..62d154149 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_schema_subject_config.yml @@ -0,0 +1,60 @@ +operationId: databases_update_kafka_schema_subject_config + +summary: Update Schema Registry Configuration for a Subject of kafka Cluster + +description: | + To update the Schema Registry configuration for a Subject of a Kafka cluster, send a PUT request to + `/v2/databases/$DATABASE_ID/schema-registry/config/$SUBJECT_NAME`. + The response is a JSON object with a `compatibility_level` key, which is set to an object + containing any database configuration parameters. +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + - $ref: "parameters.yml#/kafka_schema_subject_name" + +requestBody: + content: + application/json: + schema: + type: object + properties: + compatibility_level: + type: string + enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + description: The compatibility level of the schema registry. + required: + - compatibility_level + example: + compatibility_level: BACKWARD + +responses: + "200": + $ref: "responses/database_schema_registry_subject_config.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" + +security: + - bearer_auth: + - "database:write" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml index 31c699597..3005cb7e7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml @@ -7,7 +7,14 @@ description: >- `/v2/databases/$DATABASE_ID/online-migration` endpoint. Migrating a cluster establishes a connection with an existing cluster and replicates its contents to the target cluster. Online migration is only available for - MySQL, PostgreSQL, and Redis clusters. + MySQL, PostgreSQL, Caching, and Valkey clusters. + + If the existing database is continuously being written to, + the migration process will continue for up to two weeks unless it is manually stopped. Online migration is only available for + [MySQL](https://docs.digitalocean.com/products/databases/mysql/how-to/migrate/#:~:text=To%20migrate%20a%20MySQL%20database,then%20select%20Set%20Up%20Migration), + [PostgreSQL](https://docs.digitalocean.com/products/databases/postgresql/how-to/migrate/), + [Caching](https://docs.digitalocean.com/products/databases/redis/how-to/migrate/), and + [Valkey](https://docs.digitalocean.com/products/databases/valkey/how-to/migrate/) clusters. tags: - Databases diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_cluster.yml index a7b9d8b74..051690993 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_cluster.yml @@ -3,5 +3,5 @@ source: |- curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - -d '{"name": "backend", "engine": "pg", "version": "14", "region": "nyc3", "size": "db-s-2vcpu-4gb", "num_nodes": 2, "storage_size_mib": 61440, "tags": ["production"]}' \ + -d '{"name": "backend", "engine": "pg", "version": "14", "region": "nyc3", "size": "db-s-2vcpu-4gb", "num_nodes": 2, "storage_size_mib": 61440, "tags": ["production"], "do_settings": {"service_cnames": ["db.example.com", "database.myapp.io"]}}' \ "https://api.digitalocean.com/v2/databases" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_replica.yml index 1ff457b12..01ac0f1ea 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_create_replica.yml @@ -3,5 +3,5 @@ source: |- curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ - -d '{"name":"read-nyc3-01", "region":"nyc3", "size": "db-s-2vcpu-4gb", "storage_size_mib": 61440}' \ + -d '{"name":"read-nyc3-01", "region":"nyc3", "size": "db-s-2vcpu-4gb", "storage_size_mib": 61440, "do_settings": {"service_cnames": ["replica-db.example.com", "read-replica.myapp.io"]}}' \ "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/replicas" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_autoscale.yml new file mode 100644 index 000000000..b2ebd3470 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_autoscale.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/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/autoscale" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_set_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_set_autoscale.yml new file mode 100644 index 000000000..f71036199 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_set_autoscale.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"storage":{"enabled":true,"threshold_percent":80,"increment_gib":10}}' \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/autoscale" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_autoscale.yml new file mode 100644 index 000000000..f71036199 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_autoscale.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"storage":{"enabled":true,"threshold_percent":80,"increment_gib":10}}' \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/autoscale" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_cluster.yml index 468afe926..ad29afbdb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_cluster.yml @@ -21,6 +21,9 @@ source: |- SizeSlug: "db-s-2vcpu-4gb", NumNodes: 2, StorageSizeMiB : 61440, + DOSettings: &godo.DOSettings{ + ServiceCnames: []string{"db.example.com", "database.myapp.io"}, + }, } cluster, _, err := client.Databases.Create(ctx, createRequest) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_replica.yml index b8a7125da..fc8c36dbf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_create_replica.yml @@ -14,11 +14,13 @@ source: |- ctx := context.TODO() replicaRequest := &godo.DatabaseCreateReplicaRequest{ - Name: "read-nyc3-01", Region: "nyc3", Size: "db-s-2vcpu-4gb", - StorageSizeMiB : 61440, + StorageSizeMiB: 61440, + DOSettings: &godo.DOSettings{ + ServiceCnames: []string{"replica-db.example.com", "read-replica.myapp.io"}, + }, } replica, _, err := client.Databases.CreateReplica(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", replicaRequest) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_firewall_rules.yml index 5ae60d2c7..5573112d8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_firewall_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_firewall_rules.yml @@ -18,6 +18,7 @@ source: |- { Type: "ip_addr", Value: "192.168.1.1", + Description: "a development IP address", }, { Type: "droplet", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_cluster.yml index 6867c5436..ad7ae2aba 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_cluster.yml @@ -15,7 +15,13 @@ source: |- "storage_size_mib": 61440, "tags": [ "production" - ] + ], + "do_settings": { + "service_cnames": [ + "db.example.com", + "database.myapp.io" + ] + } } create_resp = client.databases.create_cluster(body=create_req) \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_replica.yml index 05a7d434b..a44703d67 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_create_replica.yml @@ -10,6 +10,12 @@ source: |- "region": "nyc3", "size": "db-s-2vcpu-4gb", "storage_size_mib": 61440, + "do_settings": { + "service_cnames": [ + "replica-db.example.com", + "read-replica.myapp.io" + ] + } } create_resp = client.databases.create_replica(database_cluster_uuid="9cc10173", body=create_req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_get_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_get_autoscale.yml new file mode 100644 index 000000000..634284321 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_get_autoscale.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + get_resp = client.databases.get_autoscale(database_cluster_uuid="a7a89a") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_set_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_set_autoscale.yml new file mode 100644 index 000000000..e519850cf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_set_autoscale.yml @@ -0,0 +1,16 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "storage": { + "enabled": True, + "threshold_percent": 80, + "increment_gib": 10 + } + } + + update_resp = client.databases.set_autoscale(database_cluster_uuid="a7a89a", body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_autoscale.yml new file mode 100644 index 000000000..1e5c3f7ed --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_autoscale.yml @@ -0,0 +1,16 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "storage": { + "enabled": True, + "threshold_percent": 80, + "increment_gib": 10 + } + } + + update_resp = client.databases.update_autoscale(database_cluster_uuid="a7a89a", body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_firewall_rules.yml index cfc6af1e0..4c234d5e8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_firewall_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/python/databases_update_firewall_rules.yml @@ -9,7 +9,8 @@ source: |- "rules": [ { "type": "ip_addr", - "value": "192.168.1.1" + "value": "192.168.1.1", + "description": "a development IP address", }, { "type": "k8s", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/helpers/mysql_incremental_backup.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/helpers/mysql_incremental_backup.yml new file mode 100644 index 000000000..9ed52040d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/helpers/mysql_incremental_backup.yml @@ -0,0 +1,13 @@ +type: object +description: MySQL Incremental Backup configuration settings + +properties: + enabled: + description: >- + Enable periodic incremental backups. When enabled, full_backup_week_schedule must be set. Incremental backups only store changes since the last backup, making them faster and more storage-efficient than full backups. This is particularly useful for large databases where daily full backups would be too time-consuming or expensive. + type: boolean + full_backup_week_schedule: + description: >- + Comma-separated list of days of the week when full backups should be created. Valid values: mon, tue, wed, thu, fri, sat, sun. Default is null. Example : "mon,fri,sun". + type: string + example: mon,thu \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml index a9e9b959f..5199c1807 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/kafka_advanced_config.yml @@ -10,12 +10,12 @@ properties: compression codec set by the producer. type: string enum: - - gzip - - snappy - - lz4 - - zstd - - uncompressed - - producer + - gzip + - snappy + - lz4 + - zstd + - uncompressed + - producer example: gzip group_initial_rebalance_delay_ms: description: >- @@ -116,9 +116,9 @@ properties: window type: string enum: - - delete - - compact - - compact,delete + - delete + - compact + - compact,delete example: delete log_flush_interval_messages: description: >- @@ -164,8 +164,8 @@ properties: create time or log append time. type: string enum: - - CreateTime - - LogAppendTime + - CreateTime + - LogAppendTime example: CreateTime log_message_timestamp_difference_max_ms: description: >- @@ -239,6 +239,7 @@ properties: Enable auto creation of topics type: boolean example: true + default: false min_insync_replicas: description: >- When a producer sets acks to 'all' (or '-1'), min_insync_replicas @@ -325,4 +326,11 @@ properties: type: integer minimum: 600000 maximum: 3600000 - example: 3600000 \ No newline at end of file + example: 3600000 + schema_registry: + description: >- + Enable creation of schema registry for the Kafka cluster. + Schema_registry only works with General Purpose - Dedicated CPU plans. + type: boolean + example: true + default: false diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml index bd74a352b..9157ccf7b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/mysql_advanced_config.yml @@ -204,7 +204,7 @@ properties: This may be extended for services that require binlog entries for longer than the default, for example if using the MySQL Debezium Kafka connector. type: number minimum: 600 - maximum: 86400 + maximum: 604800 example: 600 innodb_change_buffer_max_size: description: >- @@ -265,3 +265,5 @@ properties: - NONE example: INSIGHTS default: NONE + mysql_incremental_backup: + $ref: './helpers/mysql_incremental_backup.yml' 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 1fe6c867d..52933294d 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 @@ -288,3 +288,26 @@ properties: type: boolean example: false default: false + knn_memory_circuit_breaker_enabled: + description: >- + Enable or disable KNN memory circuit breaker. + type: boolean + example: true + default: true + knn_memory_circuit_breaker_limit: + description: >- + Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. + 0 is used to set it to null which can be used to invalidate caches. + type: integer + example: 60 + minimum: 0 + maximum: 100 + default: 50 + keep_index_refresh_interval: + description: >- + DigitalOcean automatically resets the `index.refresh_interval` to the default value (once per second) to + ensure that new documents are quickly available for search queries. If you are setting your own refresh intervals, + you can disable this by setting this field to true. + example: true + type: boolean + 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 c2c806586..eb327b280 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 @@ -414,3 +414,16 @@ properties: minimum: 10 maximum: 9223372036854776000 example: 50 + max_connections: + description: >- + Sets the PostgreSQL maximum number of concurrent connections to the database server. This is a limited-release parameter. Contact your account team to confirm your eligibility. You cannot decrease this parameter value when set. For services with a read replica, first increase the read replica's value. After the change is applied to the replica, you can increase the primary service's value. Changing this parameter causes a service restart. + type: integer + minimum: 25 + example: 75 + max_slot_wal_keep_size: + description: >- + PostgreSQL maximum WAL size (MB) reserved for replication slots. If -1 is specified, replication slots may retain an unlimited amount of WAL files. The default is -1 (upstream default). wal_keep_size minimum WAL size setting takes precedence over this. + type: integer + minimum: -1 + maximum: 2147483647 + example: 100 \ No newline at end of file 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 a733d286d..63fddf1c6 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,24 @@ type: object properties: redis_maxmemory_policy: - $ref: "../eviction_policy_model.yml" + type: string + enum: + - noeviction + - allkeys-lru + - allkeys-random + - volatile-lru + - volatile-random + - volatile-ttl + description: |2- + A string specifying the desired eviction policy for the Caching cluster. + + - `noeviction`: Don't evict any data, returns error when memory limit is reached. + - `allkeys-lru:` Evict any key, least recently used (LRU) first. + - `allkeys-random`: Evict keys in a random order. + - `volatile-lru`: Evict keys with expiration only, least recently used (LRU) first. + - `volatile-random`: Evict keys with expiration only in a random order. + - `volatile-ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first. + example: allkeys-lru redis_pubsub_client_output_buffer_limit: description: >- Set output buffer limit for pub / sub clients in MB. The value is the hard @@ -21,7 +38,7 @@ properties: service. example: 16 redis_io_threads: - description: Redis IO thread count + description: Caching IO thread count type: integer minimum: 1 maximum: 32 @@ -44,14 +61,14 @@ properties: example: 1 redis_ssl: description: | - Require SSL to access Redis. - - When enabled, Redis accepts only SSL connections on port `25061`. + Require SSL to access Caching. + - When enabled, Caching 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 redis_timeout: - description: Redis idle connection timeout in seconds + description: Caching idle connection timeout in seconds type: integer minimum: 0 maximum: 31536000 @@ -101,6 +118,6 @@ properties: description: >- Determines default pub/sub channels' ACL for new users if ACL is not supplied. When this option is not defined, all_channels is assumed to keep - backward compatibility. This option doesn't affect Redis configuration + backward compatibility. This option doesn't affect Caching configuration acl-pubsub-default. example: allchannels diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/valkey_advanced_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/valkey_advanced_config.yml new file mode 100644 index 000000000..a84910a6e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/advanced_config/valkey_advanced_config.yml @@ -0,0 +1,121 @@ +type: object + +properties: + valkey_maxmemory_policy: + $ref: '../eviction_policy_model.yml' + valkey_pubsub_client_output_buffer_limit: + description: >- + Set output buffer limit for pub / sub clients in MB. The value is the hard + limit, the soft limit is 1/4 of the hard limit. When setting the limit, be + mindful of the available memory in the selected service plan. + type: integer + minimum: 32 + maximum: 512 + example: 64 + valkey_number_of_databases: + type: integer + minimum: 1 + maximum: 128 + description: >- + Set number of valkey databases. Changing this will cause a restart of valkey + service. + example: 16 + valkey_io_threads: + description: Valkey IO thread count + type: integer + minimum: 1 + maximum: 32 + example: 1 + valkey_lfu_log_factor: + description: >- + Counter logarithm factor for volatile-lfu and allkeys-lfu + maxmemory-policies + type: integer + minimum: 0 + maximum: 100 + default: 10 + example: 10 + valkey_lfu_decay_time: + description: LFU maxmemory-policy counter decay time in minutes + type: integer + minimum: 1 + maximum: 120 + default: 1 + example: 1 + valkey_ssl: + description: Require SSL to access Valkey + type: boolean + default: true + example: true + valkey_timeout: + description: Valkey idle connection timeout in seconds + type: integer + minimum: 0 + maximum: 31536000 + default: 300 + example: 300 + valkey_notify_keyspace_events: + description: |2- + Set notify-keyspace-events option. Requires at least `K` or `E` and accepts any combination of the following options. Setting the parameter to `""` disables notifications. + - `K` — Keyspace events + - `E` — Keyevent events + - `g` — Generic commands (e.g. `DEL`, `EXPIRE`, `RENAME`, ...) + - `$` — String commands + - `l` — List commands + - `s` — Set commands + - `h` — Hash commands + - `z` — Sorted set commands + - `t` — Stream commands + - `d` — Module key type events + - `x` — Expired events + - `e` — Evicted events + - `m` — Key miss events + - `n` — New key events + - `A` — Alias for `"g$lshztxed"` + type: string + pattern: ^[KEg\$lshzxeA]*$ + default: '' + maxLength: 32 + example: K + valkey_persistence: + type: string + enum: + - 'off' + - rdb + description: >- + When persistence is 'rdb', Valkey does RDB dumps each 10 minutes if any key + is changed. Also RDB dumps are done according to backup schedule for + backup purposes. When persistence is 'off', no RDB dumps and backups are + done, so data can be lost at any moment if service is restarted for any + reason, or if service is powered off. Also service can't be forked. + example: rdb + valkey_acl_channels_default: + type: string + enum: + - allchannels + - resetchannels + description: >- + Determines default pub/sub channels' ACL for new users if ACL is not + supplied. When this option is not defined, all_channels is assumed to keep + backward compatibility. This option doesn't affect Valkey configuration + acl-pubsub-default. + example: allchannels + frequent_snapshots: + type: boolean + default: true + description: > + Frequent RDB snapshots + + When enabled, Valkey will create frequent local RDB snapshots. When disabled, Valkey will only take RDB snapshots when a backup is created, based on the backup schedule. This setting is ignored when valkey_persistence is set to off. + example: true + + valkey_active_expire_effort: + type: integer + minimum: 1 + maximum: 10 + default: 1 + description: > + Active expire effort + + Valkey reclaims expired keys both when accessed and in the background. The background process scans for expired keys to free memory. Increasing the active-expire-effort setting (default 1, max 10) uses more CPU to reclaim expired keys faster, reducing memory usage but potentially increasing latency. + example: 1 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/backup.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/backup.yml index bc57f5823..e9fe44d10 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/backup.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/backup.yml @@ -12,6 +12,11 @@ properties: type: number example: 0.03364864 description: The size of the database backup in GBs. + incremental: + type: boolean + example: false + description: >- + Indicates if this backup is a full or an incremental one (available only for MySQL). required: - created_at diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_autoscale_params.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_autoscale_params.yml new file mode 100644 index 000000000..7bbbb7d35 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_autoscale_params.yml @@ -0,0 +1,18 @@ +type: object + +description: >- + Contains all autoscaling configuration for a database cluster + +properties: + storage: + allOf: + - $ref: './database_storage_autoscale_params.yml' + - description: >- + Storage autoscaling configuration + +# Future expansion: +# compute: +# allOf: +# - $ref: './database_compute_autoscale_params.yml' +# - description: >- +# Compute autoscaling configuration diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml index 15f391a51..d1ec75204 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml @@ -18,13 +18,14 @@ properties: - pg - mysql - redis + - valkey - mongodb - kafka - opensearch description: >- A slug representing the database engine used for the cluster. The possible values - are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, - "kafka" for Kafka, and "opensearch" for OpenSearch. + are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB, + "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey. version: type: string example: '8' @@ -73,6 +74,7 @@ properties: A string specifying the UUID of the VPC to which the database cluster will be assigned. If excluded, the cluster when creating a new database cluster, it will be assigned to your account's default VPC for the region. +

Requires `vpc:read` scope. tags: type: array items: @@ -81,7 +83,8 @@ properties: - production nullable: true description: >- - An array of tags that have been applied to the database cluster. + An array of tags (as strings) to apply to the database cluster. +

Requires `tag:create` scope. db_names: type: array items: @@ -99,6 +102,12 @@ properties: - readOnly: true description: >- The connection details for OpenSearch dashboard. + schema_registry_connection: + allOf: + - $ref: './schema_registry_connection.yml' + - readOnly: true + description: >- + The connection details for Schema Registry. connection: allOf: - $ref: './database_connection.yml' @@ -129,7 +138,7 @@ properties: type: string format: uuid example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 - description: The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project. + description: The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project.

Requires `project:update` scope. rules: type: array items: @@ -162,6 +171,17 @@ properties: Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and a second entry for the cluster's standby node(s). readOnly: true + autoscale: + allOf: + - $ref: './database_autoscale_params.yml' + description: >- + Autoscaling configuration for the database cluster. Currently only supports storage autoscaling. If null, autoscaling is + not configured for the cluster. + do_settings: + allOf: + - $ref: './do_settings.yml' + - description: >- + DigitalOcean-specific settings for the database cluster, including custom service CNAMEs. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_read.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_read.yml new file mode 100644 index 000000000..d76f7cb6b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster_read.yml @@ -0,0 +1,187 @@ +type: object + +properties: + id: + type: string + format: uuid + example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + description: A unique ID that can be used to identify and reference a database cluster. + readOnly: true + name: + type: string + example: backend + description: A unique, human-readable name referring to a database cluster. + engine: + type: string + example: mysql + enum: + - pg + - mysql + - redis + - valkey + - mongodb + - kafka + - opensearch + description: >- + A slug representing the database engine used for the cluster. The possible values + are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Caching, "mongodb" for MongoDB, + "kafka" for Kafka, "opensearch" for OpenSearch, and "valkey" for Valkey. + version: + type: string + example: '8' + description: A string representing the version of the database engine in use for the cluster. + semantic_version: + type: string + example: '8.0.28' + description: A string representing the semantic version of the database engine in use for the cluster. + readOnly: true + num_nodes: + type: integer + example: 2 + description: The number of nodes in the database cluster. + size: + type: string + example: db-s-2vcpu-4gb + description: The slug identifier representing the size of the nodes in the database cluster. + region: + type: string + example: nyc3 + description: The slug identifier for the region where the database cluster is located. + status: + type: string + enum: + - creating + - online + - resizing + - migrating + - forking + example: creating + description: A string representing the current status of the database cluster. + readOnly: true + created_at: + type: string + format: date-time + example: 2019-01-11T18:37:36Z + description: >- + A time value given in ISO8601 combined date and time format that represents + when the database cluster was created. + readOnly: true + private_network_uuid: + type: string + pattern: '^$|[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}' + example: d455e75d-4858-4eec-8c95-da2f0a5f93a7 + description: >- + A string specifying the UUID of the VPC to which the database cluster will be + assigned. If excluded, the cluster when creating a new database cluster, it will + be assigned to your account's default VPC for the region. +

Requires `vpc:read` scope. + tags: + type: array + items: + type: string + example: + - production + nullable: true + description: >- + An array of tags that have been applied to the database cluster. +

Requires `tag:read` scope. + db_names: + type: array + items: + type: string + example: + - doadmin + nullable: true + readOnly: true + description: >- + An array of strings containing the names of databases created in the + database cluster. + ui_connection: + allOf: + - $ref: './opensearch_connection.yml' + - readOnly: true + description: >- + The connection details for OpenSearch dashboard. + schema_registry_connection: + allOf: + - $ref: './schema_registry_connection.yml' + - readOnly: true + description: >- + The connection details for Schema Registry. + connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true + private_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true + standby_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true + standby_private_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true + users: + type: array + nullable: true + items: + $ref: './database_user.yml' + readOnly: true + maintenance_window: + allOf: + - $ref: './database_maintenance_window.yml' + - readOnly: true + project_id: + type: string + format: uuid + example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + description: The ID of the project that the database cluster is assigned to. If excluded when creating a new database cluster, it will be assigned to your default project.

Requires `project:read` scope. + rules: + type: array + items: + $ref: './firewall_rule.yml' + version_end_of_life: + type: string + example: '2023-11-09T00:00:00Z' + readOnly: true + description: >- + A timestamp referring to the date when the particular version will no longer be supported. If null, the version + does not have an end of life timeline. + version_end_of_availability: + type: string + example: '2023-05-09T00:00:00Z' + readOnly: true + description: >- + A timestamp referring to the date when the particular version will no longer be available for creating new + clusters. If null, the version does not have an end of availability timeline. + storage_size_mib: + type: integer + example: 61440 + description: >- + Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond + what is provided as a base amount from the 'size' and any previously added additional storage. + metrics_endpoints: + type: array + items: + $ref: './database_service_endpoint.yml' + description: >- + Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and + a second entry for the cluster's standby node(s). + readOnly: true + do_settings: + allOf: + - $ref: './do_settings.yml' + - description: >- + DigitalOcean-specific settings for the database cluster, including custom service CNAMEs. + + + +required: + - name + - engine + - num_nodes + - size + - region diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml index 4143b1ba2..c51126133 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml @@ -6,6 +6,7 @@ properties: - $ref: './advanced_config/mysql_advanced_config.yml' - $ref: './advanced_config/postgres_advanced_config.yml' - $ref: './advanced_config/redis_advanced_config.yml' + - $ref: './advanced_config/valkey_advanced_config.yml' - $ref: './advanced_config/mongo_advanced_config.yml' - $ref: './advanced_config/kafka_advanced_config.yml' - $ref: './advanced_config/opensearch_advanced_config.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_connection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_connection.yml index 7721417cd..8c245c8e0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_connection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_connection.yml @@ -25,12 +25,12 @@ properties: readOnly: true user: type: string - description: The default user for the database. + description: The default user for the database.

Requires `database:view_credentials` scope. example: doadmin readOnly: true password: type: string - description: The randomly generated password for the default user. + description: The randomly generated password for the default user.

Requires `database:view_credentials` scope. example: wv78n3zpz42xezdk readOnly: true ssl: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_kafka_schema_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_kafka_schema_create.yml new file mode 100644 index 000000000..be9a66612 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_kafka_schema_create.yml @@ -0,0 +1,27 @@ +type: object + +properties: + subject_name: + type: string + description: The name of the schema subject. + example: customer-schema + schema_type: + type: string + enum: + - AVRO + - JSON + - PROTOBUF + description: The type of the schema. + example: AVRO + schema: + type: string + description: The schema definition in the specified format. + example: |- + { + "type": "record", + "name": "Customer", + "fields": [ + {"name": "id", "type": "int"}, + {"name": "name", "type": "string"} + ] + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml index 3f5755d83..1c42bb731 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica.yml @@ -45,6 +45,7 @@ properties: description: >- A flat array of tag names as strings to apply to the read-only replica after it is created. Tag names can either be existing or new tags. +

Requires `tag:create` scope. created_at: type: string format: date-time @@ -60,6 +61,7 @@ properties: A string specifying the UUID of the VPC to which the read-only replica will be assigned. If excluded, the replica will be assigned to your account's default VPC for the region. +

Requires `vpc:read` scope. connection: allOf: - readOnly: true @@ -74,6 +76,11 @@ properties: description: >- Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. + do_settings: + allOf: + - $ref: './do_settings.yml' + - description: >- + DigitalOcean-specific settings for the read-only replica, including custom service CNAMEs. required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica_read.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica_read.yml new file mode 100644 index 000000000..e3a333b39 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_replica_read.yml @@ -0,0 +1,84 @@ +type: object + +properties: + id: + type: string + format: uuid + example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + description: A unique ID that can be used to identify and reference a database replica. + readOnly: true + name: + type: string + example: read-nyc3-01 + description: The name to give the read-only replicating + region: + type: string + example: nyc3 + description: >- + A slug identifier for the region where the read-only replica will be + located. If excluded, the replica will be placed in the same region as + the cluster. + size: + type: string + example: db-s-2vcpu-4gb + description: >- + A slug identifier representing the size of the node for the read-only + replica. The size of the replica must be at least as large as the node + size for the database cluster from which it is replicating. + status: + type: string + enum: + - creating + - online + - resizing + - migrating + - forking + example: creating + description: A string representing the current status of the database cluster. + readOnly: true + tags: + type: array + items: + type: string + example: + - production + description: >- + A flat array of tag names as strings applied to the read-only replica.

Requires `tag:read` scope. + created_at: + type: string + format: date-time + example: 2019-01-11T18:37:36Z + description: >- + A time value given in ISO8601 combined date and time format that represents + when the database cluster was created. + readOnly: true + private_network_uuid: + type: string + example: 9423cbad-9211-442f-820b-ef6915e99b5f + description: >- + A string specifying the UUID of the VPC to which the read-only replica + will be assigned. If excluded, the replica will be assigned to your + account's default VPC for the region. +

Requires `vpc:read` scope. + connection: + allOf: + - readOnly: true + - $ref: './database_connection.yml' + private_connection: + allOf: + - readOnly: true + - $ref: './database_connection.yml' + storage_size_mib: + type: integer + example: 61440 + description: >- + Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond + what is provided as a base amount from the 'size' and any previously added additional storage. + do_settings: + allOf: + - $ref: './do_settings.yml' + - description: >- + DigitalOcean-specific settings for the read-only replica, including custom service CNAMEs. + +required: + - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_storage_autoscale_params.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_storage_autoscale_params.yml new file mode 100644 index 000000000..7c7365f09 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_storage_autoscale_params.yml @@ -0,0 +1,29 @@ +type: object + +description: >- + Configuration for database cluster storage autoscaling + +properties: + enabled: + type: boolean + description: >- + Whether storage autoscaling is enabled for the cluster + example: true + threshold_percent: + type: integer + minimum: 15 + maximum: 95 + description: >- + The storage usage threshold percentage that triggers autoscaling. + When storage usage exceeds this percentage, additional storage will be added automatically. + example: 80 + increment_gib: + type: integer + minimum: 10 + maximum: 500 + description: >- + The amount of additional storage to add (in GiB) when autoscaling is triggered + example: 10 + +required: + - enabled diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_user.yml index 65f7f933f..fd3a6880a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_user.yml @@ -20,7 +20,7 @@ properties: password: type: string example: jge5lfxtzhx42iff - description: A randomly generated password for the database user. + description: A randomly generated password for the database user.
Requires `database:view_credentials` scope. readOnly: true access_cert: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/do_settings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/do_settings.yml new file mode 100644 index 000000000..2f701fb94 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/do_settings.yml @@ -0,0 +1,20 @@ +type: object + +description: >- + DigitalOcean-specific settings for the database cluster. + +properties: + service_cnames: + type: array + items: + type: string + pattern: '^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?)+$' + maxLength: 253 + maxItems: 16 + example: + - "db.example.com" + - "database.myapp.io" + description: >- + An array of custom CNAMEs for the database cluster. Each CNAME must be a valid + RFC 1123 hostname (e.g., "db.example.com"). Maximum of 16 CNAMEs allowed, each + up to 253 characters. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/eviction_policy_model.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/eviction_policy_model.yml index 87380d9f3..83b8f0cd7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/eviction_policy_model.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/eviction_policy_model.yml @@ -7,7 +7,7 @@ enum: - volatile_random - volatile_ttl description: |2- - A string specifying the desired eviction policy for the Redis cluster. + A string specifying the desired eviction policy for a Caching or Valkey cluster. - `noeviction`: Don't evict any data, returns error when memory limit is reached. - `allkeys_lru:` Evict any key, least recently used (LRU) first. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml index d93e723d9..93bf94ee9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/firewall_rule.yml @@ -39,7 +39,11 @@ properties: A time value given in ISO8601 combined date and time format that represents when the firewall rule was created. readOnly: true - + description: + type: string + example: 'an IP address for local development' + description: >- + A human-readable description of the rule. required: - type - value diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_verbose.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_verbose.yml new file mode 100644 index 000000000..426447649 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_verbose.yml @@ -0,0 +1,31 @@ +type: object + +properties: + schema_id: + type: integer + description: The id for schema. + example: 12345 + subject_name: + type: string + description: The name of the schema subject. + example: customer-schema + schema_type: + type: string + enum: + - AVRO + - JSON + - PROTOBUF + description: The type of the schema. + example: AVRO + schema: + type: string + description: The schema definition in the specified format. + example: |- + { + "type": "record", + "name": "Customer", + "fields": [ + {"name": "id", "type": "int"}, + {"name": "name", "type": "string"} + ] + } \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_version_verbose.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_version_verbose.yml new file mode 100644 index 000000000..1941fa97a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka_schema_version_verbose.yml @@ -0,0 +1,35 @@ +type: object + +properties: + schema_id: + type: integer + description: The id for schema. + example: 12345 + version: + type: string + description: The version of the schema. + example: "1" + subject_name: + type: string + description: The name of the schema subject. + example: customer-schema + schema_type: + type: string + enum: + - AVRO + - JSON + - PROTOBUF + description: The type of the schema. + example: AVRO + schema: + type: string + description: The schema definition in the specified format. + example: |- + { + "type": "record", + "name": "Customer", + "fields": [ + {"name": "id", "type": "int"}, + {"name": "name", "type": "string"} + ] + } \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/datadog_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/datadog_logsink.yml new file mode 100644 index 000000000..0c7c9ef66 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/datadog_logsink.yml @@ -0,0 +1,16 @@ +type: object +description: | + Configuration for Datadog integration **applicable only to MongoDB clusters**. +properties: + site: + type: string + example: http-intake.logs.datadoghq.com + description: Datadog connection URL + datadog_api_key: + type: string + example: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx + description: Datadog API key + +required: + - site + - datadog_api_key diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml index 487ca7dd8..63ef4def3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink/rsyslog_logsink.yml @@ -31,6 +31,24 @@ properties: Conditional (required if `format` == `custom`). Syslog log line template for a custom format, supporting limited rsyslog style templating (using `%tag%`). Supported tags are: `HOSTNAME`, `app-name`, `msg`, `msgid`, `pri`, `procid`, `structured-data`, `timestamp` and `timestamp:::date-rfc3339`. + + --- + **Datadog Integration Example for Non-Mongo clusters**: + ``` + DD_KEY <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.DB_NAME %app-name% - - - %msg% + ``` + - Replace `DD_KEY` with your actual Datadog API key. + - Replace `DB_NAME` with the actual name of your database cluster. + - Configure the Server: + - US Region: Use `intake.logs.datadoghq.com` + - EU Region: Use `tcp-intake.logs.datadoghq.eu` + - Configure the Port: + - US Region: Use port `10516` + - EU Region: Use port `443` + - Enable TLS: + - Ensure the TLS checkbox is enabled. + - Note: This configuration applies to **non-Mongo clusters only**. For **Mongo clusters**, use the `datadog_logsink` integration instead. + sd: type: string example: TOKEN tag="LiteralValue" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml index 95eb8e571..61042c6a5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_base.yml @@ -12,4 +12,13 @@ properties: - rsyslog - elasticsearch - opensearch + - datadog + description: | + Type of logsink integration. + + - Use `datadog` for Datadog integration **only with MongoDB clusters**. + - For non-MongoDB clusters, use `rsyslog` for general syslog forwarding. + - Other supported types include `elasticsearch` and `opensearch`. + + More details about the configuration can be found in the `config` property. example: rsyslog diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml index 3a44034f5..f031d9c4d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_create.yml @@ -7,4 +7,5 @@ allOf: anyOf: - $ref: './logsink/rsyslog_logsink.yml' - $ref: './logsink/elasticsearch_logsink.yml' - - $ref: './logsink/opensearch_logsink.yml' \ No newline at end of file + - $ref: './logsink/opensearch_logsink.yml' + - $ref: './logsink/datadog_logsink.yml' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml index 2174051d8..c0fa550ad 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_update.yml @@ -6,6 +6,7 @@ properties: - $ref: './logsink/rsyslog_logsink.yml' - $ref: './logsink/elasticsearch_logsink.yml' - $ref: './logsink/opensearch_logsink.yml' + - $ref: './logsink/datadog_logsink.yml' required: - config \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml index 2215096a6..9315351d1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/logsink_verbose.yml @@ -8,6 +8,7 @@ allOf: - $ref: './logsink/rsyslog_logsink.yml' - $ref: './logsink/elasticsearch_logsink.yml' - $ref: './logsink/opensearch_logsink.yml' + - $ref: './logsink/datadog_logsink.yml' example: config: server: 192.168.0.1 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/online_migration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/online_migration.yml index c9c55f2c4..9ab0b4bac 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/online_migration.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/online_migration.yml @@ -10,6 +10,7 @@ properties: description: The current status of the migration. enum: - running + - syncing - canceled - error - done diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml index 3eba6f8a2..09ec99c62 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml @@ -19,12 +19,12 @@ properties: readOnly: true user: type: string - description: The default user for the opensearch dashboard. + description: The default user for the opensearch dashboard.

Requires `database:view_credentials` scope. example: doadmin readOnly: true password: type: string - description: The randomly generated password for the default user. + description: The randomly generated password for the default user.

Requires `database:view_credentials` scope. example: wv78n3zpz42xezdk readOnly: true ssl: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml index b9b4cef3c..5e3ef636b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml @@ -29,6 +29,11 @@ properties: - $ref: "./database_region_options.yml" - $ref: "./database_version_options.yml" - $ref: "./database_layout_options.yml" + valkey: + allOf: + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" opensearch: allOf: - $ref: "./database_region_options.yml" @@ -45,6 +50,8 @@ properties: $ref: "./database_version_availabilities.yml" redis: $ref: "./database_version_availabilities.yml" + valkey: + $ref: "./database_version_availabilities.yml" mongodb: $ref: "./database_version_availabilities.yml" opensearch: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/schema_registry_connection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/schema_registry_connection.yml new file mode 100644 index 000000000..e750bb3bf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/schema_registry_connection.yml @@ -0,0 +1,34 @@ +type: object + +properties: + uri: + type: string + description: >- + This is provided as a convenience and should be able to be constructed by the other attributes. + example: https://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060 + readOnly: true + host: + type: string + description: The FQDN pointing to the schema registry connection uri. + example: backend-do-user-19081923-0.db.ondigitalocean.com + readOnly: true + port: + type: integer + description: The port on which the schema registry is listening. + example: 20835 + readOnly: true + user: + type: string + description: The default user for the schema registry.

Requires `database:view_credentials` scope. + example: doadmin + readOnly: true + password: + type: string + description: The randomly generated password for the schema registry.

Requires `database:view_credentials` scope. + example: wv78n3zpz42xezdk + readOnly: true + ssl: + type: boolean + description: A boolean value indicating if the connection should be made over SSL. + example: true + readOnly: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/source_database.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/source_database.yml index 996077dd5..e84c692f0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/source_database.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/source_database.yml @@ -1,5 +1,8 @@ type: object +required: + - source + properties: source: type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml index 756eaffa5..4f3325fa8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml @@ -68,3 +68,31 @@ properties: description: >- ACLs (Access Control Lists) specifying permissions on topics within a Kafka cluster. + mongo_user_settings: + type: object + properties: + databases: + type: array + items: + type: string + example: my-db + example: [my-db, my-db-2] + description: >- + A list of databases to which the user should have access. When the database is set to `admin`, + the user will have access to all databases based on the user's role i.e. a user with the role `readOnly` + assigned to the `admin` database will have read access to all databases. + role: + type: string + enum: + - readOnly + - readWrite + - dbAdmin + example: readOnly + description: >- + The role to assign to the user with each role mapping to a MongoDB built-in role. + `readOnly` maps to a [read](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-read) role. + `readWrite` maps to a [readWrite](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-readWrite) role. + `dbAdmin` maps to a [dbAdmin](https://www.mongodb.com/docs/manual/reference/built-in-roles/#mongodb-authrole-dbAdmin) role. + description: >- + MongoDB-specific settings for the user. This option is not currently + supported for other database engines. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml index 0847980c7..9da0e470e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/parameters.yml @@ -38,7 +38,7 @@ username: tag_name: in: query name: tag_name - description: Limits the results to database clusters with a specific tag. + description: Limits the results to database clusters with a specific tag.

Requires `tag:read` scope. required: false example: production schema: @@ -88,3 +88,21 @@ logsink_id: example: 50484ec3-19d6-4cd3-b56f-3b0381c289a6 schema: type: string + +kafka_schema_subject_name: + in: path + name: subject_name + description: The name of the Kafka schema subject. + required: true + example: customer-schema + schema: + type: string + +kafka_schema_version: + in: path + name: version + description: The version of the Kafka schema subject. + required: true + example: "1" + schema: + type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/autoscale.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/autoscale.yml new file mode 100644 index 000000000..9ed098d64 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/autoscale.yml @@ -0,0 +1,23 @@ +description: A JSON object with autoscale configuration details. + +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: + autoscale: + $ref: '../models/database_autoscale_params.yml' + example: + autoscale: + storage: + enabled: true + threshold_percent: 80 + increment_gib: 10 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_backups.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_backups.yml index ef885b7e1..d4a779e97 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_backups.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_backups.yml @@ -17,11 +17,40 @@ content: type: array items: $ref: '../models/backup.yml' + scheduled_backup_time: + type: object + properties: + backup_hour: + type: integer + example: 20 + description: The hour of the day when the backup is scheduled (in UTC). + backup_minute: + type: integer + example: 40 + description: The minute of the hour when the backup is scheduled. + backup_interval_hours: + type: integer + example: 24 + description: The frequency, in hours, at which backups are taken. + backup_progress: + type: string + example: '36' + description: >- + If a backup is currently in progress, this attribute shows the + percentage of completion. If no backup is in progress, this attribute + will be hidden. required: - backups example: backups: - created_at: '2019-01-11T18:42:27Z' size_gigabytes: 0.03357696 + incremental: false - created_at: '2019-01-12T18:42:29Z' size_gigabytes: 0.03364864 + incremental: true + scheduled_backup_time: + backup_hour: 20 + backup_minute: 40 + backup_interval_hours: 24 + backup_progress: '36' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml index 9cfb9918c..64a7d55f0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml @@ -14,7 +14,7 @@ content: type: object properties: database: - $ref: '../models/database_cluster.yml' + $ref: '../models/database_cluster_read.yml' required: - database example: @@ -80,3 +80,7 @@ content: version_end_of_life: '2023-11-09T00:00:00Z' version_end_of_availability: '2023-05-09T00:00:00Z' storage_size_mib: 61440 + do_settings: + service_cnames: + - "db.example.com" + - "database.myapp.io" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_clusters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_clusters.yml index 44c918ad7..4cc786e7c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_clusters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_clusters.yml @@ -15,7 +15,7 @@ content: databases: type: array items: - $ref: '../models/database_cluster.yml' + $ref: '../models/database_cluster_read.yml' example: databases: - id: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml index 6b0f36817..505291540 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_config.yml @@ -18,6 +18,7 @@ content: - $ref: '../models/advanced_config/mysql_advanced_config.yml' - $ref: '../models/advanced_config/postgres_advanced_config.yml' - $ref: '../models/advanced_config/redis_advanced_config.yml' + - $ref: '../models/advanced_config/valkey_advanced_config.yml' - $ref: '../models/advanced_config/kafka_advanced_config.yml' - $ref: '../models/advanced_config/opensearch_advanced_config.yml' - $ref: '../models/advanced_config/mongo_advanced_config.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replica.yml index fba605290..b2f2f0479 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replica.yml @@ -14,7 +14,7 @@ content: type: object properties: replica: - $ref: '../models/database_replica.yml' + $ref: '../models/database_replica_read.yml' example: replica: name: read-nyc3-01 @@ -37,3 +37,7 @@ content: region: nyc3 status: online created_at: '2019-01-11T18:37:36Z' + do_settings: + service_cnames: + - "replica-db.example.com" + - "read-replica.myapp.io" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replicas.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replicas.yml index 289a57ede..20c80fbc4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replicas.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_replicas.yml @@ -15,7 +15,7 @@ content: replicas: type: array items: - $ref: '../models/database_replica.yml' + $ref: '../models/database_replica_read.yml' example: replicas: - name: read-nyc3-01 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_config.yml new file mode 100644 index 000000000..0744fee61 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_config.yml @@ -0,0 +1,30 @@ +description: A JSON object with a key of `compatibility_level`. + +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: + compatibility_level: + type: string + enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + description: The compatibility level of the schema registry. + required: + - compatibility_level + example: + compatibility_level: BACKWARD \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_subject_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_subject_config.yml new file mode 100644 index 000000000..cc651d129 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_schema_registry_subject_config.yml @@ -0,0 +1,35 @@ +description: A JSON object with a key of `compatibility_level`. + +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: + subject_name: + type: string + description: The name of the schema subject. + compatibility_level: + type: string + enum: + - NONE + - BACKWARD + - BACKWARD_TRANSITIVE + - FORWARD + - FORWARD_TRANSITIVE + - FULL + - FULL_TRANSITIVE + description: The compatibility level of the schema registry. + required: + - subject_name + - compatibility_level + example: + subject_name: "my-schema-subject" + compatibility_level: BACKWARD diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/firewall_rules.yml index a6367d2e2..075190557 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/firewall_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/firewall_rules.yml @@ -26,6 +26,7 @@ content: - uuid: adfe81a8-0fa1-4e2d-973f-06aa5af19b44 cluster_uuid: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 type: ip_addr + description: 'a development IP address' value: 192.168.1.1 created_at: '2019-11-14T20:30:28Z' - uuid: b9b42276-8295-4313-b40f-74173a7f46e6 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema.yml new file mode 100644 index 000000000..717fcdb98 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema.yml @@ -0,0 +1,20 @@ +description: A JSON object. + +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: + - $ref: "../models/kafka_schema_verbose.yml" + required: + - schema_id + - subject_name + - schema_type + - schema diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema_version.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema_version.yml new file mode 100644 index 000000000..0e42c71cf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schema_version.yml @@ -0,0 +1,21 @@ +description: A JSON object. + +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: + - $ref: "../models/kafka_schema_version_verbose.yml" + required: + - schema_id + - subject_name + - schema_type + - schema + - version diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schemas.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schemas.yml new file mode 100644 index 000000000..24c257954 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/kafka_schemas.yml @@ -0,0 +1,18 @@ +description: A JSON object with a key of `subjects`. + +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: + subjects: + type: array + items: + $ref: '../models/kafka_schema_verbose.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml index e249bea69..f5955851e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink.yml @@ -13,13 +13,7 @@ content: schema: properties: sink: - allOf: - - $ref: "../models/logsink_verbose.yml" - required: - - sink_id - - sink_name - - sink_type - - config + $ref: "logsink_schema.yml" examples: Create an opensearch logsink: value: @@ -52,3 +46,12 @@ content: port: 514 tls: false format: rfc5424 + Create a datadog logsink: + value: + sink: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: logs-sink + sink_type: rsyslog + config: + site: http-intake.logs.datadoghq.com + datadog_api_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_data.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_data.yml new file mode 100644 index 000000000..a0a270951 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_data.yml @@ -0,0 +1,43 @@ +description: A JSON object with logsink properties. + +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: + $ref: "logsink_schema.yml" + examples: + Get an opensearch logsink: + value: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: "logs-sink" + sink_type: "opensearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "opensearch-logs" + index_days_max: 5 + Get an elasticsearch logsink: + value: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: "logs-sink" + sink_type: "elasticsearch" + config: + url: https://user:passwd@192.168.0.1:25060 + index_prefix: "elasticsearch-logs" + index_days_max: 5 + Get a rsyslog logsink: + value: + sink_id: "dfcc9f57d86bf58e321c2c6c31c7a971be244ac7" + sink_name: logs-sink + sink_type: rsyslog + config: + server: 192.168.0.1 + port: 514 + tls: false + format: rfc5424 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_schema.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_schema.yml new file mode 100644 index 000000000..2ee3e2070 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsink_schema.yml @@ -0,0 +1,7 @@ +allOf: + - $ref: "../models/logsink_verbose.yml" +required: + - sink_id + - sink_name + - sink_type + - config \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml index c41bef0b9..a81099c4c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/logsinks.yml @@ -15,13 +15,7 @@ content: sinks: type: array items: - allOf: - - $ref: "../models/logsink_verbose.yml" - required: - - sink_id - - sink_name - - sink_type - - config + $ref: "logsink_schema.yml" example: sinks: - sink_id: 799990b6-d551-454b-9ffe-b8618e9d6272 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml index 992e725dc..281acd4f0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml @@ -21,6 +21,7 @@ content: - fra1 - lon1 - nyc1 + - nyc2 - nyc3 - sfo2 - sfo3 @@ -28,8 +29,7 @@ content: - syd1 - tor1 versions: - - "3.6" - - "3.7" + - "3.8" layouts: - num_nodes: 3 sizes: @@ -49,6 +49,7 @@ content: sizes: - gd-2vcpu-8gb - gd-4vcpu-16gb + default_version: "3.8" mongodb: regions: - ams3 @@ -56,6 +57,7 @@ content: - fra1 - lon1 - nyc1 + - nyc2 - nyc3 - sfo2 - sfo3 @@ -63,7 +65,6 @@ content: - syd1 - tor1 versions: - - "5.0" - "6.0" - "7.0" layouts: @@ -109,6 +110,7 @@ content: - so1_5-16vcpu-128gb - so1_5-24vcpu-192gb - so1_5-32vcpu-256gb + default_version: "7.0" mysql: regions: - ams3 @@ -116,6 +118,7 @@ content: - fra1 - lon1 - nyc1 + - nyc2 - nyc3 - sfo2 - sfo3 @@ -224,6 +227,7 @@ content: - db-intel-8vcpu-32gb - db-amd-16vcpu-64gb - db-intel-16vcpu-64gb + default_version: "8" opensearch: regions: - ams3 @@ -231,6 +235,7 @@ content: - fra1 - lon1 - nyc1 + - nyc2 - nyc3 - sfo2 - sfo3 @@ -281,6 +286,7 @@ content: - gd-4vcpu-16gb - m3-4vcpu-32gb - m3-8vcpu-64gb + default_version: "2" pg: regions: - ams3 @@ -288,6 +294,7 @@ content: - fra1 - lon1 - nyc1 + - nyc2 - nyc3 - sfo2 - sfo3 @@ -299,6 +306,7 @@ content: - "14" - "15" - "16" + - "17" layouts: - num_nodes: 1 sizes: @@ -399,6 +407,7 @@ content: - db-intel-8vcpu-32gb - db-amd-16vcpu-64gb - db-intel-16vcpu-64gb + default_version: "17" redis: regions: - ams3 @@ -406,6 +415,7 @@ content: - fra1 - lon1 - nyc1 + - nyc2 - nyc3 - sfo2 - sfo3 @@ -458,49 +468,123 @@ content: - m-16vcpu-128gb - m-24vcpu-192gb - m-32vcpu-256gb + valkey: + regions: + - ams3 + - blr1 + - fra1 + - lon1 + - nyc1 + - nyc3 + - sfo2 + - sfo3 + - sgp1 + - syd1 + - tor1 + versions: + - "8" + layouts: + - num_nodes: 1 + sizes: + - db-s-1vcpu-1gb + - db-s-1vcpu-2gb + - db-s-2vcpu-4gb + - db-s-4vcpu-8gb + - db-s-6vcpu-16gb + - db-s-8vcpu-32gb + - db-s-16vcpu-64gb + - m-2vcpu-16gb + - m-4vcpu-32gb + - m-8vcpu-64gb + - m-16vcpu-128gb + - m-24vcpu-192gb + - m-32vcpu-256gb + - num_nodes: 2 + sizes: + - db-s-1vcpu-2gb + - db-s-2vcpu-4gb + - db-s-4vcpu-8gb + - db-s-6vcpu-16gb + - db-s-8vcpu-32gb + - db-s-16vcpu-64gb + - m-2vcpu-16gb + - m-4vcpu-32gb + - m-8vcpu-64gb + - m-16vcpu-128gb + - m-24vcpu-192gb + - m-32vcpu-256gb + - num_nodes: 3 + sizes: + - db-s-1vcpu-2gb + - db-s-2vcpu-4gb + - db-s-4vcpu-8gb + - db-s-6vcpu-16gb + - db-s-8vcpu-32gb + - db-s-16vcpu-64gb + - m-2vcpu-16gb + - m-4vcpu-32gb + - m-8vcpu-64gb + - m-16vcpu-128gb + - m-24vcpu-192gb + - m-32vcpu-256gb + default_version: "8" version_availability: kafka: - - end_of_life: - end_of_availability: "2024-07-18T00:00:00Z" - version: "3.6" - - end_of_life: - end_of_availability: "2025-01-17T00:00:00Z" - version: "3.7" + - end_of_life: null + end_of_availability: "2025-06-03T00:00:00Z" + version: "3.8" + default: true mongodb: - - end_of_life: "2024-10-01T07:00:00Z" - end_of_availability: - version: "5.0" - end_of_life: "2025-07-01T07:00:00Z" - end_of_availability: + end_of_availability: null version: "6.0" + default: false - end_of_life: "2026-08-01T07:00:00Z" - end_of_availability: + end_of_availability: null version: "7.0" + default: true mysql: - - end_of_life: - end_of_availability: + - end_of_life: null + end_of_availability: null version: "8" + default: true opensearch: - - end_of_life: - end_of_availability: + - end_of_life: null + end_of_availability: null version: "1" - - end_of_life: - end_of_availability: + default: false + - end_of_life: null + end_of_availability: null version: "2" + default: true pg: - end_of_life: "2025-11-13T00:00:00Z" end_of_availability: "2025-05-13T00:00:00Z" version: "13" + default: false - end_of_life: "2026-11-12T00:00:00Z" end_of_availability: "2026-05-12T00:00:00Z" version: "14" + default: false - end_of_life: "2027-11-11T00:00:00Z" end_of_availability: "2027-05-12T00:00:00Z" version: "15" + default: false - end_of_life: "2028-11-09T00:00:00Z" end_of_availability: "2028-05-09T00:00:00Z" version: "16" + default: false + - end_of_life: "2029-11-08T00:00:00Z" + end_of_availability: "2029-05-08T00:00:00Z" + version: "17" + default: true redis: - - end_of_life: - end_of_availability: + - end_of_life: "2025-06-30T00:00:00Z" + end_of_availability: "2025-04-30T00:00:00Z" version: "7" + default: true + valkey: + - end_of_life: null + end_of_availability: null + version: "8" + default: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml index c5a7c5aee..374ca5982 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml @@ -84,3 +84,5 @@ x-codeSamples: security: - bearer_auth: - 'domain:create' + - bearer_auth: + - 'domain:update' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml index e350131dc..af126b75a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml @@ -44,3 +44,5 @@ x-codeSamples: security: - bearer_auth: - 'domain:delete' + - bearer_auth: + - 'domain:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml index c150ce23c..cbdc641e1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml @@ -7,24 +7,24 @@ description: | `/v2/droplets/$DROPLET_ID/actions`. In the JSON body to the request, set the `type` attribute to on of the supported action types: - | Action | Details | - | ---------------------------------------- | ----------- | - | `enable_backups` | Enables backups for a Droplet | - | `disable_backups` | Disables backups for a Droplet | - | `change_backup_policy` | Update the backup policy for a Droplet | - | `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | - | `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | - | `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | - | `power_off` | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | - | `power_on` | Powers on a Droplet. | - | `restore` | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | - | `password_reset` | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | - | `resize` | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | - | `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | - | `rename` | Renames a Droplet. | - | `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | - | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | - | `snapshot` | Takes a snapshot of a Droplet. | + | Action | Details | Additionally Required Permission | + | ---------------------------------------- | ----------- | ----------- | + | `enable_backups` | Enables backups for a Droplet | | + | `disable_backups` | Disables backups for a Droplet | | + | `change_backup_policy` | Update the backup policy for a Droplet | | + | `reboot` | Reboots a Droplet. A `reboot` action is an attempt to reboot the Droplet in a graceful way, similar to using the `reboot` command from the console. | | + | `power_cycle` | Power cycles a Droplet. A `powercycle` action is similar to pushing the reset button on a physical machine, it's similar to booting from scratch. | | + | `shutdown` | Shutsdown a Droplet. A shutdown action is an attempt to shutdown the Droplet in a graceful way, similar to using the `shutdown` command from the console. Since a `shutdown` command can fail, this action guarantees that the command is issued, not that it succeeds. The preferred way to turn off a Droplet is to attempt a shutdown, with a reasonable timeout, followed by a `power_off` action to ensure the Droplet is off. | | + | `power_off` | Powers off a Droplet. A `power_off` event is a hard shutdown and should only be used if the `shutdown` action is not successful. It is similar to cutting the power on a server and could lead to complications. | | + | `power_on` | Powers on a Droplet. | | + | `restore` | Restore a Droplet using a backup image. The image ID that is passed in must be a backup of the current Droplet instance. The operation will leave any embedded SSH keys intact. | droplet:admin | + | `password_reset` | Resets the root password for a Droplet. A new password will be provided via email. It must be changed after first use. | droplet:admin | + | `resize` | Resizes a Droplet. Set the `size` attribute to a size slug. If a permanent resize with disk changes included is desired, set the `disk` attribute to `true`. | droplet:create | + | `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | droplet:admin | + | `rename` | Renames a Droplet. | | + | `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | | + | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | | + | `snapshot` | Takes a snapshot of a Droplet. | image:create | tags: - Droplet Actions diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml index 49194314c..d3b35590d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml @@ -16,7 +16,7 @@ description: | - `enable_ipv6` - `enable_backups` - `disable_backups` - - `snapshot` + - `snapshot` (also requires `image:create` permission) tags: - Droplet Actions @@ -26,7 +26,7 @@ parameters: requestBody: description: | - The `type` attribute set in the request body will specify the action that + The `type` attribute set in the request body will specify the action that will be taken on the Droplet. Some actions will require additional attributes to be set as well. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml index 791e7121e..23a9b0ffa 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml @@ -5,7 +5,9 @@ summary: Deleting Droplets by Tag description: | To delete **all** Droplets assigned to a specific tag, include the `tag_name` query parameter set to the name of the tag in your DELETE request. For - example, `/v2/droplets?tag_name=$TAG_NAME`. + example, `/v2/droplets?tag_name=$TAG_NAME`. + + This endpoint requires `tag:read` scope. A successful request will receive a 204 status code with no body in response. This indicates that the request was processed successfully. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml index 9d2bb2ab2..521765f3d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml @@ -47,3 +47,7 @@ x-codeSamples: security: - bearer_auth: - 'droplet:delete' + - 'block_storage:delete' + - 'block_storage_snapshot:delete' + - 'image:delete' + - 'reserved_ip:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml index d7dd2d335..f2b846413 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml @@ -47,3 +47,7 @@ x-codeSamples: security: - bearer_auth: - 'droplet:delete' + - 'block_storage:delete' + - 'block_storage_snapshot:delete' + - 'image:delete' + - 'reserved_ip:delete' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml index c5c73319a..8cf0591c7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml @@ -53,3 +53,7 @@ x-codeSamples: security: - bearer_auth: - 'droplet:delete' + - 'block_storage:delete' + - 'block_storage_snapshot:delete' + - 'image:delete' + - 'reserved_ip:delete' 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 1c057f2e2..93376f5eb 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 @@ -7,6 +7,9 @@ description: | Droplet, send a GET request to the `/v2/droplets/$DROPLET_ID/destroy_with_associated_resources` endpoint. + This endpoint will only return resources that you are authorized to see. For + example, to see associated Reserved IPs, include the `reserved_ip:read` scope. + The response will be a JSON object containing `snapshots`, `volumes`, and `volume_snapshots` keys. Each will be set to an array of objects containing information about the associated resources. @@ -42,4 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'droplet:delete' + - 'droplet:read' 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 ce7460f4b..770a6d8de 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 @@ -80,7 +80,7 @@ properties: - 53893572 description: An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the - instance creation. + instance creation.
Requires `image:read` scope. next_backup_window: allOf: @@ -96,10 +96,12 @@ properties: example: - 67512819 description: An array of snapshot IDs of any snapshots created from the - Droplet instance. + Droplet instance.
Requires `image:read` scope. image: - $ref: '../../images/models/image.yml' + allOf: + - $ref: '../../images/models/image.yml' + - description: The Droplet's image.
Requires `image:read` scope. volume_ids: type: array @@ -108,7 +110,7 @@ properties: example: - '506f78a4-e098-11e5-ad9f-000f53306ae1' description: A flat array including the unique identifier for each Block - Storage volume attached to the Droplet. + Storage volume attached to the Droplet.
Requires `block_storage:read` scope. size: $ref: '../../sizes/models/size.yml' @@ -146,13 +148,13 @@ properties: example: - web - env:prod - description: An array of Tags the Droplet has been tagged with. + description: An array of Tags the Droplet has been tagged with.
Requires `tag:read` scope. vpc_uuid: type: string example: '760e09ef-dc84-11e8-981e-3cfdfeaae000' description: A string specifying the UUID of the VPC to which the Droplet - is assigned. + is assigned.
Requires `vpc:read` scope. gpu_info: $ref: '../../sizes/models/gpu_info.yml' 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 b4ffb6032..714823c7b 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 @@ -23,7 +23,7 @@ properties: example: ubuntu-20-04-x64 description: The image ID of a public or private image or the slug identifier for a public image. This image will be the base image for - your Droplet. + your Droplet.
Requires `image:read` scope. ssh_keys: type: array @@ -36,7 +36,8 @@ properties: - 3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45 default: [] description: An array containing the IDs or fingerprints of the SSH keys - that you wish to embed in the Droplet's root account upon creation. + that you wish to embed in the Droplet's root account upon creation. You must add + the keys to your team before they can be embedded on a Droplet.
Requires `ssh_key:read` scope. backups: type: boolean @@ -74,7 +75,7 @@ properties: - web default: [] description: A flat array of tag names as strings to apply to the Droplet - after it is created. Tag names can either be existing or new tags. + after it is created. Tag names can either be existing or new tags.
Requires `tag:create` scope. user_data: type: string @@ -104,14 +105,14 @@ properties: default: [] description: An array of IDs for block storage volumes that will be attached to the Droplet once created. The volumes must not already be attached to - an existing Droplet. + an existing Droplet.
Requires `block_storage:read` scpoe. vpc_uuid: type: string example: 760e09ef-dc84-11e8-981e-3cfdfeaae000 description: A string specifying the UUID of the VPC to which the Droplet will be assigned. If excluded, the Droplet will be assigned to your - account's default VPC for the region. + account's default VPC for the region.
Requires `vpc:read` scope. with_droplet_agent: type: boolean 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 80ea30561..11bdcbbee 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,7 +12,7 @@ droplet_tag_name: in: query name: tag_name description: Used to filter Droplets by a specific tag. Can not be combined - with `name` or `type`. + with `name` or `type`.
Requires `tag:read` scope. required: false schema: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml index aad1f25d1..5c40687f4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/all_droplet_backup_policies.yml @@ -17,6 +17,7 @@ content: - type: object properties: policies: + type: object description: | A map where the keys are the Droplet IDs and the values are objects containing the backup policy information for each Droplet. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/associated_resources_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/associated_resources_list.yml index 0297463e5..e9542ea64 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/associated_resources_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/responses/associated_resources_list.yml @@ -17,22 +17,27 @@ content: properties: reserved_ips: type: array + description: Reserved IPs that are associated with this Droplet.
Requires `reserved_ip:read` scope. items: $ref: '../models/associated_resource.yml' floating_ips: type: array + description: Floating IPs that are associated with this Droplet.
Requires `reserved_ip:read` scope. items: $ref: '../models/associated_resource.yml' snapshots: type: array + description: Snapshots that are associated with this Droplet.
Requires `image:read` scope. items: $ref: '../models/associated_resource.yml' volumes: type: array + description: Volumes that are associated with this Droplet.
Requires `block_storage:read` scope. items: $ref: '../models/associated_resource.yml' volume_snapshots: type: array + description: Volume Snapshots that are associated with this Droplet.
Requires `block_storage_snapshot:read` scope. items: $ref: '../models/associated_resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml index b870374be..47201235c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml @@ -7,6 +7,8 @@ description: | `/v2/firewalls/$FIREWALL_ID`. The request should contain a full representation of the firewall including existing attributes. **Note that any attributes that are not provided will be reset to their default values.** +

You must have read access (e.g. `droplet:read`) to all resources attached + to the firewall to successfully update the firewall. tags: - Firewalls diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml index 821b75121..0dc2a7598 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/models/firewall.yml @@ -70,6 +70,7 @@ allOf: type: array description: >- An array containing the IDs of the Droplets assigned to the firewall. +

Requires `droplet:read` scope. nullable: true items: type: integer @@ -81,6 +82,7 @@ allOf: - $ref: "../../../shared/attributes/existing_tags_array.yml" - description: >- An array containing the names of the Tags assigned to the firewall. +

Requires `tag:read` scope. example: gateway - $ref: "firewall_rule.yml#/firewall_rules" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/create_firewall_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/create_firewall_response.yml index 6e70b98af..f30c2659a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/create_firewall_response.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/create_firewall_response.yml @@ -1,6 +1,6 @@ description: >- The response will be a JSON object with a firewall key. This will be set to - an object containing the standard firewall attributes + an object containing the standard firewall attributes. headers: ratelimit-limit: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/get_firewall_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/get_firewall_response.yml index eb7fe545e..fed358b50 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/get_firewall_response.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/get_firewall_response.yml @@ -1,6 +1,8 @@ description: >- The response will be a JSON object with a firewall key. This will be set to an - object containing the standard firewall attributes. + object containing the standard firewall attributes.

Firewalls responses + will include only the resources that you are granted to see. Ensure that your + API token includes all necessary `:read` permissions for requested firewall. headers: ratelimit-limit: @@ -46,4 +48,4 @@ content: droplet_ids: - 8043964 tags: [] - pending_changes: [] \ No newline at end of file + pending_changes: [] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/list_firewalls_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/list_firewalls_response.yml index 6dca1b4c7..2cc794478 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/list_firewalls_response.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/responses/list_firewalls_response.yml @@ -1,6 +1,8 @@ description: >- To list all of the firewalls available on your account, send a GET request to - `/v2/firewalls`. + `/v2/firewalls`.

Firewalls responses will include only the resources + that you are granted to see. Ensure that your API token includes all necessary + `:read` permissions for requested firewall. headers: ratelimit-limit: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml index e4ad6626f..ad2918438 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml @@ -12,9 +12,6 @@ description: >- * To create a new floating IP reserved to a region, send a POST request to `/v2/floating_ips` with the `region` attribute. - **Note**: In addition to the standard rate limiting, only 12 floating IPs may - be created per 60 seconds. - tags: - Floating IPs diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/models/floating_ip.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/models/floating_ip.yml index d5bfeb079..3754c89c1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/models/floating_ip.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/models/floating_ip.yml @@ -20,6 +20,7 @@ properties: you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null. +

Requires `droplet:read` scope. anyOf: - title: 'null' type: object @@ -39,4 +40,4 @@ properties: type: string format: uuid example: 746c6152-2fa2-11ed-92d3-27aaa54e4988 - description: The UUID of the project to which the reserved IP currently belongs. + description: The UUID of the project to which the reserved IP currently belongs.

Requires `project:read` scope. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml index a0f707a0e..c7cee19af 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/definitions.yml @@ -1,3 +1,41 @@ +apiAWSDataSource: + description: AWS S3 Data Source + properties: + bucket_name: + description: Spaces bucket name + example: example name + type: string + item_path: + example: example string + type: string + key_id: + description: The AWS Key ID + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + region: + description: Region of bucket + example: example string + type: string + secret_key: + description: The AWS Secret Key + example: example string + type: string + type: object +apiAWSDataSourceDisplay: + description: AWS S3 Data Source for Display + properties: + bucket_name: + description: Spaces bucket name + example: example name + type: string + item_path: + example: example string + type: string + region: + description: Region of bucket + example: example string + type: string + type: object apiAcceptAgreementOutput: description: AcceptAgreementOutput Description properties: @@ -31,6 +69,10 @@ apiAgent: items: $ref: '#/apiAgent' type: array + conversation_logs_enabled: + description: Whether conversation logs are enabled for the agent + example: true + type: boolean created_at: description: Creation date / time example: "2023-01-01T00:00:00Z" @@ -40,7 +82,7 @@ apiAgent: $ref: '#/apiDeployment' description: description: Description of agent - example: '"example string"' + example: example string type: string functions: items: @@ -52,13 +94,13 @@ apiAgent: $ref: '#/apiAgentGuardrail' type: array if_case: - example: '"example string"' + example: example string type: string instruction: description: Agent instruction. Instructions help your agent to perform its job effectively. See [Write Effective Agent Instructions](https://docs.digitalocean.com/products/genai-platform/concepts/best-practices/#agent-instructions) for best practices. - example: '"example string"' + example: example string type: string k: example: 123 @@ -69,50 +111,62 @@ apiAgent: items: $ref: '#/apiKnowledgeBase' type: array + logging_config: + $ref: '#/apiAgentLoggingConfig' max_tokens: example: 123 format: int64 type: integer model: $ref: '#/apiModel' + model_provider_key: + $ref: '#/apiModelProviderKeyInfo' name: description: Agent name - example: '"example name"' + example: example name type: string + openai_api_key: + $ref: '#/apiOpenAIAPIKeyInfo' parent_agents: description: Parent agents items: $ref: '#/apiAgent' type: array project_id: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string + provide_citations: + description: Whether the agent should provide in-response citations + example: true + type: boolean region: description: Region code - example: '"example string"' + example: example string type: string + retrieval_method: + $ref: '#/apiRetrievalMethod' route_created_at: description: Creation of route date / time example: "2023-01-01T00:00:00Z" format: date-time type: string route_created_by: - example: '"12345"' + example: "12345" format: uint64 type: string route_name: description: Route name - example: '"example name"' + example: example name type: string route_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string tags: description: Agent tag to organize related resources example: - example string items: - example: '"example string"' + example: example string type: string type: array temperature: @@ -132,24 +186,41 @@ apiAgent: type: string url: description: Access your agent under this url - example: '"example string"' + example: example string type: string user_id: description: Id of user that created the agent - example: '"12345"' + example: "12345" format: uint64 type: string uuid: description: Unique agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + version_hash: + description: The latest version of the agent + example: example string + type: string + vpc_egress_ips: + description: VPC Egress IPs + example: + - example string + items: + example: example string + type: string + type: array + vpc_uuid: + example: '"12345678-1234-1234-1234-123456789012"' type: string + workspace: + $ref: '#/apiWorkspace' type: object apiAgentAPIKey: description: Agent API Key properties: api_key: description: Api key - example: '"example string"' + example: example string type: string type: object apiAgentAPIKeyInfo: @@ -162,7 +233,7 @@ apiAgentAPIKeyInfo: type: string created_by: description: Created by - example: '"12345"' + example: "12345" format: uint64 type: string deleted_at: @@ -172,14 +243,14 @@ apiAgentAPIKeyInfo: type: string name: description: Name - example: '"example name"' + example: example name type: string secret_key: - example: '"example string"' + example: example string type: string uuid: description: Uuid - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiAgentChatbotIdentifier: @@ -187,7 +258,101 @@ apiAgentChatbotIdentifier: properties: agent_chatbot_identifier: description: Agent chatbot identifier - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgentChildRelationshipVerion: + properties: + agent_name: + description: Name of the child agent + example: example name + type: string + child_agent_uuid: + description: Child agent unique identifier + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + if_case: + description: If case + example: example string + type: string + is_deleted: + description: Child agent is deleted + example: true + type: boolean + route_name: + description: Route name + example: example name + type: string + type: object +apiAgentConversationLogConfig: + description: Response for getting or creating an agent conversation log location + properties: + agent_uuid: + description: Agent UUID + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + spaces_data_source: + $ref: '#/apiSpacesDataSource' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + type: object +apiAgentDeploymentCodeArtifact: + description: File to upload + properties: + agent_code_file_path: + description: The agent code file path + example: example string + type: string + size_in_bytes: + description: The size of the file in bytes + example: "12345" + format: uint64 + type: string + stored_object_key: + description: The object key the file was stored as + example: example string + type: string + type: object +apiAgentDeploymentRelease: + description: An Agent Deployment Release + properties: + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by_user_email: + description: Email of user that created the agent deployment release + example: example@example.com + type: string + created_by_user_id: + description: Id of user that created the agent deployment release + example: "12345" + format: uint64 + type: string + error_msg: + description: A error message provinding a hint which part of the system experienced + an error + example: example string + type: string + status: + $ref: '#/apiReleaseStatus' + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique release id + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiAgentFunction: @@ -195,28 +360,33 @@ apiAgentFunction: properties: api_key: description: Api key - example: '"example string"' + example: example string type: string created_at: description: Creation date / time example: "2023-01-01T00:00:00Z" format: date-time type: string + created_by: + description: Created by user id from DO + example: "12345" + format: uint64 + type: string description: description: Agent description - example: '"example string"' + example: example string type: string faas_name: - example: '"example name"' + example: example name type: string faas_namespace: - example: '"example name"' + example: example name type: string input_schema: type: object name: description: Name - example: '"example name"' + example: example name type: string output_schema: type: object @@ -227,31 +397,55 @@ apiAgentFunction: type: string url: description: Download your agent here - example: '"example string"' + example: example string type: string uuid: description: Unique id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgentFunctionVersion: + description: Function represents a function configuration for an agent + properties: + description: + description: Description of the function + example: example string + type: string + faas_name: + description: FaaS name of the function + example: example name + type: string + faas_namespace: + description: FaaS namespace of the function + example: example name + type: string + is_deleted: + description: Whether the function is deleted + example: true + type: boolean + name: + description: Name of the function + example: example name type: string type: object apiAgentGuardrail: description: A Agent Guardrail properties: agent_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string created_at: example: "2023-01-01T00:00:00Z" format: date-time type: string default_response: - example: '"example string"' + example: example string type: string description: - example: '"example string"' + example: example string type: string guardrail_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string is_attached: example: true @@ -262,7 +456,7 @@ apiAgentGuardrail: metadata: type: object name: - example: '"example name"' + example: example name type: string priority: example: 123 @@ -275,27 +469,117 @@ apiAgentGuardrail: format: date-time type: string uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgentGuardrailInput: + properties: + guardrail_uuid: + description: Guardrail uuid + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + priority: + description: Priority of the guardrail + example: 123 + format: int64 + type: integer + type: object +apiAgentGuardrailVersion: + description: Agent Guardrail version + properties: + is_deleted: + description: Whether the guardrail is deleted + example: true + type: boolean + name: + description: Guardrail Name + example: example name + type: string + priority: + description: Guardrail Priority + example: 123 + format: int64 + type: integer + uuid: + description: Guardrail UUID + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgentKnowledgeBaseVersion: + properties: + is_deleted: + description: Deletet at date / time + example: true + type: boolean + name: + description: Name of the knowledge base + example: example name + type: string + uuid: + description: Unique id of the knowledge base + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgentLogInsightsPrice: + properties: + attributes: + items: + $ref: '#/apiBillingAttribute' + type: array + display_name: + example: example name + type: string + prices: + items: + $ref: '#/apiBillingPrice' + type: array + type: object +apiAgentLoggingConfig: + properties: + galileo_project_id: + description: Galileo project identifier + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + galileo_project_name: + description: Name of the Galileo project + example: example name + type: string + insights_enabled: + description: Whether insights are enabled + example: true + type: boolean + insights_enabled_at: + description: Timestamp when insights were enabled + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + log_stream_id: + description: Identifier for the log stream + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + log_stream_name: + description: Name of the log stream + example: example name type: string type: object apiAgentModelUsage: properties: agent_name: description: Agent name - example: '"example name"' + example: example name type: string agent_uuid: description: Agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string requests_used: description: Requests used - example: '"12345"' + example: "12345" format: uint64 type: string tokens_used: description: Tokens used - example: '"12345"' + example: "12345" format: uint64 type: string type: object @@ -306,10 +590,10 @@ apiAgentPrice: $ref: '#/apiBillingAttribute' type: array display_name: - example: '"example name"' + example: example name type: string model_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string prices: items: @@ -370,10 +654,16 @@ apiAgentPublic: description: The DigitalOcean project ID associated with the agent example: 12345678-1234-1234-1234-123456789012 type: string + provide_citations: + description: Whether the agent should provide in-response citations + example: true + type: boolean region: description: Region code example: '"tor1"' type: string + retrieval_method: + $ref: '#/apiRetrievalMethod' route_created_at: description: Creation of route date / time example: "2021-01-01T00:00:00Z" @@ -397,7 +687,7 @@ apiAgentPublic: example: - example string items: - example: '"example string"' + example: example string type: string type: array temperature: @@ -434,6 +724,10 @@ apiAgentPublic: description: Unique agent id example: '"12345678-1234-1234-1234-123456789012"' type: string + version_hash: + description: The latest version of the agent + example: example string + type: string type: object apiAgentTemplate: description: Represents an AgentTemplate entity @@ -444,12 +738,17 @@ apiAgentTemplate: format: date-time type: string description: - description: Description of the agent template - example: '"example string"' + description: Deprecated - Use summary instead + example: example string type: string + guardrails: + description: List of guardrails associated with the agent template + items: + $ref: '#/apiAgentTemplateGuardrail' + type: array instruction: description: Instructions for the agent template - example: '"example string"' + example: example string type: string k: description: The 'k' value for the agent template @@ -461,6 +760,15 @@ apiAgentTemplate: items: $ref: '#/apiKnowledgeBase' type: array + long_description: + description: The long description of the agent template + example: '"Enhance your customer service with an AI agent designed to provide + consistent, helpful, and accurate support across multiple channels. This template + creates an agent that can answer product questions, troubleshoot common issues, + process simple requests, and maintain a friendly, on-brand voice throughout + customer interactions. Reduce response times, handle routine inquiries efficiently, + and ensure your customers feel heard and helped."' + type: string max_tokens: description: The max_tokens setting for the agent template example: 123 @@ -470,13 +778,34 @@ apiAgentTemplate: $ref: '#/apiModel' name: description: Name of the agent template - example: '"example name"' + example: example name type: string + short_description: + description: The short description of the agent template + example: '"This template has been designed with question-answer and conversational + use cases in mind. It comes with validated agent instructions, fine-tuned + model settings, and preconfigured guardrails defined for customer support-related + use cases."' + type: string + summary: + description: The summary of the agent template + example: example string + type: string + tags: + description: List of tags associated with the agent template + example: + - example string + items: + example: example string + type: string + type: array temperature: description: The temperature setting for the agent template example: 123 format: float type: number + template_type: + $ref: '#/apiAgentTemplateType' top_p: description: The top_p setting for the agent template example: 123 @@ -489,82 +818,294 @@ apiAgentTemplate: type: string uuid: description: Unique id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object -apiAgreement: - description: Agreement Description +apiAgentTemplateGuardrail: properties: - description: - example: '"example string"' - type: string - name: - example: '"example name"' - type: string - url: - example: '"example string"' - type: string + priority: + description: Priority of the guardrail + example: 123 + format: int32 + type: integer uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + description: Uuid of the guardrail + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object -apiAnthropicAPIKeyInfo: - description: Anthropic API Key Info +apiAgentTemplateType: + default: AGENT_TEMPLATE_TYPE_STANDARD + description: |- + - AGENT_TEMPLATE_TYPE_STANDARD: The standard agent template + - AGENT_TEMPLATE_TYPE_ONE_CLICK: The one click agent template + enum: + - AGENT_TEMPLATE_TYPE_STANDARD + - AGENT_TEMPLATE_TYPE_ONE_CLICK + example: AGENT_TEMPLATE_TYPE_STANDARD + type: string +apiAgentVersion: + description: Represents an AgentVersion entity properties: + agent_uuid: + description: Uuid of the agent this version belongs to + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + attached_child_agents: + description: List of child agent relationships + items: + $ref: '#/apiAgentChildRelationshipVerion' + type: array + attached_functions: + description: List of function versions + items: + $ref: '#/apiAgentFunctionVersion' + type: array + attached_guardrails: + description: List of guardrail version + items: + $ref: '#/apiAgentGuardrailVersion' + type: array + attached_knowledgebases: + description: List of knowledge base agent versions + items: + $ref: '#/apiAgentKnowledgeBaseVersion' + type: array + can_rollback: + description: Whether the version is able to be rolled back to + example: true + type: boolean created_at: - description: Key creation date + description: Creation date example: "2023-01-01T00:00:00Z" format: date-time type: string - created_by: - description: Created by user id from DO - example: '"12345"' + created_by_email: + description: User who created this version + example: example@example.com + type: string + currently_applied: + description: Whether this is the currently applied configuration + example: true + type: boolean + description: + description: Description of the agent + example: example string + type: string + id: + description: Unique identifier + example: "12345" format: uint64 type: string - deleted_at: - description: Key deleted date - example: "2023-01-01T00:00:00Z" - format: date-time + instruction: + description: Instruction for the agent + example: example string + type: string + k: + description: K value for the agent's configuration + example: 123 + format: int64 + type: integer + max_tokens: + description: Max tokens setting for the agent + example: 123 + format: int64 + type: integer + model_name: + description: Name of model associated to the agent version + example: example name type: string name: - description: Name - example: '"example name"' + description: Name of the agent + example: example name type: string - updated_at: - description: Key last updated date - example: "2023-01-01T00:00:00Z" - format: date-time + provide_citations: + description: Whether the agent should provide in-response citations + example: true + type: boolean + retrieval_method: + $ref: '#/apiRetrievalMethod' + tags: + description: Tags associated with the agent + example: + - example string + items: + example: example string + type: string + type: array + temperature: + description: Temperature setting for the agent + example: 123 + format: float + type: number + top_p: + description: Top_p setting for the agent + example: 123 + format: float + type: number + trigger_action: + description: Action triggering the configuration update + example: example string type: string - uuid: - description: Uuid - example: '"123e4567-e89b-12d3-a456-426614174000"' + version_hash: + description: Version hash + example: example string type: string type: object -apiAuditHeader: - description: An alternative way to provide auth information. for internal use only. +apiAgentWorkspace: + description: An Agent Workspace properties: - actor_id: - example: '"12345"' - format: uint64 - type: string + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by_user_email: + description: Email of user that created the agent workspace + example: example@example.com + type: string + created_by_user_id: + description: Id of user that created the agent workspace + example: "12345" + format: uint64 + type: string + deployments: + description: The deployments the agent workspace has + items: + $ref: '#/apiAgentWorkspaceDeployment' + type: array + name: + description: Agent name + example: example name + type: string + project_id: + description: The project id the agent workspace belogs to + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + team_id: + description: Team id the agent workspace belongs to + example: "12345" + format: uint64 + type: string + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique agent id + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgentWorkspaceDeployment: + description: An Agent Workspace Deployment + properties: + active_release: + $ref: '#/apiAgentDeploymentRelease' + created_at: + description: Creation date / time + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by_user_email: + description: Email of user that created the agent workspace + example: example@example.com + type: string + created_by_user_id: + description: Id of user that created the agent workspace + example: "12345" + format: uint64 + type: string + latest_release: + $ref: '#/apiAgentDeploymentRelease' + logging_config: + $ref: '#/apiAgentLoggingConfig' + name: + description: Agent name + example: example name + type: string + updated_at: + description: Last modified + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique agent id + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAgreement: + description: Agreement Description + properties: + description: + example: example string + type: string + name: + example: example name + type: string + url: + example: example string + type: string + uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAnthropicAPIKeyInfo: + description: Anthropic API Key Info + properties: + created_at: + description: Key creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by user id from DO + example: "12345" + format: uint64 + type: string + deleted_at: + description: Key deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + name: + description: Name + example: example name + type: string + updated_at: + description: Key last updated date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Uuid + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiAuditHeader: + description: An alternative way to provide auth information. for internal use only. + properties: + actor_id: + example: "12345" + format: uint64 + type: string actor_ip: - example: '"example string"' + example: example string type: string actor_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string context_urn: - example: '"example string"' + example: example string type: string origin_application: - example: '"example string"' + example: example string type: string user_id: - example: '"12345"' + example: "12345" format: uint64 type: string user_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiBatchJobPhase: @@ -576,24 +1117,25 @@ apiBatchJobPhase: - BATCH_JOB_PHASE_SUCCEEDED - BATCH_JOB_PHASE_FAILED - BATCH_JOB_PHASE_ERROR + - BATCH_JOB_PHASE_CANCELLED example: BATCH_JOB_PHASE_UNKNOWN type: string apiBillingAttribute: properties: name: - example: '"example name"' + example: example name type: string value: - example: '"example string"' + example: example string type: string type: object apiBillingPrice: properties: rate: - example: '"example string"' + example: example string type: string region: - example: '"example string"' + example: example string type: string type: object apiCancelKnowledgeBaseIndexingJobInputPublic: @@ -613,26 +1155,94 @@ apiCancelKnowledgeBaseIndexingJobOutput: apiChatbot: description: A Chatbot properties: + allowed_domains: + example: + - example string + items: + example: example string + type: string + type: array button_background_color: - example: '"example string"' + example: example string type: string logo: - example: '"example string"' + example: example string type: string name: description: Name of chatbot - example: '"example name"' + example: example name type: string primary_color: - example: '"example string"' + example: example string type: string secondary_color: - example: '"example string"' + example: example string type: string starting_message: - example: '"example string"' + example: example string type: string type: object +apiChunkingAlgorithm: + default: CHUNKING_ALGORITHM_SECTION_BASED + description: |- + The chunking algorithm to use for processing data sources. + + **Note: This feature requires enabling the knowledgebase enhancements feature preview flag.** + enum: + - CHUNKING_ALGORITHM_UNKNOWN + - CHUNKING_ALGORITHM_SECTION_BASED + - CHUNKING_ALGORITHM_HIERARCHICAL + - CHUNKING_ALGORITHM_SEMANTIC + - CHUNKING_ALGORITHM_FIXED_LENGTH + example: CHUNKING_ALGORITHM_SECTION_BASED + type: string +apiChunkingOptions: + description: |- + Configuration options for the chunking algorithm. + + **Note: This feature requires enabling the knowledgebase enhancements feature preview flag.** + properties: + child_chunk_size: + description: Hierarchical options + example: 350 + format: int64 + type: integer + max_chunk_size: + description: Section_Based and Fixed_Length options + example: 750 + format: int64 + type: integer + parent_chunk_size: + description: Hierarchical options + example: 1000 + format: int64 + type: integer + semantic_threshold: + description: Semantic options + example: 0.5 + format: float + type: number + type: object +apiCrawlingOption: + default: UNKNOWN + description: |- + Options for specifying how URLs found on pages should be handled. + + - UNKNOWN: Default unknown value + - SCOPED: Only include the base URL. + - PATH: Crawl the base URL and linked pages within the URL path. + - DOMAIN: Crawl the base URL and linked pages within the same domain. + - SUBDOMAINS: Crawl the base URL and linked pages for any subdomain. + - SITEMAP: Crawl URLs discovered in the sitemap. + enum: + - UNKNOWN + - SCOPED + - PATH + - DOMAIN + - SUBDOMAINS + - SITEMAP + example: UNKNOWN + type: string apiCreateAgentAPIKeyInputPublic: properties: agent_uuid: @@ -649,6 +1259,45 @@ apiCreateAgentAPIKeyOutput: api_key_info: $ref: '#/apiAgentAPIKeyInfo' type: object +apiCreateAgentDeploymentFileUploadPresignedURLInputPublic: + description: Request for pre-signed URL's to upload file for Agent Workspace + properties: + file: + $ref: '#/apiPresignedUrlFile' + type: object +apiCreateAgentDeploymentFileUploadPresignedURLOutput: + description: Response with pre-signed url to upload file + properties: + request_id: + description: The ID generated for the request for Presigned URLs. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + upload: + $ref: '#/apiFilePresignedUrlResponse' + type: object +apiCreateAgentDeploymentReleaseInputPublic: + properties: + agent_deployment_code_artifact: + $ref: '#/apiAgentDeploymentCodeArtifact' + agent_deployment_name: + description: The deployment name + example: example name + type: string + agent_workspace_name: + description: The name of agent workspace + example: example name + type: string + type: object +apiCreateAgentDeploymentReleaseOutput: + description: One Agent Deployment Release + properties: + agent_deployment_release: + $ref: '#/apiAgentDeploymentRelease' + type: object +apiCreateAgentFromTemplateInput: + properties: + conversation_logs_enabled: + example: "false" apiCreateAgentFromTemplateInputPublic: properties: project_id: @@ -657,14 +1306,26 @@ apiCreateAgentFromTemplateInputPublic: example: '"tor1"' template_uuid: example: '"12345678-1234-1234-1234-123456789012"' + workspace_uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiCreateAgentFromTemplateOutput: properties: agent: $ref: '#/apiAgent' type: object +apiCreateAgentInput: + properties: + conversation_logs_enabled: + example: "false" + vpc_uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiCreateAgentInputPublic: description: Parameters for Agent Creation properties: + anthropic_key_uuid: + description: Optional Anthropic API key ID to use with Anthropic models + example: '"12345678-1234-1234-1234-123456789012"' + type: string description: description: A text description of the agent, not used in inference example: '"My Agent Description"' @@ -680,9 +1341,12 @@ apiCreateAgentInputPublic: example: - example string items: - example: '"example string"' + example: example string type: string type: array + model_provider_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + type: string model_uuid: description: Identifier for the foundation model. example: '"12345678-1234-1234-1234-123456789012"' @@ -691,6 +1355,10 @@ apiCreateAgentInputPublic: description: Agent name example: '"My Agent"' type: string + open_ai_key_uuid: + description: Optional OpenAI API key ID to use with OpenAI models + example: '"12345678-1234-1234-1234-123456789012"' + type: string project_id: description: The id of the DigitalOcean project this agent will belong to example: '"12345678-1234-1234-1234-123456789012"' @@ -704,9 +1372,13 @@ apiCreateAgentInputPublic: example: - example string items: - example: '"example string"' + example: example string type: string type: array + workspace_uuid: + description: Identifier for the workspace + example: 123e4567-e89b-12d3-a456-426614174000 + type: string type: object apiCreateAgentOutput: description: Information about a newly created Agent @@ -714,6 +1386,60 @@ apiCreateAgentOutput: agent: $ref: '#/apiAgent' type: object +apiCreateAgentWorkspaceDeploymentInputPublic: + properties: + agent_deployment_code_artifact: + $ref: '#/apiAgentDeploymentCodeArtifact' + agent_deployment_name: + description: The deployment name + example: example name + type: string + agent_workspace_name: + description: The name of agent workspace + example: example name + type: string + type: object +apiCreateAgentWorkspaceDeploymentOutput: + description: One Agent Workspace Deployment + properties: + agent_workspace_deployment: + $ref: '#/apiAgentWorkspaceDeployment' + type: object +apiCreateAgentWorkspaceInputPublic: + properties: + agent_deployment_code_artifact: + $ref: '#/apiAgentDeploymentCodeArtifact' + agent_deployment_name: + description: The deployment name + example: example name + type: string + agent_workspace_name: + description: The name of agent workspace + example: example name + type: string + project_id: + description: The project id + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiCreateAgentWorkspaceOutput: + properties: + agent_workspace: + $ref: '#/apiAgentWorkspace' + type: object +apiCreateAnthropicAPIKeyInputPublic: + description: CreateAnthropicAPIKeyInputPublic is used to create a new Anthropic + API key for a specific agent. + properties: + api_key: + description: Anthropic API key + example: '"sk-ant-12345678901234567890123456789012"' + type: string + name: + description: Name of the key + example: '"Production Key"' + type: string + type: object apiCreateAnthropicAPIKeyOutput: description: CreateAnthropicAPIKeyOutput is used to return the newly created Anthropic API key. @@ -731,12 +1457,21 @@ apiCreateChatbotOutput: chatbot: $ref: '#/apiChatbot' type: object +apiCreateDataSourceFileUploadPresignedUrlsInputPublic: + description: Request for pre-signed URL's to upload files for KB Data Sources + properties: + files: + description: A list of files to generate presigned URLs for. + items: + $ref: '#/apiPresignedUrlFile' + type: array + type: object apiCreateDataSourceFileUploadPresignedUrlsOutput: description: Response with pre-signed urls to upload files. properties: request_id: description: The ID generated for the request for Presigned URLs. - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string uploads: description: A list of generated presigned URLs and object keys, one per file. @@ -744,6 +1479,65 @@ apiCreateDataSourceFileUploadPresignedUrlsOutput: $ref: '#/apiFilePresignedUrlResponse' type: array type: object +apiCreateEvaluationDatasetInputPublic: + description: Creates an evaluation dataset for an agent + properties: + dataset_type: + $ref: '#/apiEvaluationDatasetType' + file_upload_dataset: + $ref: '#/apiFileUploadDataSource' + name: + description: The name of the agent evaluation dataset. + example: example name + type: string + type: object +apiCreateEvaluationDatasetOutput: + description: Output for creating an agent evaluation dataset + properties: + evaluation_dataset_uuid: + description: Evaluation dataset uuid. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiCreateEvaluationTestCaseInputPublic: + properties: + agent_workspace_name: + example: example name + type: string + dataset_uuid: + description: Dataset against which the test‑case is executed. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + description: + description: Description of the test case. + example: example string + type: string + metrics: + description: Full metric list to use for evaluation test case. + example: + - example string + items: + example: example string + type: string + type: array + name: + description: Name of the test case. + example: example name + type: string + star_metric: + $ref: '#/apiStarMetric' + workspace_uuid: + description: The workspace uuid. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiCreateEvaluationTestCaseOutput: + properties: + test_case_uuid: + description: Test‑case UUID. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object apiCreateGuardrailOutput: description: CreateGuardrailOutput description properties: @@ -753,14 +1547,20 @@ apiCreateGuardrailOutput: apiCreateKnowledgeBaseDataSourceInputPublic: description: Data to create a knowledge base data source properties: - file_upload_data_source: - $ref: '#/apiFileUploadDataSource' + aws_data_source: + $ref: '#/apiAWSDataSource' + chunking_algorithm: + $ref: '#/apiChunkingAlgorithm' + chunking_options: + $ref: '#/apiChunkingOptions' knowledge_base_uuid: description: Knowledge base id example: '"12345678-1234-1234-1234-123456789012"' type: string spaces_data_source: $ref: '#/apiSpacesDataSource' + web_crawler_data_source: + $ref: '#/apiWebCrawlerDataSource' type: object apiCreateKnowledgeBaseDataSourceOutput: description: Information about a newly created knowldege base data source @@ -807,7 +1607,7 @@ apiCreateKnowledgeBaseInputPublic: example: - example string items: - example: '"example string"' + example: example string type: string type: array vpc_uuid: @@ -821,63 +1621,237 @@ apiCreateKnowledgeBaseOutput: knowledge_base: $ref: '#/apiKnowledgeBase' type: object +apiCreateModelAPIKeyInputPublic: + properties: + name: + description: A human friendly name to identify the key + example: Production Key + type: string + type: object +apiCreateModelAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelAPIKeyInfo' + type: object apiCreateModelOutput: description: Information about a newly created model properties: model: $ref: '#/apiModel' type: object -apiDeleteAgentAPIKeyInputPublic: +apiCreateModelProviderKeyInputPublic: properties: - agent_uuid: - example: '"12345678-1234-1234-1234-123456789012"' - api_key_uuid: - example: '"12345678-1234-1234-1234-123456789012"' -apiDeleteAgentAPIKeyOutput: + api_key: + example: sk-ant-12345678901234567890123456789012 + name: + example: Production Key + provider: + example: OPENAI +apiCreateModelProviderKeyOutput: properties: api_key_info: - $ref: '#/apiAgentAPIKeyInfo' + $ref: '#/apiModelProviderKeyInfo' type: object -apiDeleteAgentInputPublic: +apiCreateOpenAIAPIKeyInputPublic: + description: CreateOpenAIAPIKeyInputPublic is used to create a new OpenAI API key + for a specific agent. properties: - uuid: - example: '"12345678-1234-1234-1234-123456789012"' -apiDeleteAgentOutput: - description: Info about a deleted agent - properties: - agent: - $ref: '#/apiAgent' + api_key: + description: OpenAI API key + example: '"sk-proj--123456789098765432123456789"' + type: string + name: + description: Name of the key + example: '"Production Key"' + type: string type: object -apiDeleteAnthropicAPIKeyOutput: - description: DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic +apiCreateOpenAIAPIKeyOutput: + description: CreateOpenAIAPIKeyOutput is used to return the newly created OpenAI API key. properties: api_key_info: - $ref: '#/apiAnthropicAPIKeyInfo' + $ref: '#/apiOpenAIAPIKeyInfo' type: object -apiDeleteChatbotInputPublic: +apiCreateScheduledIndexingInputPublic: properties: - agent_uuid: - example: '"12345678-1234-1234-1234-123456789012"' -apiDeleteChatbotOutput: - description: Information about a delete chatbot - properties: - agent_uuid: - description: Agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + days: + description: Days for execution (day is represented same as in a cron expression, + e.g. Monday begins with 1 ) + items: + example: 123 + format: int32 + type: integer + type: array + knowledge_base_uuid: + description: Knowledge base uuid for which the schedule is created + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + time: + description: Time of execution (HH:MM) UTC + example: example string type: string type: object -apiDeleteGuardrailOutput: - description: DeleteGuardrailOutput description +apiCreateScheduledIndexingOutput: properties: - uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + indexing_info: + $ref: '#/apiScheduledIndexingInfo' + type: object +apiCreateTracesInputPublic: + properties: + agent_deployment_name: + description: Deployment name + example: example name type: string + agent_workspace_name: + description: Agent workspace name to create traces for. + example: example name + type: string + agent_workspace_uuid: + description: Agent Workspace UUID to create traces for - DEPRECATED, use workspace + name + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + session_id: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + traces: + description: List of traces to create + items: + $ref: '#/apiTrace' + type: array type: object -apiDeleteKnowledgeBaseDataSourceInputPublic: +apiCreateTracesOutput: + description: Output for creating traces properties: - data_source_uuid: - example: '"12345678-1234-1234-1234-123456789012"' + session_id: + description: Session ID + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + trace_uuids: + description: Trace UUIDs created + example: + - example string + items: + example: example string + type: string + type: array + type: object +apiCreateWorkspaceInputPublic: + description: Parameters for Workspace Creation + properties: + agent_uuids: + description: Ids of the agents(s) to attach to the workspace + example: + - example string + items: + example: example string + type: string + type: array + description: + description: Description of the workspace + example: example string + type: string + name: + description: Name of the workspace + example: example name + type: string + type: object +apiCreateWorkspaceOutput: + properties: + workspace: + $ref: '#/apiWorkspace' + type: object +apiDataPoint: + description: DataPoint message to represent a single data point + properties: + timestamp: + description: The timestamp of the data point + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + value: + description: The value of the data point + example: 123 + format: double + type: number + type: object +apiDeleteAgentAPIKeyInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteAgentAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAgentAPIKeyInfo' + type: object +apiDeleteAgentConversationLogConfigOutput: + description: Output for deleting agent conversation log config + properties: + agent_uuid: + description: Agent UUID + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiDeleteAgentInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteAgentOutput: + description: Info about a deleted agent + properties: + agent: + $ref: '#/apiAgent' + type: object +apiDeleteAgentWorkspaceDeploymentOutput: + properties: + agent_workspace_deployment_uuid: + description: The agent workspace deployment id + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiDeleteAgentWorkspaceOutput: + properties: + agent_workspace_name: + description: The agent workspace name + example: example name + type: string + type: object +apiDeleteAnthropicAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteAnthropicAPIKeyOutput: + description: DeleteAnthropicAPIKeyOutput is used to return the deleted Anthropic + API key. + properties: + api_key_info: + $ref: '#/apiAnthropicAPIKeyInfo' + type: object +apiDeleteChatbotInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteChatbotOutput: + description: Information about a delete chatbot + properties: + agent_uuid: + description: Agent id + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiDeleteGuardrailOutput: + description: DeleteGuardrailOutput description + properties: + uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiDeleteKnowledgeBaseDataSourceInputPublic: + properties: + data_source_uuid: + example: '"12345678-1234-1234-1234-123456789012"' knowledge_base_uuid: example: '"12345678-1234-1234-1234-123456789012"' apiDeleteKnowledgeBaseDataSourceOutput: @@ -885,11 +1859,11 @@ apiDeleteKnowledgeBaseDataSourceOutput: properties: data_source_uuid: description: Data source id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string knowledge_base_uuid: description: Knowledge base id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiDeleteKnowledgeBaseInputPublic: @@ -901,7 +1875,47 @@ apiDeleteKnowledgeBaseOutput: properties: uuid: description: The id of the deleted knowledge base - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiDeleteModelAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteModelAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelAPIKeyInfo' + type: object +apiDeleteModelProviderKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteModelProviderKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelProviderKeyInfo' + type: object +apiDeleteOpenAIAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiDeleteOpenAIAPIKeyOutput: + description: DeleteOpenAIAPIKeyOutput is used to return the deleted OpenAI API key. + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object +apiDeleteScheduledIndexingOutput: + properties: + indexing_info: + $ref: '#/apiScheduledIndexingInfo' + type: object +apiDeleteWorkspaceOutput: + properties: + workspace_uuid: + description: Workspace + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiDeployment: @@ -914,7 +1928,7 @@ apiDeployment: type: string name: description: Name - example: '"example name"' + example: example name type: string status: $ref: '#/apiDeploymentStatus' @@ -925,11 +1939,11 @@ apiDeployment: type: string url: description: Access your deployed agent here - example: '"example string"' + example: example string type: string uuid: description: Unique id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string visibility: $ref: '#/apiDeploymentVisibility' @@ -946,6 +1960,7 @@ apiDeploymentStatus: - STATUS_UNDEPLOYING - STATUS_UNDEPLOYMENT_FAILED - STATUS_DELETED + - STATUS_BUILDING example: STATUS_UNKNOWN type: string apiDeploymentVisibility: @@ -964,6 +1979,430 @@ apiDeploymentVisibility: - VISIBILITY_PRIVATE example: VISIBILITY_UNKNOWN type: string +apiDropboxDataSource: + description: Dropbox Data Source + properties: + folder: + example: example string + type: string + refresh_token: + description: Refresh token. you can obrain a refresh token by following the + oauth2 flow. see /v2/gen-ai/oauth2/dropbox/tokens for reference. + example: example string + type: string + type: object +apiDropboxDataSourceDisplay: + description: Dropbox Data Source for Display + properties: + folder: + example: example string + type: string + type: object +apiDropboxOauth2GetTokensInput: + description: The oauth2 code from google + properties: + code: + description: The oauth2 code from google + example: example string + type: string + redirect_url: + description: Redirect url + example: example string + type: string + type: object +apiDropboxOauth2GetTokensOutput: + description: The dropbox oauth2 token and refresh token + properties: + refresh_token: + description: The refresh token + example: example string + type: string + token: + description: The access token + example: example string + type: string + type: object +apiEvaluationDataset: + properties: + created_at: + description: Time created at. + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + dataset_name: + description: Name of the dataset. + example: example name + type: string + dataset_uuid: + description: UUID of the dataset. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + file_size: + description: The size of the dataset uploaded file in bytes. + example: "12345" + format: uint64 + type: string + has_ground_truth: + description: Does the dataset have a ground truth column? + example: true + type: boolean + row_count: + description: Number of rows in the dataset. + example: 123 + format: int64 + type: integer + type: object +apiEvaluationDatasetType: + default: EVALUATION_DATASET_TYPE_UNKNOWN + enum: + - EVALUATION_DATASET_TYPE_UNKNOWN + - EVALUATION_DATASET_TYPE_ADK + - EVALUATION_DATASET_TYPE_NON_ADK + example: EVALUATION_DATASET_TYPE_UNKNOWN + type: string +apiEvaluationMetric: + properties: + category: + $ref: '#/apiEvaluationMetricCategory' + description: + example: example string + type: string + inverted: + description: If true, the metric is inverted, meaning that a lower value is + better. + example: true + type: boolean + is_metric_goal: + example: true + type: boolean + metric_name: + example: example name + type: string + metric_rank: + example: 123 + format: int64 + type: integer + metric_type: + $ref: '#/apiEvaluationMetricType' + metric_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + metric_value_type: + $ref: '#/apiEvaluationMetricValueType' + range_max: + description: The maximum value for the metric. + example: 123 + format: float + type: number + range_min: + description: The minimum value for the metric. + example: 123 + format: float + type: number + type: object +apiEvaluationMetricCategory: + default: METRIC_CATEGORY_UNSPECIFIED + enum: + - METRIC_CATEGORY_UNSPECIFIED + - METRIC_CATEGORY_CORRECTNESS + - METRIC_CATEGORY_USER_OUTCOMES + - METRIC_CATEGORY_SAFETY_AND_SECURITY + - METRIC_CATEGORY_CONTEXT_QUALITY + - METRIC_CATEGORY_MODEL_FIT + example: METRIC_CATEGORY_UNSPECIFIED + type: string +apiEvaluationMetricResult: + properties: + error_description: + description: Error description if the metric could not be calculated. + example: example string + type: string + metric_name: + description: Metric name + example: example name + type: string + metric_value_type: + $ref: '#/apiEvaluationMetricValueType' + number_value: + description: The value of the metric as a number. + example: 123 + format: double + type: number + reasoning: + description: Reasoning of the metric result. + example: example string + type: string + string_value: + description: The value of the metric as a string. + example: example string + type: string + type: object +apiEvaluationMetricType: + default: METRIC_TYPE_UNSPECIFIED + enum: + - METRIC_TYPE_UNSPECIFIED + - METRIC_TYPE_GENERAL_QUALITY + - METRIC_TYPE_RAG_AND_TOOL + example: METRIC_TYPE_UNSPECIFIED + type: string +apiEvaluationMetricValueType: + default: METRIC_VALUE_TYPE_UNSPECIFIED + enum: + - METRIC_VALUE_TYPE_UNSPECIFIED + - METRIC_VALUE_TYPE_NUMBER + - METRIC_VALUE_TYPE_STRING + - METRIC_VALUE_TYPE_PERCENTAGE + example: METRIC_VALUE_TYPE_UNSPECIFIED + type: string +apiEvaluationRun: + properties: + agent_deleted: + description: Whether agent is deleted + example: true + type: boolean + agent_deployment_name: + description: The agent deployment name + example: example name + type: string + agent_name: + description: Agent name + example: example name + type: string + agent_uuid: + description: Agent UUID. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + agent_version_hash: + description: Version hash + example: example string + type: string + agent_workspace_uuid: + description: Agent workspace uuid + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + created_by_user_email: + example: example@example.com + type: string + created_by_user_id: + example: "12345" + format: uint64 + type: string + error_description: + description: The error description + example: example string + type: string + evaluation_run_uuid: + description: Evaluation run UUID. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + evaluation_test_case_workspace_uuid: + description: Evaluation test case workspace uuid + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + finished_at: + description: Run end time. + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + pass_status: + description: The pass status of the evaluation run based on the star metric. + example: true + type: boolean + queued_at: + description: Run queued time. + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + run_level_metric_results: + items: + $ref: '#/apiEvaluationMetricResult' + type: array + run_name: + description: Run name. + example: example name + type: string + star_metric_result: + $ref: '#/apiEvaluationMetricResult' + started_at: + description: Run start time. + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + status: + $ref: '#/apiEvaluationRunStatus' + test_case_description: + description: Test case description. + example: example string + type: string + test_case_name: + description: Test case name. + example: example name + type: string + test_case_uuid: + description: Test-case UUID. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + test_case_version: + description: Test-case-version. + example: 123 + format: int64 + type: integer + type: object +apiEvaluationRunStatus: + default: EVALUATION_RUN_STATUS_UNSPECIFIED + description: Evaluation Run Statuses + enum: + - EVALUATION_RUN_STATUS_UNSPECIFIED + - EVALUATION_RUN_QUEUED + - EVALUATION_RUN_RUNNING_DATASET + - EVALUATION_RUN_EVALUATING_RESULTS + - EVALUATION_RUN_CANCELLING + - EVALUATION_RUN_CANCELLED + - EVALUATION_RUN_SUCCESSFUL + - EVALUATION_RUN_PARTIALLY_SUCCESSFUL + - EVALUATION_RUN_FAILED + example: EVALUATION_RUN_STATUS_UNSPECIFIED + type: string +apiEvaluationTestCase: + properties: + archived_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by_user_email: + example: example@example.com + type: string + created_by_user_id: + example: "12345" + format: uint64 + type: string + dataset: + $ref: '#/apiEvaluationDataset' + dataset_name: + example: example name + type: string + dataset_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + description: + example: example string + type: string + latest_version_number_of_runs: + example: 123 + format: int32 + type: integer + metrics: + items: + $ref: '#/apiEvaluationMetric' + type: array + name: + example: example name + type: string + star_metric: + $ref: '#/apiStarMetric' + test_case_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + total_runs: + example: 123 + format: int32 + type: integer + updated_at: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + updated_by_user_email: + example: example@example.com + type: string + updated_by_user_id: + example: "12345" + format: uint64 + type: string + version: + example: 123 + format: int64 + type: integer + type: object +apiEvaluationTestCaseMetricList: + properties: + metric_uuids: + example: + - example string + items: + example: example string + type: string + type: array + type: object +apiEvaluationTraceSpan: + description: Represents a span within an evaluatioin trace (e.g., LLM call, tool + call, etc.) + properties: + created_at: + description: When the span was created + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + input: + description: Input data for the span (flexible structure - can be messages array, + string, etc.) + type: object + name: + description: Name/identifier for the span + example: example name + type: string + output: + description: Output data from the span (flexible structure - can be message, + string, etc.) + type: object + retriever_chunks: + description: Any retriever span chunks that were included as part of the span. + items: + $ref: '#/apiPromptChunk' + type: array + span_level_metric_results: + description: The span-level metric results. + items: + $ref: '#/apiEvaluationMetricResult' + type: array + type: + $ref: '#/apiTraceSpanType' + type: object +apiEvaluationUsage: + properties: + agent_measurements: + items: + $ref: '#/apiEvaluationUsageMeasurement' + type: array + guardrail_measurements: + items: + $ref: '#/apiEvaluationUsageMeasurement' + type: array + start: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + stop: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + type: object +apiEvaluationUsageMeasurement: + properties: + measurements: + items: + $ref: '#/apiUsageMeasurement' + type: array + resource_name: + example: example name + type: string + resource_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object apiFilePresignedUrlResponse: description: Detailed info about each presigned URL returned to the client. properties: @@ -974,16 +2413,16 @@ apiFilePresignedUrlResponse: type: string object_key: description: The unique object key to store the file as. - example: '"example string"' + example: example string type: string original_file_name: description: The original file name. - example: '"example name"' + example: example name type: string presigned_url: description: The actual presigned URL the client can use to upload the file directly. - example: '"example string"' + example: example string type: string type: object apiFileUploadDataSource: @@ -991,33 +2430,83 @@ apiFileUploadDataSource: properties: original_file_name: description: The original file name - example: '"example name"' + example: example name type: string size_in_bytes: description: The size of the file in bytes - example: '"12345"' + example: "12345" format: uint64 type: string stored_object_key: description: The object key the file was stored as - example: '"example string"' + example: example string type: string type: object +apiGalileoJWTOutput: + properties: + access_token: + description: Access token for the clickout to Galileo + example: example string + type: string + base_url: + description: Base URL for the Galileo instance + example: example string + type: string + expires_at: + description: Expiry time of the access token + example: example string + type: string + type: object +apiGenerateOauth2URLOutput: + description: The url for the oauth2 flow + properties: + url: + description: The oauth2 url + example: example string + type: string + type: object +apiGetAgentDeploymentReleaseOutput: + description: One Agent Deployment Release + properties: + agent_deployment_release: + $ref: '#/apiAgentDeploymentRelease' + type: object +apiGetAgentDeploymentUsageOutput: + description: Agent deployment usage + properties: + log_insights_usage: + $ref: '#/apiResourceUsage' + type: object apiGetAgentInputPublic: properties: uuid: example: '"12345678-1234-1234-1234-123456789012"' +apiGetAgentInsightsMetricsResponse: + properties: + metrics: + $ref: '#/apiMetricResponse' + type: object apiGetAgentOutput: description: One Agent properties: agent: $ref: '#/apiAgent' type: object -apiGetAgentOutputPublic: - description: One Agent +apiGetAgentRuntimeLogsRequestPublic: properties: - agent: - $ref: '#/apiAgentPublic' + follow: + example: "true" + tail_lines: + example: "10" + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetAgentRuntimeLogsResponse: + description: Agent runtime logs response + properties: + live_url: + description: URL for live logs + example: example string + type: string type: object apiGetAgentTemplateInputPublic: properties: @@ -1039,9 +2528,34 @@ apiGetAgentUsageInputPublic: apiGetAgentUsageOutput: description: Agent usage properties: + log_insights_usage: + $ref: '#/apiResourceUsage' usage: $ref: '#/apiResourceUsage' type: object +apiGetAgentWorkspaceDeploymentOutput: + description: One Agent Workspace Deployment + properties: + agent_workspace_deployment: + $ref: '#/apiAgentWorkspaceDeployment' + type: object +apiGetAgentWorkspaceDeploymentRuntimeLogsOutput: + properties: + live_url: + description: URL for live logs + example: example string + type: string + type: object +apiGetAgentWorkspaceOutput: + description: One Agent Workspace + properties: + agent_workspace: + $ref: '#/apiAgentWorkspace' + type: object +apiGetAnthropicAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiGetAnthropicAPIKeyOutput: properties: api_key_info: @@ -1060,6 +2574,46 @@ apiGetChildrenOutput: $ref: '#/apiAgent' type: array type: object +apiGetEvaluationRunOutput: + properties: + evaluation_run: + $ref: '#/apiEvaluationRun' + type: object +apiGetEvaluationRunPromptResultsOutput: + properties: + prompt: + $ref: '#/apiPrompt' + type: object +apiGetEvaluationRunResultsOutput: + description: Gets the full results of an evaluation run with all prompts. + properties: + evaluation_run: + $ref: '#/apiEvaluationRun' + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + prompts: + description: The prompt level results. + items: + $ref: '#/apiPrompt' + type: array + type: object +apiGetEvaluationRunUsageOutput: + properties: + usage: + $ref: '#/apiEvaluationUsage' + type: object +apiGetEvaluationTestCaseOutput: + properties: + evaluation_test_case: + $ref: '#/apiEvaluationTestCase' + type: object +apiGetEvaluationTestCaseUsageOutput: + properties: + usage: + $ref: '#/apiEvaluationUsage' + type: object apiGetGuardrailOutput: properties: guardrail: @@ -1071,6 +2625,17 @@ apiGetGuardrailUsageOutput: usage: $ref: '#/apiResourceUsage' type: object +apiGetIndexingJobDetailsSignedURLInputPublic: + properties: + indexing_job_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetIndexingJobDetailsSignedURLOutput: + properties: + signed_url: + description: The signed url for downloading the indexing job details + example: example string + type: string + type: object apiGetKnowledgeBaseIndexingJobInputPublic: properties: uuid: @@ -1126,7 +2691,7 @@ apiGetModelPlaygroundTokensOutput: properties: token_limit_per_day: description: Daily token limit - example: '"12345"' + example: "12345" format: uint64 type: string tokens_remaining: @@ -1135,6 +2700,15 @@ apiGetModelPlaygroundTokensOutput: format: int64 type: integer type: object +apiGetModelProviderKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetModelProviderKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelProviderKeyInfo' + type: object apiGetModelUsageInputPublic: properties: start: @@ -1153,6 +2727,15 @@ apiGetModelVersionsInputPublic: properties: name: example: '"My Model"' +apiGetOpenAIAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetOpenAIAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object apiGetPreferredRegionOutput: description: Region code of preferred Regions properties: @@ -1192,12 +2775,142 @@ apiGetResourceLimitsOutput: format: int64 type: integer type: object +apiGetResourceUsageOutput: + description: Resource usage output + properties: + agent_count: + description: Total agents used + example: 123 + format: int64 + type: integer + agent_usage: + description: Agent usage + items: + $ref: '#/apiResourceUsage' + type: array + guardrail_count: + description: Total guardrails used + example: 123 + format: int64 + type: integer + guardrail_usage: + description: Guardrail usage + items: + $ref: '#/apiResourceUsage' + type: array + indexing_job_usage: + description: Indexing job usage + items: + $ref: '#/apiResourceUsage' + type: array + knowledge_base_count: + description: Total knowledge bases used + example: 123 + format: int64 + type: integer + type: object +apiGetScheduledIndexingOutput: + properties: + indexing_info: + $ref: '#/apiScheduledIndexingInfo' + type: object +apiGetServerlessInferenceUsageInputPublic: + properties: + start: + example: '"2021-01-01T00:00:00Z"' + stop: + example: '"2021-01-02T00:00:00Z"' + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiGetServerlessInferenceUsageOutput: + description: Serverless inference usage output + properties: + usage: + $ref: '#/apiResourceUsage' + type: object apiGetTeamAgreementOutput: description: GetTeamAgreementOutput Output properties: team_agreement: $ref: '#/apiTeamAgreement' type: object +apiGetWorkspaceOutput: + properties: + workspace: + $ref: '#/apiWorkspace' + type: object +apiGoogleDriveDataSource: + description: Google Drive Data Source + properties: + folder_id: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + refresh_token: + description: Refresh token. you can obrain a refresh token by following the + oauth2 flow. see /v2/gen-ai/oauth2/google/tokens for reference. + example: example string + type: string + type: object +apiGoogleDriveDataSourceDisplay: + description: Google Drive Data Source for Display + properties: + folder_id: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + folder_name: + description: Name of the selected folder if available + example: example name + type: string + type: object +apiGoogleDriveFolder: + description: A folder in google drive + properties: + id: + description: Id of the folder + example: example string + type: string + name: + description: Name of the folder + example: example name + type: string + parent_id: + description: Id of the parent folder - if empty it is a root folder + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiGoogleOauth2GetTokensInput: + description: The oauth2 code from google + properties: + code: + description: The oauth2 code from google + example: example string + type: string + list_folders: + description: Request folders in return + example: true + type: boolean + redirect_url: + description: 'Optional: redirect url' + example: example string + type: string + type: object +apiGoogleOauth2GetTokensOutput: + description: The google oauth2 token and refresh token + properties: + folders: + description: The folders + items: + $ref: '#/apiGoogleDriveFolder' + type: array + refresh_token: + description: The refresh token + example: example string + type: string + token: + description: The access token + example: example string + type: string + type: object apiGuardrail: description: Guardrail description properties: @@ -1206,7 +2919,7 @@ apiGuardrail: example: - example string items: - example: '"example string"' + example: example string type: string type: array created_at: @@ -1214,11 +2927,16 @@ apiGuardrail: example: "2023-01-01T00:00:00Z" format: date-time type: string + created_by: + description: Created by user id from DO + example: "12345" + format: uint64 + type: string default_response: - example: '"example string"' + example: example string type: string description: - example: '"example string"' + example: example string type: string is_default: example: true @@ -1226,10 +2944,10 @@ apiGuardrail: metadata: type: object name: - example: '"example name"' + example: example name type: string template_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: $ref: '#/apiGuardrailType' @@ -1239,7 +2957,7 @@ apiGuardrail: format: date-time type: string uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiGuardrailPrice: @@ -1249,10 +2967,10 @@ apiGuardrailPrice: $ref: '#/apiBillingAttribute' type: array display_name: - example: '"example name"' + example: example name type: string guardrail_template_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string prices: items: @@ -1268,15 +2986,15 @@ apiGuardrailTemplate: format: date-time type: string default_response: - example: '"example string"' + example: example string type: string description: - example: '"example string"' + example: example string type: string metadata: type: object name: - example: '"example name"' + example: example name type: string type: $ref: '#/apiGuardrailType' @@ -1286,7 +3004,7 @@ apiGuardrailTemplate: format: date-time type: string uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiGuardrailType: @@ -1298,6 +3016,19 @@ apiGuardrailType: - GUARDRAIL_TYPE_CONTENT_MODERATION example: GUARDRAIL_TYPE_UNKNOWN type: string +apiIndexJobStatus: + default: INDEX_JOB_STATUS_UNKNOWN + enum: + - INDEX_JOB_STATUS_UNKNOWN + - INDEX_JOB_STATUS_PARTIAL + - INDEX_JOB_STATUS_IN_PROGRESS + - INDEX_JOB_STATUS_COMPLETED + - INDEX_JOB_STATUS_FAILED + - INDEX_JOB_STATUS_NO_CHANGES + - INDEX_JOB_STATUS_PENDING + - INDEX_JOB_STATUS_CANCELLED + example: INDEX_JOB_STATUS_UNKNOWN + type: string apiIndexedDataSource: properties: completed_at: @@ -1307,11 +3038,40 @@ apiIndexedDataSource: type: string data_source_uuid: description: Uuid of the indexed data source - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + error_details: + description: A detailed error description + example: example string + type: string + error_msg: + description: A string code provinding a hint which part of the system experienced + an error + example: example string + type: string + failed_item_count: + description: Total count of files that have failed + example: "12345" + format: uint64 type: string indexed_file_count: description: Total count of files that have been indexed - example: '"12345"' + example: "12345" + format: uint64 + type: string + indexed_item_count: + description: Total count of files that have been indexed + example: "12345" + format: uint64 + type: string + removed_item_count: + description: Total count of files that have been removed + example: "12345" + format: uint64 + type: string + skipped_item_count: + description: Total count of files that have been skipped + example: "12345" format: uint64 type: string started_at: @@ -1319,22 +3079,36 @@ apiIndexedDataSource: example: "2023-01-01T00:00:00Z" format: date-time type: string + status: + $ref: '#/apiIndexedDataSourceStatus' total_bytes: description: Total size of files in data source in bytes - example: '"12345"' + example: "12345" format: uint64 type: string total_bytes_indexed: description: Total size of files in data source in bytes that have been indexed - example: '"12345"' + example: "12345" format: uint64 type: string total_file_count: description: Total file count in the data source - example: '"12345"' + example: "12345" format: uint64 type: string type: object +apiIndexedDataSourceStatus: + default: DATA_SOURCE_STATUS_UNKNOWN + enum: + - DATA_SOURCE_STATUS_UNKNOWN + - DATA_SOURCE_STATUS_IN_PROGRESS + - DATA_SOURCE_STATUS_UPDATED + - DATA_SOURCE_STATUS_PARTIALLY_UPDATED + - DATA_SOURCE_STATUS_NOT_UPDATED + - DATA_SOURCE_STATUS_FAILED + - DATA_SOURCE_STATUS_CANCELLED + example: DATA_SOURCE_STATUS_UNKNOWN + type: string apiIndexingJob: description: IndexingJob description properties: @@ -1348,20 +3122,29 @@ apiIndexingJob: example: "2023-01-01T00:00:00Z" format: date-time type: string + data_source_jobs: + description: Details on Data Sources included in the Indexing Job + items: + $ref: '#/apiIndexedDataSource' + type: array data_source_uuids: example: - example string items: - example: '"example string"' + example: example string type: string type: array finished_at: example: "2023-01-01T00:00:00Z" format: date-time type: string + is_report_available: + description: Boolean value to determine if the indexing job details are available + example: true + type: boolean knowledge_base_uuid: description: Knowledge base id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string phase: $ref: '#/apiBatchJobPhase' @@ -1369,8 +3152,10 @@ apiIndexingJob: example: "2023-01-01T00:00:00Z" format: date-time type: string + status: + $ref: '#/apiIndexJobStatus' tokens: - description: Number of tokens + description: Number of tokens [This field is deprecated] example: 123 format: int64 type: integer @@ -1379,6 +3164,11 @@ apiIndexingJob: example: 123 format: int64 type: integer + total_tokens: + description: Total Tokens Consumed By the Indexing Job + example: "12345" + format: uint64 + type: string updated_at: description: Last modified example: "2023-01-01T00:00:00Z" @@ -1386,15 +3176,7 @@ apiIndexingJob: type: string uuid: description: Unique id - example: '"123e4567-e89b-12d3-a456-426614174000"' - type: string - type: object -apiIssueAgentTokenInputPublic: - description: Input for issuing a token for an agent - properties: - agent_uuid: - description: Agent ID - example: '"12345678-1234-1234-1234-123456789012"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiIssueAgentTokenOutput: @@ -1402,40 +3184,52 @@ apiIssueAgentTokenOutput: properties: access_token: description: The token - example: '"example string"' + example: example string type: string refresh_token: description: The token used to refresh - example: '"example string"' + example: example string type: string type: object apiIssueModelPlaygroundTokenOutput: description: IssueModelPlaygroundTokenOutput description properties: access_token: - example: '"example string"' + example: example string type: string refresh_token: - example: '"example string"' + example: example string type: string type: object apiKBDataSource: properties: + aws_data_source: + $ref: '#/apiAWSDataSource' bucket_name: description: Deprecated, moved to data_source_details - example: '"example name"' + example: example name type: string bucket_region: description: Deprecated, moved to data_source_details - example: '"example string"' - type: string + example: example string + type: string + chunking_algorithm: + $ref: '#/apiChunkingAlgorithm' + chunking_options: + $ref: '#/apiChunkingOptions' + dropbox_data_source: + $ref: '#/apiDropboxDataSource' file_upload_data_source: $ref: '#/apiFileUploadDataSource' + google_drive_data_source: + $ref: '#/apiGoogleDriveDataSource' item_path: - example: '"example string"' + example: example string type: string spaces_data_source: $ref: '#/apiSpacesDataSource' + web_crawler_data_source: + $ref: '#/apiWebCrawlerDataSource' type: object apiKnowledgeBase: description: Knowledgebase Description @@ -1451,10 +3245,10 @@ apiKnowledgeBase: format: date-time type: string database_id: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string embedding_model_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string is_public: description: Whether the knowledge base is public or not @@ -1464,21 +3258,21 @@ apiKnowledgeBase: $ref: '#/apiIndexingJob' name: description: Name of knowledge base - example: '"example name"' + example: example name type: string project_id: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string region: description: Region code - example: '"example string"' + example: example string type: string tags: description: Tags to organize related resources example: - example string items: - example: '"example string"' + example: example string type: string type: array updated_at: @@ -1488,37 +3282,47 @@ apiKnowledgeBase: type: string user_id: description: Id of user that created the knowledge base - example: '"12345"' + example: "12345" format: int64 type: string uuid: description: Unique id for knowledge base - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiKnowledgeBaseDataSource: description: Data Source configuration for Knowledge Bases properties: + aws_data_source: + $ref: '#/apiAWSDataSourceDisplay' bucket_name: description: Name of storage bucket - Deprecated, moved to data_source_details - example: '"example name"' + example: example name type: string + chunking_algorithm: + $ref: '#/apiChunkingAlgorithm' + chunking_options: + $ref: '#/apiChunkingOptions' created_at: description: Creation date / time example: "2023-01-01T00:00:00Z" format: date-time type: string + dropbox_data_source: + $ref: '#/apiDropboxDataSourceDisplay' file_upload_data_source: $ref: '#/apiFileUploadDataSource' + google_drive_data_source: + $ref: '#/apiGoogleDriveDataSourceDisplay' item_path: description: Path of folder or object in bucket - Deprecated, moved to data_source_details - example: '"example string"' + example: example string type: string - last_indexing_job: - $ref: '#/apiIndexingJob' + last_datasource_indexing_job: + $ref: '#/apiIndexedDataSource' region: description: Region code - Deprecated, moved to data_source_details - example: '"example string"' + example: example string type: string spaces_data_source: $ref: '#/apiSpacesDataSource' @@ -1529,8 +3333,10 @@ apiKnowledgeBaseDataSource: type: string uuid: description: Unique id of knowledge base - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string + web_crawler_data_source: + $ref: '#/apiWebCrawlerDataSource' type: object apiKnowledgeBasePrice: properties: @@ -1539,10 +3345,10 @@ apiKnowledgeBasePrice: $ref: '#/apiBillingAttribute' type: array display_name: - example: '"example name"' + example: example name type: string model_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string prices: items: @@ -1593,6 +3399,19 @@ apiLinkAgentGuardrailOutput: agent: $ref: '#/apiAgent' type: object +apiLinkAgentGuardrailsInputPublic: + description: Information about linking an agent to a guardrail + properties: + agent_uuid: + description: The UUID of the agent. + example: '"12345678-1234-1234-1234-123456789012"' + type: string + guardrails: + description: The list of guardrails to attach. + items: + $ref: '#/apiAgentGuardrailInput' + type: array + type: object apiLinkAgentInputPublic: description: Information for linking an agent properties: @@ -1617,11 +3436,11 @@ apiLinkAgentOutput: properties: child_agent_uuid: description: Routed agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string parent_agent_uuid: description: A unique identifier for the parent agent. - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiLinkKnowledgeBaseInputPublic: @@ -1636,6 +3455,12 @@ apiLinkKnowledgeBaseOutput: agent: $ref: '#/apiAgent' type: object +apiLinkKnowledgeBasesInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + knowledge_base_uuids: + example: '["12345678-1234-1234-1234-123456789012", "12345678-1234-1234-1234-123456789012"]' apiLinks: description: Links to other pages properties: @@ -1662,12 +3487,25 @@ apiListAgentAPIKeysOutput: meta: $ref: '#/apiMeta' type: object +apiListAgentDeploymentReleasesOutput: + description: Query all agent deployment releases for a given agent deployment + properties: + agent_deployment_releases: + description: The agent deployment releases + items: + $ref: '#/apiAgentDeploymentRelease' + type: array + type: object apiListAgentPricesOutput: properties: agent_prices: items: $ref: '#/apiAgentPrice' type: array + log_insights_prices: + items: + $ref: '#/apiAgentLogInsightsPrice' + type: array type: object apiListAgentTemplatesInputPublic: properties: @@ -1675,6 +3513,8 @@ apiListAgentTemplatesInputPublic: example: "1" per_page: example: "20" + template_type: + example: one-click apiListAgentTemplatesOutput: properties: links: @@ -1686,6 +3526,48 @@ apiListAgentTemplatesOutput: $ref: '#/apiAgentTemplate' type: array type: object +apiListAgentVersionsInputPublic: + properties: + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiListAgentVersionsOutput: + description: List of agent versions + properties: + agent_versions: + description: Agents + items: + $ref: '#/apiAgentVersion' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAgentWorkspaceDeploymentsOutput: + properties: + agent_workspace_deployments: + description: The agent workspace deployments + items: + $ref: '#/apiAgentWorkspaceDeployment' + type: array + type: object +apiListAgentWorkspacesOutput: + description: List of Agent Workspaces + properties: + agent_workspaces: + description: Agent Workspaces + items: + $ref: '#/apiAgentWorkspace' + type: array + type: object +apiListAgentsByAnthropicKeyInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" + uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiListAgentsByAnthropicKeyOutput: description: List of Agents that linked to a specific Anthropic Key properties: @@ -1698,6 +3580,57 @@ apiListAgentsByAnthropicKeyOutput: meta: $ref: '#/apiMeta' type: object +apiListAgentsByModelProviderKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + page: + example: "1" + per_page: + example: "20" +apiListAgentsByModelProviderKeyOutput: + properties: + agents: + description: Api key infos + items: + $ref: '#/apiAgent' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAgentsByOpenAIKeyInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" + uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiListAgentsByOpenAIKeyOutput: + description: List of Agents that are linked to a specific OpenAI Key + properties: + agents: + items: + $ref: '#/apiAgent' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListAgentsByWorkspaceOutput: + properties: + agents: + items: + $ref: '#/apiAgent' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object apiListAgentsInputPublic: properties: only_deployed: @@ -1732,6 +3665,12 @@ apiListAgentsOutputPublic: meta: $ref: '#/apiMeta' type: object +apiListAnthropicAPIKeysInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" apiListAnthropicAPIKeysOutput: description: ListAnthropicAPIKeysOutput is used to return the list of Anthropic API keys for a specific agent. @@ -1746,6 +3685,62 @@ apiListAnthropicAPIKeysOutput: meta: $ref: '#/apiMeta' type: object +apiListEvaluationMetricsOutput: + properties: + metrics: + items: + $ref: '#/apiEvaluationMetric' + type: array + type: object +apiListEvaluationPricesOutput: + properties: + evaluation_agent_prices: + items: + $ref: '#/apiAgentPrice' + type: array + evaluation_guardrail_prices: + items: + $ref: '#/apiGuardrailPrice' + type: array + type: object +apiListEvaluationRunsByAgentDeploymentOutput: + properties: + evaluation_runs: + items: + $ref: '#/apiEvaluationRun' + type: array + type: object +apiListEvaluationRunsByAgentOutput: + properties: + evaluation_runs: + items: + $ref: '#/apiEvaluationRun' + type: array + type: object +apiListEvaluationRunsByTestCaseOutput: + properties: + evaluation_runs: + description: List of evaluation runs. + items: + $ref: '#/apiEvaluationRun' + type: array + type: object +apiListEvaluationTestCasesByWorkspaceOutput: + properties: + evaluation_test_cases: + items: + $ref: '#/apiEvaluationTestCase' + type: array + type: object +apiListEvaluationTestCasesOutput: + properties: + evaluation_test_cases: + description: Alternative way of authentication for internal usage only - should + not be exposed to public api + items: + $ref: '#/apiEvaluationTestCase' + type: array + type: object apiListGuardrailAgentsOutput: properties: agents: @@ -1795,6 +3790,10 @@ apiListIndexingJobDataSourcesOutput: $ref: '#/apiIndexedDataSource' type: array type: object +apiListIndexingJobsByKnowledgeBaseUUIDInputPublic: + properties: + knowledge_base_uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiListKnowledgeBaseAgentsInputPublic: properties: knowledge_base_uuid: @@ -1855,32 +3854,77 @@ apiListKnowledgeBasePricesOutput: $ref: '#/apiKnowledgeBasePrice' type: array type: object +apiListKnowledgeBasesByDatabaseOutput: + description: List of knowledge bases + properties: + knowledge_bases: + description: The knowledge bases + items: + $ref: '#/apiKnowledgeBase' + type: array + type: object apiListKnowledgeBasesInputPublic: properties: page: example: "1" per_page: example: "20" -apiListKnowledgeBasesOutput: - description: List of knowledge bases +apiListKnowledgeBasesOutput: + description: List of knowledge bases + properties: + knowledge_bases: + description: The knowledge bases + items: + $ref: '#/apiKnowledgeBase' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListModelAPIKeysInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListModelAPIKeysOutput: + properties: + api_key_infos: + description: Api key infos + items: + $ref: '#/apiModelAPIKeyInfo' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object +apiListModelPricesOutput: + properties: + model_prices: + items: + $ref: '#/apiModelPrice' + type: array + type: object +apiListModelProviderKeysInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListModelProviderKeysOutput: properties: - knowledge_bases: - description: The knowledge bases + api_key_infos: + description: Api key infos items: - $ref: '#/apiKnowledgeBase' + $ref: '#/apiModelProviderKeyInfo' type: array links: $ref: '#/apiLinks' meta: $ref: '#/apiMeta' type: object -apiListModelPricesOutput: - properties: - model_prices: - items: - $ref: '#/apiModelPrice' - type: array - type: object apiListModelUsagesByAgentOutput: description: ListModelUsagesByAgentOutput description properties: @@ -1890,17 +3934,17 @@ apiListModelUsagesByAgentOutput: $ref: '#/apiMeta' request_limit_per_minute: description: Total request limit per minute - example: '"12345"' + example: "12345" format: uint64 type: string token_limit_per_day: description: Total token limit per day - example: '"12345"' + example: "12345" format: uint64 type: string token_limit_per_minute: description: Total token limit per minute - example: '"12345"' + example: "12345" format: uint64 type: string usages: @@ -1945,6 +3989,26 @@ apiListModelsOutputPublic: $ref: '#/apiModelPublic' type: array type: object +apiListOpenAIAPIKeysInputPublic: + properties: + page: + example: "1" + per_page: + example: "20" +apiListOpenAIAPIKeysOutput: + description: ListOpenAIAPIKeysOutput is used to return the list of OpenAI API keys + for a specific agent. + properties: + api_key_infos: + description: Api key infos + items: + $ref: '#/apiOpenAIAPIKeyInfo' + type: array + links: + $ref: '#/apiLinks' + meta: + $ref: '#/apiMeta' + type: object apiListRegionsOutput: description: Region Codes properties: @@ -1954,6 +4018,21 @@ apiListRegionsOutput: $ref: '#/genaiapiRegion' type: array type: object +apiListServerlessInferencePricesOutput: + properties: + serverless_inference_prices: + items: + $ref: '#/apiServerlessInferencePrice' + type: array + type: object +apiListWorkspacesOutput: + properties: + workspaces: + description: Workspaces + items: + $ref: '#/apiWorkspace' + type: array + type: object apiMeta: description: Meta information about the data set properties: @@ -1973,6 +4052,29 @@ apiMeta: format: int64 type: integer type: object +apiMetricResponse: + properties: + results: + description: A list of metric results + items: + $ref: '#/apiMetricResult' + type: array + type: object +apiMetricResult: + description: MetricResult message to represent individual metric data + properties: + labels: + additionalProperties: + example: example string + type: string + description: Labels for the metric (e.g., metadata like agent_uuid, usage_type) + type: object + values: + description: Data points for the metric + items: + $ref: '#/apiDataPoint' + type: array + type: object apiModel: description: Description of a Model properties: @@ -1985,26 +4087,42 @@ apiModel: type: string inference_name: description: Internally used name - example: '"example name"' + example: example name type: string inference_version: description: Internally used version - example: '"example string"' + example: example string type: string is_foundational: description: True if it is a foundational model provided by do example: true type: boolean + kb_default_chunk_size: + description: Default chunking size limit to show in UI + example: 123 + format: int64 + type: integer + kb_max_chunk_size: + description: Maximum chunk size limit of model + example: 123 + format: int64 + type: integer + kb_min_chunk_size: + description: Minimum chunking size token limits if model supports KNOWLEDGEBASE + usecase + example: 123 + format: int64 + type: integer metadata: description: Additional meta data type: object name: description: Name of the model - example: '"example name"' + example: example name type: string parent_uuid: description: Unique id of the model, this model is based on - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string provider: $ref: '#/apiModelProvider' @@ -2019,15 +4137,53 @@ apiModel: type: boolean url: description: Download url - example: '"example string"' + example: example string type: string + usecases: + description: Usecases of the model + example: + - MODEL_USECASE_AGENT + - MODEL_USECASE_GUARDRAIL + items: + $ref: '#/apiModelUsecase' + type: array uuid: description: Unique id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string version: $ref: '#/apiModelVersion' type: object +apiModelAPIKeyInfo: + description: Model API Key Info + properties: + created_at: + description: Creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by + example: "12345" + format: uint64 + type: string + deleted_at: + description: Deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + name: + description: Name + example: example name + type: string + secret_key: + example: example string + type: string + uuid: + description: Uuid + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object apiModelPrice: properties: attributes: @@ -2035,10 +4191,10 @@ apiModelPrice: $ref: '#/apiBillingAttribute' type: array display_name: - example: '"example name"' + example: example name type: string model_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string prices: items: @@ -2050,8 +4206,47 @@ apiModelProvider: enum: - MODEL_PROVIDER_DIGITALOCEAN - MODEL_PROVIDER_ANTHROPIC + - MODEL_PROVIDER_OPENAI example: MODEL_PROVIDER_DIGITALOCEAN type: string +apiModelProviderKeyInfo: + properties: + api_key_uuid: + description: API key ID + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + created_at: + description: Key creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by user id from DO + example: "12345" + format: uint64 + type: string + deleted_at: + description: Key deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + models: + description: Models supported by the openAI api key + items: + $ref: '#/apiModel' + type: array + name: + description: Name of the key + example: example name + type: string + provider: + $ref: '#/apiModelProvider' + updated_at: + description: Key last updated date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + type: object apiModelPublic: description: A machine learning model stored on the GenAI platform properties: @@ -2062,13 +4257,33 @@ apiModelPublic: example: "2021-01-01T00:00:00Z" format: date-time type: string + id: + description: Human-readable model identifier + example: llama3.3-70b-instruct + type: string is_foundational: description: True if it is a foundational model provided by do example: true type: boolean + kb_default_chunk_size: + description: Default chunking size limit to show in UI + example: 123 + format: int64 + type: integer + kb_max_chunk_size: + description: Maximum chunk size limit of model + example: 123 + format: int64 + type: integer + kb_min_chunk_size: + description: Minimum chunking size token limits if model supports KNOWLEDGEBASE + usecase + example: 123 + format: int64 + type: integer name: - description: Name of the model - example: Llama 3.3 (70b) + description: Display name of the model + example: Llama 3.3 Instruct (70B) type: string parent_uuid: description: Unique id of the model, this model is based on @@ -2108,12 +4323,16 @@ apiModelUsecase: - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + - MODEL_USECASE_REASONING: The model usecase for reasoning + - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference enum: - MODEL_USECASE_UNKNOWN - MODEL_USECASE_AGENT - MODEL_USECASE_FINETUNED - MODEL_USECASE_KNOWLEDGEBASE - MODEL_USECASE_GUARDRAIL + - MODEL_USECASE_REASONING + - MODEL_USECASE_SERVERLESS example: MODEL_USECASE_UNKNOWN type: string apiModelVersion: @@ -2135,24 +4354,82 @@ apiModelVersion: format: int64 type: integer type: object +apiMoveAgentsToWorkspaceInputPublic: + description: Parameters for Moving agents to a Workspace + properties: + agent_uuids: + description: Agent uuids + example: + - example string + items: + example: example string + type: string + type: array + workspace_uuid: + description: Workspace uuid to move agents to + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiMoveAgentsToWorkspaceOutput: + properties: + workspace: + $ref: '#/apiWorkspace' + type: object +apiOpenAIAPIKeyInfo: + description: OpenAI API Key Info + properties: + created_at: + description: Key creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: Created by user id from DO + example: "12345" + format: uint64 + type: string + deleted_at: + description: Key deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + models: + description: Models supported by the openAI api key + items: + $ref: '#/apiModel' + type: array + name: + description: Name + example: example name + type: string + updated_at: + description: Key last updated date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Uuid + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object apiPages: description: Information about how to reach other pages properties: first: description: First page - example: '"example string"' + example: example string type: string last: description: Last page - example: '"example string"' + example: example string type: string next: description: Next page - example: '"example string"' + example: example string type: string previous: description: Previous page - example: '"example string"' + example: example string type: string type: object apiPresignedUrlFile: @@ -2160,40 +4437,106 @@ apiPresignedUrlFile: properties: file_name: description: Local filename - example: '"example name"' + example: example name type: string file_size: description: The size of the file in bytes. - example: '"12345"' + example: "12345" format: int64 type: string type: object -apiRefreshAgentTokenInputPublic: +apiPrompt: properties: - agent_uuid: - example: '"12345678-1234-1234-1234-123456789012"' - refresh_token: - example: '"12345678-1234-1234-1234-123456789012"' + evaluation_trace_spans: + description: The evaluated trace spans. + items: + $ref: '#/apiEvaluationTraceSpan' + type: array + ground_truth: + description: The ground truth for the prompt. + example: example string + type: string + input: + example: example string + type: string + input_tokens: + description: The number of input tokens used in the prompt. + example: "12345" + format: uint64 + type: string + output: + example: example string + type: string + output_tokens: + description: The number of output tokens used in the prompt. + example: "12345" + format: uint64 + type: string + prompt_chunks: + description: The list of prompt chunks. + items: + $ref: '#/apiPromptChunk' + type: array + prompt_id: + description: Prompt ID + example: 123 + format: int64 + type: integer + prompt_level_metric_results: + description: The metric results for the prompt. + items: + $ref: '#/apiEvaluationMetricResult' + type: array + trace_id: + description: The trace id for the prompt. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiPromptChunk: + properties: + chunk_usage_pct: + description: The usage percentage of the chunk. + example: 123 + format: double + type: number + chunk_used: + description: Indicates if the chunk was used in the prompt. + example: true + type: boolean + index_uuid: + description: The index uuid (Knowledge Base) of the chunk. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + source_name: + description: The source name for the chunk, e.g., the file name or document + title. + example: example name + type: string + text: + description: Text content of the chunk. + example: example string + type: string + type: object apiRefreshAgentTokenOutput: description: Information about a refreshed token properties: access_token: description: The token - example: '"example string"' + example: example string type: string refresh_token: description: Rhe refreshed token - example: '"example string"' + example: example string type: string type: object apiRefreshModelPlaygroundTokenOutput: description: RefreshModelPlaygroundTokenOutput description properties: access_token: - example: '"example string"' + example: example string type: string refresh_token: - example: '"example string"' + example: example string type: string type: object apiRegenerateAgentAPIKeyInputPublic: @@ -2202,41 +4545,247 @@ apiRegenerateAgentAPIKeyInputPublic: example: '"12345678-1234-1234-1234-123456789012"' api_key_uuid: example: '"12345678-1234-1234-1234-123456789012"' -apiRegenerateAgentAPIKeyOutput: +apiRegenerateAgentAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiAgentAPIKeyInfo' + type: object +apiRegenerateModelAPIKeyInputPublic: + properties: + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' +apiRegenerateModelAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelAPIKeyInfo' + type: object +apiReleaseStatus: + default: RELEASE_STATUS_UNKNOWN + description: |- + - RELEASE_STATUS_UNKNOWN: the status of the release is unknown or not set + - RELEASE_STATUS_WAITING_FOR_DEPLOYMENT: the release is queued and waiting to be deployed + - RELEASE_STATUS_DEPLOYING: the release is currently being deployed + - RELEASE_STATUS_RUNNING: the release is successfully deployed and running + - RELEASE_STATUS_FAILED: the release deployment failed + - RELEASE_STATUS_WAITING_FOR_UNDEPLOYMENT: the release is waiting to be undeployed/removed + - RELEASE_STATUS_UNDEPLOYING: the release is currently being undeployed + - RELEASE_STATUS_UNDEPLOYMENT_FAILED: the release undeployment failed + - RELEASE_STATUS_DELETED: the release has been deleted + - RELEASE_STATUS_BUILDING: the release is building + enum: + - RELEASE_STATUS_UNKNOWN + - RELEASE_STATUS_WAITING_FOR_DEPLOYMENT + - RELEASE_STATUS_DEPLOYING + - RELEASE_STATUS_RUNNING + - RELEASE_STATUS_FAILED + - RELEASE_STATUS_WAITING_FOR_UNDEPLOYMENT + - RELEASE_STATUS_UNDEPLOYING + - RELEASE_STATUS_UNDEPLOYMENT_FAILED + - RELEASE_STATUS_DELETED + - RELEASE_STATUS_BUILDING + example: RELEASE_STATUS_UNKNOWN + type: string +apiResourceUsage: + description: Resource Usage Description + properties: + measurements: + items: + $ref: '#/apiUsageMeasurement' + type: array + resource_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + start: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + stop: + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + type: object +apiRetrievalMethod: + default: RETRIEVAL_METHOD_UNKNOWN + description: |- + - RETRIEVAL_METHOD_UNKNOWN: The retrieval method is unknown + - RETRIEVAL_METHOD_REWRITE: The retrieval method is rewrite + - RETRIEVAL_METHOD_STEP_BACK: The retrieval method is step back + - RETRIEVAL_METHOD_SUB_QUERIES: The retrieval method is sub queries + - RETRIEVAL_METHOD_NONE: The retrieval method is none + enum: + - RETRIEVAL_METHOD_UNKNOWN + - RETRIEVAL_METHOD_REWRITE + - RETRIEVAL_METHOD_STEP_BACK + - RETRIEVAL_METHOD_SUB_QUERIES + - RETRIEVAL_METHOD_NONE + example: RETRIEVAL_METHOD_UNKNOWN + type: string +apiRollbackToAgentVersionInputPublic: + properties: + uuid: + description: Agent unique identifier + example: '"12345678-1234-1234-1234-123456789012"' + type: string + version_hash: + description: Unique identifier + example: c3658d8b5c05494cd03ce042926ef08157889ed54b1b74b5ee0b3d66dcee4b73 + type: string + type: object +apiRollbackToAgentVersionOutput: + properties: + audit_header: + $ref: '#/apiAuditHeader' + version_hash: + description: Unique identifier + example: example string + type: string + type: object +apiRunEvaluationTestCaseInputPublic: + description: Run an evaluation test case. + properties: + agent_deployment_names: + description: Agent deployment names to run the test case against (ADK agent + workspaces). + example: + - example string + items: + example: example string + type: string + type: array + agent_uuids: + description: Agent UUIDs to run the test case against (legacy agents). + example: + - example string + items: + example: example string + type: string + type: array + run_name: + description: The name of the run. + example: Evaluation Run Name + type: string + test_case_uuid: + description: Test-case UUID to run + example: '"12345678-1234-1234-1234-123456789012"' + type: string + type: object +apiRunEvaluationTestCaseOutput: properties: - api_key_info: - $ref: '#/apiAgentAPIKeyInfo' + evaluation_run_uuids: + example: + - example string + items: + example: example string + type: string + type: array type: object -apiResourceUsage: - description: Resource Usage Description +apiScheduledIndexingInfo: + description: Metadata for scheduled indexing entries properties: - measurements: + created_at: + description: Created at timestamp + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + days: + description: Days for execution (day is represented same as in a cron expression, + e.g. Monday begins with 1 ) items: - $ref: '#/apiUsageMeasurement' + example: 123 + format: int32 + type: integer type: array - start: + deleted_at: + description: Deleted at timestamp (if soft deleted) example: "2023-01-01T00:00:00Z" format: date-time type: string - stop: + is_active: + description: Whether the schedule is currently active + example: true + type: boolean + knowledge_base_uuid: + description: Knowledge base uuid associated with this schedule + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + last_ran_at: + description: Last time the schedule was executed + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + next_run_at: + description: Next scheduled run + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + time: + description: Scheduled time of execution (HH:MM:SS format) + example: example string + type: string + updated_at: + description: Updated at timestamp example: "2023-01-01T00:00:00Z" format: date-time type: string + uuid: + description: Unique identifier for the scheduled indexing entry + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiServerlessInferencePrice: + properties: + attributes: + items: + $ref: '#/apiBillingAttribute' + type: array + display_name: + example: example name + type: string + model_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + prices: + items: + $ref: '#/apiBillingPrice' + type: array type: object apiSpacesDataSource: description: Spaces Bucket Data Source properties: bucket_name: description: Spaces bucket name - example: '"example name"' + example: example name type: string item_path: - example: '"example string"' + example: example string type: string region: description: Region of bucket - example: '"example string"' + example: example string + type: string + type: object +apiStarMetric: + properties: + metric_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 type: string + name: + example: example name + type: string + success_threshold: + description: |- + The success threshold for the star metric. + This is a value that the metric must reach to be considered successful. + example: 123 + format: float + type: number + success_threshold_pct: + description: |- + The success threshold for the star metric. + This is a percentage value between 0 and 100. + example: 123 + format: int32 + type: integer type: object apiStartKnowledgeBaseIndexingJobInputPublic: description: StartKnowledgeBaseIndexingJobInputPublic description @@ -2247,7 +4796,7 @@ apiStartKnowledgeBaseIndexingJobInputPublic: example: - example string items: - example: '"example string"' + example: example string type: string type: array knowledge_base_uuid: @@ -2269,7 +4818,7 @@ apiTeamAgreement: format: date-time type: string agreement_uuid: - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiTeamModelURLOutput: @@ -2277,7 +4826,79 @@ apiTeamModelURLOutput: properties: url: description: The signed url that can be used to upload one file - example: '"example string"' + example: example string + type: string + type: object +apiTrace: + description: Represents a complete trace + properties: + created_at: + description: When the trace was created + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + input: + description: Input data for the trace + type: object + name: + description: Name/identifier for the trace + example: example name + type: string + output: + description: Output data from the trace + type: object + spans: + description: List of spans that make up this trace + items: + $ref: '#/apiTraceSpan' + type: array + type: object +apiTraceSpan: + description: Represents a span within a trace (e.g., LLM call, function call, etc.) + properties: + created_at: + description: When the span was created + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + input: + description: Input data for the span (flexible structure - can be messages array, + string, etc.) + type: object + name: + description: Name/identifier for the span + example: example name + type: string + output: + description: Output data from the span (flexible structure - can be message, + string, etc.) + type: object + type: + $ref: '#/apiTraceSpanType' + type: object +apiTraceSpanType: + default: TRACE_SPAN_TYPE_UNKNOWN + description: Types of spans in a trace + enum: + - TRACE_SPAN_TYPE_UNKNOWN + - TRACE_SPAN_TYPE_LLM + - TRACE_SPAN_TYPE_RETRIEVER + - TRACE_SPAN_TYPE_TOOL + example: TRACE_SPAN_TYPE_UNKNOWN + type: string +apiTracingServiceJWTOutput: + properties: + access_token: + description: Access token for the clickout to the tracing service + example: example string + type: string + base_url: + description: Base URL for the tracing service instance + example: example string + type: string + expires_at: + description: Expiry time of the access token + example: example string type: string type: object apiUnlinkAgentFunctionInputPublic: @@ -2292,6 +4913,12 @@ apiUnlinkAgentFunctionOutput: agent: $ref: '#/apiAgent' type: object +apiUnlinkAgentGuardrailInputPublic: + properties: + agent_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + guardrail_uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiUnlinkAgentGuardrailOutput: description: UnlinkAgentGuardrailOutput description properties: @@ -2309,11 +4936,11 @@ apiUnlinkAgentOutput: properties: child_agent_uuid: description: Routed agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string parent_agent_uuid: description: Pagent agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object apiUnlinkKnowledgeBaseInputPublic: @@ -2335,7 +4962,7 @@ apiUpdateAgentAPIKeyInputPublic: example: '"12345678-1234-1234-1234-123456789012"' type: string api_key_uuid: - description: Api key id + description: API key ID example: '"12345678-1234-1234-1234-123456789012"' type: string name: @@ -2406,9 +5033,37 @@ apiUpdateAgentFunctionOutput: agent: $ref: '#/apiAgent' type: object +apiUpdateAgentInput: + properties: + agent_log_insights_enabled: + example: "false" + conversation_logs_enabled: + example: "false" + vpc_uuid: + example: '"12345678-1234-1234-1234-123456789012"' apiUpdateAgentInputPublic: description: Data to modify an existing Agent properties: + agent_log_insights_enabled: + example: true + type: boolean + allowed_domains: + description: Optional list of allowed domains for the chatbot - Must use fully + qualified domain name (FQDN) such as https://example.com + example: + - example string + items: + example: example string + type: string + type: array + anthropic_key_uuid: + description: Optional anthropic key uuid for use with anthropic models + example: '"12345678-1234-1234-1234-123456789012"' + type: string + conversation_logs_enabled: + description: Optional update of conversation logs enabled + example: true + type: boolean description: description: Agent description example: '"My Agent Description"' @@ -2432,6 +5087,10 @@ apiUpdateAgentInputPublic: example: 100 format: int64 type: integer + model_provider_key_uuid: + description: Optional Model Provider uuid for use with provider models + example: '"12345678-1234-1234-1234-123456789012"' + type: string model_uuid: description: Identifier for the foundation model. example: '"12345678-1234-1234-1234-123456789012"' @@ -2440,16 +5099,25 @@ apiUpdateAgentInputPublic: description: Agent name example: '"My New Agent Name"' type: string + open_ai_key_uuid: + description: Optional OpenAI key uuid for use with OpenAI models + example: '"12345678-1234-1234-1234-123456789012"' + type: string project_id: description: The id of the DigitalOcean project this agent will belong to example: '"12345678-1234-1234-1234-123456789012"' type: string + provide_citations: + example: true + type: boolean + retrieval_method: + $ref: '#/apiRetrievalMethod' tags: description: A set of abitrary tags to organize your agent example: - example string items: - example: '"example string"' + example: example string type: string type: array temperature: @@ -2477,6 +5145,43 @@ apiUpdateAgentOutput: agent: $ref: '#/apiAgent' type: object +apiUpdateAgentWorkspaceDeploymentInputPublic: + properties: + agent_deployment_name: + description: The name of the deployment + example: example name + type: string + agent_workspace_name: + description: Unique agent workspace name + example: example name + type: string + log_insights_enabled: + example: true + type: boolean + type: object +apiUpdateAgentWorkspaceDeploymentOutput: + description: One Agent Workspace Deployment + properties: + agent_workspace_deployment: + $ref: '#/apiAgentWorkspaceDeployment' + type: object +apiUpdateAnthropicAPIKeyInputPublic: + description: UpdateAnthropicAPIKeyInputPublic is used to update an existing Anthropic + API key for a specific agent. + properties: + api_key: + description: Anthropic API key + example: '"sk-ant-12345678901234567890123456789012"' + type: string + api_key_uuid: + description: API key ID + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Name of the key + example: '"Production Key"' + type: string + type: object apiUpdateAnthropicAPIKeyOutput: description: UpdateAnthropicAPIKeyOutput is used to return the updated Anthropic API key. @@ -2488,6 +5193,8 @@ apiUpdateChatbotInputPublic: properties: agent_uuid: example: '"12345678-1234-1234-1234-123456789012"' + allowed_domains: + example: '["https://example.com"]' button_background_color: example: '"#0000FF"' logo: @@ -2506,12 +5213,68 @@ apiUpdateChatbotOutput: chatbot: $ref: '#/apiChatbot' type: object +apiUpdateEvaluationTestCaseInputPublic: + properties: + dataset_uuid: + description: Dataset against which the test‑case is executed. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + description: + description: Description of the test case. + example: example string + type: string + metrics: + $ref: '#/apiEvaluationTestCaseMetricList' + name: + description: Name of the test case. + example: example name + type: string + star_metric: + $ref: '#/apiStarMetric' + test_case_uuid: + description: Test-case UUID to update + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiUpdateEvaluationTestCaseOutput: + properties: + test_case_uuid: + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + version: + description: The new verson of the test case. + example: 123 + format: int32 + type: integer + type: object apiUpdateGuardrailOutput: description: UpdateGuardrailOutput description properties: guardrail: $ref: '#/apiGuardrail' type: object +apiUpdateKnowledgeBaseDataSourceInputPublic: + description: Update a data source of a knowledge base with change in chunking algorithm/options + properties: + chunking_algorithm: + $ref: '#/apiChunkingAlgorithm' + chunking_options: + $ref: '#/apiChunkingOptions' + data_source_uuid: + description: Data Source ID (Path Parameter) + example: 98765432-1234-1234-1234-123456789012 + type: string + knowledge_base_uuid: + description: Knowledge Base ID (Path Parameter) + example: 12345678-1234-1234-1234-123456789012 + type: string + type: object +apiUpdateKnowledgeBaseDataSourceOutput: + description: Update a data source of a knowledge base with change in chunking algorithm/options + properties: + knowledge_base_data_source: + $ref: '#/apiKnowledgeBaseDataSource' + type: object apiUpdateKnowledgeBaseInputPublic: description: Information about updating a knowledge base properties: @@ -2538,7 +5301,7 @@ apiUpdateKnowledgeBaseInputPublic: example: - example string items: - example: '"example string"' + example: example string type: string type: array uuid: @@ -2581,23 +5344,104 @@ apiUpdateLinkedAgentOutput: properties: child_agent_uuid: description: Routed agent id - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string parent_agent_uuid: description: A unique identifier for the parent agent. - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 type: string + rollback: + example: true + type: boolean uuid: description: Unique id of linkage - example: '"123e4567-e89b-12d3-a456-426614174000"' + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiUpdateModelAPIKeyInputPublic: + properties: + api_key_uuid: + description: API key ID + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Name + example: '"Production Key"' type: string type: object +apiUpdateModelAPIKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelAPIKeyInfo' + type: object apiUpdateModelMetadataOutput: description: Information about updated meta data for a model properties: model: $ref: '#/apiModel' type: object +apiUpdateModelProviderKeyInputPublic: + properties: + api_key: + example: sk-ant-12345678901234567890123456789012 + api_key_uuid: + example: '"12345678-1234-1234-1234-123456789012"' + name: + example: Production Key +apiUpdateModelProviderKeyOutput: + properties: + api_key_info: + $ref: '#/apiModelProviderKeyInfo' + type: object +apiUpdateOpenAIAPIKeyInputPublic: + description: UpdateOpenAIAPIKeyInputPublic is used to update an existing OpenAI + API key for a specific agent. + properties: + api_key: + description: OpenAI API key + example: '"sk-ant-12345678901234567890123456789012"' + type: string + api_key_uuid: + description: API key ID + example: '"12345678-1234-1234-1234-123456789012"' + type: string + name: + description: Name of the key + example: '"Production Key"' + type: string + type: object +apiUpdateOpenAIAPIKeyOutput: + description: UpdateOpenAIAPIKeyOutput is used to return the updated OpenAI API key. + properties: + api_key_info: + $ref: '#/apiOpenAIAPIKeyInfo' + type: object +apiUpdateScheduledIndexingOutput: + properties: + indexing_info: + $ref: '#/apiScheduledIndexingInfo' + type: object +apiUpdateWorkspaceInputPublic: + description: Parameters for Update Workspace + properties: + description: + description: The new description of the workspace + example: example string + type: string + name: + description: The new name of the workspace + example: example name + type: string + workspace_uuid: + description: Workspace UUID. + example: 123e4567-e89b-12d3-a456-426614174000 + type: string + type: object +apiUpdateWorkspaceOutput: + properties: + workspace: + $ref: '#/apiWorkspace' + type: object apiUsageMeasurement: description: Usage Measurement Description properties: @@ -2606,7 +5450,86 @@ apiUsageMeasurement: format: int64 type: integer usage_type: - example: '"example string"' + example: example string + type: string + type: object +apiUsageType: + default: USAGE_TYPE_UNSPECIFIED + enum: + - USAGE_TYPE_UNSPECIFIED + - INPUT + - OUTPUT + example: USAGE_TYPE_UNSPECIFIED + type: string +apiWebCrawlerDataSource: + description: WebCrawlerDataSource + properties: + base_url: + description: The base url to crawl. + example: example string + type: string + crawling_option: + $ref: '#/apiCrawlingOption' + embed_media: + description: Whether to ingest and index media (images, etc.) on web pages. + example: true + type: boolean + exclude_tags: + description: Declaring which tags to exclude in web pages while webcrawling + example: + - example string + items: + example: example string + type: string + type: array + type: object +apiWorkspace: + properties: + agents: + description: Agents + items: + $ref: '#/apiAgent' + type: array + created_at: + description: Creation date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + created_by: + description: The id of user who created this workspace + example: "12345" + format: uint64 + type: string + created_by_email: + description: The email of the user who created this workspace + example: example@example.com + type: string + deleted_at: + description: Deleted date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + description: + description: Description of the workspace + example: example string + type: string + evaluation_test_cases: + description: Evaluations + items: + $ref: '#/apiEvaluationTestCase' + type: array + name: + description: Name of the workspace + example: example name + type: string + updated_at: + description: Update date + example: "2023-01-01T00:00:00Z" + format: date-time + type: string + uuid: + description: Unique id + example: 123e4567-e89b-12d3-a456-426614174000 type: string type: object dbaasClusterStatus: @@ -2631,11 +5554,11 @@ genaiapiRegion: properties: inference_url: description: Url for inference server - example: '"example string"' + example: example string type: string region: description: Region code - example: '"example string"' + example: example string type: string serves_batch: description: This datacenter is capable of running batch jobs @@ -2647,7 +5570,7 @@ genaiapiRegion: type: boolean stream_inference_url: description: The url for the inference streaming server - example: '"example string"' + example: example string type: string type: object protobufNullValue: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml index 24b5af558..409f4eda2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/child_agents/6a09d603-b68d-11ef-bf8f-4e013e2ddde4" \ -d '{ "parent_agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml index 07cf075a0..11c53afef 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_function.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/functions" \ -d '{ "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_guardrails.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_guardrails.yml new file mode 100644 index 000000000..c738ea644 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_agent_guardrails.yml @@ -0,0 +1,18 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1c8be326-00fe-11f1-b542-ca68c578b05c/guardrails" \ + -d '{ + "guardrails": [ + { + "guardrail_uuid": "69bcc61c-2bb2-49fd-b6ed-7c1bd73d6442", + "priority": 1 + }, + { + "guardrail_uuid": "dc72b12b-bd45-46c9-bca1-00a6624aac3a", + "priority": 2 + } + ] + }' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml index 6bfdbe3ef..7f8a7e0f8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_base.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4" \ -d '{ "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_bases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_bases.yml new file mode 100644 index 000000000..944610af6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_attach_knowledge_bases.yml @@ -0,0 +1,14 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/knowledge_bases" \ + -d '{ + "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "knowledge_base_uuids": [ + "9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4", + "683c3100-7c18-4c94-aea4-5ac5875cc87c", + "4887a78b-74af-46b3-98f4-451a48f9cc5e" + ] + }' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml index 638e73ec2..f9b05b4e7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_cancel_indexing_job.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/indexing_jobs/79ca9798-cf7d-11ef-bf8f-4e013e2ddde4/cancel" \ -d '{ "uuid": "79ca9798-cf7d-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml index 5b67f4a81..de45f5776 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents" \ -d '{ "name": "api-create", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml index 1b124dcec..c654dffd0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_agent_api_key.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys" \ -d '{ "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_anthropic_api_key.yml new file mode 100644 index 000000000..9041e7c4f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_anthropic_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/anthropic/keys" \ + -d '{ + "api_key": "sk-ant-12345678901234567890123456789012", + "name": "test-key" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_data_source_file_upload_presigned_urls.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_data_source_file_upload_presigned_urls.yml new file mode 100644 index 000000000..90115f76d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_data_source_file_upload_presigned_urls.yml @@ -0,0 +1,12 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls" \ + -d '{ + "files": [{ + "file_name": "dataset.csv", + "file_size": 2048 + }] + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset.yml new file mode 100644 index 000000000..a5ba36721 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset.yml @@ -0,0 +1,14 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/evaluation_datasets" \ + -d '{ + "name": "dataset.csv", + "file_upload_dataset": { + "original_file_name": "dataset.csv", + "stored_object_key": "123abc", + "size_in_bytes": 255 + } + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset_file_upload_presigned_urls.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset_file_upload_presigned_urls.yml new file mode 100644 index 000000000..908882707 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_dataset_file_upload_presigned_urls.yml @@ -0,0 +1,12 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls" \ + -d '{ + "files": [{ + "file_name": "dataset.csv", + "file_size": 2048 + }] + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_test_case.yml new file mode 100644 index 000000000..c193a337d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_evaluation_test_case.yml @@ -0,0 +1,18 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/evaluation_test_cases" \ + -d '{ + "name": "Test Case", + "description": "Description of the test case", + "dataset_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "metrics": ["1b418231-b7d6-11ef-bf8f-4e013e2ddde4", "2b418231-b7d6-11ef-bf8f-4e013e2ddde4"], + "star_metric": { + "metric_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "name": "Retrieved chunk usage", + "success_threshold_pct": 80 + }, + "workspace_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml index c9ef00b4b..64a82e6d7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_indexing_job.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/indexing_jobs" \ -d '{ "knowledge_base_uuid": "9758a232-b351-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml index 09712babf..4a7775ec2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases" \ -d '{ "name": "kb-api-create", @@ -14,9 +14,39 @@ source: |- "database_id": "abf1055a-745d-4c24-a1db-1959ea819264", "datasources": [ { - "bucket_name": "test-public-gen-ai", - "bucket_region": "tor1" - } + "spaces_data_source": { + "bucket_name": "test-public-gen-ai", + "region": "tor1" + }, + "chunking_algorithm": "CHUNKING_ALGORITHM_HIERARCHICAL", + "chunking_options": { + "parent_chunk_size": 1000, + "child_chunk_size": 350 + } + }, + { + "web_crawler_data_source": { + "base_url": "https://example.com", + "crawling_option": "SCOPED", + "embed_media": false, + "exclude_tags": ["nav","footer","header","aside","script","style","form","iframe", "noscript"] + }, + "chunking_algorithm": "CHUNKING_ALGORITHM_SEMANTIC", + "chunking_options": { + "max_chunk_size": 500, + "semantic_threshold": 0.6 + } + }, + { + "spaces_data_source": { + "bucket_name": "test-public-gen-ai-2", + "region": "tor1" + }, + "chunking_algorithm": "CHUNKING_ALGORITHM_FIXED_LENGTH", + "chunking_options": { + "max_chunk_size": 400 + } + }, ], "region": "tor1", "vpc_uuid": "f7176e0b-8c5e-4e32-948e-79327e56225a" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml index b8d728877..1265e10cc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_knowledge_base_data_source.yml @@ -1,6 +1,19 @@ lang: cURL source: |- - curl -X DELETE \ + curl -X POST \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ - "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/20cd8434-6ea1-11f0-bf8f-4e013e2ddde4/data_sources" \ + -d '{ + "knowledge_base_uuid": "20cd8434-6ea1-11f0-bf8f-4e013e2ddde4", + "web_crawler_data_source": { + "base_url": "https://example.com", + "crawling_option": "SCOPED", + "embed_media": false, + "exclude_tags": ["nav","footer","header","aside","script","style","form","iframe", "noscript"] + }, + "chunking_algorithm": "CHUNKING_ALGORITHM_SECTION_BASED", + "chunking_options": { + "max_chunk_size": 500 + } + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_model_api_key.yml new file mode 100644 index 000000000..21a371b81 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_model_api_key.yml @@ -0,0 +1,9 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/models/api_keys" \ + -d '{ + "name": "test-key" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_dropbox_tokens.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_dropbox_tokens.yml new file mode 100644 index 000000000..30a906839 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_dropbox_tokens.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/oauth2/dropbox/tokens?code=" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_google_tokens.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_google_tokens.yml new file mode 100644 index 000000000..c699f2e36 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_oauth2_google_tokens.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/oauth2/google/tokens?code=" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml new file mode 100644 index 000000000..f711d0735 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_openai_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys" \ + -d '{ + "api_key": "sk-proj--12345678901234567890123456789012", + "name": "test-key" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml new file mode 100644 index 000000000..6c3089215 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_scheduled_indexing.yml @@ -0,0 +1,14 @@ +lang: cURL +source: |- + curl --location --request POST 'https://api.digitalocean.com/v2/gen-ai/scheduled-indexing' \ + --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN"' \ + --header 'Content-Type: application/json' \ + --data '{ + "knowledge_base_uuid": "knowledge_base_uuid", + "time": "18:00", + "days": [ + 1, + 2, + 3 + ] + }' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_workspace.yml new file mode 100644 index 000000000..351015c5d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_create_workspace.yml @@ -0,0 +1,13 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/workspaces" \ + -d '{ + "name": "api-create", + "description": "This is a test workspace created via the API", + "agent_uuids": [ + "9758a232-b351-11ef-bf8f-4e013e2ddde4" + ] + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml index 4daac8053..2ce558bae 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agent/5581a586-a745-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml index 047989c46..cfd7443a5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_agent_api_key.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_anthropic_api_key.yml new file mode 100644 index 000000000..c97e97ac4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_anthropic_api_key.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/gen-ai/anthropic/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml index d2c413ff2..f467bf370 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/8241f44e-b0da-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml index c8b107535..73987e506 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_knowledge_base_data_source.yml @@ -2,6 +2,5 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ - "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" - + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_model_api_key.yml new file mode 100644 index 000000000..23d049235 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_model_api_key.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/gen-ai/models/api_keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_openai_api_key.yml new file mode 100644 index 000000000..dcc2a4c03 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_openai_api_key.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/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml new file mode 100644 index 000000000..0686153cf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_scheduled_indexing.yml @@ -0,0 +1,4 @@ +lang: cURL +source: |- + curl --location --request DELETE 'https://api.digitalocean.com/v2/gen-ai/scheduled-indexing/{scheduled_indexing_id}' \ + --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_workspace.yml new file mode 100644 index 000000000..4d725a4c8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_delete_workspace.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/gen-ai/workspaces/5581a586-a745-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml index 0a513e243..631280ee5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/ff47f5b7-96e5-11ef-bf8f-4e013e2ddde4/child_agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml index 93c129024..52e5629d3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_function.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/ff47f5b7-96e5-11ef-bf8f-4e013e2ddde4/functions/6cc5cda5-9ac3-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_guardrail.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_guardrail.yml new file mode 100644 index 000000000..ddee4b913 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_agent_guardrail.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/gen-ai/agents/1c8be326-00fe-11f1-b542-ca68c578b04c/guardrails/69bcc61c-2bb2-49fd-b6ed-7c1bd73d6572" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml index b8d728877..4ece252b5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_detach_knowledge_base.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X DELETE \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9a6e3975-b0c6-11ef-bf8f-4e013e2ddde4/data_sources/bd2a2db5-b8b0-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml index 7eead19a8..875829491 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml index a353b26f5..8cd936b6a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_children.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4/child_agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_usage.yml new file mode 100644 index 000000000..7e9238b5d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_agent_usage.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/genai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4/usage?start=2024-01-01T00:00:00Z&stop=2024-01-31T23:59:59Z" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_anthropic_api_key.yml new file mode 100644 index 000000000..bbc4f0db0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_anthropic_api_key.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/gen-ai/anthropic/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run.yml new file mode 100644 index 000000000..c975201b2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run.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/gen-ai/evaluation_runs/9758a232-b351-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_prompt_results.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_prompt_results.yml new file mode 100644 index 000000000..a5d94d386 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_prompt_results.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/gen-ai/evaluation_runs/9758a232-b351-11ef-bf8f-4e013e2ddde4/results/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_results.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_results.yml new file mode 100644 index 000000000..d887c090e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_run_results.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/gen-ai/evaluation_runs/9758a232-b351-11ef-bf8f-4e013e2ddde4/results" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_test_case.yml new file mode 100644 index 000000000..4e0f5c98a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_evaluation_test_case.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/gen-ai/evaluation_test_cases/9758a232-b351-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml index edc9105ac..e0b50be82 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/indexing_jobs/9758a232-b351-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml new file mode 100644 index 000000000..382520632 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_indexing_job_details_signed_url.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl --location --request GET 'https://api.digitalocean.com/v2/gen-ai/indexing_jobs/6b090372-a8c3-11f0-b542-ca68c578b04b/details_signed_url' \ + --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ + --header 'Content-Type: application/json' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml index 7fc36438b..5cd138ba1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_knowledge_base.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9758a232-b351-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_oauth2_url.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_oauth2_url.yml new file mode 100644 index 000000000..d576dbb1b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_oauth2_url.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/gen-ai/oauth2/url?type=google&redirect_uri=http://localhost:3000" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_openai_api_key.yml new file mode 100644 index 000000000..a43550e6b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_openai_api_key.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/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml new file mode 100644 index 000000000..7931ebc03 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_scheduled_indexing.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl --location --request GET 'https://api.digitalocean.com/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}' \ + --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ + --header 'Content-Type: application/json' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_workspace.yml new file mode 100644 index 000000000..4e856ff0f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_get_workspace.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/gen-ai/workspaces/c441bf77-81d6-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml index 82242c275..4565db5c1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_api_keys.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4/api_keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_versions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_versions.yml new file mode 100644 index 000000000..30af412f1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agent_versions.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/gen-ai/agents/c441bf77-81d6-11ef-bf8f-4e013e2ddde4/versions" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml index 4ad02f0ad..cdffcca71 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_anthropic_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_anthropic_key.yml new file mode 100644 index 000000000..f3d72c392 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_anthropic_key.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/gen-ai/anthropic/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.yml new file mode 100644 index 000000000..87aef0acb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_openai_key.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/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_workspace.yml new file mode 100644 index 000000000..6d8c5992e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_agents_by_workspace.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/gen-ai/workspaces/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/agents" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_anthropic_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_anthropic_api_keys.yml new file mode 100644 index 000000000..ea723a1e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_anthropic_api_keys.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/gen-ai/anthropic/keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml index 4ac83b216..a0ff55ab0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_datacenter_regions.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/regions" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_metrics.yml new file mode 100644 index 000000000..fe9e5a69a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_metrics.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/gen-ai/evaluation_metrics" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_runs_by_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_runs_by_test_case.yml new file mode 100644 index 000000000..2bb6bc0f2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_runs_by_test_case.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/gen-ai/evaluation_test_cases/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/evaluation_runs" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases.yml new file mode 100644 index 000000000..e0a1e534a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases.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/gen-ai/evaluation_test_cases" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases_by_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases_by_workspace.yml new file mode 100644 index 000000000..d624772b5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_evaluation_test_cases_by_workspace.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/gen-ai/workspaces/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4/evaluation_test_cases" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml index 38399e656..d2fa14e7f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_job_data_sources.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/indexing_jobs/9758a232-b351-11ef-bf8f-4e013e2ddde4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml index 28b63ab1f..53a3a9ce9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/indexing_jobs" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml new file mode 100644 index 000000000..85e158963 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml @@ -0,0 +1,5 @@ +lang: cURL +source: |- + curl --location --request GET 'https://api.digitalocean.com/v2/gen-ai/knowledge_bases/1139121f-a860-11f0-b542-ca68c578b04b/indexing_jobs' \ + --header 'Authorization: Bearer $DIGITALOCEAN_TOKEN' \ + --header 'Content-Type: application/json' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml index d665882c0..71db91ca8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_base_data_sources.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/9758a232-b351-11ef-bf8f-4e013e2ddde4/data_sources" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml index 529d1960b..ec2e945ee 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_knowledge_bases.yml @@ -2,5 +2,5 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_model_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_model_api_keys.yml new file mode 100644 index 000000000..4f0555241 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_model_api_keys.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/gen-ai/models/api_keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml index 702c08bac..2f9cd1686 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_models.yml @@ -2,6 +2,6 @@ lang: cURL source: |- curl -X GET \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/models" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_openai_api_keys.yml new file mode 100644 index 000000000..55adfcacd --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_openai_api_keys.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/gen-ai/openai/keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_workspaces.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_workspaces.yml new file mode 100644 index 000000000..fa5054f19 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_list_workspaces.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/gen-ai/workspaces" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_move_agents_to_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_move_agents_to_workspace.yml new file mode 100644 index 000000000..cd0f15a68 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_move_agents_to_workspace.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/workspaces/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/agents" \ + -d '{ + "workspace_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "agent_uuids": ["95ea6652-75ed-11ef-bf8f-4e013e2ddde4", "37455431-84bd-4fa2-94cf-e8486f8f8c5e"] + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml index fb40c0853..934d764cc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_agent_api_key.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys/11efcf7e-824d-2808-bf8f-4e013e2ddde4/regenerate" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_model_api_key.yml new file mode 100644 index 000000000..ab53d2c2f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_regenerate_model_api_key.yml @@ -0,0 +1,8 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/models/api_keys/11efcf7e-824d-2808-bf8f-4e013e2ddde4/regenerate" + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_rollback_to_agent_version.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_rollback_to_agent_version.yml new file mode 100644 index 000000000..53363add1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_rollback_to_agent_version.yml @@ -0,0 +1,11 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/versions" \ + -d '{ + "uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "version_hash": "c3658d8b5c05494cd03ce042926ef08157889ed54b1b74b5ee0b3d66dcee4b73" + }' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_run_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_run_evaluation_test_case.yml new file mode 100644 index 000000000..8aec1d5a9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_run_evaluation_test_case.yml @@ -0,0 +1,11 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/evaluation_runs" \ + -d '{ + "test_case_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "agent_uuids": ["1b418231-b7d6-11ef-bf8f-4e013e2ddde4", "2b418231-b7d6-11ef-bf8f-4e013e2ddde4"], + "run_name": "My Evaluation Run", + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml index 94f266dd7..43133e713 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4" \ -d '{ "uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml index ed89abf6d..3d3de329a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_api_key.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/api_keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" \ -d '{ "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml index 4a9debefa..591ab3d55 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_deployment_visibility.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/deployment_visibility" \ -d '{ "uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml index df7800e29..95fb69504 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agent_function.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/functions/b00e74f6-985c-11ef-bf8f-4e013e2ddde4" \ -d '{ "agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml new file mode 100644 index 000000000..125c2ff11 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_agents_workspace.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/workspaces/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/agents" \ + -d '{ + "workspace_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "agent_uuids": ["95ea6652-75ed-11ef-bf8f-4e013e2ddde4", "37455431-84bd-4fa2-94cf-e8486f8f8c5e"] + }' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_anthropic_api_key.yml new file mode 100644 index 000000000..f086682cb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_anthropic_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/anthropic/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" \ + -d '{ + "api_key_uuid": "11efb7d6-cdb5-6388-bf8f-4e013e2ddde4", + "name": "test-key2" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml index 415ded9c6..a6b4eb6d6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_attached_agent.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/agents/1b418231-b7d6-11ef-bf8f-4e013e2ddde4/child_agents/18c4c90c-cc40-11ef-bf8f-4e013e2ddde4" \ -d '{ "parent_agent_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_evaluation_test_case.yml new file mode 100644 index 000000000..bb3d0d791 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_evaluation_test_case.yml @@ -0,0 +1,18 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/evaluation_test_cases/e51dba65-cf7a-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "test_case_uuid": "e51dba65-cf7a-11ef-bf8f-4e013e2ddde4", + "name": "Updated Test Case", + "description": "Updated description of the test case", + "dataset_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "metrics": ["1b418231-b7d6-11ef-bf8f-4e013e2ddde4", "2b418231-b7d6-11ef-bf8f-4e013e2ddde4"], + "star_metric": { + "metric_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "name": "Retrieved chunk usage", + "success_threshold_pct": 80 + } + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml index 4b9296b44..97d8355cf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base.yml @@ -2,7 +2,7 @@ lang: cURL source: |- curl -X PUT \ -H "Content-Type: application/json" \ - -H "Authorization: Bearer $PREVIEW_API_TOKEN" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/e51dba65-cf7a-11ef-bf8f-4e013e2ddde4" \ -d '{ "uuid": "e51dba65-cf7a-11ef-bf8f-4e013e2ddde4", diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base_data_source.yml new file mode 100644 index 000000000..1327bedcb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_knowledge_base_data_source.yml @@ -0,0 +1,12 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/knowledge_bases/12345678-1234-1234-1234-123456789012/data_sources/98765432-1234-1234-1234-123456789012" \ + -d '{ + "chunking_algorithm": "CHUNKING_ALGORITHM_SECTION_BASED", + "chunking_options": { + "max_chunk_size": 500 + } + }' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_model_api_key.yml new file mode 100644 index 000000000..33237e1b3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_model_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/models/api_keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" \ + -d '{ + "api_key_uuid": "11efb7d6-cdb5-6388-bf8f-4e013e2ddde4", + "name": "test-key2" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml new file mode 100644 index 000000000..35aaae0d3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_openai_api_key.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/openai/keys/11efb7d6-cdb5-6388-bf8f-4e013e2ddde4" \ + -d '{ + "api_key_uuid": "11efb7d6-cdb5-6388-bf8f-4e013e2ddde4", + "name": "test-key2" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_workspace.yml new file mode 100644 index 000000000..29a6d2955 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/examples/curl/genai_update_workspace.yml @@ -0,0 +1,11 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/gen-ai/workspaces/1b418231-b7d6-11ef-bf8f-4e013e2ddde4" \ + -d '{ + "workspace_uuid": "1b418231-b7d6-11ef-bf8f-4e013e2ddde4", + "name": "rename-agent-api", + "description": "workspace description" + }' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml index 99883a33c..7d1393c82 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent.yml @@ -49,6 +49,6 @@ security: - genai:create summary: Add Agent Route to an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_attach_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml index 1ca3abf5c..127a4630c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_function.yml @@ -42,6 +42,6 @@ security: - genai:create summary: Add Function Route to an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_attach_agent_function.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_guardrails.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_guardrails.yml new file mode 100644 index 000000000..eb2bf86cf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_agent_guardrails.yml @@ -0,0 +1,47 @@ +description: To attach guardrails to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/guardrails`. +operationId: genai_attach_agent_guardrails +parameters: +- description: The UUID of the agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkAgentGuardrailsInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkAgentGuardrailOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Attach Guardrails to an Agent +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_attach_agent_guardrails.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml index 6cdf242c4..00305b6de 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_base.yml @@ -44,6 +44,6 @@ security: - genai:create summary: Attach Knowledge Base to an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_attach_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_bases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_bases.yml new file mode 100644 index 000000000..7962e5363 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_attach_knowledge_bases.yml @@ -0,0 +1,42 @@ +description: To attach knowledge bases to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases` +operationId: genai_attach_knowledge_bases +parameters: +- description: A unique identifier for an agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiLinkKnowledgeBaseOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Attach Knowledge Bases to an Agent +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_attach_knowledge_bases.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml index 9ff4b0113..53135c2d4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_cancel_indexing_job.yml @@ -43,6 +43,6 @@ security: - genai:update summary: Cancel Indexing Job for a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_cancel_indexing_job.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml index e8e108bf8..9f1743830 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent.yml @@ -35,6 +35,6 @@ security: - genai:create summary: Create an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_create_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml index dadcb723b..9b16141da 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_agent_api_key.yml @@ -42,6 +42,6 @@ security: - genai:create summary: Create an Agent API Key tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_create_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_anthropic_api_key.yml new file mode 100644 index 000000000..438f3cd02 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_anthropic_api_key.yml @@ -0,0 +1,39 @@ +description: To create an Anthropic API key, send a POST request to `/v2/gen-ai/anthropic/keys`. +operationId: genai_create_anthropic_api_key +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAnthropicAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateAnthropicAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create Anthropic API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_anthropic_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_data_source_file_upload_presigned_urls.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_data_source_file_upload_presigned_urls.yml new file mode 100644 index 000000000..de8be2cda --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_data_source_file_upload_presigned_urls.yml @@ -0,0 +1,40 @@ +description: To create presigned URLs for knowledge base data source file upload, + send a POST request to `/v2/gen-ai/knowledge_bases/data_sources/file_upload_presigned_urls`. +operationId: genai_create_data_source_file_upload_presigned_urls +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateDataSourceFileUploadPresignedUrlsInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateDataSourceFileUploadPresignedUrlsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create Presigned URLs for Data Source File Upload +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_data_source_file_upload_presigned_urls.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset.yml new file mode 100644 index 000000000..faba3c988 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset.yml @@ -0,0 +1,39 @@ +description: To create an evaluation dataset, send a POST request to `/v2/gen-ai/evaluation_datasets`. +operationId: genai_create_evaluation_dataset +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateEvaluationDatasetInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateEvaluationDatasetOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create Evaluation Dataset +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_evaluation_dataset.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset_file_upload_presigned_urls.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset_file_upload_presigned_urls.yml new file mode 100644 index 000000000..61f0cfb49 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_dataset_file_upload_presigned_urls.yml @@ -0,0 +1,40 @@ +description: To create presigned URLs for evaluation dataset file upload, send a POST + request to `/v2/gen-ai/evaluation_datasets/file_upload_presigned_urls`. +operationId: genai_create_evaluation_dataset_file_upload_presigned_urls +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateDataSourceFileUploadPresignedUrlsInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateDataSourceFileUploadPresignedUrlsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create Presigned URLs for Evaluation Dataset File Upload +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_evaluation_dataset_file_upload_presigned_urls.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_test_case.yml new file mode 100644 index 000000000..b9f98deaa --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_evaluation_test_case.yml @@ -0,0 +1,39 @@ +description: To create an evaluation test-case send a POST request to `/v2/gen-ai/evaluation_test_cases`. +operationId: genai_create_evaluation_test_case +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateEvaluationTestCaseInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateEvaluationTestCaseOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create Evaluation Test Case. +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_evaluation_test_case.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml index f61fd1e80..eec92e234 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_indexing_job.yml @@ -35,6 +35,6 @@ security: - genai:create summary: Start Indexing Job for a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_create_indexing_job.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml index 08575714b..592f83655 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base.yml @@ -34,6 +34,6 @@ security: - genai:create summary: Create a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_create_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml index 75dd07ff5..a05c894ef 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_knowledge_base_data_source.yml @@ -42,6 +42,6 @@ security: - genai:create summary: Add Data Source to a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_create_knowledge_base_data_source.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_model_api_key.yml new file mode 100644 index 000000000..d951449c9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_model_api_key.yml @@ -0,0 +1,39 @@ +description: To create a model API key, send a POST request to `/v2/gen-ai/models/api_keys`. +operationId: genai_create_model_api_key +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateModelAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateModelAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create a Model API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_model_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_oauth2_dropbox_tokens.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_oauth2_dropbox_tokens.yml new file mode 100644 index 000000000..25dcdd3a4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_oauth2_dropbox_tokens.yml @@ -0,0 +1,41 @@ +description: To obtain the refresh token, needed for creation of data sources, send + a GET request to `/v2/gen-ai/oauth2/dropbox/tokens`. Pass the code you obtrained + from the oauth flow in the field 'code' +operationId: genai_create_oauth2_dropbox_tokens +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDropboxOauth2GetTokensInput +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDropboxOauth2GetTokensOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Get Oauth2 Dropbox Tokens +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_oauth2_dropbox_tokens.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_openai_api_key.yml new file mode 100644 index 000000000..3b4f3e3c7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_openai_api_key.yml @@ -0,0 +1,39 @@ +description: To create an OpenAI API key, send a POST request to `/v2/gen-ai/openai/keys`. +operationId: genai_create_openai_api_key +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateOpenAIAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateOpenAIAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create OpenAI API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_openai_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_scheduled_indexing.yml new file mode 100644 index 000000000..11cac7b85 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_scheduled_indexing.yml @@ -0,0 +1,40 @@ +description: To create scheduled indexing for a knowledge base, send a POST request + to `/v2/gen-ai/scheduled-indexing`. +operationId: genai_create_scheduled_indexing +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateScheduledIndexingInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateScheduledIndexingOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create scheduled indexing for knowledge base +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_scheduled_indexing.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_workspace.yml new file mode 100644 index 000000000..301c52b8d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_create_workspace.yml @@ -0,0 +1,40 @@ +description: To create a new workspace, send a POST request to `/v2/gen-ai/workspaces`. + The response body contains a JSON object with the newly created workspace object. +operationId: genai_create_workspace +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateWorkspaceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiCreateWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Create a Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_create_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml index e91f6ce04..5a06b820d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent.yml @@ -37,6 +37,6 @@ security: - genai:delete summary: Delete an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_delete_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml index 500bfb271..c89e804cf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_agent_api_key.yml @@ -44,6 +44,6 @@ security: - genai:delete summary: 'Delete API Key for an Agent ' tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_delete_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_anthropic_api_key.yml new file mode 100644 index 000000000..81d5b19fe --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_anthropic_api_key.yml @@ -0,0 +1,42 @@ +description: To delete an Anthropic API key, send a DELETE request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. +operationId: genai_delete_anthropic_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteAnthropicAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:delete +summary: Delete Anthropic API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_anthropic_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml index 6f5280a13..a24637861 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base.yml @@ -37,6 +37,6 @@ security: - genai:delete summary: Delete a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_delete_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml index 3a8458132..8c3d5c8cc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_knowledge_base_data_source.yml @@ -45,6 +45,6 @@ security: - genai:delete summary: Delete a Data Source from a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_delete_knowledge_base_data_source.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_model_api_key.yml new file mode 100644 index 000000000..6a67f8219 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_model_api_key.yml @@ -0,0 +1,42 @@ +description: To delete an API key for a model, send a DELETE request to `/v2/gen-ai/models/api_keys/{api_key_uuid}`. +operationId: genai_delete_model_api_key +parameters: +- description: API key for an agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteModelAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:delete +summary: Delete API Key for a Model +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_model_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_openai_api_key.yml new file mode 100644 index 000000000..60e68c67d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_openai_api_key.yml @@ -0,0 +1,42 @@ +description: To delete an OpenAI API key, send a DELETE request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. +operationId: genai_delete_openai_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteOpenAIAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:delete +summary: Delete OpenAI API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_openai_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_scheduled_indexing.yml new file mode 100644 index 000000000..2ec1a1e66 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_scheduled_indexing.yml @@ -0,0 +1,43 @@ +description: Delete Scheduled Indexing for knowledge base, send a DELETE request to + `/v2/gen-ai/scheduled-indexing/{uuid}`. +operationId: genai_delete_scheduled_indexing +parameters: +- description: UUID of the scheduled indexing + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteScheduledIndexingOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:delete +summary: Delete Scheduled Indexing +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_scheduled_indexing.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_workspace.yml new file mode 100644 index 000000000..43f3f154b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_delete_workspace.yml @@ -0,0 +1,42 @@ +description: To delete a workspace, send a DELETE request to `/v2/gen-ai/workspace/{workspace_uuid}`. +operationId: genai_delete_workspace +parameters: +- description: Workspace UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDeleteWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:delete +summary: Delete a Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_delete_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml index 5c294647a..af8ab88aa 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent.yml @@ -45,6 +45,6 @@ security: - genai:delete summary: Delete Agent Route for an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_detach_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml index 9babbc422..6fe789da2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_function.yml @@ -45,6 +45,6 @@ security: - genai:delete summary: Delete Function Route for an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_detach_agent_function.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_guardrail.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_guardrail.yml new file mode 100644 index 000000000..dd212efc1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_agent_guardrail.yml @@ -0,0 +1,49 @@ +description: To detach a guardrail from an agent, send a DELETE request to `/v2/gen-ai/agents/{agent_uuid}/guardrails/{guardrail_uuid}`. +operationId: genai_detach_agent_guardrail +parameters: +- description: The UUID of the agent. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: agent_uuid + required: true + schema: + type: string +- description: The UUID of the guardrail to detach. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: guardrail_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUnlinkAgentGuardrailOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:delete +summary: Detach a Guardrail from an Agent +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_detach_agent_guardrail.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml index 3434ddf21..f5c010ed9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_detach_knowledge_base.yml @@ -44,6 +44,6 @@ security: - genai:delete summary: Detach Knowledge Base from an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_detach_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml index 46dec81a2..bb85d69da 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent.yml @@ -14,7 +14,7 @@ responses: content: application/json: schema: - $ref: ./definitions.yml#/apiGetAgentOutputPublic + $ref: ./definitions.yml#/apiGetAgentOutput description: A successful response. headers: ratelimit-limit: @@ -38,6 +38,6 @@ security: - genai:read summary: Retrieve an Existing Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_get_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml index e9d004be6..b2ea7f5f8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_children.yml @@ -37,6 +37,6 @@ security: - genai:read summary: View Agent Routes tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_get_agent_children.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_usage.yml new file mode 100644 index 000000000..ece135cec --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_agent_usage.yml @@ -0,0 +1,56 @@ +description: To get agent usage, send a GET request to `/v2/gen-ai/agents/{uuid}/usage`. + Returns usage metrics for the specified agent within the provided time range. +operationId: genai_get_agent_usage +parameters: +- description: Agent id + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +- description: Return all usage data from this date. + example: '"example string"' + in: query + name: start + schema: + type: string +- description: Return all usage data up to this date, if omitted, will return up to + the current date. + example: '"example string"' + in: query + name: stop + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAgentUsageOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Get Agent Usage +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_agent_usage.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_anthropic_api_key.yml new file mode 100644 index 000000000..6ac46edf7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_anthropic_api_key.yml @@ -0,0 +1,42 @@ +description: To retrieve details of an Anthropic API key, send a GET request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. +operationId: genai_get_anthropic_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetAnthropicAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Get Anthropic API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_anthropic_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run.yml new file mode 100644 index 000000000..816887951 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run.yml @@ -0,0 +1,43 @@ +description: To retrive information about an existing evaluation run, send a GET request + to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}`. +operationId: genai_get_evaluation_run +parameters: +- description: Evaluation run UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: evaluation_run_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetEvaluationRunOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Retrieve Information About an Existing Evaluation Run +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_evaluation_run.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_prompt_results.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_prompt_results.yml new file mode 100644 index 000000000..3ea066738 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_prompt_results.yml @@ -0,0 +1,49 @@ +description: To retrieve results of an evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results/{prompt_id}`. +operationId: genai_get_evaluation_run_prompt_results +parameters: +- description: Evaluation run UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: evaluation_run_uuid + required: true + schema: + type: string +- description: Prompt ID to get results for. + example: 1 + in: path + name: prompt_id + required: true + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetEvaluationRunPromptResultsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Retrieve Results of an Evaluation Run Prompt +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_evaluation_run_prompt_results.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_results.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_results.yml new file mode 100644 index 000000000..cd58da472 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_run_results.yml @@ -0,0 +1,54 @@ +description: To retrieve results of an evaluation run, send a GET request to `/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}/results`. +operationId: genai_get_evaluation_run_results +parameters: +- description: Evaluation run UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: evaluation_run_uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetEvaluationRunResultsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Retrieve Results of an Evaluation Run +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_evaluation_run_results.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_test_case.yml new file mode 100644 index 000000000..02c5684c8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_evaluation_test_case.yml @@ -0,0 +1,49 @@ +description: To retrive information about an existing evaluation test case, send a + GET request to `/v2/gen-ai/evaluation_test_case/{test_case_uuid}`. +operationId: genai_get_evaluation_test_case +parameters: +- description: The test case uuid to retrieve. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: test_case_uuid + required: true + schema: + type: string +- description: Version of the test case. + example: 1 + in: query + name: evaluation_test_case_version + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetEvaluationTestCaseOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Retrieve Information About an Existing Evaluation Test Case +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_evaluation_test_case.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml index 4e8d47415..9a00a9340 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job.yml @@ -38,6 +38,6 @@ security: - genai:read summary: Retrieve Status of Indexing Job for a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_get_indexing_job.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job_details_signed_url.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job_details_signed_url.yml new file mode 100644 index 000000000..b34a54fee --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_indexing_job_details_signed_url.yml @@ -0,0 +1,42 @@ +description: To get a signed URL for indexing job details, send a GET request to `/v2/gen-ai/indexing_jobs/{uuid}/details_signed_url`. +operationId: genai_get_indexing_job_details_signed_url +parameters: +- description: The uuid of the indexing job + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: indexing_job_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetIndexingJobDetailsSignedURLOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Get Signed URL for Indexing Job Details +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_indexing_job_details_signed_url.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml index c5df4a8de..3c07e7e32 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_knowledge_base.yml @@ -38,6 +38,6 @@ security: - genai:read summary: Retrieve Information About an Existing Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_get_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_dropbox_tokens.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_dropbox_tokens.yml new file mode 100644 index 000000000..bb593b402 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_dropbox_tokens.yml @@ -0,0 +1,41 @@ +description: To obtain the refresh token, needed for creation of data sources, send + a GET request to `/v2/gen-ai/oauth2/dropbox/tokens`. Pass the code you obtrained + from the oauth flow in the field 'code' +operationId: genai_get_oauth2_dropbox_tokens +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDropboxOauth2GetTokensInput +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiDropboxOauth2GetTokensOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Get Oauth2 Dropbox Tokens +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_oauth2_dropbox_tokens.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_google_tokens.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_google_tokens.yml new file mode 100644 index 000000000..813add7ef --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_google_tokens.yml @@ -0,0 +1,41 @@ +description: To obtain the refresh token, needed for creation of data sources, send + a GET request to `/v2/gen-ai/oauth2/google/tokens`. Pass the code you obtrained + from the oauth flow in the field 'code' +operationId: genai_get_oauth2_google_tokens +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGoogleOauth2GetTokensInput +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGoogleOauth2GetTokensOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Get Oauth2 Google Tokens +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_oauth2_google_tokens.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_url.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_url.yml new file mode 100644 index 000000000..f2c8efb19 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_oauth2_url.yml @@ -0,0 +1,48 @@ +description: To generate an Oauth2-URL for use with your localhost, send a GET request + to `/v2/gen-ai/oauth2/url`. Pass 'http://localhost:3000 as redirect_url +operationId: genai_get_oauth2_url +parameters: +- description: Type "google" / "dropbox". + example: '"example string"' + in: query + name: type + schema: + type: string +- description: The redirect url. + example: '"example string"' + in: query + name: redirect_url + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGenerateOauth2URLOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Get Oauth2 URL +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_oauth2_url.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_openai_api_key.yml new file mode 100644 index 000000000..97a3afd13 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_openai_api_key.yml @@ -0,0 +1,42 @@ +description: To retrieve details of an OpenAI API key, send a GET request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. +operationId: genai_get_openai_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetOpenAIAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Get OpenAI API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_openai_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_scheduled_indexing.yml new file mode 100644 index 000000000..d58b1b506 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_scheduled_indexing.yml @@ -0,0 +1,43 @@ +description: Get Scheduled Indexing for knowledge base using knoweldge base uuid, + send a GET request to `/v2/gen-ai/scheduled-indexing/knowledge-base/{knowledge_base_uuid}`. +operationId: genai_get_scheduled_indexing +parameters: +- description: UUID of the scheduled indexing entry + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetScheduledIndexingOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Get Scheduled Indexing for Knowledge Base +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_scheduled_indexing.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_workspace.yml new file mode 100644 index 000000000..3dd238616 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_get_workspace.yml @@ -0,0 +1,43 @@ +description: To retrieve details of a workspace, GET request to `/v2/gen-ai/workspaces/{workspace_uuid}`. + The response body is a JSON object containing the workspace. +operationId: genai_get_workspace +parameters: +- description: Workspace UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiGetWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: Retrieve an Existing Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_get_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml index 3e7caa799..ee7423bba 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_api_keys.yml @@ -49,6 +49,6 @@ security: - genai:read summary: List Agent API Keys tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_agent_api_keys.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_versions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_versions.yml new file mode 100644 index 000000000..c7180ea24 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agent_versions.yml @@ -0,0 +1,54 @@ +description: To list all agent versions, send a GET request to `/v2/gen-ai/agents/{uuid}/versions`. +operationId: genai_list_agent_versions +parameters: +- description: Agent uuid + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentVersionsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Agent Versions +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agent_versions.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml index 0049e5fa8..142aa1020 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents.yml @@ -48,6 +48,6 @@ security: - genai:read summary: List Agents tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_agents.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_anthropic_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_anthropic_key.yml new file mode 100644 index 000000000..36665e861 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_anthropic_key.yml @@ -0,0 +1,54 @@ +description: List Agents by Anthropic Key. +operationId: genai_list_agents_by_anthropic_key +parameters: +- description: Unique ID of Anthropic key + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentsByAnthropicKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List agents by Anthropic key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agents_by_anthropic_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_openai_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_openai_key.yml new file mode 100644 index 000000000..2d8b00b3b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_openai_key.yml @@ -0,0 +1,54 @@ +description: List Agents by OpenAI Key. +operationId: genai_list_agents_by_openai_key +parameters: +- description: Unique ID of OpenAI key + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentsByOpenAIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List agents by OpenAI key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agents_by_openai_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_workspace.yml new file mode 100644 index 000000000..20f699f2b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_agents_by_workspace.yml @@ -0,0 +1,60 @@ +description: To list all agents by a Workspace, send a GET request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. +operationId: genai_list_agents_by_workspace +parameters: +- description: Workspace UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +- description: Only list agents that are deployed. + example: true + in: query + name: only_deployed + schema: + type: boolean +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAgentsByWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List agents by Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_agents_by_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_anthropic_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_anthropic_api_keys.yml new file mode 100644 index 000000000..7e2bd9987 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_anthropic_api_keys.yml @@ -0,0 +1,47 @@ +description: To list all Anthropic API keys, send a GET request to `/v2/gen-ai/anthropic/keys`. +operationId: genai_list_anthropic_api_keys +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListAnthropicAPIKeysOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Anthropic API Keys +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_anthropic_api_keys.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml index 1bbacbded..10708bd63 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_datacenter_regions.yml @@ -42,6 +42,6 @@ security: - genai:read summary: List Datacenter Regions tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_datacenter_regions.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_metrics.yml new file mode 100644 index 000000000..8b84a74ab --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_metrics.yml @@ -0,0 +1,34 @@ +description: To list all evaluation metrics, send a GET request to `/v2/gen-ai/evaluation_metrics`. +operationId: genai_list_evaluation_metrics +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListEvaluationMetricsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Evaluation Metrics +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_evaluation_metrics.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_runs_by_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_runs_by_test_case.yml new file mode 100644 index 000000000..f83cba46e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_runs_by_test_case.yml @@ -0,0 +1,48 @@ +description: To list all evaluation runs by test case, send a GET request to `/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs`. +operationId: genai_list_evaluation_runs_by_test_case +parameters: +- description: Evaluation run UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: evaluation_test_case_uuid + required: true + schema: + type: string +- description: Version of the test case. + example: 1 + in: query + name: evaluation_test_case_version + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListEvaluationRunsByTestCaseOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Evaluation Runs by Test Case +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_evaluation_runs_by_test_case.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases.yml new file mode 100644 index 000000000..a6dcb55c3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases.yml @@ -0,0 +1,34 @@ +description: To list all evaluation test cases, send a GET request to `/v2/gen-ai/evaluation_test_cases`. +operationId: genai_list_evaluation_test_cases +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListEvaluationTestCasesOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Evaluation Test Cases +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_evaluation_test_cases.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml new file mode 100644 index 000000000..a9c355dec --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_evaluation_test_cases_by_workspace.yml @@ -0,0 +1,43 @@ +description: To list all evaluation test cases by a workspace, send a GET request + to `/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases`. +operationId: genai_list_evaluation_test_cases_by_workspace +parameters: +- description: Workspace UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListEvaluationTestCasesByWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Evaluation Test Cases by Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_evaluation_test_cases_by_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml index 9ea6ccd1d..4c4824e07 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_job_data_sources.yml @@ -37,6 +37,6 @@ security: - genai:read summary: List Data Sources for Indexing Job for a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_indexing_job_data_sources.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml index f696f409d..caacee926 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs.yml @@ -43,6 +43,6 @@ security: - genai:read summary: List Indexing Jobs for a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_indexing_jobs.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs_by_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs_by_knowledge_base.yml new file mode 100644 index 000000000..c1c0621a7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_indexing_jobs_by_knowledge_base.yml @@ -0,0 +1,43 @@ +description: To list latest 15 indexing jobs for a knowledge base, send a GET request + to `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/indexing_jobs`. +operationId: genai_list_indexing_jobs_by_knowledge_base +parameters: +- description: Knowledge base uuid in string + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListKnowledgeBaseIndexingJobsOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Indexing Jobs for a Knowledge Base +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_indexing_jobs_by_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml index 7e36d0aa9..36e4e462b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_base_data_sources.yml @@ -50,6 +50,6 @@ security: - genai:read summary: List Data Sources for a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_knowledge_base_data_sources.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml index 0741eea3d..d3b3cfb19 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_knowledge_bases.yml @@ -1,4 +1,4 @@ -description: To attach a knowledge base to an agent, send a POST request to `/v2/gen-ai/agents/{agent_uuid}/knowledge_bases/{knowledge_base_uuid}`. +description: To list all knowledge bases, send a GET request to `/v2/gen-ai/knowledge_bases`. operationId: genai_list_knowledge_bases parameters: - description: Page number. @@ -42,6 +42,6 @@ security: - genai:read summary: List Knowledge Bases tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_knowledge_bases.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_model_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_model_api_keys.yml new file mode 100644 index 000000000..d8daac0b6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_model_api_keys.yml @@ -0,0 +1,47 @@ +description: To list all model API keys, send a GET request to `/v2/gen-ai/models/api_keys`. +operationId: genai_list_model_api_keys +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListModelAPIKeysOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Model API Keys +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_model_api_keys.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml index 4cc7143a3..341a1c9b5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_models.yml @@ -9,6 +9,8 @@ parameters: - MODEL_USECASE_FINETUNED: The model maybe used for fine tuning - MODEL_USECASE_KNOWLEDGEBASE: The model maybe used for knowledge bases (embedding models) - MODEL_USECASE_GUARDRAIL: The model maybe used for guardrails + - MODEL_USECASE_REASONING: The model usecase for reasoning + - MODEL_USECASE_SERVERLESS: The model usecase for serverless inference example: - MODEL_USECASE_UNKNOWN in: query @@ -21,6 +23,8 @@ parameters: - MODEL_USECASE_FINETUNED - MODEL_USECASE_KNOWLEDGEBASE - MODEL_USECASE_GUARDRAIL + - MODEL_USECASE_REASONING + - MODEL_USECASE_SERVERLESS type: string type: array - description: Only include models that are publicly available. @@ -70,6 +74,6 @@ security: - genai:read summary: List Available Models tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_list_models.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_openai_api_keys.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_openai_api_keys.yml new file mode 100644 index 000000000..3fd3d16f1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_openai_api_keys.yml @@ -0,0 +1,47 @@ +description: To list all OpenAI API keys, send a GET request to `/v2/gen-ai/openai/keys`. +operationId: genai_list_openai_api_keys +parameters: +- description: Page number. + example: 1 + in: query + name: page + schema: + type: integer +- description: Items per page. + example: 1 + in: query + name: per_page + schema: + type: integer +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListOpenAIAPIKeysOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List OpenAI API Keys +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_openai_api_keys.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_workspaces.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_workspaces.yml new file mode 100644 index 000000000..491f24dd8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_list_workspaces.yml @@ -0,0 +1,34 @@ +description: To list all workspaces, send a GET request to `/v2/gen-ai/workspaces`. +operationId: genai_list_workspaces +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiListWorkspacesOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:read +summary: List Workspaces +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_list_workspaces.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_move_agents_to_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_move_agents_to_workspace.yml new file mode 100644 index 000000000..381068777 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_move_agents_to_workspace.yml @@ -0,0 +1,47 @@ +description: To move all listed agetns a given workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. +operationId: genai_move_agents_to_workspace +parameters: +- description: Workspace uuid to move agents to + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiMoveAgentsToWorkspaceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiMoveAgentsToWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Move Agents to a Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_move_agents_to_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml index 661224a8f..e7d4b1697 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_agent_api_key.yml @@ -8,7 +8,7 @@ parameters: required: true schema: type: string -- description: Api key id +- description: API key ID example: '"123e4567-e89b-12d3-a456-426614174000"' in: path name: api_key_uuid @@ -44,6 +44,6 @@ security: - genai:update summary: Regenerate API Key for an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_regenerate_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_model_api_key.yml new file mode 100644 index 000000000..ace836274 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_regenerate_model_api_key.yml @@ -0,0 +1,42 @@ +description: To regenerate a model API key, send a PUT request to `/v2/gen-ai/models/api_keys/{api_key_uuid}/regenerate`. +operationId: genai_regenerate_model_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiRegenerateModelAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Regenerate API Key for a Model +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_regenerate_model_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_rollback_to_agent_version.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_rollback_to_agent_version.yml new file mode 100644 index 000000000..bbfbf622c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_rollback_to_agent_version.yml @@ -0,0 +1,47 @@ +description: To update to a specific agent version, send a PUT request to `/v2/gen-ai/agents/{uuid}/versions`. +operationId: genai_rollback_to_agent_version +parameters: +- description: Agent unique identifier + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiRollbackToAgentVersionInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiRollbackToAgentVersionOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Rollback to Agent Version +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_rollback_to_agent_version.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_run_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_run_evaluation_test_case.yml new file mode 100644 index 000000000..382929a05 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_run_evaluation_test_case.yml @@ -0,0 +1,39 @@ +description: To run an evaluation test case, send a POST request to `/v2/gen-ai/evaluation_runs`. +operationId: genai_run_evaluation_test_case +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiRunEvaluationTestCaseInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiRunEvaluationTestCaseOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:create +summary: Run an Evaluation Test Case +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_run_evaluation_test_case.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml index babb31ce9..afeaaeca1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent.yml @@ -43,6 +43,6 @@ security: - genai:update summary: Update an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_update_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml index e4f742d5f..06b52b9b6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_api_key.yml @@ -8,7 +8,7 @@ parameters: required: true schema: type: string -- description: Api key id +- description: API key ID example: '"123e4567-e89b-12d3-a456-426614174000"' in: path name: api_key_uuid @@ -49,6 +49,6 @@ security: - genai:update summary: Update API Key for an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_update_agent_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml index 10d82cf41..0690c31e3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_deployment_visibility.yml @@ -1,4 +1,4 @@ -description: Check whether an agent is public or private. To get the agent status, +description: Check whether an agent is public or private. To update the agent status, send a PUT request to `/v2/gen-ai/agents/{uuid}/deployment_visibility`. operationId: genai_update_agent_deployment_visibility parameters: @@ -41,8 +41,8 @@ responses: security: - bearer_auth: - genai:update -summary: Check Agent Status +summary: Update Agent Status tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_update_agent_deployment_visibility.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml index e335d28c3..7cd85dd91 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agent_function.yml @@ -49,6 +49,6 @@ security: - genai:update summary: Update Function Route for an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_update_agent_function.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agents_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agents_workspace.yml new file mode 100644 index 000000000..14f27a645 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_agents_workspace.yml @@ -0,0 +1,47 @@ +description: To move all listed agents a given workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}/agents`. +operationId: genai_update_agents_workspace +parameters: +- description: Workspace uuid to move agents to + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiMoveAgentsToWorkspaceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiMoveAgentsToWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Move Agents to a Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_agents_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_anthropic_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_anthropic_api_key.yml new file mode 100644 index 000000000..150ebe843 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_anthropic_api_key.yml @@ -0,0 +1,47 @@ +description: To update an Anthropic API key, send a PUT request to `/v2/gen-ai/anthropic/keys/{api_key_uuid}`. +operationId: genai_update_anthropic_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAnthropicAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateAnthropicAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update Anthropic API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_anthropic_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml index 4b0bfd2b1..02935234c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_attached_agent.yml @@ -49,6 +49,6 @@ security: - genai:update summary: Update Agent Route for an Agent tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_update_attached_agent.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_evaluation_test_case.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_evaluation_test_case.yml new file mode 100644 index 000000000..f7afe7214 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_evaluation_test_case.yml @@ -0,0 +1,47 @@ +description: To update an evaluation test-case send a PUT request to `/v2/gen-ai/evaluation_test_cases/{test_case_uuid}`. +operationId: genai_update_evaluation_test_case +parameters: +- description: Test-case UUID to update + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: test_case_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateEvaluationTestCaseInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateEvaluationTestCaseOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update an Evaluation Test Case. +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_evaluation_test_case.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml index ea7f29a87..b4c068d4f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base.yml @@ -42,6 +42,6 @@ security: - genai:update summary: Update a Knowledge Base tags: -- GenAI Platform (Public Preview) +- GradientAI Platform x-codeSamples: - $ref: examples/curl/genai_update_knowledge_base.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base_data_source.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base_data_source.yml new file mode 100644 index 000000000..6e08139b8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_knowledge_base_data_source.yml @@ -0,0 +1,55 @@ +description: To update a data source (e.g. chunking options), send a PUT request to + `/v2/gen-ai/knowledge_bases/{knowledge_base_uuid}/data_sources/{data_source_uuid}`. +operationId: genai_update_knowledge_base_data_source +parameters: +- description: Knowledge Base ID (Path Parameter) + example: 123e4567-e89b-12d3-a456-426614174000 + in: path + name: knowledge_base_uuid + required: true + schema: + type: string +- description: Data Source ID (Path Parameter) + example: 123e4567-e89b-12d3-a456-426614174000 + in: path + name: data_source_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateKnowledgeBaseDataSourceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateKnowledgeBaseDataSourceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update Data Source options +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_knowledge_base_data_source.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_model_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_model_api_key.yml new file mode 100644 index 000000000..2ba4bae4b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_model_api_key.yml @@ -0,0 +1,47 @@ +description: To update a model API key, send a PUT request to `/v2/gen-ai/models/api_keys/{api_key_uuid}`. +operationId: genai_update_model_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateModelAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateModelAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update API Key for a Model +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_model_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_openai_api_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_openai_api_key.yml new file mode 100644 index 000000000..01818c60f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_openai_api_key.yml @@ -0,0 +1,47 @@ +description: To update an OpenAI API key, send a PUT request to `/v2/gen-ai/openai/keys/{api_key_uuid}`. +operationId: genai_update_openai_api_key +parameters: +- description: API key ID + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: api_key_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateOpenAIAPIKeyInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateOpenAIAPIKeyOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update OpenAI API Key +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_openai_api_key.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_scheduled_indexing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_scheduled_indexing.yml new file mode 100644 index 000000000..1e70e1049 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_scheduled_indexing.yml @@ -0,0 +1,42 @@ +description: Update Scheduled Indexing for knowledge base, send a PUT request to `/v2/gen-ai/scheduled-indexing/{uuid}`. +operationId: genai_update_scheduled_indexing +parameters: +- description: UUID of the scheduled inexing + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: uuid + required: true + schema: + type: string +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateScheduledIndexingOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update Scheduled Indexing +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_scheduled_indexing.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_workspace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_workspace.yml new file mode 100644 index 000000000..3e157a9d1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/gen-ai/genai_update_workspace.yml @@ -0,0 +1,48 @@ +description: To update a workspace, send a PUT request to `/v2/gen-ai/workspaces/{workspace_uuid}`. + The response body is a JSON object containing the workspace. +operationId: genai_update_workspace +parameters: +- description: Workspace UUID. + example: '"123e4567-e89b-12d3-a456-426614174000"' + in: path + name: workspace_uuid + required: true + schema: + type: string +requestBody: + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateWorkspaceInputPublic +responses: + "200": + content: + application/json: + schema: + $ref: ./definitions.yml#/apiUpdateWorkspaceOutput + description: A successful response. + 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 + "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 +security: +- bearer_auth: + - genai:update +summary: Update a Workspace +tags: +- GradientAI Platform +x-codeSamples: +- $ref: examples/curl/genai_update_workspace.yml diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_add_registries.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_add_registries.yml new file mode 100644 index 000000000..015886a70 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_add_registries.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"cluster_uuids": ["bd5f5959-5e1e-4205-a714-a914373942af", "50c2f44c-011d-493e-aee5-361a4a0d1844"], "registries": ["registry-a", "registry-b"]}' \ + "https://api.digitalocean.com/v2/kubernetes/registries" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_get_status_messages.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_get_status_messages.yml new file mode 100644 index 000000000..e4db2fae2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_get_status_messages.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/kubernetes/clusters/bd5f5959-5e1e-4205-a714-a914373942af/status_messages" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_remove_registries.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_remove_registries.yml new file mode 100644 index 000000000..fa1850e26 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/curl/kubernetes_remove_registries.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X DELETE \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"cluster_uuids": ["bd5f5959-5e1e-4205-a714-a914373942af", "50c2f44c-011d-493e-aee5-361a4a0d1844"], "registries": ["registry-a", "registry-b"]}' \ + "https://api.digitalocean.com/v2/kubernetes/registries" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/go/kubernetes_get_status_messages.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/go/kubernetes_get_status_messages.yml new file mode 100644 index 000000000..f6dcf8b7e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/examples/go/kubernetes_get_status_messages.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + messages, _, err := client.Kubernetes.GetClusterStatusMessages(ctx, "8d91899c-0739-4a1a-acc5-deadbeefbb8f", nil) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml index 4096c37a2..0287193ba 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml @@ -58,4 +58,4 @@ x-codeSamples: security: - bearer_auth: - - 'kubernetes:create' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registries.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registries.yml new file mode 100644 index 000000000..728d66c1e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registries.yml @@ -0,0 +1,39 @@ +operationId: kubernetes_add_registries + +summary: Add Container Registries to Kubernetes Clusters + +description: To integrate the container registries with Kubernetes clusters, send + a POST request to `/v2/kubernetes/registries`. + +tags: + - Kubernetes + +requestBody: + content: + application/json: + schema: + $ref: 'models/cluster_registries.yml' + +responses: + '204': + $ref: '../../shared/responses/no_content.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/kubernetes_add_registries.yml' + +security: + - bearer_auth: + - 'kubernetes:create' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml index 67ac1e15e..d53704eec 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml @@ -12,7 +12,7 @@ requestBody: content: application/json: schema: - $ref: 'models/cluster_registries.yml' + $ref: 'models/cluster_registry.yml' responses: '204': @@ -38,3 +38,4 @@ x-codeSamples: security: - bearer_auth: - 'kubernetes:create' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml index b6cd32b72..04e3fd4e4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'kubernetes:delete' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml index 70c323fc6..ba66dec49 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'kubernetes:delete' + - 'kubernetes:update' 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 0314737a8..c75e8853b 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 @@ -21,6 +21,12 @@ description: | If not set or 0, then the token will have a 7 day expiry. The query parameter has no impact in certificate-based authentication. + Kubernetes Roles granted to a user with a token-based kubeconfig are derived from that user's + DigitalOcean role. Predefined roles (Owner, Member, Modifier etc.) have an automatic mapping + to Kubernetes roles. Custom roles are not automatically mapped to any Kubernetes roles, + and require [additional configuration](https://docs.digitalocean.com/products/kubernetes/how-to/set-up-custom-rolebindings/) + by a cluster administrator. + tags: - Kubernetes diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_status_messages.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_status_messages.yml new file mode 100644 index 000000000..73a3d993b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_status_messages.yml @@ -0,0 +1,43 @@ +operationId: kubernetes_get_status_messages + +summary: Fetch Status Messages for a Kubernetes Cluster + +description: | + To retrieve status messages for a Kubernetes cluster, send a GET request to + `/v2/kubernetes/clusters/$K8S_CLUSTER_ID/status_messages`. Status messages inform users of any issues that come up during the cluster lifecycle. + +tags: + - Kubernetes + +parameters: + - $ref: 'parameters.yml#/kubernetes_cluster_id' + - $ref: 'parameters.yml#/kubernetes_status_messages_since' + +responses: + '200': + $ref: 'responses/status_messages.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/kubernetes_get_status_messages.yml' + - $ref: 'examples/go/kubernetes_get_status_messages.yml' + +security: + - bearer_auth: + - 'kubernetes:read' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registries.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registries.yml new file mode 100644 index 000000000..87d543733 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registries.yml @@ -0,0 +1,38 @@ +operationId: kubernetes_remove_registries + +summary: Remove Container Registries from Kubernetes Clusters + +description: To remove the container registries from Kubernetes clusters, send a + DELETE request to `/v2/kubernetes/registries`. + +tags: + - Kubernetes + +requestBody: + content: + application/json: + schema: + $ref: 'models/cluster_registries.yml' + +responses: + '204': + $ref: '../../shared/responses/no_content.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/kubernetes_remove_registries.yml' + +security: + - bearer_auth: + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml index 15b9fc34b..0a2c3b97f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml @@ -12,7 +12,7 @@ requestBody: content: application/json: schema: - $ref: 'models/cluster_registries.yml' + $ref: 'models/cluster_registry.yml' responses: '204': @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'kubernetes:delete' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml index b0b726264..7066f4bb7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'kubernetes:create' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_metrics_exporter_plugin.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_metrics_exporter_plugin.yml new file mode 100644 index 000000000..7fb29dcb3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_metrics_exporter_plugin.yml @@ -0,0 +1,8 @@ +type: object +nullable: true +description: An object specifying whether the AMD Device Metrics Exporter should be enabled in the Kubernetes cluster. +properties: + enabled: + type: boolean + description: Indicates whether the AMD Device Metrics Exporter is enabled. + example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_plugin.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_plugin.yml new file mode 100644 index 000000000..1198bd7b2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/amd_gpu_device_plugin.yml @@ -0,0 +1,8 @@ +type: object +nullable: true +description: An object specifying whether the AMD GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an AMD GPU node pool. +properties: + enabled: + type: boolean + description: Indicates whether the AMD GPU Device Plugin is enabled. + example: true 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 6411eb765..508703136 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 @@ -48,7 +48,7 @@ properties: format: uuid example: c33931f2-a26a-4e61-b85c-4e95a2ec431b description: A string specifying the UUID of the VPC to which the - Kubernetes cluster is assigned. + Kubernetes cluster is assigned.

Requires `vpc:read` scope. ipv4: type: string @@ -67,22 +67,23 @@ properties: items: type: string example: - - k8s - - k8s:bd5f5959-5e1e-4205-a714-a914373942af - - production - - web-team - description: An array of tags applied to the Kubernetes cluster. All + - k8s + - k8s:bd5f5959-5e1e-4205-a714-a914373942af + - production + - web-team + description: An array of tags to apply to the Kubernetes cluster. All clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. +

Requires `tag:read` and `tag:create` scope, as well as `tag:delete` if existing tags are getting removed. node_pools: type: array description: An object specifying the details of the worker nodes available to the Kubernetes cluster. items: - $ref: 'node_pool.yml#/kubernetes_node_pool' + $ref: "node_pool.yml#/kubernetes_node_pool" maintenance_policy: - $ref: 'maintenance_policy.yml' + $ref: "maintenance_policy.yml" auto_upgrade: type: boolean @@ -100,13 +101,13 @@ properties: state: type: string enum: - - running - - provisioning - - degraded - - error - - deleted - - upgrading - - deleting + - running + - provisioning + - degraded + - error + - deleted + - upgrading + - deleting example: provisioning description: A string indicating the current status of the cluster. message: @@ -156,7 +157,25 @@ properties: integrated with the cluster. control_plane_firewall: - $ref: 'control_plane_firewall.yml' + $ref: "control_plane_firewall.yml" + + cluster_autoscaler_configuration: + $ref: "cluster_autoscaler_configuration.yml" + + routing_agent: + $ref: "routing_agent.yml" + + amd_gpu_device_plugin: + $ref: "amd_gpu_device_plugin.yml" + + amd_gpu_device_metrics_exporter_plugin: + $ref: "amd_gpu_device_metrics_exporter_plugin.yml" + + nvidia_gpu_device_plugin: + $ref: "nvidia_gpu_device_plugin.yml" + + rdma_shared_dev_plugin: + $ref: "rdma_shared_dev_plugin.yml" required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_autoscaler_configuration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_autoscaler_configuration.yml new file mode 100644 index 000000000..6a80484d4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_autoscaler_configuration.yml @@ -0,0 +1,34 @@ +type: object +nullable: true +description: An object specifying custom cluster autoscaler configuration. +properties: + scale_down_utilization_threshold: + type: number + description: Used to customize when cluster autoscaler scales down non-empty nodes by setting the node utilization threshold. + example: 0.65 + + scale_down_unneeded_time: + type: string + description: Used to customize how long a node is unneeded before being scaled down. + example: "1m0s" + + expanders: + type: array + items: + type: string + enum: + - random + - priority + - least_waste + description: | + Customizes expanders used by cluster-autoscaler. + The autoscaler will apply each expander from the provided list to narrow down the selection of node types created to scale up, + until either a single node type is left, or the list of expanders is exhausted. + If this flag is unset, autoscaler will use its default expander `random`. + Passing an empty list (_not_ `null`) will unset any previous expander customizations. + + Available expanders: + - `random`: Randomly selects a node group to scale. + - `priority`: Selects the node group with the highest priority as per [user-provided configuration](https://docs.digitalocean.com/products/kubernetes/how-to/autoscale/#configuring-priority-expander) + - `least_waste`: Selects the node group that will result in the least amount of idle resources. + example: ["priority", "random"] diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_read.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_read.yml new file mode 100644 index 000000000..05bd59bfb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_read.yml @@ -0,0 +1,194 @@ +type: object + +properties: + id: + type: string + format: uuid + readOnly: true + example: bd5f5959-5e1e-4205-a714-a914373942af + description: A unique ID that can be used to identify and reference a + Kubernetes cluster. + + name: + type: string + example: prod-cluster-01 + description: A human-readable name for a Kubernetes cluster. + + region: + type: string + example: nyc1 + description: The slug identifier for the region where the Kubernetes + cluster is located. + + version: + type: string + example: 1.18.6-do.0 + description: The slug identifier for the version of Kubernetes used for the + cluster. If set to a minor version (e.g. "1.14"), the latest version within + it will be used (e.g. "1.14.6-do.1"); if set to "latest", the latest + published version will be used. See the `/v2/kubernetes/options` endpoint + to find all currently available versions. + + cluster_subnet: + type: string + format: cidr + 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 + 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. + + vpc_uuid: + type: string + format: uuid + example: c33931f2-a26a-4e61-b85c-4e95a2ec431b + description: A string specifying the UUID of the VPC to which the + Kubernetes cluster is assigned.

Requires `vpc:read` scope. + + ipv4: + type: string + readOnly: true + example: "68.183.121.157" + description: The public IPv4 address of the Kubernetes master node. This will not be set if high availability is configured on the cluster (v1.21+) + + endpoint: + type: string + readOnly: true + example: https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com + description: The base URL of the API server on the Kubernetes master node. + + tags: + type: array + items: + type: string + example: + - k8s + - k8s:bd5f5959-5e1e-4205-a714-a914373942af + - production + - web-team + description: An array of tags applied to the Kubernetes cluster. All + clusters are automatically tagged `k8s` and `k8s:$K8S_CLUSTER_ID`. +

Requires `tag:read` scope. + + node_pools: + type: array + description: An object specifying the details of the worker nodes available + to the Kubernetes cluster. + items: + $ref: "node_pool.yml#/kubernetes_node_pool" + + maintenance_policy: + $ref: "maintenance_policy.yml" + + auto_upgrade: + type: boolean + default: false + example: true + description: A boolean value indicating whether the cluster will be + automatically upgraded to new patch releases during its maintenance window. + + status: + type: object + readOnly: true + description: An object containing a `state` attribute whose value is set to + a string indicating the current status of the cluster. + properties: + state: + type: string + enum: + - running + - provisioning + - degraded + - error + - deleted + - upgrading + - deleting + example: provisioning + description: A string indicating the current status of the cluster. + message: + type: string + example: provisioning + description: An optional message providing additional information about + the current cluster state. + + created_at: + type: string + format: date-time + readOnly: true + example: "2018-11-15T16:00:11Z" + description: A time value given in ISO8601 combined date and time format + that represents when the Kubernetes cluster was created. + + updated_at: + type: string + format: date-time + example: "2018-11-15T16:00:11Z" + readOnly: true + description: A time value given in ISO8601 combined date and time format + that represents when the Kubernetes cluster was last updated. + + surge_upgrade: + type: boolean + default: false + example: true + description: A boolean value indicating whether surge upgrade is + enabled/disabled for the cluster. Surge upgrade makes cluster upgrades + fast and reliable by bringing up new nodes before destroying the outdated + nodes. + + ha: + type: boolean + default: false + example: true + description: A boolean value indicating whether the control plane + is run in a highly available configuration in the cluster. Highly available + control planes incur less downtime. The property cannot be disabled. + + registry_enabled: + type: boolean + readOnly: true + example: true + description: A read-only boolean value indicating if a container registry is + integrated with the cluster. + + registries: + type: array + nullable: true + items: + type: string + example: + - registry-a + - registry-b + description: An array of integrated DOCR registries. + + control_plane_firewall: + $ref: "control_plane_firewall.yml" + + cluster_autoscaler_configuration: + $ref: "cluster_autoscaler_configuration.yml" + + routing_agent: + $ref: "routing_agent.yml" + + amd_gpu_device_plugin: + $ref: "amd_gpu_device_plugin.yml" + + amd_gpu_device_metrics_exporter_plugin: + $ref: "amd_gpu_device_metrics_exporter_plugin.yml" + + nvidia_gpu_device_plugin: + $ref: "nvidia_gpu_device_plugin.yml" + + rdma_shared_dev_plugin: + $ref: "rdma_shared_dev_plugin.yml" + +required: + - name + - region + - version + - node_pools diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registries.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registries.yml index 1230654e1..0809ddf36 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registries.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registries.yml @@ -9,3 +9,11 @@ properties: - bd5f5959-5e1e-4205-a714-a914373942af - 50c2f44c-011d-493e-aee5-361a4a0d1844 description: An array containing the UUIDs of Kubernetes clusters. + registries: + type: array + items: + type: string + example: + - registry-a + - registry-b + description: An array containing the registry names. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registry.yml new file mode 100644 index 000000000..1230654e1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_registry.yml @@ -0,0 +1,11 @@ +type: object + +properties: + cluster_uuids: + type: array + items: + type: string + example: + - bd5f5959-5e1e-4205-a714-a914373942af + - 50c2f44c-011d-493e-aee5-361a4a0d1844 + description: An array containing the UUIDs of Kubernetes clusters. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml index 5fcc7b02a..30aca3936 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/cluster_update.yml @@ -48,5 +48,23 @@ properties: control_plane_firewall: $ref: 'control_plane_firewall.yml' + cluster_autoscaler_configuration: + $ref: 'cluster_autoscaler_configuration.yml' + + routing_agent: + $ref: 'routing_agent.yml' + + amd_gpu_device_plugin: + $ref: "amd_gpu_device_plugin.yml" + + amd_gpu_device_metrics_exporter_plugin: + $ref: "amd_gpu_device_metrics_exporter_plugin.yml" + + nvidia_gpu_device_plugin: + $ref: "nvidia_gpu_device_plugin.yml" + + rdma_shared_dev_plugin: + $ref: "rdma_shared_dev_plugin.yml" + required: - name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml index 393c70454..9cd44436b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/control_plane_firewall.yml @@ -3,7 +3,7 @@ nullable: true description: An object specifying the control plane firewall for the Kubernetes cluster. Control plane firewall is in early availability (invite only). properties: - enable: + enabled: type: boolean description: Indicates whether the control plane firewall is enabled. example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/node_pool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/node_pool.yml index 7f08d6773..c88b15887 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/node_pool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/node_pool.yml @@ -61,6 +61,7 @@ kubernetes_node_pool_base: description: An array containing the tags applied to the node pool. All node pools are automatically tagged `k8s`, `k8s-worker`, and `k8s:$K8S_CLUSTER_ID`. +

Requires `tag:read` scope. labels: type: object diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/nvidia_gpu_device_plugin.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/nvidia_gpu_device_plugin.yml new file mode 100644 index 000000000..fc860a67e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/nvidia_gpu_device_plugin.yml @@ -0,0 +1,8 @@ +type: object +nullable: true +description: An object specifying whether the Nvidia GPU Device Plugin should be enabled in the Kubernetes cluster. It's enabled by default for clusters with an Nvidia GPU node pool. +properties: + enabled: + type: boolean + description: Indicates whether the Nvidia GPU Device Plugin is enabled. + example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/options.yml index cbfe74439..73c2b29d7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/options.yml @@ -3,6 +3,7 @@ kubernetes_options: type: object properties: options: + type: object properties: regions: type: array diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/rdma_shared_dev_plugin.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/rdma_shared_dev_plugin.yml new file mode 100644 index 000000000..916b0ee0c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/rdma_shared_dev_plugin.yml @@ -0,0 +1,8 @@ +type: object +nullable: true +description: An object specifying whether the RDMA shared device plugin should be enabled in the Kubernetes cluster. +properties: + enabled: + type: boolean + description: Indicates whether the RDMA shared device plugin is enabled. + example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/routing_agent.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/routing_agent.yml new file mode 100644 index 000000000..9389ce112 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/routing_agent.yml @@ -0,0 +1,8 @@ +type: object +nullable: true +description: An object specifying whether the routing-agent component should be enabled for the Kubernetes cluster. +properties: + enabled: + type: boolean + description: Indicates whether the routing-agent component is enabled. + example: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/status_messages.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/status_messages.yml new file mode 100644 index 000000000..8cd6c5408 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/models/status_messages.yml @@ -0,0 +1,16 @@ +type: object + +properties: + message: + type: string + readOnly: true + example: Resource provisioning may be delayed while our team resolves an incident + description: Status information about the cluster which impacts it's lifecycle. + + timestamp: + type: string + format: date-time + readOnly: true + example: "2018-11-15T16:00:11Z" + description: A timestamp in ISO8601 format that represents when the status + message was emitted. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/parameters.yml index 5d67dc6be..7dd684113 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/parameters.yml @@ -83,3 +83,14 @@ kubernetes_node_replace: maximum: 1 default: 0 example: 1 + +kubernetes_status_messages_since: + in: query + name: since + required: false + description: A timestamp used to return status messages emitted since the + specified time. The timestamp should be in ISO8601 format. + schema: + type: string + format: date-time + example: 2018-11-15T16:00:11Z diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/all_clusters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/all_clusters.yml index d436ab773..2b1af5c6a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/all_clusters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/all_clusters.yml @@ -20,10 +20,10 @@ content: kubernetes_clusters: type: array items: - $ref: '../models/cluster.yml' + $ref: '../models/cluster_read.yml' - $ref: '../../../shared/pages.yml#/pagination' - $ref: '../../../shared/meta.yml' examples: All Kubernetes Clusters: - $ref: 'examples.yml#/kubernetes_clusters_all' \ No newline at end of file + $ref: 'examples.yml#/kubernetes_clusters_all' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml index 05079644e..d092979a0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/examples.yml @@ -97,12 +97,31 @@ kubernetes_clusters_all: updated_at: '2018-11-15T16:00:11Z' surge_upgrade: false registry_enabled: false + registries: + - registry-a + - registry-b ha: false control_plane_firewall: enabled: true allowed_addresses: - "1.2.3.4/32" - "1.1.0.0/16" + cluster_autoscaler_configuration: + scale_down_utilization_threshold: 0.65 + scale_down_unneeded_time: "1m" + expanders: + - priority + - random + routing_agent: + enabled: false + amd_gpu_device_plugin: + enabled: false + amd_gpu_device_metrics_exporter_plugin: + enabled: false + nvidia_gpu_device_plugin: + enabled: false + rdma_shared_dev_plugin: + enabled: false meta: total: 1 @@ -204,12 +223,31 @@ kubernetes_single: updated_at: '2018-11-15T16:00:11Z' surge_upgrade: false registry_enabled: false + registries: + - registry-a + - registry-b ha: false control_plane_firewall: enabled: true allowed_addresses: - "1.2.3.4/32" - "1.1.0.0/16" + cluster_autoscaler_configuration: + scale_down_utilization_threshold: 0.65 + scale_down_unneeded_time: "1m" + expanders: + - priority + - random + routing_agent: + enabled: false + amd_gpu_device_plugin: + enabled: false + amd_gpu_device_metrics_exporter_plugin: + enabled: false + nvidia_gpu_device_plugin: + enabled: false + rdma_shared_dev_plugin: + enabled: false kubernetes_updated: value: @@ -309,12 +347,31 @@ kubernetes_updated: updated_at: '2018-11-15T16:00:11Z' surge_upgrade: true registry_enabled: false + registries: + - registry-a + - registry-b ha: false control_plane_firewall: enabled: true allowed_addresses: - "1.2.3.4/32" - "1.1.0.0/16" + cluster_autoscaler_configuration: + scale_down_utilization_threshold: 0.65 + scale_down_unneeded_time: "1m" + expanders: + - priority + - random + routing_agent: + enabled: false + amd_gpu_device_plugin: + enabled: false + amd_gpu_device_metrics_exporter_plugin: + enabled: false + nvidia_gpu_device_plugin: + enabled: false + rdma_shared_dev_plugin: + enabled: false kubernetes_clusters_create_basic_response: value: @@ -379,12 +436,31 @@ kubernetes_clusters_create_basic_response: updated_at: '2018-11-15T16:00:11Z' surge_upgrade: false registry_enabled: false + registries: + - registry-a + - registry-b ha: false control_plane_firewall: enabled: true allowed_addresses: - "1.2.3.4/32" - "1.1.0.0/16" + cluster_autoscaler_configuration: + scale_down_utilization_threshold: 0.65 + scale_down_unneeded_time: "1m" + expanders: + - priority + - random + routing_agent: + enabled: false + amd_gpu_device_plugin: + enabled: false + amd_gpu_device_metrics_exporter_plugin: + enabled: false + nvidia_gpu_device_plugin: + enabled: false + rdma_shared_dev_plugin: + enabled: false kubernetes_clusters_multi_pool_response: value: @@ -486,12 +562,21 @@ kubernetes_clusters_multi_pool_response: updated_at: '2018-11-15T16:00:11Z' surge_upgrade: false registry_enabled: false + registries: + - registry-a + - registry-b ha: false control_plane_firewall: enabled: true allowed_addresses: - "1.2.3.4/32" - "1.1.0.0/16" + cluster_autoscaler_configuration: + scale_down_utilization_threshold: 0.65 + scale_down_unneeded_time: "1m" + expanders: + - priority + - random kubernetes_options: value: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/existing_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/existing_cluster.yml index 5d24b01fc..a05e6fb0a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/existing_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/existing_cluster.yml @@ -16,7 +16,7 @@ content: schema: properties: kubernetes_cluster: - $ref: '../models/cluster.yml' + $ref: '../models/cluster_read.yml' examples: Single Kubernetes Cluster: - $ref: 'examples.yml#/kubernetes_single' \ No newline at end of file + $ref: 'examples.yml#/kubernetes_single' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/status_messages.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/status_messages.yml new file mode 100644 index 000000000..34119c222 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/responses/status_messages.yml @@ -0,0 +1,20 @@ +description: | + The response is a JSON object which contains status messages for a Kubernetes cluster. Each message object contains a timestamp and an indication of what issue the cluster is experiencing at a given time. + + +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: + messages: + type: array + items: + $ref: "../models/status_messages.yml" 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 49bab79d9..747e9a57a 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 @@ -29,6 +29,13 @@ properties: example: '104.131.186.241' description: An attribute containing the public-facing IP address of the load balancer. + + ipv6: + type: string + readOnly: true + example: '2604:a880:800:14::85f5:c000' + description: An attribute containing the public-facing IPv6 address of the + load balancer. size_unit: type: integer @@ -169,6 +176,17 @@ properties: to resources on the same VPC network. This property cannot be updated after creating the load balancer. + network_stack: + type: string + example: IPV4 + enum: + - IPV4 + - DUALSTACK + default: IPV4 + description: A string indicating whether the load balancer will support IPv4 + or both IPv4 and IPv6 networking. This property cannot be updated after + creating the load balancer. + type: type: string example: REGIONAL @@ -201,5 +219,15 @@ properties: description: An array containing the UUIDs of the Regional load balancers to be used as target backends for a Global load balancer. + tls_cipher_policy: + type: string + example: STRONG + enum: + - DEFAULT + - STRONG + default: DEFAULT + description: A string indicating the policy for the TLS cipher suites used by the load balancer. + The possible values are `DEFAULT` or `STRONG`. The default value is `DEFAULT`. + required: - forwarding_rules 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 index e7a5a8c88..d15eb54d5 100644 --- 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 @@ -11,6 +11,7 @@ properties: description: "destination name" example: "managed_opensearch_cluster" type: + type: string enum: - opensearch_dbaas - opensearch_ext 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 index 26967db56..13d535c46 100644 --- 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 @@ -9,6 +9,7 @@ properties: description: "destination name" example: "managed_opensearch_cluster" type: + type: string enum: - opensearch_dbaas - opensearch_ext 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 index e4f121778..0c2b0820a 100644 --- 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 @@ -8,6 +8,7 @@ properties: description: "destination name" example: "managed_opensearch_cluster" type: + type: string enum: - opensearch_dbaas - opensearch_ext diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml new file mode 100644 index 000000000..ff8faa330 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_cpu_usage.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_cpu_usage + +summary: Get Database MySQL CPU Usage Metrics + +description: >- + Retrieve CPU usage (percent) for a MySQL cluster. Response is a time series of + cluster-level CPU usage. Use **aggregate** to get avg, max, or min over the range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/aggregate_avg_max_min' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml new file mode 100644 index 000000000..0b8aa0da9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_disk_usage.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_disk_usage + +summary: Get Database MySQL Disk Usage Metrics + +description: >- + Retrieve disk usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, + or min) over the time range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/aggregate_avg_max_min' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml new file mode 100644 index 000000000..10a805023 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_index_vs_sequential_reads.yml @@ -0,0 +1,33 @@ +operationId: monitoring_get_database_mysql_index_vs_sequential_reads + +summary: Get Database MySQL Index vs Sequential Reads Metrics + +description: >- + Retrieve index vs sequential reads ratio (percent) for a MySQL service — i.e. + percentage of reads using an index. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_load.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_load.yml new file mode 100644 index 000000000..2de4dc17e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_load.yml @@ -0,0 +1,36 @@ +operationId: monitoring_get_database_mysql_load + +summary: Get Database MySQL Load Average Metrics + +description: >- + Retrieve load metrics for a MySQL cluster. Use **metric** for the window: **load1** (1-minute), + **load5** (5-minute), or **load15** (15-minute). Use **aggregate** to get either the average (avg) + or maximum (max) over that window over the time range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_load' + - $ref: 'parameters.yml#/aggregate_avg_max' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml new file mode 100644 index 000000000..9691e37cd --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_memory_usage.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_memory_usage + +summary: Get Database MySQL Memory Usage Metrics + +description: >- + Retrieve memory usage (percent) for a MySQL cluster. Use **aggregate** (avg, max, + or min) over the time range. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/aggregate_avg_max_min' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_op_rates.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_op_rates.yml new file mode 100644 index 000000000..801508137 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_op_rates.yml @@ -0,0 +1,34 @@ +operationId: monitoring_get_database_mysql_op_rates + +summary: Get Database MySQL Operations Throughput Metrics + +description: >- + Retrieve operations rate (per second) for a MySQL service. Use **metric** to + choose select, insert, update, or delete. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_op_rates' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml new file mode 100644 index 000000000..ac0a24a5c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_latency.yml @@ -0,0 +1,35 @@ +operationId: monitoring_get_database_mysql_schema_latency + +summary: Get Database MySQL Schema Latency Metrics + +description: >- + Retrieve table I/O latency (seconds) for a schema. Requires **schema** and + **metric** (insert, fetch, update, delete). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/schema' + - $ref: 'parameters.yml#/metric_schema_io' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml new file mode 100644 index 000000000..206cc2672 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_schema_throughput.yml @@ -0,0 +1,35 @@ +operationId: monitoring_get_database_mysql_schema_throughput + +summary: Get Database MySQL Schema Throughput Metrics + +description: >- + Retrieve table I/O throughput (rows per second) for a schema. Requires **schema** + and **metric** (insert, fetch, update, delete). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/schema' + - $ref: 'parameters.yml#/metric_schema_io' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_active.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_active.yml new file mode 100644 index 000000000..f9534212b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_active.yml @@ -0,0 +1,31 @@ +operationId: monitoring_get_database_mysql_threads_active + +summary: Get Database MySQL Threads Active Metrics + +description: Retrieve active (running) threads for a MySQL service. + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml new file mode 100644 index 000000000..3c2366aca --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_connected.yml @@ -0,0 +1,31 @@ +operationId: monitoring_get_database_mysql_threads_connected + +summary: Get Database MySQL Threads Connected Metrics + +description: Retrieve current threads connected for a MySQL service (gauge). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml new file mode 100644 index 000000000..8b2ca433e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_database_mysql_threads_created_rate.yml @@ -0,0 +1,31 @@ +operationId: monitoring_get_database_mysql_threads_created_rate + +summary: Get Database MySQL Threads Created Rate Metrics + +description: Retrieve threads created rate for a MySQL service (per second). + +tags: + - Monitoring + +parameters: + - $ref: 'parameters.yml#/db_id' + - $ref: 'parameters.yml#/metric_timestamp_start' + - $ref: 'parameters.yml#/metric_timestamp_end' + +responses: + "200": + $ref: responses/metric_response.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 + +security: + - bearer_auth: + - 'monitoring:read' 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 72f7561eb..750eca70f 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 @@ -119,3 +119,92 @@ sink_uuid: schema: type: string example: 78b172b6-52c3-4a4b-96d5-78d3f1a0b18c + +# DBaaS MySQL monitoring metrics parameters + +db_id: + in: query + name: db_id + required: true + description: The DBaaS cluster UUID (database ID). + schema: + type: string + format: uuid + example: 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + +aggregate_avg_max_min: + in: query + name: aggregate + required: true + description: Aggregation over the time range (avg, max, or min). + schema: + type: string + enum: + - avg + - max + - min + example: avg + +aggregate_avg_max: + in: query + name: aggregate + required: true + description: Aggregation over the time range (avg or max). + schema: + type: string + enum: + - avg + - max + example: avg + +metric_load: + in: query + name: metric + required: true + description: >- + Load window: **load1** (1-minute), **load5** (5-minute), **load15** (15-minute). The value is + either average or max over that window, depending on the **aggregate** parameter (avg or max). + schema: + type: string + enum: + - load1 + - load5 + - load15 + example: load1 + +metric_op_rates: + in: query + name: metric + required: true + description: Operation type (select, insert, update, or delete). + schema: + type: string + enum: + - select + - insert + - update + - delete + example: select + +metric_schema_io: + in: query + name: metric + required: true + description: Table I/O operation (insert, fetch, update, or delete). + schema: + type: string + enum: + - insert + - fetch + - update + - delete + example: insert + +schema: + in: query + name: schema + required: true + description: The schema (database) name. + schema: + type: string + example: defaultdb \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_actions_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_actions_create.yml new file mode 100644 index 000000000..06c4f0598 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_actions_create.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"type": "resize", "params": {"size_gib": 1024}, "region": "atl1"}' \ + "https://api.digitalocean.com/v2/nfs/${nfs_id}/actions" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_create.yml new file mode 100644 index 000000000..ded3bcb90 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_create.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "sammy-share-drive", "size_gib": 1024, "region": "atl1", "vpc_ids": ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"]}' \ + "https://api.digitalocean.com/v2/nfs" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_delete.yml new file mode 100644 index 000000000..359bd0f7f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_delete.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/nfs/{share_id}?region=atl1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_get.yml new file mode 100644 index 000000000..4ce6048c0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_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/nfs/{share_id}?region=atl1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_list.yml new file mode 100644 index 000000000..aec9562b4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_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/nfs?region=atl1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_delete.yml new file mode 100644 index 000000000..940f36769 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_delete.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/nfs/snapshots/{snapshot_id}?region=atl1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_get.yml new file mode 100644 index 000000000..3cea5da86 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_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/nfs/snapshots/{snapshot_id}?region=atl1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_list.yml new file mode 100644 index 000000000..7d3f8ff58 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/examples/curl/nfs_snapshot_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/nfs/snapshots?region=atl1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions.yml new file mode 100644 index 000000000..335142029 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions.yml @@ -0,0 +1,91 @@ +nfs_action: + required: + - type + type: object + description: Specifies the action that will be taken on the NFS share. + properties: + type: + type: string + enum: + - resize + - snapshot + example: resize + description: The type of action to initiate for the NFS share (such as resize or snapshot). + region: + type: string + description: The DigitalOcean region slug (e.g. atl1, nyc2) where the NFS snapshot resides. + example: atl1 + +nfs_action_resize: + allOf: + - $ref: '#/nfs_action' + - type: object + properties: + params: + type: object + properties: + size_gib: + type: integer + example: 2048 + description: The new size for the NFS share. + required: + - size_gib + +nfs_action_snapshot: + allOf: + - $ref: '#/nfs_action' + - type: object + properties: + params: + type: object + properties: + name: + type: string + example: daily-backup + description: Snapshot name of the NFS share + required: + - name + +nfs_action_attach: + allOf: + - $ref: '#/nfs_action' + - type: object + properties: + params: + type: object + properties: + vpc_id: + type: string + example: vpc-id-123 + description: The ID of the VPC to which the NFS share will be attached + required: + - vpc_id + +nfs_action_detach: + allOf: + - $ref: '#/nfs_action' + - type: object + properties: + params: + type: object + properties: + vpc_id: + type: string + example: vpc-id-123 + description: The ID of the VPC from which the NFS share will be detached + required: + - vpc_id +nfs_action_switch_performance_tier: + allOf: + - $ref: '#/nfs_action' + - type: object + properties: + params: + type: object + properties: + performance_tier: + type: string + example: standard + description: The performance tier to which the NFS share will be switched (e.g., standard, high). + required: + - performance_tier diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions_response.yml new file mode 100644 index 000000000..e245bb552 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_actions_response.yml @@ -0,0 +1,45 @@ +type: object +description: Action response of an NFS share. + +properties: + action: + type: object + description: The action that was submitted. + properties: + region_slug: + type: string + description: The DigitalOcean region slug where the resource is located. + example: "atl1" + resource_id: + type: string + format: uuid + description: The unique identifier of the resource on which the action is being performed. + example: "b5eb9e60-6750-4f3f-90b6-8296966eaf35" + resource_type: + type: string + enum: ["network_file_share", "network_file_share_snapshot"] + description: The type of resource on which the action is being performed. + example: "network_file_share" + started_at: + type: string + format: date-time + description: The timestamp when the action was started. + example: "2025-10-14T11:55:31.615157397Z" + status: + type: string + enum: ["in-progress", "completed", "errored"] + description: The current status of the action. + example: "in-progress" + type: + type: string + description: The type of action being performed. + example: "resize" + required: + - region_slug + - resource_id + - resource_type + - started_at + - status + - type +required: + - action diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_create_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_create_response.yml new file mode 100644 index 000000000..02b9a972b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_create_response.yml @@ -0,0 +1,5 @@ +type: object + +properties: + share: + $ref: 'nfs_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_get_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_get_response.yml new file mode 100644 index 000000000..02b9a972b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_get_response.yml @@ -0,0 +1,5 @@ +type: object + +properties: + share: + $ref: 'nfs_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_list_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_list_response.yml new file mode 100644 index 000000000..facc7e66a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_list_response.yml @@ -0,0 +1,7 @@ +type: object + +properties: + shares: + type: array + items: + $ref: 'nfs_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_request.yml new file mode 100644 index 000000000..8ac8f6c30 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_request.yml @@ -0,0 +1,30 @@ +--- +type: object +properties: + name: + type: string + description: The human-readable name of the share. + example: "my-nfs-share" + size_gib: + type: integer + description: The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50. + example: 50 + region: + type: string + description: The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + example: atl1 + vpc_ids: + type: array + items: + type: string + description: List of VPC IDs that should be able to access the share. + example: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + performance_tier: + type: string + description: The performance tier of the share. + example: "standard" +required: + - name + - size_gib + - region + - vpc_ids diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_response.yml new file mode 100644 index 000000000..0afd13e97 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_response.yml @@ -0,0 +1,53 @@ +--- +type: object +properties: + id: + type: string + description: The unique identifier of the NFS share. + readOnly: true + example: "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d" + name: + type: string + description: The human-readable name of the share. + example: "sammy-share-drive" + size_gib: + type: integer + description: The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50. + example: 1024 + region: + type: string + description: The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + example: "atl1" + status: + type: string + enum: [CREATING, ACTIVE, FAILED, DELETED] + description: The current status of the share. + readOnly: true + example: "ACTIVE" + created_at: + type: string + format: date-time + description: Timestamp for when the NFS share was created. + readOnly: true + example: "2023-01-01T00:00:00Z" + vpc_ids: + type: array + items: + type: string + description: List of VPC IDs that should be able to access the share. + example: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + mount_path: + type: string + description: Path at which the share will be available, to be mounted at a target of the user's choice within the client + example: "/123456/your-nfs-share-uuid" + host: + type: string + description: The host IP of the NFS server that will be accessible from the associated VPC + example: "10.128.32.2" +required: + - id + - name + - size_gib + - region + - status + - created_at diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_get_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_get_response.yml new file mode 100644 index 000000000..138374f3e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_get_response.yml @@ -0,0 +1,5 @@ +type: object + +properties: + snapshot: + $ref: 'nfs_snapshot_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_list_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_list_response.yml new file mode 100644 index 000000000..7a2188a19 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_list_response.yml @@ -0,0 +1,7 @@ +type: object + +properties: + snapshots: + type: array + items: + $ref: 'nfs_snapshot_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_response.yml new file mode 100644 index 000000000..2bd0d0194 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/models/nfs_snapshot_response.yml @@ -0,0 +1,44 @@ +--- +type: object +description: Represents an NFS snapshot. +properties: + id: + type: string + description: The unique identifier of the snapshot. + example: "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d" + name: + type: string + description: The human-readable name of the snapshot. + example: "daily-backup" + size_gib: + type: integer + format: uint64 + description: The size of the snapshot in GiB. + example: 1024 + region: + type: string + description: The DigitalOcean region slug where the snapshot is located. + example: "atl1" + status: + type: string + enum: [UNKNOWN, CREATING, ACTIVE, FAILED, DELETED] + description: The current status of the snapshot. + example: "CREATING" + created_at: + type: string + format: date-time + description: The timestamp when the snapshot was created. + example: "2023-11-14T16:29:21Z" + share_id: + type: string + format: uuid + description: The unique identifier of the share from which this snapshot was created. + example: "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d" +required: + - id + - name + - region + - size_gib + - status + - created_at + - share_id diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_actions_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_actions_create.yml new file mode 100644 index 000000000..e4356a049 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_actions_create.yml @@ -0,0 +1,74 @@ +operationId: nfs_create_action + +summary: Initiate an NFS action + +description: | + To execute an action (such as resize) on a specified NFS share, + send a POST request to `/v2/nfs/{nfs_id}/actions`. In the JSON body + to the request, set the `type` attribute to on of the supported action types: + + | Action | Details | + | -------------------------------- | ----------- | + | `resize` | Resizes an NFS share. Set the size_gib attribute to a desired value in GiB | + | `snapshot` | Takes a snapshot of an NFS share | + | `attach` | Attaches an NFS share to a VPC. Set the vpc_id attribute to the desired VPC ID | + | `detach` | Detaches an NFS share from a VPC. Set the vpc_id attribute to the desired VPC ID | + | `switch_performance_tier` | Switches the performance tier of an NFS share. Set the performance_tier attribute to the desired tier (e.g., standard, high) | + +tags: + - NFS Actions + +parameters: + - $ref: "parameters.yml#/nfs_id" + +requestBody: + required: true + + description: | + The `type` attribute set in the request body will specify the action that + will be taken on the NFS share. Some actions will require additional + attributes to be set as well. + + content: + application/json: + schema: + anyOf: + - $ref: 'models/nfs_actions.yml#/nfs_action_resize' + - $ref: 'models/nfs_actions.yml#/nfs_action_snapshot' + - $ref: 'models/nfs_actions.yml#/nfs_action_attach' + - $ref: 'models/nfs_actions.yml#/nfs_action_detach' + - $ref: 'models/nfs_actions.yml#/nfs_action_switch_performance_tier' + discriminator: + propertyName: type + mapping: + resize: 'models/nfs_actions.yml#/nfs_action_resize' + snapshot: 'models/nfs_actions.yml#/nfs_action_snapshot' + attach: 'models/nfs_actions.yml#/nfs_action_attach' + detach: 'models/nfs_actions.yml#/nfs_action_detach' + switch_performance_tier: 'models/nfs_actions.yml#/nfs_action_switch_performance_tier' + +responses: + '201': + $ref: 'responses/nfs_actions.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/nfs_actions_create.yml' + +security: + - bearer_auth: + - 'nfs:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_create.yml new file mode 100644 index 000000000..5d989fc57 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_create.yml @@ -0,0 +1,52 @@ +operationId: nfs_create + +summary: Create a new NFS share + +description: | + To create a new NFS share, send a POST request to `/v2/nfs`. + +tags: + - NFS + +requestBody: + required: true + + content: + application/json: + schema: + $ref: 'models/nfs_request.yml' + + examples: + Basic NFS Share: + value: + name: "sammy-share-drive" + size_gib: 1024 + region: "atl1" + vpc_ids: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + performance_tier: "standard" + +responses: + '201': + $ref: 'responses/nfs_create.yml' + + '400': + $ref: 'responses/bad_request.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/nfs_create.yml' + +security: + - bearer_auth: + - "nfs:create" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_delete.yml new file mode 100644 index 000000000..67ca2e4d3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_delete.yml @@ -0,0 +1,41 @@ +operationId: nfs_delete + +summary: "Delete an NFS share" + +description: | + To delete an NFS share, send a DELETE request to `/v2/nfs/{nfs_id}?region=${region}`. + + A successful request will return a `204 No Content` status code. + +tags: + - NFS + +parameters: + - $ref: "parameters.yml#/nfs_id" + - $ref: "parameters.yml#/region" + +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/nfs_delete.yml' + +security: + - bearer_auth: + - "nfs:delete" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_get.yml new file mode 100644 index 000000000..50c6554ea --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_get.yml @@ -0,0 +1,41 @@ +operationId: nfs_get + +summary: Get an NFS share + +description: | + To get an NFS share, send a GET request to `/v2/nfs/{nfs_id}?region=${region}`. + + A successful request will return the NFS share. + +tags: + - NFS + +parameters: + - $ref: "parameters.yml#/nfs_id" + - $ref: "parameters.yml#/region" + +responses: + "200": + $ref: "responses/nfs_get.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/nfs_get.yml' + +security: + - bearer_auth: + - "nfs:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_list.yml new file mode 100644 index 000000000..f06867c77 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_list.yml @@ -0,0 +1,40 @@ +operationId: nfs_list + +summary: List NFS shares per region + +description: | + To list NFS shares, send a GET request to `/v2/nfs?region=${region}`. + + A successful request will return all NFS shares belonging to the authenticated user. + +tags: + - NFS + +parameters: + - $ref: "parameters.yml#/region" + +responses: + "200": + $ref: "responses/nfs_list.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/nfs_list.yml' + +security: + - bearer_auth: + - "nfs:list" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_delete.yml new file mode 100644 index 000000000..5ba6bafb6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_delete.yml @@ -0,0 +1,41 @@ +operationId: nfs_delete_snapshot + +summary: "Delete an NFS snapshot" + +description: | + To delete an NFS snapshot, send a DELETE request to `/v2/nfs/snapshots/{nfs_snapshot_id}?region=${region}`. + + A successful request will return a `204 No Content` status code. + +tags: + - NFS + +parameters: + - $ref: "parameters.yml#/nfs_snapshot_id" + - $ref: "parameters.yml#/region" + +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/nfs_snapshot_delete.yml' + +security: + - bearer_auth: + - "nfs:delete" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_get.yml new file mode 100644 index 000000000..9d89ad563 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_get.yml @@ -0,0 +1,41 @@ +operationId: nfs_get_snapshot + +summary: Get an NFS snapshot by ID + +description: | + To get an NFS snapshot, send a GET request to `/v2/nfs/snapshots/{nfs_snapshot_id}?region=${region}`. + + A successful request will return the NFS snapshot. + +tags: + - NFS + +parameters: + - $ref: "parameters.yml#/nfs_snapshot_id" + - $ref: "parameters.yml#/region" + +responses: + "200": + $ref: "responses/nfs_snapshot_get.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/nfs_snapshot_get.yml' + +security: + - bearer_auth: + - "nfs:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_list.yml new file mode 100644 index 000000000..4aad10155 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/nfs_snapshot_list.yml @@ -0,0 +1,43 @@ +operationId: nfs_list_snapshot + +summary: List NFS snapshots per region + +description: | + To list all NFS snapshots, send a GET request to `/v2/nfs/snapshots?region=${region}&share_id={share_id}`. + + A successful request will return all NFS snapshots belonging to the authenticated user in the specified region. + + Optionally, you can filter snapshots by a specific NFS share by including the `share_id` query parameter. + +tags: + - NFS + +parameters: + - $ref: "parameters.yml#/region" + - $ref: "parameters.yml#/share_id" + +responses: + "200": + $ref: "responses/nfs_snapshot_list.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/nfs_snapshot_list.yml' + +security: + - bearer_auth: + - "nfs:list" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/parameters.yml new file mode 100644 index 000000000..8a0cb9ad8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/parameters.yml @@ -0,0 +1,61 @@ +nfs_id: + in: path + name: nfs_id + description: The unique ID of the NFS share + required: true + schema: + type: string + example: 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + +name: + in: query + name: name + required: true + description: The human-readable name of the share. + schema: + type: string + example: my-nfs-share + +size_gib: + in: query + name: size_gib + required: true + description: The desired/provisioned size of the share in GiB (Gibibytes). Must be >= 50. + schema: + type: integer + example: 50 + +region: + in: query + name: region + description: The DigitalOcean region slug (e.g., nyc2, atl1) where the NFS share resides. + schema: + type: string + example: atl1 + +vpc_ids: + in: query + name: vpc_ids + required: true + description: List of VPC IDs that should be able to access the share. + schema: + type: string + example: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + +nfs_snapshot_id: + in: path + name: nfs_snapshot_id + description: The unique ID of the NFS snapshot + required: true + schema: + type: string + example: 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d + +share_id: + in: query + name: share_id + required: false + description: The unique ID of an NFS share. If provided, only snapshots of this specific share will be returned. + schema: + type: string + example: 0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/bad_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/bad_request.yml new file mode 100644 index 000000000..6769c2747 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/bad_request.yml @@ -0,0 +1,17 @@ +description: Size must be greater than or equal to 50Gib + +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: + $ref: '../../../shared/models/error.yml' + example: + id: bad_request + message: The value for 'size_gib' must be greater than or equal to 50Gib. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_actions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_actions.yml new file mode 100644 index 000000000..9f36a693b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_actions.yml @@ -0,0 +1,14 @@ +description: The response will be a JSON object with a key called `action`. + +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: + $ref: '../models/nfs_actions_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_create.yml new file mode 100644 index 000000000..0e2e2f423 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_create.yml @@ -0,0 +1,14 @@ +--- +description: >- + A JSON response containing details about the new NFS share. +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: + $ref: '../models/nfs_create_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_get.yml new file mode 100644 index 000000000..b9f664a4d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_get.yml @@ -0,0 +1,30 @@ +description: >- + The response will be a JSON object with a key called `share`. The value will + be an object containing the standard attributes associated with an NFS share. + +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: + $ref: '../models/nfs_get_response.yml' + + examples: + Active Share: + value: + share: + id: "0a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d" + name: "sammy-share-drive" + size_gib: 1024 + region: "atl1" + status: "ACTIVE" + created_at: "2023-01-01T00:00:00Z" + vpc_ids: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + mount_path: "/123456/your-nfs-share-uuid" + host: "10.128.32.2" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_list.yml new file mode 100644 index 000000000..2bea786c2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_list.yml @@ -0,0 +1,18 @@ +--- +description: >- + The response will be a JSON object with a key called `shares`. + The value will be an array of objects, each containing the standard + attributes associated with an NFS share. + +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: + $ref: '../models/nfs_list_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_get.yml new file mode 100644 index 000000000..4af4587cd --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_get.yml @@ -0,0 +1,16 @@ +description: >- + The response will be a JSON object with a key called `snapshot`. The value will + be an object containing the standard attributes associated with an NFS snapshot. + +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: + $ref: '../models/nfs_snapshot_get_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_list.yml new file mode 100644 index 000000000..a4f8ee3e4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/nfs/responses/nfs_snapshot_list.yml @@ -0,0 +1,18 @@ +--- +description: >- + The response will be a JSON object with a key called `snapshots`. + The value will be an array of objects, each containing the standard + attributes associated with an NFS snapshot. + +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: + $ref: '../models/nfs_snapshot_list_response.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_bgp_auth_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_bgp_auth_key_get.yml new file mode 100644 index 000000000..c948be710 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_bgp_auth_key_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/partner_network_connect/attachments/5a4981aa-9653-4bd1-bef5-d6bff52042e4/bgp_auth_key" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_create.yml new file mode 100644 index 000000000..c743cbe72 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_create.yml @@ -0,0 +1,10 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name":"c5pAqd-ped-007","connection_bandwidth_in_mbps":1000,"region":"NYC","naas_provider":"MEGAPORT","vpc_ids":["bafc1c1d-bac1-2412-7f5e-fezc832z213z"],"bgp":{"local_router_ip":"169.254.11.1/29","peer_router_ip":"169.254.11.2/29","peer_router_asn":133938,"auth_key":"0zzyTNuRZa00vqkzIToPG3q"}}' \ + "https://api.digitalocean.com/v2/partner_network_connect/attachments" + + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_delete.yml new file mode 100644 index 000000000..00b724b2c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_delete.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/partner_network_connect/attachments/5a4981aa-9653-4bd1-bef5-d6bff52042e4" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_get.yml new file mode 100644 index 000000000..c4d36be03 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_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/partner_network_connect/attachments/5a4981aa-9653-4bd1-bef5-d6bff52042e4" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_list.yml new file mode 100644 index 000000000..7bc647a2d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_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/partner_network_connect/attachments" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_create.yml new file mode 100644 index 000000000..ac9e10bbc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_create.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/partner_network_connect/attachments/1cf0aad8-292b-40f8-9d32-1fbde6e04991/service_key" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_get.yml new file mode 100644 index 000000000..13a84be73 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_service_key_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/partner_network_connect/attachments/1cf0aad8-292b-40f8-9d32-1fbde6e04991/service_key" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_update.yml new file mode 100644 index 000000000..c671b669b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/curl/partner_attachment_update.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/partner_network_connect/attachments/5a4981aa-9653-4bd1-bef5-d6bff52042e4" \ + -d '{ "name": "partner-network-test" }' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_bgp_auth_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_bgp_auth_key_get.yml new file mode 100644 index 000000000..92c0add56 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_bgp_auth_key_get.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + response, _, err := client.PartnerAttachment.GetBGPAuthKey(ctx,"5a4981aa-9653-4bd1-bef5-d6bff52042e4") + } \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_create.yml new file mode 100644 index 000000000..a491e8769 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_create.yml @@ -0,0 +1,31 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + createReq := &godo.PartnerAttachmentCreateRequest{ + Name:"c5pAqd-ped-007", + ConnectionBandwidthInMbps:1000, + Region:"NYC", + NaaSProvider:"MEGAPORT", + VPCIDs:[]string{"bafc1c1d-bac1-2412-7f5e-fezc832z213z"}, + BGP: godo.BGP{ + LocalRouterIP:"169.254.11.1/29", + PeerRouterIP:"169.254.11.2/29", + PeerASN:133938, + AuthKey:"0zzyTNuRZa00vqkzIToPG3q", + }, + } + + response, _, err := client.PartnerAttachment.Create(ctx, createReq) + } + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_delete.yml new file mode 100644 index 000000000..04241085f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_delete.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + response, err := client.PartnerAttachment.Delete(ctx,"5a4981aa-9653-4bd1-bef5-d6bff52042e4") + } \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_get.yml new file mode 100644 index 000000000..d811cd7e1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_get.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + partnerAttachmentResponse, _, err := client.PartnerAttachment.Get(ctx, "5a4981aa-9653-4bd1-bef5-d6bff52042e4") + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_list.yml new file mode 100644 index 000000000..342ef9d46 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_list.yml @@ -0,0 +1,19 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("$DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + + ListOptions := &godo.ListOptions{ Page: 1, PerPage: 20, WithProjects: true} + + response, _, err := client.PartnerAttachment.List(ctx, ListOptions) + } + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_create.yml new file mode 100644 index 000000000..8260e5d32 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_create.yml @@ -0,0 +1,15 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + response, _, err := client.PartnerAttachment.RegenerateServiceKey(ctx, "5a4981aa-9653-4bd1-bef5-d6bff52042e4") + } \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_get.yml new file mode 100644 index 000000000..b2a21f524 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_service_key_get.yml @@ -0,0 +1,15 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + client := godo.NewFromToken(token) + ctx := context.TODO() + response, _, err := client.PartnerAttachment.GetServiceKey(ctx, "5a4981aa-9653-4bd1-bef5-d6bff52042e4") + } \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_update.yml new file mode 100644 index 000000000..3896f44db --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/go/partner_attachment_update.yml @@ -0,0 +1,21 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + partnerAttachmentRequest := &godo.PartnerAttachmentUpdateRequest{ + Name: "partner-network-test-region", + } + + response, _, err := client.PartnerAttachment.Update(ctx, "5a4981aa-9653-4bd1-bef5-d6bff52042e4", partnerAttachmentRequest) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_bgp_auth_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_bgp_auth_key_get.yml new file mode 100644 index 000000000..01712e68e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_bgp_auth_key_get.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + + response = client.partner_attachments.get_bgp_auth_key("5a4981aa-9653-4bd1-bef5-d6bff52042e4") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_create.yml new file mode 100644 index 000000000..54e140286 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_create.yml @@ -0,0 +1,24 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + + req = { + "connection_bandwidth_in_mbps": 1000, + "naas_provider": "MEGAPORT", + "name": "c5pAqd-ped-007", + "region": "NYC", + "vpc_ids": [ + "bafc1c1d-bac1-2412-7f5e-fezc832z213z" + ], + "bgp": { + "auth_key": "0zzyTNuRZa00vqkzIToPG3q", + "local_router_ip": "169.254.11.1/29", + "peer_router_asn": 133938, + "peer_router_ip": "169.254.11.2/29" + }, + } + + resp = client.partner_attachments.create(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_delete.yml new file mode 100644 index 000000000..ea9788b76 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_delete.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + + response = client.partner_attachments.delete("5a4981aa-9653-4bd1-bef5-d6bff52042e4") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_get.yml new file mode 100644 index 000000000..f3000257c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_get.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + + partner_attachment_response = client.partner_attachments.get("5a4981aa-9653-4bd1-bef5-d6bff52042e4") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_list.yml new file mode 100644 index 000000000..4ce33996d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_list.yml @@ -0,0 +1,9 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("$DIGITALOCEAN_TOKEN")) + + partner_attachment_response = client.partner_attachments.list() + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_create.yml new file mode 100644 index 000000000..a4e434f8f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_create.yml @@ -0,0 +1,6 @@ +lang: Python +source: |- + import os + from pydo import Client + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + response = client.partner_attachments.create_service_key("5a4981aa-9653-4bd1-bef5-d6bff52042e4") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_get.yml new file mode 100644 index 000000000..526d4f232 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_service_key_get.yml @@ -0,0 +1,6 @@ +lang: Python +source: |- + import os + from pydo import Client + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + response = client.partner_attachments.get_service_key("5a4981aa-9653-4bd1-bef5-d6bff52042e4") \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_update.yml new file mode 100644 index 000000000..62bb87a5e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/examples/python/partner_attachment_update.yml @@ -0,0 +1,11 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN")) + request = { + "Name": "partner-network-test" + } + + print(client.partner_attachments.patch("5a4981aa-9653-4bd1-bef5-d6bff52042e4", body = request)) \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/bgp_auth_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/bgp_auth_key.yml new file mode 100644 index 000000000..bae617c03 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/bgp_auth_key.yml @@ -0,0 +1,8 @@ +partner_attachment_bgp_auth_key: + type: object + properties: + value: + type: string + readOnly: true + example: secret + description: The BGP authentication key for the partner attachment. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/partner_attachment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/partner_attachment.yml new file mode 100644 index 000000000..99e8e76a1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/partner_attachment.yml @@ -0,0 +1,227 @@ +partner_attachment: + type: object + properties: + id: + type: string + format: string + readOnly: true + example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + description: A unique ID that can be used to identify and reference the partner attachment. + x-order: 1 + name: + type: string + pattern: ^[a-zA-Z0-9\-\.]+$ + example: env.prod-partner-network-connect + description: >- + The name of the partner attachment. Must be unique and may only contain + alphanumeric characters, dashes, and periods. + x-order: 2 + state: + type: string + readOnly: true + example: active + description: The current operational state of the attachment. + x-order: 4 + connection_bandwidth_in_mbps: + type: integer + example: 1000 + description: The bandwidth (in Mbps) of the connection. + x-order: 5 + region: + type: string + example: nyc + description: The region where the partner attachment is located. + x-order: 6 + naas_provider: + type: string + example: megaport + description: The Network as a Service (NaaS) provider for the partner attachment. + x-order: 7 + vpc_ids: + type: array + items: + type: string + format: string + minItems: 1 + example: + - c140286f-e6ce-4131-8b7b-df4590ce8d6a + - 994a2735-dc84-11e8-80bc-3cfdfea9fba1 + description: An array of VPC network IDs. + x-order: 8 + bgp: + type: object + properties: + local_asn: + type: integer + example: 64532 + description: ASN of the local router. + peer_asn: + type: integer + example: 64532 + description: ASN of the peer router + local_router_ip: + type: string + example: 169.254.0.1/29 + description: IP of the DigitalOcean router + peer_router_ip: + type: string + example: 169.254.0.1/29 + description: IP of the peer router + description: The BGP configuration for the partner attachment. + x-order: 9 + 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. + x-order: 10 + parent_uuid: + type: string + readOnly: true + example: 34259a41-0ca6-4a6b-97dd-a22bcab900dd + description: Associated partner attachment UUID + x-order: 11 + children: + type: array + readOnly: true + items: + type: string + format: string + minItems: 1 + example: + - ee1ad867-7026-44a5-bfcc-2587b52e1291 + description: An array of associated partner attachment UUIDs. + x-order: 12 + +partner_attachment_writable: + type: object + required: + - name + - connection_bandwidth_in_mbps + - region + - naas_provider + - vpc_ids + properties: + name: + type: string + pattern: ^[a-zA-Z0-9\-\.]+$ + example: env.prod-partner-network-connect + description: >- + The name of the partner attachment. Must be unique and may only contain + alphanumeric characters, dashes, and periods. + connection_bandwidth_in_mbps: + type: integer + description: Bandwidth (in Mbps) of the connection. + enum: [ 1000, 2000, 5000, 10000 ] + example: 1000 + region: + description: The region to create the partner attachment. + enum: [nyc, sfo, fra, ams, sgp] + type: string + example: nyc + naas_provider: + type: string + example: megaport + vpc_ids: + type: array + items: + type: string + format: string + minItems: 1 + example: + - c140286f-e6ce-4131-8b7b-df4590ce8d6a + - 994a2735-dc84-11e8-80bc-3cfdfea9fba1 + description: An array of VPCs IDs. + parent_uuid: + type: string + description: Optional associated partner attachment UUID + example: d594cf8d-8c79-4bc5-aec1-6f9b211506b3 + bgp: + type: object + description: Optional BGP configurations + required: + - local_router_ip + - peer_router_ip + - peer_router_asn + - auth_key + properties: + local_router_ip: + type: string + example: 169.254.0.1/29 + description: IP of the DO router + peer_router_ip: + type: string + example: 169.254.0.6/29 + description: IP of the Naas Provider router + peer_router_asn: + type: integer + example: 64532 + description: ASN of the peer router + auth_key: + type: string + example: 0xsNnb1pwQlowdoMySEfWwk4I + description: BGP Auth Key + redundancy_zone: + type: string + description: Optional redundancy zone for the partner attachment. + enum: [ MEGAPORT_BLUE, MEGAPORT_RED ] + example: MEGAPORT_BLUE + +partner_attachment_updatable: + anyOf: + - title: Name + required: + - name + type: object + properties: + name: + type: string + pattern: ^[a-zA-Z0-9\-\.]+$ + example: env.prod-partner-network-connect + description: >- + The name of the partner attachment. Must be unique and may only contain + alphanumeric characters, dashes, and periods. + - title: VPC IDs + type: object + required: + - vpc_ids + properties: + vpc_ids: + type: array + items: + type: string + format: string + minItems: 1 + example: + - c140286f-e6ce-4131-8b7b-df4590ce8d6a + - 994a2735-dc84-11e8-80bc-3cfdfea9fba1 + description: An array of VPCs IDs. + - title: BGP + type: object + properties: + bgp: + type: object + description: BGP configurations + required: + - local_router_ip + - peer_router_ip + - peer_router_asn + - auth_key + properties: + local_router_ip: + type: string + example: 169.254.0.1/29 + description: IP of the DO router + peer_router_ip: + type: string + example: 169.254.0.6/29 + description: IP of the NaaS provider router + peer_router_asn: + type: integer + example: 64532 + description: ASN of the peer router + auth_key: + type: string + example: 0xsNnb1pwQlowdoMySEfWwk4I + description: BGP Auth Key diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/remote_route.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/remote_route.yml new file mode 100644 index 000000000..80fe56b00 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/remote_route.yml @@ -0,0 +1,8 @@ +partner_attachment_remote_route: + type: object + properties: + cidr: + type: string + readOnly: true + example: 10.10.10.0/24 + description: A CIDR block representing a remote route. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/service_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/service_key.yml new file mode 100644 index 000000000..7f49d8a1d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/models/service_key.yml @@ -0,0 +1,20 @@ +partner_attachment_service_key: + type: object + properties: + value: + type: string + readOnly: true + example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + x-order: 1 + created_at: + type: string + format: date-time + readOnly: true + example: '2020-03-13T19:20:47.442049222Z' + description: A time value given in the ISO 8601 combined date and time format. + x-order: 2 + state: + type: string + readOnly: true + example: "CREATED" + x-order: 3 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/parameters.yml new file mode 100644 index 000000000..06366b2e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/parameters.yml @@ -0,0 +1,10 @@ +pa_id: + in: path + name: pa_id + description: A unique identifier for a partner attachment. + required: true + schema: + type: string + format: string + minimum: 1 + example: 4de7ac8b-495b-4884-9a69-1050c6793cd6 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_bgp_auth_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_bgp_auth_key_get.yml new file mode 100644 index 000000000..f8412cc1d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_bgp_auth_key_get.yml @@ -0,0 +1,41 @@ +operationId: partnerAttachments_get_bgp_auth_key + +summary: Get current BGP auth key for the partner attachment + +description: | + To get the current BGP auth key for a partner attachment, send a `GET` request to + `/v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key`. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + +responses: + '200': + $ref: 'responses/single_partner_attachment_bgp_auth_key.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/partner_attachment_bgp_auth_key_get.yml' + - $ref: 'examples/go/partner_attachment_bgp_auth_key_get.yml' + - $ref: 'examples/python/partner_attachment_bgp_auth_key_get.yml' + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_create.yml new file mode 100644 index 000000000..eb7e89d89 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_create.yml @@ -0,0 +1,48 @@ +operationId: partnerAttachments_create + +summary: Create a new partner attachment + +description: | + To create a new partner attachment, send a `POST` request to + `/v2/partner_network_connect/attachments` with a JSON object containing the + required configuration details. + +tags: + - Partner Network Connect + +requestBody: + content: + application/json: + schema: + $ref: 'models/partner_attachment.yml#/partner_attachment_writable' + +responses: + '202': + $ref: 'responses/single_partner_attachment.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '422': + $ref: '../../shared/responses/unprocessable_entity.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/partner_attachment_create.yml' + - $ref: 'examples/go/partner_attachment_create.yml' + - $ref: 'examples/python/partner_attachment_create.yml' + +security: + - bearer_auth: + - partner_network_connect:create diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_delete.yml new file mode 100644 index 000000000..4f0e20945 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_delete.yml @@ -0,0 +1,41 @@ +operationId: partnerAttachments_delete + +summary: Delete an existing partner attachment + +description: | + To delete an existing partner attachment, send a `DELETE` request to + `/v2/partner_network_connect/attachments/{pa_id}`. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + +responses: + '202': + $ref: 'responses/single_partner_attachment_deleting.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/partner_attachment_delete.yml' + - $ref: 'examples/go/partner_attachment_delete.yml' + - $ref: 'examples/python/partner_attachment_delete.yml' + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_get.yml new file mode 100644 index 000000000..2b222952a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_get.yml @@ -0,0 +1,42 @@ +operationId: partnerAttachments_get + +summary: Retrieve an existing partner attachment + +description: | + To get the details of a partner attachment, send a `GET` request to + `/v2/partner_network_connect/attachments/{pa_id}`. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + +responses: + '200': + $ref: 'responses/single_partner_attachment.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/partner_attachment_get.yml' + - $ref: 'examples/go/partner_attachment_get.yml' + - $ref: 'examples/python/partner_attachment_get.yml' + + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_list.yml new file mode 100644 index 000000000..7f4e848a6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_list.yml @@ -0,0 +1,42 @@ +operationId: partnerAttachments_list + +summary: List all partner attachments + +description: >- + To list all of the Partner Attachments on your account, send a `GET` request to + `/v2/partner_network_connect/attachments`. + +tags: + - Partner Network Connect + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/all_partner_attachments.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/partner_attachment_list.yml' + - $ref: 'examples/go/partner_attachment_list.yml' + - $ref: 'examples/python/partner_attachment_list.yml' + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_remote_routes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_remote_routes_list.yml new file mode 100644 index 000000000..d2932f3ad --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_remote_routes_list.yml @@ -0,0 +1,46 @@ +operationId: partnerAttachments_list_remote_routes + +summary: List remote routes for a partner attachment + +description: | + To list all remote routes associated with a partner attachment, send a `GET` request to + `/v2/partner_network_connect/attachments/{pa_id}/remote_routes`. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/all_partner_attachment_remote_routes.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: + - lang: cURL + source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/partner_network_connect/attachments/9ddccad8-a6d2-42f1-84e7-c92916193978/remote_routes" + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_create.yml new file mode 100644 index 000000000..fd1af96cf --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_create.yml @@ -0,0 +1,42 @@ +operationId: partnerAttachments_create_service_key + +summary: Regenerate the service key for the partner attachment + +description: > + This operation generates a new service key for the specified partner attachment. + The operation is asynchronous, and the response is an empty JSON object returned with a 202 status code. + To poll for the new service key, send a `GET` request to `/v2/partner_network_connect/attachments/{pa_id}/service_key`. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + +responses: + '202': + $ref: 'responses/empty_json_object.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/partner_attachment_service_key_create.yml' + - $ref: 'examples/go/partner_attachment_service_key_create.yml' + - $ref: 'examples/python/partner_attachment_service_key_create.yml' + +security: + - bearer_auth: + - partner_network_connect:write diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_get.yml new file mode 100644 index 000000000..97e618134 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_service_key_get.yml @@ -0,0 +1,41 @@ +operationId: partnerAttachments_get_service_key + +summary: Get the current service key for the partner attachment + +description: | + To get the current service key for a partner attachment, send a `GET` request to + `/v2/partner_network_connect/attachments/{pa_id}/service_key`. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + +responses: + '200': + $ref: 'responses/single_partner_attachment_service_key.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/partner_attachment_service_key_get.yml' + - $ref: 'examples/go/partner_attachment_service_key_get.yml' + - $ref: 'examples/python/partner_attachment_service_key_get.yml' + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_update.yml new file mode 100644 index 000000000..67a03ddc5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/partner_attachment_update.yml @@ -0,0 +1,48 @@ +operationId: partnerAttachments_patch + +summary: Update an existing partner attachment + +description: | + To update an existing partner attachment, send a `PATCH` request to + `/v2/partner_network_connect/attachments/{pa_id}` with a JSON object containing the + fields to be updated. + +tags: + - Partner Network Connect + +parameters: + - $ref: 'parameters.yml#/pa_id' + +requestBody: + content: + application/json: + schema: + $ref: 'models/partner_attachment.yml#/partner_attachment_updatable' + +responses: + '202': + $ref: 'responses/single_partner_attachment.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/partner_attachment_update.yml' + - $ref: 'examples/go/partner_attachment_update.yml' + - $ref: 'examples/python/partner_attachment_update.yml' + +security: + - bearer_auth: + - partner_network_connect:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachment_remote_routes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachment_remote_routes.yml new file mode 100644 index 000000000..c9fd4d2e0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachment_remote_routes.yml @@ -0,0 +1,31 @@ +description: |- + The response will be a JSON object with a `remote_routes` array containing + information on all the remote routes associated with the partner attachment + +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: + remote_routes: + type: array + items: + $ref: '../models/remote_route.yml#/partner_attachment_remote_route' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + example: + remote_routes: + - cidr: 10.10.10.0/24 + - cidr: 10.10.10.10/24 + links: {} + meta: + total: 2 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachments.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachments.yml new file mode 100644 index 000000000..cffef7c96 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/all_partner_attachments.yml @@ -0,0 +1,57 @@ +description: |- + The response will be a JSON object with a `partner_attachments` key + that contains an array of all partner attachments + +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: + partner_attachments: + type: array + items: + $ref: '../models/partner_attachment.yml#/partner_attachment' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + example: + partner_attachments: + - name: env.prod-partner-network-connect + id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + urn: do:partner_attachment:5a4981aa-9653-4bd1-bef5-d6bff52042e4 + state: active + created_at: '2020-03-13T19:20:47.442049222Z' + connection_bandwidth_in_mbps: 10000 + region: nyc + naas_provider: MEGAPORT + vpc_ids: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + bgp: + local_asn: 65432 + local_router_ip: "169.254.0.1/29" + peer_asn: 133937 + peer_router_ip: "169.254.0.6/29" + - id: e0fe0f4d-596a-465e-a902-571ce57b79fa + urn: do:partner_attachment:e0fe0f4d-596a-465e-a902-571ce57b79fa + state: active + name: env.test-partner-network-connect + created_at: '2020-03-13T19:29:20Z' + connection_bandwidth_in_mbps: 10000 + region: nyc + naas_provider: MEGAPORT + vpc_ids: ["e9eef79d-eb6f-4de1-a5b2-38d7468c75c0", "ac1a3d83-349f-4f67-8214-c2803cec0cff"] + bgp: + local_asn: 65432 + local_router_ip: "169.254.0.9/29" + peer_asn: 133937 + peer_router_ip: "169.254.0.14/29" + links: {} + meta: + total: 2 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/empty_json_object.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/empty_json_object.yml new file mode 100644 index 000000000..fb2f9dcd4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/empty_json_object.yml @@ -0,0 +1,18 @@ +description: |- + The response is an empty JSON object. + +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: {} + example: {} + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment.yml new file mode 100644 index 000000000..0e68f4f97 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment.yml @@ -0,0 +1,35 @@ +description: |- + The response will be a JSON object with details about the partner attachment + including attached VPC network IDs and BGP configuration information + +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: + partner_attachment: + $ref: '../models/partner_attachment.yml#/partner_attachment' + example: + partner_attachment: + id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + name: env.prod-partner-network-connect + state: CREATED + created_at: '2025-03-27T13:03:53Z' + connection_bandwidth_in_mbps: 1000 + region: NYC + naas_provider: MEGAPORT + vpc_ids: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + bgp: + local_asn: 65000 + local_router_ip: "2.2.2.2/29" + peer_asn: 65001 + peer_router_ip: "3.3.3.3/29" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_bgp_auth_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_bgp_auth_key.yml new file mode 100644 index 000000000..5a22f99e2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_bgp_auth_key.yml @@ -0,0 +1,25 @@ +description: |- + The response will be a JSON object with a `bgp_auth_key` object containing a + `value` field with the BGP auth key value + +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: + bgp_auth_key: + type: object + items: + $ref: '../models/service_key.yml#/partner_attachment_service_key' + example: + bgp_auth_key: + value: secret \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_deleting.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_deleting.yml new file mode 100644 index 000000000..f1b28e37f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_deleting.yml @@ -0,0 +1,35 @@ +description: |- + The response will be a JSON object with details about the partner attachment + and `"state": "DELETING"` to indicate that the partner attachment is being deleted. + +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: + partner_attachment: + $ref: '../models/partner_attachment.yml#/partner_attachment' + example: + partner_attachment: + id: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + name: env.prod-partner-network-connect + state: DELETING + created_at: '2025-03-27T13:03:53Z' + connection_bandwidth_in_mbps: 1000 + region: NYC + naas_provider: MEGAPORT + vpc_ids: ["796c6fe3-2a1d-4da2-9f3e-38239827dc91"] + bgp: + local_asn: 65000 + local_router_ip: "2.2.2.2/29" + peer_asn: 65001 + peer_router_ip: "3.3.3.3/29" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_service_key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_service_key.yml new file mode 100644 index 000000000..0e6f94380 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/partner_network_connect/responses/single_partner_attachment_service_key.yml @@ -0,0 +1,27 @@ +description: |- + The response will be a JSON object with a `service_key` object containing + the service key value and creation information + +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: + service_key: + type: object + items: + $ref: '../models/service_key.yml#/partner_attachment_service_key' + example: + service_key: + created_at: '2020-03-13T19:20:47.442049222Z' + value: 5a4981aa-9653-4bd1-bef5-d6bff52042e4 + state: 'CREATED' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/models/project_assignment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/models/project_assignment.yml index 72a64c1a7..8b8158238 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/models/project_assignment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/models/project_assignment.yml @@ -7,4 +7,4 @@ properties: $ref: '../../../shared/attributes/urn.yml' example: - do:droplet:13457723 - description: A list of uniform resource names (URNs) to be added to a project. \ No newline at end of file + description: A list of uniform resource names (URNs) to be added to a project. Only resources that you are authorized to see will be returned. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml index 32c815292..ca4e18bff 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml @@ -2,8 +2,10 @@ operationId: projects_assign_resources summary: Assign Resources to a Project -description: To assign resources to a project, send a POST request to - `/v2/projects/$PROJECT_ID/resources`. +description: | + To assign resources to a project, send a POST request to `/v2/projects/$PROJECT_ID/resources`. + + You must have both `project:update` and `:read` scopes to assign new resources. For example, to assign a Droplet to a project, include both the `project:update` and `droplet:read` scopes. tags: - Project Resources diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml index ee556a8f3..be561d309 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml @@ -2,8 +2,10 @@ operationId: projects_assign_resources_default summary: Assign Resources to Default Project -description: To assign resources to your default project, send a POST request to - `/v2/projects/default/resources`. +description: | + To assign resources to your default project, send a POST request to `/v2/projects/default/resources`. + + You must have both project:update and :read scopes to assign new resources. For example, to assign a Droplet to the default project, include both the `project:update` and `droplet:read` scopes. tags: - Project Resources diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml index 8a988617a..4b0093ae2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml @@ -2,8 +2,10 @@ operationId: projects_list_resources summary: List Project Resources -description: To list all your resources in a project, send a GET request to - `/v2/projects/$PROJECT_ID/resources`. +description: | + To list all your resources in a project, send a GET request to `/v2/projects/$PROJECT_ID/resources`. + + This endpoint will only return resources that you are authorized to see. For example, to see Droplets in a project, include the `droplet:read` scope. tags: - Project Resources diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml index 7fc823f5c..8480d0de8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml @@ -2,8 +2,10 @@ operationId: projects_list_resources_default summary: List Default Project Resources -description: To list all your resources in your default project, send a GET - request to `/v2/projects/default/resources`. +description: | + To list all your resources in your default project, send a GET request to `/v2/projects/default/resources`. + + Only resources that you are authorized to see will be returned. For example, to see Droplets in a project, include the `droplet:read` scope. tags: - Project Resources diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/assigned_resources_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/assigned_resources_list.yml index 74cbba20d..564693cd4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/assigned_resources_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/assigned_resources_list.yml @@ -1,6 +1,9 @@ -description: The response will be a JSON object with a key called `resources`. +description: | + The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. + Only resources that you are authorized to see will be returned. + headers: ratelimit-limit: $ref: '../../../shared/headers.yml#/ratelimit-limit' @@ -15,6 +18,7 @@ content: type: object properties: resources: + description: All resources, including the ones added in the request, that are assigned to the project. Only resources that you are authorized to see will be returned. type: array items: $ref: '../models/resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/resources_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/resources_list.yml index f1fcff989..9f5535bb1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/resources_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/responses/resources_list.yml @@ -1,6 +1,9 @@ -description: The response will be a JSON object with a key called `resources`. +description: | + The response will be a JSON object with a key called `resources`. The value of this will be an object with the standard resource attributes. + Only resources that you are authorized to see will be returned. + headers: ratelimit-limit: $ref: '../../../shared/headers.yml#/ratelimit-limit' @@ -16,6 +19,7 @@ content: - type: object properties: resources: + description: The resources that are assigned to this project. Only resources that you are authorized to see will be returned. type: array items: $ref: '../models/resource.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/models/region.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/models/region.yml index b80e3c21d..a16baf694 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/models/region.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/models/region.yml @@ -14,6 +14,7 @@ properties: example: nyc3 features: + type: array items: type: string description: This attribute is set to an array which contains features available @@ -34,10 +35,11 @@ properties: example: true sizes: + type: array items: type: string description: This attribute is set to an array which contains the identifying - slugs for the sizes available in this region. + slugs for the sizes available in this region. sizes:read is required to view. example: - s-1vcpu-1gb - s-1vcpu-2gb diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/all_registries_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/all_registries_get.yml new file mode 100644 index 000000000..d89e3841b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/all_registries_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/registries" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_create.yml new file mode 100644 index 000000000..a2ac80efb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_create.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "example", "subscription_tier_slug": "basic", "region": "fra1"}' \ + "https://api.digitalocean.com/v2/registries" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete.yml new file mode 100644 index 000000000..11348af1d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete.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/registries/example" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repository.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repository.yml new file mode 100644 index 000000000..3e9026f5a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repository.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/registries/example/repositories/repo-1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryManifest.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryManifest.yml new file mode 100644 index 000000000..09e782c0a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryManifest.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/registries/example/repositories/repo-1/digests/sha256:cb8a924afdf0229ef7515d9e5b3024e23b3eb03ddbba287f4a19c6ac90b8d221" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryTag.yml new file mode 100644 index 000000000..f06fd64db --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_delete_repositoryTag.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/registries/example/repositories/repo-1/tags/mytag" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get.yml new file mode 100644 index 000000000..b9e77eace --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_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/registries/example" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_all.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_all.yml new file mode 100644 index 000000000..d89e3841b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_all.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/registries" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_dockerCredentials.yml new file mode 100644 index 000000000..53767ec88 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_dockerCredentials.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/registries/example/docker-credentials" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_garbageCollection.yml new file mode 100644 index 000000000..2476a55f5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_garbageCollection.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/registries/example/garbage-collection" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_options.yml new file mode 100644 index 000000000..72c2b9e33 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_options.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/registries/options" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_subscription.yml new file mode 100644 index 000000000..8d85228b8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_get_subscription.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/registries/subscription" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_garbageCollections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_garbageCollections.yml new file mode 100644 index 000000000..5f8f9529e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_garbageCollections.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/registries/example/garbage-collections" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2.yml new file mode 100644 index 000000000..b72b2fbe2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2.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/registries/example/repositoriesV2?page_size=1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2_next_page.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2_next_page.yml new file mode 100644 index 000000000..444dd4d77 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoriesV2_next_page.yml @@ -0,0 +1,6 @@ +lang: cURL (next page) +source: |- + curl -X GET \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/registries/example/repositoriesV2?page=2&page_token=JPZmZzZXQiOjB9&per_page=1" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryManifests.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryManifests.yml new file mode 100644 index 000000000..700cd1c20 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryManifests.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/registries/example/repositories/repo-1/digests" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryTags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryTags.yml new file mode 100644 index 000000000..2ef639296 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_list_repositoryTags.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/registries/example/repositories/repo-1/tags" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_run_garbageCollection.yml new file mode 100644 index 000000000..e98bf7ba8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_run_garbageCollection.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/registries/example/garbage-collection" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_garbageCollection.yml new file mode 100644 index 000000000..d99ba864b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_garbageCollection.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/registries/example/garbage-collection/example-gc-uuid" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_subscription.yml new file mode 100644 index 000000000..f96cf1900 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_update_subscription.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"tier_slug": "professional"}' \ + "https://api.digitalocean.com/v2/registries/subscription" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_validate_name.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_validate_name.yml new file mode 100644 index 000000000..c22e3d77e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registries_validate_name.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "example"}' \ + "https://api.digitalocean.com/v2/registries/validate-name" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registry_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registry_run_garbageCollection.yml index 5622ec46e..6c37f151d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registry_run_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/curl/registry_run_garbageCollection.yml @@ -3,4 +3,5 @@ source: |- curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{ "type": "unreferenced blobs only"}' \ "https://api.digitalocean.com/v2/registry/example/garbage-collection" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_create.yml new file mode 100644 index 000000000..f31f1c79c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_create.yml @@ -0,0 +1,14 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "name": "example", + "region": "fra1", + "subscription_tier_slug": "basic" + } + + resp = client.registries.create(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete.yml new file mode 100644 index 000000000..5bd6012a3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.delete(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repository.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repository.yml new file mode 100644 index 000000000..04efbae6c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repository.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.delete_repository(registry_name="example", repository_name="repo-1") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryManifest.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryManifest.yml new file mode 100644 index 000000000..58e6dd889 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryManifest.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.delete_repository_manifest(registry_name="example", repository_name="repo-1", manifest_digest="sha256:cb8a924afd") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryTag.yml new file mode 100644 index 000000000..1464b3342 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_delete_repositoryTag.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.delete_repository_tag(registry_name="example", repository_name="repo-1", repository_tag="06a447a") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get.yml new file mode 100644 index 000000000..18b2a25a7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.get(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_all.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_all.yml new file mode 100644 index 000000000..e95c57ba6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_all.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.get() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_dockerCredentials.yml new file mode 100644 index 000000000..9a1717826 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_dockerCredentials.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.get_docker_credentials(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_garbageCollection.yml new file mode 100644 index 000000000..46387ec56 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_garbageCollection.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.get_garbage_collection(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_options.yml new file mode 100644 index 000000000..ee3740144 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_options.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.get_options() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_subscription.yml new file mode 100644 index 000000000..e82581ab6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_get_subscription.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.get_subscription() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_garbageCollections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_garbageCollections.yml new file mode 100644 index 000000000..82ca995bd --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_garbageCollections.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.list_garbage_collections(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoriesV2.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoriesV2.yml new file mode 100644 index 000000000..545e05aea --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoriesV2.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.list_repositories_v2(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryManifests.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryManifests.yml new file mode 100644 index 000000000..c53c0c306 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryManifests.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.list_repository_manifests(registry_name="example", repository_name="repo01") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryTags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryTags.yml new file mode 100644 index 000000000..f04560a00 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_list_repositoryTags.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.list_repository_tags(registry_name="example", repository_name="repo01") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_run_garbageCollection.yml new file mode 100644 index 000000000..d698212a0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_run_garbageCollection.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.run_garbage_collection(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_garbageCollection.yml new file mode 100644 index 000000000..d698212a0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_garbageCollection.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.registries.run_garbage_collection(registry_name="example") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_subscription.yml new file mode 100644 index 000000000..0379a70a4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_update_subscription.yml @@ -0,0 +1,12 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "tier_slug": "basic" + } + + resp = client.registries.update_subscription(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_validate_name.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_validate_name.yml new file mode 100644 index 000000000..00b9aec6a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registries_validate_name.yml @@ -0,0 +1,12 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "name": "example" + } + + resp = client.registries.validate_name(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registry_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registry_run_garbageCollection.yml index a3058a363..1681fecec 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registry_run_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/examples/python/registry_run_garbageCollection.yml @@ -4,5 +4,10 @@ source: |- from pydo import Client client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "type": "unreferenced blobs only" + + } - resp = client.registry.run_garbage_collection(registry_name="example") + resp = client.registry.run_garbage_collection(registry_name="example",body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry.yml new file mode 100644 index 000000000..b9c7479c8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry.yml @@ -0,0 +1,4 @@ +type: object + +allOf: + - $ref: 'registry_base.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry_create.yml new file mode 100644 index 000000000..5168b6752 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/multiregistry_create.yml @@ -0,0 +1,38 @@ +type: object + +properties: + name: + type: string + maxLength: 63 + pattern: '^[a-z0-9-]{1,63}$' + example: example + description: A globally unique name for the container registry. Must be + lowercase and be composed only of numbers, letters and `-`, up to a limit + of 63 characters. + + subscription_tier_slug: + type: string + enum: + - starter + - basic + - professional + example: basic + description: The slug of the subscription tier to sign up for. Valid values + can be retrieved using the options endpoint. + + region: + type: string + enum: + - nyc3 + - sfo3 + - sfo2 + - ams3 + - sgp1 + - fra1 + - blr1 + - syd1 + example: fra1 + description: Slug of the region where registry data is stored. When not provided, a region will be selected. + +required: +- name diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry.yml index 931bff973..0e6f9a314 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry.yml @@ -1,44 +1,10 @@ type: object -properties: - name: - type: string - maxLength: 63 - pattern: '^[a-z0-9-]{1,63}$' - example: example - description: A globally unique name for the container registry. Must be - lowercase and be composed only of numbers, letters and `-`, up to a limit - of 63 characters. - - created_at: - type: string - format: date-time - readOnly: true - example: '2020-03-21T16:02:37Z' - description: A time value given in ISO8601 combined date and time format - that represents when the registry was created. - - region: - type: string - example: fra1 - description: Slug of the region where registry data is stored - - storage_usage_bytes: - type: integer - readOnly: true - example: 29393920 - description: The amount of storage used in the registry in bytes. - - storage_usage_bytes_updated_at: - type: string - format: date-time - readOnly: true - example: '2020-11-04T21:39:49.530562231Z' - description: The time at which the storage usage was updated. Storage usage - is calculated asynchronously, and may not immediately reflect pushes to - the registry. - - subscription: - allOf: - - readOnly: true - - $ref: 'subscription.yml' +allOf: + - $ref: 'registry_base.yml' + - type: object + properties: + subscription: + allOf: + - readOnly: true + - $ref: 'subscription.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_base.yml new file mode 100644 index 000000000..f7dd7757d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_base.yml @@ -0,0 +1,39 @@ +type: object + +properties: + name: + type: string + maxLength: 63 + pattern: '^[a-z0-9-]{1,63}$' + example: example + description: A globally unique name for the container registry. Must be + lowercase and be composed only of numbers, letters and `-`, up to a limit + of 63 characters. + + created_at: + type: string + format: date-time + readOnly: true + example: '2020-03-21T16:02:37Z' + description: A time value given in ISO8601 combined date and time format + that represents when the registry was created. + + region: + type: string + example: fra1 + description: Slug of the region where registry data is stored + + storage_usage_bytes: + type: integer + readOnly: true + example: 29393920 + description: The amount of storage used in the registry in bytes. + + storage_usage_bytes_updated_at: + type: string + format: date-time + readOnly: true + example: '2020-11-04T21:39:49.530562231Z' + description: The time at which the storage usage was updated. Storage usage + is calculated asynchronously, and may not immediately reflect pushes to + the registry. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_run_gc.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_run_gc.yml new file mode 100644 index 000000000..2f03965a8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/models/registry_run_gc.yml @@ -0,0 +1,11 @@ +type: object + +properties: + type: + type: string + enum: + - untagged manifests only + - unreferenced blobs only + - untagged manifests and unreferenced blobs + example: unreferenced blobs only + description: Type of the garbage collection to run against this registry diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_create.yml new file mode 100644 index 000000000..7e6810e8c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_create.yml @@ -0,0 +1,48 @@ +operationId: registries_create + +summary: "Create Container Registry" + +description: | + To create your container registry, send a POST request to `/v2/registries`. + + The `name` becomes part of the URL for images stored in the registry. For + example, if your registry is called `example`, an image in it will have the + URL `registry.digitalocean.com/example/image:tag`. + +tags: + - Container Registries + +requestBody: + required: true + + content: + application/json: + schema: + $ref: 'models/multiregistry_create.yml' + +responses: + '201': + $ref: 'responses/multiregistry_info.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/registries_create.yml' + - $ref: 'examples/python/registries_create.yml' + +security: + - bearer_auth: + - 'registry:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete.yml new file mode 100644 index 000000000..7a788f6ca --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete.yml @@ -0,0 +1,39 @@ +operationId: registries_delete + +summary: "Delete Container Registry By Name" + +description: To delete your container registry, destroying all container image + data stored in it, send a DELETE request to `/v2/registries/{registry_name}`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + +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/registries_delete.yml' + - $ref: 'examples/python/registries_delete.yml' + +security: + - bearer_auth: + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repository.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repository.yml new file mode 100644 index 000000000..d9f1057f7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repository.yml @@ -0,0 +1,44 @@ +operationId: registries_delete_repository + +summary: "Delete Container Registry Repository" + +description: | + To delete a container repository including all of its tags, send a DELETE request to + `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME`. + + A successful request will receive a 204 status code with no body in response. + This indicates that the request was processed successfully. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + - $ref: 'parameters.yml#/registry_repository_name' + +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/registries_delete_repository.yml' + - $ref: 'examples/python/registries_delete_repository.yml' + +security: + - bearer_auth: + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryManifest.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryManifest.yml new file mode 100644 index 000000000..521523ffb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryManifest.yml @@ -0,0 +1,52 @@ +operationId: registries_delete_repositoryManifest + +summary: "Delete Container Registry Repository Manifest" + +description: | + To delete a container repository manifest by digest in one of your registries, send a DELETE request to + `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. + + Note that if your repository name contains `/` characters, it must be + URL-encoded in the request URL. For example, to delete + `registry.digitalocean.com/example/my/repo@sha256:abcd`, the path would be + `/v2/registry/example/repositories/my%2Frepo/digests/sha256:abcd`. + + A successful request will receive a 204 status code with no body in response. + This indicates that the request was processed successfully. + + It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + - $ref: 'parameters.yml#/registry_repository_name' + - $ref: 'parameters.yml#/registry_manifest_digest' + +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/registries_delete_repositoryManifest.yml' + - $ref: 'examples/python/registries_delete_repositoryManifest.yml' + +security: + - bearer_auth: + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryTag.yml new file mode 100644 index 000000000..0a05c263e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_delete_repositoryTag.yml @@ -0,0 +1,50 @@ +operationId: registries_delete_repositoryTag + +summary: "Delete Container Registry Repository Tag" + +description: | + To delete a container repository tag in on of our container registries, send a DELETE request to + `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. + + Note that if your repository name contains `/` characters, it must be + URL-encoded in the request URL. For example, to delete + `registry.digitalocean.com/example/my/repo:mytag`, the path would be + `/v2/registry/example/repositories/my%2Frepo/tags/mytag`. + + A successful request will receive a 204 status code with no body in response. + This indicates that the request was processed successfully. It is similar to DELETE `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + - $ref: 'parameters.yml#/registry_repository_name' + - $ref: 'parameters.yml#/registry_repository_tag' + +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/registries_delete_repositoryTag.yml' + - $ref: 'examples/python/registries_delete_repositoryTag.yml' + +security: + - bearer_auth: + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get.yml new file mode 100644 index 000000000..41d9264e5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get.yml @@ -0,0 +1,39 @@ +operationId: registries_get + +summary: "Get a Container Registry By Name" + +description: To get information about any container registry in your account, send a GET + request to `/v2/registries/{registry_name}`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + +responses: + '200': + $ref: 'responses/multiregistry_info.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/registries_get.yml' + - $ref: 'examples/python/registries_get.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_all.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_all.yml new file mode 100644 index 000000000..f581727ee --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_all.yml @@ -0,0 +1,33 @@ +operationId: registries_list + +summary: "List All Container Registries" + +description: To get information about any container registry in your account, send a GET + request to `/v2/registries/`. + +tags: + - Container Registries + +responses: + '200': + $ref: 'responses/all_registries_info.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/registries_get_all.yml' + - $ref: 'examples/python/registries_get_all.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_dockerCredentials.yml new file mode 100644 index 000000000..e98b86ff5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_dockerCredentials.yml @@ -0,0 +1,61 @@ +operationId: registries_get_dockerCredentials + +summary: "Get Docker Credentials By Registry Name" + +description: | + In order to access your container registry with the Docker client or from a + Kubernetes cluster, you will need to configure authentication. The necessary + JSON configuration can be retrieved by sending a GET request to + `/v2/registries/{registry_name}/docker-credentials`. + + The response will be in the format of a Docker `config.json` file. To use the + config in your Kubernetes cluster, create a Secret with: + + kubectl create secret generic docr \ + --from-file=.dockerconfigjson=config.json \ + --type=kubernetes.io/dockerconfigjson + + By default, the returned credentials have read-only access to your registry + and cannot be used to push images. This is appropriate for most Kubernetes + clusters. To retrieve read/write credentials, suitable for use with the Docker + client or in a CI system, read_write may be provided as query parameter. For + example: `/v2/registries/{registry_name}/docker-credentials?read_write=true` + + By default, the returned credentials will not expire. To retrieve credentials + with an expiry set, expiry_seconds may be provided as a query parameter. For + example: `/v2/registries/{registry_name}/docker-credentials?expiry_seconds=3600` will return + credentials that expire after one hour. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + +responses: + '200': + $ref: 'responses/docker_credentials.yml' + + '404': + $ref: '../../shared/responses/not_found.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/registries_get_dockerCredentials.yml' + - $ref: 'examples/python/registries_get_dockerCredentials.yml' + +security: + - bearer_auth: + - 'registry:read' + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_garbageCollection.yml new file mode 100644 index 000000000..99af3cb95 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_garbageCollection.yml @@ -0,0 +1,39 @@ +operationId: registries_get_garbageCollection + +summary: "Get Active Garbage Collection" + +description: To get information about the currently-active garbage collection + for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + +responses: + '200': + $ref: 'responses/garbage_collection.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/registries_get_garbageCollection.yml' + - $ref: 'examples/python/registries_get_garbageCollection.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_options.yml new file mode 100644 index 000000000..81c86cbc1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_options.yml @@ -0,0 +1,44 @@ +operationId: registries_get_options + +summary: "List Registry Options (Subscription Tiers and Available Regions)" + +description: >- + This endpoint serves to provide additional information as to which option values + are available when creating a container registry. + + There are multiple subscription tiers available for container registry. Each + tier allows a different number of image repositories to be created in your + registry, and has a different amount of storage and transfer included. + + There are multiple regions available for container registry and controls + where your data is stored. + + To list the available options, send a GET request to + `/v2/registries/options`. This is similar to GET `/v2/registry/options`. + +tags: + - Container Registries + +responses: + '200': + $ref: 'responses/registry_options_response.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/registries_get_options.yml' + - $ref: 'examples/python/registries_get_options.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_subscription.yml new file mode 100644 index 000000000..368434081 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_get_subscription.yml @@ -0,0 +1,34 @@ +operationId: registries_get_subscription + +summary: "Get Subscription Information" + +description: A subscription is automatically created when you configure your + container registry. To get information about your subscription, send a GET + request to `/v2/registries/subscription`. It is similar to GET `/v2/registry/subscription`. + +tags: + - Container Registries + +responses: + '200': + $ref: 'responses/subscription_response.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/registries_get_subscription.yml' + - $ref: 'examples/python/registries_get_subscription.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_garbageCollections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_garbageCollections.yml new file mode 100644 index 000000000..e38561dc7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_garbageCollections.yml @@ -0,0 +1,41 @@ +operationId: registries_list_garbageCollections + +summary: "List Garbage Collections" + +description: To get information about past garbage collections for a registry, + send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/garbage_collections.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/registries_list_garbageCollections.yml' + - $ref: 'examples/python/registries_list_garbageCollections.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoriesV2.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoriesV2.yml new file mode 100644 index 000000000..14591f359 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoriesV2.yml @@ -0,0 +1,46 @@ +operationId: registries_list_repositoriesV2 + +summary: "List All Container Registry Repositories (V2)" + +description: To list all repositories in your container registry, send a GET + request to `/v2/registries/$REGISTRY_NAME/repositoriesV2`. It is similar to GET `/v2/registry/$REGISTRY_NAME/repositoriesV2`. + +tags: + - Container Registries + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: 'parameters.yml#/token_pagination_page' + - $ref: 'parameters.yml#/token_pagination_page_token' + - $ref: 'parameters.yml#/registry_name' + +responses: + '200': + $ref: 'responses/all_repositories_v2.yml' + + '400': + $ref: '../../shared/responses/bad_request.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/registries_list_repositoriesV2.yml' + - $ref: 'examples/curl/registries_list_repositoriesV2_next_page.yml' + - $ref: 'examples/python/registries_list_repositoriesV2.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryManifests.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryManifests.yml new file mode 100644 index 000000000..31c815498 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryManifests.yml @@ -0,0 +1,49 @@ +operationId: registries_list_repositoryManifests + +summary: "List All Container Registry Repository Manifests" + +description: | + To list all manifests in your container registry repository, send a GET + request to `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. + + Note that if your repository name contains `/` characters, it must be + URL-encoded in the request URL. For example, to list manifests for + `registry.digitalocean.com/example/my/repo`, the path would be + `/v2/registry/example/repositories/my%2Frepo/digests`. + + It is similar to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. +tags: + - Container Registries + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: 'parameters.yml#/registry_name' + - $ref: 'parameters.yml#/registry_repository_name' + +responses: + '200': + $ref: 'responses/repository_manifests.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/registries_list_repositoryManifests.yml' + - $ref: 'examples/python/registries_list_repositoryManifests.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryTags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryTags.yml new file mode 100644 index 000000000..68a22a7fe --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_list_repositoryTags.yml @@ -0,0 +1,50 @@ +operationId: registries_list_repositoryTags + +summary: "List All Container Registry Repository Tags" + +description: | + To list all tags in one of your container registry's repository, send a GET + request to `/v2/registries/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. + + Note that if your repository name contains `/` characters, it must be + URL-encoded in the request URL. For example, to list tags for + `registry.digitalocean.com/example/my/repo`, the path would be + `/v2/registry/example/repositories/my%2Frepo/tags`. + + It is similar to GET `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. + +tags: + - Container Registries + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: 'parameters.yml#/registry_name' + - $ref: 'parameters.yml#/registry_repository_name' + +responses: + '200': + $ref: 'responses/repository_tags.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/registries_list_repositoryTags.yml' + - $ref: 'examples/python/registries_list_repositoryTags.yml' + +security: + - bearer_auth: + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_run_garbageCollection.yml new file mode 100644 index 000000000..7c48db31e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_run_garbageCollection.yml @@ -0,0 +1,59 @@ +operationId: registries_run_garbageCollection + +summary: "Start Garbage Collection" + +description: | + Garbage collection enables users to clear out unreferenced blobs (layer & + 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://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 + `/v2/registries/$REGISTRY_NAME/garbage-collection`. This will initiate the + following sequence of events on your registry. + + * Set the registry to read-only mode, meaning no further write-scoped + JWTs will be issued to registry clients. Existing write-scoped JWTs will + continue to work until they expire which can take up to 15 minutes. + * Wait until all existing write-scoped JWTs have expired. + * Scan all registry manifests to determine which blobs are unreferenced. + * Delete all unreferenced blobs from the registry. + * Record the number of blobs deleted and bytes freed, mark the garbage + collection status as `success`. + * Remove the read-only mode restriction from the registry, meaning write-scoped + JWTs will once again be issued to registry clients. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + +responses: + '201': + $ref: 'responses/garbage_collection.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/registries_run_garbageCollection.yml' + - $ref: 'examples/python/registries_run_garbageCollection.yml' + +security: + - bearer_auth: + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_garbageCollection.yml new file mode 100644 index 000000000..950ef97ac --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_garbageCollection.yml @@ -0,0 +1,49 @@ +operationId: registries_update_garbageCollection + +summary: "Update Garbage Collection" + +description: To cancel the currently-active garbage collection for a registry, + send a PUT request to `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID` + and specify one or more of the attributes below. It is similar to PUT `/v2/registries/$REGISTRY_NAME/garbage-collection/$GC_UUID`. + +tags: + - Container Registries + +parameters: + - $ref: 'parameters.yml#/registry_name' + - $ref: 'parameters.yml#/garbage_collection_uuid' + +requestBody: + required: true + + content: + application/json: + schema: + $ref: 'models/update_registry.yml' + +responses: + '200': + $ref: 'responses/garbage_collection.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/registries_update_garbageCollection.yml' + - $ref: 'examples/python/registries_update_garbageCollection.yml' + +security: + - bearer_auth: + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_subscription.yml new file mode 100644 index 000000000..75c7dcec3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_update_subscription.yml @@ -0,0 +1,49 @@ +operationId: registries_update_subscription + +summary: "Update Subscription Tier" + +description: After creating your registry, you can switch to a different + subscription tier to better suit your needs. To do this, send a POST request + to `/v2/registries/subscription`. It is similar to POST `/v2/registry/subscription`. + +tags: + - Container Registries + +requestBody: + content: + application/json: + schema: + type: object + properties: + tier_slug: + type: string + enum: + - starter + - basic + - professional + example: basic + description: The slug of the subscription tier to sign up for. + +responses: + '200': + $ref: 'responses/subscription_response.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/registries_update_subscription.yml' + - $ref: 'examples/python/registries_update_subscription.yml' + +security: + - bearer_auth: + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_validate_name.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_validate_name.yml new file mode 100644 index 000000000..5d3b12527 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registries_validate_name.yml @@ -0,0 +1,51 @@ +operationId: registries_validate_name + +summary: "Validate a Container Registry Name" + +description: | + To validate that a container registry name is available for use, send a POST + request to `/v2/registries/validate-name`. + + If the name is both formatted correctly and available, the response code will + be 204 and contain no body. If the name is already in use, the response will + be a 409 Conflict. + + It is similar to `/v2/registry/validate-name`. + +tags: + - Container Registries + +requestBody: + required: true + + content: + application/json: + schema: + $ref: 'models/validate_registry.yml' + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '409': + $ref: '../../shared/responses/conflict.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/registries_validate_name.yml' + - $ref: 'examples/python/registries_validate_name.yml' + +security: + - bearer_auth: + - 'registry:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml index f7477b8cb..3bb613865 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml @@ -1,8 +1,11 @@ operationId: registry_create -summary: Create Container Registry +deprecated: true +summary: 'Create Container Registry' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To create your container registry, send a POST request to `/v2/registry`. The `name` becomes part of the URL for images stored in the registry. For diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml index fc28fe2ec..594c9db62 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml @@ -1,9 +1,15 @@ operationId: registry_delete -summary: Delete Container Registry +deprecated: true -description: To delete your container registry, destroying all container image +summary: 'Delete Container Registry' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To delete your container registry, destroying all container image data stored in it, send a DELETE request to `/v2/registry`. + + This operation is not compatible with multiple registries in a DO account. You should use `/v2/registries/{registry_name}` instead. tags: - Container Registry @@ -14,6 +20,9 @@ responses: '401': $ref: '../../shared/responses/unauthorized.yml' + + '412': + $ref: './responses/registries_precondition_fail.yml' '404': $ref: '../../shared/responses/not_found.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml index d6078ead8..da0362354 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml @@ -1,8 +1,11 @@ operationId: registry_delete_repositoryManifest -summary: Delete Container Registry Repository Manifest +deprecated: true +summary: 'Delete Container Registry Repository Manifest' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To delete a container repository manifest by digest, send a DELETE request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests/$MANIFEST_DIGEST`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml index 3fbf68156..b4841b0f5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml @@ -1,8 +1,11 @@ operationId: registry_delete_repositoryTag -summary: Delete Container Registry Repository Tag +deprecated: true +summary: 'Delete Container Registry Repository Tag' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To delete a container repository tag, send a DELETE request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags/$TAG`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml index 412da9e94..eb64c2d5b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml @@ -1,9 +1,15 @@ operationId: registry_get -summary: Get Container Registry Information +deprecated: true -description: To get information about your container registry, send a GET +summary: 'Get Container Registry Information' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To get information about your container registry, send a GET request to `/v2/registry`. + + This operation is not compatible with multiple registries in a DO account. You should use `/v2/registries/{registry_name}` instead. tags: - Container Registry @@ -14,6 +20,9 @@ responses: '401': $ref: '../../shared/responses/unauthorized.yml' + + '412': + $ref: './responses/registries_precondition_fail.yml' '429': $ref: '../../shared/responses/too_many_requests.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml index a5e3d778d..46e4e5114 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml @@ -1,8 +1,11 @@ operationId: registry_get_dockerCredentials -summary: Get Docker Credentials for Container Registry +deprecated: true +summary: 'Get Docker Credentials for Container Registry' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + In order to access your container registry with the Docker client or from a Kubernetes cluster, you will need to configure authentication. The necessary JSON configuration can be retrieved by sending a GET request to diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml index fce654c18..2f69c9cb5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml @@ -1,8 +1,12 @@ operationId: registry_get_garbageCollection -summary: Get Active Garbage Collection +deprecated: true -description: To get information about the currently-active garbage collection +summary: 'Get Active Garbage Collection' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To get information about the currently-active garbage collection for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collection`. tags: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml index 306b82146..d398a09b2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml @@ -1,8 +1,11 @@ operationId: registry_get_options -summary: List Registry Options (Subscription Tiers and Available Regions) +deprecated: true + +summary: 'List Registry Options (Subscription Tiers and Available Regions)' +description: | + **Note: This endpoint is deprecated and may be removed in a future version. There is no alternative.****Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** -description: >- This endpoint serves to provide additional information as to which option values are available when creating a container registry. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml index c0ecae454..c721fc991 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml @@ -1,8 +1,12 @@ operationId: registry_get_subscription -summary: Get Subscription Information +deprecated: true -description: A subscription is automatically created when you configure your +summary: 'Get Subscription' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + A subscription is automatically created when you configure your container registry. To get information about your subscription, send a GET request to `/v2/registry/subscription`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml index 69ffe66fb..34065e8a7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml @@ -1,8 +1,12 @@ operationId: registry_list_garbageCollections -summary: List Garbage Collections +deprecated: true -description: To get information about past garbage collections for a registry, +summary: 'List Garbage Collections' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To get information about past garbage collections for a registry, send a GET request to `/v2/registry/$REGISTRY_NAME/garbage-collections`. tags: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml index f47013883..8c2c4e1df 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml @@ -2,9 +2,10 @@ operationId: registry_list_repositories deprecated: true -summary: List All Container Registry Repositories - +summary: 'List All Container Registry Repositories' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + This endpoint has been deprecated in favor of the _List All Container Registry Repositories [V2]_ endpoint. To list all repositories in your container registry, send a GET diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml index 81ebb19b7..524078654 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml @@ -1,8 +1,12 @@ operationId: registry_list_repositoriesV2 -summary: List All Container Registry Repositories (V2) +deprecated: true -description: To list all repositories in your container registry, send a GET +summary: 'List All Container Registry Repositories (V2)' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To list all repositories in your container registry, send a GET request to `/v2/registry/$REGISTRY_NAME/repositoriesV2`. tags: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml index 909a50b83..ccfdc8a7c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml @@ -1,8 +1,11 @@ operationId: registry_list_repositoryManifests -summary: List All Container Registry Repository Manifests +deprecated: true +summary: 'List All Container Registry Repository Manifests' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To list all manifests in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/digests`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml index 70d0276ff..99f875d57 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml @@ -1,8 +1,11 @@ operationId: registry_list_repositoryTags -summary: List All Container Registry Repository Tags +deprecated: true +summary: 'List All Container Registry Repository Tags' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To list all tags in your container registry repository, send a GET request to `/v2/registry/$REGISTRY_NAME/repositories/$REPOSITORY_NAME/tags`. 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 2303af381..22bcfe0fc 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 @@ -1,8 +1,11 @@ operationId: registry_run_garbageCollection -summary: Start Garbage Collection +deprecated: true +summary: 'Start Garbage Collection' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + Garbage collection enables users to clear out unreferenced blobs (layer & 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 @@ -28,6 +31,14 @@ description: | tags: - Container Registry +requestBody: + required: false + + content: + application/json: + schema: + $ref: 'models/registry_run_gc.yml' + parameters: - $ref: 'parameters.yml#/registry_name' @@ -56,4 +67,4 @@ x-codeSamples: security: - bearer_auth: - - 'registry:create' + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml index 9de2dcd5e..448c4ddc1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml @@ -1,8 +1,12 @@ operationId: registry_update_garbageCollection -summary: Update Garbage Collection +deprecated: true -description: To cancel the currently-active garbage collection for a registry, +summary: 'Update Garbage Collection' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + To cancel the currently-active garbage collection for a registry, send a PUT request to `/v2/registry/$REGISTRY_NAME/garbage-collection/$GC_UUID` and specify one or more of the attributes below. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml index 66f902247..199c92ae6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml @@ -1,8 +1,12 @@ operationId: registry_update_subscription -summary: Update Subscription Tier +deprecated: true -description: After creating your registry, you can switch to a different +summary: 'Update Subscription Tier' +description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + + After creating your registry, you can switch to a different subscription tier to better suit your needs. To do this, send a POST request to `/v2/registry/subscription`. @@ -30,6 +34,9 @@ responses: '401': $ref: '../../shared/responses/unauthorized.yml' + + '412': + $ref: './responses/registries_over_limit.yml' '429': $ref: '../../shared/responses/too_many_requests.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml index 1384aef0c..415d04359 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml @@ -1,8 +1,11 @@ operationId: registry_validate_name -summary: Validate a Container Registry Name +deprecated: true +summary: 'Validate a Container Registry Name' description: | + **Note: This endpoint is deprecated. Please use the `/v2/registries` endpoint instead.** + To validate that a container registry name is available for use, send a POST request to `/v2/registry/validate-name`. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/all_registries_info.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/all_registries_info.yml new file mode 100644 index 000000000..27b1923c7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/all_registries_info.yml @@ -0,0 +1,20 @@ +description: The response will be a JSON object with the key `registry` + containing information about your registry. + +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: + registries: + type: array + items: + oneOf: + - $ref: '../models/registry.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/multiregistry_info.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/multiregistry_info.yml new file mode 100644 index 000000000..a2bba4c05 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/multiregistry_info.yml @@ -0,0 +1,17 @@ +description: The response will be a JSON object with the key `registry` + containing information about your registry. + +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: + registry: + $ref: '../models/multiregistry.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_over_limit.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_over_limit.yml new file mode 100644 index 000000000..9744d7015 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_over_limit.yml @@ -0,0 +1,17 @@ +description: There are more than one registries in the DO account. + +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: + $ref: '../../../shared/models/error.yml' + example: + id: precondition_failed + message: "registry is not eligible for tier because: [OverRegistryLimit]" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_precondition_fail.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_precondition_fail.yml new file mode 100644 index 000000000..3e770d4b9 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/responses/registries_precondition_fail.yml @@ -0,0 +1,20 @@ +description: There are more than one registries in the DO account. + +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: + $ref: '../../../shared/models/error.yml' + example: + id: precondition_failed + message: |- + This API is not supported if you have created multiple registries. Please use + ‘/v2/registries/{registry_name}’ instead. Refer to + https://docs.digitalocean.com/reference/api/digitalocean/#tag/Container-Registry for more info. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/models/reserved_ip.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/models/reserved_ip.yml index e1b17423d..030083e43 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/models/reserved_ip.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/models/reserved_ip.yml @@ -19,7 +19,7 @@ properties: description: The Droplet that the reserved IP has been assigned to. When you query a reserved IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will - be null. + be null.

Requires `droplet:read` scope. anyOf: - title: 'null' type: object @@ -39,4 +39,5 @@ properties: type: string format: uuid example: 746c6152-2fa2-11ed-92d3-27aaa54e4988 - description: The UUID of the project to which the reserved IP currently belongs. + description: The UUID of the project to which the reserved IP currently belongs.

Requires `project:read` scope. + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml index 548bfe372..f653e6a51 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml @@ -12,9 +12,6 @@ description: >- * To create a new reserved IP reserved to a region, send a POST request to `/v2/reserved_ips` with the `region` attribute. - **Note**: In addition to the standard rate limiting, only 12 reserved IPs may - be created per 60 seconds. - tags: - Reserved IPs diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/create_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/create_reserved_ipv6.yml new file mode 100644 index 000000000..cb943feda --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/create_reserved_ipv6.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"region_slug": "nyc3"}' \ + "https://api.digitalocean.com/v2/reserved_ipv6" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/delete_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/delete_reserved_ipv6.yml new file mode 100644 index 000000000..7dfcfa877 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/delete_reserved_ipv6.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/reserved_ipv6/2409:40d0:f7:1017:74b4:3a96:105e:4c6e" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/get_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/get_reserved_ipv6.yml new file mode 100644 index 000000000..93ca1db7e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/get_reserved_ipv6.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/reserved_ipv6/2409:40d0:f7:1017:74b4:3a96:105e:4c6e" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/list_reserved_ipv6s.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/list_reserved_ipv6s.yml new file mode 100644 index 000000000..280846c2b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/list_reserved_ipv6s.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/reserved_ipv6?page=1&per_page=20" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/post_reserved_ipv6_action.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/post_reserved_ipv6_action.yml new file mode 100644 index 000000000..a5cbd5ebb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/curl/post_reserved_ipv6_action.yml @@ -0,0 +1,15 @@ +lang: cURL +source: |- + # Assign a Reserved IPv6 to a Droplet + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"type":"assign","droplet_id":8219222}' \ + "https://api.digitalocean.com/v2/reserved_ipv6/2409:40d0:f7:1017:74b4:3a96:105e:4c6e/actions" + + # Unassign a Reserved IPv6 from a Droplet + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"type":"unassign"}' \ + "https://api.digitalocean.com/v2/reserved_ipv6/2409:40d0:f7:1017:74b4:3a96:105e:4c6e/actions" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/create_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/create_reserved_ipv6.yml new file mode 100644 index 000000000..d999bf1f6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/create_reserved_ipv6.yml @@ -0,0 +1,21 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + createRequest := &godo.ReservedIPV6CreateRequest{ + RegionSlug: "nyc3", + } + + reservedIPV6, _, err := client.ReservedIPV6s.Create(ctx, createRequest) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/delete_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/delete_reserved_ipv6.yml new file mode 100644 index 000000000..54dbe7c07 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/delete_reserved_ipv6.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + _, err := client.ReservedIPV6s.Delete(ctx, "2409:40d0:f7:1017:74b4:3a96:105e:4c6e") + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/get_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/get_reserved_ipv6.yml new file mode 100644 index 000000000..712b158f5 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/get_reserved_ipv6.yml @@ -0,0 +1,17 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + reservedIP, _, err := client.ReservedIPV6s.Get(ctx, "2409:40d0:f7:1017:74b4:3a96:105e:4c6e") + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/list_reserved_ipv6s.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/list_reserved_ipv6s.yml new file mode 100644 index 000000000..14477125a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/list_reserved_ipv6s.yml @@ -0,0 +1,22 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + opt := &godo.ListOptions{ + Page: 1, + PerPage: 200, + } + + reservedIPs, _, err := client.ReservedIPV6s.List(ctx, opt) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/post_reserved_ipv6_action.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/post_reserved_ipv6_action.yml new file mode 100644 index 000000000..de0a4d0b2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/go/post_reserved_ipv6_action.yml @@ -0,0 +1,21 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + // Assign a Reserved IPv6 to a Droplet + action, _, err := client.ReservedIPV6Actions.Assign(ctx, "2409:40d0:f7:1017:74b4:3a96:105e:4c6e", 8219222) + + // Unassign a Reserved IPv6 + action, _, err := client.ReservedIPV6Actions.Unassign(ctx, "2409:40d0:f7:1017:74b4:3a96:105e:4c6e") + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/create_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/create_reserved_ipv6.yml new file mode 100644 index 000000000..b88fc7889 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/create_reserved_ipv6.yml @@ -0,0 +1,12 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req = { + "region_slug": nyc3 + } + + resp = client.reserved_ipv6s.create(body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/delete_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/delete_reserved_ipv6.yml new file mode 100644 index 000000000..3288d8986 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/delete_reserved_ipv6.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.reserved_ipv6s.delete(reserved_ipv6="2409:40d0:f7:1017:74b4:3a96:105e:4c6e") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/get_reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/get_reserved_ipv6.yml new file mode 100644 index 000000000..8e4020983 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/get_reserved_ipv6.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.reserved_ipv6s.get(reserved_ipv6="2409:40d0:f7:1017:74b4:3a96:105e:4c6e") diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/list_reserved_ipv6s.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/list_reserved_ipv6s.yml new file mode 100644 index 000000000..dfaeca2a0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/list_reserved_ipv6s.yml @@ -0,0 +1,8 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + resp = client.reserved_ipv6s.list() diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/post_reserved_ipv6_action.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/post_reserved_ipv6_action.yml new file mode 100644 index 000000000..a09d3b410 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/examples/python/post_reserved_ipv6_action.yml @@ -0,0 +1,12 @@ +lang: Python +source: |- + import os + from pydo import Client + + client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN")) + + req={ + "type": "unassign" + } + + resp = client.reserved_ipv6s_actions.post(reserved_ipv6="2409:40d0:f7:1017:74b4:3a96:105e:4c6e", body=req) diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6.yml new file mode 100644 index 000000000..250b8f8d3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6.yml @@ -0,0 +1,32 @@ +type: object + +properties: + ip: + type: string + format: ipv6 + example: 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + description: The public IP address of the reserved IPv6. It also serves as its + identifier. + + reserved_at: + type: string + format: date-time + example: "2024-11-20T11:08:30Z" + description: The date and time when the reserved IPv6 was reserved. + + region_slug: + type: string + description: The region that the reserved IPv6 is reserved to. When you + query a reserved IPv6,the region_slug will be returned. + example: nyc3 + + droplet: + anyOf: + - title: 'null' + type: object + nullable: true + description: If the reserved IP is not assigned to a Droplet, the value will be null.

Requires `droplet:read` scope. + - $ref: '../../droplets/models/droplet.yml' + example: null + + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_actions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_actions.yml new file mode 100644 index 000000000..98bccdfae --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_actions.yml @@ -0,0 +1,36 @@ +reserved_ipv6_action_type: + type: object + required: + - type + properties: + type: + type: string + enum: + - assign + - unassign + description: The type of action to initiate for the reserved IPv6. + discriminator: + propertyName: type + mapping: + assign: '#/reserved_ipv6_action_assign' + unassign: '#/reserved_ipv6_action_unassign' + +reserved_ipv6_action_unassign: + allOf: + - $ref: '#/reserved_ipv6_action_type' + - type: object + required: + - type + +reserved_ipv6_action_assign: + allOf: + - $ref: '#/reserved_ipv6_action_type' + - type: object + required: + - type + - droplet_id + properties: + droplet_id: + type: integer + example: 758604968 + description: The ID of the Droplet that the reserved IPv6 will be assigned to. \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_create.yml new file mode 100644 index 000000000..e79ba9089 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_create.yml @@ -0,0 +1,9 @@ +title: Reserve to Region +type: object +properties: + region_slug: + type: string + example: nyc3 + description: The slug identifier for the region the reserved IPv6 will be reserved to. +required: +- region_slug \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_list.yml new file mode 100644 index 000000000..80898d43b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/models/reserved_ipv6_list.yml @@ -0,0 +1,30 @@ +type: object +properties: + reserved_ipv6s: + type: array + items: + properties: + ip: + type: string + format: ipv6 + example: 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + description: The public IP address of the reserved IPv6. It also serves as its + identifier. + region_slug: + type: string + description: The region that the reserved IPv6 is reserved to. When you + query a reserved IPv6,the region_slug will be returned. + example: nyc3 + reserved_at: + type: string + format: date-time + example: '2020-01-01T00:00:00Z' + droplet: + description: Requires `droplet:read` scope. + anyOf: + - title: 'null' + type: object + nullable: true + description: If the reserved IP is not assigned to a Droplet, the value will be null.

Requires `droplet:read` scope. + - $ref: '../../droplets/models/droplet.yml' + example: null diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/parameters.yml new file mode 100644 index 000000000..5712e8b5f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/parameters.yml @@ -0,0 +1,10 @@ +reserved_ipv6: + in: path + name: reserved_ipv6 + description: A reserved IPv6 address. + required: true + schema: + type: string + format: ipv6 + minimum: 1 + example: 2409:40d0:f7:1017:74b4:3a96:105e:4c6e diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6Actions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6Actions_post.yml new file mode 100644 index 000000000..c21f93f32 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6Actions_post.yml @@ -0,0 +1,64 @@ +operationId: reservedIPv6Actions_post + +summary: "Initiate a Reserved IPv6 Action" + +description: | + To initiate an action on a reserved IPv6 send a POST request to + `/v2/reserved_ipv6/$RESERVED_IPV6/actions`. In the JSON body to the request, + set the `type` attribute to on of the supported action types: + + | Action | Details + |------------|-------- + | `assign` | Assigns a reserved IPv6 to a Droplet + | `unassign` | Unassign a reserved IPv6 from a Droplet + +tags: + - "Reserved IPv6 Actions" + +parameters: + - $ref: 'parameters.yml#/reserved_ipv6' + +requestBody: + description: | + The `type` attribute set in the request body will specify the action that + will be taken on the reserved IPv6. + + content: + application/json: + schema: + anyOf: + - $ref: 'models/reserved_ipv6_actions.yml#/reserved_ipv6_action_unassign' + - $ref: 'models/reserved_ipv6_actions.yml#/reserved_ipv6_action_assign' + discriminator: + propertyName: type + mapping: + unassign: 'models/reserved_ipv6_actions.yml#/reserved_ipv6_action_unassign' + assign: 'models/reserved_ipv6_actions.yml#/reserved_ipv6_action_assign' + +responses: + '201': + $ref: 'responses/reserved_ipv6_action.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/post_reserved_ipv6_action.yml' + - $ref: 'examples/go/post_reserved_ipv6_action.yml' + - $ref: 'examples/python/post_reserved_ipv6_action.yml' + +security: + - bearer_auth: + - 'reserved_ip:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_create.yml new file mode 100644 index 000000000..85e8d0c58 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_create.yml @@ -0,0 +1,46 @@ +operationId: reservedIPv6_create + +summary: "Create a New Reserved IPv6" + +description: >- + On creation, a reserved IPv6 must be reserved to a region. + + * To create a new reserved IPv6 reserved to a region, send a POST request to + `/v2/reserved_ipv6` with the `region_slug` attribute. + + +tags: + - "Reserved IPv6" + +requestBody: + required: true + + content: + application/json: + schema: + $ref: 'models/reserved_ipv6_create.yml' + +responses: + '201': + $ref: 'responses/reserved_ipv6_create.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/create_reserved_ipv6.yml' + - $ref: 'examples/go/create_reserved_ipv6.yml' + - $ref: 'examples/python/create_reserved_ipv6.yml' + +security: + - bearer_auth: + - 'reserved_ip:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_delete.yml new file mode 100644 index 000000000..97783b122 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_delete.yml @@ -0,0 +1,47 @@ +operationId: reservedIPv6_delete + +summary: "Delete a Reserved IPv6" + +description: | + To delete a reserved IP and remove it from your account, send a DELETE request + to `/v2/reserved_ipv6/$RESERVED_IPV6`. + + A successful request will receive a 204 status code with no body in response. + This indicates that the request was processed successfully. + +tags: + - "Reserved IPv6" + +parameters: + - $ref: 'parameters.yml#/reserved_ipv6' + +responses: + '204': + $ref: '../../shared/responses/no_content.yml' + + '401': + $ref: '../../shared/responses/unauthorized.yml' + + '404': + $ref: '../../shared/responses/not_found.yml' + + '422': + $ref: '../../shared/responses/unprocessable_entity.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/delete_reserved_ipv6.yml' + - $ref: 'examples/go/delete_reserved_ipv6.yml' + - $ref: 'examples/python/delete_reserved_ipv6.yml' + +security: + - bearer_auth: + - 'reserved_ip:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_get.yml new file mode 100644 index 000000000..c46e7debb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_get.yml @@ -0,0 +1,40 @@ +operationId: reservedIPv6_get + +summary: "Retrieve an Existing Reserved IPv6" + +description: To show information about a reserved IPv6, send a GET request to + `/v2/reserved_ipv6/$RESERVED_IPV6`. + +tags: + - "Reserved IPv6" + +parameters: + - $ref: 'parameters.yml#/reserved_ipv6' + +responses: + '200': + $ref: 'responses/reserved_ipv6.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/get_reserved_ipv6.yml' + - $ref: 'examples/go/get_reserved_ipv6.yml' + - $ref: 'examples/python/get_reserved_ipv6.yml' + +security: + - bearer_auth: + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_list.yml new file mode 100644 index 000000000..c957e2ed6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/reservedIPv6_list.yml @@ -0,0 +1,38 @@ +operationId: reservedIPv6_list + +summary: "List All Reserved IPv6s" + +description: To list all of the reserved IPv6s available on your account, send a + GET request to `/v2/reserved_ipv6`. + +tags: + - "Reserved IPv6" + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + +responses: + '200': + $ref: 'responses/reserved_ipv6_list.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/list_reserved_ipv6s.yml' + - $ref: 'examples/go/list_reserved_ipv6s.yml' + - $ref: 'examples/python/list_reserved_ipv6s.yml' + +security: + - bearer_auth: + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/examples.yml new file mode 100644 index 000000000..a337f62c1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/examples.yml @@ -0,0 +1,149 @@ +reserved_ipv6_assigning: + summary: Assigning to Droplet + value: + type: "assign" + droplet_id: 3164444 + +reserved_ipv6_reserving: + summary: Reserving to Region + value: + region_slug: nyc3 + + +reserved_ipv6_reserved: + summary: Reserved to Region + value: + reserved_ipv6: + ip: 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + region_slug: nyc3 + reserved_at: 2024-11-20T11:08:30Z + droplet: null + +reserved_ipv6_assigned: + summary: Assigned to Droplet + value: + reserved_ipv6: + ip: 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + reserved_at: 2024-11-20T11:08:30Z + droplet: + id: 3164444 + name: example.com + memory: 1024 + vcpus: 1 + disk: 25 + locked: false + status: active + kernel: null + created_at: '2020-07-21T18:37:44Z' + features: + - backups + - private_networking + - ipv6 + backup_ids: + - 53893572 + next_backup_window: + start: '2020-07-30T00:00:00Z' + end: '2020-07-30T23:00:00Z' + snapshot_ids: + - 67512819 + image: + id: 63663980 + name: 20.04 (LTS) x64 + type: base + distribution: Ubuntu + slug: ubuntu-20-04-x64 + public: true + regions: + - ams2 + - ams3 + - blr1 + - fra1 + - lon1 + - nyc1 + - nyc2 + - nyc3 + - sfo1 + - sfo2 + - sfo3 + - sgp1 + - tor1 + created_at: '2020-05-15T05:47:50Z' + min_disk_size: 20 + size_gigabytes: 2.36 + description: '' + tags: [] + status: available + error_message: '' + volume_ids: [] + size: + slug: 's-1vcpu-1gb' + memory: 1024 + vcpus: 1 + disk: 25 + transfer: 1.0 + price_monthly: 5.0 + price_hourly: 0.00743999984115362 + regions: + - ams2 + - ams3 + - blr1 + - fra1 + - lon1 + - nyc1 + - nyc2 + - nyc3 + - sfo1 + - sfo2 + - sfo3 + - sgp1 + - tor1 + available: true + description: Basic + size_slug: s-1vcpu-1gb + 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: + - ip_address: '2604:a880:0:1010::18a:a001' + netmask: 64 + gateway: '2604:a880:0:1010::1' + type: public + region: + name: New York 3 + slug: nyc3 + features: + - backups + - ipv6 + - metadata + - install_agent + - storage + - image_transfer + 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 + tags: + - web + - env:prod + vpc_uuid: 760e09ef-dc84-11e8-981e-3cfdfeaae000 + region_slug: nyc3 + \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6.yml new file mode 100644 index 000000000..125ec3dff --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6.yml @@ -0,0 +1,24 @@ +description: The response will be a JSON object with key `reserved_ipv6`. The value of this will be an object that contains the standard attributes + associated with a reserved IPv6. + +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: + reserved_ipv6: + $ref: '../models/reserved_ipv6.yml' + + examples: + reserved_ipv6_assigned: + $ref: 'examples.yml#/reserved_ipv6_assigned' + reserved_ipv6_reserved: + $ref: 'examples.yml#/reserved_ipv6_reserved' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_action.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_action.yml new file mode 100644 index 000000000..797c42bb2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_action.yml @@ -0,0 +1,68 @@ +description: The response will be an object with a key called `action`. The + value of this will be an object that contains the standard reserved IP + action attributes. + +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: + action: + allOf: + - $ref: '../../actions/models/action.yml' + - type: object + properties: + resource_id: + type: integer + example: 758604968 + description: The ID of the resource that the action is being taken on. + resource_type: + type: string + example: reserved_ipv6 + description: The type of resource that the action is being taken on. + region_slug: + type: string + example: nyc3 + description: The slug identifier for the region the resource is located in. + + example: + action: + id: 72531856 + status: completed + type: assign_ip + started_at: '2015-11-12T17:51:03Z' + completed_at: '2015-11-12T17:51:14Z' + resource_id: 758604968 + resource_type: reserved_ipv6 + region: + name: New York 3 + slug: nyc3 + 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-192gb + features: + - private_networking + - backups + - ipv6 + - metadata + available: true + region_slug: nyc3 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_create.yml new file mode 100644 index 000000000..50c575a8b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_create.yml @@ -0,0 +1,40 @@ +description: The response will be a JSON object with key `reserved_ipv6`. The value of this will be an object that contains the standard attributes + associated with a reserved IPv6. + + +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: + reserved_ipv6: + type: object + properties: + ip: + type: string + format: ipv6 + example: 2409:40d0:f7:1017:74b4:3a96:105e:4c6e + description: The public IP address of the reserved IPv6. It also serves as its + identifier. + + region_slug: + type: string + description: The region that the reserved IPv6 is reserved to. When you + query a reserved IPv6,the region_slug will be returned. + example: nyc3 + + reserved_at: + type: string + format: date-time + example: "2024-11-20T11:08:30Z" + + examples: + reserved_ipv6_reserved: + $ref: 'examples.yml#/reserved_ipv6_reserved' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_list.yml new file mode 100644 index 000000000..add5a129d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ipv6/responses/reserved_ipv6_list.yml @@ -0,0 +1,32 @@ +description: The response will be a JSON object with a key called + `reserved_ipv6s`. This will be set to an array of reserved IP objects, each of + which will contain the standard reserved IP attributes + +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: + - $ref: '../models/reserved_ipv6_list.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + + example: + links: {} + meta: + total: 1 + reserved_ipv6s: + - ip: fd53:616d:6d60::dc9:c001 + region_slug: nyc3 + reserved_at: '2020-01-01T00:00:00Z' + - ip: fd53:616d:6d60::dc9:c002 + region_slug: nyc1 + reserved_at: '2020-01-01T00:00:00Z' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml index 9f03e4043..2ff234cb0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml @@ -41,3 +41,4 @@ x-codeSamples: security: - bearer_auth: - 'sizes:read' + - 'regions:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/models/snapshots.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/models/snapshots.yml index edb57c3d5..b3587f482 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/models/snapshots.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/models/snapshots.yml @@ -28,7 +28,7 @@ allOf: description: The type of resource that the snapshot originated from. tags: - description: An array of Tags the snapshot has been tagged with. + description: An array of Tags the snapshot has been tagged with.

Requires `tag:read` scope. type: array items: type: string @@ -40,4 +40,4 @@ allOf: required: - resource_id - resource_type - - tags \ No newline at end of file + - tags diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_create.yml new file mode 100644 index 000000000..b51ec52e3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_create.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "test-key", "grants": [{"bucket": "test-bucket", "permission": "read"}]}' \ + "https://api.digitalocean.com/v2/spaces/keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_delete.yml new file mode 100644 index 000000000..52c789701 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_delete.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/spaces/keys/DOACCESSKEYEXAMPLE" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_get.yml new file mode 100644 index 000000000..64a9bba9e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_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/spaces/keys/DOACCESSKEYEXAMPLE" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_list.yml new file mode 100644 index 000000000..df84f9d1c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_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/spaces/keys" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_patch.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_patch.yml new file mode 100644 index 000000000..6af8bb7f1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_patch.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PATCH \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "new-key-name"}' \ + "https://api.digitalocean.com/v2/spaces/keys/DOACCESSKEYEXAMPLE" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_update.yml new file mode 100644 index 000000000..06eb40c61 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/examples/curl/spaces_key_update.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"name": "new-key-name"}' \ + "https://api.digitalocean.com/v2/spaces/keys/DOACCESSKEYEXAMPLE" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_create.yml new file mode 100644 index 000000000..e3ffb27bc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_create.yml @@ -0,0 +1,75 @@ +operationId: spacesKey_create + +summary: "Create a New Spaces Access Key" + +description: | + To create a new Spaces Access Key, send a POST request to `/v2/spaces/keys`. + At the moment, you cannot mix a fullaccess permission with scoped permissions. + A fullaccess permission will be prioritized if fullaccess and scoped permissions are both added. + +tags: + - Spaces Keys + +requestBody: + required: true + + content: + application/json: + schema: + $ref: "models/key.yml" + + examples: + Read Only Key: + value: + name: "read-only-key" + grants: [{ "bucket": "my-bucket", "permission": "read" }] + + Read Write Key: + value: + name: "read-write-key" + grants: [{ "bucket": "my-bucket", "permission": "readwrite" }] + + Full Access Key: + value: + name: "full-access-key" + grants: [{ "bucket": "", "permission": "fullaccess" }] + + Mixed Permissions Key: + value: + name: "mixed-permissions-key" + grants: + [ + { "bucket": "my-bucket", "permission": "read" }, + { "bucket": "my-bucket2", "permission": "readwrite" }, + ] + + No Grant Key: + value: + name: "no-grant-key" + grants: [] + +responses: + "201": + $ref: "responses/key_create.yml" + + "400": + $ref: "responses/bad_request.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/spaces_key_create.yml" + +security: + - bearer_auth: + - "spaces_key:create_credentials" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_delete.yml new file mode 100644 index 000000000..e4ca49f0a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_delete.yml @@ -0,0 +1,40 @@ +operationId: spacesKey_delete + +summary: "Delete a Spaces Access Key" + +description: | + To delete a Spaces Access Key, send a DELETE request to `/v2/spaces/keys/$ACCESS_KEY`. + + A successful request will return a `204 No Content` status code. + +tags: + - Spaces Keys + +parameters: + - $ref: "parameters.yml#/access_key_id" + +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/spaces_key_delete.yml" + +security: + - bearer_auth: + - "spaces_key:delete" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_get.yml new file mode 100644 index 000000000..c64344b20 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_get.yml @@ -0,0 +1,40 @@ +operationId: spacesKey_get + +summary: "Get a Spaces Access Key" + +description: | + To get a Spaces Access Key, send a GET request to `/v2/spaces/keys/$ACCESS_KEY`. + + A successful request will return the Access Key. + +tags: + - Spaces Keys + +parameters: + - $ref: "parameters.yml#/access_key_id" + +responses: + "200": + $ref: "responses/key_get.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/spaces_key_get.yml" + +security: + - bearer_auth: + - "spaces_key:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_list.yml new file mode 100644 index 000000000..d78b512d2 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_list.yml @@ -0,0 +1,41 @@ +operationId: spacesKey_list + +summary: "List Spaces Access Keys" + +description: | + To list Spaces Access Key, send a GET request to `/v2/spaces/keys`. Sort parameter must be used with Sort Direction. + +tags: + - Spaces Keys + +parameters: + - $ref: "../../shared/parameters.yml#/per_page" + - $ref: "../../shared/parameters.yml#/page" + - $ref: "parameters.yml#/sort" + - $ref: "parameters.yml#/sort_direction" + - $ref: "parameters.yml#/name" + - $ref: "parameters.yml#/bucket" + - $ref: "parameters.yml#/permission" + +responses: + "200": + $ref: "responses/key_list.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/spaces_key_list.yml" + +security: + - bearer_auth: + - "spaces_key:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_patch.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_patch.yml new file mode 100644 index 000000000..eb9b83f24 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_patch.yml @@ -0,0 +1,55 @@ +operationId: spacesKey_patch + +summary: "Update Spaces Access Keys" + +description: | + To update Spaces Access Key, send a PUT or PATCH request to `/v2/spaces/keys/$ACCESS_KEY`. At the moment, you cannot convert a + fullaccess key to a scoped key or vice versa. You can only update the name of the key. + +tags: + - Spaces Keys + +parameters: + - $ref: "parameters.yml#/access_key_id" + +requestBody: + required: true + + content: + application/json: + schema: + $ref: "models/key.yml" + + examples: + Update Key Name: + value: + name: "new-key-name" + +responses: + "200": + $ref: "responses/key_update.yml" + + "400": + $ref: "responses/bad_request.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/spaces_key_patch.yml" + +security: + - bearer_auth: + - "spaces_key:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_update.yml new file mode 100644 index 000000000..3280e0ca8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/key_update.yml @@ -0,0 +1,55 @@ +operationId: spacesKey_update + +summary: "Update Spaces Access Keys" + +description: | + To update Spaces Access Key, send a PUT or PATCH request to `/v2/spaces/keys/$ACCESS_KEY`. At the moment, you cannot convert a + fullaccess key to a scoped key or vice versa. You can only update the name of the key. + +tags: + - Spaces Keys + +parameters: + - $ref: "parameters.yml#/access_key_id" + +requestBody: + required: true + + content: + application/json: + schema: + $ref: "models/key.yml" + + examples: + Update Key Name: + value: + name: "new-key-name" + +responses: + "200": + $ref: "responses/key_update.yml" + + "400": + $ref: "responses/bad_request.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/spaces_key_update.yml" + +security: + - bearer_auth: + - "spaces_key:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/grant.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/grant.yml new file mode 100644 index 000000000..35af33ec1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/grant.yml @@ -0,0 +1,16 @@ +type: object + +properties: + bucket: + type: string + description: The name of the bucket. + example: my-bucket + + permission: + type: string + description: The permission to grant to the user. Possible values are `read`, `readwrite`, `fullaccess`, or an empty string. + example: read + +required: +- bucket +- permission diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key.yml new file mode 100644 index 000000000..7381bd114 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key.yml @@ -0,0 +1,27 @@ +type: object + +properties: + name: + type: string + description: The access key's name. + example: "my-access-key" + + grants: + type: array + description: The list of permissions for the access key. + items: + $ref: "grant.yml" + default: [] + + access_key: + type: string + description: The Access Key ID used to access a bucket. + example: DOACCESSKEYEXAMPLE + readOnly: true + + created_at: + type: string + format: date-time + description: The date and time the key was created. + example: "2018-07-19T15:04:16Z" + readOnly: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key_create_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key_create_response.yml new file mode 100644 index 000000000..c4ff8d2ab --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/models/key_create_response.yml @@ -0,0 +1,10 @@ +allOf: + - type: object + properties: + secret_key: + type: string + description: The secret key used to access the bucket. We return secret keys only once upon creation. Make sure to copy the key and securely store it. + example: DOSECRETKEYEXAMPLE + readOnly: true + + - $ref: 'key.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/parameters.yml new file mode 100644 index 000000000..6d0e5713c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/parameters.yml @@ -0,0 +1,55 @@ +access_key_id: + in: path + name: access_key + description: The access key's ID. + required: true + schema: + type: string + example: DOACCESSKEYEXAMPLE + +sort: + in: query + name: sort + required: false + description: The field to sort by. + schema: + type: string + default: "created_at" + example: created_at + +sort_direction: + in: query + name: sort_direction + required: false + description: The direction to sort by. Possible values are `asc` or `desc`. + schema: + type: string + default: "desc" + example: desc + +name: + in: query + name: name + required: false + description: The access key's name. + schema: + type: string + example: my-access-key + +bucket: + in: query + name: bucket + required: false + description: The bucket's name. + schema: + type: string + example: my-bucket + +permission: + in: query + name: permission + required: false + description: The permission of the access key. Possible values are `read`, `readwrite`, `fullaccess`, or an empty string. + schema: + type: string + example: read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/bad_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/bad_request.yml new file mode 100644 index 000000000..6215cd35f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/bad_request.yml @@ -0,0 +1,17 @@ +description: Cannot mix fullaccess permission with scoped permissions + +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: + $ref: '../../../shared/models/error.yml' + example: + id: bad_request + message: cannot mix fullaccess permission with scoped permissions. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_create.yml new file mode 100644 index 000000000..3c95f8e20 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_create.yml @@ -0,0 +1,53 @@ +description: >- + A JSON response containing details about the new 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: + key: + $ref: "../models/key_create_response.yml" + + examples: + Read Only Key: + value: + key: + name: read-only-key + access_key: DOACCESSKEYEXAMPLE + secret_key: DOSECRETKEYEXAMPLE + grants: + - bucket: my-bucket + permission: read + created_at: "2018-07-19T15:04:16Z" + + Full Access Key: + value: + key: + name: full-access-key + access_key: DOACCESSKEYEXAMPLE + secret_key: DOSECRETKEYEXAMPLE + grants: + - bucket: "" + permission: fullaccess + created_at: "2018-07-19T15:04:16Z" + + Mixed Permission Access Key: + value: + key: + name: custom-bucket-key + access_key: DOACCESSKEYEXAMPLE + secret_key: DOSECRETKEYEXAMPLE + grants: + - bucket: my-bucket + permission: readwrite + - bucket: my-other-bucket + permission: read + created_at: "2018-07-19T15:04:16Z" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_get.yml new file mode 100644 index 000000000..4bf08c9d0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_get.yml @@ -0,0 +1,32 @@ +description: >- + A JSON response containing details about the 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: + allOf: + - type: object + properties: + keys: + type: array + items: + $ref: "../models/key.yml" + + examples: + Read Only Key: + value: + key: + name: read-only-key + access_key: DOACCESSKEYEXAMPLE + grants: + - bucket: my-bucket + permission: read + created_at: "2018-07-19T15:04:16Z" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_list.yml new file mode 100644 index 000000000..b492aae0c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_list.yml @@ -0,0 +1,35 @@ +description: >- + A JSON response containing a list of keys. + +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: + keys: + type: array + items: + $ref: '../models/key.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + + example: + keys: + - name: my-access-key + access_key: DOACCESSKEYEXAMPLE + grants: + - bucket: my-bucket + permission: read + created_at: '2018-07-19T15:04:16Z' + links: {} + meta: + total: 1 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_update.yml new file mode 100644 index 000000000..dce7d0f34 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/spaces/responses/key_update.yml @@ -0,0 +1,28 @@ +description: >- + The response will be a JSON object + +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: + key: + $ref: '../models/key.yml' + + examples: + Read Only Key: + value: + key: + name: new-key-name + access_key: DOACCESSKEYEXAMPLE + grants: + - bucket: my-bucket + permission: read + created_at: '2018-07-19T15:04:16Z' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags.yml index 962453409..023723ae8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags.yml @@ -25,23 +25,35 @@ properties: resources: type: object - description: >- + description: | An embedded object containing key value pairs of resource type and resource statistics. It also includes a count of the total number of resources tagged with the current tag as well as a `last_tagged_uri` attribute set to the last resource tagged with the current tag. + + This will only include resources that you are authorized to see. For example, to see tagged Droplets, include the `droplet:read` scope. readOnly: true allOf: - $ref: 'tags_metadata.yml' - properties: droplets: - $ref: 'tags_metadata.yml' + allOf: + - description: Droplets that are tagged with the specified tag.
Requires `droplet:read` scope. + - $ref: 'tags_metadata.yml' imgages: - $ref: 'tags_metadata.yml' + allOf: + - description: Images that are tagged with the specified tag.
Requires `image:read` scope. + - $ref: 'tags_metadata.yml' volumes: - $ref: 'tags_metadata.yml' + allOf: + - description: Volumes that are tagged with the specified tag.
Requires `block_storage:read` scope. + - $ref: 'tags_metadata.yml' volume_snapshots: - $ref: 'tags_metadata.yml' + allOf: + - description: Volume Snapshots that are tagged with the specified tag.
Requires `block_storage_snapshot:read` scope. + - $ref: 'tags_metadata.yml' databases: - $ref: 'tags_metadata.yml' + allOf: + - description: Databases that are tagged with the specified tag.
Requires `database:read` scope. + - $ref: 'tags_metadata.yml' example: count: 5 last_tagged_uri: https://api.digitalocean.com/v2/images/7555620 @@ -59,4 +71,4 @@ properties: last_tagged_uri: https://api.digitalocean.com/v2/snapshots/1f6f46e8-6b60-11e9-be4e-0a58ac144519 databases: count: 1 - last_tagged_uri: https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976 \ No newline at end of file + last_tagged_uri: https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags_resource.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags_resource.yml index d083edc61..be40d8248 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags_resource.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/models/tags_resource.yml @@ -2,9 +2,12 @@ type: object properties: resources: - description: >- + description: | An array of objects containing resource_id and resource_type attributes. + + This response will only include resources that you are authorized to see. + For example, to see Droplets, include the `droplet:read` scope. type: array @@ -34,4 +37,4 @@ properties: resource_type: volume required: - - resources \ No newline at end of file + - resources diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/responses/tags_existing.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/responses/tags_existing.yml index 2094b2567..f2382f9b6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/responses/tags_existing.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/responses/tags_existing.yml @@ -1,7 +1,9 @@ -description: >- +description: | The response will be a JSON object with a key called `tag`. The value of this will be a tag object containing the standard tag attributes. + Tagged resources will only include resources that you are authorized to see. + headers: ratelimit-limit: $ref: '../../../shared/headers.yml#/ratelimit-limit' @@ -39,4 +41,4 @@ content: last_tagged_uri: https://api.digitalocean.com/v2/snapshots/1f6f46e8-6b60-11e9-be4e-0a58ac144519 databases: count: 1 - last_tagged_uri: https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976 \ No newline at end of file + last_tagged_uri: https://api.digitalocean.com/v2/databases/b92438f6-ba03-416c-b642-e9236db91976 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml index 9e2218149..c1c91cda1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml @@ -2,7 +2,7 @@ operationId: tags_assign_resources summary: Tag a Resource -description: >- +description: | Resources can be tagged by sending a POST request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. @@ -12,6 +12,9 @@ description: >- `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + In order to tag a resource, you must have both `tag:create` and `:update` scopes. For example, + to tag a Droplet, you must have `tag:create` and `droplet:update`. + tags: - Tags diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml index 22939e128..97014cfd8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml @@ -2,10 +2,13 @@ operationId: tags_get summary: Retrieve a Tag -description: >- +description: | To retrieve an individual tag, you can send a `GET` request to `/v2/tags/$TAG_NAME`. + This endpoint will only return tagged resources that you are authorized to see. + For example, to see tagged Droplets, include the `droplet:read` scope. + tags: - Tags diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml index 2b232e6a8..a086f51c3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml @@ -2,7 +2,11 @@ operationId: tags_list summary: List All Tags -description: To list all of your tags, you can send a GET request to `/v2/tags`. +description: | + To list all of your tags, you can send a GET request to `/v2/tags`. + + This endpoint will only return tagged resources that you are authorized to see + (e.g. Droplets will only be returned if you have `droplet:read`). tags: - Tags diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml index 999110e0c..2509aaaa0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml @@ -2,7 +2,7 @@ operationId: tags_unassign_resources summary: Untag a Resource -description: >- +description: | Resources can be untagged by sending a DELETE request to `/v2/tags/$TAG_NAME/resources` with an array of json objects containing `resource_id` and `resource_type` attributes. @@ -12,6 +12,9 @@ description: >- `database`, `image`, `volume` or `volume_snapshot`. `resource_id` is expected to be the ID of the resource as a string. + In order to untag a resource, you must have both `tag:delete` and `:update` scopes. For example, + to untag a Droplet, you must have `tag:delete` and `droplet:update`. + tags: - Tags diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml index dba2ccb7b..17138e288 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml @@ -64,3 +64,4 @@ x-codeSamples: security: - bearer_auth: - 'uptime:create' + - 'uptime:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml index c3f3d63e4..dec25d0c0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml @@ -41,3 +41,4 @@ x-codeSamples: security: - bearer_auth: - 'uptime:delete' + - 'uptime:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base.yml index f2d69dc5c..34b75e1a1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base.yml @@ -49,4 +49,4 @@ properties: readOnly: true tags: - $ref: '../../../shared/attributes/tags_array.yml' \ No newline at end of file + $ref: '../../../shared/attributes/tags_array.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base_read.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base_read.yml new file mode 100644 index 000000000..8a9c84b8d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_base_read.yml @@ -0,0 +1,52 @@ +type: object + +properties: + + id: + type: string + description: The unique identifier for the block storage volume. + example: 506f78a4-e098-11e5-ad9f-000f53306ae1 + readOnly: true + + droplet_ids: + type: array + items: + type: integer + nullable: true + description: >- + An array containing the IDs of the Droplets the volume is attached to. + Note that at this time, a volume can only be attached to a single Droplet. + example: [] + readOnly: true + + name: + type: string + description: >- + A human-readable name for the block storage volume. Must be lowercase and + be composed only of numbers, letters and "-", up to a limit of 64 + characters. The name must begin with a letter. + example: example + + description: + type: string + description: >- + An optional free-form text field to describe a block storage volume. + example: Block store for examples + + size_gigabytes: + type: integer + description: >- + The size of the block storage volume in GiB (1024^3). This field does not apply + when creating a volume from a snapshot. + example: 10 + + created_at: + type: string + description: >- + A time value given in ISO8601 combined date and time format that + represents when the block storage volume was created. + example: 2020-03-02T17:00:49Z + readOnly: true + + tags: + $ref: '../../../shared/attributes/tags_array_read.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_full.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_full.yml index 0bdb41b07..8e7952c1c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_full.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/models/volume_full.yml @@ -1,7 +1,7 @@ type: object allOf: - - $ref: 'volume_base.yml' + - $ref: 'volume_base_read.yml' - properties: region: allOf: @@ -45,4 +45,4 @@ allOf: filesystem_label: type: string description: The label currently applied to the filesystem. - example: example \ No newline at end of file + example: example 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 67dabd1a1..4ceba495c 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 @@ -97,3 +97,4 @@ x-codeSamples: security: - bearer_auth: - "block_storage_action:create" + - "api:write" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml index ab84abe95..f68952df8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml @@ -81,4 +81,5 @@ x-codeSamples: security: - bearer_auth: + - 'api:write' - 'block_storage:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml index b7d667491..d4cb60b75 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml @@ -44,3 +44,4 @@ x-codeSamples: security: - bearer_auth: - 'block_storage:delete' + - 'api:write' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml index ae268d365..eaa28d7bc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml @@ -63,4 +63,6 @@ x-codeSamples: security: - bearer_auth: + - "api:read" + - "api:write" - "block_storage:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples.yml new file mode 100644 index 000000000..d0e4b0426 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples.yml @@ -0,0 +1,24 @@ +vpc_nat_gateway_create_request: + value: + name: "test-vpc-nat-gateways" + type: "PUBLIC" + region: "tor1" + size: 1 + vpcs: + - vpc_uuid: "0eb1752f-807b-4562-a077-8018e13ab1fb" + default_gateway: true + udp_timeout_seconds: 30 + icmp_timeout_seconds: 30 + tcp_timeout_seconds: 30 + project_id: "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30" + +vpc_nat_gateway_update_request: + value: + name: "test-vpc-nat-gateways-updated" + size: 2 + vpcs: + - vpc_uuid: "0eb1752f-807b-4562-a077-8018e13ab1fb" + default_gateway: false + udp_timeout_seconds: 60 + icmp_timeout_seconds: 60 + tcp_timeout_seconds: 60 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_create.yml new file mode 100644 index 000000000..7bcab2f06 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_create.yml @@ -0,0 +1,21 @@ +lang: cURL +source: |- + curl -X POST \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{ + "name": "test-vpc-nat-gateways", + "type": "PUBLIC", + "region": "tor1", + "size": 1, + "vpcs": [ + { + "vpc_uuid": "0eb1752f-807b-4562-a077-8018e13ab1fb", + "default_gateway": true + } + ], + "udp_timeout_seconds": 30, + "icmp_timeout_seconds": 30, + "tcp_timeout_seconds": 30 + }' \ + "https://api.digitalocean.com/v2/vpc_nat_gateways" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_delete.yml new file mode 100644 index 000000000..654f06472 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_delete.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/vpc_nat_gateways/a21d90fe-dc75-4097-993a-2dc7d1a8a438" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_get.yml new file mode 100644 index 000000000..5f5ade225 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_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_nat_gateways/a21d90fe-dc75-4097-993a-2dc7d1a8a438" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_list.yml new file mode 100644 index 000000000..e86184811 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_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_nat_gateways?page=1&per_page=10" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_update.yml new file mode 100644 index 000000000..1980aaae3 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/examples/curl/vpc_nat_gateway_update.yml @@ -0,0 +1,19 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{ + "name": "test-vpc-nat-gateways", + "size": 2, + "vpcs": [ + { + "vpc_uuid": "0eb1752f-807b-4562-a077-8018e13ab1fb", + "default_gateway": false + } + ], + "udp_timeout_seconds": 30, + "icmp_timeout_seconds": 30, + "tcp_timeout_seconds": 300 + }' \ + "https://api.digitalocean.com/v2/vpc_nat_gateways/a21d90fe-dc75-4097-993a-2dc7d1a8a438" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_create.yml new file mode 100644 index 000000000..d8cc3fe35 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_create.yml @@ -0,0 +1,79 @@ +type: object + +properties: + name: + type: string + example: my-vpc-nat-gateway + description: The human-readable name of the VPC NAT gateway. + + type: + type: string + enum: + - PUBLIC + example: PUBLIC + description: The type of the VPC NAT gateway. + + region: + type: string + enum: + - nyc1 + - nyc2 + - nyc3 + - ams2 + - ams3 + - sfo1 + - sfo2 + - sfo3 + - sgp1 + - lon1 + - fra1 + - tor1 + - blr1 + - syd1 + - atl1 + example: tor1 + description: The region in which the VPC NAT gateway is created. + + size: + type: integer + example: 1 + description: The size of the VPC NAT gateway. + + vpcs: + type: array + items: + type: object + properties: + vpc_uuid: + type: string + example: 0d3db13e-a604-4944-9827-7ec2642d32ac + description: The unique identifier of the VPC to which the NAT gateway is attached. + default_gateway: + type: boolean + example: true + description: The classification of the NAT gateway as the default egress route for the VPC traffic. + required: + - vpc_uuid + description: An array of VPCs associated with the VPC NAT gateway. + + udp_timeout_seconds: + type: integer + example: 30 + description: The UDP timeout in seconds for the VPC NAT gateway. + + icmp_timeout_seconds: + type: integer + example: 30 + description: The ICMP timeout in seconds for the VPC NAT gateway. + + tcp_timeout_seconds: + type: integer + example: 30 + description: The TCP timeout in seconds for the VPC NAT gateway. + +required: + - name + - type + - region + - size + - vpcs diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_get.yml new file mode 100644 index 000000000..8cedcf880 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_get.yml @@ -0,0 +1,118 @@ +type: object + +properties: + id: + type: string + example: 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + description: The unique identifier for the VPC NAT gateway. This is automatically generated upon creation. + + name: + type: string + example: my-vpc-nat-gateway + description: The human-readable name of the VPC NAT gateway. + + type: + type: string + enum: + - PUBLIC + example: PUBLIC + description: The type of the VPC NAT gateway. + + state: + type: string + enum: + - NEW + - PROVISIONING + - ACTIVE + - DELETING + - ERROR + - INVALID + description: The current state of the VPC NAT gateway. + example: ACTIVE + + region: + type: string + enum: + - nyc1 + - nyc2 + - nyc3 + - ams2 + - ams3 + - sfo1 + - sfo2 + - sfo3 + - sgp1 + - lon1 + - fra1 + - tor1 + - blr1 + - syd1 + - atl1 + example: tor1 + description: The region in which the VPC NAT gateway is created. + + size: + type: integer + example: 1 + description: The size of the VPC NAT gateway. + + vpcs: + type: array + items: + type: object + properties: + vpc_uuid: + type: string + example: 0d3db13e-a604-4944-9827-7ec2642d32ac + description: The unique identifier of the VPC to which the NAT gateway is attached. + gateway_ip: + type: string + example: 10.118.0.35 + description: The gateway IP address of the VPC NAT gateway. + description: An array of VPCs associated with the VPC NAT gateway. + + egresses: + type: object + properties: + public_gateways: + type: array + description: An array of public gateway IP addresses for the VPC NAT gateway. + items: + type: object + properties: + ipv4: + type: string + example: 174.138.113.197 + description: IPv4 address of the public gateway. + description: An object containing egress information for the VPC NAT gateway. + + udp_timeout_seconds: + type: integer + example: 30 + description: The UDP timeout in seconds for the VPC NAT gateway. + + icmp_timeout_seconds: + type: integer + example: 30 + description: The ICMP timeout in seconds for the VPC NAT gateway. + + tcp_timeout_seconds: + type: integer + example: 30 + description: The TCP timeout in seconds for the VPC NAT gateway. + + created_at: + format: date-time + title: The creation time of the VPC NAT gateway. + type: string + example: 2020-07-28T18:00:00Z + description: A time value given in ISO8601 combined date and time format + that represents when the VPC NAT gateway was created. + + updated_at: + format: date-time + title: The last update time of the VPC NAT gateway. + type: string + example: 2020-07-28T18:00:00Z + description: A time value given in ISO8601 combined date and time format + that represents when the VPC NAT gateway was last updated. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_update.yml new file mode 100644 index 000000000..938f13ee4 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/models/vpc_nat_gateway_update.yml @@ -0,0 +1,47 @@ +type: object + +properties: + name: + type: string + example: my-vpc-nat-gateway + description: The human-readable name of the VPC NAT gateway. + + size: + type: integer + example: 1 + description: The size of the VPC NAT gateway. + + vpcs: + type: array + items: + type: object + properties: + vpc_uuid: + type: string + example: 0d3db13e-a604-4944-9827-7ec2642d32ac + description: The unique identifier of the VPC to which the NAT gateway is attached. + default_gateway: + type: boolean + example: false + description: The classification of the NAT gateway as the default egress route for the VPC traffic. + description: + An array of VPCs associated with the VPC NAT gateway. + + udp_timeout_seconds: + type: integer + example: 30 + description: The UDP timeout in seconds for the VPC NAT gateway. + + icmp_timeout_seconds: + type: integer + example: 30 + description: The ICMP timeout in seconds for the VPC NAT gateway. + + tcp_timeout_seconds: + type: integer + example: 30 + description: The TCP timeout in seconds for the VPC NAT gateway. + +required: + - name + - size diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/parameters.yml new file mode 100644 index 000000000..83ba1edee --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/parameters.yml @@ -0,0 +1,65 @@ +vpc_nat_gateway_id: + in: path + name: id + description: The unique identifier of the VPC NAT gateway. + required: true + schema: + type: string + example: 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + +vpc_nat_gateway_state: + in: query + name: state + description: The current state of the VPC NAT gateway. + schema: + type: string + enum: + - new + - provisioning + - active + - deleting + - error + - invalid + example: active + +vpc_nat_gateway_region: + in: query + name: region + description: The region where the VPC NAT gateway is located. + schema: + type: string + enum: + - nyc1 + - nyc2 + - nyc3 + - ams2 + - ams3 + - sfo1 + - sfo2 + - sfo3 + - sgp1 + - lon1 + - fra1 + - tor1 + - blr1 + - syd1 + - atl1 + example: tor1 + +vpc_nat_gateway_type: + in: query + name: type + description: The type of the VPC NAT gateway. + schema: + type: string + enum: + - public + example: public + +vpc_nat_gateway_name: + in: query + name: name + description: The name of the VPC NAT gateway. + schema: + type: string + example: my-vpc-nat-gateway diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/examples.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/examples.yml new file mode 100644 index 000000000..d14a8b96f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/examples.yml @@ -0,0 +1,86 @@ +vpc_nat_gateways: + value: + vpc_nat_gateways: + - id: 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + name: "test-vpc-nat-gateways" + type: "PUBLIC" + state: "ACTIVE" + region: "tor1" + size: 1 + vpcs: + - vpc_uuid: "0eb1752f-807b-4562-a077-8018e13ab1fb" + gateway_ip: "10.118.0.35" + egresses: + public_gateways: + - ipv4: "174.138.113.197" + udp_timeout_seconds: 30 + icmp_timeout_seconds: 30 + tcp_timeout_seconds: 30 + created_at: "2025-08-12T18:43:14Z" + updated_at: "2025-08-12T19:00:04Z" + project_id: "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30" + links: {} + meta: + total: 1 + +vpc_nat_gateway: + value: + vpc_nat_gateway: + id: 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + name: "test-vpc-nat-gateways" + type: "PUBLIC" + state: "ACTIVE" + region: "tor1" + size: 1 + vpcs: + - vpc_uuid: "0eb1752f-807b-4562-a077-8018e13ab1fb" + gateway_ip: "10.118.0.35" + default_gateway: true + egresses: + public_gateways: + - ipv4: "174.138.113.197" + udp_timeout_seconds: 30 + icmp_timeout_seconds: 30 + tcp_timeout_seconds: 30 + created_at: "2025-08-12T18:43:14Z" + updated_at: "2025-08-12T19:00:04Z" + +vpc_nat_gateway_create: + value: + vpc_nat_gateway: + id: 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + name: "test-vpc-nat-gateways" + type: "PUBLIC" + state: "ACTIVE" + region: "tor1" + size: 1 + vpcs: + - vpc_uuid: "0eb1752f-807b-4562-a077-8018e13ab1fb" + default_gateway: true + egresses: {} + udp_timeout_seconds: 30 + icmp_timeout_seconds: 30 + tcp_timeout_seconds: 30 + created_at: "2025-08-12T18:43:14Z" + updated_at: "2025-08-12T18:43:14Z" + +vpc_nat_gateway_update: + value: + vpc_nat_gateway: + id: 70e1b58d-cdec-4e95-b3ee-2d4d95feff51 + name: "test-vpc-nat-gateways" + type: "PUBLIC" + state: "ACTIVE" + region: "tor1" + size: 2 + vpcs: + - vpc_uuid: "0eb1752f-807b-4562-a077-8018e13ab1fb" + gateway_ip: "10.118.0.35" + egresses: + public_gateways: + - ipv4: "174.138.113.197" + udp_timeout_seconds: 30 + icmp_timeout_seconds: 30 + tcp_timeout_seconds: 30 + created_at: "2025-08-12T18:43:14Z" + updated_at: "2025-08-12T19:00:04Z" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway.yml new file mode 100644 index 000000000..de3179194 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway.yml @@ -0,0 +1,21 @@ +description: | + The response will be a JSON object with a key called `vpc_nat_gateway`. This will be + set to a JSON object that contains the standard VPC NAT gateway attributes. + +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: + vpc_nat_gateway: + $ref: '../models/vpc_nat_gateway_get.yml' + examples: + VPC NAT Gateway Response: + $ref: 'examples.yml#/vpc_nat_gateway' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_create.yml new file mode 100644 index 000000000..051e78260 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_create.yml @@ -0,0 +1,21 @@ +description: | + The response will be a JSON object with a key called `vpc_nat_gateway`. This will be + set to a JSON object that contains the standard VPC NAT gateway attributes. + +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: + vpc_nat_gateway: + $ref: '../models/vpc_nat_gateway_create.yml' + examples: + VPC NAT Gateway Response: + $ref: 'examples.yml#/vpc_nat_gateway_create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_update.yml new file mode 100644 index 000000000..6b75573bb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateway_update.yml @@ -0,0 +1,21 @@ +description: | + The response will be a JSON object with a key called `vpc_nat_gateway`. This will be + set to a JSON object that contains the standard VPC NAT gateway attributes. + +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: + vpc_nat_gateway: + $ref: '../models/vpc_nat_gateway_update.yml' + examples: + VPC NAT Gateway Update Response: + $ref: 'examples.yml#/vpc_nat_gateway_update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateways.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateways.yml new file mode 100644 index 000000000..ce0be32bc --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/responses/vpc_nat_gateways.yml @@ -0,0 +1,26 @@ +description: A JSON object with a key of `vpc_nat_gateways`. + +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_nat_gateways: + type: array + items: + $ref: '../models/vpc_nat_gateway_get.yml' + - $ref: '../../../shared/pages.yml#/pagination' + - $ref: '../../../shared/meta.yml' + examples: + VPC NAT Gateways List Response: + $ref: 'examples.yml#/vpc_nat_gateways' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_create.yml new file mode 100644 index 000000000..14e6e584d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_create.yml @@ -0,0 +1,43 @@ +operationId: vpcnatgateways_create + +summary: Create a New VPC NAT Gateway + +description: | + To create a new VPC NAT gateway, send a POST request to `/v2/vpc_nat_gateways` setting the required attributes. + + The response body will contain a JSON object with a key called `vpc_nat_gateway` containing the standard attributes for the new VPC NAT gateway. + +tags: + - "VPC NAT Gateways" + +requestBody: + content: + application/json: + schema: + $ref: 'models/vpc_nat_gateway_create.yml' + examples: + VPC NAT Gateway Create Request: + $ref: 'examples.yml#/vpc_nat_gateway_create_request' + +responses: + '202': + $ref: 'responses/vpc_nat_gateway_create.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_nat_gateway_create.yml' + +security: + - bearer_auth: + - 'nat_gateway:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_delete.yml new file mode 100644 index 000000000..378cffd0d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_delete.yml @@ -0,0 +1,40 @@ +operationId: vpcnatgateways_delete + +summary: Delete VPC NAT Gateway + +description: | + To destroy a VPC NAT Gateway, send a DELETE request to the `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID` endpoint. + + A successful response will include a 202 response code and no content. + +tags: + - "VPC NAT Gateways" + +parameters: + - $ref: 'parameters.yml#/vpc_nat_gateway_id' + +responses: + '202': + $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/vpc_nat_gateway_delete.yml' + +security: + - bearer_auth: + - 'nat_gateway:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_get.yml new file mode 100644 index 000000000..be396d5ca --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_get.yml @@ -0,0 +1,39 @@ +operationId: vpcnatgateways_get + +summary: Retrieve an Existing VPC NAT Gateway + +description: | + To show information about an individual VPC NAT gateway, send a GET request to + `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID`. + +tags: + - "VPC NAT Gateways" + +parameters: + - $ref: 'parameters.yml#/vpc_nat_gateway_id' + +responses: + '200': + $ref: 'responses/vpc_nat_gateway.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_nat_gateway_get.yml' + +security: + - bearer_auth: + - 'nat_gateway:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_list.yml new file mode 100644 index 000000000..23ee494a1 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_list.yml @@ -0,0 +1,42 @@ +operationId: vpcnatgateways_list + +summary: List All VPC NAT Gateways + +description: | + To list all VPC NAT gateways in your team, send a GET request to `/v2/vpc_nat_gateways`. + The response body will be a JSON object with a key of `vpc_nat_gateways` containing an array of VPC NAT gateway objects. + These each contain the standard VPC NAT gateway attributes. + +tags: + - "VPC NAT Gateways" + +parameters: + - $ref: '../../shared/parameters.yml#/per_page' + - $ref: '../../shared/parameters.yml#/page' + - $ref: './parameters.yml#/vpc_nat_gateway_state' + - $ref: './parameters.yml#/vpc_nat_gateway_region' + - $ref: './parameters.yml#/vpc_nat_gateway_type' + - $ref: './parameters.yml#/vpc_nat_gateway_name' + +responses: + '200': + $ref: 'responses/vpc_nat_gateways.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_nat_gateway_list.yml' + +security: + - bearer_auth: + - 'nat_gateway:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_update.yml new file mode 100644 index 000000000..fd0c08e67 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpc_nat_gateways/vpc_nat_gateway_update.yml @@ -0,0 +1,49 @@ +operationId: vpcnatgateways_update + +summary: Update VPC NAT Gateway + +description: | + To update the configuration of an existing VPC NAT Gateway, send a PUT request to + `/v2/vpc_nat_gateways/$VPC_NAT_GATEWAY_ID`. The request must contain a full representation + of the VPC NAT Gateway including existing attributes. + +tags: + - "VPC NAT Gateways" + +parameters: + - $ref: 'parameters.yml#/vpc_nat_gateway_id' + +requestBody: + content: + application/json: + schema: + $ref: 'models/vpc_nat_gateway_update.yml' + examples: + VPC NAT Gateway Update Request: + $ref: 'examples.yml#/vpc_nat_gateway_update_request' + +responses: + '200': + $ref: 'responses/vpc_nat_gateway_update.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_nat_gateway_update.yml' + +security: + - bearer_auth: + - 'nat_gateway:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/attributes/urn.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/attributes/urn.yml new file mode 100644 index 000000000..d4949e57a --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/attributes/urn.yml @@ -0,0 +1,5 @@ +type: string +pattern: ^do:(dbaas|domain|droplet|floatingip|loadbalancer|space|volume|kubernetes|vpc):.* +example: do:vpc:5a4981aa-9653-4bd1-bef5-d6bff52042e4 +description: The uniform resource name (URN) for the resource in the format + do:resource_type:resource_id. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/models/vpc.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/models/vpc.yml index c51d2dec9..eb7130d65 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/models/vpc.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/models/vpc.yml @@ -1,10 +1,10 @@ vpc: type: object allOf: - - $ref: '#/vpc_updatable' - - $ref: '#/vpc_create' - - $ref: '#/vpc_default' - - $ref: '#/vpc_base' + - $ref: "#/vpc_updatable" + - $ref: "#/vpc_create" + - $ref: "#/vpc_default" + - $ref: "#/vpc_base" vpc_base: type: object @@ -17,7 +17,7 @@ vpc_base: description: A unique ID that can be used to identify and reference the VPC. urn: - $ref: '../../../shared/attributes/urn.yml' + $ref: "../attributes/urn.yml" created_at: type: string @@ -70,7 +70,7 @@ vpc_create: example: 10.10.10.0/24 description: The range of IP addresses in the VPC in CIDR notation. Network ranges cannot overlap with other networks in the same account - and must be in range of private addresses as defined in RFC1918. It - may not be smaller than `/28` nor larger than `/16`. If no IP range - is specified, a `/20` network range is generated that won't conflict - with other VPC networks in your account. + and must be in range of private addresses as defined in RFC1918. It + may not be smaller than `/28` nor larger than `/16`. If no IP range + is specified, a `/20` network range is generated that won't conflict + with other VPC networks in your account. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/all_vpcs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/all_vpcs.yml index 76af6be92..06aa710e7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/all_vpcs.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/all_vpcs.yml @@ -1,7 +1,7 @@ description: >- The response will be a JSON object with a key called `vpcs`. This will be set to an array of objects, each of which will contain the standard attributes - associated with a VPC + associated with a VPC. headers: ratelimit-limit: @@ -52,4 +52,4 @@ content: default: true links: {} meta: - total: 3 \ No newline at end of file + total: 3 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_members.yml index 50533a78d..5ca0deeee 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_members.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/responses/vpc_members.yml @@ -1,8 +1,11 @@ -description: >- +description: | The response will be a JSON object with a key called members. This will be set to an array of objects, each of which will contain the standard attributes associated with a VPC member. + Only resources that you are authorized to see will be returned (e.g. to see Droplets, + you must have `droplet:read`). + headers: ratelimit-limit: $ref: '../../../shared/headers.yml#/ratelimit-limit' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml index 2b0915b79..372adf4a3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml @@ -10,6 +10,9 @@ description: | included a `resource_type` query parameter. For example, to only list Droplets in the VPC, send a GET request to `/v2/vpcs/$VPC_ID/members?resource_type=droplet`. + Only resources that you are authorized to see will be returned (e.g. to see Droplets, + you must have `droplet:read`). + tags: - VPCs diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml index 28c77d7da..e528a9d42 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/existing_tags_array.yml @@ -5,6 +5,7 @@ nullable: true description: >- A flat array of tag names as strings to be applied to the resource. Tag names must exist in order to be referenced in a request. +

Requires `tag:create` and `tag:read` scopes. example: - base-image - prod diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml index 8243341c7..5c21bb199 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array.yml @@ -5,6 +5,7 @@ nullable: true description: >- A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags. +

Requires `tag:create` scope. example: - base-image - prod diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array_read.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array_read.yml new file mode 100644 index 000000000..e18b0dfa0 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/attributes/tags_array_read.yml @@ -0,0 +1,10 @@ +type: array +items: + type: string +nullable: true +description: >- + A flat array of tag names as strings applied to the resource. +

Requires `tag:read` scope. +example: + - base-image + - prod diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/accepted.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/accepted.yml index 952573051..23e8123bc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/accepted.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/accepted.yml @@ -1,4 +1,4 @@ -description: The does not indicate the success or failure of any +description: This does not indicate the success or failure of any operation, just that the request has been accepted for processing. headers: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/bad_request.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/bad_request.yml index 544c5a128..553983418 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/bad_request.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/bad_request.yml @@ -1,4 +1,4 @@ -description: Bad Request +description: There was an error parsing the request body. headers: ratelimit-limit: @@ -15,4 +15,4 @@ content: example: id: bad_request message: error parsing request body - request_id: 4851a473-1621-42ea-b2f9-5071c0ea8414 \ No newline at end of file + request_id: 4851a473-1621-42ea-b2f9-5071c0ea8414 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/conflict.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/conflict.yml index f2478b65e..7a693e774 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/conflict.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/conflict.yml @@ -1,4 +1,4 @@ -description: Conflict +description: The request could not be completed due to a conflict. headers: ratelimit-limit: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/server_error.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/server_error.yml index 24ca9e978..064b4fb5c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/server_error.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/server_error.yml @@ -1,4 +1,4 @@ -description: Server error. +description: There was a server error. headers: ratelimit-limit: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/too_many_requests.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/too_many_requests.yml index 21dca433b..59324487c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/too_many_requests.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/too_many_requests.yml @@ -1,4 +1,4 @@ -description: API Rate limit exceeded +description: The API rate limit has been exceeded. headers: ratelimit-limit: @@ -14,4 +14,4 @@ content: $ref: '../models/error.yml' example: id: too_many_requests - message: API Rate limit exceeded. + message: API rate limit exceeded. diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unauthorized.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unauthorized.yml index 50ccec555..e6083aeea 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unauthorized.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unauthorized.yml @@ -1,4 +1,4 @@ -description: Unauthorized +description: Authentication failed due to invalid credentials. headers: ratelimit-limit: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unexpected_error.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unexpected_error.yml index 20d15dab1..c922d0eee 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unexpected_error.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unexpected_error.yml @@ -1,4 +1,4 @@ -description: Unexpected error +description: There was an unexpected error. headers: ratelimit-limit: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unprocessable_entity.yml b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unprocessable_entity.yml new file mode 100644 index 000000000..d41b99729 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/shared/responses/unprocessable_entity.yml @@ -0,0 +1,17 @@ +description: Unprocessable Entity +headers: + ratelimit-limit: + $ref: '../headers.yml#/ratelimit-limit' + ratelimit-remaining: + $ref: '../headers.yml#/ratelimit-remaining' + ratelimit-reset: + $ref: '../headers.yml#/ratelimit-reset' + +content: + application/json: + schema: + $ref: '../models/error.yml' + example: + id: unprocessable_entity + message: request payload validation failed + request_id: 4851a473-1621-42ea-b2f9-5071c0ea8414 \ No newline at end of file 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 4ccd073d1..07ce6c0b6 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -3,33 +3,33 @@ * Do not make direct changes to the file. */ -export type paths = { - readonly "/": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; +export interface paths { + "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ - readonly get: operations["meta/root"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/advisories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List global security advisories @@ -37,41 +37,41 @@ export type paths = { * * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ - readonly get: operations["security-advisories/list-global-advisories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["security-advisories/list-global-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/advisories/{ghsa_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a global security advisory * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. */ - readonly get: operations["security-advisories/get-global-advisory"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["security-advisories/get-global-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the authenticated app @@ -79,41 +79,41 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-authenticated"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/app-manifests/{code}/conversions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - readonly post: operations["apps/create-from-manifest"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/hook/config": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook configuration for an app @@ -121,27 +121,27 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-webhook-config-for-app"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly patch: operations["apps/update-webhook-config-for-app"]; - readonly trace?: never; + patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; - readonly "/app/hook/deliveries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deliveries for an app webhook @@ -149,21 +149,21 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/list-webhook-deliveries"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/hook/deliveries/{delivery_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a delivery for an app webhook @@ -171,63 +171,63 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-webhook-delivery"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/app/hook/deliveries/{delivery_id}/attempts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly post: operations["apps/redeliver-webhook-delivery"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installation-requests": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ - readonly get: operations["apps/list-installation-requests-for-authenticated-app"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List installations for the authenticated app @@ -235,21 +235,21 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/list-installations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations/{installation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an installation for the authenticated app @@ -257,30 +257,30 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-installation"]; - readonly put?: never; - readonly post?: never; + get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly delete: operations["apps/delete-installation"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations/{installation_id}/access_tokens": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. @@ -291,99 +291,99 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly post: operations["apps/create-installation-access-token"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations/{installation_id}/suspended": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * @description Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly put: operations["apps/suspend-installation"]; - readonly post?: never; + put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly delete: operations["apps/unsuspend-installation"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/applications/{client_id}/grant": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - readonly delete: operations["apps/delete-authorization"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/applications/{client_id}/token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ - readonly post: operations["apps/check-token"]; + post: operations["apps/check-token"]; /** * Delete an app token * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ - readonly delete: operations["apps/delete-token"]; - readonly options?: never; - readonly head?: never; + delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ - readonly patch: operations["apps/reset-token"]; - readonly trace?: never; + patch: operations["apps/reset-token"]; + trace?: never; }; - readonly "/applications/{client_id}/token/scoped": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify @@ -392,220 +392,312 @@ export type paths = { * * Invalid tokens will return `404 NOT FOUND`. */ - readonly post: operations["apps/scope-token"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/apps/{app_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an app * @description > [!NOTE] * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ - readonly get: operations["apps/get-by-slug"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/assignments/{assignment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/assignments/{assignment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an assignment * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - readonly get: operations["classroom/get-an-assignment"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/get-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/assignments/{assignment_id}/accepted_assignments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/assignments/{assignment_id}/accepted_assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * 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-assignments-for-an-assignment"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/list-accepted-assignments-for-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/assignments/{assignment_id}/grades": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/assignments/{assignment_id}/grades": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get assignment grades * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - readonly get: operations["classroom/get-assignment-grades"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/get-assignment-grades"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/classrooms": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/classrooms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List classrooms * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. */ - readonly get: operations["classroom/list-classrooms"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/list-classrooms"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/classrooms/{classroom_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/classrooms/{classroom_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a classroom * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. */ - readonly get: operations["classroom/get-a-classroom"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/get-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/classrooms/{classroom_id}/assignments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/classrooms/{classroom_id}/assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List assignments for a classroom * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. */ - readonly get: operations["classroom/list-assignments-for-a-classroom"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/list-assignments-for-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/codes_of_conduct": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ - readonly get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/codes_of_conduct/{key}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ - readonly get: operations["codes-of-conduct/get-conduct-code"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/emojis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Revoke a list of credentials + * @description Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + * + * This endpoint currently accepts the following credential types: + * - Personal access tokens (classic) + * - Fine-grained personal access tokens + * + * Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + * GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + * + * To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + * + * > [!NOTE] + * > Any authenticated requests will return a 403. + */ + post: operations["credentials/revoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get emojis * @description Lists all the emojis available to use on GitHub. */ - readonly get: operations["emojis/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an enterprise + * @description Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-enterprise"]; + /** + * Set GitHub Actions cache retention limit for an enterprise + * @description Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an enterprise + * @description Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-enterprise"]; + /** + * Set GitHub Actions cache storage limit for an enterprise + * @description Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get code security configurations for an enterprise @@ -615,8 +707,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-configurations-for-enterprise"]; - readonly put?: never; + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; /** * Create a code security configuration for an enterprise * @description Creates a code security configuration in an enterprise. @@ -625,19 +717,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly post: operations["code-security/create-configuration-for-enterprise"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/create-configuration-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default code security configurations for an enterprise @@ -647,21 +739,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-default-configurations-for-enterprise"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-default-configurations-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Retrieve a code security configuration of an enterprise @@ -671,9 +763,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-single-configuration-for-enterprise"]; - readonly put?: never; - readonly post?: never; + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; /** * Delete a code security configuration for an enterprise * @description Deletes a code security configuration from an enterprise. @@ -684,9 +776,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly delete: operations["code-security/delete-configuration-for-enterprise"]; - readonly options?: never; - readonly head?: never; + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; /** * Update a custom code security configuration for an enterprise * @description Updates a code security configuration in an enterprise. @@ -695,18 +787,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly patch: operations["code-security/update-enterprise-configuration"]; - readonly trace?: never; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Attach an enterprise configuration to repositories * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. @@ -717,21 +809,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly post: operations["code-security/attach-enterprise-configuration"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/attach-enterprise-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Set a code security configuration as a default for an enterprise * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. @@ -742,20 +834,20 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly put: operations["code-security/set-configuration-as-default-for-enterprise"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repositories associated with an enterprise code security configuration @@ -765,21 +857,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-repositories-for-enterprise-configuration"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/dependabot/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List Dependabot alerts for an enterprise @@ -791,68 +883,272 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - readonly get: operations["dependabot/list-alerts-for-enterprise"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List enterprise teams + * @description List all teams in the enterprise for the authenticated user + */ + get: operations["enterprise-teams/list"]; + put?: never; + /** + * Create an enterprise team + * @description To create an enterprise team, the authenticated user must be an owner of the enterprise. + */ + post: operations["enterprise-teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members in an enterprise team + * @description Lists all team members in an enterprise team. + */ + get: operations["enterprise-team-memberships/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk add team members + * @description Add multiple team members to an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk remove team members + * @description Remove multiple team members from an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get enterprise team membership + * @description Returns whether the user is a member of the enterprise team. + */ + get: operations["enterprise-team-memberships/get"]; + /** + * Add team member + * @description Add a team member to an enterprise team. + */ + put: operations["enterprise-team-memberships/add"]; + post?: never; + /** + * Remove team membership + * @description Remove membership of a specific user from a particular team in an enterprise. + */ + delete: operations["enterprise-team-memberships/remove"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignments + * @description Get all organizations assigned to an enterprise team + */ + get: operations["enterprise-team-organizations/get-assignments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add organization assignments + * @description Assign an enterprise team to multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/secret-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Remove organization assignments + * @description Unassign an enterprise team from multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * Get organization assignment + * @description Check if an enterprise team is assigned to an organization + */ + get: operations["enterprise-team-organizations/get-assignment"]; + /** + * Add an organization assignment + * @description Assign an enterprise team to an organization. + */ + put: operations["enterprise-team-organizations/add"]; + post?: never; + /** + * Delete an organization assignment + * @description Unassign an enterprise team from an organization. + */ + delete: operations["enterprise-team-organizations/delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an enterprise team + * @description Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. + */ + get: operations["enterprise-teams/get"]; + put?: never; + post?: never; + /** + * Delete an enterprise team + * @description To delete an enterprise team, the authenticated user must be an enterprise owner. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + */ + delete: operations["enterprise-teams/delete"]; + options?: never; + head?: never; + /** + * Update an enterprise team + * @description To edit a team, the authenticated user must be an enterprise owner. */ - readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + patch: operations["enterprise-teams/update"]; + trace?: never; }; - readonly "/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/feeds": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get feeds @@ -871,28 +1167,28 @@ export type paths = { * > [!NOTE] * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - readonly get: operations["activity/get-feeds"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - readonly get: operations["gists/list"]; - readonly put?: never; + get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. @@ -900,19 +1196,19 @@ export type paths = { * > [!NOTE] * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - readonly post: operations["gists/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/public": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public gists @@ -920,41 +1216,41 @@ export type paths = { * * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - readonly get: operations["gists/list-public"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List starred gists * @description List the authenticated user's starred gists: */ - readonly get: operations["gists/list-starred"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/{gist_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gist @@ -965,13 +1261,13 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/get"]; - readonly put?: never; - readonly post?: never; + get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ - readonly delete: operations["gists/delete"]; - readonly options?: never; - readonly head?: never; + delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files @@ -985,15 +1281,15 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly patch: operations["gists/update"]; - readonly trace?: never; + patch: operations["gists/update"]; + trace?: never; }; - readonly "/gists/{gist_id}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List gist comments @@ -1004,8 +1300,8 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/list-comments"]; - readonly put?: never; + get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. @@ -1015,19 +1311,19 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly post: operations["gists/create-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/{gist_id}/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gist comment @@ -1038,13 +1334,13 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/get-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ - readonly delete: operations["gists/delete-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. @@ -1054,72 +1350,72 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly patch: operations["gists/update-comment"]; - readonly trace?: never; + patch: operations["gists/update-comment"]; + trace?: never; }; - readonly "/gists/{gist_id}/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List gist commits */ - readonly get: operations["gists/list-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/gists/{gist_id}/forks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List gist forks */ - readonly get: operations["gists/list-forks"]; - readonly put?: never; + get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ - readonly post: operations["gists/fork"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/gists/{gist_id}/star": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Check if a gist is starred */ - readonly get: operations["gists/check-is-starred"]; + get: operations["gists/check-is-starred"]; /** * Star a gist * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["gists/star"]; - readonly post?: never; + put: operations["gists/star"]; + post?: never; /** Unstar a gist */ - readonly delete: operations["gists/unstar"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/{gist_id}/{sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gist revision @@ -1130,41 +1426,41 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/get-revision"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gitignore/templates": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ - readonly get: operations["gitignore/get-all-templates"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gitignore/templates/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gitignore template @@ -1174,63 +1470,63 @@ export type paths = { * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ - readonly get: operations["gitignore/get-template"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/installation/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ - readonly get: operations["apps/list-repos-accessible-to-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/installation/token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ - readonly delete: operations["apps/revoke-installation-access-token"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issues assigned to the authenticated user @@ -1248,98 +1544,101 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/licenses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ - readonly get: operations["licenses/get-all-commonly-used"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/licenses/{license}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ - readonly get: operations["licenses/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/markdown": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** Render a Markdown document */ - readonly post: operations["markdown/render"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/markdown/raw": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Render a Markdown document + * @description Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + */ + post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - readonly post: operations["markdown/render-raw"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/accounts/{account_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a subscription plan for an account @@ -1347,21 +1646,21 @@ export type paths = { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/get-subscription-plan-for-account"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-subscription-plan-for-account"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/plans": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List plans @@ -1369,21 +1668,21 @@ export type paths = { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-plans"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-plans"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/plans/{plan_id}/accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List accounts for a plan @@ -1391,21 +1690,21 @@ export type paths = { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-accounts-for-plan"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-accounts-for-plan"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/stubbed/accounts/{account_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/stubbed/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a subscription plan for an account (stubbed) @@ -1413,21 +1712,21 @@ export type paths = { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/get-subscription-plan-for-account-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-subscription-plan-for-account-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/stubbed/plans": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/stubbed/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List plans (stubbed) @@ -1435,21 +1734,21 @@ export type paths = { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-plans-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-plans-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List accounts for a plan (stubbed) @@ -1457,21 +1756,21 @@ export type paths = { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-accounts-for-plan-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-accounts-for-plan-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/meta": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub meta information @@ -1484,94 +1783,94 @@ export type paths = { * > [!NOTE] * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ - readonly get: operations["meta/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/networks/{owner}/{repo}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events for a network of repositories * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-events-for-repo-network"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/notifications": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. */ - readonly get: operations["activity/list-notifications-for-authenticated-user"]; + get: operations["activity/list-notifications-for-authenticated-user"]; /** * Mark notifications as read * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly put: operations["activity/mark-notifications-as-read"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/notifications/threads/{thread_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a thread * @description Gets information about a notification thread. */ - readonly get: operations["activity/get-thread"]; - readonly put?: never; - readonly post?: never; + get: operations["activity/get-thread"]; + put?: never; + post?: never; /** * Mark a thread as done * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. */ - readonly delete: operations["activity/mark-thread-as-done"]; - readonly options?: never; - readonly head?: never; + delete: operations["activity/mark-thread-as-done"]; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications. */ - readonly patch: operations["activity/mark-thread-as-read"]; - readonly trace?: never; + patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; - readonly "/notifications/threads/{thread_id}/subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a thread subscription for the authenticated user @@ -1579,7 +1878,7 @@ export type paths = { * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - readonly get: operations["activity/get-thread-subscription-for-authenticated-user"]; + get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. @@ -1588,44 +1887,44 @@ export type paths = { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ - readonly put: operations["activity/set-thread-subscription"]; - readonly post?: never; + put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - readonly delete: operations["activity/delete-thread-subscription"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/octocat": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Octocat * @description Get the octocat as ASCII art */ - readonly get: operations["meta/get-octocat"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/organizations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organizations @@ -1634,21 +1933,228 @@ export type paths = { * > [!NOTE] * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ - readonly get: operations["orgs/list"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an organization + * @description Gets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-organization"]; + /** + * Set GitHub Actions cache retention limit for an organization + * @description Sets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an organization + * @description Gets GitHub Actions cache storage limit for an organization. All repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-organization"]; + /** + * Set GitHub Actions cache storage limit for an organization + * @description Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists the repositories Dependabot can access in an organization + * @description Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + */ + get: operations["dependabot/repository-access-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Updates Dependabot's repository access list for an organization + * @description Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + * + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + * + * **Example request body:** + * ```json + * { + * "repository_ids_to_add": [123, 456], + * "repository_ids_to_remove": [789] + * } + * ``` + */ + patch: operations["dependabot/update-repository-access-for-org"]; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access/default-level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set the default repository access level for Dependabot + * @description Sets the default level of repository access Dependabot will have while performing an update. Available values are: + * - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + * - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + * + * Unauthorized users will not see the existence of this endpoint. + * + * This operation supports both server-to-server and user-to-server access. + */ + put: operations["dependabot/set-repository-access-default-level"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all budgets for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-all-budgets-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a budget by ID for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-budget-org"]; + put?: never; + post?: never; + /** + * Delete a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + */ + delete: operations["billing/delete-budget-org"]; + options?: never; + head?: never; + /** + * Update a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + */ + patch: operations["billing/update-budget-org"]; + trace?: never; }; - readonly "/organizations/{org}/settings/billing/usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/organizations/{org}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for an organization + * @description Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get billing usage report for an organization @@ -1656,27 +2162,52 @@ export type paths = { * * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." */ - readonly get: operations["billing/get-github-billing-usage-report-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-usage-summary-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * @@ -1684,9 +2215,9 @@ export type paths = { * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ - readonly get: operations["orgs/get"]; - readonly put?: never; - readonly post?: never; + get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. @@ -1697,9 +2228,9 @@ export type paths = { * * https://docs.github.com/site-policy/github-terms/github-terms-of-service */ - readonly delete: operations["orgs/delete"]; - readonly options?: never; - readonly head?: never; + delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @description > [!WARNING] @@ -1714,15 +2245,15 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ - readonly patch: operations["orgs/update"]; - readonly trace?: never; + patch: operations["orgs/update"]; + trace?: never; }; - readonly "/orgs/{org}/actions/cache/usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions cache usage for an organization @@ -1731,21 +2262,21 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-usage-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/cache/usage-by-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories with GitHub Actions cache usage for an organization @@ -1754,21 +2285,21 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub-hosted runners for an organization @@ -1776,126 +2307,226 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. */ - readonly get: operations["actions/list-hosted-runners-for-org"]; - readonly put?: never; + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; /** * Create a GitHub-hosted runner for an organization * @description Creates a GitHub-hosted runner for an organization. * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. */ - readonly post: operations["actions/create-hosted-runner-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List custom images for an organization + * @description List custom images for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a custom image definition for GitHub Actions Hosted Runners + * @description Get a custom image definition for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-for-org"]; + put?: never; + post?: never; + /** + * Delete a custom image from the organization + * @description Delete a custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/images/github-owned": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List image versions of a custom image for an organization + * @description List image versions of a custom image for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-image-versions-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an image version of a custom image for GitHub Actions Hosted Runners + * @description Get an image version of a custom image for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-version-for-org"]; + put?: never; + post?: never; + /** + * Delete an image version of custom image from the organization + * @description Delete an image version of custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-version-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub-owned images for GitHub-hosted runners in an organization * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/images/partner": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get partner images for GitHub-hosted runners in an organization * @description Get the list of partner images available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-partner-images-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get limits on GitHub-hosted runners for an organization * @description Get the GitHub-hosted runners limits for an organization. */ - readonly get: operations["actions/get-hosted-runners-limits-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/machine-sizes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub-hosted runners machine specs for an organization * @description Get the list of machine specs available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-machine-specs-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/platforms": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get platforms for GitHub-hosted runners in an organization * @description Get the list of platforms available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-platforms-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a GitHub-hosted runner for an organization @@ -1903,30 +2534,30 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. */ - readonly get: operations["actions/get-hosted-runner-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a GitHub-hosted runner for an organization * @description Deletes a GitHub-hosted runner for an organization. */ - readonly delete: operations["actions/delete-hosted-runner-for-org"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; /** * Update a GitHub-hosted runner for an organization * @description Updates a GitHub-hosted runner for an organization. * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. */ - readonly patch: operations["actions/update-hosted-runner-for-org"]; - readonly trace?: never; + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/actions/oidc/customization/sub": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the customization template for an OIDC subject claim for an organization @@ -1934,27 +2565,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["oidc/get-oidc-custom-sub-template-for-org"]; + get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly put: operations["oidc/update-oidc-custom-sub-template-for-org"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions permissions for an organization @@ -1962,27 +2593,107 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-permissions-organization"]; + get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-permissions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for an organization + * @description Gets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-organization"]; + /** + * Set artifact and log retention settings for an organization + * @description Sets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for an organization + * @description Gets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-organization"]; + /** + * Set fork PR contributor approval permissions for an organization + * @description Sets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for an organization + * @description Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-organization"]; + /** + * Set private repo fork PR workflow settings for an organization + * @description Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories enabled for GitHub Actions in an organization @@ -1990,7 +2701,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." @@ -1998,48 +2709,48 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/enable-selected-repository-github-actions-organization"]; - readonly post?: never; + put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/disable-selected-repository-github-actions-organization"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/selected-actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get allowed actions and reusable workflows for an organization @@ -2047,27 +2758,111 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-allowed-actions-organization"]; + get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-allowed-actions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get self-hosted runners settings for an organization + * @description Gets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-self-hosted-runners-permissions-organization"]; + /** + * Set self-hosted runners settings for an organization + * @description Sets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repositories allowed to use self-hosted runners in an organization + * @description Lists repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/list-selected-repositories-self-hosted-runners-organization"]; + /** + * Set repositories allowed to use self-hosted runners in an organization + * @description Sets repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-selected-repositories-self-hosted-runners-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a repository to the list of repositories allowed to use self-hosted runners in an organization + * @description Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/enable-selected-repository-self-hosted-runners-organization"]; + post?: never; + /** + * Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + * @description Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + delete: operations["actions/disable-selected-repository-self-hosted-runners-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default workflow permissions for an organization @@ -2077,7 +2872,7 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions @@ -2086,20 +2881,20 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runner-groups": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List self-hosted runner groups for an organization @@ -2107,27 +2902,27 @@ export type paths = { * * 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; + 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. */ - 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; + post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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 @@ -2135,33 +2930,33 @@ export type paths = { * * 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; + 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. */ - readonly delete: operations["actions/delete-self-hosted-runner-group-from-org"]; - readonly options?: never; - readonly head?: never; + 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. */ - readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; - readonly trace?: never; + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub-hosted runners in a group for an organization @@ -2169,21 +2964,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-github-hosted-runners-in-group-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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 @@ -2191,55 +2986,55 @@ export type paths = { * * 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"]; + 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; + 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; }; - 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; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: 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. */ - readonly put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; - readonly post?: never; + 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. */ - 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; + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + 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; + "/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 @@ -2247,55 +3042,55 @@ export type paths = { * * 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"]; + 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; + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: 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. */ - readonly put: operations["actions/add-self-hosted-runner-to-group-for-org"]; - readonly post?: never; + 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. */ - readonly delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List self-hosted runners for an organization @@ -2305,21 +3100,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-self-hosted-runners-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/downloads": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List runner applications for an organization @@ -2329,24 +3124,24 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-runner-applications-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/actions/runners/generate-jitconfig": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. @@ -2355,22 +3150,22 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/generate-runner-jitconfig-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/generate-runner-jitconfig-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/registration-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -2385,22 +3180,22 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-registration-token-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/remove-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. @@ -2415,19 +3210,19 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-remove-token-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/{runner_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a self-hosted runner for an organization @@ -2437,9 +3232,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/get-self-hosted-runner-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. @@ -2448,18 +3243,18 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-from-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/{runner_id}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for a self-hosted runner for an organization @@ -2469,7 +3264,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific @@ -2479,7 +3274,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. @@ -2488,7 +3283,7 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an @@ -2498,22 +3293,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured @@ -2526,18 +3321,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization secrets @@ -2548,21 +3343,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-org-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization public key @@ -2573,21 +3368,21 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization secret @@ -2597,7 +3392,7 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-org-secret"]; + get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using @@ -2607,8 +3402,8 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/create-or-update-org-secret"]; - readonly post?: never; + put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. @@ -2617,18 +3412,18 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization secret @@ -2639,7 +3434,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-selected-repos-for-org-secret"]; + get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` @@ -2650,22 +3445,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly put: operations["actions/set-selected-repos-for-org-secret"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for @@ -2676,8 +3471,8 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/add-selected-repo-to-org-secret"]; - readonly post?: never; + put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` @@ -2688,18 +3483,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-selected-repo-from-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization variables @@ -2709,8 +3504,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-org-variables"]; - readonly put?: never; + get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. @@ -2719,19 +3514,19 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-org-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization variable @@ -2741,9 +3536,9 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-org-variable"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. @@ -2752,9 +3547,9 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-org-variable"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. @@ -2763,15 +3558,15 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly patch: operations["actions/update-org-variable"]; - readonly trace?: never; + patch: operations["actions/update-org-variable"]; + trace?: never; }; - readonly "/orgs/{org}/actions/variables/{name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization variable @@ -2782,7 +3577,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-selected-repos-for-org-variable"]; + get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @description Replaces all repositories for an organization variable that is available @@ -2793,22 +3588,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly put: operations["actions/set-selected-repos-for-org-variable"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization variable * @description Adds a repository to an organization variable that is available to selected repositories. @@ -2818,8 +3613,8 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/add-selected-repo-to-org-variable"]; - readonly post?: never; + put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @description Removes a repository from an organization variable that is @@ -2830,18 +3625,242 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-selected-repo-from-org-variable"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/attestations/{subject_digest}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an artifact deployment record + * @description Create or update deployment records for an artifact associated + * with an organization. + * This endpoint allows you to record information about a specific + * artifact, such as its name, digest, environments, cluster, and + * deployment. + * The deployment name has to be uniqe within a cluster (i.e a + * combination of logical, physical environment and cluster) as it + * identifies unique deployment. + * Multiple requests for the same combination of logical, physical + * environment, cluster and deployment name will only create one + * record, successive request will update the existing record. + * This allows for a stable tracking of a deployment where the actual + * deployed artifact can change over time. + */ + post: operations["orgs/create-artifact-deployment-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Set cluster deployment records + * @description Set deployment records for a given cluster. + * If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + * 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + * If no existing records match, new records will be created. + */ + post: operations["orgs/set-cluster-deployment-records"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/storage-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create artifact metadata storage record + * @description Create metadata storage records for artifacts associated with an organization. + * This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + * associated with a repository owned by the organization. + */ + post: operations["orgs/create-artifact-storage-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact deployment records + * @description List deployment records for an artifact metadata associated with an organization. + */ + get: operations["orgs/list-artifact-deployment-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact storage records + * @description List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + */ + get: operations["orgs/list-artifact-storage-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["orgs/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["orgs/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["orgs/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestation repositories + * @description List repositories owned by the provided organization that have created at least one attested artifact + * Results will be sorted in ascending order by repository ID + */ + get: operations["orgs/list-attestation-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + */ + delete: operations["orgs/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List attestations @@ -2851,69 +3870,144 @@ export type paths = { * * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly get: operations["orgs/list-attestations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/blocks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users blocked by an organization * @description List the users blocked by an organization. */ - readonly get: operations["orgs/list-blocked-users"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-blocked-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/blocks/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user is blocked by an organization * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. */ - readonly get: operations["orgs/check-blocked-user"]; + get: operations["orgs/check-blocked-user"]; /** * Block a user from an organization * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. */ - readonly put: operations["orgs/block-user"]; - readonly post?: never; + put: operations["orgs/block-user"]; + post?: never; /** * Unblock a user from an organization * @description Unblocks the given user on behalf of the specified organization. */ - readonly delete: operations["orgs/unblock-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/unblock-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List campaigns for an organization + * @description Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/list-org-campaigns"]; + put?: never; + /** + * Create a campaign for an organization + * @description Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + post: operations["campaigns/create-campaign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns/{campaign_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a campaign for an organization + * @description Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/get-campaign-summary"]; + put?: never; + post?: never; + /** + * Delete a campaign for an organization + * @description Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + delete: operations["campaigns/delete-campaign"]; + options?: never; + head?: never; + /** + * Update a campaign + * @description Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + patch: operations["campaigns/update-campaign"]; + trace?: never; }; - readonly "/orgs/{org}/code-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List code scanning alerts for an organization @@ -2923,21 +4017,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly get: operations["code-scanning/list-alerts-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get code security configurations for an organization @@ -2945,10 +4039,10 @@ export type paths = { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-configurations-for-org"]; - readonly put?: never; + get: operations["code-security/get-configurations-for-org"]; + put?: never; /** * Create a code security configuration * @description Creates a code security configuration in an organization. @@ -2957,19 +4051,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly post: operations["code-security/create-configuration"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/create-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default code security configurations @@ -2977,27 +4071,27 @@ export type paths = { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-default-configurations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/code-security/configurations/detach": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["code-security/get-default-configurations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/detach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Detach configurations from repositories * @description Detach code security configuration(s) from a set of repositories. @@ -3007,18 +4101,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly delete: operations["code-security/detach-configuration"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["code-security/detach-configuration"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code security configuration @@ -3028,9 +4122,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-configuration"]; - readonly put?: never; - readonly post?: never; + get: operations["code-security/get-configuration"]; + put?: never; + post?: never; /** * Delete a code security configuration * @description Deletes the desired code security configuration from an organization. @@ -3041,9 +4135,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly delete: operations["code-security/delete-configuration"]; - readonly options?: never; - readonly head?: never; + delete: operations["code-security/delete-configuration"]; + options?: never; + head?: never; /** * Update a code security configuration * @description Updates a code security configuration in an organization. @@ -3052,18 +4146,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly patch: operations["code-security/update-configuration"]; - readonly trace?: never; + patch: operations["code-security/update-configuration"]; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Attach a configuration to repositories * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. @@ -3074,21 +4168,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly post: operations["code-security/attach-configuration"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/attach-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Set a code security configuration as a default for an organization * @description Sets a code security configuration as a default to be applied to new repositories in your organization. @@ -3099,20 +4193,20 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly put: operations["code-security/set-configuration-as-default"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["code-security/set-configuration-as-default"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repositories associated with a code security configuration @@ -3120,23 +4214,23 @@ export type paths = { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-repositories-for-configuration"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-repositories-for-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces for the organization @@ -3144,46 +4238,46 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/list-in-organization"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-in-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/set-codespaces-access"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["codespaces/set-codespaces-access"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/access/selected_users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/access/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Add users to Codespaces access for an organization * @deprecated @@ -3194,7 +4288,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["codespaces/set-codespaces-access-users"]; + post: operations["codespaces/set-codespaces-access-users"]; /** * Remove users from Codespaces access for an organization * @deprecated @@ -3205,18 +4299,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-codespaces-access-users"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-codespaces-access-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization secrets @@ -3225,42 +4319,42 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/list-org-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization public key * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization secret @@ -3268,7 +4362,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/get-org-secret"]; + get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using @@ -3276,26 +4370,26 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/create-or-update-org-secret"]; - readonly post?: never; + put: operations["codespaces/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes an organization development environment secret using the secret name. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization secret @@ -3304,7 +4398,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/list-selected-repos-for-org-secret"]; + get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization development environment secret when the `visibility` @@ -3313,29 +4407,29 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/set-selected-repos-for-org-secret"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["codespaces/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/add-selected-repo-to-org-secret"]; - readonly post?: never; + put: operations["codespaces/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization development environment secret when the `visibility` @@ -3344,18 +4438,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/billing": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/billing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Copilot seat information and settings for an organization @@ -3370,21 +4464,21 @@ export type paths = { * * 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/get-copilot-organization-details"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/get-copilot-organization-details"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/billing/seats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/billing/seats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List all Copilot seat assignments for an organization @@ -3395,28 +4489,28 @@ export type paths = { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * 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"]; - 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/billing/selected_teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["copilot/list-copilot-seats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/copilot/billing/selected_teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] @@ -3433,7 +4527,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ - readonly post: operations["copilot/add-copilot-seats-for-teams"]; + post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] @@ -3449,21 +4543,21 @@ export type paths = { * * 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"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/billing/selected_users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/billing/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] @@ -3480,7 +4574,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ - readonly post: operations["copilot/add-copilot-seats-for-users"]; + post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] @@ -3496,83 +4590,100 @@ export type paths = { * * 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"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/metrics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/content_exclusion": { + 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. + * Get Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * > [!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. + * Gets information about an organization's Copilot content exclusion path rules. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." * - * 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. + * Organization owners can view details about Copilot content exclusion rules for the organization. * - * 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 `copilot` or `read:org` scopes to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + * > [!CAUTION] + * > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + * > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. */ - 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; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; + get: operations["copilot/copilot-content-exclusion-for-organization"]; /** - * Get a summary of Copilot usage for organization members + * Set Copilot content exclusion rules for an organization * @description > [!NOTE] * > 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. - * See the response schema tab for detailed metrics definitions. + * Sets Copilot content exclusion path rules for an organization. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + * + * Organization owners can set Copilot content exclusion rules for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + * + * > [!CAUTION] + * > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + * > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + */ + put: operations["copilot/set-copilot-content-exclusion-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + 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. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 100 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. * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + * 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/usage-metrics-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/copilot-metrics-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List Dependabot alerts for an organization @@ -3582,21 +4693,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["dependabot/list-alerts-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization secrets @@ -3605,21 +4716,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/list-org-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization public key @@ -3628,21 +4739,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization secret @@ -3650,7 +4761,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/get-org-secret"]; + get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using @@ -3658,26 +4769,26 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["dependabot/create-or-update-org-secret"]; - readonly post?: never; + put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["dependabot/delete-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization secret @@ -3686,7 +4797,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/list-selected-repos-for-org-secret"]; + get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` @@ -3695,22 +4806,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["dependabot/set-selected-repos-for-org-secret"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for @@ -3719,8 +4830,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["dependabot/add-selected-repo-to-org-secret"]; - readonly post?: never; + put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` @@ -3729,18 +4840,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/docker/conflicts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get list of conflicting packages during Docker migration for organization @@ -3748,62 +4859,62 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ - readonly get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public organization events * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-org-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/failed_invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/failed_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List failed organization invitations * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - readonly get: operations["orgs/list-failed-invitations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-failed-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization webhooks @@ -3814,8 +4925,8 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/list-webhooks"]; - readonly put?: never; + get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Create a hook that posts payloads in JSON format. @@ -3825,19 +4936,19 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly post: operations["orgs/create-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization webhook @@ -3849,9 +4960,9 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/get-webhook"]; - readonly put?: never; - readonly post?: never; + get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description Delete a webhook for an organization. @@ -3861,9 +4972,9 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly delete: operations["orgs/delete-webhook"]; - readonly options?: never; - readonly head?: never; + delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, @@ -3877,15 +4988,15 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly patch: operations["orgs/update-webhook"]; - readonly trace?: never; + patch: operations["orgs/update-webhook"]; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/config": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook configuration for an organization @@ -3896,12 +5007,12 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/get-webhook-config-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." @@ -3911,15 +5022,15 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly patch: operations["orgs/update-webhook-config-for-org"]; - readonly trace?: never; + patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deliveries for an organization webhook @@ -3930,21 +5041,21 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/list-webhook-deliveries"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook delivery for an organization webhook @@ -3955,24 +5066,24 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/get-webhook-delivery"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. @@ -3982,22 +5093,22 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly post: operations["orgs/redeliver-webhook-delivery"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/pings": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) @@ -4008,199 +5119,199 @@ export type paths = { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly post: operations["orgs/ping-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-route-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/insights/api/subject-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: 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. */ - 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; + get: operations["api-insights/get-subject-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/insights/api/summary-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: 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. */ - 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; + get: operations["api-insights/get-summary-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-summary-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-summary-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/insights/api/time-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: 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. */ - 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; + get: operations["api-insights/get-time-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-time-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-time-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization installation for the authenticated app @@ -4208,21 +5319,21 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-org-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/installations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List app installations for an organization @@ -4233,49 +5344,49 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ - readonly get: operations["orgs/list-app-installations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/interaction-limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get interaction restrictions for an organization * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - readonly get: operations["interactions/get-restrictions-for-org"]; + get: operations["interactions/get-restrictions-for-org"]; /** * Set interaction restrictions for an organization * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - readonly put: operations["interactions/set-restrictions-for-org"]; - readonly post?: never; + put: operations["interactions/set-restrictions-for-org"]; + post?: never; /** * Remove interaction restrictions for an organization * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - readonly delete: operations["interactions/remove-restrictions-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["interactions/remove-restrictions-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pending organization invitations @@ -4284,8 +5395,8 @@ export type paths = { * `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub * member, the `login` field in the return hash will be `null`. */ - readonly get: operations["orgs/list-pending-invitations"]; - readonly put?: never; + get: operations["orgs/list-pending-invitations"]; + put?: never; /** * Create an organization invitation * @description Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. @@ -4293,61 +5404,124 @@ export type paths = { * 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)." */ - readonly post: operations["orgs/create-invitation"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/create-invitation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/invitations/{invitation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Cancel an organization invitation * @description Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - readonly delete: operations["orgs/cancel-invitation"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/cancel-invitation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/invitations/{invitation_id}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/invitations/{invitation_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization invitation teams * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - readonly get: operations["orgs/list-invitation-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-invitation-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/issue-types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + */ + get: operations["orgs/list-issue-types"]; + put?: never; + /** + * Create issue type for an organization + * @description Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-issue-type"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update issue type for an organization + * @description Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/update-issue-type"]; + post?: never; + /** + * Delete issue type for an organization + * @description Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-issue-type"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization issues assigned to the authenticated user @@ -4363,65 +5537,68 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - readonly get: operations["orgs/list-members"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ - readonly get: operations["orgs/check-membership-for-user"]; - readonly put?: never; - readonly post?: never; + get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ - readonly delete: operations["orgs/remove-member"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces for a user in organization @@ -4429,65 +5606,65 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/get-codespaces-for-user-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["codespaces/get-codespaces-for-user-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a codespace from the organization * @description Deletes a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-from-organization"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-from-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Stop a codespace for an organization user * @description Stops a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["codespaces/stop-in-organization"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/stop-in-organization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}/copilot": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}/copilot": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Copilot seat assignment details for a user @@ -4497,33 +5674,33 @@ export type paths = { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * Only organization owners can view Copilot seat assignment details for members of their organization. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ - readonly get: operations["copilot/get-copilot-seat-details-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/get-copilot-seat-details-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/memberships/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - readonly get: operations["orgs/get-membership-for-user"]; + get: operations["orgs/get-membership-for-user"]; /** * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. @@ -4536,26 +5713,29 @@ export type paths = { * * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - readonly put: operations["orgs/set-membership-for-user"]; - readonly post?: never; + put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ - readonly delete: operations["orgs/remove-membership-for-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization migrations @@ -4563,25 +5743,25 @@ export type paths = { * * A list of `repositories` is only returned for export migrations. */ - readonly get: operations["migrations/list-for-org"]; - readonly put?: never; + get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. */ - readonly post: operations["migrations/start-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization migration status @@ -4594,85 +5774,85 @@ export type paths = { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - readonly get: operations["migrations/get-status-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}/archive": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ - readonly get: operations["migrations/download-archive-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - readonly delete: operations["migrations/delete-archive-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - readonly delete: operations["migrations/unlock-repo-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ - readonly get: operations["migrations/list-repos-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all organization roles for an organization @@ -4685,25 +5865,25 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/list-org-roles"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/organization-roles/teams/{team_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["orgs/list-org-roles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a team * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4712,20 +5892,20 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-all-org-roles-team"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-all-org-roles-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Assign an organization role to a team * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4734,8 +5914,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["orgs/assign-team-to-org-role"]; - readonly post?: never; + put: operations["orgs/assign-team-to-org-role"]; + post?: never; /** * Remove an organization role from a team * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4744,22 +5924,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-org-role-team"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-org-role-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/users/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a user * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4768,20 +5948,20 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-all-org-roles-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-all-org-roles-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/users/{username}/{role_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Assign an organization role to a user * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4790,8 +5970,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["orgs/assign-user-to-org-role"]; - readonly post?: never; + put: operations["orgs/assign-user-to-org-role"]; + post?: never; /** * Remove an organization role from a user * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4800,18 +5980,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-org-role-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-org-role-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/{role_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization role @@ -4824,21 +6004,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/get-org-role"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/get-org-role"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/{role_id}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/{role_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List teams that are assigned to an organization role @@ -4848,21 +6028,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/list-org-role-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-org-role-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/{role_id}/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/{role_id}/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users that are assigned to an organization role @@ -4872,65 +6052,65 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/list-org-role-users"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-org-role-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/outside_collaborators": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ - readonly get: operations["orgs/list-outside-collaborators"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/outside_collaborators/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Convert an organization member to outside collaborator * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - readonly put: operations["orgs/convert-member-to-outside-collaborator"]; - readonly post?: never; + put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ - readonly delete: operations["orgs/remove-outside-collaborator"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List packages for an organization @@ -4938,21 +6118,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package for an organization @@ -4960,9 +6140,9 @@ export type paths = { * * 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; - readonly post?: never; + get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. @@ -4971,21 +6151,21 @@ export type paths = { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. @@ -4998,19 +6178,19 @@ export type paths = { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List package versions for a package owned by an organization @@ -5018,21 +6198,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package version for an organization @@ -5040,9 +6220,9 @@ export type paths = { * * 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; - readonly post?: never; + get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. @@ -5051,21 +6231,21 @@ export type paths = { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. @@ -5078,19 +6258,19 @@ export type paths = { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-token-requests": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-token-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List requests to access organization resources with fine-grained personal access tokens @@ -5098,49 +6278,49 @@ export type paths = { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grant-requests"]; - readonly put?: never; + get: operations["orgs/list-pat-grant-requests"]; + put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/review-pat-grant-requests-in-bulk"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/review-pat-grant-requests-in-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Review a request to access organization resources with a fine-grained personal access token * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/review-pat-grant-request"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/review-pat-grant-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories requested to be accessed by a fine-grained personal access token @@ -5148,21 +6328,21 @@ export type paths = { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grant-request-repositories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-pat-grant-request-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-tokens": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List fine-grained personal access tokens with access to organization resources @@ -5170,49 +6350,49 @@ export type paths = { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grants"]; - readonly put?: never; + get: operations["orgs/list-pat-grants"]; + put?: never; /** * Update the access to organization resources via fine-grained personal access tokens * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/update-pat-accesses"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/update-pat-accesses"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-tokens/{pat_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-tokens/{pat_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Update the access a fine-grained personal access token has to organization resources * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/update-pat-access"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/update-pat-access"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories a fine-grained personal access token has access to @@ -5220,184 +6400,342 @@ export type paths = { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grant-repositories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-pat-grant-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/private-registries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List private registries for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Lists all private registry configurations available at the organization-level without revealing their encrypted + * @description Lists all private registry configurations available at the organization-level without revealing their encrypted * values. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["private-registries/list-org-private-registries"]; - readonly put?: never; + get: operations["private-registries/list-org-private-registries"]; + put?: never; /** * Create a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["private-registries/create-org-private-registry"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/private-registries/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get private registries public key for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * @description Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["private-registries/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/private-registries/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * @description Get the configuration of a single private registry defined for an organization, omitting its encrypted value. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["private-registries/get-org-private-registry"]; - readonly put?: never; - readonly post?: never; + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; /** * Delete a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Delete a private registry configuration at the organization-level. + * @description Delete a private registry configuration at the organization-level. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["private-registries/delete-org-private-registry"]; - readonly options?: never; - readonly head?: never; + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; /** * Update a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly patch: operations["private-registries/update-org-private-registry"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly get: operations["projects/list-for-org"]; - readonly put?: never; + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; + "/orgs/{org}/projectsV2": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List projects for organization + * @description List all projects owned by a specific organization accessible by the authenticated user. + */ + get: operations["projects/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for organization + * @description Get a specific organization-owned project. + */ + get: operations["projects/get-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for organization owned project + * @description Create draft issue item for the specified organization owned project. + */ + post: operations["projects/create-draft-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for organization + * @description List all fields for a specific organization-owned project. + */ + get: operations["projects/list-fields-for-org"]; + put?: never; + /** + * Add a field to an organization-owned project. + * @description Add a field to an organization-owned project. + */ + post: operations["projects/add-field-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for organization + * @description Get a specific field for an organization-owned project. + */ + get: operations["projects/get-field-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization owned project + * @description List all items for a specific organization-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-org"]; + put?: never; + /** + * Add item to organization owned project + * @description Add an issue or pull request item to the specified organization owned project. + */ + post: operations["projects/add-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for an organization owned project + * @description Get a specific item from an organization-owned project. + */ + get: operations["projects/get-org-item"]; + put?: never; + post?: never; + /** + * Delete project item for organization + * @description Delete a specific item from an organization-owned project. + */ + delete: operations["projects/delete-item-for-org"]; + options?: never; + head?: never; + /** + * Update project item for organization + * @description Update a specific item in an organization-owned project. + */ + patch: operations["projects/update-item-for-org"]; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly post: operations["projects/create-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/properties/schema": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + * Create a view for an organization-owned project + * @description Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization project view + * @description List items in an organization project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/properties/schema": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. * Organization members can read these properties. */ - readonly get: operations["orgs/get-all-custom-properties"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/custom-properties-for-repos-get-organization-definitions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - readonly patch: operations["orgs/create-or-update-custom-properties"]; - readonly trace?: never; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-definitions"]; + trace?: never; }; - readonly "/orgs/{org}/properties/schema/{custom_property_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/properties/schema/{custom_property_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. * Organization members can read these properties. */ - readonly get: operations["orgs/get-custom-property"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definition"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. @@ -5406,8 +6744,8 @@ export type paths = { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - readonly put: operations["orgs/create-or-update-custom-property"]; - readonly post?: never; + put: operations["orgs/custom-properties-for-repos-create-or-update-organization-definition"]; + post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. @@ -5416,30 +6754,30 @@ export type paths = { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - readonly delete: operations["orgs/remove-custom-property"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/custom-properties-for-repos-delete-organization-definition"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/properties/values": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List custom property values for organization repositories * @description Lists organization repositories with all of their custom property values. * Organization members can read these properties. */ - readonly get: operations["orgs/list-custom-properties-values-for-repos"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/custom-properties-for-repos-get-organization-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for organization repositories * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. @@ -5453,65 +6791,65 @@ export type paths = { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ - readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; - readonly trace?: never; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-values"]; + trace?: never; }; - readonly "/orgs/{org}/public_members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ - readonly get: operations["orgs/list-public-members"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/public_members/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. */ - readonly get: operations["orgs/check-public-membership-for-user"]; + get: operations["orgs/check-public-membership-for-user"]; /** * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["orgs/set-public-membership-for-authenticated-user"]; - readonly post?: never; + put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ - readonly delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization repositories @@ -5520,93 +6858,93 @@ export type paths = { * > [!NOTE] * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ - readonly get: operations["repos/list-for-org"]; - readonly put?: never; + get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ - readonly post: operations["repos/create-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all organization repository rulesets * @description Get all the repository rulesets for an organization. */ - readonly get: operations["repos/get-org-rulesets"]; - readonly put?: never; + get: operations["repos/get-org-rulesets"]; + put?: never; /** * Create an organization repository ruleset * @description Create a repository ruleset for an organization. */ - readonly post: operations["repos/create-org-ruleset"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-org-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets/rule-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization rule suites * @description Lists suites of rule evaluations at the organization level. * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-org-rule-suites"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-org-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization rule suite * @description Gets information about a suite of rule evaluations from within an organization. * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-org-rule-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-org-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets/{ruleset_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization repository ruleset @@ -5615,29 +6953,69 @@ export type paths = { * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user * making the API request has write access to the ruleset. */ - readonly get: operations["repos/get-org-ruleset"]; + get: operations["repos/get-org-ruleset"]; /** * Update an organization repository ruleset * @description Update a ruleset for an organization. */ - readonly put: operations["repos/update-org-ruleset"]; - readonly post?: never; + put: operations["repos/update-org-ruleset"]; + post?: never; /** * Delete an organization repository ruleset * @description Delete a ruleset for an organization. */ - readonly delete: operations["repos/delete-org-ruleset"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/secret-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + delete: operations["repos/delete-org-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset history + * @description Get the history of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset version + * @description Get a version of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List secret scanning alerts for an organization @@ -5647,21 +7025,49 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/list-alerts-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/secret-scanning/pattern-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization pattern configurations + * @description Lists the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `read:org` scope to use this endpoint. + */ + get: operations["secret-scanning/list-org-pattern-configs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update organization pattern configurations + * @description Updates the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["secret-scanning/update-org-pattern-configs"]; + trace?: never; }; - readonly "/orgs/{org}/security-advisories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository security advisories for an organization @@ -5671,21 +7077,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly get: operations["security-advisories/list-org-repository-advisories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["security-advisories/list-org-repository-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/security-managers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List security manager teams @@ -5693,121 +7099,133 @@ export type paths = { * @description > [!WARNING] * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ - readonly get: operations["orgs/list-security-manager-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/security-managers/teams/{team_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add a security manager team * @deprecated * @description > [!WARNING] * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ - readonly put: operations["orgs/add-security-manager-team"]; - readonly post?: never; + put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @deprecated * @description > [!WARNING] * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ - readonly delete: operations["orgs/remove-security-manager-team"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/billing/actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get immutable releases settings for an organization + * @description Gets the immutable releases policy for repositories in an organization. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings"]; + /** + * Set immutable releases settings for an organization + * @description Sets the immutable releases policy for repositories in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["billing/get-github-actions-billing-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["orgs/set-immutable-releases-settings"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/billing/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/immutable-releases/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * List selected repositories for immutable releases enforcement + * @description List all of the repositories that have been selected for immutable releases enforcement in an organization. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings-repositories"]; + /** + * Set selected repositories for immutable releases enforcement + * @description Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["billing/get-github-packages-billing-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["orgs/set-immutable-releases-settings-repositories"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/billing/shared-storage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; + get?: never; /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Enable a selected repository for immutable releases in an organization + * @description Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/enable-selected-repository-immutable-releases-organization"]; + post?: never; + /** + * Disable a selected repository for immutable releases in an organization + * @description Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["billing/get-shared-storage-billing-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/disable-selected-repository-immutable-releases-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/network-configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List hosted compute network configurations for an organization @@ -5815,27 +7233,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. */ - readonly get: operations["hosted-compute/list-network-configurations-for-org"]; - readonly put?: never; + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; /** * Create a hosted compute network configuration for an organization * @description Creates a hosted compute network configuration for an organization. * * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. */ - readonly post: operations["hosted-compute/create-network-configuration-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a hosted compute network configuration for an organization @@ -5843,33 +7261,33 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. */ - readonly get: operations["hosted-compute/get-network-configuration-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; /** * Delete a hosted compute network configuration from an organization * @description Deletes a hosted compute network configuration from an organization. * * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. */ - readonly delete: operations["hosted-compute/delete-network-configuration-from-org"]; - readonly options?: never; - readonly head?: never; + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; /** * Update a hosted compute network configuration for an organization * @description Updates a hosted compute network configuration for an organization. * * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. */ - readonly patch: operations["hosted-compute/update-network-configuration-for-org"]; - readonly trace?: never; + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/settings/network-settings/{network_settings_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a hosted compute network settings resource for an organization @@ -5877,21 +7295,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. */ - readonly get: operations["hosted-compute/get-network-settings-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/team/{team_slug}/copilot/metrics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Copilot metrics for a team @@ -5900,7 +7318,7 @@ export type paths = { * > [!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, + * The response contains metrics for up to 100 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. * @@ -5909,83 +7327,47 @@ export type paths = { * * 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; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a summary of Copilot usage for a team - * @description > [!NOTE] - * > 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. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - readonly get: operations["copilot/usage-metrics-for-team"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/copilot-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ - readonly get: operations["teams/list"]; - readonly put?: never; + get: operations["teams/list"]; + put?: never; /** * Create a team * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - readonly post: operations["teams/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a team by name @@ -5994,9 +7376,9 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - readonly get: operations["teams/get-by-name"]; - readonly put?: never; - readonly post?: never; + get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -6006,9 +7388,9 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - readonly delete: operations["teams/delete-in-org"]; - readonly options?: never; - readonly head?: never; + delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. @@ -6016,295 +7398,15 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - readonly patch: operations["teams/update-in-org"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussions-in-org"]; - readonly put?: never; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + patch: operations["teams/update-in-org"]; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-in-org"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-in-org"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-in-org"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussion-comments-in-org"]; - readonly put?: never; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-comment-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-comment-in-org"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-comment-in-org"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-comment-in-org"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-comment-in-org"]; - readonly put?: never; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-comment-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - /** - * Delete team discussion comment reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["reactions/delete-for-team-discussion-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-in-org"]; - readonly put?: never; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - /** - * Delete team discussion reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["reactions/delete-for-team-discussion"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pending team invitations @@ -6313,21 +7415,21 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - readonly get: operations["teams/list-pending-invitations-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-pending-invitations-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team members @@ -6335,21 +7437,21 @@ export type paths = { * * To list members in a team, the team must be visible to the authenticated user. */ - readonly get: operations["teams/list-members-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get team membership for a user @@ -6365,7 +7467,7 @@ export type paths = { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ - readonly get: operations["teams/get-membership-for-user-in-org"]; + get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. @@ -6382,8 +7484,8 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly put: operations["teams/add-or-update-membership-for-user-in-org"]; - readonly post?: never; + put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. @@ -6396,78 +7498,18 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly delete: operations["teams/remove-membership-for-user-in-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ - readonly get: operations["teams/list-projects-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - readonly get: operations["teams/check-permissions-for-project-in-org"]; - /** - * Add or update team project permissions - * @description 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. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - readonly put: operations["teams/add-or-update-project-permissions-in-org"]; - readonly post?: never; - /** - * Remove a project from a team - * @description 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. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - readonly delete: operations["teams/remove-project-in-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team repositories @@ -6476,21 +7518,21 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - readonly get: operations["teams/list-repos-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check team permissions for a repository @@ -6505,7 +7547,7 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly get: operations["teams/check-permissions-for-repo-in-org"]; + get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." @@ -6515,8 +7557,8 @@ export type paths = { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - readonly put: operations["teams/add-or-update-repo-permissions-in-org"]; - readonly post?: never; + put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. @@ -6524,18 +7566,18 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly delete: operations["teams/remove-repo-in-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List child teams @@ -6544,24 +7586,24 @@ export type paths = { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - readonly get: operations["teams/list-child-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/{security_product}/{enablement}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @deprecated @@ -6574,240 +7616,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ - readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/columns/cards/{card_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a project card - * @description Gets information about a project card. - */ - readonly get: operations["projects/get-card"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a project card - * @description Deletes a project card - */ - readonly delete: operations["projects/delete-card"]; - readonly options?: never; - readonly head?: never; - /** Update an existing project card */ - readonly patch: operations["projects/update-card"]; - readonly trace?: never; - }; - readonly "/projects/columns/cards/{card_id}/moves": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** Move a project card */ - readonly post: operations["projects/move-card"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/columns/{column_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a project column - * @description Gets information about a project column. - */ - readonly get: operations["projects/get-column"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a project column - * @description Deletes a project column. - */ - readonly delete: operations["projects/delete-column"]; - readonly options?: never; - readonly head?: never; - /** Update an existing project column */ - readonly patch: operations["projects/update-column"]; - readonly trace?: never; - }; - readonly "/projects/columns/{column_id}/cards": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List project cards - * @description Lists the project cards in a project. - */ - readonly get: operations["projects/list-cards"]; - readonly put?: never; - /** Create a project card */ - readonly post: operations["projects/create-card"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/columns/{column_id}/moves": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** Move a project column */ - readonly post: operations["projects/move-column"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly get: operations["projects/get"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - readonly delete: operations["projects/delete"]; - readonly options?: never; - readonly head?: never; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly patch: operations["projects/update"]; - readonly trace?: never; - }; - readonly "/projects/{project_id}/collaborators": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - readonly get: operations["projects/list-collaborators"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}/collaborators/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - readonly put: operations["projects/add-collaborator"]; - readonly post?: never; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - readonly delete: operations["projects/remove-collaborator"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}/collaborators/{username}/permission": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - readonly get: operations["projects/get-permission-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}/columns": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List project columns - * @description Lists the project columns in a project. - */ - readonly get: operations["projects/list-columns"]; - readonly put?: never; - /** - * Create a project column - * @description Creates a new project column. - */ - readonly post: operations["projects/create-column"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/rate_limit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get rate limit status for the authenticated user @@ -6821,6 +7642,7 @@ export type paths = { * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -6828,32 +7650,33 @@ export type paths = { * > [!NOTE] * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - readonly get: operations["rate-limit/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * * > [!NOTE] - * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. */ - readonly get: operations["repos/get"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. @@ -6863,22 +7686,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. */ - readonly patch: operations["repos/update"]; - readonly trace?: never; + patch: operations["repos/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/artifacts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List artifacts for a repository @@ -6888,21 +7711,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-artifacts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an artifact @@ -6912,26 +7735,26 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-artifact"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-artifact"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download an artifact @@ -6940,21 +7763,81 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-artifact"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for a repository + * @description Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-repository"]; + /** + * Set GitHub Actions cache retention limit for a repository + * @description Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for a repository + * @description Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-repository"]; + /** + * Set GitHub Actions cache storage limit for a repository + * @description Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/cache/usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions cache usage for a repository @@ -6965,21 +7848,21 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-usage"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/caches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub Actions caches for a repository @@ -6987,49 +7870,49 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-list"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-actions-cache-by-key"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/caches/{cache_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-actions-cache-by-id"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a job for a workflow run @@ -7039,21 +7922,21 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-job-for-workflow-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download job logs for a workflow run @@ -7064,43 +7947,43 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-job-logs-for-workflow-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/re-run-job-for-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/oidc/customization/sub": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the customization template for an OIDC subject claim for a repository @@ -7108,27 +7991,27 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; + get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/organization-secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository organization secrets @@ -7139,21 +8022,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-organization-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/organization-variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository organization variables @@ -7163,21 +8046,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-organization-variables"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions permissions for a repository @@ -7185,27 +8068,27 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-permissions-repository"]; + get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-permissions-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions/access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the level of access for workflows outside of the repository @@ -7215,7 +8098,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-workflow-access-to-repository"]; + get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. @@ -7224,20 +8107,104 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-workflow-access-to-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for a repository + * @description Gets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-repository"]; + /** + * Set artifact and log retention settings for a repository + * @description Sets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for a repository + * @description Gets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-repository"]; + /** + * Set fork PR contributor approval permissions for a repository + * @description Sets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for a repository + * @description Gets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-repository"]; + /** + * Set private repo fork PR workflow settings for a repository + * @description Sets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions/selected-actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get allowed actions and reusable workflows for a repository @@ -7245,27 +8212,27 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-allowed-actions-repository"]; + get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-allowed-actions-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions/workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default workflow permissions for a repository @@ -7275,7 +8242,7 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; + get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions @@ -7284,20 +8251,20 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List self-hosted runners for a repository @@ -7307,21 +8274,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-self-hosted-runners-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/downloads": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List runner applications for a repository @@ -7331,24 +8298,24 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-runner-applications-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. @@ -7357,22 +8324,22 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ - readonly post: operations["actions/generate-runner-jitconfig-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/generate-runner-jitconfig-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/registration-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -7387,22 +8354,22 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-registration-token-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/remove-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. @@ -7417,19 +8384,19 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-remove-token-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a self-hosted runner for a repository @@ -7439,9 +8406,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-self-hosted-runner-for-repo"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. @@ -7450,18 +8417,18 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-from-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for a self-hosted runner for a repository @@ -7471,7 +8438,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific @@ -7481,7 +8448,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. @@ -7490,7 +8457,7 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a @@ -7500,22 +8467,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured @@ -7528,18 +8495,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List workflow runs for a repository @@ -7551,21 +8518,21 @@ export type paths = { * * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ - readonly get: operations["actions/list-workflow-runs-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a workflow run @@ -7575,9 +8542,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-run"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. @@ -7586,18 +8553,18 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-workflow-run"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the review history for a workflow run @@ -7605,43 +8572,43 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-reviews-for-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/approve-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/approve-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List workflow run artifacts @@ -7651,21 +8618,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-workflow-run-artifacts"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a workflow run attempt @@ -7675,21 +8642,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-run-attempt"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List jobs for a workflow run attempt @@ -7700,21 +8667,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-jobs-for-workflow-run-attempt"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download workflow run attempt logs @@ -7725,46 +8692,46 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-workflow-run-attempt-logs"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/cancel-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." @@ -7774,22 +8741,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly post: operations["actions/review-custom-gates-for-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/review-custom-gates-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Force cancel a workflow run * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. @@ -7797,19 +8764,19 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/force-cancel-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/force-cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List jobs for a workflow run @@ -7820,21 +8787,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-jobs-for-workflow-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download workflow run logs @@ -7845,27 +8812,27 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-workflow-run-logs"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-workflow-run-logs"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get pending deployments for a workflow run @@ -7875,8 +8842,8 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-pending-deployments-for-run"]; - readonly put?: never; + get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. @@ -7885,87 +8852,90 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/review-pending-deployments-for-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/re-run-workflow"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/re-run-workflow-failed-jobs"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get workflow run usage - * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-run-usage"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow-run-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository secrets @@ -7976,21 +8946,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository public key @@ -8001,21 +8971,21 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-repo-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository secret @@ -8025,7 +8995,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-repo-secret"]; + get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using @@ -8035,8 +9005,8 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/create-or-update-repo-secret"]; - readonly post?: never; + put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. @@ -8045,18 +9015,18 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-repo-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository variables @@ -8066,8 +9036,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-variables"]; - readonly put?: never; + get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. @@ -8076,19 +9046,19 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-repo-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository variable @@ -8098,9 +9068,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-repo-variable"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. @@ -8109,9 +9079,9 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-repo-variable"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. @@ -8120,15 +9090,15 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly patch: operations["actions/update-repo-variable"]; - readonly trace?: never; + patch: operations["actions/update-repo-variable"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository workflows @@ -8138,21 +9108,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-repo-workflows"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a workflow @@ -8163,46 +9133,46 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Disable a workflow * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/disable-workflow"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a workflow dispatch event * @description You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. @@ -8211,41 +9181,41 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-workflow-dispatch"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Enable a workflow * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/enable-workflow"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List workflow runs for a workflow @@ -8257,25 +9227,28 @@ export type paths = { * * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ - readonly get: operations["actions/list-workflow-runs"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get workflow usage - * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -8283,21 +9256,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-usage"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/activity": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository activities @@ -8306,41 +9279,41 @@ export type paths = { * For more information about viewing repository activity, * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." */ - readonly get: operations["repos/list-activities"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-activities"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - readonly get: operations["issues/list-assignees"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/assignees/{assignee}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user can be assigned @@ -8350,24 +9323,24 @@ export type paths = { * * Otherwise a `404` status code is returned. */ - readonly get: operations["issues/check-user-can-be-assigned"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/attestations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/attestations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an attestation * @description Store an artifact attestation and associate it with a repository. @@ -8376,19 +9349,19 @@ export type paths = { * * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly post: operations["repos/create-attestation"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-attestation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/attestations/{subject_digest}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List attestations @@ -8398,21 +9371,21 @@ export type paths = { * * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly get: operations["repos/list-attestations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/autolinks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all autolinks of a repository @@ -8420,25 +9393,25 @@ export type paths = { * * Information about autolinks are only available to repository administrators. */ - readonly get: operations["repos/list-autolinks"]; - readonly put?: never; + get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ - readonly post: operations["repos/create-autolink"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/autolinks/{autolink_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an autolink reference of a repository @@ -8446,95 +9419,95 @@ export type paths = { * * Information about autolinks are only available to repository administrators. */ - readonly get: operations["repos/get-autolink"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly delete: operations["repos/delete-autolink"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if Dependabot security updates are enabled for a repository * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ - readonly get: operations["repos/check-automated-security-fixes"]; + get: operations["repos/check-automated-security-fixes"]; /** * Enable Dependabot security updates * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ - readonly put: operations["repos/enable-automated-security-fixes"]; - readonly post?: never; + put: operations["repos/enable-automated-security-fixes"]; + post?: never; /** * Disable Dependabot security updates * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ - readonly delete: operations["repos/disable-automated-security-fixes"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-automated-security-fixes"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List branches */ - readonly get: operations["repos/list-branches"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get a branch */ - readonly get: operations["repos/get-branch"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-branch-protection"]; + get: operations["repos/get-branch-protection"]; /** * Update branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8547,71 +9520,71 @@ export type paths = { * > [!NOTE] * > The list of users, apps, and teams in total is limited to 100 items. */ - readonly put: operations["repos/update-branch-protection"]; - readonly post?: never; + put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/delete-branch-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get admin branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-admin-branch-protection"]; - readonly put?: never; + get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly post: operations["repos/set-admin-branch-protection"]; + post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly delete: operations["repos/delete-admin-branch-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get pull request review protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-pull-request-review-protection"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/delete-pull-request-review-protection"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8621,15 +9594,15 @@ export type paths = { * > [!NOTE] * > Passing new arrays of `users` and `teams` replaces their previous values. */ - readonly patch: operations["repos/update-pull-request-review-protection"]; - readonly trace?: never; + patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get commit signature protection @@ -8640,95 +9613,95 @@ export type paths = { * > [!NOTE] * > You must enable branch protection to require signed commits. */ - readonly get: operations["repos/get-commit-signature-protection"]; - readonly put?: never; + get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly post: operations["repos/create-commit-signature-protection"]; + post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly delete: operations["repos/delete-commit-signature-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get status checks protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-status-checks-protection"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/remove-status-check-protection"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly patch: operations["repos/update-status-check-protection"]; - readonly trace?: never; + patch: operations["repos/update-status-check-protection"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-all-status-check-contexts"]; + get: operations["repos/get-all-status-check-contexts"]; /** * Set status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly put: operations["repos/set-status-check-contexts"]; + put: operations["repos/set-status-check-contexts"]; /** * Add status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly post: operations["repos/add-status-check-contexts"]; + post: operations["repos/add-status-check-contexts"]; /** * Remove status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/remove-status-check-contexts"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get access restrictions @@ -8739,27 +9712,27 @@ export type paths = { * > [!NOTE] * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - readonly get: operations["repos/get-access-restrictions"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - readonly delete: operations["repos/delete-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get apps with access to the protected branch @@ -8767,39 +9740,39 @@ export type paths = { * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly get: operations["repos/get-apps-with-access-to-protected-branch"]; + get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly put: operations["repos/set-app-access-restrictions"]; + put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly post: operations["repos/add-app-access-restrictions"]; + post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly delete: operations["repos/remove-app-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get teams with access to the protected branch @@ -8807,39 +9780,39 @@ export type paths = { * * Lists the teams who have push access to this branch. The list includes child teams. */ - readonly get: operations["repos/get-teams-with-access-to-protected-branch"]; + get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ - readonly put: operations["repos/set-team-access-restrictions"]; + put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ - readonly post: operations["repos/add-team-access-restrictions"]; + post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ - readonly delete: operations["repos/remove-team-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get users with access to the protected branch @@ -8847,7 +9820,7 @@ export type paths = { * * Lists the people who have push access to this branch. */ - readonly get: operations["repos/get-users-with-access-to-protected-branch"]; + get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8858,7 +9831,7 @@ export type paths = { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly put: operations["repos/set-user-access-restrictions"]; + put: operations["repos/set-user-access-restrictions"]; /** * Add user access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8869,7 +9842,7 @@ export type paths = { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly post: operations["repos/add-user-access-restrictions"]; + post: operations["repos/add-user-access-restrictions"]; /** * Remove user access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8880,21 +9853,21 @@ export type paths = { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly delete: operations["repos/remove-user-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/rename": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. @@ -8906,22 +9879,22 @@ export type paths = { * * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ - readonly post: operations["repos/rename-branch"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a check run * @description Creates a new check run for a specific commit in a repository. @@ -8933,19 +9906,19 @@ export type paths = { * > [!NOTE] * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ - readonly post: operations["checks/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a check run @@ -8956,12 +9929,12 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. @@ -8971,15 +9944,15 @@ export type paths = { * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly patch: operations["checks/update"]; - readonly trace?: never; + patch: operations["checks/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check run annotations @@ -8987,48 +9960,46 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-annotations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly post: operations["checks/rerequest-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". @@ -9038,40 +10009,40 @@ export type paths = { * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly post: operations["checks/create-suite"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/check-suites/preferences": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ - readonly patch: operations["checks/set-suites-preferences"]; - readonly trace?: never; + patch: operations["checks/set-suites-preferences"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a check suite @@ -9082,21 +10053,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/get-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check runs in a check suite @@ -9107,43 +10078,41 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-for-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly post: operations["checks/rerequest-suite"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List code scanning alerts for a repository @@ -9155,21 +10124,21 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/list-alerts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code scanning alert @@ -9177,26 +10146,26 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/get-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly patch: operations["code-scanning/update-alert"]; - readonly trace?: never; + patch: operations["code-scanning/update-alert"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the status of an autofix for a code scanning alert @@ -9204,8 +10173,8 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/get-autofix"]; - readonly put?: never; + get: operations["code-scanning/get-autofix"]; + put?: never; /** * Create an autofix for a code scanning alert * @description Creates an autofix for a code scanning alert. @@ -9216,43 +10185,43 @@ export type paths = { * * 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. */ - readonly post: operations["code-scanning/create-autofix"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Commit an autofix for a code scanning alert * @description Commits an autofix for a code scanning alert. * - * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly post: operations["code-scanning/commit-autofix"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List instances of a code scanning alert @@ -9260,21 +10229,21 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/list-alert-instances"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/analyses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List code scanning analyses for a repository @@ -9294,21 +10263,21 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/list-recent-analyses"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code scanning analysis for a repository @@ -9330,9 +10299,9 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/get-analysis"]; - readonly put?: never; - readonly post?: never; + get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. @@ -9400,18 +10369,18 @@ export type paths = { * * 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-analysis"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/databases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List CodeQL databases for a repository @@ -9419,21 +10388,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-codeql-databases"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a CodeQL database for a repository @@ -9447,30 +10416,30 @@ export type paths = { * * 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; + get: operations["code-scanning/get-codeql-database"]; + put?: never; + post?: 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; - readonly trace?: never; + delete: operations["code-scanning/delete-codeql-database"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a CodeQL variant analysis * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. @@ -9482,19 +10451,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["code-scanning/create-variant-analysis"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/create-variant-analysis"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the summary of a CodeQL variant analysis @@ -9502,21 +10471,21 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/get-variant-analysis"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/get-variant-analysis"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the analysis status of a repository in a CodeQL variant analysis @@ -9524,21 +10493,21 @@ export type paths = { * * 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. */ - readonly get: operations["code-scanning/get-variant-analysis-repo-task"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/get-variant-analysis-repo-task"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/default-setup": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code scanning default setup configuration @@ -9546,30 +10515,30 @@ export type paths = { * * 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-default-setup"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly patch: operations["code-scanning/update-default-setup"]; - readonly trace?: never; + patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/sarifs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." @@ -9607,40 +10576,40 @@ export type paths = { * * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ - readonly post: operations["code-scanning/upload-sarif"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly get: operations["code-scanning/get-sarif"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-security-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the code security configuration associated with a repository @@ -9650,21 +10619,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["code-security/get-configuration-for-repository"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codeowners/errors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List CODEOWNERS errors @@ -9674,21 +10643,21 @@ export type paths = { * For more information about the correct CODEOWNERS syntax, * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ - readonly get: operations["repos/codeowners-errors"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces in a repository for the authenticated user @@ -9696,27 +10665,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-in-repository-for-authenticated-user"]; - readonly put?: never; + get: operations["codespaces/list-in-repository-for-authenticated-user"]; + put?: never; /** * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-with-repo-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/create-with-repo-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/devcontainers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/devcontainers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List devcontainer configurations in a repository for the authenticated user @@ -9725,21 +10694,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/machines": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List available machine types for a repository @@ -9747,21 +10716,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/repo-machines-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/repo-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/new": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/new": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default attributes for a codespace @@ -9769,21 +10738,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/permissions_check": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/permissions_check": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if permissions defined by a devcontainer have been accepted by the authenticated user @@ -9791,21 +10760,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/check-permissions-for-devcontainer"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/check-permissions-for-devcontainer"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository secrets @@ -9814,21 +10783,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["codespaces/list-repo-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository public key @@ -9837,21 +10806,21 @@ export type paths = { * * 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"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository secret @@ -9859,61 +10828,61 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["codespaces/get-repo-secret"]; + get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ - readonly put: operations["codespaces/create-or-update-repo-secret"]; - readonly post?: never; + put: operations["codespaces/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ - readonly delete: operations["codespaces/delete-repo-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/collaborators": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. * * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. - * + * The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ - readonly get: operations["repos/list-collaborators"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/collaborators/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user is a repository collaborator @@ -9925,14 +10894,16 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ - readonly get: operations["repos/check-collaborator"]; + get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} @@ -9942,6 +10913,8 @@ export type paths = { * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * + * For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + * * **Updating an existing collaborator's permission level** * * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -9950,8 +10923,8 @@ export type paths = { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - readonly put: operations["repos/add-collaborator"]; - readonly post?: never; + put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. @@ -9959,8 +10932,8 @@ export type paths = { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -9977,44 +10950,46 @@ export type paths = { * * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ - readonly delete: operations["repos/remove-collaborator"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/collaborators/{username}/permission": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ - readonly get: operations["repos/get-collaborator-permission-level"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + * @description Checks the repository permission and role of a collaborator. + * + * The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + * The `role_name` attribute provides the name of the assigned role, including custom roles. The + * `permission` can also be used to determine which base level of access the collaborator has to the repository. + * + * The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. + */ + get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commit comments for a repository @@ -10027,21 +11002,21 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["repos/list-commit-comments-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a commit comment @@ -10054,13 +11029,13 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["repos/get-commit-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ - readonly delete: operations["repos/delete-commit-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. @@ -10072,43 +11047,43 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["repos/update-commit-comment"]; - readonly trace?: never; + patch: operations["repos/update-commit-comment"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ - readonly get: operations["reactions/list-for-commit-comment"]; - readonly put?: never; + get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - readonly post: operations["reactions/create-for-commit-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description > [!NOTE] @@ -10116,18 +11091,18 @@ export type paths = { * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ - readonly delete: operations["reactions/delete-for-commit-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commits @@ -10161,21 +11136,21 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/list-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List branches for HEAD commit @@ -10183,21 +11158,21 @@ export type paths = { * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - readonly get: operations["repos/list-branches-for-head-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commit comments @@ -10210,8 +11185,8 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["repos/list-comments-for-commit"]; - readonly put?: never; + get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. @@ -10225,41 +11200,41 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["repos/create-commit-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ - readonly get: operations["repos/list-pull-requests-associated-with-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a commit @@ -10304,21 +11279,21 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/get-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/check-runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check runs for a Git reference @@ -10331,21 +11306,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/check-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check suites for a Git reference @@ -10356,21 +11331,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-suites-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the combined status for a specific reference @@ -10383,21 +11358,21 @@ export type paths = { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - readonly get: operations["repos/get-combined-status-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/statuses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commit statuses for a reference @@ -10405,21 +11380,21 @@ export type paths = { * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - readonly get: operations["repos/list-commit-statuses-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/community/profile": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/community/profile": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get community profile metrics @@ -10435,21 +11410,21 @@ export type paths = { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - readonly get: operations["repos/get-community-profile-metrics"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-community-profile-metrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/compare/{basehead}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Compare two commits @@ -10505,21 +11480,21 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/compare-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/contents/{path}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repository content @@ -10549,7 +11524,7 @@ export type paths = { * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. * - Greater than 100 MB: This endpoint is not supported. */ - readonly get: operations["repos/get-content"]; + get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. @@ -10559,8 +11534,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ - readonly put: operations["repos/create-or-update-file-contents"]; - readonly post?: never; + put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. @@ -10574,18 +11549,18 @@ export type paths = { * > [!NOTE] * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ - readonly delete: operations["repos/delete-file"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/contributors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository contributors @@ -10593,67 +11568,67 @@ export type paths = { * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - readonly get: operations["repos/list-contributors"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["dependabot/list-alerts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["dependabot/get-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly patch: operations["dependabot/update-alert"]; - readonly trace?: never; + patch: operations["dependabot/update-alert"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository secrets @@ -10662,21 +11637,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["dependabot/list-repo-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository public key @@ -10686,21 +11661,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ - readonly get: operations["dependabot/get-repo-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository secret @@ -10708,7 +11683,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["dependabot/get-repo-secret"]; + get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using @@ -10716,69 +11691,69 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["dependabot/create-or-update-repo-secret"]; - readonly post?: never; + put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["dependabot/delete-repo-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ - readonly get: operations["dependency-graph/diff-range"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependency-graph/sbom": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ - readonly get: operations["dependency-graph/export-sbom"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/dependency-graph/snapshots": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. @@ -10787,26 +11762,26 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["dependency-graph/create-repository-snapshot"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ - readonly get: operations["repos/list-deployments"]; - readonly put?: never; + get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. @@ -10858,24 +11833,24 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get a deployment */ - readonly get: operations["repos/get-deployment"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * Delete a deployment * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. @@ -10889,67 +11864,67 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ - readonly delete: operations["repos/delete-deployment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ - readonly get: operations["repos/list-deployment-statuses"]; - readonly put?: never; + get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment-status"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ - readonly get: operations["repos/get-deployment-status"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/dispatches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." @@ -10960,19 +11935,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-dispatch-event"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List environments @@ -10982,21 +11957,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-all-environments"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment @@ -11007,7 +11982,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-environment"]; + get: operations["repos/get-environment"]; /** * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." @@ -11020,24 +11995,24 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["repos/create-or-update-environment"]; - readonly post?: never; + put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete-an-environment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deployment branch policies @@ -11047,27 +12022,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/list-deployment-branch-policies"]; - readonly put?: never; + get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment-branch-policy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a deployment branch policy @@ -11077,33 +12052,33 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-deployment-branch-policy"]; + get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["repos/update-deployment-branch-policy"]; - readonly post?: never; + put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete-deployment-branch-policy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all deployment protection rules for an environment @@ -11113,31 +12088,31 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-all-deployment-protection-rules"]; - readonly put?: never; + get: operations["repos/get-all-deployment-protection-rules"]; + put?: never; /** * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment-protection-rule"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment-protection-rule"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List custom deployment rule integrations available for an environment @@ -11151,21 +12126,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/list-custom-deployment-rule-integrations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-custom-deployment-rule-integrations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a custom deployment protection rule @@ -11175,9 +12150,9 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-custom-deployment-protection-rule"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-custom-deployment-protection-rule"]; + put?: never; + post?: never; /** * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. @@ -11186,18 +12161,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/disable-deployment-protection-rule"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-deployment-protection-rule"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List environment secrets @@ -11208,21 +12183,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-environment-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment public key @@ -11233,21 +12208,21 @@ export type paths = { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-environment-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment secret @@ -11257,7 +12232,7 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-environment-secret"]; + get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using @@ -11267,8 +12242,8 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/create-or-update-environment-secret"]; - readonly post?: never; + put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. @@ -11277,18 +12252,18 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-environment-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List environment variables @@ -11298,8 +12273,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-environment-variables"]; - readonly put?: never; + get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. @@ -11308,19 +12283,19 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-environment-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment variable @@ -11330,9 +12305,9 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-environment-variable"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. @@ -11341,9 +12316,9 @@ export type paths = { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-environment-variable"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. @@ -11352,40 +12327,40 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly patch: operations["actions/update-environment-variable"]; - readonly trace?: never; + patch: operations["actions/update-environment-variable"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository events * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-repo-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/forks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List forks */ - readonly get: operations["repos/list-forks"]; - readonly put?: never; + get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. @@ -11396,36 +12371,36 @@ export type paths = { * > [!NOTE] * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ - readonly post: operations["repos/create-fork"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/blobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ - readonly post: operations["git/create-blob"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/blobs/{file_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a blob @@ -11438,24 +12413,24 @@ export type paths = { * * **Note** This endpoint supports blobs up to 100 megabytes in size. */ - readonly get: operations["git/get-blob"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). @@ -11490,19 +12465,19 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly post: operations["git/create-commit"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/commits/{commit_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a commit object @@ -11540,21 +12515,21 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["git/get-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/matching-refs/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List matching references @@ -11567,21 +12542,21 @@ export type paths = { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - readonly get: operations["git/list-matching-refs"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/ref/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a reference @@ -11590,68 +12565,68 @@ export type paths = { * > [!NOTE] * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - readonly get: operations["git/get-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/refs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - readonly post: operations["git/create-ref"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/refs/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ - readonly delete: operations["git/delete-ref"]; - readonly options?: never; - readonly head?: never; + delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly patch: operations["git/update-ref"]; - readonly trace?: never; + patch: operations["git/update-ref"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/tags": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. @@ -11686,19 +12661,19 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly post: operations["git/create-tag"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/tags/{tag_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a tag @@ -11732,24 +12707,24 @@ export type paths = { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["git/get-tag"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/trees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. @@ -11758,19 +12733,19 @@ export type paths = { * * Returns an error if you try to delete a file that does not exist. */ - readonly post: operations["git/create-tree"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/trees/{tree_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a tree @@ -11781,76 +12756,76 @@ export type paths = { * > [!NOTE] * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ - readonly get: operations["git/get-tree"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ - readonly get: operations["repos/list-webhooks"]; - readonly put?: never; + get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - readonly post: operations["repos/create-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ - readonly get: operations["repos/get-webhook"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** * Delete a repository webhook * @description Delete a webhook for an organization. * * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. */ - readonly delete: operations["repos/delete-webhook"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ - readonly patch: operations["repos/update-webhook"]; - readonly trace?: never; + patch: operations["repos/update-webhook"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/config": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook configuration for a repository @@ -11858,110 +12833,110 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-webhook-config-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ - readonly patch: operations["repos/update-webhook-config-for-repo"]; - readonly trace?: never; + patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ - readonly get: operations["repos/list-webhook-deliveries"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ - readonly get: operations["repos/get-webhook-delivery"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ - readonly post: operations["repos/redeliver-webhook-delivery"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - readonly post: operations["repos/ping-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. @@ -11969,19 +12944,48 @@ export type paths = { * > [!NOTE] * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - readonly post: operations["repos/test-push-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Check if immutable releases are enabled for a repository + * @description Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + * enforced by the repository owner. The authenticated user must have admin read access to the repository. + */ + get: operations["repos/check-immutable-releases"]; + /** + * Enable immutable releases + * @description Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + put: operations["repos/enable-immutable-releases"]; + post?: never; + /** + * Disable immutable releases + * @description Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + delete: operations["repos/disable-immutable-releases"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/import": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an import status @@ -12024,7 +13028,7 @@ export type paths = { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - readonly get: operations["migrations/get-import-status"]; + get: operations["migrations/get-import-status"]; /** * Start an import * @deprecated @@ -12035,8 +13039,8 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly put: operations["migrations/start-import"]; - readonly post?: never; + put: operations["migrations/start-import"]; + post?: never; /** * Cancel an import * @deprecated @@ -12045,9 +13049,9 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly delete: operations["migrations/cancel-import"]; - readonly options?: never; - readonly head?: never; + delete: operations["migrations/cancel-import"]; + options?: never; + head?: never; /** * Update an import * @deprecated @@ -12061,15 +13065,15 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly patch: operations["migrations/update-import"]; - readonly trace?: never; + patch: operations["migrations/update-import"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/import/authors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/import/authors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get commit authors @@ -12081,28 +13085,28 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly get: operations["migrations/get-commit-authors"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/import/authors/{author_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["migrations/get-commit-authors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/import/authors/{author_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Map a commit author * @deprecated @@ -12112,15 +13116,15 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly patch: operations["migrations/map-commit-author"]; - readonly trace?: never; + patch: operations["migrations/map-commit-author"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/import/large_files": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/import/large_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get large files @@ -12130,28 +13134,28 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly get: operations["migrations/get-large-files"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/import/lfs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["migrations/get-large-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/import/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update Git LFS preference * @deprecated @@ -12164,15 +13168,15 @@ export type paths = { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly patch: operations["migrations/set-lfs-preference"]; - readonly trace?: never; + patch: operations["migrations/set-lfs-preference"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository installation for the authenticated app @@ -12180,87 +13184,87 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-repo-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/interaction-limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get interaction restrictions for a repository * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - readonly get: operations["interactions/get-restrictions-for-repo"]; + get: operations["interactions/get-restrictions-for-repo"]; /** * Set interaction restrictions for a repository * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly put: operations["interactions/set-restrictions-for-repo"]; - readonly post?: never; + put: operations["interactions/set-restrictions-for-repo"]; + post?: never; /** * Remove interaction restrictions for a repository * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly delete: operations["interactions/remove-restrictions-for-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["interactions/remove-restrictions-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - readonly get: operations["repos/list-invitations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/invitations/{invitation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ - readonly delete: operations["repos/delete-invitation"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ - readonly patch: operations["repos/update-invitation"]; - readonly trace?: never; + patch: operations["repos/update-invitation"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository issues @@ -12276,8 +13280,8 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-for-repo"]; - readonly put?: never; + get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. @@ -12292,19 +13296,19 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["issues/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue comments for a repository @@ -12319,21 +13323,21 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-comments-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an issue comment @@ -12346,16 +13350,16 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/get-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ - readonly delete: operations["issues/delete-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. @@ -12367,43 +13371,74 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["issues/update-comment"]; - readonly trace?: never; + patch: operations["issues/update-comment"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Pin an issue comment + * @description You can use the REST API to pin comments on issues. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + put: operations["issues/pin-comment"]; + post?: never; + /** + * Unpin an issue comment + * @description You can use the REST API to unpin comments on issues. + */ + delete: operations["issues/unpin-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ - readonly get: operations["reactions/list-for-issue-comment"]; - readonly put?: never; + get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - readonly post: operations["reactions/create-for-issue-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description > [!NOTE] @@ -12411,58 +13446,58 @@ export type paths = { * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ - readonly delete: operations["reactions/delete-for-issue-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue events for a repository * @description Lists events for a repository. */ - readonly get: operations["issues/list-events-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/events/{event_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an issue event * @description Gets a single event by the event id. */ - readonly get: operations["issues/get-event"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an issue @@ -12483,12 +13518,12 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access or Triage role can edit an issue. @@ -12500,39 +13535,39 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["issues/update"]; - readonly trace?: never; + patch: operations["issues/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - readonly post: operations["issues/add-assignees"]; + post: operations["issues/add-assignees"]; /** * Remove assignees from an issue * @description Removes one or more assignees from an issue. */ - readonly delete: operations["issues/remove-assignees"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user can be assigned to a issue @@ -12542,21 +13577,21 @@ export type paths = { * * Otherwise a `404` status code is returned. */ - readonly get: operations["issues/check-user-can-be-assigned-to-issue"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue comments @@ -12571,8 +13606,8 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-comments"]; - readonly put?: never; + get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. @@ -12589,145 +13624,271 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["issues/create-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocked by + * @description You can use the REST API to list the dependencies an issue is blocked by. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocked-by"]; + put?: never; + /** + * Add a dependency an issue is blocked by + * @description You can use the REST API to add a 'blocked by' relationship to an issue. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-blocked-by-dependency"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove dependency an issue is blocked by + * @description You can use the REST API to remove a dependency that an issue is blocked by. + * + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-dependency-blocked-by"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocking + * @description You can use the REST API to list the dependencies an issue is blocking. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocking"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue events * @description Lists all events for an issue. */ - readonly get: operations["issues/list-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for an issue * @description Lists all labels for an issue. */ - readonly get: operations["issues/list-labels-on-issue"]; + get: operations["issues/list-labels-on-issue"]; /** * Set labels for an issue * @description Removes any previous labels and sets the new labels for an issue. */ - readonly put: operations["issues/set-labels"]; + put: operations["issues/set-labels"]; /** * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. + * @description Adds labels to an issue. */ - readonly post: operations["issues/add-labels"]; + post: operations["issues/add-labels"]; /** * Remove all labels from an issue * @description Removes all labels from an issue. */ - readonly delete: operations["issues/remove-all-labels"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - readonly delete: operations["issues/remove-label"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["issues/lock"]; - readonly post?: never; + put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ - readonly delete: operations["issues/unlock"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get parent issue + * @description You can use the REST API to get the parent issue of a sub-issue. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/get-parent"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ - readonly get: operations["reactions/list-for-issue"]; - readonly put?: never; + get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - readonly post: operations["reactions/create-for-issue"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description > [!NOTE] @@ -12735,22 +13896,22 @@ export type paths = { * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ - readonly delete: operations["reactions/delete-for-issue"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove sub-issue * @description You can use the REST API to remove a sub-issue from an issue. @@ -12763,32 +13924,32 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly delete: operations["issues/remove-sub-issue"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List sub-issues * @description You can use the REST API to list the sub-issues on an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-sub-issues"]; - readonly put?: never; + get: operations["issues/list-sub-issues"]; + put?: never; /** * Add sub-issue * @description You can use the REST API to add sub-issues to issues. @@ -12804,173 +13965,173 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["issues/add-sub-issue"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Reprioritize sub-issue * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. */ - readonly patch: operations["issues/reprioritize-sub-issue"]; - readonly trace?: never; + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ - readonly get: operations["issues/list-events-for-timeline"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List deploy keys */ - readonly get: operations["repos/list-deploy-keys"]; - readonly put?: never; + get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ - readonly post: operations["repos/create-deploy-key"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/keys/{key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get a deploy key */ - readonly get: operations["repos/get-deploy-key"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - readonly delete: operations["repos/delete-deploy-key"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for a repository * @description Lists all labels for a repository. */ - readonly get: operations["issues/list-labels-for-repo"]; - readonly put?: never; + get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ - readonly post: operations["issues/create-label"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a label * @description Gets a label using the given name. */ - readonly get: operations["issues/get-label"]; - readonly put?: never; - readonly post?: never; + get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ - readonly delete: operations["issues/delete-label"]; - readonly options?: never; - readonly head?: never; + delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ - readonly patch: operations["issues/update-label"]; - readonly trace?: never; + patch: operations["issues/update-label"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/languages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - readonly get: operations["repos/list-languages"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/license": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the license for a repository @@ -12981,151 +14142,151 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ - readonly get: operations["licenses/get-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/merge-upstream": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - readonly post: operations["repos/merge-upstream"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/merges": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ - readonly post: operations["repos/merge"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/milestones": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List milestones * @description Lists milestones for a repository. */ - readonly get: operations["issues/list-milestones"]; - readonly put?: never; + get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ - readonly post: operations["issues/create-milestone"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/milestones/{milestone_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ - readonly get: operations["issues/get-milestone"]; - readonly put?: never; - readonly post?: never; + get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ - readonly delete: operations["issues/delete-milestone"]; - readonly options?: never; - readonly head?: never; + delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ - readonly patch: operations["issues/update-milestone"]; - readonly trace?: never; + patch: operations["issues/update-milestone"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ - readonly get: operations["issues/list-labels-for-milestone"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/notifications": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. */ - readonly get: operations["activity/list-repo-notifications-for-authenticated-user"]; + get: operations["activity/list-repo-notifications-for-authenticated-user"]; /** * Mark repository notifications as read * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly put: operations["activity/mark-repo-notifications-as-read"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a GitHub Pages site @@ -13133,7 +14294,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-pages"]; + get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). @@ -13142,7 +14303,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["repos/update-information-about-pages-site"]; + put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." @@ -13151,7 +14312,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-pages-site"]; + post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). @@ -13160,18 +14321,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete-pages-site"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/builds": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub Pages builds @@ -13179,27 +14340,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/list-pages-builds"]; - readonly put?: never; + get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - readonly post: operations["repos/request-pages-build"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/builds/latest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get latest Pages build @@ -13207,21 +14368,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-latest-pages-build"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/builds/{build_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Pages build @@ -13229,43 +14390,43 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-pages-build"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/pages/deployments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * * The authenticated user must have write permission to the repository. */ - readonly post: operations["repos/create-pages-deployment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the status of a GitHub Pages deployment @@ -13273,43 +14434,43 @@ export type paths = { * * The authenticated user must have read permission for the GitHub Pages site. */ - readonly get: operations["repos/get-pages-deployment"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-pages-deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a GitHub Pages deployment * @description Cancels a GitHub Pages deployment. * * The authenticated user must have write permissions for the GitHub Pages site. */ - readonly post: operations["repos/cancel-pages-deployment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/cancel-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/health": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/health": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a DNS health check for GitHub Pages @@ -13321,85 +14482,61 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-pages-health-check"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-pages-health-check"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if private vulnerability reporting is enabled for a repository * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". */ - readonly get: operations["repos/check-private-vulnerability-reporting"]; + get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." */ - readonly put: operations["repos/enable-private-vulnerability-reporting"]; - readonly post?: never; + put: operations["repos/enable-private-vulnerability-reporting"]; + post?: never; /** * Disable private vulnerability reporting for a repository * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". */ - readonly delete: operations["repos/disable-private-vulnerability-reporting"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-private-vulnerability-reporting"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly get: operations["projects/list-for-repo"]; - readonly put?: never; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly post: operations["projects/create-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/properties/values": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all custom property values for a repository * @description Gets all custom property values that are set for a repository. * Users with read access to the repository can use this endpoint. */ - readonly get: operations["repos/get-custom-properties-values"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["repos/custom-properties-for-repos-get-repository-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for a repository * @description Create new or update existing custom property values for a repository. @@ -13407,15 +14544,15 @@ export type paths = { * * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ - readonly patch: operations["repos/create-or-update-custom-properties-values"]; - readonly trace?: never; + patch: operations["repos/custom-properties-for-repos-create-or-update-repository-values"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pull requests @@ -13434,8 +14571,8 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list"]; - readonly put?: never; + get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -13451,19 +14588,19 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List review comments in a repository @@ -13477,21 +14614,21 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-review-comments-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a review comment for a pull request @@ -13504,16 +14641,16 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/get-review-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ - readonly delete: operations["pulls/delete-review-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. @@ -13525,43 +14662,43 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["pulls/update-review-comment"]; - readonly trace?: never; + patch: operations["pulls/update-review-comment"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ - readonly get: operations["reactions/list-for-pull-request-review-comment"]; - readonly put?: never; + get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - readonly post: operations["reactions/create-for-pull-request-review-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description > [!NOTE] @@ -13569,18 +14706,18 @@ export type paths = { * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ - readonly delete: operations["reactions/delete-for-pull-request-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a pull request @@ -13608,12 +14745,12 @@ export type paths = { * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ - readonly get: operations["pulls/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -13627,37 +14764,37 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["pulls/update"]; - readonly trace?: never; + patch: operations["pulls/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-with-pr-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/create-with-pr-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List review comments on a pull request @@ -13671,8 +14808,8 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-review-comments"]; - readonly put?: never; + get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." @@ -13691,22 +14828,22 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create-review-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. @@ -13721,19 +14858,19 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create-reply-for-review-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commits on a pull request @@ -13748,21 +14885,21 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/files": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pull requests files @@ -13778,75 +14915,75 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-files"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. */ - readonly get: operations["pulls/check-if-merged"]; + get: operations["pulls/check-if-merged"]; /** * Merge a pull request * @description Merges a pull request into the base branch. * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ - readonly put: operations["pulls/merge"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ - readonly get: operations["pulls/list-requested-reviewers"]; - readonly put?: never; + get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description Requests reviews for a pull request from a given set of users and/or teams. * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ - readonly post: operations["pulls/request-reviewers"]; + post: operations["pulls/request-reviewers"]; /** * Remove requested reviewers from a pull request * @description Removes review requests from a pull request for a given set of users and/or teams. */ - readonly delete: operations["pulls/remove-requested-reviewers"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reviews for a pull request @@ -13859,8 +14996,8 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-reviews"]; - readonly put?: never; + get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. @@ -13881,19 +15018,19 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create-review"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a review for a pull request @@ -13906,7 +15043,7 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/get-review"]; + get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. @@ -13918,8 +15055,8 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly put: operations["pulls/update-review"]; - readonly post?: never; + put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. @@ -13931,18 +15068,18 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly delete: operations["pulls/delete-pending-review"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List comments for a pull request review @@ -13955,23 +15092,23 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-comments-for-review"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. @@ -13986,23 +15123,23 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly put: operations["pulls/dismiss-review"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." @@ -14014,40 +15151,40 @@ export type paths = { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/submit-review"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * 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; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/readme": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository README @@ -14058,21 +15195,21 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ - readonly get: operations["repos/get-readme"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/readme/{dir}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository README for a directory @@ -14083,21 +15220,21 @@ export type paths = { * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ - readonly get: operations["repos/get-readme-in-directory"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List releases @@ -14105,27 +15242,27 @@ export type paths = { * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - readonly get: operations["repos/list-releases"]; - readonly put?: never; + get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ - readonly post: operations["repos/create-release"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/assets/{asset_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a release asset @@ -14137,46 +15274,46 @@ export type paths = { * The API will either redirect the client to the location, or stream it directly if possible. * API clients should handle both a `200` or `302` response. */ - readonly get: operations["repos/get-release-asset"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ - readonly delete: operations["repos/delete-release-asset"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ - readonly patch: operations["repos/update-release-asset"]; - readonly trace?: never; + patch: operations["repos/update-release-asset"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/generate-notes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - readonly post: operations["repos/generate-release-notes"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/latest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the latest release @@ -14184,41 +15321,41 @@ export type paths = { * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - readonly get: operations["repos/get-latest-release"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/tags/{tag}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ - readonly get: operations["repos/get-release-by-tag"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a release @@ -14227,33 +15364,33 @@ export type paths = { * > [!NOTE] * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ - readonly get: operations["repos/get-release"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ - readonly delete: operations["repos/delete-release"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ - readonly patch: operations["repos/update-release"]; - readonly trace?: never; + patch: operations["repos/update-release"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/assets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List release assets */ - readonly get: operations["repos/list-release-assets"]; - readonly put?: never; + get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in @@ -14276,47 +15413,47 @@ export type paths = { * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - readonly post: operations["repos/upload-release-asset"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ - readonly get: operations["reactions/list-for-release"]; - readonly put?: never; + get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - readonly post: operations["reactions/create-for-release"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description > [!NOTE] @@ -14324,18 +15461,18 @@ export type paths = { * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ - readonly delete: operations["reactions/delete-for-release"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rules/branches/{branch}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rules/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get rules for a branch @@ -14344,87 +15481,87 @@ export type paths = { * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" * enforcement statuses are not returned. */ - readonly get: operations["repos/get-branch-rules"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-branch-rules"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all repository rulesets * @description Get all the rulesets for a repository. */ - readonly get: operations["repos/get-repo-rulesets"]; - readonly put?: never; + get: operations["repos/get-repo-rulesets"]; + put?: never; /** * Create a repository ruleset * @description Create a ruleset for a repository. */ - readonly post: operations["repos/create-repo-ruleset"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-repo-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets/rule-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository rule suites * @description Lists suites of rule evaluations at the repository level. * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-repo-rule-suites"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-repo-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository rule suite * @description Gets information about a suite of rule evaluations from within a repository. * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-repo-rule-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-repo-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository ruleset @@ -14433,29 +15570,69 @@ export type paths = { * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user * making the API request has write access to the ruleset. */ - readonly get: operations["repos/get-repo-ruleset"]; + get: operations["repos/get-repo-ruleset"]; /** * Update a repository ruleset * @description Update a ruleset for a repository. */ - readonly put: operations["repos/update-repo-ruleset"]; - readonly post?: never; + put: operations["repos/update-repo-ruleset"]; + post?: never; /** * Delete a repository ruleset * @description Delete a ruleset for a repository. */ - readonly delete: operations["repos/delete-repo-ruleset"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + delete: operations["repos/delete-repo-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset history + * @description Get the history of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset version + * @description Get a version of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List secret scanning alerts for a repository @@ -14465,21 +15642,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/list-alerts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a secret scanning alert @@ -14489,29 +15666,31 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/get-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * + * You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + * * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly patch: operations["secret-scanning/update-alert"]; - readonly trace?: never; + patch: operations["secret-scanning/update-alert"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List locations for a secret scanning alert @@ -14521,24 +15700,24 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/list-locations-for-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a push protection bypass * @description Creates a bypass for a previously push protected secret. @@ -14547,41 +15726,44 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["secret-scanning/create-push-protection-bypass"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/secret-scanning/scan-history": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get secret scanning scan history for a repository * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * + * > [!NOTE] + * > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/get-scan-history"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository security advisories @@ -14591,8 +15773,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ - readonly get: operations["security-advisories/list-repository-advisories"]; - readonly put?: never; + get: operations["security-advisories/list-repository-advisories"]; + put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. @@ -14601,40 +15783,40 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly post: operations["security-advisories/create-repository-advisory"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-repository-advisory"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/reports": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/reports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Privately report a security vulnerability * @description Report a security vulnerability to the maintainers of the repository. * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. */ - readonly post: operations["security-advisories/create-private-vulnerability-report"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-private-vulnerability-report"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository security advisory @@ -14647,12 +15829,12 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ - readonly get: operations["security-advisories/get-repository-advisory"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["security-advisories/get-repository-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. @@ -14662,18 +15844,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly patch: operations["security-advisories/update-repository-advisory"]; - readonly trace?: never; + patch: operations["security-advisories/update-repository-advisory"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Request a CVE for a repository security advisory * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." @@ -14684,22 +15866,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly post: operations["security-advisories/create-repository-advisory-cve-request"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-repository-advisory-cve-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. @@ -14707,19 +15889,19 @@ export type paths = { * > [!NOTE] * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ - readonly post: operations["security-advisories/create-fork"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stargazers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List stargazers @@ -14729,21 +15911,21 @@ export type paths = { * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ - readonly get: operations["activity/list-stargazers-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/code_frequency": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the weekly commit activity @@ -14752,41 +15934,41 @@ export type paths = { * > [!NOTE] * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ - readonly get: operations["repos/get-code-frequency-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/commit_activity": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - readonly get: operations["repos/get-commit-activity-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/contributors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all contributor commit activity @@ -14800,21 +15982,21 @@ export type paths = { * > [!NOTE] * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ - readonly get: operations["repos/get-contributors-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/participation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the weekly commit count @@ -14824,21 +16006,21 @@ export type paths = { * * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ - readonly get: operations["repos/get-participation-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/punch_card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the hourly commit count for each day @@ -14850,168 +16032,108 @@ export type paths = { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - readonly get: operations["repos/get-punch-card-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/statuses/{sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - readonly post: operations["repos/create-commit-status"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/subscribers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List watchers * @description Lists the people watching the specified repository. */ - readonly get: operations["activity/list-watchers-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. */ - readonly get: operations["activity/get-repo-subscription"]; + get: operations["activity/get-repo-subscription"]; /** * Set a repository subscription * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. */ - readonly put: operations["activity/set-repo-subscription"]; - readonly post?: never; + put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). */ - readonly delete: operations["activity/delete-repo-subscription"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/tags": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List repository tags */ - readonly get: operations["repos/list-tags"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/tags/protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Closing down - List tag protection states for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - * - * This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ - readonly get: operations["repos/list-tag-protection"]; - readonly put?: never; - /** - * Closing down - Create a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - * - * This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - readonly post: operations["repos/create-tag-protection"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - /** - * Closing down - Delete a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - * - * This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - readonly delete: operations["repos/delete-tag-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/tarball/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download a repository archive (tar) @@ -15022,21 +16144,21 @@ export type paths = { * > [!NOTE] * > For private repositories, these links are temporary and expire after five minutes. */ - readonly get: operations["repos/download-tarball-archive"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository teams @@ -15046,169 +16168,169 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/list-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/topics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get all repository topics */ - readonly get: operations["repos/get-all-topics"]; + get: operations["repos/get-all-topics"]; /** Replace all repository topics */ - readonly put: operations["repos/replace-all-topics"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/traffic/clones": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/traffic/clones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repository clones * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly get: operations["repos/get-clones"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-clones"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/traffic/popular/paths": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/traffic/popular/paths": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get top referral paths * @description Get the top 10 popular contents over the last 14 days. */ - readonly get: operations["repos/get-top-paths"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-top-paths"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/traffic/popular/referrers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/traffic/popular/referrers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get top referral sources * @description Get the top 10 referrers over the last 14 days. */ - readonly get: operations["repos/get-top-referrers"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-top-referrers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/traffic/views": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/traffic/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get page views * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly get: operations["repos/get-views"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/transfer": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-views"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - readonly post: operations["repos/transfer"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if vulnerability alerts are enabled for a repository * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly get: operations["repos/check-vulnerability-alerts"]; + get: operations["repos/check-vulnerability-alerts"]; /** * Enable vulnerability alerts * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly put: operations["repos/enable-vulnerability-alerts"]; - readonly post?: never; + put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @description Disables dependency alerts and the dependency graph for a repository. * The authenticated user must have admin access to the repository. For more information, * see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly delete: operations["repos/disable-vulnerability-alerts"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/zipball/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download a repository archive (zip) @@ -15219,43 +16341,43 @@ export type paths = { * > [!NOTE] * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ - readonly get: operations["repos/download-zipball-archive"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{template_owner}/{template_repo}/generate": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ - readonly post: operations["repos/create-using-template"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public repositories @@ -15265,21 +16387,21 @@ export type paths = { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ - readonly get: operations["repos/list-public"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/code": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search code @@ -15304,21 +16426,21 @@ export type paths = { * * This endpoint requires you to authenticate and limits you to 10 requests per minute. */ - readonly get: operations["search/code"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search commits @@ -15331,21 +16453,21 @@ export type paths = { * * `q=repo:octocat/Spoon-Knife+css` */ - readonly get: operations["search/commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search issues and pull requests @@ -15363,21 +16485,21 @@ export type paths = { * > [!NOTE] * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - readonly get: operations["search/issues-and-pull-requests"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search labels @@ -15391,21 +16513,21 @@ export type paths = { * * The labels that best match the query appear first in the search results. */ - readonly get: operations["search/labels"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search repositories @@ -15419,21 +16541,21 @@ export type paths = { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - readonly get: operations["search/repos"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/topics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search topics @@ -15447,21 +16569,21 @@ export type paths = { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - readonly get: operations["search/topics"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search users @@ -15477,21 +16599,21 @@ export type paths = { * * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." */ - readonly get: operations["search/users"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a team (Legacy) @@ -15499,9 +16621,9 @@ export type paths = { * @description > [!WARNING] * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ - readonly get: operations["teams/get-legacy"]; - readonly put?: never; - readonly post?: never; + get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated @@ -15512,9 +16634,9 @@ export type paths = { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - readonly delete: operations["teams/delete-legacy"]; - readonly options?: never; - readonly head?: never; + delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated @@ -15526,259 +16648,15 @@ export type paths = { * > [!NOTE] * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ - readonly patch: operations["teams/update-legacy"]; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussions-legacy"]; - readonly put?: never; - /** - * Create a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-legacy"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-legacy"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-legacy"]; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussion-comments-legacy"]; - readonly put?: never; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-comment-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-comment-legacy"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-comment-legacy"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-comment-legacy"]; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-comment-legacy"]; - readonly put?: never; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-comment-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-legacy"]; - readonly put?: never; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + patch: operations["teams/update-legacy"]; + trace?: never; }; - readonly "/teams/{team_id}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pending team invitations (Legacy) @@ -15788,21 +16666,21 @@ export type paths = { * * 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`. */ - readonly get: operations["teams/list-pending-invitations-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-pending-invitations-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team members (Legacy) @@ -15812,21 +16690,21 @@ export type paths = { * * Team members will include the members of child teams. */ - readonly get: operations["teams/list-members-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/members/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get team member (Legacy) @@ -15837,7 +16715,7 @@ export type paths = { * * To list members in a team, the team must be visible to the authenticated user. */ - readonly get: operations["teams/get-member-legacy"]; + get: operations["teams/get-member-legacy"]; /** * Add team member (Legacy) * @deprecated @@ -15854,8 +16732,8 @@ export type paths = { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["teams/add-member-legacy"]; - readonly post?: never; + put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated @@ -15870,18 +16748,18 @@ export type paths = { * > [!NOTE] * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly delete: operations["teams/remove-member-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/memberships/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get team membership for a user (Legacy) @@ -15898,7 +16776,7 @@ export type paths = { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ - readonly get: operations["teams/get-membership-for-user-legacy"]; + get: operations["teams/get-membership-for-user-legacy"]; /** * Add or update team membership for a user (Legacy) * @deprecated @@ -15916,8 +16794,8 @@ export type paths = { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - readonly put: operations["teams/add-or-update-membership-for-user-legacy"]; - readonly post?: never; + put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated @@ -15931,82 +16809,18 @@ export type paths = { * > [!NOTE] * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly delete: operations["teams/remove-membership-for-user-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List team projects (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ - readonly get: operations["teams/list-projects-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/projects/{project_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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. - */ - readonly get: operations["teams/check-permissions-for-project-legacy"]; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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. - */ - readonly put: operations["teams/add-or-update-project-permissions-legacy"]; - readonly post?: never; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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. - */ - readonly delete: operations["teams/remove-project-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team repositories (Legacy) @@ -16014,21 +16828,21 @@ export type paths = { * @description > [!WARNING] * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ - readonly get: operations["teams/list-repos-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/repos/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check team permissions for a repository (Legacy) @@ -16041,7 +16855,7 @@ export type paths = { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ - readonly get: operations["teams/check-permissions-for-repo-legacy"]; + get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated @@ -16052,8 +16866,8 @@ export type paths = { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["teams/add-or-update-repo-permissions-legacy"]; - readonly post?: never; + put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated @@ -16062,18 +16876,18 @@ export type paths = { * * 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. */ - readonly delete: operations["teams/remove-repo-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List child teams (Legacy) @@ -16081,93 +16895,93 @@ export type paths = { * @description > [!WARNING] * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ - readonly get: operations["teams/list-child-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ - readonly get: operations["users/get-authenticated"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - readonly patch: operations["users/update-authenticated"]; - readonly trace?: never; + patch: operations["users/update-authenticated"]; + trace?: never; }; - readonly "/user/blocks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users blocked by the authenticated user * @description List the users you've blocked on your personal account. */ - readonly get: operations["users/list-blocked-by-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-blocked-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/blocks/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user is blocked by the authenticated user * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. */ - readonly get: operations["users/check-blocked"]; + get: operations["users/check-blocked"]; /** * Block a user * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. */ - readonly put: operations["users/block"]; - readonly post?: never; + put: operations["users/block"]; + post?: never; /** * Unblock a user * @description Unblocks the given user and returns a 204. */ - readonly delete: operations["users/unblock"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/unblock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces for the authenticated user @@ -16175,8 +16989,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-for-authenticated-user"]; - readonly put?: never; + get: operations["codespaces/list-for-authenticated-user"]; + put?: never; /** * Create a codespace for the authenticated user * @description Creates a new codespace, owned by the authenticated user. @@ -16185,19 +16999,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List secrets for the authenticated user @@ -16208,21 +17022,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/list-secrets-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-secrets-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get public key for the authenticated user @@ -16232,21 +17046,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/get-public-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-public-key-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a secret for the authenticated user @@ -16256,7 +17070,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/get-secret-for-authenticated-user"]; + get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using @@ -16266,8 +17080,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; - readonly post?: never; + put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + post?: never; /** * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. @@ -16276,18 +17090,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-secret-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for a user secret @@ -16297,7 +17111,7 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. @@ -16306,22 +17120,22 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. @@ -16330,8 +17144,8 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; - readonly post?: never; + put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. @@ -16340,18 +17154,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a codespace for the authenticated user @@ -16359,18 +17173,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/get-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["codespaces/get-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; + delete: operations["codespaces/delete-for-authenticated-user"]; + options?: never; + head?: never; /** * Update a codespace for the authenticated user * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. @@ -16379,18 +17193,18 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly patch: operations["codespaces/update-for-authenticated-user"]; - readonly trace?: never; + patch: operations["codespaces/update-for-authenticated-user"]; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/exports": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/exports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Export a codespace for the authenticated user * @description Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. @@ -16399,19 +17213,19 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/export-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/export-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/exports/{export_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/exports/{export_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get details about a codespace export @@ -16419,21 +17233,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/get-export-details-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-export-details-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/machines": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List machine types for a codespace @@ -16441,24 +17255,24 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/codespace-machines-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/codespaces/{codespace_name}/publish": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["codespaces/codespace-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/codespaces/{codespace_name}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository from an unpublished codespace * @description Publishes an unpublished codespace, creating a new repository and assigning it to the codespace. @@ -16469,63 +17283,63 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/publish-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/publish-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/start": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Start a codespace for the authenticated user * @description Starts a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/start-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/stop": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Stop a codespace for the authenticated user * @description Stops a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/stop-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/stop-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/docker/conflicts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get list of conflicting packages during Docker migration for authenticated-user @@ -16533,41 +17347,41 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ - readonly get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/email/visibility": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/email/visibility": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set primary email visibility for the authenticated user * @description Sets the visibility for your primary email addresses. */ - readonly patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - readonly trace?: never; + patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; + trace?: never; }; - readonly "/user/emails": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List email addresses for the authenticated user @@ -16576,96 +17390,96 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ - readonly get: operations["users/list-emails-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly post: operations["users/add-email-for-authenticated-user"]; + post: operations["users/add-email-for-authenticated-user"]; /** * Delete an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly delete: operations["users/delete-email-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/followers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ - readonly get: operations["users/list-followers-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/following": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ - readonly get: operations["users/list-followed-by-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/following/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Check if a person is followed by the authenticated user */ - readonly get: operations["users/check-person-is-followed-by-authenticated"]; + get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ - readonly put: operations["users/follow"]; - readonly post?: never; + put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ - readonly delete: operations["users/unfollow"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/gpg_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GPG keys for the authenticated user @@ -16673,27 +17487,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ - readonly get: operations["users/list-gpg-keys-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ - readonly post: operations["users/create-gpg-key-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/gpg_keys/{gpg_key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a GPG key for the authenticated user @@ -16701,27 +17515,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ - readonly get: operations["users/get-gpg-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ - readonly delete: operations["users/delete-gpg-key-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/installations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List app installations accessible to the user access token @@ -16731,21 +17545,21 @@ export type paths = { * * You can find the permissions for the installation under the `permissions` key. */ - readonly get: operations["apps/list-installations-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/installations/{installation_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories accessible to the user access token @@ -16755,77 +17569,77 @@ export type paths = { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - readonly get: operations["apps/list-installation-repos-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/installations/{installation_id}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. * * This endpoint only works for PATs (classic) with the `repo` scope. */ - readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"]; - readonly post?: never; + put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. * * This endpoint only works for PATs (classic) with the `repo` scope. */ - readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/interaction-limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get interaction restrictions for your public repositories * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - readonly get: operations["interactions/get-restrictions-for-authenticated-user"]; + get: operations["interactions/get-restrictions-for-authenticated-user"]; /** * Set interaction restrictions for your public repositories * @description Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - readonly put: operations["interactions/set-restrictions-for-authenticated-user"]; - readonly post?: never; + put: operations["interactions/set-restrictions-for-authenticated-user"]; + post?: never; /** * Remove interaction restrictions from your public repositories * @description Removes any interaction restrictions from your public repositories. */ - readonly delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["interactions/remove-restrictions-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List user account issues assigned to the authenticated user @@ -16841,21 +17655,21 @@ export type paths = { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public SSH keys for the authenticated user @@ -16863,27 +17677,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ - readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. */ - readonly post: operations["users/create-public-ssh-key-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/keys/{key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a public SSH key for the authenticated user @@ -16891,135 +17705,135 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ - readonly get: operations["users/get-public-ssh-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ - readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/marketplace_purchases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/marketplace_purchases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List subscriptions for the authenticated user * @description Lists the active subscriptions for the authenticated user. */ - readonly get: operations["apps/list-subscriptions-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-subscriptions-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/marketplace_purchases/stubbed": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/marketplace_purchases/stubbed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List subscriptions for the authenticated user (stubbed) * @description Lists the active subscriptions for the authenticated user. */ - readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/memberships/orgs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ - readonly get: operations["orgs/list-memberships-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/memberships/orgs/{org}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ - readonly get: operations["orgs/get-membership-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ - readonly patch: operations["orgs/update-membership-for-authenticated-user"]; - readonly trace?: never; + patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; - readonly "/user/migrations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List user migrations * @description Lists all migrations a user has started. */ - readonly get: operations["migrations/list-for-authenticated-user"]; - readonly put?: never; + get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ - readonly post: operations["migrations/start-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user migration status @@ -17032,21 +17846,21 @@ export type paths = { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). */ - readonly get: operations["migrations/get-status-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/get-status-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}/archive": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download a user migration archive @@ -17072,65 +17886,65 @@ export type paths = { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - readonly get: operations["migrations/get-archive-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a user migration archive * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - readonly delete: operations["migrations/delete-archive-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/delete-archive-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}/repos/{repo_name}/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Unlock a user repository * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - readonly delete: operations["migrations/unlock-repo-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/unlock-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ - readonly get: operations["migrations/list-repos-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/orgs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organizations for the authenticated user @@ -17141,21 +17955,21 @@ export type paths = { * > [!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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List packages for the authenticated user's namespace @@ -17163,21 +17977,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package for the authenticated user @@ -17185,30 +17999,30 @@ export type paths = { * * 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; - readonly post?: never; + get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * 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. 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. @@ -17219,19 +18033,19 @@ export type paths = { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List package versions for a package owned by the authenticated user @@ -17239,21 +18053,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package version for the authenticated user @@ -17261,9 +18075,9 @@ export type paths = { * * 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; - readonly post?: never; + get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. @@ -17272,21 +18086,21 @@ export type paths = { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. @@ -17297,39 +18111,19 @@ export type paths = { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly post: operations["projects/create-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/public_emails": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public email addresses for the authenticated user @@ -17339,21 +18133,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ - readonly get: operations["users/list-public-emails-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories for the authenticated user @@ -17361,97 +18155,97 @@ export type paths = { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - readonly get: operations["repos/list-for-authenticated-user"]; - readonly put?: never; + get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ - readonly post: operations["repos/create-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/repository_invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - readonly get: operations["repos/list-invitations-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/repository_invitations/{invitation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ - readonly delete: operations["repos/decline-invitation-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ - readonly patch: operations["repos/accept-invitation-for-authenticated-user"]; - readonly trace?: never; + patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; - readonly "/user/social_accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ - readonly get: operations["users/list-social-accounts-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly post: operations["users/add-social-account-for-authenticated-user"]; + post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly delete: operations["users/delete-social-account-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/ssh_signing_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List SSH signing keys for the authenticated user @@ -17459,27 +18253,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ - readonly get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ - readonly post: operations["users/create-ssh-signing-key-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/ssh_signing_keys/{ssh_signing_key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an SSH signing key for the authenticated user @@ -17487,27 +18281,27 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ - readonly get: operations["users/get-ssh-signing-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ - readonly delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories starred by the authenticated user @@ -17517,69 +18311,69 @@ export type paths = { * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ - readonly get: operations["activity/list-repos-starred-by-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/starred/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. */ - readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["activity/star-repo-for-authenticated-user"]; - readonly post?: never; + put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ - readonly delete: operations["activity/unstar-repo-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/subscriptions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ - readonly get: operations["activity/list-watched-repos-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List teams for the authenticated user @@ -17590,21 +18384,21 @@ export type paths = { * * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ - readonly get: operations["teams/list-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/{account_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user using their ID @@ -17616,21 +18410,41 @@ export type paths = { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ - readonly get: operations["users/get-by-id"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/get-by-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/{user_id}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for user owned project + * @description Create draft issue item for the specified user owned project. + */ + post: operations["projects/create-draft-item-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users @@ -17638,21 +18452,41 @@ export type paths = { * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ - readonly get: operations["users/list"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{user_id}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for a user-owned project + * @description Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user @@ -17664,21 +18498,105 @@ export type paths = { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ - readonly get: operations["users/get-by-username"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/attestations/{subject_digest}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["users/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["users/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["users/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + */ + delete: operations["users/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List attestations @@ -17688,21 +18606,21 @@ export type paths = { * * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly get: operations["users/list-attestations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/docker/conflicts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get list of conflicting packages during Docker migration for user @@ -17710,21 +18628,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ - readonly get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List events for the authenticated user @@ -17733,21 +18651,21 @@ export type paths = { * > [!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. */ - readonly get: operations["activity/list-events-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/events/orgs/{org}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization events for the authenticated user @@ -17756,139 +18674,139 @@ export type paths = { * > [!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. */ - readonly get: operations["activity/list-org-events-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/events/public": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events for a user * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-events-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/followers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List followers of a user * @description Lists the people following the specified user. */ - readonly get: operations["users/list-followers-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/following": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ - readonly get: operations["users/list-following-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/following/{target_user}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Check if a user follows another user */ - readonly get: operations["users/check-following-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/gists": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List gists for a user * @description Lists public gists for the specified user: */ - readonly get: operations["gists/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/gpg_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ - readonly get: operations["users/list-gpg-keys-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/hovercard": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get contextual information for a user @@ -17898,21 +18816,21 @@ export type paths = { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["users/get-context-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user installation for the authenticated app @@ -17920,41 +18838,41 @@ export type paths = { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-user-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - readonly get: operations["users/list-public-keys-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/orgs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organizations for a user @@ -17962,21 +18880,21 @@ export type paths = { * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ - readonly get: operations["orgs/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List packages for a user @@ -17984,21 +18902,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package for a user @@ -18006,9 +18924,9 @@ export type paths = { * * 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; - readonly post?: never; + get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. @@ -18017,21 +18935,21 @@ export type paths = { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. @@ -18044,19 +18962,19 @@ export type paths = { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List package versions for a package owned by a user @@ -18064,21 +18982,21 @@ export type paths = { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package version for a user @@ -18086,9 +19004,9 @@ export type paths = { * * 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; - readonly post?: never; + get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. @@ -18097,21 +19015,21 @@ export type paths = { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. @@ -18124,39 +19042,175 @@ export type paths = { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List user projects - * @description Lists projects for a user. - */ - readonly get: operations["projects/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/received_events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List projects for user + * @description List all projects owned by a specific user accessible by the authenticated user. + */ + get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for user + * @description Get a specific user-owned project. + */ + get: operations["projects/get-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for user + * @description List all fields for a specific user-owned project. + */ + get: operations["projects/list-fields-for-user"]; + put?: never; + /** + * Add field to user owned project + * @description Add a field to a specified user owned project. + */ + post: operations["projects/add-field-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for user + * @description Get a specific field for a user-owned project. + */ + get: operations["projects/get-field-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user owned project + * @description List all items for a specific user-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-user"]; + put?: never; + /** + * Add item to user owned project + * @description Add an issue or pull request item to the specified user owned project. + */ + post: operations["projects/add-item-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for a user owned project + * @description Get a specific item from a user-owned project. + */ + get: operations["projects/get-user-item"]; + put?: never; + post?: never; + /** + * Delete project item for user + * @description Delete a specific item from a user-owned project. + */ + delete: operations["projects/delete-item-for-user"]; + options?: never; + head?: never; + /** + * Update project item for user + * @description Update a specific item in a user-owned project. + */ + patch: operations["projects/update-item-for-user"]; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user project view + * @description List items in a user project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List events received by the authenticated user @@ -18166,174 +19220,171 @@ export type paths = { * > [!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. */ - readonly get: operations["activity/list-received-events-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/received_events/public": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events received by a user * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-received-public-events-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ - readonly get: operations["repos/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/settings/billing/actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ - readonly get: operations["billing/get-github-actions-billing-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/settings/billing/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ - readonly get: operations["billing/get-github-packages-billing-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/settings/billing/shared-storage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for a user + * @description Gets a report of premium request usage for a user. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for a user + * @description Gets a report of the total usage for a user. + * + * **Note:** This endpoint is only available to users with access to the enhanced billing platform. + */ + get: operations["billing/get-github-billing-usage-report-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for a user + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Gets a summary report of usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - readonly get: operations["billing/get-shared-storage-billing-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["billing/get-github-billing-usage-summary-report-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/social_accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ - readonly get: operations["users/list-social-accounts-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/ssh_signing_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ - readonly get: operations["users/list-ssh-signing-keys-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories starred by a user @@ -18343,270 +19394,270 @@ export type paths = { * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ - readonly get: operations["activity/list-repos-starred-by-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/subscriptions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ - readonly get: operations["activity/list-repos-watched-by-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all API versions * @description Get all supported GitHub API versions. */ - readonly get: operations["meta/get-all-versions"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get-all-versions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/zen": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ - readonly get: operations["meta/get-zen"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; -}; +} export type webhooks = Record; -export type components = { +export interface components { schemas: { - readonly root: { + root: { /** Format: uri-template */ - readonly current_user_url: string; + current_user_url: string; /** Format: uri-template */ - readonly current_user_authorizations_html_url: string; + current_user_authorizations_html_url: string; /** Format: uri-template */ - readonly authorizations_url: string; + authorizations_url: string; /** Format: uri-template */ - readonly code_search_url: string; + code_search_url: string; /** Format: uri-template */ - readonly commit_search_url: string; + commit_search_url: string; /** Format: uri-template */ - readonly emails_url: string; + emails_url: string; /** Format: uri-template */ - readonly emojis_url: string; + emojis_url: string; /** Format: uri-template */ - readonly events_url: string; + events_url: string; /** Format: uri-template */ - readonly feeds_url: string; + feeds_url: string; /** Format: uri-template */ - readonly followers_url: string; + followers_url: string; /** Format: uri-template */ - readonly following_url: string; + following_url: string; /** Format: uri-template */ - readonly gists_url: string; + gists_url: string; /** * Format: uri-template * @deprecated */ - readonly hub_url?: string; + hub_url?: string; /** Format: uri-template */ - readonly issue_search_url: string; + issue_search_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly label_search_url: string; + label_search_url: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** Format: uri-template */ - readonly organization_url: string; + organization_url: string; /** Format: uri-template */ - readonly organization_repositories_url: string; + organization_repositories_url: string; /** Format: uri-template */ - readonly organization_teams_url: string; + organization_teams_url: string; /** Format: uri-template */ - readonly public_gists_url: string; + public_gists_url: string; /** Format: uri-template */ - readonly rate_limit_url: string; + rate_limit_url: string; /** Format: uri-template */ - readonly repository_url: string; + repository_url: string; /** Format: uri-template */ - readonly repository_search_url: string; + repository_search_url: string; /** Format: uri-template */ - readonly current_user_repositories_url: string; + current_user_repositories_url: string; /** Format: uri-template */ - readonly starred_url: string; + starred_url: string; /** Format: uri-template */ - readonly starred_gists_url: string; + starred_gists_url: string; /** Format: uri-template */ - readonly topic_search_url?: string; + topic_search_url?: string; /** Format: uri-template */ - readonly user_url: string; + user_url: string; /** Format: uri-template */ - readonly user_organizations_url: string; + user_organizations_url: string; /** Format: uri-template */ - readonly user_repositories_url: string; + user_repositories_url: string; /** Format: uri-template */ - readonly user_search_url: string; + user_search_url: string; }; /** * @description The package's language or package management ecosystem. * @enum {string} */ - readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; + "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ - readonly vulnerability: { + vulnerability: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name: string | null; + name: string | null; } | null; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; + vulnerable_version_range: string | null; /** @description The package version that resolves the vulnerability. */ - readonly first_patched_version: string | null; + first_patched_version: string | null; /** @description The functions in the package that are affected by the vulnerability. */ - readonly vulnerable_functions: readonly string[] | null; + readonly vulnerable_functions: string[] | null; }; - readonly "cvss-severities": { - readonly cvss_v3?: { + "cvss-severities": { + cvss_v3?: { /** @description The CVSS 3 vector string. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS 3 score. */ readonly score: number | null; } | null; - readonly cvss_v4?: { + cvss_v4?: { /** @description The CVSS 4 vector string. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS 4 score. */ readonly score: number | null; } | null; } | null; /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ - readonly "security-advisory-epss": { - readonly percentage?: number; - readonly percentile?: number; + "security-advisory-epss": { + percentage?: number; + percentile?: number; } | null; /** * Simple User * @description A GitHub user. */ - readonly "simple-user": { - readonly name?: string | null; - readonly email?: string | null; + "simple-user": { + name?: string | null; + email?: string | null; /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; + starred_at?: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; }; /** * @description The type of credit the user is receiving. * @enum {string} */ - readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; + "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; /** @description A GitHub Security Advisory. */ - readonly "global-advisory": { + "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ @@ -18624,9 +19675,9 @@ export type components = { */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; + description: string | null; /** * @description The type of advisory. * @enum {string} @@ -18636,22 +19687,22 @@ export type components = { * @description The severity of the advisory. * @enum {string} */ - readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; + severity: "critical" | "high" | "medium" | "low" | "unknown"; /** * Format: uri * @description The URL of the advisory's source code. */ - readonly source_code_location: string | null; - readonly identifiers: readonly { + source_code_location: string | null; + readonly identifiers: { /** * @description The type of identifier. * @enum {string} */ - readonly type: "CVE" | "GHSA"; + type: "CVE" | "GHSA"; /** @description The identifier value. */ - readonly value: string; + value: string; }[] | null; - readonly references: readonly string[] | null; + references: string[] | null; /** * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. @@ -18679,140 +19730,140 @@ export type components = { */ readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["vulnerability"][] | null; - readonly cvss: { + vulnerabilities: components["schemas"]["vulnerability"][] | null; + cvss: { /** @description The CVSS vector. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS score. */ readonly score: number | null; } | null; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly epss?: components["schemas"]["security-advisory-epss"]; - readonly cwes: readonly { + cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; + cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; + cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; /** @description The users who contributed to the advisory. */ - readonly credits: readonly { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; + readonly credits: { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; }[] | null; }; /** * Basic Error * @description Basic Error */ - readonly "basic-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly url?: string; - readonly status?: string; + "basic-error": { + message?: string; + documentation_url?: string; + url?: string; + status?: string; }; /** * Validation Error Simple * @description Validation Error Simple */ - readonly "validation-error-simple": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: readonly string[]; + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; }; /** * Enterprise * @description An enterprise on GitHub. */ - readonly enterprise: { + enterprise: { /** @description A short description of the enterprise. */ - readonly description?: string | null; + description?: string | null; /** * Format: uri * @example https://github.com/enterprises/octo-business */ - readonly html_url: string; + html_url: string; /** * Format: uri * @description The enterprise's website URL. */ - readonly website_url?: string | null; + website_url?: string | null; /** * @description Unique identifier of the enterprise * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the enterprise. * @example Octo Business */ - readonly name: string; + name: string; /** * @description The slug url identifier for the enterprise. * @example octo-business */ - readonly slug: string; + slug: string; /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** Format: uri */ - readonly avatar_url: string; + avatar_url: string; }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly integration: { + integration: { /** * @description Unique identifier of the GitHub app * @example 37 */ - readonly id: number; + id: number; /** * @description The slug name of the GitHub app * @example probot-owners */ - readonly slug?: string; + slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id: string; + node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; - readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; + client_id?: string; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners */ - readonly name: string; + name: string; /** @example The description of the app. */ - readonly description: string | null; + description: string | null; /** * Format: uri * @example https://example.com */ - readonly external_url: string; + external_url: string; /** * Format: uri * @example https://github.com/apps/super-ci */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly updated_at: string; + updated_at: string; /** * @description The set of permissions for the GitHub app * @example { @@ -18820,268 +19871,265 @@ export type components = { * "deployments": "write" * } */ - readonly permissions: { - readonly issues?: string; - readonly checks?: string; - readonly metadata?: string; - readonly contents?: string; - readonly deployments?: string; + permissions: { + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; } & { - readonly [key: string]: string; + [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" * ] */ - readonly events: readonly string[]; + events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ - readonly installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - readonly webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - readonly pem?: string; + installations_count?: number; } | null; /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - readonly "webhook-config-url": string; + "webhook-config-url": string; /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - readonly "webhook-config-content-type": string; + "webhook-config-content-type": string; /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - readonly "webhook-config-secret": string; - readonly "webhook-config-insecure-ssl": string | number; + "webhook-config-secret": string; + "webhook-config-insecure-ssl": string | number; /** * Webhook Configuration * @description Configuration object of the webhook */ - readonly "webhook-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"]; + "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"]; }; /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - readonly "hook-delivery-item": { + "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ - readonly id: number; + id: number; /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - readonly guid: string; + guid: string; /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - readonly delivered_at: string; + delivered_at: string; /** * @description Whether the webhook delivery is a redelivery. * @example false */ - readonly redelivery: boolean; + redelivery: boolean; /** * @description Time spent delivering. * @example 0.03 */ - readonly duration: number; + duration: number; /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - readonly status: string; + status: string; /** * @description Status code received when delivery was made. * @example 502 */ - readonly status_code: number; + status_code: number; /** * @description The event that triggered the delivery. * @example issues */ - readonly event: string; + event: string; /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - readonly action: string | null; + action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ - readonly installation_id: number | null; + installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ - readonly repository_id: number | null; + repository_id: number | null; /** * Format: date-time * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z */ - readonly throttled_at?: string | null; + throttled_at?: string | null; }; /** * Scim Error * @description Scim Error */ - readonly "scim-error": { - readonly message?: string | null; - readonly documentation_url?: string | null; - readonly detail?: string | null; - readonly status?: number; - readonly scimType?: string | null; - readonly schemas?: readonly string[]; + "scim-error": { + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; }; /** * Validation Error * @description Validation Error */ - readonly "validation-error": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: readonly { - readonly resource?: string; - readonly field?: string; - readonly message?: string; - readonly code: string; - readonly index?: number; - readonly value?: (string | null) | (number | null) | (readonly string[] | null); + "validation-error": { + message: string; + documentation_url: string; + errors?: { + resource?: string; + field?: string; + message?: string; + code: string; + index?: number; + value?: (string | null) | (number | null) | (string[] | null); }[]; }; /** * Webhook delivery * @description Delivery made by a webhook. */ - readonly "hook-delivery": { + "hook-delivery": { /** * @description Unique identifier of the delivery. * @example 42 */ - readonly id: number; + id: number; /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - readonly guid: string; + guid: string; /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - readonly delivered_at: string; + delivered_at: string; /** * @description Whether the delivery is a redelivery. * @example false */ - readonly redelivery: boolean; + redelivery: boolean; /** * @description Time spent delivering. * @example 0.03 */ - readonly duration: number; + duration: number; /** * @description Description of the status of the attempted delivery * @example failed to connect */ - readonly status: string; + status: string; /** * @description Status code received when delivery was made. * @example 502 */ - readonly status_code: number; + status_code: number; /** * @description The event that triggered the delivery. * @example issues */ - readonly event: string; + event: string; /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - readonly action: string | null; + action: string | null; /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - readonly installation_id: number | null; + installation_id: number | null; /** * @description The id of the repository associated with this event. * @example 123 */ - readonly repository_id: number | null; + repository_id: number | null; /** * Format: date-time * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z */ - readonly throttled_at?: string | null; + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com */ - readonly url?: string; - readonly request: { + url?: string; + request: { /** @description The request headers sent with the webhook delivery. */ - readonly headers: { - readonly [key: string]: unknown; + headers: { + [key: string]: unknown; } | null; /** @description The webhook payload. */ - readonly payload: { - readonly [key: string]: unknown; + payload: { + [key: string]: unknown; } | null; }; - readonly response: { + response: { /** @description The response headers received when the delivery was made. */ - readonly headers: { - readonly [key: string]: unknown; + headers: { + [key: string]: unknown; } | null; /** @description The response payload received. */ - readonly payload: string | null; + payload: string | null; }; }; /** * Integration Installation Request * @description Request to install an integration on a target */ - readonly "integration-installation-request": { + "integration-installation-request": { /** * @description Unique identifier of the request installation. * @example 42 */ - readonly id: number; + id: number; /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id?: string; - readonly account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; - readonly requester: components["schemas"]["simple-user"]; + node_id?: string; + account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; + requester: components["schemas"]["simple-user"]; /** * Format: date-time * @example 2022-07-08T16:18:44-04:00 */ - readonly created_at: string; + created_at: string; }; /** * App Permissions @@ -19093,707 +20141,746 @@ export type components = { * "single_file": "read" * } */ - readonly "app-permissions": { + "app-permissions": { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. * @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. * @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create and retrieve build artifact metadata records. + * @enum {string} + */ + artifact_metadata?: "read" | "write"; + /** + * @description The level of permission to create and retrieve the access token for repository attestations. + * @enum {string} + */ + attestations?: "read" | "write"; /** * @description The level of permission to grant the access token for checks on code. * @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. * @enum {string} */ - readonly codespaces?: "read" | "write"; + codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** - * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @description The level of permission to grant the access token to manage Dependabot secrets. * @enum {string} */ - readonly dependabot_secrets?: "read" | "write"; + dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; + /** + * @description The level of permission to grant the access token for discussions and related comments and labels. + * @enum {string} + */ + discussions?: "read" | "write"; /** * @description The level of permission to grant the access token for managing repository environments. * @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. * @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the merge queues for a repository. + * @enum {string} + */ + merge_queues?: "read" | "write"; /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. * @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** * @description The level of permission to grant the access token for packages published to GitHub Packages. * @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. * @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. * @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. * @enum {string} */ - readonly repository_custom_properties?: "read" | "write"; + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. * @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. * @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** * @description The level of permission to grant the access token to manage repository secrets. * @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. * @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** * @description The level of permission to grant the access token to manage just a single file. * @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** * @description The level of permission to grant the access token for commit statuses. * @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** * @description The level of permission to grant the access token to manage Dependabot alerts. * @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. * @enum {string} */ - readonly workflows?: "write"; + workflows?: "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + * @enum {string} + */ + custom_properties_for_organizations?: "read" | "write"; /** * @description The level of permission to grant the access token for organization teams and members. * @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** * @description The level of permission to grant the access token to manage access to an organization. * @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ - readonly organization_custom_roles?: "read" | "write"; + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom organization roles management. * @enum {string} */ - readonly organization_custom_org_roles?: "read" | "write"; + organization_custom_org_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom property management. + * @description The level of permission to grant the access token for repository custom properties management at the organization level. * @enum {string} */ - readonly organization_custom_properties?: "read" | "write" | "admin"; + 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 public preview and is subject to change. * @enum {string} */ - readonly organization_copilot_seat_management?: "write"; + organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ - readonly organization_announcement_banners?: "read" | "write"; + organization_announcement_banners?: "read" | "write"; /** * @description The level of permission to grant the access token to view events triggered by an activity in an organization. * @enum {string} */ - readonly organization_events?: "read"; + organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. * @enum {string} */ - readonly organization_personal_access_tokens?: "read" | "write"; + organization_personal_access_tokens?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. * @enum {string} */ - readonly organization_personal_access_token_requests?: "read" | "write"; + organization_personal_access_token_requests?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing an organization's plan. * @enum {string} */ - readonly organization_plan?: "read"; + organization_plan?: "read"; /** * @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"; + organization_projects?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. * @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** * @description The level of permission to grant the access token to manage organization secrets. * @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. * @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. * @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; - /** - * @description The level of permission to grant the access token to manage team discussions and related comments. - * @enum {string} - */ - readonly team_discussions?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the email addresses belonging to a user. * @enum {string} */ - readonly email_addresses?: "read" | "write"; + email_addresses?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the followers belonging to a user. * @enum {string} */ - readonly followers?: "read" | "write"; + followers?: "read" | "write"; /** * @description The level of permission to grant the access token to manage git SSH keys. * @enum {string} */ - readonly git_ssh_keys?: "read" | "write"; + git_ssh_keys?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. * @enum {string} */ - readonly gpg_keys?: "read" | "write"; + gpg_keys?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage interaction limits on a repository. * @enum {string} */ - readonly interaction_limits?: "read" | "write"; + interaction_limits?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the profile settings belonging to a user. * @enum {string} */ - readonly profile?: "write"; + profile?: "write"; /** * @description The level of permission to grant the access token to list and manage repositories a user is starring. * @enum {string} */ - readonly starring?: "read" | "write"; + starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token for organization custom properties management at the enterprise level. + * @enum {string} + */ + enterprise_custom_properties_for_organizations?: "read" | "write" | "admin"; }; /** * Simple User * @description A GitHub user. */ - readonly "nullable-simple-user": { - readonly name?: string | null; - readonly email?: string | null; + "nullable-simple-user": { + name?: string | null; + email?: string | null; /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; + starred_at?: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; } | null; /** * Installation * @description Installation */ - readonly installation: { + installation: { /** * @description The ID of the installation. * @example 1 */ - readonly id: number; - readonly account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; + id: number; + account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection: "all" | "selected"; + repository_selection: "all" | "selected"; /** * Format: uri * @example https://api.github.com/app/installations/1/access_tokens */ - readonly access_tokens_url: string; + access_tokens_url: string; /** * Format: uri * @example https://api.github.com/installation/repositories */ - readonly repositories_url: string; + repositories_url: string; /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - readonly html_url: string; + html_url: string; /** @example 1 */ - readonly app_id: number; + app_id: number; + /** @example Iv1.ab1112223334445c */ + client_id?: string; /** @description The ID of the user or organization this token is being scoped to. */ - readonly target_id: number; + target_id: number; /** @example Organization */ - readonly target_type: string; - readonly permissions: components["schemas"]["app-permissions"]; - readonly events: readonly string[]; + target_type: string; + permissions: components["schemas"]["app-permissions"]; + events: string[]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** @example config.yaml */ - readonly single_file_name: string | null; + single_file_name: string | null; /** @example true */ - readonly has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean; /** * @example [ * "config.yml", * ".github/issue_TEMPLATE.md" * ] */ - readonly single_file_paths?: readonly string[]; + single_file_paths?: string[]; /** @example github-actions */ - readonly app_slug: string; - readonly suspended_by: components["schemas"]["nullable-simple-user"]; + app_slug: string; + suspended_by: components["schemas"]["nullable-simple-user"]; /** Format: date-time */ - readonly suspended_at: string | null; + suspended_at: string | null; /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - readonly contact_email?: string | null; + contact_email?: string | null; }; /** * License Simple * @description License Simple */ - readonly "nullable-license-simple": { + "nullable-license-simple": { /** @example mit */ - readonly key: string; + key: string; /** @example MIT License */ - readonly name: string; + name: string; /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + url: string | null; /** @example MIT */ - readonly spdx_id: string | null; + spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + node_id: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; } | null; /** * Repository * @description A repository on GitHub. */ - readonly repository: { + repository: { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -19801,7 +20888,7 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -19810,7 +20897,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -19818,7 +20905,7 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -19827,503 +20914,508 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; }; /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - readonly "installation-token": { - readonly token: string; - readonly expires_at: string; - readonly permissions?: components["schemas"]["app-permissions"]; + "installation-token": { + token: string; + expires_at: string; + permissions?: components["schemas"]["app-permissions"]; /** @enum {string} */ - readonly repository_selection?: "all" | "selected"; - readonly repositories?: readonly components["schemas"]["repository"][]; + repository_selection?: "all" | "selected"; + repositories?: components["schemas"]["repository"][]; /** @example README.md */ - readonly single_file?: string; + single_file?: string; /** @example true */ - readonly has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean; /** * @example [ * "config.yml", * ".github/issue_TEMPLATE.md" * ] */ - readonly single_file_paths?: readonly string[]; + single_file_paths?: string[]; }; /** Scoped Installation */ - readonly "nullable-scoped-installation": { - readonly permissions: components["schemas"]["app-permissions"]; + "nullable-scoped-installation": { + permissions: components["schemas"]["app-permissions"]; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection: "all" | "selected"; + repository_selection: "all" | "selected"; /** @example config.yaml */ - readonly single_file_name: string | null; + single_file_name: string | null; /** @example true */ - readonly has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean; /** * @example [ * "config.yml", * ".github/issue_TEMPLATE.md" * ] */ - readonly single_file_paths?: readonly string[]; + single_file_paths?: string[]; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repositories_url: string; - readonly account: components["schemas"]["simple-user"]; + repositories_url: string; + account: components["schemas"]["simple-user"]; } | null; /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ - readonly authorization: { + authorization: { /** Format: int64 */ - readonly id: number; + id: number; /** Format: uri */ - readonly url: string; + url: string; /** @description A list of scopes that this authorization is in. */ - readonly scopes: readonly string[] | null; - readonly token: string; - readonly token_last_eight: string | null; - readonly hashed_token: string | null; - readonly app: { - readonly client_id: string; - readonly name: string; + scopes: string[] | null; + token: string; + token_last_eight: string | null; + hashed_token: string | null; + app: { + client_id: string; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly note: string | null; + note: string | null; /** Format: uri */ - readonly note_url: string | null; + note_url: string | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly created_at: string; - readonly fingerprint: string | null; - readonly user?: components["schemas"]["nullable-simple-user"]; - readonly installation?: components["schemas"]["nullable-scoped-installation"]; + created_at: string; + fingerprint: string | null; + user?: components["schemas"]["nullable-simple-user"]; + installation?: components["schemas"]["nullable-scoped-installation"]; /** Format: date-time */ - readonly expires_at: string | null; + expires_at: string | null; }; /** * Simple Classroom Repository * @description A GitHub repository view for Classroom */ - readonly "simple-classroom-repository": { + "simple-classroom-repository": { /** * @description A unique identifier of the repository. * @example 1296269 */ - readonly id: number; + id: number; /** * @description The full, globally unique name of the repository. * @example octocat/Hello-World */ - readonly full_name: string; + full_name: string; /** * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** * @description The GraphQL identifier of the repository. * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @description Whether the repository is private. */ - readonly private: boolean; + private: boolean; /** * @description The default branch for the repository. * @example main */ - readonly default_branch: string; + default_branch: string; }; /** * Organization Simple for Classroom * @description A GitHub organization. */ - readonly "simple-classroom-organization": { + "simple-classroom-organization": { /** @example 1 */ - readonly id: number; + id: number; /** @example github */ - readonly login: string; + login: string; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/github */ - readonly html_url: string; + html_url: string; /** @example Github - Code thigns happen here */ - readonly name: string | null; + name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; }; /** * Classroom * @description A GitHub Classroom classroom */ - readonly classroom: { + classroom: { /** * @description Unique identifier of the classroom. * @example 42 */ - readonly id: number; + id: number; /** * @description The name of the classroom. * @example Programming Elixir */ - readonly name: string; + name: string; /** * @description Whether classroom is archived. * @example false */ - readonly archived: boolean; - readonly organization: components["schemas"]["simple-classroom-organization"]; + archived: boolean; + organization: components["schemas"]["simple-classroom-organization"]; /** * @description The URL of the classroom on GitHub Classroom. * @example https://classroom.github.com/classrooms/1-programming-elixir */ - readonly url: string; + url: string; }; /** * Classroom Assignment * @description A GitHub Classroom assignment */ - readonly "classroom-assignment": { + "classroom-assignment": { /** * @description Unique identifier of the repository. * @example 42 */ - readonly id: number; + id: number; /** * @description Whether an accepted assignment creates a public repository. * @example true */ - readonly public_repo: boolean; + public_repo: boolean; /** * @description Assignment title. * @example Intro to Binaries */ - readonly title: string; + title: string; /** * @description Whether it's a group assignment or individual assignment. * @example individual * @enum {string} */ - readonly type: "individual" | "group"; + type: "individual" | "group"; /** * @description The link that a student can use to accept the assignment. * @example https://classroom.github.com/a/Lx7jiUgx */ - readonly invite_link: string; + invite_link: string; /** * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. * @example true */ - readonly invitations_enabled: boolean; + invitations_enabled: boolean; /** * @description Sluggified name of the assignment. * @example intro-to-binaries */ - readonly slug: string; + slug: string; /** * @description Whether students are admins on created repository when a student accepts the assignment. * @example true */ - readonly students_are_repo_admins: boolean; + students_are_repo_admins: boolean; /** * @description Whether feedback pull request will be created when a student accepts the assignment. * @example true */ - readonly feedback_pull_requests_enabled: boolean; + feedback_pull_requests_enabled: boolean; /** * @description The maximum allowable teams for the assignment. * @example 0 */ - readonly max_teams: number | null; + max_teams: number | null; /** * @description The maximum allowable members per team. * @example 0 */ - readonly max_members: number | null; + max_members: number | null; /** * @description The selected editor for the assignment. * @example codespaces */ - readonly editor: string; + editor: string; /** * @description The number of students that have accepted the assignment. * @example 25 */ - readonly accepted: number; + accepted: number; /** * @description The number of students that have submitted the assignment. * @example 10 */ - readonly submitted: number; + submitted: number; /** * @description The number of students that have passed the assignment. * @example 10 */ - readonly passing: number; + passing: number; /** * @description The programming language used in the assignment. * @example elixir */ - readonly language: string; + language: string; /** * Format: date-time * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z */ - readonly deadline: string | null; - readonly starter_code_repository: components["schemas"]["simple-classroom-repository"]; - readonly classroom: components["schemas"]["classroom"]; + deadline: string | null; + starter_code_repository: components["schemas"]["simple-classroom-repository"]; + classroom: components["schemas"]["classroom"]; }; /** * Simple Classroom User * @description A GitHub user simplified for Classroom. */ - readonly "simple-classroom-user": { + "simple-classroom-user": { /** @example 1 */ - readonly id: number; + id: number; /** @example octocat */ - readonly login: string; + login: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; }; /** * Simple Classroom * @description A GitHub Classroom classroom */ - readonly "simple-classroom": { + "simple-classroom": { /** * @description Unique identifier of the classroom. * @example 42 */ - readonly id: number; + id: number; /** * @description The name of the classroom. * @example Programming Elixir */ - readonly name: string; + name: string; /** * @description Returns whether classroom is archived or not. * @example false */ - readonly archived: boolean; + archived: boolean; /** * @description The url of the classroom on GitHub Classroom. * @example https://classroom.github.com/classrooms/1-programming-elixir */ - readonly url: string; + url: string; }; /** * Simple Classroom Assignment * @description A GitHub Classroom assignment */ - readonly "simple-classroom-assignment": { + "simple-classroom-assignment": { /** * @description Unique identifier of the repository. * @example 42 */ - readonly id: number; + id: number; /** * @description Whether an accepted assignment creates a public repository. * @example true */ - readonly public_repo: boolean; + public_repo: boolean; /** * @description Assignment title. * @example Intro to Binaries */ - readonly title: string; + title: string; /** * @description Whether it's a Group Assignment or Individual Assignment. * @example individual * @enum {string} */ - readonly type: "individual" | "group"; + type: "individual" | "group"; /** * @description The link that a student can use to accept the assignment. * @example https://classroom.github.com/a/Lx7jiUgx */ - readonly invite_link: string; + invite_link: string; /** * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. * @example true */ - readonly invitations_enabled: boolean; + invitations_enabled: boolean; /** * @description Sluggified name of the assignment. * @example intro-to-binaries */ - readonly slug: string; + slug: string; /** * @description Whether students are admins on created repository on accepted assignment. * @example true */ - readonly students_are_repo_admins: boolean; + students_are_repo_admins: boolean; /** * @description Whether feedback pull request will be created on assignment acceptance. * @example true */ - readonly feedback_pull_requests_enabled: boolean; + feedback_pull_requests_enabled: boolean; /** * @description The maximum allowable teams for the assignment. * @example 0 */ - readonly max_teams?: number | null; + max_teams?: number | null; /** * @description The maximum allowable members per team. * @example 0 */ - readonly max_members?: number | null; + max_members?: number | null; /** * @description The selected editor for the assignment. * @example codespaces */ - readonly editor: string; + editor: string; /** * @description The number of students that have accepted the assignment. * @example 25 */ - readonly accepted: number; + accepted: number; /** * @description The number of students that have submitted the assignment. * @example 10 */ - readonly submitted: number; + submitted: number; /** * @description The number of students that have passed the assignment. * @example 10 */ - readonly passing: number; + passing: number; /** * @description The programming language used in the assignment. * @example elixir */ - readonly language: string; + language: string; /** * Format: date-time * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z */ - readonly deadline: string | null; - readonly classroom: components["schemas"]["simple-classroom"]; + deadline: string | null; + classroom: components["schemas"]["simple-classroom"]; }; /** * Classroom Accepted Assignment * @description A GitHub Classroom accepted assignment */ - readonly "classroom-accepted-assignment": { + "classroom-accepted-assignment": { /** * @description Unique identifier of the repository. * @example 42 */ - readonly id: number; + id: number; /** * @description Whether an accepted assignment has been submitted. * @example true */ - readonly submitted: boolean; + submitted: boolean; /** * @description Whether a submission passed. * @example true */ - readonly passing: boolean; + passing: boolean; /** * @description Count of student commits. * @example 5 */ - readonly commit_count: number; + commit_count: number; /** * @description Most recent grade. * @example 10/10 */ - readonly grade: string; - readonly students: readonly components["schemas"]["simple-classroom-user"][]; - readonly repository: components["schemas"]["simple-classroom-repository"]; - readonly assignment: components["schemas"]["simple-classroom-assignment"]; + grade: string; + students: components["schemas"]["simple-classroom-user"][]; + repository: components["schemas"]["simple-classroom-repository"]; + assignment: components["schemas"]["simple-classroom-assignment"]; }; /** * Classroom Assignment Grade * @description Grade for a student or groups GitHub Classroom assignment */ - readonly "classroom-assignment-grade": { + "classroom-assignment-grade": { /** @description Name of the assignment */ - readonly assignment_name: string; + assignment_name: string; /** @description URL of the assignment */ - readonly assignment_url: string; + assignment_url: string; /** @description URL of the starter code for the assignment */ - readonly starter_code_url: string; + starter_code_url: string; /** @description GitHub username of the student */ - readonly github_username: string; + github_username: string; /** @description Roster identifier of the student */ - readonly roster_identifier: string; + roster_identifier: string; /** @description Name of the student's assignment repository */ - readonly student_repository_name: string; + student_repository_name: string; /** @description URL of the student's assignment repository */ - readonly student_repository_url: string; + student_repository_url: string; /** @description Timestamp of the student's assignment submission */ - readonly submission_timestamp: string; + submission_timestamp: string; /** @description Number of points awarded to the student */ - readonly points_awarded: number; + points_awarded: number; /** @description Number of points available for the assignment */ - readonly points_available: number; + points_available: number; /** @description If a group assignment, name of the group the student is in */ - readonly group_name?: string; + group_name?: string; }; /** * Code Of Conduct * @description Code Of Conduct */ - readonly "code-of-conduct": { + "code-of-conduct": { /** @example contributor_covenant */ - readonly key: string; + key: string; /** @example Contributor Covenant */ - readonly name: string; + name: string; /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - readonly url: string; + url: string; /** * @example # Contributor Covenant Code of Conduct * @@ -20371,413 +21463,472 @@ export type components = { * * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ - readonly body?: string; + body?: string; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; + }; + /** + * Actions cache retention limit for an enterprise + * @description GitHub Actions cache retention policy for an enterprise. + */ + "actions-cache-retention-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an enterprise + * @description GitHub Actions cache storage policy for an enterprise. + */ + "actions-cache-storage-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; }; /** @description A code security configuration */ - readonly "code-security-configuration": { + "code-security-configuration": { /** @description The ID of the code security configuration */ - readonly id?: number; + id?: number; /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name?: string; + name?: string; /** * @description The type of the code security configuration. * @enum {string} */ - readonly target_type?: "global" | "organization" | "enterprise"; + target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ - readonly description?: string; + description?: string; /** * @description The enablement status of GitHub Advanced Security * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal + * @enum {string|null} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set" | null; + /** @description Feature options for code scanning */ + code_scanning_options?: { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** * @description The enablement status of code scanning default setup * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; /** @description Feature options for code scanning default setup */ - readonly code_scanning_default_setup_options?: { + code_scanning_default_setup_options?: { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ - readonly runner_type?: "standard" | "labeled" | "not_set" | null; + runner_type?: "standard" | "labeled" | "not_set" | null; /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ - readonly runner_label?: string | null; + runner_label?: string | null; } | null; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; + reviewer_id: number; /** * @description The type of the bypass reviewer * @enum {string} */ - readonly reviewer_type: "TEAM" | "ROLE"; + reviewer_type: "TEAM" | "ROLE"; + /** @description The ID of the security configuration associated with this bypass reviewer */ + security_configuration_id?: number; }[]; }; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; /** * Format: uri * @description The URL of the configuration */ - readonly url?: string; + url?: string; /** * Format: uri * @description The URL of the configuration */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; }; + /** @description Security Configuration feature options for code scanning */ + "code-scanning-options": { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** @description Feature options for code scanning default setup */ - readonly "code-scanning-default-setup-options": { + "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ - readonly runner_type?: "standard" | "labeled" | "not_set"; + runner_type?: "standard" | "labeled" | "not_set"; /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ - readonly runner_label?: string | null; + runner_label?: string | null; } | null; /** @description A list of default code security configurations */ - readonly "code-security-default-configurations": readonly { + "code-security-default-configurations": { /** * @description The visibility of newly created repositories for which the code security configuration will be applied to by default * @enum {unknown} */ - readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; }[]; /** * Simple Repository * @description A GitHub repository. */ - readonly "simple-repository": { + "simple-repository": { /** * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ - readonly id: number; + id: number; /** * @description The GraphQL identifier of the repository. * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Hello-World */ - readonly name: string; + name: string; /** * @description The full, globally unique, name of the repository. * @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + owner: components["schemas"]["simple-user"]; /** @description Whether the repository is private. */ - readonly private: boolean; + private: boolean; /** * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** * @description The repository description. * @example This your first repo! */ - readonly description: string | null; + description: string | null; /** @description Whether the repository is a fork. */ - readonly fork: boolean; + fork: boolean; /** * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** * @description A template for the API URL to download the repository as an archive. * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** * @description A template for the API URL to list the available assignees for issues in the repository. * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** * @description A template for the API URL to create or retrieve a raw Git blob in the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** * @description A template for the API URL to get information about branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** * @description A template for the API URL to get information about collaborators of the repository. * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** * @description A template for the API URL to get information about comments on the repository. * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** * @description A template for the API URL to get information about commits on the repository. * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** * @description A template for the API URL to compare two commits or refs. * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** * @description A template for the API URL to get the contents of the repository. * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** * @description A template for the API URL to get information about Git commits of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** * @description A template for the API URL to get information about Git refs of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** * @description A template for the API URL to get information about Git tags of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** * @description A template for the API URL to get information about issue comments on the repository. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** * @description A template for the API URL to get information about issue events on the repository. * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** * @description A template for the API URL to get information about issues on the repository. * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** * @description A template for the API URL to get information about deploy keys on the repository. * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** * @description A template for the API URL to get information about labels of the repository. * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** * @description A template for the API URL to get information about milestones of the repository. * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** * @description A template for the API URL to get information about notifications on the repository. * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** * @description A template for the API URL to get information about pull requests on the repository. * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** * @description A template for the API URL to get information about releases on the repository. * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** * @description A template for the API URL to get information about statuses of a commit. * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** * @description A template for the API URL to create or retrieve a raw Git tree of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; }; /** @description Repositories associated with a code security configuration and attachment status */ - readonly "code-security-configuration-repositories": { + "code-security-configuration-repositories": { /** * @description The attachment status of the code security configuration on the repository. * @enum {string} */ - readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - readonly repository?: components["schemas"]["simple-repository"]; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -20792,7 +21943,7 @@ export type components = { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -20802,7 +21953,7 @@ export type components = { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -20815,17 +21966,17 @@ export type components = { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly epss?: components["schemas"]["security-advisory-epss"]; + cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -20835,7 +21986,7 @@ export type components = { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -20862,40 +22013,70 @@ export type components = { * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; + /** + * Dependabot alert dismissal request + * @description Information about an active dismissal request for this Dependabot alert. + */ + "dependabot-alert-dismissal-request-simple": { + /** @description The unique identifier of the dismissal request. */ + id?: number; + /** + * @description The current status of the dismissal request. + * @enum {string} + */ + status?: "pending" | "approved" | "rejected" | "cancelled"; + /** @description The user who requested the dismissal. */ + requester?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The login name of the user. */ + login?: string; + }; + /** + * Format: date-time + * @description The date and time when the dismissal request was created. + */ + created_at?: string; + /** + * Format: uri + * @description The API URL to get more information about this dismissal request. + */ + url?: string; + } | null; /** @description A Dependabot alert. */ - readonly "dependabot-alert-with-repository": { - readonly number: components["schemas"]["alert-number"]; + "dependabot-alert-with-repository": { + number: components["schemas"]["alert-number"]; /** * @description The state of the Dependabot alert. * @enum {string} @@ -20903,7 +22084,7 @@ export type components = { readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ readonly dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -20911,230 +22092,461 @@ export type components = { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; - readonly security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; - readonly security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at: components["schemas"]["alert-updated-at"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; + security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; + security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at: components["schemas"]["alert-updated-at"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; /** * @description The reason that the alert was dismissed. * @enum {string|null} */ - readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; + dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; /** @description An optional comment associated with the alert's dismissal. */ - readonly dismissed_comment: string | null; - readonly fixed_at: components["schemas"]["alert-fixed-at"]; - readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; - readonly repository: components["schemas"]["simple-repository"]; + dismissed_comment: string | null; + fixed_at: components["schemas"]["alert-fixed-at"]; + auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; + repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "nullable-alert-updated-at": string | null; - /** - * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. - * @enum {string} - */ - readonly "secret-scanning-alert-state": "open" | "resolved"; - /** - * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. - * @enum {string|null} + * Enterprise Team + * @description Group of enterprise owners and/or members */ - readonly "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; - readonly "organization-secret-scanning-alert": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + description?: string; + slug: string; + /** Format: uri */ + url: string; /** - * Format: uri - * @description The REST API URL of the code locations for this alert. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example disabled | all */ - readonly locations_url?: string; - readonly state?: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + sync_to_organizations?: string; + /** @example disabled | selected | all */ + organization_selection_type?: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id: string | null; /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example Justice League */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + group_name?: string | null; /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league */ - readonly secret_type_display_name?: string; - /** @description The secret that was detected. */ - readonly secret?: string; - readonly repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * Format: uri + * @example https://api.github.com/orgs/github */ - readonly push_protection_bypassed_at?: string | null; - readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ - readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ - readonly push_protection_bypass_request_comment?: string | null; + url: string; /** * Format: uri - * @description The URL to a push protection bypass request. + * @example https://api.github.com/orgs/github/repos */ - readonly push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ - readonly resolution_comment?: string | null; + repos_url: string; /** - * @description The token status as of the latest validity check. - * @enum {string} + * Format: uri + * @example https://api.github.com/orgs/github/events */ - 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; + 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; }; /** * Actor * @description Actor */ - readonly actor: { - readonly id: number; - readonly login: string; - readonly display_login?: string; - readonly gravatar_id: string | null; + actor: { + id: number; + login: string; + display_login?: string; + gravatar_id: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly avatar_url: string; + avatar_url: string; + }; + /** + * Label + * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + /** + * Format: int64 + * @description Unique identifier for the label. + * @example 208045946 + */ + id: number; + /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ + node_id: string; + /** + * Format: uri + * @description URL for the label + * @example https://api.github.com/repositories/42/labels/bug + */ + url: string; + /** + * @description The name of the label. + * @example bug + */ + name: string; + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ + description: string | null; + /** + * @description 6-character hex code, without the leading #, identifying the color + * @example FFFFFF + */ + color: string; + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ + default: boolean; + }; + /** + * Discussion + * @description A Discussion in a repository. + */ + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** Reactions */ + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + /** + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} + */ + state: "open" | "closed" | "locked" | "converting" | "transferring"; + /** + * @description The reason for the current state + * @example resolved + * @enum {string|null} + */ + state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + labels?: components["schemas"]["label"][]; }; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly "nullable-milestone": { + "nullable-milestone": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - readonly labels_url: string; + labels_url: string; /** @example 1002604 */ - readonly id: number; + id: number; /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - readonly node_id: string; + node_id: string; /** * @description The number of the milestone. * @example 42 */ - readonly number: number; + number: number; /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** * @description The title of the milestone. * @example v1.0 */ - readonly title: string; + title: string; /** @example Tracking milestone for version 1.0 */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ - readonly open_issues: number; + open_issues: number; /** @example 8 */ - readonly closed_issues: number; + closed_issues: number; /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - readonly closed_at: string | null; + closed_at: string | null; /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - readonly due_on: string | null; + due_on: string | null; + } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly "nullable-integration": { + "nullable-integration": { /** * @description Unique identifier of the GitHub app * @example 37 */ - readonly id: number; + id: number; /** * @description The slug name of the GitHub app * @example probot-owners */ - readonly slug?: string; + slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id: string; + node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; - readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; + client_id?: string; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners */ - readonly name: string; + name: string; /** @example The description of the app. */ - readonly description: string | null; + description: string | null; /** * Format: uri * @example https://example.com */ - readonly external_url: string; + external_url: string; /** * Format: uri * @example https://github.com/apps/super-ci */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly updated_at: string; + updated_at: string; /** * @description The set of permissions for the GitHub app * @example { @@ -21142,34 +22554,28 @@ export type components = { * "deployments": "write" * } */ - readonly permissions: { - readonly issues?: string; - readonly checks?: string; - readonly metadata?: string; - readonly contents?: string; - readonly deployments?: string; + permissions: { + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; } & { - readonly [key: string]: string; + [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" * ] */ - readonly events: readonly string[]; + events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ - readonly installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - readonly webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - readonly pem?: string; + installations_count?: number; } | null; /** * author_association @@ -21177,77 +22583,182 @@ export type components = { * @example OWNER * @enum {string} */ - readonly "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ - readonly "reaction-rollup": { + "reaction-rollup": { /** Format: uri */ - readonly url: string; - readonly total_count: number; - readonly "+1": number; - readonly "-1": number; - readonly laugh: number; - readonly confused: number; - readonly heart: number; - readonly hooray: number; - readonly eyes: number; - readonly rocket: number; + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + eyes: number; + rocket: number; }; /** Sub-issues Summary */ - readonly "sub-issues-summary": { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; + /** + * Pinned Issue Comment + * @description Context around who pinned an issue comment and when it was pinned. + */ + "nullable-pinned-issue-comment": { + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + pinned_at: string; + pinned_by: components["schemas"]["nullable-simple-user"]; + } | null; + /** + * Issue Comment + * @description Comments provide a way for people to collaborate on an issue. + */ + "nullable-issue-comment": { + /** + * Format: int64 + * @description Unique identifier of the issue comment + * @example 42 + */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the issue comment + * @example https://api.github.com/repositories/42/issues/comments/1 + */ + url: string; + /** + * @description Contents of the issue comment + * @example What version of Safari were you using when you observed this bug? + */ + body?: string; + body_text?: string; + body_html?: string; + /** Format: uri */ + html_url: string; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + updated_at: string; + /** Format: uri */ + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + } | null; + /** Issue Dependencies Summary */ + "issue-dependencies-summary": { + blocked_by: number; + blocking: number; + total_blocked_by: number; + total_blocking: number; + }; + /** + * Issue Field Value + * @description A value assigned to an issue field + */ + "issue-field-value": { + /** + * Format: int64 + * @description Unique identifier for the issue field. + * @example 1 + */ + issue_field_id: number; + /** @example IFT_GDKND */ + node_id: string; + /** + * @description The data type of the issue field + * @example text + * @enum {string} + */ + data_type: "text" | "single_select" | "number" | "date"; + /** @description The value of the issue field */ + value: (string | number) | null; + /** @description Details about the selected option (only present for single_select fields) */ + single_select_option?: { + /** + * Format: int64 + * @description Unique identifier for the option. + * @example 1 + */ + id: number; + /** + * @description The name of the option + * @example High + */ + name: string; + /** + * @description The color of the option + * @example red + */ + color: string; + } | null; }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - readonly issue: { + issue: { /** Format: int64 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - readonly url: string; + url: string; /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + repository_url: string; + labels_url: string; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - readonly number: number; + number: number; /** * @description State of the issue; either 'open' or 'closed' * @example open */ - readonly state: string; + state: string; /** * @description The reason for the current state * @example not_planned * @enum {string|null} */ - readonly state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - readonly title: string; + title: string; /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - readonly body?: string | null; - readonly user: components["schemas"]["nullable-simple-user"]; + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ @@ -21255,484 +22766,604 @@ export type components = { * "registration" * ] */ - readonly labels: readonly (string | { + labels: (string | { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - /** Format: uri */ - readonly url?: string; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; - readonly default?: boolean; + id?: number; + node_id?: string; + /** Format: uri */ + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; })[]; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly comments: number; - readonly pull_request?: { + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: components["schemas"]["nullable-milestone"]; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly diff_url: string | null; + diff_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly patch_url: string | null; + patch_url: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; /** Format: date-time */ - readonly closed_at: string | null; + closed_at: string | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly draft?: boolean; - readonly closed_by?: components["schemas"]["nullable-simple-user"]; - readonly body_html?: string; - readonly body_text?: string; + updated_at: string; + draft?: boolean; + closed_by?: components["schemas"]["nullable-simple-user"]; + body_html?: string; + body_text?: string; /** Format: uri */ - readonly timeline_url?: string; - readonly repository?: components["schemas"]["repository"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly author_association: components["schemas"]["author-association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + author_association?: components["schemas"]["author-association"]; + reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; }; /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - readonly "issue-comment": { + "issue-comment": { /** * Format: int64 * @description Unique identifier of the issue comment * @example 42 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - readonly url: string; + url: string; /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - readonly body?: string; - readonly body_text?: string; - readonly body_html?: string; + body?: string; + body_text?: string; + body_html?: string; /** Format: uri */ - readonly html_url: string; - readonly user: components["schemas"]["nullable-simple-user"]; + html_url: string; + user: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly issue_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + }; + /** Pull Request Minimal */ + "pull-request-minimal": { + /** Format: int64 */ + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + }; + /** + * Release Asset + * @description Data related to a release. + */ + "release-asset": { + /** Format: uri */ + url: string; + /** Format: uri */ + browser_download_url: string; + id: number; + node_id: string; + /** + * @description The file name of the asset. + * @example Team Environment + */ + name: string; + label: string | null; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded" | "open"; + content_type: string; + size: number; + digest: string | null; + download_count: number; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + uploader: components["schemas"]["nullable-simple-user"]; + }; + /** + * Release + * @description A release. + */ + release: { + /** Format: uri */ + url: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + assets_url: string; + upload_url: string; + /** Format: uri */ + tarball_url: string | null; + /** Format: uri */ + zipball_url: string | null; + id: number; + node_id: string; + /** + * @description The name of the tag. + * @example v1.0.0 + */ + tag_name: string; + /** + * @description Specifies the commitish value that determines where the Git tag is created from. + * @example master + */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ + draft: boolean; + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ + prerelease: boolean; + /** + * @description Whether or not the release is immutable. + * @example false + */ + immutable?: boolean; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + published_at: string | null; + /** Format: date-time */ + updated_at?: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + mentions_count?: number; + /** + * Format: uri + * @description The URL of the release discussion. + */ + discussion_url?: string; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Event * @description Event */ - readonly event: { - readonly id: string; - readonly type: string | null; - readonly actor: components["schemas"]["actor"]; - readonly repo: { - readonly id: number; - readonly name: string; + event: { + id: string; + type: string | null; + actor: components["schemas"]["actor"]; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; - }; - readonly org?: components["schemas"]["actor"]; - readonly payload: { - readonly action?: string; - readonly issue?: components["schemas"]["issue"]; - readonly comment?: components["schemas"]["issue-comment"]; - readonly pages?: readonly { - readonly page_name?: string; - readonly title?: string; - readonly summary?: string | null; - readonly action?: string; - readonly sha?: string; - readonly html_url?: string; - }[]; + url: string; }; - readonly public: boolean; + org?: components["schemas"]["actor"]; + payload: components["schemas"]["create-event"] | components["schemas"]["delete-event"] | components["schemas"]["discussion-event"] | components["schemas"]["issues-event"] | components["schemas"]["issue-comment-event"] | components["schemas"]["fork-event"] | components["schemas"]["gollum-event"] | components["schemas"]["member-event"] | components["schemas"]["public-event"] | components["schemas"]["push-event"] | components["schemas"]["pull-request-event"] | components["schemas"]["pull-request-review-comment-event"] | components["schemas"]["pull-request-review-event"] | components["schemas"]["commit-comment-event"] | components["schemas"]["release-event"] | components["schemas"]["watch-event"]; + public: boolean; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; }; /** * Link With Type * @description Hypermedia Link with Type */ - readonly "link-with-type": { - readonly href: string; - readonly type: string; + "link-with-type": { + href: string; + type: string; }; /** * Feed * @description Feed */ - readonly feed: { + feed: { /** @example https://github.com/timeline */ - readonly timeline_url: string; + timeline_url: string; /** @example https://github.com/{user} */ - readonly user_url: string; + user_url: string; /** @example https://github.com/octocat */ - readonly current_user_public_url?: string; + current_user_public_url?: string; /** @example https://github.com/octocat.private?token=abc123 */ - readonly current_user_url?: string; + current_user_url?: string; /** @example https://github.com/octocat.private.actor?token=abc123 */ - readonly current_user_actor_url?: string; + current_user_actor_url?: string; /** @example https://github.com/octocat-org */ - readonly current_user_organization_url?: string; + current_user_organization_url?: string; /** * @example [ * "https://github.com/organizations/github/octocat.private.atom?token=abc123" * ] */ - readonly current_user_organization_urls?: readonly string[]; + current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ - readonly security_advisories_url?: string; + security_advisories_url?: string; /** * @description A feed of discussions for a given repository. * @example https://github.com/{user}/{repo}/discussions */ - readonly repository_discussions_url?: string; + repository_discussions_url?: string; /** * @description A feed of discussions for a given repository and category. * @example https://github.com/{user}/{repo}/discussions/categories/{category} */ - readonly repository_discussions_category_url?: string; - readonly _links: { - readonly timeline: components["schemas"]["link-with-type"]; - readonly user: components["schemas"]["link-with-type"]; - readonly security_advisories?: components["schemas"]["link-with-type"]; - readonly current_user?: components["schemas"]["link-with-type"]; - readonly current_user_public?: components["schemas"]["link-with-type"]; - readonly current_user_actor?: components["schemas"]["link-with-type"]; - readonly current_user_organization?: components["schemas"]["link-with-type"]; - readonly current_user_organizations?: readonly components["schemas"]["link-with-type"][]; - readonly repository_discussions?: components["schemas"]["link-with-type"]; - readonly repository_discussions_category?: components["schemas"]["link-with-type"]; + repository_discussions_category_url?: string; + _links: { + timeline: components["schemas"]["link-with-type"]; + user: components["schemas"]["link-with-type"]; + security_advisories?: components["schemas"]["link-with-type"]; + current_user?: components["schemas"]["link-with-type"]; + current_user_public?: components["schemas"]["link-with-type"]; + current_user_actor?: components["schemas"]["link-with-type"]; + current_user_organization?: components["schemas"]["link-with-type"]; + current_user_organizations?: components["schemas"]["link-with-type"][]; + repository_discussions?: components["schemas"]["link-with-type"]; + repository_discussions_category?: components["schemas"]["link-with-type"]; }; }; /** * Base Gist * @description Base Gist */ - readonly "base-gist": { + "base-gist": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly forks_url: string; + forks_url: string; /** Format: uri */ - readonly commits_url: string; - readonly id: string; - readonly node_id: string; + commits_url: string; + id: string; + node_id: string; /** Format: uri */ - readonly git_pull_url: string; + git_pull_url: string; /** Format: uri */ - readonly git_push_url: string; + git_push_url: string; /** Format: uri */ - readonly html_url: string; - readonly files: { - readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding: string; + encoding: string; }; }; - readonly public: boolean; + public: boolean; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly description: string | null; - readonly comments: number; - readonly comments_enabled?: boolean; - readonly user: components["schemas"]["nullable-simple-user"]; + updated_at: string; + description: string | null; + comments: number; + comments_enabled?: boolean; + user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ - readonly comments_url: string; - readonly owner?: components["schemas"]["simple-user"]; - readonly truncated?: boolean; - readonly forks?: readonly unknown[]; - readonly history?: readonly unknown[]; + comments_url: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User * @description Public User */ - readonly "public-user": { - readonly login: string; + "public-user": { + login: string; /** Format: int64 */ - readonly id: number; + id: number; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly user_view_type: "public"; - readonly node_id: string; + user_view_type: "public"; + node_id: string; /** Format: uri */ - readonly avatar_url: string; - readonly gravatar_id: string | null; + avatar_url: string; + gravatar_id: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly starred_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; /** Format: uri */ - readonly subscriptions_url: string; + subscriptions_url: string; /** Format: uri */ - readonly organizations_url: string; + organizations_url: string; /** Format: uri */ - readonly repos_url: string; - readonly events_url: string; + repos_url: string; + events_url: string; /** Format: uri */ - readonly received_events_url: string; - readonly type: string; - readonly site_admin: boolean; - readonly name: string | null; - readonly company: string | null; - readonly blog: string | null; - readonly location: string | null; + received_events_url: string; + type: string; + site_admin: boolean; + name: string | null; + company: string | null; + blog: string | null; + location: string | null; /** Format: email */ - readonly email: string | null; + email: string | null; /** Format: email */ - readonly notification_email?: string | null; - readonly hireable: boolean | null; - readonly bio: string | null; - readonly twitter_username?: string | null; - readonly public_repos: number; - readonly public_gists: number; - readonly followers: number; - readonly following: number; + notification_email?: string | null; + hireable: boolean | null; + bio: string | null; + twitter_username?: string | null; + public_repos: number; + public_gists: number; + followers: number; + following: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly plan?: { - readonly collaborators: number; - readonly name: string; - readonly space: number; - readonly private_repos: number; + updated_at: string; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; }; /** @example 1 */ - readonly private_gists?: number; + private_gists?: number; /** @example 2 */ - readonly total_private_repos?: number; + total_private_repos?: number; /** @example 2 */ - readonly owned_private_repos?: number; + owned_private_repos?: number; /** @example 1 */ - readonly disk_usage?: number; + disk_usage?: number; /** @example 3 */ - readonly collaborators?: number; + collaborators?: number; }; /** * Gist History * @description Gist History */ - readonly "gist-history": { - readonly user?: components["schemas"]["nullable-simple-user"]; - readonly version?: string; + "gist-history": { + user?: components["schemas"]["nullable-simple-user"]; + version?: string; /** Format: date-time */ - readonly committed_at?: string; - readonly change_status?: { - readonly total?: number; - readonly additions?: number; - readonly deletions?: number; + committed_at?: string; + change_status?: { + total?: number; + additions?: number; + deletions?: number; }; /** Format: uri */ - readonly url?: string; + url?: string; }; /** * Gist Simple * @description Gist Simple */ - readonly "gist-simple": { + "gist-simple": { /** @deprecated */ - readonly forks?: readonly { - readonly id?: string; + forks?: { + id?: string; /** Format: uri */ - readonly url?: string; - readonly user?: components["schemas"]["public-user"]; + url?: string; + user?: components["schemas"]["public-user"]; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; }[] | null; /** @deprecated */ - readonly history?: readonly components["schemas"]["gist-history"][] | null; + history?: components["schemas"]["gist-history"][] | null; /** * Gist * @description Gist */ - readonly fork_of?: { + fork_of?: { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly forks_url: string; + forks_url: string; /** Format: uri */ - readonly commits_url: string; - readonly id: string; - readonly node_id: string; + commits_url: string; + id: string; + node_id: string; /** Format: uri */ - readonly git_pull_url: string; + git_pull_url: string; /** Format: uri */ - readonly git_push_url: string; + git_push_url: string; /** Format: uri */ - readonly html_url: string; - readonly files: { - readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; }; }; - readonly public: boolean; + public: boolean; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly description: string | null; - readonly comments: number; - readonly comments_enabled?: boolean; - readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ - readonly comments_url: string; - readonly owner?: components["schemas"]["nullable-simple-user"]; - readonly truncated?: boolean; - readonly forks?: readonly unknown[]; - readonly history?: readonly unknown[]; + updated_at: string; + description: string | null; + comments: number; + comments_enabled?: boolean; + user: components["schemas"]["nullable-simple-user"]; + /** Format: uri */ + comments_url: string; + owner?: components["schemas"]["nullable-simple-user"]; + truncated?: boolean; + forks?: unknown[]; + history?: unknown[]; } | null; - readonly url?: string; - readonly forks_url?: string; - readonly commits_url?: string; - readonly id?: string; - readonly node_id?: string; - readonly git_pull_url?: string; - readonly git_push_url?: string; - readonly html_url?: string; - readonly files?: { - readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; - readonly truncated?: boolean; - readonly content?: string; + url?: string; + forks_url?: string; + commits_url?: string; + id?: string; + node_id?: string; + git_pull_url?: string; + git_push_url?: string; + html_url?: string; + files?: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding: string; + encoding: string; } | null; }; - readonly public?: boolean; - readonly created_at?: string; - readonly updated_at?: string; - readonly description?: string | null; - readonly comments?: number; - readonly comments_enabled?: boolean; - readonly user?: string | null; - readonly comments_url?: string; - readonly owner?: components["schemas"]["simple-user"]; - readonly truncated?: boolean; + public?: boolean; + created_at?: string; + updated_at?: string; + description?: string | null; + comments?: number; + comments_enabled?: boolean; + user?: string | null; + comments_url?: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; }; /** * Gist Comment * @description A comment made to a gist. */ - readonly "gist-comment": { + "gist-comment": { /** @example 1 */ - readonly id: number; + id: number; /** @example MDExOkdpc3RDb21tZW50MQ== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - readonly url: string; + url: string; /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; - readonly user: components["schemas"]["nullable-simple-user"]; + body: string; + user: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - readonly updated_at: string; - readonly author_association: components["schemas"]["author-association"]; + updated_at: string; + author_association: components["schemas"]["author-association"]; }; /** * Gist Commit * @description Gist Commit */ - readonly "gist-commit": { + "gist-commit": { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - readonly url: string; + url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - readonly version: string; - readonly user: components["schemas"]["nullable-simple-user"]; - readonly change_status: { - readonly total?: number; - readonly additions?: number; - readonly deletions?: number; + version: string; + user: components["schemas"]["nullable-simple-user"]; + change_status: { + total?: number; + additions?: number; + deletions?: number; }; /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - readonly committed_at: string; + committed_at: string; }; /** * Gitignore Template * @description Gitignore Template */ - readonly "gitignore-template": { + "gitignore-template": { /** @example C */ - readonly name: string; + name: string; /** * @example # Object files * *.o @@ -21752,56 +23383,56 @@ export type components = { * *.out * *.app */ - readonly source: string; + source: string; }; /** * License Simple * @description License Simple */ - readonly "license-simple": { + "license-simple": { /** @example mit */ - readonly key: string; + key: string; /** @example MIT License */ - readonly name: string; + name: string; /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + url: string | null; /** @example MIT */ - readonly spdx_id: string | null; + spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + node_id: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; }; /** * License * @description License */ - readonly license: { + license: { /** @example mit */ - readonly key: string; + key: string; /** @example MIT License */ - readonly name: string; + name: string; /** @example MIT */ - readonly spdx_id: string | null; + spdx_id: string | null; /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - readonly html_url: string; + html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - readonly description: string; + description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - readonly implementation: string; + implementation: string; /** * @example [ * "commercial-use", @@ -21811,19 +23442,19 @@ export type components = { * "private-use" * ] */ - readonly permissions: readonly string[]; + permissions: string[]; /** * @example [ * "include-copyright" * ] */ - readonly conditions: readonly string[]; + conditions: string[]; /** * @example [ * "no-liability" * ] */ - readonly limitations: readonly string[]; + limitations: string[]; /** * @example The MIT License (MIT) * @@ -21847,689 +23478,1178 @@ export type components = { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - readonly body: string; + body: string; /** @example true */ - readonly featured: boolean; + featured: boolean; }; /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - readonly "marketplace-listing-plan": { + "marketplace-listing-plan": { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - readonly accounts_url: string; + accounts_url: string; /** @example 1313 */ - readonly id: number; + id: number; /** @example 3 */ - readonly number: number; + number: number; /** @example Pro */ - readonly name: string; + name: string; /** @example A professional-grade CI solution */ - readonly description: string; + description: string; /** @example 1099 */ - readonly monthly_price_in_cents: number; + monthly_price_in_cents: number; /** @example 11870 */ - readonly yearly_price_in_cents: number; + yearly_price_in_cents: number; /** * @example FLAT_RATE * @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ - readonly has_free_trial: boolean; - readonly unit_name: string | null; + has_free_trial: boolean; + unit_name: string | null; /** @example published */ - readonly state: string; + state: string; /** * @example [ * "Up to 25 private repositories", * "11 concurrent builds" * ] */ - readonly bullets: readonly string[]; + bullets: string[]; }; /** * Marketplace Purchase * @description Marketplace Purchase */ - readonly "marketplace-purchase": { - readonly url: string; - readonly type: string; - readonly id: number; - readonly login: string; - readonly organization_billing_email?: string; - readonly email?: string | null; - readonly marketplace_pending_change?: { - readonly is_installed?: boolean; - readonly effective_date?: string; - readonly unit_count?: number | null; - readonly id?: number; - readonly plan?: components["schemas"]["marketplace-listing-plan"]; + "marketplace-purchase": { + url: string; + type: string; + id: number; + login: string; + organization_billing_email?: string; + email?: string | null; + marketplace_pending_change?: { + is_installed?: boolean; + effective_date?: string; + unit_count?: number | null; + id?: number; + plan?: components["schemas"]["marketplace-listing-plan"]; } | null; - readonly marketplace_purchase: { - readonly billing_cycle?: string; - readonly next_billing_date?: string | null; - readonly is_installed?: boolean; - readonly unit_count?: number | null; - readonly on_free_trial?: boolean; - readonly free_trial_ends_on?: string | null; - readonly updated_at?: string; - readonly plan?: components["schemas"]["marketplace-listing-plan"]; + marketplace_purchase: { + billing_cycle?: string; + next_billing_date?: string | null; + is_installed?: boolean; + unit_count?: number | null; + on_free_trial?: boolean; + free_trial_ends_on?: string | null; + updated_at?: string; + plan?: components["schemas"]["marketplace-listing-plan"]; }; }; /** * Api Overview * @description Api Overview */ - readonly "api-overview": { + "api-overview": { /** @example true */ - readonly verifiable_password_authentication: boolean; - readonly ssh_key_fingerprints?: { - readonly SHA256_RSA?: string; - readonly SHA256_DSA?: string; - readonly SHA256_ECDSA?: string; - readonly SHA256_ED25519?: string; + verifiable_password_authentication: boolean; + ssh_key_fingerprints?: { + SHA256_RSA?: string; + SHA256_DSA?: string; + SHA256_ECDSA?: string; + SHA256_ED25519?: string; }; /** * @example [ * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" * ] */ - readonly ssh_keys?: readonly string[]; + ssh_keys?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly hooks?: readonly string[]; + hooks?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly github_enterprise_importer?: readonly string[]; + github_enterprise_importer?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly web?: readonly string[]; + web?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly api?: readonly string[]; + api?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly git?: readonly string[]; + git?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly packages?: readonly string[]; + packages?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly pages?: readonly string[]; + pages?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly importer?: readonly string[]; + importer?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly actions?: readonly string[]; + actions?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly actions_macos?: readonly string[]; + actions_macos?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly codespaces?: readonly string[]; + codespaces?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly dependabot?: readonly string[]; + dependabot?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly copilot?: readonly string[]; - readonly domains?: { - readonly website?: readonly string[]; - readonly codespaces?: readonly string[]; - readonly copilot?: readonly string[]; - readonly packages?: readonly string[]; - readonly actions?: readonly string[]; - readonly actions_inbound?: { - readonly full_domains?: readonly string[]; - readonly wildcard_domains?: readonly string[]; + copilot?: string[]; + domains?: { + website?: string[]; + codespaces?: string[]; + copilot?: string[]; + packages?: string[]; + actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; }; - readonly artifact_attestations?: { + artifact_attestations?: { /** * @example [ * "example" * ] */ - readonly trust_domain?: string; - readonly services?: readonly string[]; + trust_domain?: string; + services?: string[]; }; }; }; - readonly "security-and-analysis": { - readonly advanced_security?: { + "security-and-analysis": { + /** + * @description Enable or disable GitHub Advanced Security for the repository. + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ + advanced_security?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + code_security?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; }; /** @description Enable or disable Dependabot security updates for the repository. */ - readonly dependabot_security_updates?: { + dependabot_security_updates?: { /** * @description The enablement status of Dependabot security updates for the repository. * @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + secret_scanning?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; }; - readonly secret_scanning?: { + secret_scanning_push_protection?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - readonly secret_scanning_push_protection?: { + secret_scanning_non_provider_patterns?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - readonly secret_scanning_non_provider_patterns?: { + secret_scanning_ai_detection?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - readonly secret_scanning_ai_detection?: { + secret_scanning_delegated_alert_dismissal?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + secret_scanning_delegated_bypass?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + 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"; + }[]; }; } | null; /** * Minimal Repository * @description Minimal Repository */ - readonly "minimal-repository": { + "minimal-repository": { /** * Format: int64 * @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @example Hello-World */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - readonly git_url?: string; + git_tags_url: string; + git_url?: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - readonly ssh_url?: string; + releases_url: string; + ssh_url?: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - readonly clone_url?: string; - readonly mirror_url?: string | null; + trees_url: string; + clone_url?: string; + mirror_url?: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; - readonly svn_url?: string; - readonly homepage?: string | null; - readonly language?: string | null; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; + hooks_url: string; + svn_url?: string; + homepage?: string | null; + language?: string | null; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly has_discussions?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived?: boolean; + disabled?: boolean; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string | null; + pushed_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at?: string | null; + created_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at?: string | null; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; + updated_at?: string | null; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; /** @example admin */ - readonly role_name?: string; - readonly temp_clone_token?: string; - readonly delete_branch_on_merge?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; - readonly license?: { - readonly key?: string; - readonly name?: string; - readonly spdx_id?: string; - readonly url?: string; - readonly node_id?: string; + role_name?: string; + temp_clone_token?: string; + delete_branch_on_merge?: boolean; + subscribers_count?: number; + network_count?: number; + code_of_conduct?: components["schemas"]["code-of-conduct"]; + license?: { + key?: string; + name?: string; + spdx_id?: string; + url?: string | null; + node_id?: string; } | null; /** @example 0 */ - readonly forks?: number; + forks?: number; /** @example 0 */ - readonly open_issues?: number; + open_issues?: number; /** @example 0 */ - readonly watchers?: number; - readonly allow_forking?: boolean; + watchers?: number; + allow_forking?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + web_commit_signoff_required?: boolean; + security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Thread * @description Thread */ - readonly thread: { - readonly id: string; - readonly repository: components["schemas"]["minimal-repository"]; - readonly subject: { - readonly title: string; - readonly url: string; - readonly latest_comment_url: string; - readonly type: string; - }; - readonly reason: string; - readonly unread: boolean; - readonly updated_at: string; - readonly last_read_at: string | null; - readonly url: string; + thread: { + id: string; + repository: components["schemas"]["minimal-repository"]; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string | null; + url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ - readonly subscription_url: string; + subscription_url: string; }; /** * Thread Subscription * @description Thread Subscription */ - readonly "thread-subscription": { + "thread-subscription": { /** @example true */ - readonly subscribed: boolean; - readonly ignored: boolean; - readonly reason: string | null; + subscribed: boolean; + ignored: boolean; + reason: string | null; /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - readonly thread_url?: string; + thread_url?: string; /** * Format: uri * @example https://api.github.com/repos/1 */ - readonly repository_url?: string; + repository_url?: string; }; /** - * Organization Simple - * @description A GitHub organization. + * Actions cache retention limit for an organization + * @description GitHub Actions cache retention policy for an organization. */ - readonly "organization-simple": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + "actions-cache-retention-limit-for-organization": { + /** + * @description For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an organization + * @description GitHub Actions cache storage policy for an organization. + */ + "actions-cache-storage-limit-for-organization": { + /** + * @description For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; + /** + * Simple Repository + * @description A GitHub repository. + */ + "nullable-simple-repository": { + /** + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ + node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World */ - readonly url: string; + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World + */ + url: string; + /** + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + */ + archive_url: string; + /** + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} + */ + assignees_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + */ + blobs_url: string; + /** + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} + */ + branches_url: string; + /** + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + */ + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly repos_url: string; + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - 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; + contributors_url: string; + /** + * Format: uri + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments + */ + deployments_url: string; + /** + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads + */ + downloads_url: string; + /** + * Format: uri + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events + */ + events_url: string; + /** + * Format: uri + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks + */ + forks_url: string; + /** + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + */ + git_commits_url: string; + /** + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + */ + git_refs_url: string; + /** + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + */ + git_tags_url: string; + /** + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + */ + issue_comment_url: string; + /** + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + */ + issue_events_url: string; + /** + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} + */ + issues_url: string; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; + } | null; + /** + * Dependabot Repository Access Details + * @description Information about repositories that Dependabot is able to access in an organization + */ + "dependabot-repository-access-details": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string|null} + */ + default_level?: "public" | "internal" | null; + accessible_repositories?: components["schemas"]["nullable-simple-repository"][]; }; - readonly "billing-usage-report": { - readonly usageItems?: readonly { + budget: { + /** + * @description The unique identifier for the budget + * @example 2066deda-923f-43f9-88d2-62395a28c0cdd + */ + id: string; + /** + * @description The type of pricing for the budget + * @example SkuPricing + * @enum {string} + */ + budget_type: "SkuPricing" | "ProductPricing"; + /** @description The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description The type of limit enforcement for the budget + * @example true + */ + prevent_further_usage: boolean; + /** + * @description The scope of the budget (enterprise, organization, repository, cost center) + * @example enterprise + */ + budget_scope: string; + /** + * @description The name of the entity for the budget (enterprise does not require a name). + * @example octocat/hello-world + */ + budget_entity_name?: string; + /** @description A single product or sku to apply the budget to. */ + budget_product_sku: string; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients: string[]; + }; + }; + get_all_budgets: { + /** @description Array of budget objects for the enterprise */ + budgets: components["schemas"]["budget"][]; + /** @description Indicates if there are more pages of results available (maps to hasNextPage from billing platform) */ + has_next_page?: boolean; + /** @description Total number of budgets matching the query */ + total_count?: number; + }; + "get-budget": { + /** @description ID of the budget. */ + id: string; + /** + * @description The type of scope for the budget + * @example enterprise + * @enum {string} + */ + budget_scope: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @example octocat/hello-world + */ + budget_entity_name: string; + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description Whether to prevent additional spending once the budget is exceeded + * @example true + */ + prevent_further_usage: boolean; + /** + * @description A single product or sku to apply the budget to. + * @example actions_linux + */ + budget_product_sku: string; + /** + * @description The type of pricing for the budget + * @example ProductPricing + * @enum {string} + */ + budget_type: "ProductPricing" | "SkuPricing"; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert?: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients?: string[]; + }; + }; + "delete-budget": { + /** @description A message indicating the result of the deletion operation */ + message: string; + /** @description The ID of the deleted budget */ + id: string; + }; + "billing-premium-request-usage-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the user for the usage report. */ + user?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report": { + usageItems?: { /** @description Date of the usage line item. */ - readonly date: string; + date: string; /** @description Product name. */ - readonly product: string; + product: string; /** @description SKU name. */ - readonly sku: string; + sku: string; /** @description Quantity of the usage line item. */ - readonly quantity: number; + quantity: number; /** @description Unit type of the usage line item. */ - readonly unitType: string; + unitType: string; /** @description Price per unit of the usage line item. */ - readonly pricePerUnit: number; + pricePerUnit: number; /** @description Gross amount of the usage line item. */ - readonly grossAmount: number; + grossAmount: number; /** @description Discount amount of the usage line item. */ - readonly discountAmount: number; + discountAmount: number; /** @description Net amount of the usage line item. */ - readonly netAmount: number; + netAmount: number; /** @description Name of the organization. */ - readonly organizationName: string; + organizationName: string; /** @description Name of the repository. */ - readonly repositoryName?: string; + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; }[]; }; /** * Organization Full * @description Organization Full */ - readonly "organization-full": { + "organization-full": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; /** @example github */ - readonly name?: string; + name?: string; /** @example GitHub */ - readonly company?: string; + company?: string; /** * Format: uri * @example https://github.com/blog */ - readonly blog?: string; + blog?: string; /** @example San Francisco */ - readonly location?: string; + location?: string; /** * Format: email * @example octocat@github.com */ - readonly email?: string; + email?: string; /** @example github */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** @example true */ - readonly is_verified?: boolean; + is_verified?: boolean; /** @example true */ - readonly has_organization_projects: boolean; + has_organization_projects: boolean; /** @example true */ - readonly has_repository_projects: boolean; + has_repository_projects: boolean; /** @example 2 */ - readonly public_repos: number; + public_repos: number; /** @example 1 */ - readonly public_gists: number; + public_gists: number; /** @example 20 */ - readonly followers: number; + followers: number; /** @example 0 */ - readonly following: number; + following: number; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** @example Organization */ - readonly type: string; + type: string; /** @example 100 */ - readonly total_private_repos?: number; + total_private_repos?: number; /** @example 100 */ - readonly owned_private_repos?: number; + owned_private_repos?: number; /** @example 81 */ - readonly private_gists?: number | null; + private_gists?: number | null; /** @example 10000 */ - readonly disk_usage?: 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. * @example 8 */ - readonly collaborators?: number | null; + collaborators?: number | null; /** * Format: email * @example org@example.com */ - readonly billing_email?: string | null; - readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; }; - readonly default_repository_permission?: string | null; + default_repository_permission?: string | null; + /** + * @description The default branch for repositories created in this organization. + * @example main + */ + default_repository_branch?: string | null; /** @example true */ - readonly members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null; /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null; /** @example all */ - readonly members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string; + /** @example true */ + members_can_create_public_repositories?: boolean; + /** @example true */ + members_can_create_private_repositories?: boolean; /** @example true */ - readonly members_can_create_public_repositories?: boolean; + members_can_create_internal_repositories?: boolean; /** @example true */ - readonly members_can_create_private_repositories?: boolean; + members_can_create_pages?: boolean; /** @example true */ - readonly members_can_create_internal_repositories?: boolean; + members_can_create_public_pages?: boolean; /** @example true */ - readonly members_can_create_pages?: boolean; + members_can_create_private_pages?: boolean; /** @example true */ - readonly members_can_create_public_pages?: boolean; + members_can_delete_repositories?: boolean; /** @example true */ - readonly members_can_create_private_pages?: boolean; + members_can_change_repo_visibility?: boolean; + /** @example true */ + members_can_invite_outside_collaborators?: boolean; + /** @example true */ + members_can_delete_issues?: boolean; + /** @example true */ + display_commenter_full_name_setting_enabled?: boolean; + /** @example true */ + readers_can_create_discussions?: boolean; + /** @example true */ + members_can_create_teams?: boolean; + /** @example true */ + members_can_view_dependency_insights?: boolean; /** @example false */ - readonly members_can_fork_private_repositories?: boolean | null; + members_can_fork_private_repositories?: boolean | null; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22539,7 +24659,7 @@ export type components = { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly advanced_security_enabled_for_new_repositories?: boolean; + advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22549,7 +24669,7 @@ export type components = { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly dependabot_alerts_enabled_for_new_repositories?: boolean; + dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22559,7 +24679,7 @@ export type components = { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; + dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22569,7 +24689,7 @@ export type components = { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly dependency_graph_enabled_for_new_repositories?: boolean; + dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22579,7 +24699,7 @@ export type components = { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly secret_scanning_enabled_for_new_repositories?: boolean; + secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22589,2173 +24709,2440 @@ export type components = { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean; + secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** * @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. * @example false */ - readonly secret_scanning_push_protection_custom_link_enabled?: boolean; + secret_scanning_push_protection_custom_link_enabled?: boolean; /** * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ - readonly secret_scanning_push_protection_custom_link?: string | null; + secret_scanning_push_protection_custom_link?: string | null; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly archived_at: string | null; + 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; + deploy_keys_enabled_for_repositories?: boolean; }; - readonly "actions-cache-usage-org-enterprise": { + "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ - readonly total_active_caches_count: number; + total_active_caches_count: number; /** @description The total size in bytes of all active cache items across all repositories of an enterprise or an organization. */ - readonly total_active_caches_size_in_bytes: number; + total_active_caches_size_in_bytes: number; }; /** * Actions Cache Usage by repository * @description GitHub Actions Cache Usage by repository. */ - readonly "actions-cache-usage-by-repository": { + "actions-cache-usage-by-repository": { /** * @description The repository owner and name for the cache usage being shown. * @example octo-org/Hello-World */ - readonly full_name: string; + full_name: string; /** * @description The sum of the size in bytes of all the active cache items in the repository. * @example 2322142 */ - readonly active_caches_size_in_bytes: number; + active_caches_size_in_bytes: number; /** * @description The number of active caches in the repository. * @example 3 */ - readonly active_caches_count: number; + active_caches_count: number; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - readonly "nullable-actions-hosted-runner-pool-image": { + "nullable-actions-hosted-runner-pool-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 */ - readonly id: string; + id: string; /** * @description Image size in GB. * @example 86 */ - readonly size_gb: number; + size_gb: number; /** * @description Display name for this image. * @example 20.04 */ - readonly display_name: string; + display_name: string; /** * @description The image provider. * @enum {string} */ - readonly source: "github" | "partner" | "custom"; + source: "github" | "partner" | "custom"; /** * @description The image version of the hosted runner pool. * @example latest */ - readonly version: string; + version?: string; } | null; /** * Github-owned VM details. * @description Provides details of a particular machine spec. */ - readonly "actions-hosted-runner-machine-spec": { + "actions-hosted-runner-machine-spec": { /** * @description The ID used for the `size` parameter when creating a new runner. * @example 8-core */ - readonly id: string; + id: string; /** * @description The number of cores. * @example 8 */ - readonly cpu_cores: number; + cpu_cores: number; /** * @description The available RAM for the machine spec. * @example 32 */ - readonly memory_gb: number; + memory_gb: number; /** * @description The available SSD storage for the machine spec. * @example 300 */ - readonly storage_gb: number; + storage_gb: number; }; /** * Public IP for a GitHub-hosted larger runners. * @description Provides details of Public IP for a GitHub-hosted larger runners */ - readonly "public-ip": { + "public-ip": { /** * @description Whether public IP is enabled. * @example true */ - readonly enabled?: boolean; + enabled?: boolean; /** * @description The prefix for the public IP. * @example 20.80.208.150 */ - readonly prefix?: string; + prefix?: string; /** * @description The length of the IP prefix. * @example 28 */ - readonly length?: number; + length?: number; }; /** * GitHub-hosted hosted runner * @description A Github-hosted hosted runner. */ - readonly "actions-hosted-runner": { + "actions-hosted-runner": { /** * @description The unique identifier of the hosted runner. * @example 5 */ - readonly id: number; + id: number; /** * @description The name of the hosted runner. * @example my-github-hosted-runner */ - readonly name: string; + name: string; /** * @description The unique identifier of the group that the hosted runner belongs to. * @example 2 */ - readonly runner_group_id?: number; - readonly image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; - readonly machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + runner_group_id?: number; + image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; /** * @description The status of the runner. * @example Ready * @enum {string} */ - readonly status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; /** * @description The operating system of the image. * @example linux-x64 */ - readonly platform: string; + platform: string; /** * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. * @default 10 * @example 5 */ - readonly maximum_runners: number; + maximum_runners: number; /** * @description Whether public IP is enabled for the hosted runners. * @example true */ - readonly public_ip_enabled: boolean; + public_ip_enabled: boolean; /** @description The public IP ranges when public IP is enabled for the hosted runners. */ - readonly public_ips?: readonly components["schemas"]["public-ip"][]; + public_ips?: components["schemas"]["public-ip"][]; /** * Format: date-time * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z */ - readonly last_active_on?: string | null; + last_active_on?: string | null; + /** @description Whether custom image generation is enabled for the hosted runners. */ + image_gen?: boolean; + }; + /** + * GitHub-hosted runner custom image details + * @description Provides details of a custom runner image + */ + "actions-hosted-runner-custom-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example 1 + */ + id: number; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Total size of all the image versions in GB. + * @example 200 + */ + total_versions_size: number; + /** + * @description Display name for this image. + * @example CustomImage + */ + name: string; + /** + * @description The image provider. + * @example custom + */ + source: string; + /** + * @description The number of image versions associated with the image. + * @example 4 + */ + versions_count: number; + /** + * @description The latest image version associated with the image. + * @example 1.3.0 + */ + latest_version: string; + /** + * @description The number of image versions associated with the image. + * @example Ready + */ + state: string; + }; + /** + * GitHub-hosted runner custom image version details. + * @description Provides details of a hosted runner custom image version + */ + "actions-hosted-runner-custom-image-version": { + /** + * @description The version of image. + * @example 1.0.0 + */ + version: string; + /** + * @description The state of image version. + * @example Ready + */ + state: string; + /** + * @description Image version size in GB. + * @example 30 + */ + size_gb: number; + /** + * @description The creation date time of the image version. + * @example 2024-11-09T23:39:01Z + */ + created_on: string; + /** + * @description The image version status details. + * @example None + */ + state_details: string; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - readonly "actions-hosted-runner-image": { + "actions-hosted-runner-curated-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 */ - readonly id: string; + id: string; /** * @description The operating system of the image. * @example linux-x64 */ - readonly platform: string; + platform: string; /** * @description Image size in GB. * @example 86 */ - readonly size_gb: number; + size_gb: number; /** * @description Display name for this image. * @example 20.04 */ - readonly display_name: string; + display_name: string; /** * @description The image provider. * @enum {string} */ - readonly source: "github" | "partner" | "custom"; + source: "github" | "partner" | "custom"; }; - readonly "actions-hosted-runner-limits": { + "actions-hosted-runner-limits": { /** * Static public IP Limits for GitHub-hosted Hosted Runners. * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners */ - readonly public_ips: { + public_ips: { /** * @description The maximum number of static public IP addresses that can be used for Hosted Runners. * @example 50 */ - readonly maximum: number; + maximum: number; /** * @description The current number of static public IP addresses in use by Hosted Runners. * @example 17 */ - readonly current_usage: number; + current_usage: number; }; }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization */ - readonly "oidc-custom-sub": { + "oidc-custom-sub": { /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */ - readonly include_claim_keys: readonly string[]; + include_claim_keys: string[]; }; /** * Empty Object * @description An object without any properties. */ - readonly "empty-object": Record; + "empty-object": Record; /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. * @enum {string} */ - readonly "enabled-repositories": "all" | "none" | "selected"; + "enabled-repositories": "all" | "none" | "selected"; /** * @description The permissions policy that controls the actions and reusable workflows that are allowed to run. * @enum {string} */ - readonly "allowed-actions": "all" | "local_only" | "selected"; + "allowed-actions": "all" | "local_only" | "selected"; /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */ - readonly "selected-actions-url": string; - readonly "actions-organization-permissions": { - readonly enabled_repositories: components["schemas"]["enabled-repositories"]; + "selected-actions-url": string; + /** @description Whether actions must be pinned to a full-length commit SHA. */ + "sha-pinning-required": boolean; + "actions-organization-permissions": { + enabled_repositories: components["schemas"]["enabled-repositories"]; /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - readonly selected_repositories_url?: string; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; + selected_repositories_url?: string; + allowed_actions?: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; - readonly "selected-actions": { + "actions-artifact-and-log-retention-response": { + /** @description The number of days artifacts and logs are retained */ + days: number; + /** @description The maximum number of days that can be configured */ + maximum_allowed_days: number; + }; + "actions-artifact-and-log-retention": { + /** @description The number of days to retain artifacts and logs */ + days: number; + }; + "actions-fork-pr-contributor-approval": { + /** + * @description The policy that controls when fork PR workflows require approval from a maintainer. + * @enum {string} + */ + approval_policy: "first_time_contributors_new_to_github" | "first_time_contributors" | "all_external_contributors"; + }; + "actions-fork-pr-workflows-private-repos": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows: boolean; + }; + "actions-fork-pr-workflows-private-repos-request": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows?: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables?: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows?: boolean; + }; + "selected-actions": { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - readonly github_owned_allowed?: boolean; + github_owned_allowed?: boolean; /** @description Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. */ - readonly verified_allowed?: boolean; + verified_allowed?: boolean; /** * @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * * > [!NOTE] * > The `patterns_allowed` setting only applies to public repositories. */ - readonly patterns_allowed?: readonly string[]; + patterns_allowed?: string[]; + }; + "self-hosted-runners-settings": { + /** + * @description The policy that controls whether self-hosted runners can be used by repositories in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + /** @description The URL to the endpoint for managing selected repositories for self-hosted runners in the organization */ + selected_repositories_url?: string; }; /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows. * @enum {string} */ - readonly "actions-default-workflow-permissions": "read" | "write"; + "actions-default-workflow-permissions": "read" | "write"; /** @description Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. */ - readonly "actions-can-approve-pull-request-reviews": boolean; - readonly "actions-get-default-workflow-permissions": { - 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 "actions-set-default-workflow-permissions": { - 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; + "actions-can-approve-pull-request-reviews": boolean; + "actions-get-default-workflow-permissions": { + default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; + can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; + }; + "actions-set-default-workflow-permissions": { + 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` */ - readonly selected_repositories_url?: string; - readonly runners_url: string; - readonly hosted_runners_url?: string; + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; /** @description The identifier of a hosted compute network configuration. */ - readonly network_configuration_id?: string; - readonly inherited: boolean; - readonly inherited_allows_public_repositories?: boolean; - readonly allows_public_repositories: boolean; + network_configuration_id?: 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 */ - readonly workflow_restrictions_read_only: boolean; + 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; + 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[]; + selected_workflows?: string[]; }; /** * Self hosted runner label * @description A label for a self hosted runner */ - readonly "runner-label": { + "runner-label": { /** @description Unique identifier of the label. */ - readonly id?: number; + id?: number; /** @description Name of the label. */ - readonly name: string; + name: string; /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - readonly type?: "read-only" | "custom"; + type?: "read-only" | "custom"; }; /** * Self hosted runners * @description A self hosted runner */ - readonly runner: { + runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ - readonly id: number; + id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ - readonly runner_group_id?: number; + runner_group_id?: number; /** * @description The name of the runner. * @example iMac */ - readonly name: string; + name: string; /** * @description The Operating System of the runner. * @example macos */ - readonly os: string; + os: string; /** * @description The status of the runner. * @example online */ - readonly status: string; - readonly busy: boolean; - readonly labels: readonly components["schemas"]["runner-label"][]; + status: string; + busy: boolean; + labels: components["schemas"]["runner-label"][]; + ephemeral?: boolean; }; /** * Runner Application * @description Runner Application */ - readonly "runner-application": { - readonly os: string; - readonly architecture: string; - readonly download_url: string; - readonly filename: string; + "runner-application": { + os: string; + architecture: string; + download_url: string; + filename: string; /** @description A short lived bearer token used to download the runner, if needed. */ - readonly temp_download_token?: string; - readonly sha256_checksum?: string; + temp_download_token?: string; + sha256_checksum?: string; }; /** * Authentication Token * @description Authentication Token */ - readonly "authentication-token": { + "authentication-token": { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - readonly token: string; + token: string; /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - readonly expires_at: string; + expires_at: string; /** * @example { * "issues": "read", * "deployments": "write" * } */ - readonly permissions?: Record; + permissions?: Record; /** @description The repositories this token has access to */ - readonly repositories?: readonly components["schemas"]["repository"][]; + repositories?: components["schemas"]["repository"][]; /** @example config.yaml */ - readonly single_file?: string | null; + single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection?: "all" | "selected"; + repository_selection?: "all" | "selected"; }; /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - readonly "organization-actions-secret": { + "organization-actions-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; }; /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - readonly "actions-public-key": { + "actions-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; /** @example 2 */ - readonly id?: number; + id?: number; /** @example https://api.github.com/user/keys/2 */ - readonly url?: string; + url?: string; /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - readonly title?: string; + title?: string; /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; + created_at?: string; }; /** * Actions Variable for an Organization * @description Organization variable for GitHub Actions. */ - readonly "organization-actions-variable": { + "organization-actions-variable": { /** * @description The name of the variable. * @example USERNAME */ - readonly name: string; + name: string; /** * @description The value of the variable. * @example octocat */ - readonly value: string; + value: string; /** * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly updated_at: string; + updated_at: string; /** * @description Visibility of a variable * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; + }; + /** + * Artifact Deployment Record + * @description Artifact Metadata Deployment Record + */ + "artifact-deployment-record": { + id?: number; + digest?: string; + logical_environment?: string; + physical_environment?: string; + cluster?: string; + deployment_name?: string; + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + created_at?: string; + updated_at?: string; + /** @description The ID of the provenance attestation associated with the deployment record. */ + attestation_id?: number | null; + }; + /** + * Campaign state + * @description Indicates whether a campaign is open or closed + * @enum {string} + */ + "campaign-state": "open" | "closed"; + /** + * Campaign alert type + * @description Indicates the alert type of a campaign + * @enum {string} + */ + "campaign-alert-type": "code_scanning" | "secret_scanning"; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Campaign summary + * @description The campaign metadata and alert stats. + */ + "campaign-summary": { + /** @description The number of the newly created campaign */ + number: number; + /** + * Format: date-time + * @description The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** @description The campaign name */ + name?: string; + /** @description The campaign description */ + description: string; + /** @description The campaign managers */ + managers: components["schemas"]["simple-user"][]; + /** @description The campaign team managers */ + team_managers?: components["schemas"]["team"][]; + /** + * Format: date-time + * @description The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + published_at?: string; + /** + * Format: date-time + * @description The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at: string; + /** + * Format: date-time + * @description The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + */ + closed_at?: string | null; + state: components["schemas"]["campaign-state"]; + /** + * Format: uri + * @description The contact link of the campaign. + */ + contact_link: string | null; + alert_stats?: { + /** @description The number of open alerts */ + open_count: number; + /** @description The number of closed alerts */ + closed_count: number; + /** @description The number of in-progress alerts */ + in_progress_count: number; + }; }; /** @description The name of the tool used to generate the code scanning analysis. */ - readonly "code-scanning-analysis-tool-name": string; + "code-scanning-analysis-tool-name": string; /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - readonly "code-scanning-analysis-tool-guid": string | null; + "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. * @enum {string} */ - readonly "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; + "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; /** * @description Severity of a code scanning alert. * @enum {string} */ - readonly "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; + "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string|null} */ - readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; + "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} */ - readonly "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ - readonly "code-scanning-alert-dismissed-comment": string | null; - readonly "code-scanning-alert-rule-summary": { + "code-scanning-alert-dismissed-comment": string | null; + "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; + id?: string | null; /** @description The name of the rule used to detect the alert. */ - readonly name?: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity?: "none" | "note" | "warning" | "error" | null; + severity?: "none" | "note" | "warning" | "error" | null; /** * @description The security severity of the alert. * @enum {string|null} */ - readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; + security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; + description?: string; /** @description A description of the rule used to detect the alert. */ - readonly full_description?: string; + full_description?: string; /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; + tags?: string[] | null; /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ - readonly "code-scanning-analysis-tool-version": string | null; - readonly "code-scanning-analysis-tool": { - readonly name?: components["schemas"]["code-scanning-analysis-tool-name"]; - readonly version?: components["schemas"]["code-scanning-analysis-tool-version"]; - readonly guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; + "code-scanning-analysis-tool-version": string | null; + "code-scanning-analysis-tool": { + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + version?: components["schemas"]["code-scanning-analysis-tool-version"]; + guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; /** * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, * `refs/heads/` or simply ``. */ - readonly "code-scanning-ref": string; + "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly "code-scanning-analysis-analysis-key": string; + "code-scanning-analysis-analysis-key": string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly "code-scanning-alert-environment": string; + "code-scanning-alert-environment": string; /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - readonly "code-scanning-analysis-category": string; + "code-scanning-analysis-category": string; /** @description Describe a region within a file for the alert. */ - readonly "code-scanning-alert-location": { - readonly path?: string; - readonly start_line?: number; - readonly end_line?: number; - readonly start_column?: number; - readonly end_column?: number; + "code-scanning-alert-location": { + path?: string; + start_line?: number; + end_line?: number; + start_column?: number; + end_column?: number; }; /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - readonly "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; - readonly "code-scanning-alert-instance": { - readonly ref?: components["schemas"]["code-scanning-ref"]; - readonly analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - readonly environment?: components["schemas"]["code-scanning-alert-environment"]; - readonly category?: components["schemas"]["code-scanning-analysis-category"]; - readonly state?: components["schemas"]["code-scanning-alert-state"]; - readonly commit_sha?: string; - readonly message?: { - readonly text?: string; + "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; + "code-scanning-alert-instance": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-state"]; + commit_sha?: string; + message?: { + text?: string; }; - readonly location?: components["schemas"]["code-scanning-alert-location"]; - readonly html_url?: string; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - readonly classifications?: readonly components["schemas"]["code-scanning-alert-classification"][]; - }; - readonly "code-scanning-organization-alert-items": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - readonly repository: components["schemas"]["simple-repository"]; + classifications?: components["schemas"]["code-scanning-alert-classification"][]; + }; + "code-scanning-organization-alert-items": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["alert-updated-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + fixed_at?: components["schemas"]["alert-fixed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + repository: components["schemas"]["simple-repository"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * Codespace machine * @description A description of the machine powering a codespace. */ - readonly "nullable-codespace-machine": { + "nullable-codespace-machine": { /** * @description The name of the machine. * @example standardLinux */ - readonly name: string; + name: string; /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 16 GB RAM, 64 GB storage */ - readonly display_name: string; + display_name: string; /** * @description The operating system of the machine. * @example linux */ - readonly operating_system: string; + operating_system: string; /** * @description How much storage is available to the codespace. * @example 68719476736 */ - readonly storage_in_bytes: number; + storage_in_bytes: number; /** * @description How much memory is available to the codespace. * @example 17179869184 */ - readonly memory_in_bytes: number; + memory_in_bytes: number; /** * @description How many cores are available to the codespace. * @example 4 */ - readonly cpus: number; + cpus: number; /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} */ - readonly prebuild_availability: "none" | "ready" | "in_progress" | null; + prebuild_availability: "none" | "ready" | "in_progress" | null; } | null; /** * Codespace * @description A codespace. */ - readonly codespace: { + codespace: { /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - readonly name: string; + name: string; /** * @description Display name for this codespace. * @example bookish space pancake */ - readonly display_name?: string | null; + display_name?: string | null; /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - readonly environment_id: string | null; - readonly owner: components["schemas"]["simple-user"]; - readonly billable_owner: components["schemas"]["simple-user"]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null; + owner: components["schemas"]["simple-user"]; + billable_owner: components["schemas"]["simple-user"]; + repository: components["schemas"]["minimal-repository"]; + machine: components["schemas"]["nullable-codespace-machine"]; /** * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ - readonly devcontainer_path?: string | null; + devcontainer_path?: string | null; /** * @description Whether the codespace was created from a prebuild. * @example false */ - readonly prebuild: boolean | null; + prebuild: boolean | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - readonly last_used_at: string; + last_used_at: string; /** * @description State of this codespace. * @example Available * @enum {string} */ - readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; + state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** * Format: uri * @description API URL for this codespace. */ - readonly url: string; + url: string; /** @description Details about the codespace's git repository. */ - readonly git_status: { + git_status: { /** * @description The number of commits the local repository is ahead of the remote. * @example 0 */ - readonly ahead?: number; + ahead?: number; /** * @description The number of commits the local repository is behind the remote. * @example 0 */ - readonly behind?: number; + behind?: number; /** @description Whether the local repository has unpushed changes. */ - readonly has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean; /** @description Whether the local repository has uncommitted changes. */ - readonly has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean; /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - readonly ref?: string; + ref?: string; }; /** * @description The initally assigned location of a new codespace. * @example WestUs2 * @enum {string} */ - readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - readonly idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null; /** * Format: uri * @description URL to access this codespace on the web. */ - readonly web_url: string; + web_url: string; /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - readonly machines_url: string; + machines_url: string; /** * Format: uri * @description API URL to start this codespace. */ - readonly start_url: string; + start_url: string; /** * Format: uri * @description API URL to stop this codespace. */ - readonly stop_url: string; + stop_url: string; /** * Format: uri * @description API URL to publish this codespace to a new repository. */ - readonly publish_url?: string | null; + publish_url?: string | null; /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - readonly pulls_url: string | null; - readonly recent_folders: readonly string[]; - readonly runtime_constraints?: { + pulls_url: string | null; + recent_folders: string[]; + runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - readonly allowed_port_privacy_settings?: readonly string[] | null; + allowed_port_privacy_settings?: string[] | null; }; /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ - readonly pending_operation?: boolean | null; + pending_operation?: boolean | null; /** @description Text to show user when codespace is disabled by a pending operation */ - readonly pending_operation_disabled_reason?: string | null; + pending_operation_disabled_reason?: string | null; /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ - readonly idle_timeout_notice?: string | null; + idle_timeout_notice?: string | null; /** * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ - readonly retention_period_minutes?: number | null; + retention_period_minutes?: number | null; /** * Format: date-time * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z */ - readonly retention_expires_at?: string | null; + retention_expires_at?: string | null; /** * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ - readonly last_known_stop_notice?: string | null; + last_known_stop_notice?: string | null; }; /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - readonly "codespaces-org-secret": { + "codespaces-org-secret": { /** * @description The name of the secret * @example SECRET_NAME */ - readonly name: string; + name: string; /** * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at: string; + updated_at: string; /** * @description The type of repositories in the organization that the secret is visible to * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; }; /** * CodespacesPublicKey * @description The public key used for setting Codespaces secrets. */ - readonly "codespaces-public-key": { + "codespaces-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; /** @example 2 */ - readonly id?: number; + id?: number; /** @example https://api.github.com/user/keys/2 */ - readonly url?: string; + url?: string; /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - readonly title?: string; + title?: string; /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; + created_at?: string; }; /** - * Copilot Business Seat Breakdown + * Copilot Seat Breakdown * @description The breakdown of Copilot Business seats for the organization. */ - readonly "copilot-seat-breakdown": { + "copilot-organization-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ - readonly total?: number; + total?: number; /** @description Seats added during the current billing cycle. */ - readonly added_this_cycle?: number; + added_this_cycle?: number; /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ - readonly pending_cancellation?: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ - readonly pending_invitation?: number; + pending_cancellation?: number; + /** @description The number of users who have been invited to receive a Copilot seat through this organization. */ + pending_invitation?: number; /** @description The number of seats that have used Copilot during the current billing cycle. */ - readonly active_this_cycle?: number; + active_this_cycle?: number; /** @description The number of seats that have not used Copilot during the current billing cycle. */ - readonly inactive_this_cycle?: number; + inactive_this_cycle?: number; }; /** * 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"]; + "copilot-organization-details": { + seat_breakdown: components["schemas"]["copilot-organization-seat-breakdown"]; /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @description The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). * @enum {string} */ - readonly public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + public_code_suggestions: "allow" | "block" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @description The organization policy for allowing or disallowing Copilot Chat in the IDE. * @enum {string} */ - readonly ide_chat?: "enabled" | "disabled" | "unconfigured"; + ide_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @description The organization policy for allowing or disallowing Copilot features on GitHub.com. * @enum {string} */ - readonly platform_chat?: "enabled" | "disabled" | "unconfigured"; + platform_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @description The organization policy for allowing or disallowing Copilot CLI. * @enum {string} */ - readonly cli?: "enabled" | "disabled" | "unconfigured"; + cli?: "enabled" | "disabled" | "unconfigured"; /** * @description The mode of assigning new seats. * @enum {string} */ - readonly seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + 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"; + plan_type?: "business" | "enterprise"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }; /** * Organization Simple * @description A GitHub organization. */ - readonly "nullable-organization-simple": { + "nullable-organization-simple": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - readonly id: number; - /** @example MDQ6VGVhbTE= */ - readonly node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - readonly url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - readonly name: string; - /** - * @description Description of the team - * @example A great team. - */ - readonly description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - readonly permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - readonly privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - readonly notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - readonly html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - readonly repositories_url: string; - /** @example justice-league */ - readonly slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - readonly ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission: string; - readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; - }; - /** Format: uri */ - readonly url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - readonly html_url: string; - readonly members_url: string; - /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - readonly "enterprise-team": { - /** Format: int64 */ - readonly id: number; - readonly name: string; - readonly slug: string; - /** Format: uri */ - readonly url: string; - /** @example disabled | all */ - readonly sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - readonly group_id?: string | null; - /** @example Justice League */ - readonly group_name?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league - */ - readonly html_url: string; - readonly members_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ - readonly "copilot-seat-details": { - readonly assignee: components["schemas"]["simple-user"]; - readonly organization?: components["schemas"]["nullable-organization-simple"]; + "copilot-seat-details": { + assignee?: components["schemas"]["nullable-simple-user"]; + 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; + assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** * Format: date * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. */ - readonly pending_cancellation_date?: string | null; + pending_cancellation_date?: string | null; /** * Format: date-time * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. */ - readonly last_activity_at?: string | null; + last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - readonly last_activity_editor?: string | null; + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + */ + last_authenticated_at?: string | null; /** * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ - readonly updated_at?: string; + updated_at?: string; /** * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ - readonly plan_type?: "business" | "enterprise" | "unknown"; + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** + * Copilot Organization Content Exclusion Details + * @description List all Copilot Content Exclusion rules for an organization. + */ + "copilot-organization-content-exclusion-details": { + [key: string]: string[]; }; /** @description Usage metrics for Copilot editor code completions in the IDE. */ - readonly "copilot-ide-code-completions": ({ + "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; + total_engaged_users?: number; /** @description Code completion metrics for active languages. */ - readonly languages?: readonly { + languages?: { /** @description Name of the language used for Copilot code completion suggestions. */ - readonly name?: string; + 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; + total_engaged_users?: number; }[]; - readonly editors?: readonly ({ + editors?: ({ /** @description Name of the given editor. */ - readonly name?: string; + 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; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { + models?: { /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; + 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; + total_engaged_users?: number; /** @description Code completion metrics for active languages, for the given editor. */ - readonly languages?: readonly { + languages?: { /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; + 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; + 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; + 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; + 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; + 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; + total_code_lines_accepted?: number; }[]; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; })[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; /** @description Usage metrics for Copilot Chat in the IDE. */ - readonly "copilot-ide-chat": ({ + "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ - readonly total_engaged_users?: number; - readonly editors?: readonly { + total_engaged_users?: number; + editors?: { /** @description Name of the given editor. */ - readonly name?: string; + name?: string; /** @description The number of users who prompted Copilot Chat in the specified editor. */ - readonly total_engaged_users?: number; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + models?: { + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; + 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; + total_engaged_users?: number; /** @description The total number of chats initiated by users in the given editor and model. */ - readonly total_chats?: number; + 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; + 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; + total_chat_copy_events?: number; }[]; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - readonly "copilot-dotcom-chat": ({ + /** @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. */ - readonly total_engaged_users?: number; + total_engaged_users?: number; /** @description List of model metrics for a custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + models?: { + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model (if applicable). */ - readonly custom_model_training_date?: string | null; + 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; + total_engaged_users?: number; /** @description Total number of chats initiated by users on github.com. */ - readonly total_chats?: number; + total_chats?: number; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; /** @description Usage metrics for Copilot for pull requests. */ - readonly "copilot-dotcom-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. */ - readonly total_engaged_users?: number; + total_engaged_users?: number; /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - readonly repositories?: readonly { + repositories?: { /** @description Repository name */ - readonly name?: string; + 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; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + models?: { + /** @description Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; + 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; + 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; + total_engaged_users?: number; }[]; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; /** * Copilot Usage Metrics * @description Copilot usage metrics for a given day. */ - readonly "copilot-usage-metrics-day": { + "copilot-usage-metrics-day": { /** * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. */ - readonly date: string; + 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; + 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"]; + 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"]; } & { - readonly [key: string]: unknown; - }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - readonly "copilot-usage-metrics": { - /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - readonly day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - readonly total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - readonly total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - readonly total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - readonly total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - readonly total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - readonly total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - readonly total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - readonly total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - readonly breakdown: readonly ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - readonly language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - readonly editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - readonly suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - readonly acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - readonly lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - readonly lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - readonly active_users?: number; - } & { - readonly [key: string]: unknown; - })[] | null; + [key: string]: unknown; }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - readonly "organization-dependabot-secret": { + "organization-dependabot-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; }; /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - readonly "dependabot-public-key": { + "dependabot-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; }; /** * Minimal Repository * @description Minimal Repository */ - readonly "nullable-minimal-repository": { + "nullable-minimal-repository": { /** * Format: int64 * @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @example Hello-World */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - readonly git_url?: string; + git_tags_url: string; + git_url?: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - readonly ssh_url?: string; + releases_url: string; + ssh_url?: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - readonly clone_url?: string; - readonly mirror_url?: string | null; + trees_url: string; + clone_url?: string; + mirror_url?: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; - readonly svn_url?: string; - readonly homepage?: string | null; - readonly language?: string | null; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; + hooks_url: string; + svn_url?: string; + homepage?: string | null; + language?: string | null; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly has_discussions?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived?: boolean; + disabled?: boolean; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string | null; + pushed_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at?: string | null; + created_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at?: string | null; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; + updated_at?: string | null; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; /** @example admin */ - readonly role_name?: string; - readonly temp_clone_token?: string; - readonly delete_branch_on_merge?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; - readonly license?: { - readonly key?: string; - readonly name?: string; - readonly spdx_id?: string; - readonly url?: string; - readonly node_id?: string; + role_name?: string; + temp_clone_token?: string; + delete_branch_on_merge?: boolean; + subscribers_count?: number; + network_count?: number; + code_of_conduct?: components["schemas"]["code-of-conduct"]; + license?: { + key?: string; + name?: string; + spdx_id?: string; + url?: string | null; + node_id?: string; } | null; /** @example 0 */ - readonly forks?: number; + forks?: number; /** @example 0 */ - readonly open_issues?: number; + open_issues?: number; /** @example 0 */ - readonly watchers?: number; - readonly allow_forking?: boolean; + watchers?: number; + allow_forking?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + web_commit_signoff_required?: boolean; + security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; } | null; /** * Package * @description A software package */ - readonly package: { + package: { /** * @description Unique identifier of the package. * @example 1 */ - readonly id: number; + id: number; /** * @description The name of the package. * @example super-linter */ - readonly name: string; + name: string; /** * @example docker * @enum {string} */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - readonly url: string; + url: string; /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - readonly html_url: string; + html_url: string; /** * @description The number of versions of the package. * @example 1 */ - readonly version_count: number; + version_count: number; /** * @example private * @enum {string} */ - readonly visibility: "private" | "public"; - readonly owner?: components["schemas"]["nullable-simple-user"]; - readonly repository?: components["schemas"]["nullable-minimal-repository"]; + visibility: "private" | "public"; + owner?: components["schemas"]["nullable-simple-user"]; + repository?: components["schemas"]["nullable-minimal-repository"]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Organization Invitation * @description Organization Invitation */ - readonly "organization-invitation": { + "organization-invitation": { /** Format: int64 */ - readonly id: number; - readonly login: string | null; - readonly email: string | null; - readonly role: string; - readonly created_at: string; - readonly failed_at?: string | null; - readonly failed_reason?: string | null; - readonly inviter: components["schemas"]["simple-user"]; - readonly team_count: number; + id: number; + login: string | null; + email: string | null; + role: string; + created_at: string; + failed_at?: string | null; + failed_reason?: string | null; + inviter: components["schemas"]["simple-user"]; + team_count: number; /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - readonly node_id: string; + node_id: string; /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - readonly invitation_teams_url: string; + invitation_teams_url: string; /** @example "member" */ - readonly invitation_source?: string; + invitation_source?: string; }; /** * Org Hook * @description Org Hook */ - readonly "org-hook": { + "org-hook": { /** @example 1 */ - readonly id: number; + id: number; /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - readonly ping_url: string; + ping_url: string; /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - readonly deliveries_url?: string; + deliveries_url?: string; /** @example web */ - readonly name: string; + name: string; /** * @example [ * "push", * "pull_request" * ] */ - readonly events: readonly string[]; + events: string[]; /** @example true */ - readonly active: boolean; - readonly config: { + active: boolean; + config: { /** @example "http://example.com/2" */ - readonly url?: string; + url?: string; /** @example "0" */ - readonly insecure_ssl?: string; + insecure_ssl?: string; /** @example "form" */ - readonly content_type?: string; + content_type?: string; /** @example "********" */ - readonly secret?: string; + secret?: string; }; /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; - readonly type: string; + created_at: string; + type: string; }; /** * Route Stats * @description API Insights usage route stats for an actor */ - readonly "api-insights-route-stats": readonly { + "api-insights-route-stats": { /** @description The HTTP method */ - readonly http_method?: string; + http_method?: string; /** @description The API path's route template */ - readonly api_route?: string; + api_route?: string; /** * Format: int64 * @description The total number of requests within the queried time period */ - readonly total_request_count?: number; + 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; + 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 */ - readonly "api-insights-subject-stats": readonly { - readonly subject_type?: string; - readonly subject_name?: string; + "api-insights-subject-stats": { + subject_type?: string; + 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; + 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 */ - readonly "api-insights-summary-stats": { + "api-insights-summary-stats": { /** * Format: int64 * @description The total number of requests within the queried time period */ - readonly total_request_count?: number; + 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; + 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; + "api-insights-time-stats": { + timestamp?: string; /** Format: int64 */ - readonly total_request_count?: number; + total_request_count?: number; /** Format: int64 */ - readonly rate_limited_request_count?: number; + 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; + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; /** Format: int64 */ - readonly actor_id?: number; + actor_id?: number; /** Format: int64 */ - readonly integration_id?: number | null; + 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; + 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 * @enum {string} */ - readonly "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; /** * Interaction Limits * @description Interaction limit settings. */ - readonly "interaction-limit-response": { - readonly limit: components["schemas"]["interaction-group"]; + "interaction-limit-response": { + limit: components["schemas"]["interaction-group"]; /** @example repository */ - readonly origin: string; + origin: string; /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - readonly expires_at: string; + expires_at: string; }; /** * @description The duration of the interaction restriction. Default: `one_day`. * @example one_month * @enum {string} */ - readonly "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - readonly "interaction-limit": { - readonly limit: components["schemas"]["interaction-group"]; - readonly expiry?: components["schemas"]["interaction-expiry"]; + "interaction-limit": { + limit: components["schemas"]["interaction-group"]; + expiry?: components["schemas"]["interaction-expiry"]; + }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; }; /** * Org Membership * @description Org Membership */ - readonly "org-membership": { + "org-membership": { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - readonly url: string; + url: string; /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - readonly state: "active" | "pending"; + state: "active" | "pending"; /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - readonly role: "admin" | "member" | "billing_manager"; + role: "admin" | "member" | "billing_manager"; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; /** * Format: uri * @example https://api.github.com/orgs/octocat */ - readonly organization_url: string; - readonly organization: components["schemas"]["organization-simple"]; - readonly user: components["schemas"]["nullable-simple-user"]; - readonly permissions?: { - readonly can_create_repository: boolean; + organization_url: string; + organization: components["schemas"]["organization-simple"]; + user: components["schemas"]["nullable-simple-user"]; + permissions?: { + can_create_repository: boolean; }; }; /** * Migration * @description A migration. */ - readonly migration: { + migration: { /** * Format: int64 * @example 79 */ - readonly id: number; - readonly owner: components["schemas"]["nullable-simple-user"]; + id: number; + owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - readonly guid: string; + guid: string; /** @example pending */ - readonly state: string; + state: string; /** @example true */ - readonly lock_repositories: boolean; - readonly exclude_metadata: boolean; - readonly exclude_git_data: boolean; - readonly exclude_attachments: boolean; - readonly exclude_releases: boolean; - readonly exclude_owner_projects: boolean; - readonly org_metadata_only: boolean; + lock_repositories: boolean; + exclude_metadata: boolean; + exclude_git_data: boolean; + exclude_attachments: boolean; + exclude_releases: boolean; + exclude_owner_projects: boolean; + org_metadata_only: boolean; /** @description The repositories included in the migration. Only returned for export migrations. */ - readonly repositories: readonly components["schemas"]["repository"][]; + repositories: components["schemas"]["repository"][]; /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - readonly url: string; + url: string; /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - readonly updated_at: string; - readonly node_id: string; + updated_at: string; + node_id: string; /** Format: uri */ - readonly archive_url?: string; + archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ - readonly exclude?: readonly string[]; + exclude?: string[]; }; /** * Organization Role * @description Organization roles */ - readonly "organization-role": { + "organization-role": { /** * Format: int64 * @description The unique identifier of the role. */ - readonly id: number; + id: number; /** @description The name of the role. */ - readonly name: string; + name: string; /** @description A short description about who this role is for or what permissions it grants. */ - readonly description?: string | null; + description?: string | null; /** * @description The system role from which this role inherits permissions. * @enum {string|null} */ - readonly base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ - readonly source?: "Organization" | "Enterprise" | "Predefined" | null; + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ - readonly permissions: readonly string[]; - readonly organization: components["schemas"]["nullable-simple-user"]; + permissions: string[]; + organization: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The date and time the role was created. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time the role was last updated. */ - readonly updated_at: string; + updated_at: string; }; /** * A Role Assignment for a Team * @description The Relationship a Team has with a role. */ - readonly "team-role-assignment": { + "team-role-assignment": { /** * @description Determines if the team has a direct, indirect, or mixed relationship to a role * @example direct * @enum {string} */ - readonly assignment?: "direct" | "indirect" | "mixed"; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission: string; - readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; }; /** Format: uri */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; - readonly members_url: string; + html_url: string; + members_url: string; /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "team-simple": { + "team-simple": { /** * @description Unique identifier of the team * @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + members_url: string; /** * @description Name of the team * @example Justice League */ - readonly name: string; + name: string; /** * @description Description of the team * @example A great team. */ - readonly description: string | null; + description: string | null; /** * @description Permission that the team will have for its repositories * @example admin */ - readonly permission: string; + permission: string; /** * @description The level of privacy this team should have * @example closed */ - readonly privacy?: string; + privacy?: string; /** * @description The notification setting the team has set * @example notifications_enabled */ - readonly notification_setting?: string; + notification_setting?: string; /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; + repositories_url: string; /** @example justice-league */ - readonly slug: string; + slug: string; /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - readonly ldap_dn?: string; + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * A Role Assignment for a User * @description The Relationship a User has with a role. */ - readonly "user-role-assignment": { + "user-role-assignment": { /** * @description Determines if the user has a direct, indirect, or mixed relationship to a role * @example direct * @enum {string} */ - readonly assignment?: "direct" | "indirect" | "mixed"; + assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ - readonly inherited_from?: readonly components["schemas"]["team-simple"][]; - readonly name?: string | null; - readonly email?: string | null; + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; /** @example octocat */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; + starred_at?: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; }; /** * Package Version * @description A version of a software package */ - readonly "package-version": { + "package-version": { /** * @description Unique identifier of the package version. * @example 1 */ - readonly id: number; + id: number; /** * @description The name of the package version. * @example latest */ - readonly name: string; + name: string; /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - readonly url: string; + url: string; /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - readonly package_html_url: string; + package_html_url: string; /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - readonly html_url?: string; + html_url?: string; /** @example MIT */ - readonly license?: string; - readonly description?: string; + license?: string; + description?: string; /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly deleted_at?: string; + deleted_at?: string; /** Package Version Metadata */ - readonly metadata?: { + metadata?: { /** * @example docker * @enum {string} */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** Container Metadata */ - readonly container?: { - readonly tags: readonly string[]; + container?: { + tags: string[]; }; /** Docker Metadata */ - readonly docker?: { - readonly tag?: readonly string[]; + docker?: { + tag?: string[]; }; }; }; @@ -24763,602 +27150,1143 @@ export type components = { * Simple Organization Programmatic Access Grant Request * @description Minimal representation of an organization programmatic access grant request for enumerations */ - readonly "organization-programmatic-access-grant-request": { + "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ - readonly id: number; + id: number; /** @description Reason for requesting access. */ - readonly reason: string | null; - readonly owner: components["schemas"]["simple-user"]; + reason: string | null; + owner: components["schemas"]["simple-user"]; /** * @description Type of repository selection requested. * @enum {string} */ - readonly repository_selection: "none" | "all" | "subset"; + repository_selection: "none" | "all" | "subset"; /** @description URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. */ - readonly repositories_url: string; + repositories_url: string; /** @description Permissions requested, categorized by type of permission. */ - readonly permissions: { - readonly organization?: { - readonly [key: string]: string; + permissions: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ - readonly created_at: string; + 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; + 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; + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; + token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; + token_expires_at: string | null; /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + token_last_used_at: string | null; }; /** * Organization Programmatic Access Grant * @description Minimal representation of an organization programmatic access grant for enumerations */ - readonly "organization-programmatic-access-grant": { + "organization-programmatic-access-grant": { /** @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"]; + id: number; + owner: components["schemas"]["simple-user"]; /** * @description Type of repository selection requested. * @enum {string} */ - readonly repository_selection: "none" | "all" | "subset"; + repository_selection: "none" | "all" | "subset"; /** @description URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. */ - readonly repositories_url: string; + repositories_url: string; /** @description Permissions requested, categorized by type of permission. */ - readonly permissions: { - readonly organization?: { - readonly [key: string]: string; + permissions: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ - readonly access_granted_at: string; + 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; + 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; + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; + token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; + token_expires_at: string | null; /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + token_last_used_at: string | null; }; /** * Organization private registry * @description Private registry configuration for an organization */ - readonly "org-private-registry-configuration": { + "org-private-registry-configuration": { /** * @description The name of the private registry configuration. * @example MAVEN_REPOSITORY_SECRET */ - readonly name: string; + name: string; /** * @description The registry type. * @enum {string} */ - readonly registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ - readonly username?: string | null; + username?: string | null; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Organization private registry * @description Private registry configuration for an organization */ - readonly "org-private-registry-configuration-with-selected-repositories": { + "org-private-registry-configuration-with-selected-repositories": { /** * @description The name of the private registry configuration. * @example MAVEN_REPOSITORY_SECRET */ - readonly name: string; + name: string; /** * @description The registry type. * @enum {string} */ - readonly registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ - readonly username?: string; + username?: string; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** - * Project - * @description Projects are a way to organize columns and cards of work. + * Projects v2 Status Update + * @description An status update belonging to a project */ - readonly project: { + "nullable-projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the status update was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the status update was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @description The start date of the period covered by the update. + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @description The target date associated with the update. + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + } | null; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + /** @description The unique identifier of the project. */ + id: number; + /** @description The node ID of the project. */ + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + /** @description The project title. */ + title: string; + /** @description A short description of the project. */ + description: string | null; + /** @description Whether the project is visible to anyone with access to the owner. */ + public: boolean; + /** + * Format: date-time + * @description The time when the project was closed. + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @description The time when the project was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the project was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @description The project number. */ + number: number; + /** @description A concise summary of the project. */ + short_description: string | null; + /** + * Format: date-time + * @description The time when the project was deleted. + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: components["schemas"]["nullable-simple-user"]; + /** + * @description The current state of the project. + * @enum {string} + */ + state?: "open" | "closed"; + latest_status_update?: components["schemas"]["nullable-projects-v2-status-update"]; + /** @description Whether this project is a template */ + is_template?: boolean; + }; + /** + * Link + * @description Hypermedia Link + */ + link: { + href: string; + }; + /** + * Auto merge + * @description The status of auto merging a pull request. + */ + "auto-merge": { + enabled_by: components["schemas"]["simple-user"]; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + /** @description Title for the merge commit message. */ + commit_title: string; + /** @description Commit message for the merge commit. */ + commit_message: string; + } | null; + /** + * Pull Request Simple + * @description Pull Request Simple + */ + "pull-request-simple": { /** * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + */ + url: string; + /** + * Format: int64 + * @example 1 */ - readonly owner_url: string; + id: number; + /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + node_id: string; /** * Format: uri - * @example https://api.github.com/projects/1002604 + * @example https://github.com/octocat/Hello-World/pull/1347 */ - readonly url: string; + html_url: string; /** * Format: uri - * @example https://github.com/api-playground/projects-test/projects/12 + * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - readonly html_url: string; + diff_url: string; /** * Format: uri - * @example https://api.github.com/projects/1002604/columns + * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - readonly columns_url: string; - /** @example 1002604 */ - readonly id: number; - /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - readonly node_id: string; + patch_url: string; /** - * @description Name of the project - * @example Week One Sprint + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly name: string; + issue_url: string; /** - * @description Body of the project - * @example This project represents the sprint of the first week in January + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - readonly body: string | null; - /** @example 1 */ - readonly number: number; + commits_url: string; /** - * @description State of the project; either 'open' or 'closed' - * @example open + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + */ + review_comments_url: string; + /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ + review_comment_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - readonly state: string; - readonly creator: components["schemas"]["nullable-simple-user"]; + comments_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + statuses_url: string; + /** @example 1347 */ + number: number; + /** @example open */ + state: string; + /** @example true */ + locked: boolean; + /** @example new-feature */ + title: string; + user: components["schemas"]["nullable-simple-user"]; + /** @example Please pull these awesome changes */ + body: string | null; + labels: { + /** Format: int64 */ + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: components["schemas"]["nullable-milestone"]; + /** @example too heated */ + active_lock_reason?: string | null; /** * Format: date-time - * @example 2011-04-10T20:09:31Z + * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time - * @example 2014-03-03T18:58:10Z + * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + merged_at: string | null; + /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ + draft?: boolean; + }; + /** + * Draft Issue + * @description A draft issue in a project + */ + "projects-v2-draft-issue": { + /** @description The ID of the draft issue */ + id: number; + /** @description The node ID of the draft issue */ + node_id: string; + /** @description The title of the draft issue */ + title: string; + /** @description The body content of the draft issue */ + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time the draft issue was created + */ + created_at: string; + /** + * Format: date-time + * @description The time the draft issue was last updated + */ + updated_at: string; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-simple": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The content represented by the item. */ + content?: components["schemas"]["issue"] | components["schemas"]["pull-request-simple"] | components["schemas"]["projects-v2-draft-issue"]; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The URL of the project this item belongs to. + */ + project_url?: string; + /** + * Format: uri + * @description The URL of the item in the project. + */ + item_url?: string; + }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-options": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option, in raw text and HTML formats. */ + name: { + raw: string; + html: string; + }; + /** @description The description of the option, in raw text and HTML formats. */ + description: { + raw: string; + html: string; + }; + /** @description The color associated with the option. */ + color: string; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-settings": { + /** @description The unique identifier of the iteration setting. */ + id: string; /** - * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. + * Format: date + * @description The start date of the iteration. + */ + start_date: string; + /** @description The duration of the iteration in days. */ + duration: number; + /** @description The iteration title, in raw text and HTML formats. */ + title: { + raw: string; + html: string; + }; + /** @description Whether the iteration has been completed. */ + completed: boolean; + }; + /** + * Projects v2 Field + * @description A field inside a projects v2 project + */ + "projects-v2-field": { + /** @description The unique identifier of the field. */ + id: number; + /** @description The node ID of the field. */ + node_id?: string; + /** + * @description The API URL of the project that contains the field. + * @example https://api.github.com/projects/1 + */ + project_url: string; + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. * @enum {string} */ - readonly organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - readonly private?: boolean; + data_type: "assignees" | "linked_pull_requests" | "reviewers" | "labels" | "milestone" | "repository" | "title" | "text" | "single_select" | "number" | "date" | "iteration" | "issue_type" | "parent_issue" | "sub_issues_progress"; + /** @description The options available for single select fields. */ + options?: components["schemas"]["projects-v2-single-select-options"][]; + /** @description Configuration for iteration fields. */ + configuration?: { + /** @description The day of the week when the iteration starts. */ + start_day?: number; + /** @description The duration of the iteration in days. */ + duration?: number; + iterations?: components["schemas"]["projects-v2-iteration-settings"][]; + }; + /** + * Format: date-time + * @description The time when the field was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the field was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + }; + "projects-v2-field-single-select-option": { + /** @description The display name of the option. */ + name?: string; + /** + * @description The color associated with the option. + * @enum {string} + */ + color?: "BLUE" | "GRAY" | "GREEN" | "ORANGE" | "PINK" | "PURPLE" | "RED" | "YELLOW"; + /** @description The description of the option. */ + description?: string; + }; + /** @description The configuration for iteration fields. */ + "projects-v2-field-iteration-configuration": { + /** + * Format: date + * @description The start date of the first iteration. + */ + start_date?: string; + /** @description The default duration for iterations in days. Individual iterations can override this value. */ + duration?: number; + /** @description Zero or more iterations for the field. */ + iterations?: { + /** @description The title of the iteration. */ + title?: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date?: string; + /** @description The duration of the iteration in days. */ + duration?: number; + }[]; + }; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-with-content": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** + * Format: uri + * @description The API URL of the project that contains this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/3 + */ + project_url?: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + /** @description The content of the item, which varies by content type. */ + content?: { + [key: string]: unknown; + } | null; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The API URL of this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/items/3 + */ + item_url?: string | null; + /** @description The fields and values associated with this item. */ + fields?: { + [key: string]: unknown; + }[]; + }; + /** + * Projects v2 View + * @description A view inside a projects v2 project + */ + "projects-v2-view": { + /** @description The unique identifier of the view. */ + id: number; + /** @description The number of the view within the project. */ + number: number; + /** @description The name of the view. */ + name: string; + /** + * @description The layout of the view. + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** @description The node ID of the view. */ + node_id: string; + /** + * @description The API URL of the project that contains the view. + * @example https://api.github.com/orgs/octocat/projectsV2/1 + */ + project_url: string; + /** + * Format: uri + * @description The web URL of the view. + * @example https://github.com/orgs/octocat/projects/1/views/1 + */ + html_url: string; + creator: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the view was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the view was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The filter query for the view. + * @example is:issue is:open + */ + filter?: string | null; + /** @description The list of field IDs that are visible in the view. */ + visible_fields: number[]; + /** @description The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". */ + sort_by: (number | string)[][]; + /** @description The list of field IDs used for horizontal grouping. */ + group_by: number[]; + /** @description The list of field IDs used for vertical grouping (board layout). */ + vertical_group_by: number[]; }; /** * Organization Custom Property * @description Custom property defined on an organization */ - readonly "custom-property": { + "custom-property": { /** @description The name of the property */ - readonly property_name: string; + property_name: string; /** * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ - readonly url?: string; + url?: string; /** * @description The source type of the property * @example organization * @enum {string} */ - readonly source_type?: "organization" | "enterprise"; + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select * @enum {string} */ - readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ - readonly required?: boolean; + required?: boolean; /** @description Default value of the property */ - readonly default_value?: (string | readonly string[]) | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ - readonly description?: string | null; + description?: string | null; /** * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ - readonly allowed_values?: readonly string[] | null; + allowed_values?: string[] | null; /** * @description Who can edit the values of the property * @example org_actors * @enum {string|null} */ - readonly values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Set Payload * @description Custom property set payload */ - readonly "custom-property-set-payload": { + "custom-property-set-payload": { /** * @description The type of the value for the property * @example single_select * @enum {string} */ - readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ - readonly required?: boolean; + required?: boolean; /** @description Default value of the property */ - readonly default_value?: (string | readonly string[]) | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ - readonly description?: string | null; + description?: string | null; /** * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ - readonly allowed_values?: readonly string[] | null; + allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Value * @description Custom property name and associated value */ - readonly "custom-property-value": { + "custom-property-value": { /** @description The name of the property */ - readonly property_name: string; + property_name: string; /** @description The value assigned to the property */ - readonly value: (string | readonly string[]) | null; + value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values * @description List of custom property values for a repository */ - readonly "org-repo-custom-property-values": { + "org-repo-custom-property-values": { /** @example 1296269 */ - readonly repository_id: number; + repository_id: number; /** @example Hello-World */ - readonly repository_name: string; + repository_name: string; /** @example octocat/Hello-World */ - readonly repository_full_name: string; + repository_full_name: string; /** @description List of custom property names and associated values */ - readonly properties: readonly components["schemas"]["custom-property-value"][]; + properties: components["schemas"]["custom-property-value"][]; }; /** * Repository * @description A repository on GitHub. */ - readonly "nullable-repository": { + "nullable-repository": { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -25366,7 +28294,7 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -25375,7 +28303,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -25383,7 +28311,7 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -25392,229 +28320,234 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; } | null; /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - readonly "code-of-conduct-simple": { + "code-of-conduct-simple": { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly url: string; + url: string; /** @example citizen_code_of_conduct */ - readonly key: string; + key: string; /** @example Citizen Code of Conduct */ - readonly name: string; + name: string; /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly html_url: string | null; + html_url: string | null; }; /** * Full Repository * @description Full Repository */ - readonly "full-repository": { + "full-repository": { /** * Format: int64 * @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @example Hello-World */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** @example true */ - readonly is_template?: boolean; + is_template?: boolean; /** * @example [ * "octocat", @@ -25623,64 +28556,72 @@ export type components = { * "API" * ] */ - readonly topics?: readonly string[]; + topics?: string[]; /** @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** @example true */ - readonly has_downloads?: boolean; + has_downloads?: boolean; /** @example true */ - readonly has_discussions: boolean; - readonly archived: boolean; + has_discussions: boolean; + /** @example true */ + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @example public */ - readonly visibility?: string; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string; + pushed_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; + updated_at: string; + permissions?: { + admin: boolean; + maintain?: boolean; + push: boolean; + triage?: boolean; + pull: boolean; }; /** @example true */ - readonly allow_rebase_merge?: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string | null; + allow_rebase_merge?: boolean; + template_repository?: components["schemas"]["nullable-repository"]; + temp_clone_token?: string | null; /** @example true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** @example false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** @example false */ - readonly delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean; /** @example true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** @example true */ - readonly allow_update_branch?: boolean; + allow_update_branch?: boolean; /** @example false */ - readonly use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -25689,7 +28630,7 @@ export type components = { * @example PR_TITLE * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -25699,7 +28640,7 @@ export type components = { * @example PR_BODY * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -25708,7 +28649,7 @@ export type components = { * @example PR_TITLE * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -25718,120 +28659,120 @@ export type components = { * @example PR_BODY * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** @example true */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** @example 42 */ - readonly subscribers_count: number; + subscribers_count: number; /** @example 0 */ - readonly network_count: number; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly parent?: components["schemas"]["repository"]; - readonly source?: components["schemas"]["repository"]; - readonly forks: number; - readonly master_branch?: string; - readonly open_issues: number; - readonly watchers: number; + network_count: number; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + parent?: components["schemas"]["repository"]; + source?: components["schemas"]["repository"]; + forks: number; + master_branch?: string; + open_issues: number; + watchers: number; /** * @description Whether anonymous git access is allowed. * @default true */ - readonly anonymous_access_enabled: boolean; - readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + anonymous_access_enabled: boolean; + code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + security_and_analysis?: components["schemas"]["security-and-analysis"]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; }; /** * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). * @enum {string} */ - readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + "repository-rule-enforcement": "disabled" | "active" | "evaluate"; /** * Repository Ruleset Bypass Actor * @description An actor that can bypass rules in a ruleset */ - readonly "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ - readonly actor_id?: number | null; + "repository-ruleset-bypass-actor": { + /** @description The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. * @enum {string} */ - readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; + 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. Also, `pull_request` is only applicable to branch rulesets. + * @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. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. * @default always * @enum {string} */ - readonly bypass_mode: "always" | "pull_request"; + bypass_mode: "always" | "pull_request" | "exempt"; }; /** * Repository ruleset conditions for ref names * @description Parameters for a repository ruleset ref name condition */ - readonly "repository-ruleset-conditions": { - readonly ref_name?: { + "repository-ruleset-conditions": { + ref_name?: { /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - readonly include?: readonly string[]; + include?: string[]; /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: readonly string[]; + exclude?: string[]; }; }; /** * Repository ruleset conditions for repository names * @description Parameters for a repository name condition */ - readonly "repository-ruleset-conditions-repository-name-target": { - readonly repository_name: { + "repository-ruleset-conditions-repository-name-target": { + repository_name: { /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - readonly include?: readonly string[]; + include?: string[]; /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: readonly string[]; + exclude?: string[]; /** @description Whether renaming of target repositories is prevented. */ - readonly protected?: boolean; + protected?: boolean; }; }; /** * Repository ruleset conditions for repository IDs * @description Parameters for a repository ID condition */ - readonly "repository-ruleset-conditions-repository-id-target": { - readonly repository_id: { + "repository-ruleset-conditions-repository-id-target": { + repository_id: { /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - readonly repository_ids?: readonly number[]; + repository_ids?: number[]; }; }; /** * Repository ruleset property targeting definition * @description Parameters for a targeting a repository property */ - readonly "repository-ruleset-conditions-repository-property-spec": { + "repository-ruleset-conditions-repository-property-spec": { /** @description The name of the repository property to target */ - readonly name: string; + name: string; /** @description The values to match for the repository property */ - readonly property_values: readonly string[]; + property_values: string[]; /** * @description The source of the repository property. Defaults to 'custom' if not specified. * @enum {string} */ - readonly source?: "custom" | "system"; + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties * @description Parameters for a repository property condition */ - readonly "repository-ruleset-conditions-repository-property-target": { - readonly repository_property: { + "repository-ruleset-conditions-repository-property-target": { + repository_property: { /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ - readonly include?: readonly components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ - readonly exclude?: readonly components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; }; }; /** @@ -25841,545 +28782,966 @@ export type components = { * The push rulesets conditions object does not require the `ref_name` property. * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_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"]); + "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"]); /** * creation * @description Only allow users with bypass permission to create matching refs. */ - readonly "repository-rule-creation": { + "repository-rule-creation": { /** @enum {string} */ - readonly type: "creation"; + type: "creation"; }; /** * update * @description Only allow users with bypass permission to update matching refs. */ - readonly "repository-rule-update": { + "repository-rule-update": { /** @enum {string} */ - readonly type: "update"; - readonly parameters?: { + type: "update"; + parameters?: { /** @description Branch can pull changes from its upstream repository */ - readonly update_allows_fetch_and_merge: boolean; + update_allows_fetch_and_merge: boolean; }; }; /** * deletion * @description Only allow users with bypass permissions to delete matching refs. */ - readonly "repository-rule-deletion": { + "repository-rule-deletion": { /** @enum {string} */ - readonly type: "deletion"; + type: "deletion"; }; /** * required_linear_history * @description Prevent merge commits from being pushed to matching refs. */ - readonly "repository-rule-required-linear-history": { + "repository-rule-required-linear-history": { /** @enum {string} */ - readonly type: "required_linear_history"; + type: "required_linear_history"; }; /** * merge_queue * @description Merges must be performed via a merge queue. */ - readonly "repository-rule-merge-queue": { + "repository-rule-merge-queue": { /** @enum {string} */ - readonly type: "merge_queue"; - readonly parameters?: { + type: "merge_queue"; + parameters?: { /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ - readonly check_response_timeout_minutes: number; + check_response_timeout_minutes: number; /** * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. * @enum {string} */ - readonly grouping_strategy: "ALLGREEN" | "HEADGREEN"; + grouping_strategy: "ALLGREEN" | "HEADGREEN"; /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ - readonly max_entries_to_build: number; + max_entries_to_build: number; /** @description The maximum number of PRs that will be merged together in a group. */ - readonly max_entries_to_merge: number; + max_entries_to_merge: number; /** * @description Method to use when merging changes from queued pull requests. * @enum {string} */ - readonly merge_method: "MERGE" | "SQUASH" | "REBASE"; + merge_method: "MERGE" | "SQUASH" | "REBASE"; /** @description The minimum number of PRs that will be merged together in a group. */ - readonly min_entries_to_merge: number; + min_entries_to_merge: number; /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ - readonly min_entries_to_merge_wait_minutes: number; + min_entries_to_merge_wait_minutes: number; }; }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. */ - readonly "repository-rule-required-deployments": { + "repository-rule-required-deployments": { /** @enum {string} */ - readonly type: "required_deployments"; - readonly parameters?: { + type: "required_deployments"; + parameters?: { /** @description The environments that must be successfully deployed to before branches can be merged. */ - readonly required_deployment_environments: readonly string[]; + required_deployment_environments: string[]; }; }; /** * required_signatures * @description Commits pushed to matching refs must have verified signatures. */ - readonly "repository-rule-required-signatures": { + "repository-rule-required-signatures": { /** @enum {string} */ - readonly type: "required_signatures"; + type: "required_signatures"; + }; + /** + * Reviewer + * @description A required reviewing team + */ + "repository-rule-params-reviewer": { + /** @description ID of the reviewer which must review changes to matching files. */ + id: number; + /** + * @description The type of the reviewer + * @enum {string} + */ + type: "Team"; }; /** * 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[]; + "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 fnmatch syntax. */ + 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. */ - readonly minimum_approvals: number; - /** @description Node ID of the team which must review changes to matching files. */ - readonly reviewer_id: string; + minimum_approvals: number; + reviewer: components["schemas"]["repository-rule-params-reviewer"]; }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. */ - readonly "repository-rule-pull-request": { + "repository-rule-pull-request": { /** @enum {string} */ - readonly type: "pull_request"; - readonly parameters?: { - /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ - readonly allowed_merge_methods?: readonly string[]; + type: "pull_request"; + parameters?: { + /** @description Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. */ + allowed_merge_methods?: ("merge" | "squash" | "rebase")[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ - readonly dismiss_stale_reviews_on_push: boolean; + dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ - readonly require_code_owner_review: boolean; + require_code_owner_review: boolean; /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ - readonly require_last_push_approval: boolean; + require_last_push_approval: boolean; /** @description The number of approving reviews that are required before a pull request can be merged. */ - readonly required_approving_review_count: number; + required_approving_review_count: number; /** @description All conversations on code must be resolved before a pull request can be merged. */ - readonly required_review_thread_resolution: boolean; + required_review_thread_resolution: boolean; + /** + * @description > [!NOTE] + * > `required_reviewers` is in beta and subject to change. + * + * A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + */ + required_reviewers?: components["schemas"]["repository-rule-params-required-reviewer-configuration"][]; }; }; /** * StatusCheckConfiguration * @description Required status check */ - readonly "repository-rule-params-status-check-configuration": { + "repository-rule-params-status-check-configuration": { /** @description The status check context name that must be present on the commit. */ - readonly context: string; + context: string; /** @description The optional integration ID that this status check must originate from. */ - readonly integration_id?: number; + integration_id?: number; }; /** * required_status_checks * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. */ - readonly "repository-rule-required-status-checks": { + "repository-rule-required-status-checks": { /** @enum {string} */ - readonly type: "required_status_checks"; - readonly parameters?: { + type: "required_status_checks"; + parameters?: { /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ - readonly do_not_enforce_on_create?: boolean; + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ - readonly required_status_checks: readonly components["schemas"]["repository-rule-params-status-check-configuration"][]; + required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ - readonly strict_required_status_checks_policy: boolean; + strict_required_status_checks_policy: boolean; }; }; /** * non_fast_forward * @description Prevent users with push access from force pushing to refs. */ - readonly "repository-rule-non-fast-forward": { + "repository-rule-non-fast-forward": { /** @enum {string} */ - readonly type: "non_fast_forward"; + type: "non_fast_forward"; }; /** * commit_message_pattern * @description Parameters to be used for the commit_message_pattern rule */ - readonly "repository-rule-commit-message-pattern": { + "repository-rule-commit-message-pattern": { /** @enum {string} */ - readonly type: "commit_message_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "commit_message_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * commit_author_email_pattern * @description Parameters to be used for the commit_author_email_pattern rule */ - readonly "repository-rule-commit-author-email-pattern": { + "repository-rule-commit-author-email-pattern": { /** @enum {string} */ - readonly type: "commit_author_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "commit_author_email_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * committer_email_pattern * @description Parameters to be used for the committer_email_pattern rule */ - readonly "repository-rule-committer-email-pattern": { + "repository-rule-committer-email-pattern": { /** @enum {string} */ - readonly type: "committer_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "committer_email_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * branch_name_pattern * @description Parameters to be used for the branch_name_pattern rule */ - readonly "repository-rule-branch-name-pattern": { + "repository-rule-branch-name-pattern": { /** @enum {string} */ - readonly type: "branch_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "branch_name_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * tag_name_pattern * @description Parameters to be used for the tag_name_pattern rule */ - readonly "repository-rule-tag-name-pattern": { + "repository-rule-tag-name-pattern": { /** @enum {string} */ - readonly type: "tag_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "tag_name_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; + }; + }; + /** + * file_path_restriction + * @description Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + */ + "repository-rule-file-path-restriction": { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + }; + /** + * max_file_path_length + * @description Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + */ + "repository-rule-max-file-path-length": { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths. */ + max_file_path_length: number; + }; + }; + /** + * file_extension_restriction + * @description Prevent commits that include files with specified file extensions from being pushed to the commit graph. + */ + "repository-rule-file-extension-restriction": { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + }; + /** + * max_file_size + * @description Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + */ + "repository-rule-max-file-size": { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; }; }; /** * RestrictedCommits * @description Restricted commit */ - readonly "repository-rule-params-restricted-commits": { + "repository-rule-params-restricted-commits": { /** @description Full or abbreviated commit hash to reject */ - readonly oid: string; + oid: string; /** @description Reason for restriction */ - readonly reason?: string; + reason?: string; }; /** * WorkflowFileReference * @description A workflow that must run for this rule to pass */ - readonly "repository-rule-params-workflow-file-reference": { + "repository-rule-params-workflow-file-reference": { /** @description The path to the workflow file */ - readonly path: string; + path: string; /** @description The ref (branch or tag) of the workflow file to use */ - readonly ref?: string; + ref?: string; /** @description The ID of the repository where the workflow is defined */ - readonly repository_id: number; + repository_id: number; /** @description The commit SHA of the workflow file to use */ - readonly sha?: string; + sha?: string; }; /** * workflows * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. */ - readonly "repository-rule-workflows": { + "repository-rule-workflows": { /** @enum {string} */ - readonly type: "workflows"; - readonly parameters?: { + type: "workflows"; + parameters?: { /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ - readonly do_not_enforce_on_create?: boolean; + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ - readonly workflows: readonly components["schemas"]["repository-rule-params-workflow-file-reference"][]; + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; /** * CodeScanningTool * @description A tool that must provide code scanning results for this rule to pass. */ - readonly "repository-rule-params-code-scanning-tool": { + "repository-rule-params-code-scanning-tool": { /** * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." * @enum {string} */ - readonly alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." * @enum {string} */ - readonly security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; + security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; /** @description The name of a code scanning tool */ - readonly tool: string; + tool: string; }; /** * code_scanning * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. */ - readonly "repository-rule-code-scanning": { + "repository-rule-code-scanning": { /** @enum {string} */ - readonly type: "code_scanning"; - readonly parameters?: { + type: "code_scanning"; + parameters?: { /** @description Tools that must provide code scanning results for this rule to pass. */ - readonly code_scanning_tools: readonly components["schemas"]["repository-rule-params-code-scanning-tool"][]; + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; }; }; /** - * Repository Rule - * @description A repository rule. + * copilot_code_review + * @description Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. */ - readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { - /** @enum {string} */ - readonly type: "file_path_restriction"; - readonly parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - readonly restricted_file_paths: readonly string[]; - }; - } | { - /** @enum {string} */ - readonly type: "max_file_path_length"; - readonly parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - readonly max_file_path_length: number; - }; - } | { - /** @enum {string} */ - readonly type: "file_extension_restriction"; - readonly parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - readonly restricted_file_extensions: readonly string[]; - }; - } | { + "repository-rule-copilot-code-review": { /** @enum {string} */ - readonly type: "max_file_size"; - readonly parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - readonly max_file_size: number; + type: "copilot_code_review"; + parameters?: { + /** @description Copilot automatically reviews draft pull requests before they are marked as ready for review. */ + review_draft_pull_requests?: boolean; + /** @description Copilot automatically reviews each new push to the pull request. */ + review_on_push?: boolean; }; - } | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"]; + }; + /** + * CopilotCodeReviewAnalysisTool + * @description A tool that must provide code review results for this rule to pass. + */ + "repository-rule-params-copilot-code-review-analysis-tool": { + /** + * @description The name of a code review analysis tool + * @enum {string} + */ + name: "CodeQL" | "ESLint" | "PMD"; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. */ - readonly "repository-ruleset": { + "repository-ruleset": { /** @description The ID of the ruleset */ - readonly id: number; + id: number; /** @description The name of the ruleset */ - readonly name: string; + name: string; /** * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push" | "repository"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - readonly source_type?: "Repository" | "Organization" | "Enterprise"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ - readonly source: string; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + source: string; + enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** * @description The bypass type of the user making the API request for this ruleset. This field is only returned when * querying the repository-level endpoint. * @enum {string} */ - readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never"; - readonly node_id?: string; - readonly _links?: { - readonly self?: { + current_user_can_bypass?: "always" | "pull_requests_only" | "never" | "exempt"; + node_id?: string; + _links?: { + self?: { /** @description The URL of the ruleset */ - readonly href?: string; + href?: string; }; - readonly html?: { + html?: { /** @description The html URL of the ruleset */ - readonly href?: string; + href?: string; } | null; }; - readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; - readonly rules?: readonly components["schemas"]["repository-rule"][]; + conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; + rules?: components["schemas"]["repository-rule"][]; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; }; + /** + * Repository Rule + * @description A repository rule. + */ + "org-rules": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Rule Suites * @description Response */ - readonly "rule-suites": readonly { + "rule-suites": { /** @description The unique identifier of the rule insight. */ - readonly id?: number; + id?: number; /** @description The number that identifies the user. */ - readonly actor_id?: number; + actor_id?: number; /** @description The handle for the GitHub user account. */ - readonly actor_name?: string; + actor_name?: string; /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; + before_sha?: string; /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; + after_sha?: string; /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; + ref?: string; /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; + repository_id?: number; /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + repository_name?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string; + pushed_at?: string; /** * @description The result of the rule evaluations for rules with the `active` enforcement status. * @enum {string} */ - readonly result?: "pass" | "fail" | "bypass"; + result?: "pass" | "fail" | "bypass"; /** * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - readonly evaluation_result?: "pass" | "fail" | "bypass"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; + /** + * Pull request rule suite metadata + * @description Metadata for a pull request rule evaluation result. + */ + "rule-suite-pull-request": { + /** @description The pull request associated with the rule evaluation. */ + pull_request?: { + /** @description The unique identifier of the pull request. */ + id?: number; + /** @description The number of the pull request. */ + number?: number; + /** @description The user who created the pull request. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The reviews associated with the pull request. */ + reviews?: { + /** @description The unique identifier of the review. */ + id?: number; + /** @description The user who submitted the review. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The state of the review. */ + state?: string; + }[]; + }; + }; /** * Rule Suite * @description Response */ - readonly "rule-suite": { + "rule-suite": { /** @description The unique identifier of the rule insight. */ - readonly id?: number; + id?: number; /** @description The number that identifies the user. */ - readonly actor_id?: number | null; + actor_id?: number | null; /** @description The handle for the GitHub user account. */ - readonly actor_name?: string | null; - /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; + actor_name?: string | null; + /** @description The previous commit SHA of the ref. */ + before_sha?: string; + /** @description The new commit SHA of the ref. */ + after_sha?: string; /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; + ref?: string; /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; + repository_id?: number; /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + repository_name?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string; + pushed_at?: string; /** * @description The result of the rule evaluations for rules with the `active` enforcement status. * @enum {string} */ - readonly result?: "pass" | "fail" | "bypass"; + result?: "pass" | "fail" | "bypass"; /** * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ - readonly evaluation_result?: "pass" | "fail" | "bypass" | null; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ - readonly rule_evaluations?: readonly { - readonly rule_source?: { + rule_evaluations?: { + rule_source?: { /** @description The type of rule source. */ - readonly type?: string; + type?: string; /** @description The ID of the rule source. */ - readonly id?: number | null; + id?: number | null; /** @description The name of the rule source. */ - readonly name?: string | null; + name?: string | null; }; /** * @description The enforcement level of this rule source. * @enum {string} */ - readonly enforcement?: "active" | "evaluate" | "deleted ruleset"; + enforcement?: "active" | "evaluate" | "deleted ruleset"; /** * @description The result of the evaluation of the individual rule. * @enum {string} */ - readonly result?: "pass" | "fail"; + result?: "pass" | "fail"; /** @description The type of rule. */ - readonly rule_type?: string; + rule_type?: string; /** @description The detailed failure message for the rule. Null if the rule passed. */ - readonly details?: string | null; + details?: string | null; }[]; }; + /** + * Ruleset version + * @description The historical version of a ruleset + */ + "ruleset-version": { + /** @description The ID of the previous version of the ruleset */ + version_id: number; + /** @description The actor who updated the ruleset */ + actor: { + id?: number; + type?: string; + }; + /** Format: date-time */ + updated_at: string; + }; + "ruleset-version-with-state": components["schemas"]["ruleset-version"] & { + /** @description The state of the ruleset version */ + state: Record; + }; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "nullable-alert-updated-at": string | null; + /** + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + * @enum {string} + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; + /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ + "secret-scanning-location-commit": { + /** + * @description The file path in the repository + * @example /example/secrets.txt + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** @description The API URL to get the associated blob resource */ + blob_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + commit_sha: string; + /** @description The API URL to get the associated commit resource */ + commit_url: string; + }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; + /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ + "secret-scanning-location-issue-title": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_title_url: string; + }; + /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ + "secret-scanning-location-issue-body": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_body_url: string; + }; + /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ + "secret-scanning-location-issue-comment": { + /** + * Format: uri + * @description The API URL to get the issue comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + issue_comment_url: string; + }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; + /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */ + "nullable-secret-scanning-first-detected-location": (components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]) | null; + "organization-secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; + /** @description The secret that was detected. */ + secret?: string; + repository?: components["schemas"]["simple-repository"]; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description The comment that was optionally added when this alert was closed */ + resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @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; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */ + "secret-scanning-row-version": string | null; + "secret-scanning-pattern-override": { + /** @description The ID of the pattern. */ + token_type?: string; + /** @description The version of this pattern if it's a custom pattern. */ + custom_pattern_version?: string | null; + /** @description The slug of the pattern. */ + slug?: string; + /** @description The user-friendly name for the pattern. */ + display_name?: string; + /** @description The total number of alerts generated by this pattern. */ + alert_total?: number; + /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */ + alert_total_percentage?: number; + /** @description The number of false positive alerts generated by this pattern. */ + false_positives?: number; + /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */ + false_positive_rate?: number; + /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */ + bypass_rate?: number; + /** + * @description The default push protection setting for this pattern. + * @enum {string} + */ + default_setting?: "disabled" | "enabled"; + /** + * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + * @enum {string|null} + */ + enterprise_setting?: "not-set" | "disabled" | "enabled" | null; + /** + * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + * @enum {string} + */ + setting?: "not-set" | "disabled" | "enabled"; + }; + /** + * Secret scanning pattern configuration + * @description A collection of secret scanning patterns and their settings related to push protection. + */ + "secret-scanning-pattern-configuration": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Overrides for partner patterns. */ + provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + /** @description Overrides for custom patterns defined by the organization. */ + custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly "repository-advisory-vulnerability": { + "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name: string | null; + name: string | null; } | null; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; + vulnerable_version_range: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions: string | null; + patched_versions: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions: readonly string[] | null; + vulnerable_functions: string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ - readonly "repository-advisory-credit": { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; + "repository-advisory-credit": { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; /** * @description The state of the user's acceptance of the credit. * @enum {string} */ - readonly state: "accepted" | "declined" | "pending"; + state: "accepted" | "declined" | "pending"; }; /** @description A repository security advisory. */ - readonly "repository-advisory": { + "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; + cve_id: string | null; /** * Format: uri * @description The API URL for the advisory. @@ -26391,32 +29753,32 @@ export type components = { */ readonly html_url: string; /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; + description: string | null; /** * @description The severity of the advisory. * @enum {string|null} */ - readonly severity: "critical" | "high" | "medium" | "low" | null; + severity: "critical" | "high" | "medium" | "low" | null; /** @description The author of the advisory. */ readonly author: components["schemas"]["simple-user"] | null; /** @description The publisher of the advisory. */ readonly publisher: components["schemas"]["simple-user"] | null; - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of identifier. * @enum {string} */ - readonly type: "CVE" | "GHSA"; + type: "CVE" | "GHSA"; /** @description The identifier value. */ - readonly value: string; + value: string; }[]; /** * @description The state of the advisory. * @enum {string} */ - readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** * Format: date-time * @description The date and time of when the advisory was created, in ISO 8601 format. @@ -26446,1182 +29808,909 @@ export type components = { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; - readonly vulnerabilities: readonly components["schemas"]["repository-advisory-vulnerability"][] | null; - readonly cvss: { + vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + cvss: { /** @description The CVSS vector. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS score. */ readonly score: number | null; } | null; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly cwes: readonly { + cvss_severities?: components["schemas"]["cvss-severities"]; + readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; + cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; /** @description A list of only the CWE IDs. */ - readonly cwe_ids: readonly string[] | null; - readonly credits: readonly { + cwe_ids: string[] | null; + credits: { /** @description The username of the user credited. */ - readonly login?: string; - readonly type?: components["schemas"]["security-advisory-credit-types"]; + login?: string; + type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; - readonly credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; + readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; /** @description A list of users that collaborate on the advisory. */ - readonly collaborating_users: readonly components["schemas"]["simple-user"][] | null; + collaborating_users: components["schemas"]["simple-user"][] | null; /** @description A list of teams that collaborate on the advisory. */ - readonly collaborating_teams: readonly components["schemas"]["team"][] | null; + collaborating_teams: components["schemas"]["team"][] | null; /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; - readonly "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - readonly total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - readonly total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - readonly included_minutes: number; - readonly minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - readonly UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - readonly MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - readonly WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - readonly ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - readonly ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - readonly ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - readonly ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - readonly ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - readonly windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - readonly windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - readonly windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - readonly windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - readonly windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - readonly macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - readonly total?: number; - }; - }; - readonly "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - readonly total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - readonly total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - readonly included_gigabytes_bandwidth: number; - }; - readonly "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - readonly days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - readonly estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - readonly estimated_storage_for_month: number; + /** + * Check immutable releases organization settings + * @description Check immutable releases settings for an organization. + */ + "immutable-releases-organization-settings": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */ + selected_repositories_url?: string; }; /** * Hosted compute network configuration * @description A hosted compute network configuration. */ - readonly "network-configuration": { + "network-configuration": { /** * @description The unique identifier of the network configuration. * @example 123ABC456DEF789 */ - readonly id: string; + id: string; /** * @description The name of the network configuration. * @example my-network-configuration */ - readonly name: string; + name: string; /** * @description The hosted compute service the network configuration supports. * @enum {string} */ - readonly compute_service?: "none" | "actions" | "codespaces"; + compute_service?: "none" | "actions" | "codespaces"; /** * @description The unique identifier of each network settings in the configuration. * @example 123ABC456DEF789 */ - readonly network_settings_ids?: readonly string[]; + network_settings_ids?: string[]; + /** + * @description The unique identifier of each failover network settings in the configuration. + * @example 123ABC456DEF789 + */ + failover_network_settings_ids?: string[]; + /** + * @description Indicates whether the failover network resource is enabled. + * @example true + */ + failover_network_enabled?: boolean; /** * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z */ - readonly created_on: string | null; + created_on: string | null; }; /** * Hosted compute network settings resource * @description A hosted compute network settings resource. */ - readonly "network-settings": { + "network-settings": { /** * @description The unique identifier of the network settings resource. * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D */ - readonly id: string; + id: string; /** * @description The identifier of the network configuration that is using this settings resource. * @example 934E208B3EE0BD60CF5F752C426BFB53562 */ - readonly network_configuration_id?: string; + network_configuration_id?: string; /** * @description The name of the network settings resource. * @example my-network-settings */ - readonly name: string; + name: string; /** * @description The subnet this network settings resource is configured for. * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet */ - readonly subnet_id: string; + subnet_id: string; /** * @description The location of the subnet this network settings resource is configured for. * @example eastus */ - readonly region: string; + region: string; }; /** * Team Organization * @description Team Organization */ - readonly "team-organization": { + "team-organization": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; /** @example github */ - readonly name?: string; + name?: string; /** @example GitHub */ - readonly company?: string; + company?: string; /** * Format: uri * @example https://github.com/blog */ - readonly blog?: string; + blog?: string; /** @example San Francisco */ - readonly location?: string; + location?: string; /** * Format: email * @example octocat@github.com */ - readonly email?: string; + email?: string; /** @example github */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** @example true */ - readonly is_verified?: boolean; + is_verified?: boolean; /** @example true */ - readonly has_organization_projects: boolean; + has_organization_projects: boolean; /** @example true */ - readonly has_repository_projects: boolean; + has_repository_projects: boolean; /** @example 2 */ - readonly public_repos: number; + public_repos: number; /** @example 1 */ - readonly public_gists: number; + public_gists: number; /** @example 20 */ - readonly followers: number; + followers: number; /** @example 0 */ - readonly following: number; + following: number; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + created_at: string; /** @example Organization */ - readonly type: string; + type: string; /** @example 100 */ - readonly total_private_repos?: number; + total_private_repos?: number; /** @example 100 */ - readonly owned_private_repos?: number; + owned_private_repos?: number; /** @example 81 */ - readonly private_gists?: number | null; + private_gists?: number | null; /** @example 10000 */ - readonly disk_usage?: number | null; + disk_usage?: number | null; /** @example 8 */ - readonly collaborators?: number | null; + collaborators?: number | null; /** * Format: email * @example org@example.com */ - readonly billing_email?: string | null; - readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; }; - readonly default_repository_permission?: string | null; + default_repository_permission?: string | null; /** @example true */ - readonly members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null; /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null; /** @example all */ - readonly members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string; /** @example true */ - readonly members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean; /** @example true */ - readonly members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean; /** @example true */ - readonly members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean; /** @example true */ - readonly members_can_create_pages?: boolean; + members_can_create_pages?: boolean; /** @example true */ - readonly members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean; /** @example true */ - readonly members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean; /** @example false */ - readonly members_can_fork_private_repositories?: boolean | null; + members_can_fork_private_repositories?: boolean | null; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly archived_at: string | null; + archived_at: string | null; }; + /** + * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com + */ + "ldap-dn": string; /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "team-full": { + "team-full": { /** * @description Unique identifier of the team * @example 42 */ - readonly id: number; + id: number; /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + html_url: string; /** * @description Name of the team * @example Developers */ - readonly name: string; + name: string; /** @example justice-league */ - readonly slug: string; + slug: string; /** @example A great team. */ - readonly description: string | null; + description: string | null; /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - readonly privacy?: "closed" | "secret"; + privacy?: "closed" | "secret"; /** * @description The notification setting the team has set * @example notifications_enabled * @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** * @description Permission that the team will have for its repositories * @example push */ - readonly permission: string; + permission: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + members_url: string; /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; - readonly parent?: components["schemas"]["nullable-team-simple"]; + repositories_url: string; + parent?: components["schemas"]["nullable-team-simple"]; /** @example 3 */ - readonly members_count: number; + members_count: number; /** @example 10 */ - readonly repos_count: number; + repos_count: number; /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - readonly updated_at: string; - readonly organization: components["schemas"]["team-organization"]; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - readonly ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - readonly "team-discussion": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - readonly body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** @example 0 */ - readonly comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - readonly comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - readonly html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - readonly node_id: string; - /** - * @description The unique sequence number of a team discussion. - * @example 42 - */ - readonly number: number; - /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true - */ - readonly pinned: boolean; - /** - * @description Whether or not this discussion should be restricted to team members and organization owners. - * @example true - */ - readonly private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - readonly team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - readonly title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly updated_at: string; + updated_at: string; + organization: components["schemas"]["team-organization"]; + ldap_dn?: components["schemas"]["ldap-dn"]; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 - */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Team Discussion Comment - * @description A reply to a discussion within a team. - */ - readonly "team-discussion-comment": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - readonly body: string; - /** @example

Do you like apples?

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @description The ownership type of the team + * @enum {string} */ - readonly discussion_url: string; + type: "enterprise" | "organization"; /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @description Unique identifier of the organization to which this team belongs + * @example 37 */ - readonly html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - readonly node_id: string; + organization_id?: number; /** - * @description The unique sequence number of a team discussion comment. + * @description Unique identifier of the enterprise to which this team belongs * @example 42 */ - readonly number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - readonly reaction: { - /** @example 1 */ - readonly id: number; - /** @example MDg6UmVhY3Rpb24x */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z - */ - readonly created_at: string; + enterprise_id?: number; }; /** * Team Membership * @description Team Membership */ - readonly "team-membership": { + "team-membership": { /** Format: uri */ - readonly url: string; + url: string; /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - readonly role: "member" | "maintainer"; + role: "member" | "maintainer"; /** * @description The state of the user's membership in the team. * @enum {string} */ - readonly state: "active" | "pending"; - }; - /** - * Team Project - * @description A team's access to a project. - */ - readonly "team-project": { - readonly owner_url: string; - readonly url: string; - readonly html_url: string; - readonly columns_url: string; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly body: string | null; - readonly number: number; - readonly state: string; - readonly creator: components["schemas"]["simple-user"]; - readonly created_at: string; - readonly updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - readonly organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - readonly private?: boolean; - readonly permissions: { - readonly read: boolean; - readonly write: boolean; - readonly admin: boolean; - }; + state: "active" | "pending"; }; /** * Team Repository * @description A team's access to a repository. */ - readonly "team-repository": { + "team-repository": { /** * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; }; /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + role_name?: string; + owner: components["schemas"]["nullable-simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - readonly allow_forking: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - }; - /** - * Project Card - * @description Project cards represent a scope of work. - */ - readonly "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - readonly url: string; - /** - * Format: int64 - * @description The project card's ID - * @example 42 - */ - readonly id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - readonly node_id: string; - /** @example Add payload for delete Project column */ - readonly note: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @example 2016-09-05T14:21:06Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:20:22Z - */ - readonly updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - readonly archived?: boolean; - readonly column_name?: string; - readonly project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - readonly content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; - }; - /** - * Project Column - * @description Project columns contain cards of work. - */ - readonly "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - readonly cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - readonly id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ - readonly name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - readonly updated_at: string; - }; - /** - * Project Collaborator Permission - * @description Project Collaborator Permission - */ - readonly "project-collaborator-permission": { - readonly permission: string; - readonly user: components["schemas"]["nullable-simple-user"]; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; }; /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly used: number; + "rate-limit": { + limit: number; + remaining: number; + reset: number; + used: number; }; /** * Rate Limit Overview * @description Rate Limit Overview */ - readonly "rate-limit-overview": { - readonly resources: { - readonly core: components["schemas"]["rate-limit"]; - readonly graphql?: components["schemas"]["rate-limit"]; - readonly search: components["schemas"]["rate-limit"]; - readonly code_search?: components["schemas"]["rate-limit"]; - readonly source_import?: components["schemas"]["rate-limit"]; - readonly integration_manifest?: components["schemas"]["rate-limit"]; - readonly code_scanning_upload?: components["schemas"]["rate-limit"]; - readonly actions_runner_registration?: components["schemas"]["rate-limit"]; - readonly scim?: components["schemas"]["rate-limit"]; - readonly dependency_snapshots?: components["schemas"]["rate-limit"]; - readonly code_scanning_autofix?: components["schemas"]["rate-limit"]; + "rate-limit-overview": { + resources: { + core: components["schemas"]["rate-limit"]; + graphql?: components["schemas"]["rate-limit"]; + search: components["schemas"]["rate-limit"]; + code_search?: components["schemas"]["rate-limit"]; + source_import?: components["schemas"]["rate-limit"]; + integration_manifest?: components["schemas"]["rate-limit"]; + code_scanning_upload?: components["schemas"]["rate-limit"]; + actions_runner_registration?: components["schemas"]["rate-limit"]; + scim?: components["schemas"]["rate-limit"]; + dependency_snapshots?: components["schemas"]["rate-limit"]; + dependency_sbom?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; - readonly rate: components["schemas"]["rate-limit"]; + rate: components["schemas"]["rate-limit"]; }; /** * Artifact * @description An artifact */ - readonly artifact: { + artifact: { /** @example 5 */ - readonly id: number; + id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + node_id: string; /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - readonly name: string; + name: string; /** * @description The size in bytes of the artifact. * @example 12345 */ - readonly size_in_bytes: number; + size_in_bytes: number; /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - readonly url: string; + url: string; /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - readonly archive_download_url: string; + archive_download_url: string; /** @description Whether or not the artifact has expired. */ - readonly expired: boolean; + expired: boolean; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: date-time */ - readonly expires_at: string | null; + expires_at: string | null; /** Format: date-time */ - readonly updated_at: string | null; - readonly workflow_run?: { + updated_at: string | null; + /** + * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + */ + digest?: string | null; + workflow_run?: { /** @example 10 */ - readonly id?: number; + id?: number; /** @example 42 */ - readonly repository_id?: number; + repository_id?: number; /** @example 42 */ - readonly head_repository_id?: number; + head_repository_id?: number; /** @example main */ - readonly head_branch?: string; + head_branch?: string; /** @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha?: string; + head_sha?: string; } | null; }; + /** + * Actions cache retention limit for a repository + * @description GitHub Actions cache retention policy for a repository. + */ + "actions-cache-retention-limit-for-repository": { + /** + * @description The maximum number of days to keep caches in this repository. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for a repository + * @description GitHub Actions cache storage policy for a repository. + */ + "actions-cache-storage-limit-for-repository": { + /** + * @description The maximum total cache size for this repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** * Repository actions caches * @description Repository actions caches */ - readonly "actions-cache-list": { + "actions-cache-list": { /** * @description Total number of caches * @example 2 */ - readonly total_count: number; + total_count: number; /** @description Array of caches */ - readonly actions_caches: readonly { + actions_caches: { /** @example 2 */ - readonly id?: number; + id?: number; /** @example refs/heads/main */ - readonly ref?: string; + ref?: string; /** @example Linux-node-958aff96db2d75d67787d1e634ae70b659de937b */ - readonly key?: string; + key?: string; /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ - readonly version?: string; + version?: string; /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - readonly last_accessed_at?: string; + last_accessed_at?: string; /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - readonly created_at?: string; + created_at?: string; /** @example 1024 */ - readonly size_in_bytes?: number; + size_in_bytes?: number; }[]; }; /** * Job * @description Information of a job execution in a workflow run */ - readonly job: { + job: { /** * @description The id of the job. * @example 21 */ - readonly id: number; + id: number; /** * @description The id of the associated workflow run. * @example 5 */ - readonly run_id: number; + run_id: number; /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - readonly run_url: string; + run_url: string; /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - readonly run_attempt?: number; + run_attempt?: number; /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; + node_id: string; /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string | null; + html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description The outcome of the job. * @example success * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly started_at: string; + started_at: string; /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly completed_at: string | null; + completed_at: string | null; /** * @description The name of the job. * @example test-coverage */ - readonly name: string; + name: string; /** @description Steps in this job. */ - readonly steps?: readonly { + steps?: { /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** * @description The outcome of the job. * @example success */ - readonly conclusion: string | null; + conclusion: string | null; /** * @description The name of the job. * @example test-coverage */ - readonly name: string; + name: string; /** @example 1 */ - readonly number: number; + number: number; /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly started_at?: string | null; + started_at?: string | null; /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly completed_at?: string | null; + completed_at?: string | null; }[]; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly check_run_url: string; + check_run_url: string; /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ @@ -27630,96 +30719,97 @@ export type components = { * "bar" * ] */ - readonly labels: readonly string[]; + labels: string[]; /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - readonly runner_id: number | null; + runner_id: number | null; /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - readonly runner_name: string | null; + runner_name: string | null; /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - readonly runner_group_id: number | null; + runner_group_id: number | null; /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - readonly runner_group_name: string | null; + runner_group_name: string | null; /** * @description The name of the workflow. * @example Build */ - readonly workflow_name: string | null; + workflow_name: string | null; /** * @description The name of the current branch. * @example main */ - readonly head_branch: string | null; + head_branch: string | null; }; /** * Actions OIDC subject customization for a repository * @description Actions OIDC subject customization for a repository */ - readonly "oidc-custom-sub-repo": { + "oidc-custom-sub-repo": { /** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */ - readonly use_default: boolean; + use_default: boolean; /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */ - readonly include_claim_keys?: readonly string[]; + include_claim_keys?: string[]; }; /** * Actions Secret * @description Set secrets for GitHub Actions. */ - readonly "actions-secret": { + "actions-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** Actions Variable */ - readonly "actions-variable": { + "actions-variable": { /** * @description The name of the variable. * @example USERNAME */ - readonly name: string; + name: string; /** * @description The value of the variable. * @example octocat */ - readonly value: string; + value: string; /** * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly updated_at: string; + updated_at: string; }; /** @description Whether GitHub Actions is enabled on the repository. */ - readonly "actions-enabled": boolean; - readonly "actions-repository-permissions": { - readonly enabled: components["schemas"]["actions-enabled"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; + "actions-enabled": boolean; + "actions-repository-permissions": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; - readonly "actions-workflow-access-to-repository": { + "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the * repository. @@ -27727,508 +30817,501 @@ export type components = { * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ - readonly access_level: "none" | "user" | "organization"; + access_level: "none" | "user" | "organization"; }; /** * Referenced workflow * @description A workflow referenced/reused by the initial caller workflow */ - readonly "referenced-workflow": { - readonly path: string; - readonly sha: string; - readonly ref?: string; - }; - /** Pull Request Minimal */ - readonly "pull-request-minimal": { - /** Format: int64 */ - readonly id: number; - readonly number: number; - readonly url: string; - readonly head: { - readonly ref: string; - readonly sha: string; - readonly repo: { - /** Format: int64 */ - readonly id: number; - readonly url: string; - readonly name: string; - }; - }; - readonly base: { - readonly ref: string; - readonly sha: string; - readonly repo: { - /** Format: int64 */ - readonly id: number; - readonly url: string; - readonly name: string; - }; - }; + "referenced-workflow": { + path: string; + sha: string; + ref?: string; }; /** * Simple Commit * @description A commit. */ - readonly "nullable-simple-commit": { + "nullable-simple-commit": { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly id: string; + id: string; /** @description SHA for the commit's tree */ - readonly tree_id: string; + tree_id: string; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; + message: string; /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly timestamp: string; + timestamp: string; /** @description Information about the Git author */ - readonly author: { + author: { /** * @description Name of the commit's author * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; /** @description Information about the Git committer */ - readonly committer: { + committer: { /** * @description Name of the commit's committer * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; } | null; /** * Workflow Run * @description An invocation of a workflow */ - readonly "workflow-run": { + "workflow-run": { /** * @description The ID of the workflow run. * @example 5 */ - readonly id: number; + id: number; /** * @description The name of the workflow run. * @example Build */ - readonly name?: string | null; + name?: string | null; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + node_id: string; /** * @description The ID of the associated check suite. * @example 42 */ - readonly check_suite_id?: number; + check_suite_id?: number; /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - readonly check_suite_node_id?: string; + check_suite_node_id?: string; /** @example master */ - readonly head_branch: string | null; + head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** * @description The full path of the workflow * @example octocat/octo-repo/.github/workflows/ci.yml@main */ - readonly path: string; + path: string; /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - readonly run_number: number; + run_number: number; /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - readonly run_attempt?: number; - readonly referenced_workflows?: readonly components["schemas"]["referenced-workflow"][] | null; + run_attempt?: number; + referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ - readonly event: string; + event: string; /** @example completed */ - readonly status: string | null; + status: string | null; /** @example neutral */ - readonly conclusion: string | null; + conclusion: string | null; /** * @description The ID of the parent workflow. * @example 5 */ - readonly workflow_id: number; + workflow_id: number; /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/suites/4 */ - readonly html_url: string; + html_url: string; /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly actor?: components["schemas"]["simple-user"]; - readonly triggering_actor?: components["schemas"]["simple-user"]; + updated_at: string; + actor?: components["schemas"]["simple-user"]; + triggering_actor?: components["schemas"]["simple-user"]; /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - readonly run_started_at?: string; + run_started_at?: string; /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - readonly jobs_url: string; + jobs_url: string; /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - readonly logs_url: string; + logs_url: string; /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - readonly check_suite_url: string; + check_suite_url: string; /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - readonly artifacts_url: string; + artifacts_url: string; /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - readonly cancel_url: string; + cancel_url: string; /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - readonly rerun_url: string; + rerun_url: string; /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - readonly previous_attempt_url?: string | null; + previous_attempt_url?: string | null; /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - readonly workflow_url: string; - readonly head_commit: components["schemas"]["nullable-simple-commit"]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly head_repository: components["schemas"]["minimal-repository"]; + workflow_url: string; + head_commit: components["schemas"]["nullable-simple-commit"]; + repository: components["schemas"]["minimal-repository"]; + head_repository: components["schemas"]["minimal-repository"]; /** @example 5 */ - readonly head_repository_id?: number; + head_repository_id?: number; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. * @example Simple Workflow */ - readonly display_title: string; + display_title: string; }; /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - readonly "environment-approvals": { + "environment-approvals": { /** @description The list of environments that were approved or rejected */ - readonly environments: readonly { + environments: { /** * @description The id of the environment. * @example 56780428 */ - readonly id?: number; + id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id?: string; + node_id?: string; /** * @description The name of the environment. * @example staging */ - readonly name?: string; + name?: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url?: string; + url?: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url?: string; + html_url?: string; /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly created_at?: string; + created_at?: string; /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly updated_at?: string; + updated_at?: string; }[]; /** * @description Whether deployment to the environment(s) was approved or rejected or pending (with comments) * @example approved * @enum {string} */ - readonly state: "approved" | "rejected" | "pending"; - readonly user: components["schemas"]["simple-user"]; + state: "approved" | "rejected" | "pending"; + user: components["schemas"]["simple-user"]; /** * @description The comment submitted with the deployment review * @example Ship it! */ - readonly comment: string; + comment: string; }; - readonly "review-custom-gates-comment-required": { + "review-custom-gates-comment-required": { /** @description The name of the environment to approve or reject. */ - readonly environment_name: string; + environment_name: string; /** @description Comment associated with the pending deployment protection rule. **Required when state is not provided.** */ - readonly comment: string; + comment: string; }; - readonly "review-custom-gates-state-required": { + "review-custom-gates-state-required": { /** @description The name of the environment to approve or reject. */ - readonly environment_name: string; + environment_name: string; /** * @description Whether to approve or reject deployment to the specified environments. * @enum {string} */ - readonly state: "approved" | "rejected"; + state: "approved" | "rejected"; /** @description Optional comment to include with the review. */ - readonly comment?: string; + comment?: string; }; /** * @description The type of reviewer. * @example User * @enum {string} */ - readonly "deployment-reviewer-type": "User" | "Team"; + "deployment-reviewer-type": "User" | "Team"; /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - readonly "pending-deployment": { - readonly environment: { + "pending-deployment": { + environment: { /** * Format: int64 * @description The id of the environment. * @example 56780428 */ - readonly id?: number; + id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id?: string; + node_id?: string; /** * @description The name of the environment. * @example staging */ - readonly name?: string; + name?: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url?: string; + url?: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url?: string; + html_url?: string; }; /** * @description The set duration of the wait timer * @example 30 */ - readonly wait_timer: number; + wait_timer: number; /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - readonly wait_timer_started_at: string | null; + wait_timer_started_at: string | null; /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - readonly current_user_can_approve: boolean; + current_user_can_approve: boolean; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - readonly reviewers: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; - readonly reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; + reviewers: { + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; }[]; }; /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed */ - readonly deployment: { + deployment: { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - readonly url: string; + url: string; /** * Format: int64 * @description Unique identifier of the deployment * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOkRlcGxveW1lbnQx */ - readonly node_id: string; + node_id: string; /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - readonly sha: string; + sha: string; /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - readonly ref: string; + ref: string; /** * @description Parameter to specify a task to execute * @example deploy */ - readonly task: string; - readonly payload: { - readonly [key: string]: unknown; + task: string; + payload: { + [key: string]: unknown; } | string; /** @example staging */ - readonly original_environment?: string; + original_environment?: string; /** * @description Name for the target deployment environment. * @example production */ - readonly environment: string; + environment: string; /** @example Deploy request from hubot */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - readonly transient_environment?: boolean; + transient_environment?: boolean; /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - readonly production_environment?: boolean; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * Workflow Run Usage * @description Workflow Run Usage */ - readonly "workflow-run-usage": { - readonly billable: { - readonly UBUNTU?: { - readonly total_ms: number; - readonly jobs: number; - readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; + "workflow-run-usage": { + billable: { + UBUNTU?: { + total_ms: number; + jobs: number; + job_runs?: { + job_id: number; + duration_ms: number; }[]; }; - readonly MACOS?: { - readonly total_ms: number; - readonly jobs: number; - readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; + MACOS?: { + total_ms: number; + jobs: number; + job_runs?: { + job_id: number; + duration_ms: number; }[]; }; - readonly WINDOWS?: { - readonly total_ms: number; - readonly jobs: number; - readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; + WINDOWS?: { + total_ms: number; + jobs: number; + job_runs?: { + job_id: number; + duration_ms: number; }[]; }; }; - readonly run_duration_ms?: number; + run_duration_ms?: number; }; /** * Workflow * @description A GitHub Actions workflow */ - readonly workflow: { + workflow: { /** @example 5 */ - readonly id: number; + id: number; /** @example MDg6V29ya2Zsb3cxMg== */ - readonly node_id: string; + node_id: string; /** @example CI */ - readonly name: string; + name: string; /** @example ruby.yaml */ - readonly path: string; + path: string; /** * @example active * @enum {string} */ - readonly state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly updated_at: string; + updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - readonly url: string; + url: string; /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - readonly html_url: string; + html_url: string; /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - readonly badge_url: string; + badge_url: string; /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly deleted_at?: string; + deleted_at?: string; + }; + /** + * Workflow Run ID + * Format: int64 + * @description The ID of the workflow run. + */ + "workflow-run-id": number; + /** + * Workflow Dispatch Response + * @description Response containing the workflow run ID and URLs. + */ + "workflow-dispatch-response": { + workflow_run_id: components["schemas"]["workflow-run-id"]; + /** + * Format: uri + * @description The URL to the workflow run. + */ + run_url: string; + /** Format: uri */ + html_url: string; }; /** * Workflow Usage * @description Workflow Usage */ - readonly "workflow-usage": { - readonly billable: { - readonly UBUNTU?: { - readonly total_ms?: number; + "workflow-usage": { + billable: { + UBUNTU?: { + total_ms?: number; }; - readonly MACOS?: { - readonly total_ms?: number; + MACOS?: { + total_ms?: number; }; - readonly WINDOWS?: { - readonly total_ms?: number; + WINDOWS?: { + total_ms?: number; }; }; }; @@ -28236,998 +31319,1020 @@ export type components = { * Activity * @description Activity */ - readonly activity: { + activity: { /** @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The SHA of the commit before the activity. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly before: string; + before: string; /** * @description The SHA of the commit after the activity. * @example 827efc6d56897b048c772eb4087f854f46256132 */ - readonly after: string; + after: string; /** * @description The full Git reference, formatted as `refs/heads/`. * @example refs/heads/main */ - readonly ref: string; + ref: string; /** * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z */ - readonly timestamp: string; + timestamp: string; /** * @description The type of the activity that was performed. * @example force_push * @enum {string} */ - readonly activity_type: "push" | "force_push" | "branch_deletion" | "branch_creation" | "pr_merge" | "merge_queue_merge"; - readonly actor: components["schemas"]["nullable-simple-user"]; + activity_type: "push" | "force_push" | "branch_deletion" | "branch_creation" | "pr_merge" | "merge_queue_merge"; + actor: components["schemas"]["nullable-simple-user"]; }; /** * Autolink reference * @description An autolink reference. */ - readonly autolink: { + autolink: { /** @example 3 */ - readonly id: number; + id: number; /** * @description The prefix of a key that is linkified. * @example TICKET- */ - readonly key_prefix: string; + key_prefix: string; /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - readonly url_template: string; + url_template: string; /** * @description Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. * @example true */ - readonly is_alphanumeric: boolean; + is_alphanumeric: boolean; + /** Format: date-time */ + updated_at?: string | null; }; /** * Check Dependabot security updates * @description Check Dependabot security updates */ - readonly "check-automated-security-fixes": { + "check-automated-security-fixes": { /** * @description Whether Dependabot security updates are enabled for the repository. * @example true */ - readonly enabled: boolean; + enabled: boolean; /** * @description Whether Dependabot security updates are paused for the repository. * @example false */ - readonly paused: boolean; + paused: boolean; }; /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - readonly "protected-branch-required-status-check": { - readonly url?: string; - readonly enforcement_level?: string; - readonly contexts: readonly string[]; - readonly checks: readonly { - readonly context: string; - readonly app_id: number | null; + "protected-branch-required-status-check": { + url?: string; + enforcement_level?: string; + contexts: string[]; + checks: { + context: string; + app_id: number | null; }[]; - readonly contexts_url?: string; - readonly strict?: boolean; + contexts_url?: string; + strict?: boolean; }; /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - readonly "protected-branch-admin-enforced": { + "protected-branch-admin-enforced": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - readonly url: string; + url: string; /** @example true */ - readonly enabled: boolean; + enabled: boolean; }; /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - readonly "protected-branch-pull-request-review": { + "protected-branch-pull-request-review": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - readonly url?: string; - readonly dismissal_restrictions?: { + url?: string; + dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - readonly users?: readonly components["schemas"]["simple-user"][]; + users?: components["schemas"]["simple-user"][]; /** @description The list of teams with review dismissal access. */ - readonly teams?: readonly components["schemas"]["team"][]; + teams?: components["schemas"]["team"][]; /** @description The list of apps with review dismissal access. */ - readonly apps?: readonly components["schemas"]["integration"][]; + apps?: components["schemas"]["integration"][]; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - readonly url?: string; + url?: string; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - readonly users_url?: string; + users_url?: string; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - readonly teams_url?: string; + teams_url?: string; }; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - readonly bypass_pull_request_allowances?: { + bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - readonly users?: readonly components["schemas"]["simple-user"][]; + users?: components["schemas"]["simple-user"][]; /** @description The list of teams allowed to bypass pull request requirements. */ - readonly teams?: readonly components["schemas"]["team"][]; + teams?: components["schemas"]["team"][]; /** @description The list of apps allowed to bypass pull request requirements. */ - readonly apps?: readonly components["schemas"]["integration"][]; + apps?: components["schemas"]["integration"][]; }; /** @example true */ - readonly dismiss_stale_reviews: boolean; + dismiss_stale_reviews: boolean; /** @example true */ - readonly require_code_owner_reviews: boolean; + require_code_owner_reviews: boolean; /** @example 2 */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false * @example true */ - readonly require_last_push_approval: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy * @description Branch Restriction Policy */ - readonly "branch-restriction-policy": { + "branch-restriction-policy": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly users_url: string; + users_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri */ - readonly apps_url: string; - readonly users: readonly { - readonly login?: string; + apps_url: string; + users: { + login?: string; /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - readonly user_view_type?: string; - }[]; - readonly teams: readonly { - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly name?: string; - readonly slug?: string; - readonly description?: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission?: string; - readonly members_url?: string; - readonly repositories_url?: string; - readonly parent?: string | null; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + user_view_type?: string; }[]; - readonly apps: readonly { - readonly id?: number; - readonly slug?: string; - readonly node_id?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly hooks_url?: string; - readonly issues_url?: string; - readonly members_url?: string; - readonly public_members_url?: string; - readonly avatar_url?: string; - readonly description?: string; + teams: components["schemas"]["team"][]; + apps: { + id?: number; + slug?: string; + node_id?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + url?: string; + repos_url?: string; + events_url?: string; + hooks_url?: string; + issues_url?: string; + members_url?: string; + public_members_url?: string; + avatar_url?: string; + description?: string; /** @example "" */ - readonly gravatar_id?: string; + gravatar_id?: string; /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - readonly html_url?: string; + html_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - readonly followers_url?: string; + followers_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - readonly following_url?: string; + following_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - readonly gists_url?: string; + gists_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - readonly starred_url?: string; + starred_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - readonly organizations_url?: string; + organizations_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - readonly received_events_url?: string; + received_events_url?: string; /** @example "Organization" */ - readonly type?: string; + type?: string; /** @example false */ - readonly site_admin?: boolean; + site_admin?: boolean; /** @example public */ - readonly user_view_type?: string; - }; - readonly name?: string; - readonly client_id?: string; - readonly description?: string; - readonly external_url?: string; - readonly html_url?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly metadata?: string; - readonly contents?: string; - readonly issues?: string; - readonly single_file?: string; - }; - readonly events?: readonly string[]; + user_view_type?: string; + }; + name?: string; + client_id?: string; + description?: string; + external_url?: string; + html_url?: string; + created_at?: string; + updated_at?: string; + permissions?: { + metadata?: string; + contents?: string; + issues?: string; + single_file?: string; + }; + events?: string[]; }[]; }; /** * Branch Protection * @description Branch Protection */ - readonly "branch-protection": { - readonly url?: string; - readonly enabled?: boolean; - readonly required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - readonly enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - readonly required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - readonly restrictions?: components["schemas"]["branch-restriction-policy"]; - readonly required_linear_history?: { - readonly enabled?: boolean; + "branch-protection": { + url?: string; + enabled?: boolean; + required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; + enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; + required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_linear_history?: { + enabled?: boolean; }; - readonly allow_force_pushes?: { - readonly enabled?: boolean; + allow_force_pushes?: { + enabled?: boolean; }; - readonly allow_deletions?: { - readonly enabled?: boolean; + allow_deletions?: { + enabled?: boolean; }; - readonly block_creations?: { - readonly enabled?: boolean; + block_creations?: { + enabled?: boolean; }; - readonly required_conversation_resolution?: { - readonly enabled?: boolean; + required_conversation_resolution?: { + enabled?: boolean; }; /** @example "branch/with/protection" */ - readonly name?: string; + name?: string; /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - readonly protection_url?: string; - readonly required_signatures?: { + protection_url?: string; + required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - readonly url: string; + url: string; /** @example true */ - readonly enabled: boolean; + enabled: boolean; }; /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ - readonly lock_branch?: { + lock_branch?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */ - readonly allow_fork_syncing?: { + allow_fork_syncing?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; }; /** * Short Branch * @description Short Branch */ - readonly "short-branch": { - readonly name: string; - readonly commit: { - readonly sha: string; + "short-branch": { + name: string; + commit: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly protected: boolean; - readonly protection?: components["schemas"]["branch-protection"]; + protected: boolean; + protection?: components["schemas"]["branch-protection"]; /** Format: uri */ - readonly protection_url?: string; + protection_url?: string; }; /** * Git User * @description Metaproperties for Git author/committer information. */ - readonly "nullable-git-user": { + "nullable-git-user": { /** @example "Chris Wanstrath" */ - readonly name?: string; + name?: string; /** @example "chris@ozmm.org" */ - readonly email?: string; - /** @example "2007-10-29T02:42:39.000-07:00" */ - readonly date?: string; + email?: string; + /** + * Format: date-time + * @example "2007-10-29T02:42:39.000-07:00" + */ + date?: string; } | null; /** Verification */ - readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly payload: string | null; - readonly signature: string | null; - readonly verified_at?: string | null; + verification: { + verified: boolean; + reason: string; + payload: string | null; + signature: string | null; + verified_at: string | null; }; /** * Diff Entry * @description Diff Entry */ - readonly "diff-entry": { + "diff-entry": { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - readonly sha: string; + sha: string | null; /** @example file1.txt */ - readonly filename: string; + filename: string; /** * @example added * @enum {string} */ - readonly status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; /** @example 103 */ - readonly additions: number; + additions: number; /** @example 21 */ - readonly deletions: number; + deletions: number; /** @example 124 */ - readonly changes: number; + changes: number; /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - readonly blob_url: string; + blob_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - readonly raw_url: string; + raw_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly contents_url: string; + contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - readonly patch?: string; + patch?: string; /** @example file.txt */ - readonly previous_filename?: string; + previous_filename?: string; }; /** * Commit * @description Commit */ - readonly commit: { + commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly url: string; + url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly sha: string; + sha: string; /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - readonly comments_url: string; - readonly commit: { + comments_url: string; + commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly url: string; - readonly author: components["schemas"]["nullable-git-user"]; - readonly committer: components["schemas"]["nullable-git-user"]; + url: string; + author: components["schemas"]["nullable-git-user"]; + committer: components["schemas"]["nullable-git-user"]; /** @example Fix all the bugs */ - readonly message: string; + message: string; /** @example 0 */ - readonly comment_count: number; - readonly tree: { + comment_count: number; + tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - readonly sha: string; + sha: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - readonly url: string; + url: string; }; - readonly verification?: components["schemas"]["verification"]; + verification?: components["schemas"]["verification"]; }; - readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; - readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; - readonly parents: readonly { + author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly html_url?: string; + html_url?: string; }[]; - readonly stats?: { - readonly additions?: number; - readonly deletions?: number; - readonly total?: number; + stats?: { + additions?: number; + deletions?: number; + total?: number; }; - readonly files?: readonly components["schemas"]["diff-entry"][]; + files?: components["schemas"]["diff-entry"][]; }; /** * Branch With Protection * @description Branch With Protection */ - readonly "branch-with-protection": { - readonly name: string; - readonly commit: components["schemas"]["commit"]; - readonly _links: { - readonly html: string; + "branch-with-protection": { + name: string; + commit: components["schemas"]["commit"]; + _links: { + html: string; /** Format: uri */ - readonly self: string; + self: string; }; - readonly protected: boolean; - readonly protection: components["schemas"]["branch-protection"]; + protected: boolean; + protection: components["schemas"]["branch-protection"]; /** Format: uri */ - readonly protection_url: string; + protection_url: string; /** @example "mas*" */ - readonly pattern?: string; + pattern?: string; /** @example 1 */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; }; /** * Status Check Policy * @description Status Check Policy */ - readonly "status-check-policy": { + "status-check-policy": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - readonly url: string; + url: string; /** @example true */ - readonly strict: boolean; + strict: boolean; /** * @example [ * "continuous-integration/travis-ci" * ] */ - readonly contexts: readonly string[]; - readonly checks: readonly { + contexts: string[]; + checks: { /** @example continuous-integration/travis-ci */ - readonly context: string; - readonly app_id: number | null; + context: string; + app_id: number | null; }[]; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - readonly contexts_url: string; + contexts_url: string; }; /** * Protected Branch * @description Branch protections protect branches */ - readonly "protected-branch": { + "protected-branch": { /** Format: uri */ - readonly url: string; - readonly required_status_checks?: components["schemas"]["status-check-policy"]; - readonly required_pull_request_reviews?: { - /** Format: uri */ - readonly url: string; - readonly dismiss_stale_reviews?: boolean; - readonly require_code_owner_reviews?: boolean; - readonly required_approving_review_count?: number; + url: string; + required_status_checks?: components["schemas"]["status-check-policy"]; + required_pull_request_reviews?: { + /** Format: uri */ + url: string; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - readonly require_last_push_approval: boolean; - readonly dismissal_restrictions?: { + require_last_push_approval: boolean; + dismissal_restrictions?: { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly users_url: string; + users_url: string; /** Format: uri */ - readonly teams_url: string; - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - readonly apps?: readonly components["schemas"]["integration"][]; + teams_url: string; + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; + apps?: components["schemas"]["integration"][]; }; - readonly bypass_pull_request_allowances?: { - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - readonly apps?: readonly components["schemas"]["integration"][]; + bypass_pull_request_allowances?: { + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; + apps?: components["schemas"]["integration"][]; }; }; - readonly required_signatures?: { + required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - readonly url: string; + url: string; /** @example true */ - readonly enabled: boolean; + enabled: boolean; }; - readonly enforce_admins?: { + enforce_admins?: { /** Format: uri */ - readonly url: string; - readonly enabled: boolean; + url: string; + enabled: boolean; }; - readonly required_linear_history?: { - readonly enabled: boolean; + required_linear_history?: { + enabled: boolean; }; - readonly allow_force_pushes?: { - readonly enabled: boolean; + allow_force_pushes?: { + enabled: boolean; }; - readonly allow_deletions?: { - readonly enabled: boolean; + allow_deletions?: { + enabled: boolean; }; - readonly restrictions?: components["schemas"]["branch-restriction-policy"]; - readonly required_conversation_resolution?: { - readonly enabled?: boolean; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_conversation_resolution?: { + enabled?: boolean; }; - readonly block_creations?: { - readonly enabled: boolean; + block_creations?: { + enabled: boolean; }; /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ - readonly lock_branch?: { + lock_branch?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */ - readonly allow_fork_syncing?: { + allow_fork_syncing?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; }; /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - readonly "deployment-simple": { + "deployment-simple": { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - readonly url: string; + url: string; /** * @description Unique identifier of the deployment * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOkRlcGxveW1lbnQx */ - readonly node_id: string; + node_id: string; /** * @description Parameter to specify a task to execute * @example deploy */ - readonly task: string; + task: string; /** @example staging */ - readonly original_environment?: string; + original_environment?: string; /** * @description Name for the target deployment environment. * @example production */ - readonly environment: string; + environment: string; /** @example Deploy request from hubot */ - readonly description: string | null; + description: string | null; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - readonly transient_environment?: boolean; + transient_environment?: boolean; /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - readonly production_environment?: boolean; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * CheckRun * @description A check performed on the code of a given code change */ - readonly "check-run": { + "check-run": { /** * Format: int64 * @description The id of the check. * @example 21 */ - readonly id: number; + id: number; /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; + node_id: string; /** @example 42 */ - readonly external_id: string | null; + external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string | null; + html_url: string | null; /** @example https://example.com */ - readonly details_url: string | null; + details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly started_at: string | null; + started_at: string | null; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly completed_at: string | null; - readonly output: { - readonly title: string | null; - readonly summary: string | null; - readonly text: string | null; - readonly annotations_count: number; + completed_at: string | null; + output: { + title: string | null; + summary: string | null; + text: string | null; + annotations_count: number; /** Format: uri */ - readonly annotations_url: string; + annotations_url: string; }; /** * @description The name of the check. * @example test-coverage */ - readonly name: string; - readonly check_suite: { - readonly id: number; + name: string; + check_suite: { + id: number; } | null; - readonly app: components["schemas"]["nullable-integration"]; + app: components["schemas"]["nullable-integration"]; /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. */ - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; - readonly deployment?: components["schemas"]["deployment-simple"]; + pull_requests: components["schemas"]["pull-request-minimal"][]; + deployment?: components["schemas"]["deployment-simple"]; }; /** * Check Annotation * @description Check Annotation */ - readonly "check-annotation": { + "check-annotation": { /** @example README.md */ - readonly path: string; + path: string; /** @example 2 */ - readonly start_line: number; + start_line: number; /** @example 2 */ - readonly end_line: number; + end_line: number; /** @example 5 */ - readonly start_column: number | null; + start_column: number | null; /** @example 10 */ - readonly end_column: number | null; + end_column: number | null; /** @example warning */ - readonly annotation_level: string | null; + annotation_level: string | null; /** @example Spell Checker */ - readonly title: string | null; + title: string | null; /** @example Check your spelling for 'banaas'. */ - readonly message: string | null; + message: string | null; /** @example Do you mean 'bananas' or 'banana'? */ - readonly raw_details: string | null; - readonly blob_href: string; + raw_details: string | null; + blob_href: string; }; /** * Simple Commit * @description A commit. */ - readonly "simple-commit": { + "simple-commit": { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly id: string; + id: string; /** @description SHA for the commit's tree */ - readonly tree_id: string; + tree_id: string; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; + message: string; /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly timestamp: string; + timestamp: string; /** @description Information about the Git author */ - readonly author: { + author: { /** * @description Name of the commit's author * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; /** @description Information about the Git committer */ - readonly committer: { + committer: { /** * @description Name of the commit's committer * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; }; /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - readonly "check-suite": { + "check-suite": { /** * Format: int64 * @example 5 */ - readonly id: number; + id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + node_id: string; /** @example master */ - readonly head_branch: string | null; + head_branch: string | null; /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** * @example neutral * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - readonly url: string | null; + url: string | null; /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - readonly before: string | null; + before: string | null; /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - readonly after: string | null; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; - readonly app: components["schemas"]["nullable-integration"]; - readonly repository: components["schemas"]["minimal-repository"]; + after: string | null; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; + app: components["schemas"]["nullable-integration"]; + repository: components["schemas"]["minimal-repository"]; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: date-time */ - readonly updated_at: string | null; - readonly head_commit: components["schemas"]["simple-commit"]; - readonly latest_check_runs_count: number; - readonly check_runs_url: string; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + updated_at: string | null; + head_commit: components["schemas"]["simple-commit"]; + latest_check_runs_count: number; + check_runs_url: string; + rerequestable?: boolean; + runs_rerequestable?: boolean; }; /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - readonly "check-suite-preference": { - readonly preferences: { - readonly auto_trigger_checks?: readonly { - readonly app_id: number; - readonly setting: boolean; + "check-suite-preference": { + preferences: { + auto_trigger_checks?: { + app_id: number; + setting: boolean; }[]; }; - readonly repository: components["schemas"]["minimal-repository"]; - }; - readonly "code-scanning-alert-items": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; - readonly "code-scanning-alert-rule": { + repository: components["schemas"]["minimal-repository"]; + }; + "code-scanning-alert-items": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["alert-updated-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + fixed_at?: components["schemas"]["alert-fixed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + }; + "code-scanning-alert-rule": { /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; + id?: string | null; /** @description The name of the rule used to detect the alert. */ - readonly name?: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity?: "none" | "note" | "warning" | "error" | null; + severity?: "none" | "note" | "warning" | "error" | null; /** * @description The security severity of the alert. * @enum {string|null} */ - readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; + security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; + description?: string; /** @description A description of the rule used to detect the alert. */ - readonly full_description?: string; + full_description?: string; /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; + tags?: string[] | null; /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - }; - readonly "code-scanning-alert": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + help_uri?: string | null; + }; + "code-scanning-alert": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["alert-updated-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + fixed_at?: components["schemas"]["alert-fixed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + rule: components["schemas"]["code-scanning-alert-rule"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - readonly "code-scanning-alert-set-state": "open" | "dismissed"; + "code-scanning-alert-set-state": "open" | "dismissed"; + /** @description If `true`, attempt to create an alert dismissal request. */ + "code-scanning-alert-create-request": boolean; + /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */ + "code-scanning-alert-assignees": string[]; /** * @description The status of an autofix. * @enum {string} */ - readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; /** @description The description of an autofix. */ - readonly "code-scanning-autofix-description": string | null; + "code-scanning-autofix-description": string | null; /** * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-autofix-started-at": string; - readonly "code-scanning-autofix": { - readonly status: components["schemas"]["code-scanning-autofix-status"]; - readonly description: components["schemas"]["code-scanning-autofix-description"]; - readonly started_at: components["schemas"]["code-scanning-autofix-started-at"]; + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; /** @description Commit an autofix for a code scanning alert */ - readonly "code-scanning-autofix-commits": { + "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly target_ref?: string; + target_ref?: string; /** @description Commit message to be used. */ - readonly message?: string; + message?: string; } | null; - readonly "code-scanning-autofix-commits-response": { + "code-scanning-autofix-commits-response": { /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly target_ref?: string; + target_ref?: string; /** @description SHA of commit with autofix. */ - readonly sha?: string; + sha?: string; + }; + /** + * @description State of a code scanning alert instance. + * @enum {string|null} + */ + "code-scanning-alert-instance-state": "open" | "fixed" | null; + "code-scanning-alert-instance-list": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-instance-state"]; + commit_sha?: string; + message?: { + text?: string; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - readonly "code-scanning-analysis-sarif-id": string; + "code-scanning-analysis-sarif-id": string; /** @description The SHA of the commit to which the analysis you are uploading relates. */ - readonly "code-scanning-analysis-commit-sha": string; + "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - readonly "code-scanning-analysis-environment": string; + "code-scanning-analysis-environment": string; /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; - readonly "code-scanning-analysis": { - readonly ref: components["schemas"]["code-scanning-ref"]; - readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - readonly environment: components["schemas"]["code-scanning-analysis-environment"]; - readonly category?: components["schemas"]["code-scanning-analysis-category"]; + "code-scanning-analysis-url": string; + "code-scanning-analysis": { + ref: components["schemas"]["code-scanning-ref"]; + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment: components["schemas"]["code-scanning-analysis-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; /** @example error reading field xyz */ - readonly error: string; - readonly created_at: components["schemas"]["code-scanning-analysis-created-at"]; + error: string; + created_at: components["schemas"]["code-scanning-analysis-created-at"]; /** @description The total number of results in the analysis. */ - readonly results_count: number; + results_count: number; /** @description The total number of rules used in the analysis. */ - readonly rules_count: number; + rules_count: number; /** @description Unique identifier for this analysis. */ - readonly id: number; - readonly url: components["schemas"]["code-scanning-analysis-url"]; - readonly sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly deletable: boolean; + id: number; + url: components["schemas"]["code-scanning-analysis-url"]; + sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + deletable: boolean; /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - readonly warning: string; + warning: string; }; /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - readonly "code-scanning-analysis-deletion": { + "code-scanning-analysis-deletion": { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation @@ -29243,304 +32348,314 @@ export type components = { * CodeQL Database * @description A CodeQL database. */ - readonly "code-scanning-codeql-database": { + "code-scanning-codeql-database": { /** @description The ID of the CodeQL database. */ - readonly id: number; + id: number; /** @description The name of the CodeQL database. */ - readonly name: string; + name: string; /** @description The language of the CodeQL database. */ - readonly language: string; - readonly uploader: components["schemas"]["simple-user"]; + language: string; + uploader: components["schemas"]["simple-user"]; /** @description The MIME type of the CodeQL database file. */ - readonly content_type: string; + content_type: string; /** @description The size of the CodeQL database file in bytes. */ - readonly size: number; + size: number; /** * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ - readonly url: string; + url: string; /** @description The commit SHA of the repository at the time the CodeQL database was created. */ - readonly commit_oid?: string | null; + commit_oid?: string | null; }; /** * @description The language targeted by the CodeQL query * @enum {string} */ - readonly "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift"; + "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift"; /** * Repository Identifier * @description Repository Identifier */ - readonly "code-scanning-variant-analysis-repository": { + "code-scanning-variant-analysis-repository": { /** * @description A unique identifier of the repository. * @example 1296269 */ - readonly id: number; + id: number; /** * @description The name of the repository. * @example Hello-World */ - readonly name: string; + name: string; /** * @description The full, globally unique, name of the repository. * @example octocat/Hello-World */ - readonly full_name: string; + full_name: string; /** @description Whether the repository is private. */ - readonly private: boolean; + private: boolean; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; }; /** * @description The new status of the CodeQL variant analysis repository task. * @enum {string} */ - readonly "code-scanning-variant-analysis-status": "pending" | "in_progress" | "succeeded" | "failed" | "canceled" | "timed_out"; - readonly "code-scanning-variant-analysis-skipped-repo-group": { + "code-scanning-variant-analysis-status": "pending" | "in_progress" | "succeeded" | "failed" | "canceled" | "timed_out"; + "code-scanning-variant-analysis-skipped-repo-group": { /** * @description The total number of repositories that were skipped for this reason. * @example 2 */ - readonly repository_count: number; + repository_count: number; /** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */ - readonly repositories: readonly components["schemas"]["code-scanning-variant-analysis-repository"][]; + repositories: components["schemas"]["code-scanning-variant-analysis-repository"][]; }; /** * Variant Analysis * @description A run of a CodeQL query against one or more repositories. */ - readonly "code-scanning-variant-analysis": { + "code-scanning-variant-analysis": { /** @description The ID of the variant analysis. */ - readonly id: number; - readonly controller_repo: components["schemas"]["simple-repository"]; - readonly actor: components["schemas"]["simple-user"]; - readonly query_language: components["schemas"]["code-scanning-variant-analysis-language"]; + id: number; + controller_repo: components["schemas"]["simple-repository"]; + actor: components["schemas"]["simple-user"]; + query_language: components["schemas"]["code-scanning-variant-analysis-language"]; /** @description The download url for the query pack. */ - readonly query_pack_url: string; + query_pack_url: string; /** * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at?: string; + created_at?: string; /** * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at?: string; + updated_at?: string; /** * Format: date-time * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. */ - readonly completed_at?: string | null; + completed_at?: string | null; /** @enum {string} */ - readonly status: "in_progress" | "succeeded" | "failed" | "cancelled"; + status: "in_progress" | "succeeded" | "failed" | "cancelled"; /** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */ - readonly actions_workflow_run_id?: number; + actions_workflow_run_id?: number; /** * @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. * @enum {string} */ - readonly failure_reason?: "no_repos_queried" | "actions_workflow_run_failed" | "internal_error"; - readonly scanned_repositories?: readonly { - readonly repository: components["schemas"]["code-scanning-variant-analysis-repository"]; - readonly analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + failure_reason?: "no_repos_queried" | "actions_workflow_run_failed" | "internal_error"; + scanned_repositories?: { + repository: components["schemas"]["code-scanning-variant-analysis-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ - readonly result_count?: number; + result_count?: number; /** @description The size of the artifact. This is only available for successful analyses. */ - readonly artifact_size_in_bytes?: number; + artifact_size_in_bytes?: number; /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ - readonly failure_message?: string; + failure_message?: string; }[]; /** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */ - readonly skipped_repositories?: { - readonly access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; - readonly not_found_repos: { + skipped_repositories?: { + access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + not_found_repos: { /** * @description The total number of repositories that were skipped for this reason. * @example 2 */ - readonly repository_count: number; + repository_count: number; /** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */ - readonly repository_full_names: readonly string[]; + repository_full_names: string[]; }; - readonly no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; - readonly over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; }; }; - readonly "code-scanning-variant-analysis-repo-task": { - readonly repository: components["schemas"]["simple-repository"]; - readonly analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + "code-scanning-variant-analysis-repo-task": { + repository: components["schemas"]["simple-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; /** @description The size of the artifact. This is only available for successful analyses. */ - readonly artifact_size_in_bytes?: number; + artifact_size_in_bytes?: number; /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ - readonly result_count?: number; + result_count?: number; /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ - readonly failure_message?: string; + failure_message?: string; /** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */ - readonly database_commit_sha?: string; + database_commit_sha?: string; /** @description The source location prefix to use. This is only available for successful analyses. */ - readonly source_location_prefix?: string; + source_location_prefix?: string; /** @description The URL of the artifact. This is only available for successful analyses. */ - readonly artifact_url?: string; + artifact_url?: string; }; /** @description Configuration for code scanning default setup. */ - readonly "code-scanning-default-setup": { + "code-scanning-default-setup": { /** * @description Code scanning default setup has been configured or not. * @enum {string} */ - readonly state?: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description Runner type to be used. * @enum {string|null} */ - readonly runner_type?: "standard" | "labeled" | null; + runner_type?: "standard" | "labeled" | null; /** * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ - readonly runner_label?: string | null; + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ - readonly query_suite?: "default" | "extended"; + query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** * Format: date-time * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z */ - readonly updated_at?: string | null; + updated_at?: string | null; /** * @description The frequency of the periodic analysis. * @enum {string|null} */ - readonly schedule?: "weekly" | null; + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ - readonly "code-scanning-default-setup-update": { + "code-scanning-default-setup-update": { /** * @description The desired state of code scanning default setup. * @enum {string} */ - readonly state?: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description Runner type to be used. * @enum {string} */ - readonly runner_type?: "standard" | "labeled"; + runner_type?: "standard" | "labeled"; /** * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ - readonly runner_label?: string | null; + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ - readonly query_suite?: "default" | "extended"; + query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** @description CodeQL languages to be analyzed. */ - readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ - readonly "code-scanning-default-setup-update-response": { + "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ - readonly run_id?: number; + run_id?: number; /** @description URL of the corresponding run. */ - readonly run_url?: string; + run_url?: string; }; /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ - readonly "code-scanning-ref-full": string; + "code-scanning-ref-full": string; /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - readonly "code-scanning-analysis-sarif-file": string; - readonly "code-scanning-sarifs-receipt": { - readonly id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + "code-scanning-analysis-sarif-file": string; + "code-scanning-sarifs-receipt": { + id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** * Format: uri * @description The REST API URL for checking the status of the upload. */ readonly url?: string; }; - readonly "code-scanning-sarifs-status": { + "code-scanning-sarifs-status": { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - readonly processing_status?: "pending" | "complete" | "failed"; + processing_status?: "pending" | "complete" | "failed"; /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - readonly errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ - readonly "code-security-configuration-for-repository": { + "code-security-configuration-for-repository": { /** * @description The attachment status of the code security configuration on the repository. * @enum {string} */ - readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file */ - readonly "codeowners-errors": { - readonly errors: readonly { + "codeowners-errors": { + errors: { /** * @description The line number where this errors occurs. * @example 7 */ - readonly line: number; + line: number; /** * @description The column number where this errors occurs. * @example 3 */ - readonly column: number; + column: number; /** * @description The contents of the line where the error occurs. * @example * user */ - readonly source?: string; + source?: string; /** * @description The type of error. * @example Invalid owner */ - readonly kind: string; + kind: string; /** * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ - readonly suggestion?: string | null; + suggestion?: string | null; /** * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: @@ -29548,891 +32663,750 @@ export type components = { * * user * ^ */ - readonly message: string; + message: string; /** * @description The path of the file where the error occured. * @example .github/CODEOWNERS */ - readonly path: string; + path: string; }[]; }; /** * Codespace machine * @description A description of the machine powering a codespace. */ - readonly "codespace-machine": { + "codespace-machine": { /** * @description The name of the machine. * @example standardLinux */ - readonly name: string; + name: string; /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 16 GB RAM, 64 GB storage */ - readonly display_name: string; + display_name: string; /** * @description The operating system of the machine. * @example linux */ - readonly operating_system: string; + operating_system: string; /** * @description How much storage is available to the codespace. * @example 68719476736 */ - readonly storage_in_bytes: number; + storage_in_bytes: number; /** * @description How much memory is available to the codespace. * @example 17179869184 */ - readonly memory_in_bytes: number; + memory_in_bytes: number; /** * @description How many cores are available to the codespace. * @example 4 */ - readonly cpus: number; + cpus: number; /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} */ - readonly prebuild_availability: "none" | "ready" | "in_progress" | null; + prebuild_availability: "none" | "ready" | "in_progress" | null; }; /** * Codespaces Permissions Check * @description Permission check result for a given devcontainer config. */ - readonly "codespaces-permissions-check-for-devcontainer": { + "codespaces-permissions-check-for-devcontainer": { /** * @description Whether the user has accepted the permissions defined by the devcontainer config * @example true */ - readonly accepted: boolean; + accepted: boolean; }; /** * Codespaces Secret * @description Set repository secrets for GitHub Codespaces. */ - readonly "repo-codespaces-secret": { + "repo-codespaces-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Collaborator * @description Collaborator */ - readonly collaborator: { + collaborator: { /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; - readonly email?: string | null; - readonly name?: string | null; + id: number; + email?: string | null; + name?: string | null; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; - readonly permissions?: { - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - readonly admin: boolean; + type: string; + site_admin: boolean; + permissions?: { + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + admin: boolean; }; /** @example admin */ - readonly role_name: string; + role_name: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; }; /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - readonly "repository-invitation": { + "repository-invitation": { /** * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ - readonly id: number; - readonly repository: components["schemas"]["minimal-repository"]; - readonly invitee: components["schemas"]["nullable-simple-user"]; - readonly inviter: components["schemas"]["nullable-simple-user"]; + id: number; + repository: components["schemas"]["minimal-repository"]; + invitee: components["schemas"]["nullable-simple-user"]; + inviter: components["schemas"]["nullable-simple-user"]; /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - readonly permissions: "read" | "write" | "admin" | "triage" | "maintain"; + permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - readonly created_at: string; + created_at: string; /** @description Whether or not the invitation has expired */ - readonly expired?: boolean; + expired?: boolean; /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - readonly url: string; + url: string; /** @example https://github.com/octocat/Hello-World/invitations */ - readonly html_url: string; - readonly node_id: string; + html_url: string; + node_id: string; }; /** * Collaborator * @description Collaborator */ - readonly "nullable-collaborator": { + "nullable-collaborator": { /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; - readonly email?: string | null; - readonly name?: string | null; + id: number; + email?: string | null; + name?: string | null; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; - readonly permissions?: { - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - readonly admin: boolean; + type: string; + site_admin: boolean; + permissions?: { + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + admin: boolean; }; /** @example admin */ - readonly role_name: string; + role_name: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; } | null; /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - readonly "repository-collaborator-permission": { - readonly permission: string; + "repository-collaborator-permission": { + permission: string; /** @example admin */ - readonly role_name: string; - readonly user: components["schemas"]["nullable-collaborator"]; + role_name: string; + user: components["schemas"]["nullable-collaborator"]; }; /** * Commit Comment * @description Commit Comment */ - readonly "commit-comment": { + "commit-comment": { /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly url: string; - readonly id: number; - readonly node_id: string; - readonly body: string; - readonly path: string | null; - readonly position: number | null; - readonly line: number | null; - readonly commit_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + url: string; + id: number; + node_id: string; + body: string; + path: string | null; + position: number | null; + line: number | null; + commit_id: string; + user: components["schemas"]["nullable-simple-user"]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly author_association: components["schemas"]["author-association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Branch Short - * @description Branch Short - */ - readonly "branch-short": { - readonly name: string; - readonly commit: { - readonly sha: string; - readonly url: string; - }; - readonly protected: boolean; + updated_at: string; + author_association: components["schemas"]["author-association"]; + reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Link - * @description Hypermedia Link - */ - readonly link: { - readonly href: string; - }; - /** - * Auto merge - * @description The status of auto merging a pull request. + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - readonly "auto-merge": { - readonly enabled_by: components["schemas"]["simple-user"]; + reaction: { + /** @example 1 */ + id: number; + /** @example MDg6UmVhY3Rpb24x */ + node_id: string; + user: components["schemas"]["nullable-simple-user"]; /** - * @description The merge method to use. + * @description The reaction to use + * @example heart * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; - /** @description Title for the merge commit message. */ - readonly commit_title: string; - /** @description Commit message for the merge commit. */ - readonly commit_message: string; - } | null; - /** - * Pull Request Simple - * @description Pull Request Simple - */ - readonly "pull-request-simple": { - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 - */ - readonly url: string; - /** - * Format: int64 - * @example 1 - */ - readonly id: number; - /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347 - */ - readonly html_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.diff - */ - readonly diff_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.patch - */ - readonly patch_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - readonly issue_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - */ - readonly commits_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - */ - readonly review_comments_url: string; - /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - readonly review_comment_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - */ - readonly comments_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - */ - readonly statuses_url: string; - /** @example 1347 */ - readonly number: number; - /** @example open */ - readonly state: string; - /** @example true */ - readonly locked: boolean; - /** @example new-feature */ - readonly title: string; - readonly user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ - readonly body: string | null; - readonly labels: readonly { - /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly name: string; - readonly description: string; - readonly color: string; - readonly default: boolean; - }[]; - readonly milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ - readonly active_lock_reason?: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly updated_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly closed_at: string | null; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - readonly merge_commit_sha: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_teams?: readonly components["schemas"]["team"][] | null; - readonly head: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; - readonly base: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; - readonly _links: { - readonly comments: components["schemas"]["link"]; - readonly commits: components["schemas"]["link"]; - readonly statuses: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly issue: components["schemas"]["link"]; - readonly review_comments: components["schemas"]["link"]; - readonly review_comment: components["schemas"]["link"]; - readonly self: components["schemas"]["link"]; - }; - readonly author_association: components["schemas"]["author-association"]; - readonly auto_merge: components["schemas"]["auto-merge"]; - /** - * @description Indicates whether or not the pull request is a draft. - * @example false + * @example 2016-05-20T20:09:31Z */ - readonly draft?: boolean; + created_at: string; + }; + /** + * Branch Short + * @description Branch Short + */ + "branch-short": { + name: string; + commit: { + sha: string; + url: string; + }; + protected: boolean; }; /** Simple Commit Status */ - readonly "simple-commit-status": { - readonly description: string | null; - readonly id: number; - readonly node_id: string; - readonly state: string; - readonly context: string; + "simple-commit-status": { + description: string | null; + id: number; + node_id: string; + state: string; + context: string; /** Format: uri */ - readonly target_url: string | null; - readonly required?: boolean | null; + target_url: string | null; + required?: boolean | null; /** Format: uri */ - readonly avatar_url: string | null; + avatar_url: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Combined Commit Status * @description Combined Commit Status */ - readonly "combined-commit-status": { - readonly state: string; - readonly statuses: readonly components["schemas"]["simple-commit-status"][]; - readonly sha: string; - readonly total_count: number; - readonly repository: components["schemas"]["minimal-repository"]; + "combined-commit-status": { + state: string; + statuses: components["schemas"]["simple-commit-status"][]; + sha: string; + total_count: number; + repository: components["schemas"]["minimal-repository"]; /** Format: uri */ - readonly commit_url: string; + commit_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Status * @description The status of a commit. */ - readonly status: { - readonly url: string; - readonly avatar_url: string | null; - readonly id: number; - readonly node_id: string; - readonly state: string; - readonly description: string | null; - readonly target_url: string | null; - readonly context: string; - readonly created_at: string; - readonly updated_at: string; - readonly creator: components["schemas"]["nullable-simple-user"]; + status: { + url: string; + avatar_url: string | null; + id: number; + node_id: string; + state: string; + description: string | null; + target_url: string | null; + context: string; + created_at: string; + updated_at: string; + creator: components["schemas"]["nullable-simple-user"]; }; /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - readonly "nullable-code-of-conduct-simple": { + "nullable-code-of-conduct-simple": { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly url: string; + url: string; /** @example citizen_code_of_conduct */ - readonly key: string; + key: string; /** @example Citizen Code of Conduct */ - readonly name: string; + name: string; /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly html_url: string | null; + html_url: string | null; } | null; /** Community Health File */ - readonly "nullable-community-health-file": { + "nullable-community-health-file": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; } | null; /** * Community Profile * @description Community Profile */ - readonly "community-profile": { + "community-profile": { /** @example 100 */ - readonly health_percentage: number; + health_percentage: number; /** @example My first repository on GitHub! */ - readonly description: string | null; + description: string | null; /** @example example.com */ - readonly documentation: string | null; - readonly files: { - readonly code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - readonly code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly contributing: components["schemas"]["nullable-community-health-file"]; - readonly readme: components["schemas"]["nullable-community-health-file"]; - readonly issue_template: components["schemas"]["nullable-community-health-file"]; - readonly pull_request_template: components["schemas"]["nullable-community-health-file"]; + documentation: string | null; + files: { + code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; + code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; + license: components["schemas"]["nullable-license-simple"]; + contributing: components["schemas"]["nullable-community-health-file"]; + readme: components["schemas"]["nullable-community-health-file"]; + issue_template: components["schemas"]["nullable-community-health-file"]; + pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - readonly updated_at: string | null; + updated_at: string | null; /** @example true */ - readonly content_reports_enabled?: boolean; + content_reports_enabled?: boolean; }; /** * Commit Comparison * @description Commit Comparison */ - readonly "commit-comparison": { + "commit-comparison": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - readonly permalink_url: string; + permalink_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - readonly diff_url: string; + diff_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - readonly patch_url: string; - readonly base_commit: components["schemas"]["commit"]; - readonly merge_base_commit: components["schemas"]["commit"]; + patch_url: string; + base_commit: components["schemas"]["commit"]; + merge_base_commit: components["schemas"]["commit"]; /** * @example ahead * @enum {string} */ - readonly status: "diverged" | "ahead" | "behind" | "identical"; + status: "diverged" | "ahead" | "behind" | "identical"; /** @example 4 */ - readonly ahead_by: number; + ahead_by: number; /** @example 5 */ - readonly behind_by: number; + behind_by: number; /** @example 6 */ - readonly total_commits: number; - readonly commits: readonly components["schemas"]["commit"][]; - readonly files?: readonly components["schemas"]["diff-entry"][]; + total_commits: number; + commits: components["schemas"]["commit"][]; + files?: components["schemas"]["diff-entry"][]; }; /** * Content Tree * @description Content Tree */ - readonly "content-tree": { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; - readonly content?: string; + "content-tree": { + type: string; + size: number; + name: string; + path: string; + sha: string; + content?: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly entries?: readonly { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + download_url: string | null; + entries?: { + type: string; + size: number; + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }[]; - readonly _links: { + encoding?: string; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }; /** * Content Directory * @description A list of directory items */ - readonly "content-directory": readonly { + "content-directory": { /** @enum {string} */ - readonly type: "dir" | "file" | "submodule" | "symlink"; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content?: string; - readonly sha: string; + type: "dir" | "file" | "submodule" | "symlink"; + size: number; + name: string; + path: string; + content?: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }[]; /** * Content File * @description Content File */ - readonly "content-file": { + "content-file": { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly type: "file"; - readonly encoding: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content: string; - readonly sha: string; + type: "file"; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; /** @example "actual/actual.md" */ - readonly target?: string; + target?: string; /** @example "git://example.com/defunkt/dotjs.git" */ - readonly submodule_git_url?: string; + submodule_git_url?: string; }; /** * Symlink Content * @description An object describing a symlink */ - readonly "content-symlink": { + "content-symlink": { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly type: "symlink"; - readonly target: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + type: "symlink"; + target: string; + size: number; + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }; /** * Submodule Content * @description An object describing a submodule */ - readonly "content-submodule": { + "content-submodule": { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly type: "submodule"; + type: "submodule"; /** Format: uri */ - readonly submodule_git_url: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + submodule_git_url: string; + size: number; + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }; /** * File Commit * @description File Commit */ - readonly "file-commit": { - readonly content: { - readonly name?: string; - readonly path?: string; - readonly sha?: string; - readonly size?: number; - readonly url?: string; - readonly html_url?: string; - readonly git_url?: string; - readonly download_url?: string; - readonly type?: string; - readonly _links?: { - readonly self?: string; - readonly git?: string; - readonly html?: string; + "file-commit": { + content: { + name?: string; + path?: string; + sha?: string; + size?: number; + url?: string; + html_url?: string; + git_url?: string; + download_url?: string; + type?: string; + _links?: { + self?: string; + git?: string; + html?: string; }; } | null; - readonly commit: { - readonly sha?: string; - readonly node_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly author?: { - readonly date?: string; - readonly name?: string; - readonly email?: string; - }; - readonly committer?: { - readonly date?: string; - readonly name?: string; - readonly email?: string; - }; - readonly message?: string; - readonly tree?: { - readonly url?: string; - readonly sha?: string; - }; - readonly parents?: readonly { - readonly url?: string; - readonly html_url?: string; - readonly sha?: string; + commit: { + sha?: string; + node_id?: string; + url?: string; + html_url?: string; + author?: { + date?: string; + name?: string; + email?: string; + }; + committer?: { + date?: string; + name?: string; + email?: string; + }; + message?: string; + tree?: { + url?: string; + sha?: string; + }; + parents?: { + url?: string; + html_url?: string; + sha?: string; }[]; - readonly verification?: { - readonly verified?: boolean; - readonly reason?: string; - readonly signature?: string | null; - readonly payload?: string | null; - readonly verified_at?: string | null; + verification?: { + verified?: boolean; + reason?: string; + signature?: string | null; + payload?: string | null; + verified_at?: string | null; }; }; }; /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ - readonly "secret-scanning-push-protection-bypass-placeholder-id": string; + "secret-scanning-push-protection-bypass-placeholder-id": string; /** @description Repository rule violation was detected */ - readonly "repository-rule-violation-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly status?: string; - readonly metadata?: { - readonly secret_scanning?: { - readonly bypass_placeholders?: readonly { - readonly placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; - readonly token_type?: string; + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; }[]; }; }; @@ -30441,41 +33415,41 @@ export type components = { * Contributor * @description Contributor */ - readonly contributor: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; + contributor: { + login?: string; + id?: number; + node_id?: string; /** Format: uri */ - readonly avatar_url?: string; - readonly gravatar_id?: string | null; + avatar_url?: string; + gravatar_id?: string | null; /** Format: uri */ - readonly url?: string; + url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: uri */ - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly events_url?: string; + repos_url?: string; + events_url?: string; /** Format: uri */ - readonly received_events_url?: string; - readonly type: string; - readonly site_admin?: boolean; - readonly contributions: number; - readonly email?: string; - readonly name?: string; - readonly user_view_type?: string; + received_events_url?: string; + type: string; + site_admin?: boolean; + contributions: number; + email?: string; + name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ - readonly "dependabot-alert": { - readonly number: components["schemas"]["alert-number"]; + "dependabot-alert": { + number: components["schemas"]["alert-number"]; /** * @description The state of the Dependabot alert. * @enum {string} @@ -30483,7 +33457,7 @@ export type components = { readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ readonly dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -30491,200 +33465,211 @@ export type components = { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; - readonly security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; - readonly security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at: components["schemas"]["alert-updated-at"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; + security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; + security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at: components["schemas"]["alert-updated-at"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; /** * @description The reason that the alert was dismissed. * @enum {string|null} */ - readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; + dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; /** @description An optional comment associated with the alert's dismissal. */ - readonly dismissed_comment: string | null; - readonly fixed_at: components["schemas"]["alert-fixed-at"]; - readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissed_comment: string | null; + fixed_at: components["schemas"]["alert-fixed-at"]; + auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; }; /** * Dependabot Secret * @description Set secrets for Dependabot. */ - readonly "dependabot-secret": { + "dependabot-secret": { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Dependency Graph Diff * @description A diff of the dependencies between two commits. */ - readonly "dependency-graph-diff": readonly { + "dependency-graph-diff": { /** @enum {string} */ - readonly change_type: "added" | "removed"; + change_type: "added" | "removed"; /** @example path/to/package-lock.json */ - readonly manifest: string; + manifest: string; /** @example npm */ - readonly ecosystem: string; + ecosystem: string; /** @example @actions/core */ - readonly name: string; + name: string; /** @example 1.0.0 */ - readonly version: string; + version: string; /** @example pkg:/npm/%40actions/core@1.1.0 */ - readonly package_url: string | null; + package_url: string | null; /** @example MIT */ - readonly license: string | null; + license: string | null; /** @example https://github.com/github/actions */ - readonly source_repository_url: string | null; - readonly vulnerabilities: readonly { + source_repository_url: string | null; + vulnerabilities: { /** @example critical */ - readonly severity: string; + severity: string; /** @example GHSA-rf4j-j272-fj86 */ - readonly advisory_ghsa_id: string; + advisory_ghsa_id: string; /** @example A summary of the advisory. */ - readonly advisory_summary: string; + advisory_summary: string; /** @example https://github.com/advisories/GHSA-rf4j-j272-fj86 */ - readonly advisory_url: string; + advisory_url: string; }[]; /** * @description Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment. * @enum {string} */ - readonly scope: "unknown" | "runtime" | "development"; + scope: "unknown" | "runtime" | "development"; }[]; /** * Dependency Graph SPDX SBOM * @description A schema for the SPDX JSON format returned by the Dependency Graph. */ - readonly "dependency-graph-spdx-sbom": { - readonly sbom: { + "dependency-graph-spdx-sbom": { + sbom: { /** * @description The SPDX identifier for the SPDX document. * @example SPDXRef-DOCUMENT */ - readonly SPDXID: string; + SPDXID: string; /** * @description The version of the SPDX specification that this document conforms to. * @example SPDX-2.3 */ - readonly spdxVersion: string; + 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: { + comment?: string; + creationInfo: { /** * @description The date and time the SPDX document was created. * @example 2021-11-03T00:00:00Z */ - readonly created: string; + created: string; /** @description The tools that were used to generate the SPDX document. */ - readonly creators: readonly string[]; + creators: string[]; }; /** * @description The name of the SPDX document. * @example github/github */ - readonly name: string; + name: string; /** * @description The license under which the SPDX document is licensed. * @example CC0-1.0 */ - readonly dataLicense: string; + dataLicense: string; /** * @description The namespace for the SPDX document. * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ - readonly documentNamespace: string; - readonly packages: readonly { + documentNamespace: string; + packages: { /** * @description A unique SPDX identifier for the package. * @example SPDXRef-Package */ - readonly SPDXID?: string; + SPDXID?: string; /** * @description The name of the package. * @example github/github */ - readonly name?: string; + name?: string; /** * @description The version of the package. If the package does not have an exact version specified, * a version range is given. * @example 1.0.0 */ - readonly versionInfo?: string; + versionInfo?: string; /** * @description The location where the package can be downloaded, * or NOASSERTION if this has not been determined. * @example NOASSERTION */ - readonly downloadLocation?: string; + downloadLocation?: string; /** * @description Whether the package's file content has been subjected to * analysis during the creation of the SPDX document. * @example false */ - readonly filesAnalyzed?: boolean; + filesAnalyzed?: boolean; /** * @description The license of the package as determined while creating the SPDX document. * @example MIT */ - readonly licenseConcluded?: string; + licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information * was not available when the SPDX document was created. * @example NOASSERTION */ - readonly licenseDeclared?: string; + licenseDeclared?: string; /** * @description The distribution source of this package, or NOASSERTION if this was not determined. * @example NOASSERTION */ - readonly supplier?: string; + supplier?: string; /** * @description The copyright holders of the package, and any dates present with those notices, if available. * @example Copyright (c) 1985 GitHub.com */ - readonly copyrightText?: string; - readonly externalRefs?: readonly { + copyrightText?: string; + externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. * @example PACKAGE-MANAGER */ - readonly referenceCategory: string; + referenceCategory: string; /** * @description A locator for the particular external resource this reference refers to. * @example pkg:gem/rails@6.0.1 */ - readonly referenceLocator: string; + referenceLocator: string; /** * @description The category of reference to an external resource this reference refers to. * @example purl */ - readonly referenceType: string; + referenceType: string; }[]; }[]; - readonly relationships?: readonly { + relationships?: { /** * @description The type of relationship between the two SPDX elements. * @example DEPENDS_ON */ - readonly relationshipType?: string; + relationshipType?: string; /** @description The SPDX identifier of the package that is the source of the relationship. */ - readonly spdxElementId?: string; + spdxElementId?: string; /** @description The SPDX identifier of the package that is the target of the relationship. */ - readonly relatedSpdxElement?: string; + relatedSpdxElement?: string; }[]; }; }; @@ -30692,309 +33677,309 @@ export type components = { * metadata * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ - readonly metadata: { - readonly [key: string]: (string | number | boolean) | null; + metadata: { + [key: string]: (string | number | boolean) | null; }; - readonly dependency: { + dependency: { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 */ - readonly package_url?: string; - readonly metadata?: components["schemas"]["metadata"]; + package_url?: string; + metadata?: components["schemas"]["metadata"]; /** * @description A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. * @example direct * @enum {string} */ - readonly relationship?: "direct" | "indirect"; + relationship?: "direct" | "indirect"; /** * @description A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. * @example runtime * @enum {string} */ - readonly scope?: "runtime" | "development"; + scope?: "runtime" | "development"; /** * @description Array of package-url (PURLs) of direct child dependencies. * @example @actions/http-client */ - readonly dependencies?: readonly string[]; + dependencies?: string[]; }; - readonly manifest: { + manifest: { /** * @description The name of the manifest. * @example package-lock.json */ - readonly name: string; - readonly file?: { + name: string; + file?: { /** * @description The path of the manifest file relative to the root of the Git repository. * @example /src/build/package-lock.json */ - readonly source_location?: string; + source_location?: string; }; - readonly metadata?: components["schemas"]["metadata"]; + metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ - readonly resolved?: { - readonly [key: string]: components["schemas"]["dependency"]; + resolved?: { + [key: string]: components["schemas"]["dependency"]; }; }; /** * snapshot * @description Create a new snapshot of a repository's dependencies. */ - readonly snapshot: { + snapshot: { /** @description The version of the repository snapshot submission. */ - readonly version: number; - readonly job: { + version: number; + job: { /** * @description The external ID of the job. * @example 5622a2b0-63f6-4732-8c34-a1ab27e102a11 */ - readonly id: string; + id: string; /** * @description Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation. * @example yourworkflowname_yourjobname */ - readonly correlator: string; + correlator: string; /** * @description The url for the job. * @example http://example.com/build */ - readonly html_url?: string; + html_url?: string; }; /** * @description The commit SHA associated with this dependency snapshot. Maximum length: 40 characters. * @example ddc951f4b1293222421f2c8df679786153acf689 */ - readonly sha: string; + sha: string; /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main */ - readonly ref: string; + ref: string; /** @description A description of the detector used. */ - readonly detector: { + detector: { /** * @description The name of the detector used. * @example docker buildtime detector */ - readonly name: string; + name: string; /** * @description The version of the detector used. * @example 1.0.0 */ - readonly version: string; + version: string; /** * @description The url of the detector used. * @example http://example.com/docker-buildtimer-detector */ - readonly url: string; + url: string; }; - readonly metadata?: components["schemas"]["metadata"]; + metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ - readonly manifests?: { - readonly [key: string]: components["schemas"]["manifest"]; + manifests?: { + [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 */ - readonly scanned: string; + scanned: string; }; /** * Deployment Status * @description The status of a deployment. */ - readonly "deployment-status": { + "deployment-status": { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - readonly url: string; + url: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - readonly node_id: string; + node_id: string; /** * @description The state of the status. * @example success * @enum {string} */ - readonly state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - readonly creator: components["schemas"]["nullable-simple-user"]; + state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; + creator: components["schemas"]["nullable-simple-user"]; /** * @description A short description of the status. * @default * @example Deployment finished successfully. */ - readonly description: string; + description: string; /** * @description The environment of the deployment that the status is for. * @default * @example production */ - readonly environment: string; + environment: string; /** * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - readonly target_url: string; + target_url: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - readonly deployment_url: string; + deployment_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; /** * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ */ - readonly environment_url: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - readonly log_url: string; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + log_url: string; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - readonly "wait-timer": number; + "wait-timer": number; /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ - readonly "deployment-branch-policy-settings": { + "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - readonly protected_branches: boolean; + protected_branches: boolean; /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - readonly custom_branch_policies: boolean; + custom_branch_policies: boolean; } | null; /** * Environment * @description Details of a deployment environment */ - readonly environment: { + environment: { /** * Format: int64 * @description The id of the environment. * @example 56780428 */ - readonly id: number; + id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id: string; + node_id: string; /** * @description The name of the environment. * @example staging */ - readonly name: string; + name: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly updated_at: string; + updated_at: string; /** @description Built-in deployment protection rules for the environment. */ - readonly protection_rules?: readonly ({ + protection_rules?: ({ /** @example 3515 */ - readonly id: number; + id: number; /** @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; /** @example wait_timer */ - readonly type: string; - readonly wait_timer?: components["schemas"]["wait-timer"]; + type: string; + wait_timer?: components["schemas"]["wait-timer"]; } | { /** @example 3755 */ - readonly id: number; + id: number; /** @example MDQ6R2F0ZTM3NTU= */ - readonly node_id: string; + node_id: string; /** * @description Whether deployments to this environment can be approved by the user who created the deployment. * @example false */ - readonly prevent_self_review?: boolean; + prevent_self_review?: boolean; /** @example required_reviewers */ - readonly type: string; + type: string; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - readonly reviewers?: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; - readonly reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; + reviewers?: { + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; }[]; } | { /** @example 3515 */ - readonly id: number; + id: number; /** @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; /** @example branch_policy */ - readonly type: string; + type: string; })[]; - readonly deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; + deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; }; /** * @description Whether or not a user who created the job is prevented from approving their own job. * @example false */ - readonly "prevent-self-review": boolean; + "prevent-self-review": boolean; /** * Deployment branch policy * @description Details of a deployment branch or tag policy. */ - readonly "deployment-branch-policy": { + "deployment-branch-policy": { /** * @description The unique identifier of the branch or tag policy. * @example 361471 */ - readonly id?: number; + id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ - readonly node_id?: string; + node_id?: string; /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ - readonly name?: string; + name?: string; /** * @description Whether this rule targets a branch or tag. * @example branch * @enum {string} */ - readonly type?: "branch" | "tag"; + type?: "branch" | "tag"; }; /** Deployment branch and tag policy name pattern */ - readonly "deployment-branch-policy-name-pattern-with-type": { + "deployment-branch-policy-name-pattern-with-type": { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * @@ -31002,16 +33987,16 @@ export type components = { * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ - readonly name: string; + name: string; /** * @description Whether this rule targets a branch or tag * @example branch * @enum {string} */ - readonly type?: "branch" | "tag"; + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ - readonly "deployment-branch-policy-name-pattern": { + "deployment-branch-policy-name-pattern": { /** * @description The name pattern that branches must match in order to deploy to the environment. * @@ -31019,231 +34004,231 @@ export type components = { * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ - readonly name: string; + name: string; }; /** * Custom deployment protection rule app * @description A GitHub App that is providing a custom deployment protection rule. */ - readonly "custom-deployment-rule-app": { + "custom-deployment-rule-app": { /** * @description The unique identifier of the deployment protection rule integration. * @example 3515 */ - readonly id: number; + id: number; /** * @description The slugified name of the deployment protection rule integration. * @example my-custom-app */ - readonly slug: string; + slug: string; /** * @description The URL for the endpoint to get details about the app. * @example https://api.github.com/apps/custom-app-slug */ - readonly integration_url: string; + integration_url: string; /** * @description The node ID for the deployment protection rule integration. * @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; }; /** * Deployment protection rule * @description Deployment protection rule */ - readonly "deployment-protection-rule": { + "deployment-protection-rule": { /** * @description The unique identifier for the deployment protection rule. * @example 3515 */ - readonly id: number; + id: number; /** * @description The node ID for the deployment protection rule. * @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; /** * @description Whether the deployment protection rule is enabled for the environment. * @example true */ - readonly enabled: boolean; - readonly app: components["schemas"]["custom-deployment-rule-app"]; + enabled: boolean; + app: components["schemas"]["custom-deployment-rule-app"]; }; /** * Short Blob * @description Short Blob */ - readonly "short-blob": { - readonly url: string; - readonly sha: string; + "short-blob": { + url: string; + sha: string; }; /** * Blob * @description Blob */ - readonly blob: { - readonly content: string; - readonly encoding: string; + blob: { + content: string; + encoding: string; /** Format: uri */ - readonly url: string; - readonly sha: string; - readonly size: number | null; - readonly node_id: string; - readonly highlighted_content?: string; + url: string; + sha: string; + size: number | null; + node_id: string; + highlighted_content?: string; }; /** * Git Commit * @description Low-level Git commit operations within a repository */ - readonly "git-commit": { + "git-commit": { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; - readonly node_id: string; + sha: string; + node_id: string; /** Format: uri */ - readonly url: string; + url: string; /** @description Identifying information for the git-user */ - readonly author: { + author: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** @description Identifying information for the git-user */ - readonly committer: { + committer: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; - readonly tree: { + message: string; + tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly parents: readonly { + parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; }[]; - readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly signature: string | null; - readonly payload: string | null; - readonly verified_at?: string | null; + verification: { + verified: boolean; + reason: string; + signature: string | null; + payload: string | null; + verified_at: string | null; }; /** Format: uri */ - readonly html_url: string; + html_url: string; }; /** * Git Reference * @description Git references within a repository */ - readonly "git-ref": { - readonly ref: string; - readonly node_id: string; + "git-ref": { + ref: string; + node_id: string; /** Format: uri */ - readonly url: string; - readonly object: { - readonly type: string; + url: string; + object: { + type: string; /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; }; /** * Git Tag * @description Metadata for a Git tag */ - readonly "git-tag": { + "git-tag": { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - readonly node_id: string; + node_id: string; /** * @description Name of the tag * @example v0.0.1 */ - readonly tag: string; + tag: string; /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly sha: string; + sha: string; /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly url: string; + url: string; /** * @description Message describing the purpose of the tag * @example Initial public release */ - readonly message: string; - readonly tagger: { - readonly date: string; - readonly email: string; - readonly name: string; + message: string; + tagger: { + date: string; + email: string; + name: string; }; - readonly object: { - readonly sha: string; - readonly type: string; + object: { + sha: string; + type: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly verification?: components["schemas"]["verification"]; + verification?: components["schemas"]["verification"]; }; /** * Git Tree * @description The hierarchy between files in a Git repository. */ - readonly "git-tree": { - readonly sha: string; + "git-tree": { + sha: string; /** Format: uri */ - readonly url: string; - readonly truncated: boolean; + url?: string; + truncated: boolean; /** * @description Objects specifying a tree structure * @example [ @@ -31253,80 +34238,52 @@ export type components = { * "type": "blob", * "size": 30, * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" - * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" - * ] + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" * } * ] */ - readonly tree: readonly { + tree: { /** @example test/file.rb */ - readonly path?: string; + path: string; /** @example 040000 */ - readonly mode?: string; + mode: string; /** @example tree */ - readonly type?: string; + type: string; /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - readonly sha?: string; + sha: string; /** @example 12 */ - readonly size?: number; + size?: number; /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - readonly url?: string; + url?: string; }[]; }; /** Hook Response */ - readonly "hook-response": { - readonly code: number | null; - readonly status: string | null; - readonly message: string | null; + "hook-response": { + code: number | null; + status: string | null; + message: string | null; }; /** * Webhook * @description Webhooks for repositories. */ - readonly hook: { - readonly type: string; + hook: { + type: string; /** * @description Unique identifier of the webhook. * @example 42 */ - readonly id: number; + id: number; /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - readonly name: string; + name: string; /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - readonly active: boolean; + active: boolean; /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ @@ -31334,154 +34291,170 @@ export type components = { * "pull_request" * ] */ - readonly events: readonly string[]; - readonly config: components["schemas"]["webhook-config"]; + events: string[]; + config: components["schemas"]["webhook-config"]; /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; + created_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - readonly test_url: string; + test_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - readonly ping_url: string; + ping_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - readonly deliveries_url?: string; - readonly last_response: components["schemas"]["hook-response"]; + deliveries_url?: string; + last_response: components["schemas"]["hook-response"]; + }; + /** + * Check immutable releases + * @description Check immutable releases + */ + "check-immutable-releases": { + /** + * @description Whether immutable releases are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether immutable releases are enforced by the repository owner. + * @example false + */ + enforced_by_owner: boolean; }; /** * Import * @description A repository import from an external source. */ - readonly import: { - readonly vcs: string | null; - readonly use_lfs?: boolean; + import: { + vcs: string | null; + use_lfs?: boolean; /** @description The URL of the originating repository. */ - readonly vcs_url: string; - readonly svc_root?: string; - readonly tfvc_project?: string; + vcs_url: string; + svc_root?: string; + tfvc_project?: string; /** @enum {string} */ - readonly status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; - readonly status_text?: string | null; - readonly failed_step?: string | null; - readonly error_message?: string | null; - readonly import_percent?: number | null; - readonly commit_count?: number | null; - readonly push_percent?: number | null; - readonly has_large_files?: boolean; - readonly large_files_size?: number; - readonly large_files_count?: number; - readonly project_choices?: readonly { - readonly vcs?: string; - readonly tfvc_project?: string; - readonly human_name?: string; + status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + status_text?: string | null; + failed_step?: string | null; + error_message?: string | null; + import_percent?: number | null; + commit_count?: number | null; + push_percent?: number | null; + has_large_files?: boolean; + large_files_size?: number; + large_files_count?: number; + project_choices?: { + vcs?: string; + tfvc_project?: string; + human_name?: string; }[]; - readonly message?: string; - readonly authors_count?: number | null; + message?: string; + authors_count?: number | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly authors_url: string; + authors_url: string; /** Format: uri */ - readonly repository_url: string; - readonly svn_root?: string; + repository_url: string; + svn_root?: string; }; /** * Porter Author * @description Porter Author */ - readonly "porter-author": { - readonly id: number; - readonly remote_id: string; - readonly remote_name: string; - readonly email: string; - readonly name: string; + "porter-author": { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly import_url: string; + import_url: string; }; /** * Porter Large File * @description Porter Large File */ - readonly "porter-large-file": { - readonly ref_name: string; - readonly path: string; - readonly oid: string; - readonly size: number; + "porter-large-file": { + ref_name: string; + path: string; + oid: string; + size: number; }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - readonly "nullable-issue": { + "nullable-issue": { /** Format: int64 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - readonly url: string; + url: string; /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + repository_url: string; + labels_url: string; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - readonly number: number; + number: number; /** * @description State of the issue; either 'open' or 'closed' * @example open */ - readonly state: string; + state: string; /** * @description The reason for the current state * @example not_planned * @enum {string|null} */ - readonly state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - readonly title: string; + title: string; /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - readonly body?: string | null; - readonly user: components["schemas"]["nullable-simple-user"]; + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ @@ -31489,1060 +34462,1033 @@ export type components = { * "registration" * ] */ - readonly labels: readonly (string | { + labels: (string | { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - /** Format: uri */ - readonly url?: string; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; - readonly default?: boolean; + id?: number; + node_id?: string; + /** Format: uri */ + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; })[]; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly comments: number; - readonly pull_request?: { + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: components["schemas"]["nullable-milestone"]; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly diff_url: string | null; + diff_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly patch_url: string | null; + patch_url: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; /** Format: date-time */ - readonly closed_at: string | null; + closed_at: string | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly draft?: boolean; - readonly closed_by?: components["schemas"]["nullable-simple-user"]; - readonly body_html?: string; - readonly body_text?: string; + updated_at: string; + draft?: boolean; + closed_by?: components["schemas"]["nullable-simple-user"]; + body_html?: string; + body_text?: string; /** Format: uri */ - readonly timeline_url?: string; - readonly repository?: components["schemas"]["repository"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly author_association: components["schemas"]["author-association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + author_association?: components["schemas"]["author-association"]; + reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; } | null; /** * Issue Event Label * @description Issue Event Label */ - readonly "issue-event-label": { - readonly name: string | null; - readonly color: string | null; + "issue-event-label": { + name: string | null; + color: string | null; }; /** Issue Event Dismissed Review */ - readonly "issue-event-dismissed-review": { - readonly state: string; - readonly review_id: number; - readonly dismissal_message: string | null; - readonly dismissal_commit_id?: string | null; + "issue-event-dismissed-review": { + state: string; + review_id: number; + dismissal_message: string | null; + dismissal_commit_id?: string | null; }; /** * Issue Event Milestone * @description Issue Event Milestone */ - readonly "issue-event-milestone": { - readonly title: string; + "issue-event-milestone": { + title: string; }; /** * Issue Event Project Card * @description Issue Event Project Card */ - readonly "issue-event-project-card": { + "issue-event-project-card": { /** Format: uri */ - readonly url: string; - readonly id: number; + url: string; + id: number; /** Format: uri */ - readonly project_url: string; - readonly project_id: number; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + project_id: number; + column_name: string; + previous_column_name?: string; }; /** * Issue Event Rename * @description Issue Event Rename */ - readonly "issue-event-rename": { - readonly from: string; - readonly to: string; + "issue-event-rename": { + from: string; + to: string; }; /** * Issue Event * @description Issue Event */ - readonly "issue-event": { + "issue-event": { /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDEwOklzc3VlRXZlbnQx */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - readonly url: string; - readonly actor: components["schemas"]["nullable-simple-user"]; + url: string; + actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ - readonly event: string; + event: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string | null; + commit_id: string | null; /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_url: string | null; + commit_url: string | null; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; - readonly issue?: components["schemas"]["nullable-issue"]; - readonly label?: components["schemas"]["issue-event-label"]; - readonly assignee?: components["schemas"]["nullable-simple-user"]; - readonly assigner?: components["schemas"]["nullable-simple-user"]; - readonly review_requester?: components["schemas"]["nullable-simple-user"]; - readonly requested_reviewer?: components["schemas"]["nullable-simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - readonly milestone?: components["schemas"]["issue-event-milestone"]; - readonly project_card?: components["schemas"]["issue-event-project-card"]; - readonly rename?: components["schemas"]["issue-event-rename"]; - readonly author_association?: components["schemas"]["author-association"]; - readonly lock_reason?: string | null; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + created_at: string; + issue?: components["schemas"]["nullable-issue"]; + label?: components["schemas"]["issue-event-label"]; + assignee?: components["schemas"]["nullable-simple-user"]; + assigner?: components["schemas"]["nullable-simple-user"]; + review_requester?: components["schemas"]["nullable-simple-user"]; + requested_reviewer?: components["schemas"]["nullable-simple-user"]; + requested_team?: components["schemas"]["team"]; + dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; + milestone?: components["schemas"]["issue-event-milestone"]; + project_card?: components["schemas"]["issue-event-project-card"]; + rename?: components["schemas"]["issue-event-rename"]; + author_association?: components["schemas"]["author-association"]; + lock_reason?: string | null; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * Labeled Issue Event * @description Labeled Issue Event */ - readonly "labeled-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly label: { - readonly name: string; - readonly color: string; + "labeled-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + label: { + name: string; + color: string; }; }; /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - readonly "unlabeled-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly label: { - readonly name: string; - readonly color: string; + "unlabeled-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + label: { + name: string; + color: string; }; }; /** * Assigned Issue Event * @description Assigned Issue Event */ - readonly "assigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["integration"]; - readonly assignee: components["schemas"]["simple-user"]; - readonly assigner: components["schemas"]["simple-user"]; + "assigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["integration"]; + assignee: components["schemas"]["simple-user"]; + assigner: components["schemas"]["simple-user"]; }; /** * Unassigned Issue Event * @description Unassigned Issue Event */ - readonly "unassigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; - readonly assigner: components["schemas"]["simple-user"]; + "unassigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + assignee: components["schemas"]["simple-user"]; + assigner: components["schemas"]["simple-user"]; }; /** * Milestoned Issue Event * @description Milestoned Issue Event */ - readonly "milestoned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly milestone: { - readonly title: string; + "milestoned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + milestone: { + title: string; }; }; /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - readonly "demilestoned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly milestone: { - readonly title: string; + "demilestoned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + milestone: { + title: string; }; }; /** * Renamed Issue Event * @description Renamed Issue Event */ - readonly "renamed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly rename: { - readonly from: string; - readonly to: string; + "renamed-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + rename: { + from: string; + to: string; }; }; /** * Review Requested Issue Event * @description Review Requested Issue Event */ - readonly "review-requested-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly review_requester: components["schemas"]["simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly requested_reviewer?: components["schemas"]["simple-user"]; + "review-requested-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + review_requester: components["schemas"]["simple-user"]; + requested_team?: components["schemas"]["team"]; + requested_reviewer?: components["schemas"]["simple-user"]; }; /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - readonly "review-request-removed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly review_requester: components["schemas"]["simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly requested_reviewer?: components["schemas"]["simple-user"]; + "review-request-removed-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + review_requester: components["schemas"]["simple-user"]; + requested_team?: components["schemas"]["team"]; + requested_reviewer?: components["schemas"]["simple-user"]; }; /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - readonly "review-dismissed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly dismissed_review: { - readonly state: string; - readonly review_id: number; - readonly dismissal_message: string | null; - readonly dismissal_commit_id?: string; + "review-dismissed-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + dismissed_review: { + state: string; + review_id: number; + dismissal_message: string | null; + dismissal_commit_id?: string; }; }; /** * Locked Issue Event * @description Locked Issue Event */ - readonly "locked-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + "locked-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; /** @example "off-topic" */ - readonly lock_reason: string | null; + lock_reason: string | null; }; /** * Added to Project Issue Event * @description Added to Project Issue Event */ - readonly "added-to-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly project_card?: { - readonly id: number; + "added-to-project-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - readonly "moved-column-in-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly project_card?: { - readonly id: number; + "moved-column-in-project-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - readonly "removed-from-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly project_card?: { - readonly id: number; + "removed-from-project-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - readonly "converted-note-to-issue-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["integration"]; - readonly project_card?: { - readonly id: number; + "converted-note-to-issue-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Issue Event for Issue * @description Issue Event for Issue */ - readonly "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; - /** - * Label - * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). - */ - readonly label: { - /** - * Format: int64 - * @description Unique identifier for the label. - * @example 208045946 - */ - readonly id: number; - /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - * @example https://api.github.com/repositories/42/labels/bug - */ - readonly url: string; - /** - * @description The name of the label. - * @example bug - */ - readonly name: string; - /** - * @description Optional description of the label, such as its purpose. - * @example Something isn't working - */ - readonly description: string | null; - /** - * @description 6-character hex code, without the leading #, identifying the color - * @example FFFFFF - */ - readonly color: string; - /** - * @description Whether this label comes by default in a new repository. - * @example true - */ - readonly default: boolean; - }; + "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; /** * Timeline Comment Event * @description Timeline Comment Event */ - readonly "timeline-comment-event": { - readonly event: string; - readonly actor: components["schemas"]["simple-user"]; + "timeline-comment-event": { + event: string; + actor: components["schemas"]["simple-user"]; /** * @description Unique identifier of the issue comment * @example 42 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - readonly url: string; + url: string; /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - readonly body?: string; - readonly body_text?: string; - readonly body_html?: string; + body?: string; + body_text?: string; + body_html?: string; /** Format: uri */ - readonly html_url: string; - readonly user: components["schemas"]["simple-user"]; + html_url: string; + user: components["schemas"]["simple-user"]; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly issue_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; + issue_url: string; + author_association: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - readonly "timeline-cross-referenced-event": { - readonly event: string; - readonly actor?: components["schemas"]["simple-user"]; + "timeline-cross-referenced-event": { + event: string; + actor?: components["schemas"]["simple-user"]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly source: { - readonly type?: string; - readonly issue?: components["schemas"]["issue"]; + updated_at: string; + source: { + type?: string; + issue?: components["schemas"]["issue"]; }; }; /** * Timeline Committed Event * @description Timeline Committed Event */ - readonly "timeline-committed-event": { - readonly event?: string; + "timeline-committed-event": { + event?: string; /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; - readonly node_id: string; + sha: string; + node_id: string; /** Format: uri */ - readonly url: string; + url: string; /** @description Identifying information for the git-user */ - readonly author: { + author: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** @description Identifying information for the git-user */ - readonly committer: { + committer: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; - readonly tree: { + message: string; + tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly parents: readonly { + parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; }[]; - readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly signature: string | null; - readonly payload: string | null; - readonly verified_at?: string | null; + verification: { + verified: boolean; + reason: string; + signature: string | null; + payload: string | null; + verified_at: string | null; }; /** Format: uri */ - readonly html_url: string; + html_url: string; }; /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - readonly "timeline-reviewed-event": { - readonly event: string; + "timeline-reviewed-event": { + event: string; /** * @description Unique identifier of the review * @example 42 */ - readonly id: number; + id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - readonly node_id: string; - readonly user: components["schemas"]["simple-user"]; + node_id: string; + user: components["schemas"]["simple-user"]; /** * @description The text of the review. * @example This looks great. */ - readonly body: string | null; + body: string | null; /** @example CHANGES_REQUESTED */ - readonly state: string; + state: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - readonly pull_request_url: string; - readonly _links: { - readonly html: { - readonly href: string; + pull_request_url: string; + _links: { + html: { + href: string; }; - readonly pull_request: { - readonly href: string; + pull_request: { + href: string; }; }; /** Format: date-time */ - readonly submitted_at?: string; + submitted_at?: string; + /** Format: date-time */ + updated_at?: string | null; /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - readonly commit_id: string; - readonly body_html?: string; - readonly body_text?: string; - readonly author_association: components["schemas"]["author-association"]; + commit_id: string; + body_html?: string; + body_text?: string; + author_association: components["schemas"]["author-association"]; }; /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - readonly "pull-request-review-comment": { + "pull-request-review-comment": { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly url: string; + url: string; /** * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ - readonly id: number; + id: number; /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - readonly node_id: string; + node_id: string; /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - readonly diff_hunk: string; + diff_hunk: string; /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - readonly path: string; + path: string; /** * @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; + position?: number; /** * @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; + original_position?: number; /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string; + commit_id: string; /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - readonly original_commit_id: string; + original_commit_id: string; /** * @description The comment ID to reply to. * @example 8 */ - readonly in_reply_to_id?: number; - readonly user: components["schemas"]["simple-user"]; + in_reply_to_id?: number; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - readonly body: string; + body: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly pull_request_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly _links: { - readonly self: { + pull_request_url: string; + author_association: components["schemas"]["author-association"]; + _links: { + self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly href: string; + href: string; }; - readonly html: { + html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly href: string; + href: string; }; - readonly pull_request: { + pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly href: string; + href: string; }; }; /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly start_line?: number | null; + start_line?: number | null; /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly original_start_line?: number | null; + original_start_line?: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly line?: number; + line?: number; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly original_line?: number; + original_line?: number; /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; - readonly reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; + reactions?: components["schemas"]["reaction-rollup"]; /** @example "

comment body

" */ - readonly body_html?: string; + body_html?: string; /** @example "comment body" */ - readonly body_text?: string; + body_text?: string; }; /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - readonly "timeline-line-commented-event": { - readonly event?: string; - readonly node_id?: string; - readonly comments?: readonly components["schemas"]["pull-request-review-comment"][]; + "timeline-line-commented-event": { + event?: string; + node_id?: string; + comments?: components["schemas"]["pull-request-review-comment"][]; }; /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - readonly "timeline-commit-commented-event": { - readonly event?: string; - readonly node_id?: string; - readonly commit_id?: string; - readonly comments?: readonly components["schemas"]["commit-comment"][]; + "timeline-commit-commented-event": { + event?: string; + node_id?: string; + commit_id?: string; + comments?: components["schemas"]["commit-comment"][]; }; /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - readonly "timeline-assigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; + "timeline-assigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + assignee: components["schemas"]["simple-user"]; }; /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - readonly "timeline-unassigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; + "timeline-unassigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + assignee: components["schemas"]["simple-user"]; }; /** * State Change Issue Event * @description State Change Issue Event */ - readonly "state-change-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly state_reason?: string | null; + "state-change-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + state_reason?: string | null; }; /** * Timeline Event * @description Timeline Event */ - readonly "timeline-issue-events": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"] | components["schemas"]["timeline-comment-event"] | components["schemas"]["timeline-cross-referenced-event"] | components["schemas"]["timeline-committed-event"] | components["schemas"]["timeline-reviewed-event"] | components["schemas"]["timeline-line-commented-event"] | components["schemas"]["timeline-commit-commented-event"] | components["schemas"]["timeline-assigned-issue-event"] | components["schemas"]["timeline-unassigned-issue-event"] | components["schemas"]["state-change-issue-event"]; + "timeline-issue-events": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"] | components["schemas"]["timeline-comment-event"] | components["schemas"]["timeline-cross-referenced-event"] | components["schemas"]["timeline-committed-event"] | components["schemas"]["timeline-reviewed-event"] | components["schemas"]["timeline-line-commented-event"] | components["schemas"]["timeline-commit-commented-event"] | components["schemas"]["timeline-assigned-issue-event"] | components["schemas"]["timeline-unassigned-issue-event"] | components["schemas"]["state-change-issue-event"]; /** * Deploy Key * @description An SSH key granting access to a single repository. */ - readonly "deploy-key": { - readonly id: number; - readonly key: string; - readonly url: string; - readonly title: string; - readonly verified: boolean; - readonly created_at: string; - readonly read_only: boolean; - readonly added_by?: string | null; - readonly last_used?: string | null; - readonly enabled?: boolean; + "deploy-key": { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; + added_by?: string | null; + /** Format: date-time */ + last_used?: string | null; + enabled?: boolean; }; /** * Language * @description Language */ - readonly language: { - readonly [key: string]: number; + language: { + [key: string]: number; }; /** * License Content * @description License Content */ - readonly "license-content": { - readonly name: string; - readonly path: string; - readonly sha: string; - readonly size: number; + "license-content": { + name: string; + path: string; + sha: string; + size: number; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly type: string; - readonly content: string; - readonly encoding: string; - readonly _links: { + download_url: string | null; + type: string; + content: string; + encoding: string; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; - readonly license: components["schemas"]["nullable-license-simple"]; + license: components["schemas"]["nullable-license-simple"]; }; /** * Merged upstream * @description Results of a successful merge upstream request */ - readonly "merged-upstream": { - readonly message?: string; + "merged-upstream": { + message?: string; /** @enum {string} */ - readonly merge_type?: "merge" | "fast-forward" | "none"; - readonly base_branch?: string; + merge_type?: "merge" | "fast-forward" | "none"; + base_branch?: string; }; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - readonly labels_url: string; + labels_url: string; /** @example 1002604 */ - readonly id: number; + id: number; /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - readonly node_id: string; + node_id: string; /** * @description The number of the milestone. * @example 42 */ - readonly number: number; + number: number; /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** * @description The title of the milestone. * @example v1.0 */ - readonly title: string; + title: string; /** @example Tracking milestone for version 1.0 */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ - readonly open_issues: number; + open_issues: number; /** @example 8 */ - readonly closed_issues: number; + closed_issues: number; /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - readonly closed_at: string | null; + closed_at: string | null; /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - readonly due_on: string | null; + due_on: string | null; }; /** Pages Source Hash */ - readonly "pages-source-hash": { - readonly branch: string; - readonly path: string; + "pages-source-hash": { + branch: string; + path: string; }; /** Pages Https Certificate */ - readonly "pages-https-certificate": { + "pages-https-certificate": { /** * @example approved * @enum {string} */ - readonly state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed"; + state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed"; /** @example Certificate is approved */ - readonly description: string; + description: string; /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ @@ -32550,1091 +35496,852 @@ export type components = { * "www.example.com" * ] */ - readonly domains: readonly string[]; + domains: string[]; /** Format: date */ - readonly expires_at?: string; + expires_at?: string; }; /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. */ - readonly page: { + page: { /** * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - readonly url: string; + url: string; /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - readonly status: "built" | "building" | "errored" | null; + status: "built" | "building" | "errored" | null; /** * @description The Pages site's custom domain * @example example.com */ - readonly cname: string | null; + cname: string | null; /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - readonly protected_domain_state?: "pending" | "verified" | "unverified" | null; + protected_domain_state?: "pending" | "verified" | "unverified" | null; /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - readonly pending_domain_unverified_at?: string | null; + pending_domain_unverified_at?: string | null; /** * @description Whether the Page has a custom 404 page. * @default false * @example false */ - readonly custom_404: boolean; + custom_404: boolean; /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - readonly html_url?: string; + html_url?: string; /** * @description The process in which the Page will be built. * @example legacy * @enum {string|null} */ - readonly build_type?: "legacy" | "workflow" | null; - readonly source?: components["schemas"]["pages-source-hash"]; + build_type?: "legacy" | "workflow" | null; + source?: components["schemas"]["pages-source-hash"]; /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - readonly public: boolean; - readonly https_certificate?: components["schemas"]["pages-https-certificate"]; + public: boolean; + https_certificate?: components["schemas"]["pages-https-certificate"]; /** * @description Whether https is enabled on the domain * @example true */ - readonly https_enforced?: boolean; + https_enforced?: boolean; }; /** * Page Build * @description Page Build */ - readonly "page-build": { + "page-build": { /** Format: uri */ - readonly url: string; - readonly status: string; - readonly error: { - readonly message: string | null; - }; - readonly pusher: components["schemas"]["nullable-simple-user"]; - readonly commit: string; - readonly duration: number; + url: string; + status: string; + error: { + message: string | null; + }; + pusher: components["schemas"]["nullable-simple-user"]; + commit: string; + duration: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Page Build Status * @description Page Build Status */ - readonly "page-build-status": { + "page-build-status": { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - readonly url: string; + url: string; /** @example queued */ - readonly status: string; + status: string; }; /** * GitHub Pages * @description The GitHub Pages deployment status. */ - readonly "page-deployment": { + "page-deployment": { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ - readonly id: number | string; + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ - readonly status_url: string; + status_url: string; /** * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io */ - readonly page_url: string; + page_url: string; /** * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io */ - readonly preview_url?: string; + preview_url?: string; }; /** GitHub Pages deployment status */ - readonly "pages-deployment-status": { + "pages-deployment-status": { /** * @description The current status of the deployment. * @enum {string} */ - readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; }; /** * Pages Health Check Status * @description Pages Health Check Status */ - readonly "pages-health-check": { - readonly domain?: { - readonly host?: string; - readonly uri?: string; - readonly nameservers?: string; - readonly dns_resolves?: boolean; - readonly is_proxied?: boolean | null; - readonly is_cloudflare_ip?: boolean | null; - readonly is_fastly_ip?: boolean | null; - readonly is_old_ip_address?: boolean | null; - readonly is_a_record?: boolean | null; - readonly has_cname_record?: boolean | null; - readonly has_mx_records_present?: boolean | null; - readonly is_valid_domain?: boolean; - readonly is_apex_domain?: boolean; - readonly should_be_a_record?: boolean | null; - readonly is_cname_to_github_user_domain?: boolean | null; - readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; - readonly is_cname_to_fastly?: boolean | null; - readonly is_pointed_to_github_pages_ip?: boolean | null; - readonly is_non_github_pages_ip_present?: boolean | null; - readonly is_pages_domain?: boolean; - readonly is_served_by_pages?: boolean | null; - readonly is_valid?: boolean; - readonly reason?: string | null; - readonly responds_to_https?: boolean; - readonly enforces_https?: boolean; - readonly https_error?: string | null; - readonly is_https_eligible?: boolean | null; - readonly caa_error?: string | null; - }; - readonly alt_domain?: { - readonly host?: string; - readonly uri?: string; - readonly nameservers?: string; - readonly dns_resolves?: boolean; - readonly is_proxied?: boolean | null; - readonly is_cloudflare_ip?: boolean | null; - readonly is_fastly_ip?: boolean | null; - readonly is_old_ip_address?: boolean | null; - readonly is_a_record?: boolean | null; - readonly has_cname_record?: boolean | null; - readonly has_mx_records_present?: boolean | null; - readonly is_valid_domain?: boolean; - readonly is_apex_domain?: boolean; - readonly should_be_a_record?: boolean | null; - readonly is_cname_to_github_user_domain?: boolean | null; - readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; - readonly is_cname_to_fastly?: boolean | null; - readonly is_pointed_to_github_pages_ip?: boolean | null; - readonly is_non_github_pages_ip_present?: boolean | null; - readonly is_pages_domain?: boolean; - readonly is_served_by_pages?: boolean | null; - readonly is_valid?: boolean; - readonly reason?: string | null; - readonly responds_to_https?: boolean; - readonly enforces_https?: boolean; - readonly https_error?: string | null; - readonly is_https_eligible?: boolean | null; - readonly caa_error?: string | null; + "pages-health-check": { + domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; + }; + alt_domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; } | null; }; /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - readonly "pull-request": { + "pull-request": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - readonly url: string; + url: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - readonly diff_url: string; + diff_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - readonly patch_url: string; + patch_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly issue_url: string; + issue_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - readonly commits_url: string; + commits_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - readonly review_comments_url: string; + review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - readonly review_comment_url: string; + review_comment_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - readonly comments_url: string; + comments_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly statuses_url: string; + statuses_url: string; /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - readonly number: number; + number: number; /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @example true */ - readonly locked: boolean; + locked: boolean; /** * @description The title of the pull request. * @example Amazing new feature */ - readonly title: string; - readonly user: components["schemas"]["simple-user"]; + title: string; + user: components["schemas"]["simple-user"]; /** @example Please pull these awesome changes */ - readonly body: string | null; - readonly labels: readonly { + body: string | null; + labels: { /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly name: string; - readonly description: string | null; - readonly color: string; - readonly default: boolean; + id: number; + node_id: string; + url: string; + name: string; + description: string | null; + color: string; + default: boolean; }[]; - readonly milestone: components["schemas"]["nullable-milestone"]; + milestone: components["schemas"]["nullable-milestone"]; /** @example too heated */ - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly closed_at: string | null; + closed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly merged_at: string | null; + merged_at: string | null; /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - readonly merge_commit_sha: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_teams?: readonly components["schemas"]["team-simple"][] | null; - readonly head: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["simple-user"]; - }; - readonly base: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["simple-user"]; - }; - readonly _links: { - readonly comments: components["schemas"]["link"]; - readonly commits: components["schemas"]["link"]; - readonly statuses: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly issue: components["schemas"]["link"]; - readonly review_comments: components["schemas"]["link"]; - readonly review_comment: components["schemas"]["link"]; - readonly self: components["schemas"]["link"]; - }; - readonly author_association: components["schemas"]["author-association"]; - readonly auto_merge: components["schemas"]["auto-merge"]; + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team-simple"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; /** * @description Indicates whether or not the pull request is a draft. * @example false */ - readonly draft?: boolean; - readonly merged: boolean; + draft?: boolean; + merged: boolean; /** @example true */ - readonly mergeable: boolean | null; + mergeable: boolean | null; /** @example true */ - readonly rebaseable?: boolean | null; + rebaseable?: boolean | null; /** @example clean */ - readonly mergeable_state: string; - readonly merged_by: components["schemas"]["nullable-simple-user"]; + mergeable_state: string; + merged_by: components["schemas"]["nullable-simple-user"]; /** @example 10 */ - readonly comments: number; + comments: number; /** @example 0 */ - readonly review_comments: number; + review_comments: number; /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - readonly maintainer_can_modify: boolean; + maintainer_can_modify: boolean; /** @example 3 */ - readonly commits: number; + commits: number; /** @example 100 */ - readonly additions: number; + additions: number; /** @example 3 */ - readonly deletions: number; + deletions: number; /** @example 5 */ - readonly changed_files: number; + changed_files: number; }; /** * Pull Request Merge Result * @description Pull Request Merge Result */ - readonly "pull-request-merge-result": { - readonly sha: string; - readonly merged: boolean; - readonly message: string; + "pull-request-merge-result": { + sha: string; + merged: boolean; + message: string; }; /** * Pull Request Review Request * @description Pull Request Review Request */ - readonly "pull-request-review-request": { - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; + "pull-request-review-request": { + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; }; /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - readonly "pull-request-review": { + "pull-request-review": { /** * Format: int64 * @description Unique identifier of the review * @example 42 */ - readonly id: number; + id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + node_id: string; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the review. * @example This looks great. */ - readonly body: string; + body: string; /** @example CHANGES_REQUESTED */ - readonly state: string; + state: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - readonly pull_request_url: string; - readonly _links: { - readonly html: { - readonly href: string; + pull_request_url: string; + _links: { + html: { + href: string; }; - readonly pull_request: { - readonly href: string; + pull_request: { + href: string; }; }; /** Format: date-time */ - readonly submitted_at?: string; + submitted_at?: string; /** * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - readonly commit_id: string | null; - readonly body_html?: string; - readonly body_text?: string; - readonly author_association: components["schemas"]["author-association"]; + commit_id: string | null; + body_html?: string; + body_text?: string; + author_association: components["schemas"]["author-association"]; }; /** * Legacy Review Comment * @description Legacy Review Comment */ - readonly "review-comment": { + "review-comment": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly url: string; + url: string; /** * Format: int64 * @example 42 */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: int64 * @example 10 */ - readonly id: number; + id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - readonly node_id: string; + node_id: string; /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - readonly diff_hunk: string; + diff_hunk: string; /** @example file1.txt */ - readonly path: string; + path: string; /** @example 1 */ - readonly position: number | null; + position: number | null; /** @example 4 */ - readonly original_position: number; + original_position: number; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string; + commit_id: string; /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - readonly original_commit_id: string; + original_commit_id: string; /** @example 8 */ - readonly in_reply_to_id?: number; - readonly user: components["schemas"]["nullable-simple-user"]; + in_reply_to_id?: number; + user: components["schemas"]["nullable-simple-user"]; /** @example Great stuff */ - readonly body: string; + body: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly pull_request_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly _links: { - readonly self: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly pull_request: components["schemas"]["link"]; + pull_request_url: string; + author_association: components["schemas"]["author-association"]; + _links: { + self: components["schemas"]["link"]; + html: components["schemas"]["link"]; + pull_request: components["schemas"]["link"]; }; - readonly body_text?: string; - readonly body_html?: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; + body_text?: string; + body_html?: string; + reactions?: components["schemas"]["reaction-rollup"]; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly line?: number; + line?: number; /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly original_line?: number; + original_line?: number; /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly start_line?: number | null; + start_line?: number | null; /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - readonly original_start_line?: number | null; - }; - /** - * Release Asset - * @description Data related to a release. - */ - readonly "release-asset": { - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly browser_download_url: string; - readonly id: number; - readonly node_id: string; - /** - * @description The file name of the asset. - * @example Team Environment - */ - readonly name: string; - readonly label: string | null; + original_start_line?: number | null; /** - * @description State of the release asset. + * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly state: "uploaded" | "open"; - readonly content_type: string; - readonly size: number; - readonly download_count: number; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly uploader: components["schemas"]["nullable-simple-user"]; - }; - /** - * Release - * @description A release. - */ - readonly release: { - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly html_url: string; - /** Format: uri */ - readonly assets_url: string; - readonly upload_url: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** Format: uri */ - readonly zipball_url: string | null; - readonly id: number; - readonly node_id: string; - /** - * @description The name of the tag. - * @example v1.0.0 - */ - readonly tag_name: string; - /** - * @description Specifies the commitish value that determines where the Git tag is created from. - * @example master - */ - readonly target_commitish: string; - readonly name: string | null; - readonly body?: string | null; - /** - * @description true to create a draft (unpublished) release, false to create a published one. - * @example false - */ - readonly draft: boolean; - /** - * @description Whether to identify the release as a prerelease or a full release. - * @example false - */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly published_at: string | null; - readonly author: components["schemas"]["simple-user"]; - readonly assets: readonly components["schemas"]["release-asset"][]; - readonly body_html?: string; - readonly body_text?: string; - readonly mentions_count?: number; - /** - * Format: uri - * @description The URL of the release discussion. - */ - readonly discussion_url?: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; }; /** * Generated Release Notes Content * @description Generated name and body describing a release */ - readonly "release-notes-content": { + "release-notes-content": { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - readonly name: string; + name: string; /** @description The generated body describing the contents of the release supporting markdown formatting */ - readonly body: string; + body: string; }; /** * repository ruleset data for rule * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ - readonly "repository-rule-ruleset-info": { + "repository-rule-ruleset-info": { /** * @description The type of source for the ruleset that includes this rule. * @enum {string} */ - readonly ruleset_source_type?: "Repository" | "Organization"; + ruleset_source_type?: "Repository" | "Organization"; /** @description The name of the source of the ruleset that includes this rule. */ - readonly ruleset_source?: string; + ruleset_source?: string; /** @description The ID of the ruleset that includes this rule. */ - readonly ruleset_id?: number; + ruleset_id?: number; }; /** * Repository Rule * @description A repository rule with ruleset details. */ - readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); - readonly "secret-scanning-alert": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]); + "secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - readonly locations_url?: string; - readonly state?: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment to resolve an alert. */ - readonly resolution_comment?: string | null; + resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ - readonly secret_type_display_name?: string; + secret_type_display_name?: string; /** @description The secret that was detected. */ - readonly secret?: string; + secret?: string; /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly push_protection_bypassed_at?: string | null; - readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment when reviewing a push protection bypass. */ - readonly push_protection_bypass_request_reviewer_comment?: string | null; + push_protection_bypass_request_reviewer_comment?: string | null; /** @description An optional comment when requesting a push protection bypass. */ - readonly push_protection_bypass_request_comment?: string | null; + push_protection_bypass_request_comment?: string | null; /** * Format: uri * @description The URL to a push protection bypass request. */ - readonly push_protection_bypass_request_html_url?: string | null; + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ - readonly validity?: "active" | "inactive" | "unknown"; + validity?: "active" | "inactive" | "unknown"; /** @description Whether the detected secret was publicly leaked. */ - readonly publicly_leaked?: boolean | null; + 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; - /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - readonly "secret-scanning-location-commit": { - /** - * @description The file path in the repository - * @example /example/secrets.txt - */ - readonly path: string; - /** @description Line number at which the secret starts in the file */ - readonly start_line: number; - /** @description Line number at which the secret ends in the file */ - readonly end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - readonly start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - readonly end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - readonly blob_sha: string; - /** @description The API URL to get the associated blob resource */ - readonly blob_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - readonly commit_sha: string; - /** @description The API URL to get the associated commit resource */ - readonly commit_url: string; - }; - /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ - readonly "secret-scanning-location-wiki-commit": { - /** - * @description The file path of the wiki page - * @example /example/Home.md - */ - readonly path: string; - /** @description Line number at which the secret starts in the file */ - readonly start_line: number; - /** @description Line number at which the secret ends in the file */ - readonly end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ - readonly start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ - readonly end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - readonly blob_sha: string; - /** - * @description The GitHub URL to get the associated wiki page - * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - readonly page_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - readonly commit_sha: string; - /** - * @description The GitHub URL to get the associated wiki commit - * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - readonly commit_url: string; - }; - /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ - readonly "secret-scanning-location-issue-title": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - readonly issue_title_url: string; - }; - /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ - readonly "secret-scanning-location-issue-body": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - readonly issue_body_url: string; - }; - /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ - readonly "secret-scanning-location-issue-comment": { - /** - * Format: uri - * @description The API URL to get the issue comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - readonly issue_comment_url: string; - }; - /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ - readonly "secret-scanning-location-discussion-title": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082 - */ - readonly discussion_title_url: string; - }; - /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ - readonly "secret-scanning-location-discussion-body": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussion-4566270 - */ - readonly discussion_body_url: string; - }; - /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ - readonly "secret-scanning-location-discussion-comment": { - /** - * Format: uri - * @description The API URL to get the discussion comment where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 - */ - readonly discussion_comment_url: string; - }; - /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ - readonly "secret-scanning-location-pull-request-title": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - readonly pull_request_title_url: string; - }; - /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ - readonly "secret-scanning-location-pull-request-body": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - readonly pull_request_body_url: string; - }; - /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ - readonly "secret-scanning-location-pull-request-comment": { - /** - * Format: uri - * @description The API URL to get the pull request comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - readonly pull_request_comment_url: string; - }; - /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ - readonly "secret-scanning-location-pull-request-review": { - /** - * Format: uri - * @description The API URL to get the pull request review where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - */ - readonly pull_request_review_url: string; - }; - /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ - readonly "secret-scanning-location-pull-request-review-comment": { - /** - * Format: uri - * @description The API URL to get the pull request review comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - */ - readonly pull_request_review_comment_url: string; - }; - readonly "secret-scanning-location": { + multi_repo?: boolean | null; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */ + "secret-scanning-alert-resolution-comment": string | null; + /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */ + "secret-scanning-alert-assignee": string | null; + "secret-scanning-location": { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; + type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; /** * @description The reason for bypassing push protection. * @enum {string} */ - readonly "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; - readonly "secret-scanning-push-protection-bypass": { - readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** * Format: date-time * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly expire_at?: string | null; + expire_at?: string | null; /** @description The token type this bypass is for. */ - readonly token_type?: string; + token_type?: string; }; /** @description Information on a single scan performed by secret scanning on the repository */ - readonly "secret-scanning-scan": { + "secret-scanning-scan": { /** @description The type of scan */ - readonly type?: string; + type?: string; /** @description The state of the scan. Either "completed", "running", or "pending" */ - readonly status?: string; + status?: string; /** * Format: date-time * @description The time that the scan was completed. Empty if the scan is running */ - readonly completed_at?: string | null; + completed_at?: string | null; /** * Format: date-time * @description The time that the scan was started. Empty if the scan is pending */ - readonly started_at?: string | null; + started_at?: string | null; }; - readonly "secret-scanning-scan-history": { - readonly incremental_scans?: readonly components["schemas"]["secret-scanning-scan"][]; - readonly pattern_update_scans?: readonly components["schemas"]["secret-scanning-scan"][]; - readonly backfill_scans?: readonly components["schemas"]["secret-scanning-scan"][]; - readonly custom_pattern_backfill_scans?: readonly (components["schemas"]["secret-scanning-scan"] & { + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { /** @description Name of the custom pattern for custom pattern scans */ - readonly pattern_name?: string; + pattern_name?: string; /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ - readonly pattern_scope?: string; + pattern_scope?: string; })[]; }; - readonly "repository-advisory-create": { + "repository-advisory-create": { /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory impacts. */ - readonly description: string; + description: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id?: string | null; + cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly vulnerabilities: readonly { + vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name?: string | null; + name?: string | null; }; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range?: string | null; + vulnerable_version_range?: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions?: string | null; + patched_versions?: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions?: readonly string[] | null; + vulnerable_functions?: string[] | null; }[]; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - readonly cwe_ids?: readonly string[] | null; + cwe_ids?: string[] | null; /** @description A list of users receiving credit for their participation in the security advisory. */ - readonly credits?: readonly { + credits?: { /** @description The username of the user credited. */ - readonly login: string; - readonly type: components["schemas"]["security-advisory-credit-types"]; + login: string; + type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - readonly severity?: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - readonly cvss_vector_string?: string | null; + cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - readonly start_private_fork: boolean; + start_private_fork: boolean; }; - readonly "private-vulnerability-report-create": { + "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory impacts. */ - readonly description: string; + description: string; /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ - readonly vulnerabilities?: readonly { + vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name?: string | null; + name?: string | null; }; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range?: string | null; + vulnerable_version_range?: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions?: string | null; + patched_versions?: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions?: readonly string[] | null; + vulnerable_functions?: string[] | null; }[] | null; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - readonly cwe_ids?: readonly string[] | null; + cwe_ids?: string[] | null; /** * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - readonly severity?: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - readonly cvss_vector_string?: string | null; + cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - readonly start_private_fork: boolean; + start_private_fork: boolean; }; - readonly "repository-advisory-update": { + "repository-advisory-update": { /** @description A short summary of the advisory. */ - readonly summary?: string; + summary?: string; /** @description A detailed description of what the advisory impacts. */ - readonly description?: string; + description?: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id?: string | null; + cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly vulnerabilities?: readonly { + vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name?: string | null; + name?: string | null; }; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range?: string | null; + vulnerable_version_range?: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions?: string | null; + patched_versions?: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions?: readonly string[] | null; + vulnerable_functions?: string[] | null; }[]; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - readonly cwe_ids?: readonly string[] | null; + cwe_ids?: string[] | null; /** @description A list of users receiving credit for their participation in the security advisory. */ - readonly credits?: readonly { + credits?: { /** @description The username of the user credited. */ - readonly login: string; - readonly type: components["schemas"]["security-advisory-credit-types"]; + login: string; + type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - readonly severity?: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - readonly cvss_vector_string?: string | null; + cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ - readonly state?: "published" | "closed" | "draft"; + state?: "published" | "closed" | "draft"; /** @description A list of usernames who have been granted write access to the advisory. */ - readonly collaborating_users?: readonly string[] | null; + collaborating_users?: string[] | null; /** @description A list of team slugs which have been granted write access to the advisory. */ - readonly collaborating_teams?: readonly string[] | null; + collaborating_teams?: string[] | null; }; /** * Stargazer * @description Stargazer */ - readonly stargazer: { + stargazer: { /** Format: date-time */ - readonly starred_at: string; - readonly user: components["schemas"]["nullable-simple-user"]; + starred_at: string; + user: components["schemas"]["nullable-simple-user"]; }; /** * Code Frequency Stat * @description Code Frequency Stat */ - readonly "code-frequency-stat": readonly number[]; + "code-frequency-stat": number[]; /** * Commit Activity * @description Commit Activity */ - readonly "commit-activity": { + "commit-activity": { /** * @example [ * 0, @@ -33646,20 +36353,20 @@ export type components = { * 0 * ] */ - readonly days: readonly number[]; + days: number[]; /** @example 89 */ - readonly total: number; + total: number; /** @example 1336280400 */ - readonly week: number; + week: number; }; /** * Contributor Activity * @description Contributor Activity */ - readonly "contributor-activity": { - readonly author: components["schemas"]["nullable-simple-user"]; + "contributor-activity": { + author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ - readonly total: number; + total: number; /** * @example [ * { @@ -33670,486 +36377,475 @@ export type components = { * } * ] */ - readonly weeks: readonly { - readonly w?: number; - readonly a?: number; - readonly d?: number; - readonly c?: number; + weeks: { + w?: number; + a?: number; + d?: number; + c?: number; }[]; }; /** Participation Stats */ - readonly "participation-stats": { - readonly all: readonly number[]; - readonly owner: readonly number[]; + "participation-stats": { + all: number[]; + owner: number[]; }; /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - readonly "repository-subscription": { + "repository-subscription": { /** * @description Determines if notifications should be received from this repository. * @example true */ - readonly subscribed: boolean; + subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ - readonly ignored: boolean; - readonly reason: string | null; + ignored: boolean; + reason: string | null; /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - readonly created_at: string; + created_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; }; /** * Tag * @description Tag */ - readonly tag: { + tag: { /** @example v0.1 */ - readonly name: string; - readonly commit: { - readonly sha: string; + name: string; + commit: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - readonly zipball_url: string; + zipball_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - readonly tarball_url: string; - readonly node_id: string; - }; - /** - * Tag protection - * @description Tag protection - */ - readonly "tag-protection": { - /** @example 2 */ - readonly id?: number; - /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; - /** @example 2011-01-26T19:01:12Z */ - readonly updated_at?: string; - /** @example true */ - readonly enabled?: boolean; - /** @example v1.* */ - readonly pattern: string; + tarball_url: string; + node_id: string; }; /** * Topic * @description A topic aggregates entities that are related to a subject. */ - readonly topic: { - readonly names: readonly string[]; + topic: { + names: string[]; }; /** Traffic */ - readonly traffic: { + traffic: { /** Format: date-time */ - readonly timestamp: string; - readonly uniques: number; - readonly count: number; + timestamp: string; + uniques: number; + count: number; }; /** * Clone Traffic * @description Clone Traffic */ - readonly "clone-traffic": { + "clone-traffic": { /** @example 173 */ - readonly count: number; + count: number; /** @example 128 */ - readonly uniques: number; - readonly clones: readonly components["schemas"]["traffic"][]; + uniques: number; + clones: components["schemas"]["traffic"][]; }; /** * Content Traffic * @description Content Traffic */ - readonly "content-traffic": { + "content-traffic": { /** @example /github/hubot */ - readonly path: string; + path: string; /** @example github/hubot: A customizable life embetterment robot. */ - readonly title: string; + title: string; /** @example 3542 */ - readonly count: number; + count: number; /** @example 2225 */ - readonly uniques: number; + uniques: number; }; /** * Referrer Traffic * @description Referrer Traffic */ - readonly "referrer-traffic": { + "referrer-traffic": { /** @example Google */ - readonly referrer: string; + referrer: string; /** @example 4 */ - readonly count: number; + count: number; /** @example 3 */ - readonly uniques: number; + uniques: number; }; /** * View Traffic * @description View Traffic */ - readonly "view-traffic": { + "view-traffic": { /** @example 14850 */ - readonly count: number; + count: number; /** @example 3782 */ - readonly uniques: number; - readonly views: readonly components["schemas"]["traffic"][]; + uniques: number; + views: components["schemas"]["traffic"][]; }; /** Search Result Text Matches */ - readonly "search-result-text-matches": readonly { - readonly object_url?: string; - readonly object_type?: string | null; - readonly property?: string; - readonly fragment?: string; - readonly matches?: readonly { - readonly text?: string; - readonly indices?: readonly number[]; + "search-result-text-matches": { + object_url?: string; + object_type?: string | null; + property?: string; + fragment?: string; + matches?: { + text?: string; + indices?: number[]; }[]; }[]; /** * Code Search Result Item * @description Code Search Result Item */ - readonly "code-search-result-item": { - readonly name: string; - readonly path: string; - readonly sha: string; + "code-search-result-item": { + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** Format: uri */ - readonly html_url: string; - readonly repository: components["schemas"]["minimal-repository"]; - readonly score: number; - readonly file_size?: number; - readonly language?: string | null; + html_url: string; + repository: components["schemas"]["minimal-repository"]; + score: number; + file_size?: number; + language?: string | null; /** Format: date-time */ - readonly last_modified_at?: string; + last_modified_at?: string; /** * @example [ * "73..77", * "77..78" * ] */ - readonly line_numbers?: readonly string[]; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + line_numbers?: string[]; + text_matches?: components["schemas"]["search-result-text-matches"]; }; /** * Commit Search Result Item * @description Commit Search Result Item */ - readonly "commit-search-result-item": { + "commit-search-result-item": { /** Format: uri */ - readonly url: string; - readonly sha: string; + url: string; + sha: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly comments_url: string; - readonly commit: { - readonly author: { - readonly name: string; - readonly email: string; + comments_url: string; + commit: { + author: { + name: string; + email: string; /** Format: date-time */ - readonly date: string; + date: string; }; - readonly committer: components["schemas"]["nullable-git-user"]; - readonly comment_count: number; - readonly message: string; - readonly tree: { - readonly sha: string; + committer: components["schemas"]["nullable-git-user"]; + comment_count: number; + message: string; + tree: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly url: string; - readonly verification?: components["schemas"]["verification"]; - }; - readonly author: components["schemas"]["nullable-simple-user"]; - readonly committer: components["schemas"]["nullable-git-user"]; - readonly parents: readonly { - readonly url?: string; - readonly html_url?: string; - readonly sha?: string; + url: string; + verification?: components["schemas"]["verification"]; + }; + author: components["schemas"]["nullable-simple-user"]; + committer: components["schemas"]["nullable-git-user"]; + parents: { + url?: string; + html_url?: string; + sha?: string; }[]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly score: number; - readonly node_id: string; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + repository: components["schemas"]["minimal-repository"]; + score: number; + node_id: string; + text_matches?: components["schemas"]["search-result-text-matches"]; }; /** * Issue Search Result Item * @description Issue Search Result Item */ - readonly "issue-search-result-item": { + "issue-search-result-item": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + repository_url: string; + labels_url: string; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly title: string; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly user: components["schemas"]["nullable-simple-user"]; - readonly labels: readonly { + id: number; + node_id: string; + number: number; + title: string; + locked: boolean; + active_lock_reason?: string | null; + assignees?: components["schemas"]["simple-user"][] | null; + user: components["schemas"]["nullable-simple-user"]; + labels: { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly name?: string; - readonly color?: string; - readonly default?: boolean; - readonly description?: string | null; + id?: number; + node_id?: string; + url?: string; + name?: string; + color?: string; + default?: boolean; + description?: string | null; }[]; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; - readonly state: string; - readonly state_reason?: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly comments: number; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + state: string; + state_reason?: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + milestone: components["schemas"]["nullable-milestone"]; + comments: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly closed_at: string | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly pull_request?: { + closed_at: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly diff_url: string | null; + diff_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly patch_url: string | null; + patch_url: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; - readonly body?: string; - readonly score: number; - readonly author_association: components["schemas"]["author-association"]; - readonly draft?: boolean; - readonly repository?: components["schemas"]["repository"]; - readonly body_html?: string; - readonly body_text?: string; + body?: string; + score: number; + author_association: components["schemas"]["author-association"]; + draft?: boolean; + repository?: components["schemas"]["repository"]; + body_html?: string; + body_text?: string; /** Format: uri */ - readonly timeline_url?: string; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Label Search Result Item * @description Label Search Result Item */ - readonly "label-search-result-item": { - readonly id: number; - readonly node_id: string; + "label-search-result-item": { + id: number; + node_id: string; /** Format: uri */ - readonly url: string; - readonly name: string; - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly score: number; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + url: string; + name: string; + color: string; + default: boolean; + description: string | null; + score: number; + text_matches?: components["schemas"]["search-result-text-matches"]; }; /** * Repo Search Result Item * @description Repo Search Result Item */ - readonly "repo-search-result-item": { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly full_name: string; - readonly owner: components["schemas"]["nullable-simple-user"]; - readonly private: boolean; + "repo-search-result-item": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["nullable-simple-user"]; + private: boolean; /** Format: uri */ - readonly html_url: string; - readonly description: string | null; - readonly fork: boolean; + html_url: string; + description: string | null; + fork: boolean; /** Format: uri */ - readonly url: string; + url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly pushed_at: string; + pushed_at: string; /** Format: uri */ - readonly homepage: string | null; - readonly size: number; - readonly stargazers_count: number; - readonly watchers_count: number; - readonly language: string | null; - readonly forks_count: number; - readonly open_issues_count: number; - readonly master_branch?: string; - readonly default_branch: string; - readonly score: number; + homepage: string | null; + size: number; + stargazers_count: number; + watchers_count: number; + language: string | null; + forks_count: number; + open_issues_count: number; + master_branch?: string; + default_branch: string; + score: number; /** Format: uri */ - readonly forks_url: string; - readonly keys_url: string; - readonly collaborators_url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri */ - readonly hooks_url: string; - readonly issue_events_url: string; + hooks_url: string; + issue_events_url: string; /** Format: uri */ - readonly events_url: string; - readonly assignees_url: string; - readonly branches_url: string; + events_url: string; + assignees_url: string; + branches_url: string; /** Format: uri */ - readonly tags_url: string; - readonly blobs_url: string; - readonly git_tags_url: string; - readonly git_refs_url: string; - readonly trees_url: string; - readonly statuses_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; - readonly commits_url: string; - readonly git_commits_url: string; - readonly comments_url: string; - readonly issue_comment_url: string; - readonly contents_url: string; - readonly compare_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; /** Format: uri */ - readonly merges_url: string; - readonly archive_url: string; + merges_url: string; + archive_url: string; /** Format: uri */ - readonly downloads_url: string; - readonly issues_url: string; - readonly pulls_url: string; - readonly milestones_url: string; - readonly notifications_url: string; - readonly labels_url: string; - readonly releases_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly git_url: string; - readonly ssh_url: string; - readonly clone_url: string; + deployments_url: string; + git_url: string; + ssh_url: string; + clone_url: string; /** Format: uri */ - readonly svn_url: string; - readonly forks: number; - readonly open_issues: number; - readonly watchers: number; - readonly topics?: readonly string[]; + svn_url: string; + forks: number; + open_issues: number; + watchers: number; + topics?: string[]; /** Format: uri */ - readonly mirror_url: string | null; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_pages: boolean; - readonly has_wiki: boolean; - readonly has_downloads: boolean; - readonly has_discussions?: boolean; - readonly archived: boolean; + mirror_url: string | null; + has_issues: boolean; + has_projects: boolean; + has_pages: boolean; + has_wiki: boolean; + has_downloads: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_forking?: boolean; - readonly is_template?: boolean; + visibility?: string; + license: components["schemas"]["nullable-license-simple"]; + permissions?: { + admin: boolean; + maintain?: boolean; + push: boolean; + triage?: boolean; + pull: boolean; + }; + text_matches?: components["schemas"]["search-result-text-matches"]; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_forking?: boolean; + is_template?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; /** * Topic Search Result Item * @description Topic Search Result Item */ - readonly "topic-search-result-item": { - readonly name: string; - readonly display_name: string | null; - readonly short_description: string | null; - readonly description: string | null; - readonly created_by: string | null; - readonly released: string | null; + "topic-search-result-item": { + name: string; + display_name: string | null; + short_description: string | null; + description: string | null; + created_by: string | null; + released: string | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly featured: boolean; - readonly curated: boolean; - readonly score: number; - readonly repository_count?: number | null; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; + repository_count?: number | null; /** Format: uri */ - readonly logo_url?: string | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly related?: readonly { - readonly topic_relation?: { - readonly id?: number; - readonly name?: string; - readonly topic_id?: number; - readonly relation_type?: string; + logo_url?: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + related?: { + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; }; }[] | null; - readonly aliases?: readonly { - readonly topic_relation?: { - readonly id?: number; - readonly name?: string; - readonly topic_id?: number; - readonly relation_type?: string; + aliases?: { + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; }; }[] | null; }; @@ -34157,466 +36853,466 @@ export type components = { * User Search Result Item * @description User Search Result Item */ - readonly "user-search-result-item": { - readonly login: string; + "user-search-result-item": { + login: string; /** Format: int64 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** Format: uri */ - readonly avatar_url: string; - readonly gravatar_id: string | null; + avatar_url: string; + gravatar_id: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly followers_url: string; + followers_url: string; /** Format: uri */ - readonly subscriptions_url: string; + subscriptions_url: string; /** Format: uri */ - readonly organizations_url: string; + organizations_url: string; /** Format: uri */ - readonly repos_url: string; + repos_url: string; /** Format: uri */ - readonly received_events_url: string; - readonly type: string; - readonly score: number; - readonly following_url: string; - readonly gists_url: string; - readonly starred_url: string; - readonly events_url: string; - readonly public_repos?: number; - readonly public_gists?: number; - readonly followers?: number; - readonly following?: number; + received_events_url: string; + type: string; + score: number; + following_url: string; + gists_url: string; + starred_url: string; + events_url: string; + public_repos?: number; + public_gists?: number; + followers?: number; + following?: number; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; - readonly name?: string | null; - readonly bio?: string | null; + updated_at?: string; + name?: string | null; + bio?: string | null; /** Format: email */ - readonly email?: string | null; - readonly location?: string | null; - readonly site_admin: boolean; - readonly hireable?: boolean | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly blog?: string | null; - readonly company?: string | null; + email?: string | null; + location?: string | null; + site_admin: boolean; + hireable?: boolean | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + blog?: string | null; + company?: string | null; /** Format: date-time */ - readonly suspended_at?: string | null; - readonly user_view_type?: string; + suspended_at?: string | null; + user_view_type?: string; }; /** * Private User * @description Private User */ - readonly "private-user": { + "private-user": { /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly user_view_type: "private"; + user_view_type: "private"; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example monalisa octocat */ - readonly name: string | null; + name: string | null; /** @example GitHub */ - readonly company: string | null; + company: string | null; /** @example https://github.com/blog */ - readonly blog: string | null; + blog: string | null; /** @example San Francisco */ - readonly location: string | null; + location: string | null; /** * Format: email * @example octocat@github.com */ - readonly email: string | null; + email: string | null; /** * Format: email * @example octocat@github.com */ - readonly notification_email?: string | null; - readonly hireable: boolean | null; + notification_email?: string | null; + hireable: boolean | null; /** @example There once was... */ - readonly bio: string | null; + bio: string | null; /** @example monalisa */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** @example 2 */ - readonly public_repos: number; + public_repos: number; /** @example 1 */ - readonly public_gists: number; + public_gists: number; /** @example 20 */ - readonly followers: number; + followers: number; /** @example 0 */ - readonly following: number; + following: number; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly updated_at: string; + updated_at: string; /** @example 81 */ - readonly private_gists: number; + private_gists: number; /** @example 100 */ - readonly total_private_repos: number; + total_private_repos: number; /** @example 100 */ - readonly owned_private_repos: number; + owned_private_repos: number; /** @example 10000 */ - readonly disk_usage: number; + disk_usage: number; /** @example 8 */ - readonly collaborators: number; + collaborators: number; /** @example true */ - readonly two_factor_authentication: boolean; - readonly plan?: { - readonly collaborators: number; - readonly name: string; - readonly space: number; - readonly private_repos: number; + two_factor_authentication: boolean; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; }; - readonly business_plus?: boolean; - readonly ldap_dn?: string; + business_plus?: boolean; + ldap_dn?: string; }; /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - readonly "codespaces-secret": { + "codespaces-secret": { /** * @description The name of the secret * @example SECRET_NAME */ - readonly name: string; + name: string; /** * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at: string; + updated_at: string; /** * @description The type of repositories in the organization that the secret is visible to * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - readonly selected_repositories_url: string; + selected_repositories_url: string; }; /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - readonly "codespaces-user-public-key": { + "codespaces-user-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; }; /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - readonly "codespace-export-details": { + "codespace-export-details": { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - readonly state?: string | null; + state?: string | null; /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - readonly completed_at?: string | null; + completed_at?: string | null; /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - readonly branch?: string | null; + branch?: string | null; /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - readonly sha?: string | null; + sha?: string | null; /** * @description Id for the export details * @example latest */ - readonly id?: string; + id?: string; /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - readonly export_url?: string; + export_url?: string; /** * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ - readonly html_url?: string | null; + html_url?: string | null; }; /** * Codespace * @description A codespace. */ - readonly "codespace-with-full-repository": { + "codespace-with-full-repository": { /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - readonly name: string; + name: string; /** * @description Display name for this codespace. * @example bookish space pancake */ - readonly display_name?: string | null; + display_name?: string | null; /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - readonly environment_id: string | null; - readonly owner: components["schemas"]["simple-user"]; - readonly billable_owner: components["schemas"]["simple-user"]; - readonly repository: components["schemas"]["full-repository"]; - readonly machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null; + owner: components["schemas"]["simple-user"]; + billable_owner: components["schemas"]["simple-user"]; + repository: components["schemas"]["full-repository"]; + machine: components["schemas"]["nullable-codespace-machine"]; /** * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ - readonly devcontainer_path?: string | null; + devcontainer_path?: string | null; /** * @description Whether the codespace was created from a prebuild. * @example false */ - readonly prebuild: boolean | null; + prebuild: boolean | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - readonly last_used_at: string; + last_used_at: string; /** * @description State of this codespace. * @example Available * @enum {string} */ - readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; + state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** * Format: uri * @description API URL for this codespace. */ - readonly url: string; + url: string; /** @description Details about the codespace's git repository. */ - readonly git_status: { + git_status: { /** * @description The number of commits the local repository is ahead of the remote. * @example 0 */ - readonly ahead?: number; + ahead?: number; /** * @description The number of commits the local repository is behind the remote. * @example 0 */ - readonly behind?: number; + behind?: number; /** @description Whether the local repository has unpushed changes. */ - readonly has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean; /** @description Whether the local repository has uncommitted changes. */ - readonly has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean; /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - readonly ref?: string; + ref?: string; }; /** * @description The initally assigned location of a new codespace. * @example WestUs2 * @enum {string} */ - readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - readonly idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null; /** * Format: uri * @description URL to access this codespace on the web. */ - readonly web_url: string; + web_url: string; /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - readonly machines_url: string; + machines_url: string; /** * Format: uri * @description API URL to start this codespace. */ - readonly start_url: string; + start_url: string; /** * Format: uri * @description API URL to stop this codespace. */ - readonly stop_url: string; + stop_url: string; /** * Format: uri * @description API URL to publish this codespace to a new repository. */ - readonly publish_url?: string | null; + publish_url?: string | null; /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - readonly pulls_url: string | null; - readonly recent_folders: readonly string[]; - readonly runtime_constraints?: { + pulls_url: string | null; + recent_folders: string[]; + runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - readonly allowed_port_privacy_settings?: readonly string[] | null; + allowed_port_privacy_settings?: string[] | null; }; /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ - readonly pending_operation?: boolean | null; + pending_operation?: boolean | null; /** @description Text to show user when codespace is disabled by a pending operation */ - readonly pending_operation_disabled_reason?: string | null; + pending_operation_disabled_reason?: string | null; /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ - readonly idle_timeout_notice?: string | null; + idle_timeout_notice?: string | null; /** * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ - readonly retention_period_minutes?: number | null; + retention_period_minutes?: number | null; /** * Format: date-time * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z */ - readonly retention_expires_at?: string | null; + retention_expires_at?: string | null; }; /** * Email * @description Email */ - readonly email: { + email: { /** * Format: email * @example octocat@github.com */ - readonly email: string; + email: string; /** @example true */ - readonly primary: boolean; + primary: boolean; /** @example true */ - readonly verified: boolean; + verified: boolean; /** @example public */ - readonly visibility: string | null; + visibility: string | null; }; /** * GPG Key * @description A unique encryption key */ - readonly "gpg-key": { + "gpg-key": { /** * Format: int64 * @example 3 */ - readonly id: number; + id: number; /** @example Octocat's GPG Key */ - readonly name?: string | null; - readonly primary_key_id: number | null; + name?: string | null; + primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ - readonly key_id: string; + key_id: string; /** @example xsBNBFayYZ... */ - readonly public_key: string; + public_key: string; /** * @example [ * { @@ -34625,9 +37321,9 @@ export type components = { * } * ] */ - readonly emails: readonly { - readonly email?: string; - readonly verified?: boolean; + emails: { + email?: string; + verified?: boolean; }[]; /** * @example [ @@ -34647,185 +37343,256 @@ export type components = { * } * ] */ - readonly subkeys: readonly { + subkeys: { /** Format: int64 */ - readonly id?: number; - readonly primary_key_id?: number; - readonly key_id?: string; - readonly public_key?: string; - readonly emails?: readonly { - readonly email?: string; - readonly verified?: boolean; + id?: number; + primary_key_id?: number; + key_id?: string; + public_key?: string; + emails?: { + email?: string; + verified?: boolean; }[]; - readonly subkeys?: readonly unknown[]; - readonly can_sign?: boolean; - readonly can_encrypt_comms?: boolean; - readonly can_encrypt_storage?: boolean; - readonly can_certify?: boolean; - readonly created_at?: string; - readonly expires_at?: string | null; - readonly raw_key?: string | null; - readonly revoked?: boolean; + subkeys?: unknown[]; + can_sign?: boolean; + can_encrypt_comms?: boolean; + can_encrypt_storage?: boolean; + can_certify?: boolean; + created_at?: string; + expires_at?: string | null; + raw_key?: string | null; + revoked?: boolean; }[]; /** @example true */ - readonly can_sign: boolean; - readonly can_encrypt_comms: boolean; - readonly can_encrypt_storage: boolean; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; /** @example true */ - readonly can_certify: boolean; + can_certify: boolean; /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly expires_at: string | null; + expires_at: string | null; /** @example true */ - readonly revoked: boolean; - readonly raw_key: string | null; + revoked: boolean; + raw_key: string | null; }; /** * Key * @description Key */ - readonly key: { - readonly key: string; + key: { + key: string; /** Format: int64 */ - readonly id: number; - readonly url: string; - readonly title: string; + id: number; + url: string; + title: string; + /** Format: date-time */ + created_at: string; + verified: boolean; + read_only: boolean; /** Format: date-time */ - readonly created_at: string; - readonly verified: boolean; - readonly read_only: boolean; + last_used?: string | null; }; /** Marketplace Account */ - readonly "marketplace-account": { + "marketplace-account": { /** Format: uri */ - readonly url: string; - readonly id: number; - readonly type: string; - readonly node_id?: string; - readonly login: string; + url: string; + id: number; + type: string; + node_id?: string; + login: string; /** Format: email */ - readonly email?: string | null; + email?: string | null; /** Format: email */ - readonly organization_billing_email?: string | null; + organization_billing_email?: string | null; }; /** * User Marketplace Purchase * @description User Marketplace Purchase */ - readonly "user-marketplace-purchase": { + "user-marketplace-purchase": { /** @example monthly */ - readonly billing_cycle: string; + billing_cycle: string; /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - readonly next_billing_date: string | null; - readonly unit_count: number | null; + next_billing_date: string | null; + unit_count: number | null; /** @example true */ - readonly on_free_trial: boolean; + on_free_trial: boolean; /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - readonly free_trial_ends_on: string | null; + free_trial_ends_on: string | null; /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - readonly updated_at: string | null; - readonly account: components["schemas"]["marketplace-account"]; - readonly plan: components["schemas"]["marketplace-listing-plan"]; + updated_at: string | null; + account: components["schemas"]["marketplace-account"]; + plan: components["schemas"]["marketplace-listing-plan"]; }; /** * Social account * @description Social media account */ - readonly "social-account": { + "social-account": { /** @example linkedin */ - readonly provider: string; + provider: string; /** @example https://www.linkedin.com/company/github/ */ - readonly url: string; + url: string; }; /** * SSH Signing Key * @description A public SSH key used to sign Git commits */ - readonly "ssh-signing-key": { - readonly key: string; - readonly id: number; - readonly title: string; + "ssh-signing-key": { + key: string; + id: number; + title: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; }; /** * Starred Repository * @description Starred Repository */ - readonly "starred-repository": { + "starred-repository": { /** Format: date-time */ - readonly starred_at: string; - readonly repo: components["schemas"]["repository"]; - }; - /** - * Sigstore Bundle v0.1 - * @description Sigstore Bundle v0.1 - */ - readonly "sigstore-bundle-0": { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly x509CertificateChain?: { - readonly certificates?: readonly { - readonly rawBytes?: string; - }[]; - }; - readonly tlogEntries?: readonly { - readonly logIndex?: string; - readonly logId?: { - readonly keyId?: string; - }; - readonly kindVersion?: { - readonly kind?: string; - readonly version?: string; - }; - readonly integratedTime?: string; - readonly inclusionPromise?: { - readonly signedEntryTimestamp?: string; - }; - readonly inclusionProof?: string | null; - readonly canonicalizedBody?: string; - }[]; - readonly timestampVerificationData?: string | null; - }; - readonly dsseEnvelope?: { - readonly payload?: string; - readonly payloadType?: string; - readonly signatures?: readonly { - readonly sig?: string; - readonly keyid?: string; - }[]; - }; + starred_at: string; + repo: components["schemas"]["repository"]; }; /** * Hovercard * @description Hovercard */ - readonly hovercard: { - readonly contexts: readonly { - readonly message: string; - readonly octicon: string; + hovercard: { + contexts: { + message: string; + octicon: string; }[]; }; /** * Key Simple * @description Key Simple */ - readonly "key-simple": { - readonly id: number; - readonly key: string; + "key-simple": { + id: number; + key: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + last_used?: string | null; + }; + "billing-premium-request-usage-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report-user": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; /** * Enterprise @@ -34833,48 +37600,48 @@ export type components = { * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ - readonly "enterprise-webhooks": { + "enterprise-webhooks": { /** @description A short description of the enterprise. */ - readonly description?: string | null; + description?: string | null; /** * Format: uri * @example https://github.com/enterprises/octo-business */ - readonly html_url: string; + html_url: string; /** * Format: uri * @description The enterprise's website URL. */ - readonly website_url?: string | null; + website_url?: string | null; /** * @description Unique identifier of the enterprise * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the enterprise. * @example Octo Business */ - readonly name: string; + name: string; /** * @description The slug url identifier for the enterprise. * @example octo-business */ - readonly slug: string; + slug: string; /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** Format: uri */ - readonly avatar_url: string; + avatar_url: string; }; /** * Simple Installation @@ -34882,440 +37649,451 @@ export type components = { * for and sent to a GitHub App. For more information, * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ - readonly "simple-installation": { + "simple-installation": { /** * @description The ID of the installation. * @example 1 */ - readonly id: number; + id: number; /** * @description The global node ID of the installation. * @example MDQ6VXNlcjU4MzIzMQ== */ - readonly node_id: string; + node_id: string; }; /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an * organization, or when the event occurs from activity in a repository owned by an organization. */ - readonly "organization-simple-webhooks": { + "organization-simple-webhooks": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; }; /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ - readonly "repository-webhooks": { + "repository-webhooks": { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; + allow_rebase_merge: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + 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; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -35323,7 +38101,7 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -35332,7 +38110,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -35340,7 +38118,7 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -35349,42 +38127,42 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; } | null; - readonly temp_clone_token?: string; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -35392,7 +38170,7 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -35401,7 +38179,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -35409,7 +38187,7 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -35418,2228 +38196,2192 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; }; /** * 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. */ - readonly webhooks_rule: { - readonly admin_enforced: boolean; + webhooks_rule: { + admin_enforced: boolean; /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: readonly string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; /** Format: date-time */ - readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; - readonly id: number; - readonly ignore_approvals_from_contributors: boolean; + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; /** * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. * @enum {string} */ - readonly lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ - readonly lock_allows_fork_sync?: boolean; + lock_allows_fork_sync?: boolean; /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - readonly name: string; + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; + require_last_push_approval?: boolean; + required_approving_review_count: number; /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: readonly string[]; + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; /** @enum {string} */ - readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; /** @enum {string} */ - readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; + signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + strict_required_status_checks_policy: boolean; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ - readonly "simple-check-suite": { + "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - readonly after?: string | null; - readonly app?: components["schemas"]["integration"]; + after?: string | null; + app?: components["schemas"]["integration"]; /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - readonly before?: string | null; + before?: string | null; /** * @example neutral * @enum {string|null} */ - readonly conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** @example master */ - readonly head_branch?: string | null; + head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha?: string; + head_sha?: string; /** @example 5 */ - readonly id?: number; + id?: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id?: string; - readonly pull_requests?: readonly components["schemas"]["pull-request-minimal"][]; - readonly repository?: components["schemas"]["minimal-repository"]; + node_id?: string; + pull_requests?: components["schemas"]["pull-request-minimal"][]; + repository?: components["schemas"]["minimal-repository"]; /** * @example completed * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; + status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - readonly url?: string; + url?: string; }; /** * CheckRun * @description A check performed on the code of a given code change */ - readonly "check-run-with-simple-check-suite": { - readonly app: components["schemas"]["nullable-integration"]; - readonly check_suite: components["schemas"]["simple-check-suite"]; + "check-run-with-simple-check-suite": { + app: components["schemas"]["integration"]; + check_suite: components["schemas"]["simple-check-suite"]; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly completed_at: string | null; + completed_at: string | null; /** * @example neutral * @enum {string|null} */ - readonly conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; - readonly deployment?: components["schemas"]["deployment-simple"]; + conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; + deployment?: components["schemas"]["deployment-simple"]; /** @example https://example.com */ - readonly details_url: string; + details_url: string; /** @example 42 */ - readonly external_id: string; + external_id: string; /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string; + html_url: string; /** * @description The id of the check. * @example 21 */ - readonly id: number; + id: number; /** * @description The name of the check. * @example test-coverage */ - readonly name: string; + name: string; /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; - readonly output: { - readonly annotations_count: number; + node_id: string; + output: { + annotations_count: number; /** Format: uri */ - readonly annotations_url: string; - readonly summary: string | null; - readonly text: string | null; - readonly title: string | null; + annotations_url: string; + summary: string | null; + text: string | null; + title: string | null; }; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; + pull_requests: components["schemas"]["pull-request-minimal"][]; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly started_at: string; + started_at: string; /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "pending"; + status: "queued" | "in_progress" | "completed" | "pending"; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly url: string; + url: string; }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly webhooks_code_scanning_commit_oid: string; + webhooks_code_scanning_commit_oid: string; /** @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 webhooks_code_scanning_ref: string; + webhooks_code_scanning_ref: string; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - readonly webhooks_deploy_pusher_type: string; + webhooks_deploy_pusher_type: string; /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - readonly webhooks_ref_0: string; + webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - readonly webhooks_deploy_key: { - readonly added_by?: string | null; - readonly created_at: string; - readonly id: number; - readonly key: string; - readonly last_used?: string | null; - readonly read_only: boolean; - readonly title: string; + webhooks_deploy_key: { + added_by?: string | null; + created_at: string; + id: number; + key: string; + last_used?: string | null; + read_only: boolean; + title: string; /** Format: uri */ - readonly url: string; - readonly verified: boolean; - readonly enabled?: boolean; + url: string; + verified: boolean; + enabled?: boolean; }; /** Workflow */ - readonly webhooks_workflow: { + webhooks_workflow: { /** Format: uri */ - readonly badge_url: string; + badge_url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly webhooks_approver: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; - }; - readonly webhooks_reviewers: readonly { + /** + * Deployment + * @description A request for a specific ref(branch,sha,tag) to be deployed + */ + "nullable-deployment": { + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1 + */ + url: string; + /** + * Format: int64 + * @description Unique identifier of the deployment + * @example 42 + */ + id: number; + /** @example MDEwOkRlcGxveW1lbnQx */ + node_id: string; + /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ + sha: string; + /** + * @description The ref to deploy. This can be a branch, tag, or sha. + * @example topic-branch + */ + ref: string; + /** + * @description Parameter to specify a task to execute + * @example deploy + */ + task: string; + payload: { + [key: string]: unknown; + } | string; + /** @example staging */ + original_environment?: string; + /** + * @description Name for the target deployment environment. + * @example production + */ + environment: string; + /** @example Deploy request from hubot */ + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + created_at: string; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + */ + statuses_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example + */ + repository_url: string; + /** + * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. + * @example true + */ + transient_environment?: boolean; + /** + * @description Specifies if the given environment is one that end-users directly interact with. Default: false. + * @example true + */ + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + } | null; + webhooks_approver: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; + webhooks_reviewers: { /** User */ - readonly reviewer?: { + reviewer?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** @enum {string} */ - readonly type?: "User"; + type?: "User"; }[]; - readonly webhooks_workflow_job_run: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: unknown; - readonly status: string; - readonly updated_at: string; + webhooks_workflow_job_run: { + conclusion: unknown; + created_at: string; + environment: string; + html_url: string; + id: number; + name: unknown; + status: string; + updated_at: string; }; /** User */ - readonly webhooks_user: { + webhooks_user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly webhooks_answer: { + webhooks_answer: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - readonly body: string; - readonly child_comment_count: number; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; /** Format: date-time */ - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: unknown; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: unknown; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly repository_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** User */ - readonly user: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - }; - /** - * Discussion - * @description A Discussion in a repository. - */ - readonly discussion: { - readonly active_lock_reason: string | null; - readonly answer_chosen_at: string | null; - /** User */ - readonly answer_chosen_by: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - readonly answer_html_url: string | null; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - readonly body: string; - readonly category: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - readonly comments: number; - /** Format: date-time */ - readonly created_at: string; - readonly html_url: string; - readonly id: number; - readonly locked: boolean; - readonly node_id: string; - readonly number: number; - /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; - readonly timeline_url?: string; - readonly title: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly labels?: readonly components["schemas"]["label"][]; }; - readonly webhooks_comment: { + webhooks_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: number | null; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly repository_url: string; - readonly updated_at: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + updated_at: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Label */ - readonly webhooks_label: { + webhooks_label: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }; /** @description An array of repository objects that the installation can access. */ - readonly webhooks_repositories: readonly { - readonly full_name: string; + webhooks_repositories: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[]; /** @description An array of repository objects, which were added to the installation. */ - readonly webhooks_repositories_added: readonly { - readonly full_name: string; + webhooks_repositories_added: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[]; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly webhooks_repository_selection: "all" | "selected"; + webhooks_repository_selection: "all" | "selected"; /** * issue comment * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ - readonly webhooks_issue_comment: { + webhooks_issue_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ - readonly body: string; + body: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the issue comment */ - readonly id: number; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly node_id: string; - readonly performed_via_github_app: components["schemas"]["integration"]; + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["integration"]; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** @description The changes to the comment. */ - readonly webhooks_changes: { - readonly body?: { + webhooks_changes: { + body?: { /** @description The previous version of the body. */ - readonly from: string; + from: string; }; }; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly webhooks_issue: { + webhooks_issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly webhooks_milestone: { + webhooks_milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly webhooks_issue_2: { + webhooks_issue_2: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** User */ - readonly webhooks_user_mannequin: { + webhooks_user_mannequin: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ - readonly webhooks_marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly (string | null)[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + webhooks_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: (string | null)[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; /** Marketplace Purchase */ - readonly webhooks_previous_marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + webhooks_previous_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: unknown; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly webhooks_team: { - readonly deleted?: boolean; + webhooks_team: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + notification_setting: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. */ - readonly "merge-group": { + "merge-group": { /** @description The SHA of the merge group. */ - readonly head_sha: string; + head_sha: string; /** @description The full ref of the merge group. */ - readonly head_ref: string; + head_ref: string; /** @description The SHA of the merge group's parent commit. */ - readonly base_sha: string; + base_sha: string; /** @description The full ref of the branch the merge group will be merged into. */ - readonly base_ref: string; - readonly head_commit: components["schemas"]["simple-commit"]; + base_ref: string; + head_commit: components["schemas"]["simple-commit"]; }; /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ - readonly "nullable-repository-webhooks": { + "nullable-repository-webhooks": { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; + allow_rebase_merge: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + 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; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -37647,7 +40389,7 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -37656,7 +40398,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -37664,7 +40406,7 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -37673,42 +40415,42 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; } | null; - readonly temp_clone_token?: string; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -37716,7 +40458,7 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -37725,7 +40467,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -37733,7 +40475,7 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -37742,522 +40484,523 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly webhooks_milestone_3: { + webhooks_milestone_3: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Membership * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ - readonly webhooks_membership: { + webhooks_membership: { /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; + organization_url: string; + role: string; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; + state: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Personal Access Token Request * @description Details of a Personal Access Token Request. */ - readonly "personal-access-token-request": { + "personal-access-token-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ - readonly id: number; - readonly owner: components["schemas"]["simple-user"]; + id: number; + owner: components["schemas"]["simple-user"]; /** @description New requested permissions, categorized by type of permission. */ - readonly permissions_added: { - readonly organization?: { - readonly [key: string]: string; + permissions_added: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ - readonly permissions_upgraded: { - readonly organization?: { - readonly [key: string]: string; + permissions_upgraded: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ - readonly permissions_result: { - readonly organization?: { - readonly [key: string]: string; + permissions_result: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** * @description Type of repository selection requested. * @enum {string} */ - readonly repository_selection: "none" | "all" | "subset"; + repository_selection: "none" | "all" | "subset"; /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repository_count: number | null; + repository_count: number | null; /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repositories: readonly { - readonly full_name: string; + repositories: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[] | null; /** @description Date and time when the request for access was created. */ - readonly created_at: string; + 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; + 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; + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; + token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; + token_expires_at: string | null; /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + token_last_used_at: string | null; }; /** Project Card */ - readonly webhooks_project_card: { - readonly after_id?: number | null; + webhooks_project_card: { + after_id?: number | null; /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; + archived: boolean; + column_id: number; /** Format: uri */ - readonly column_url: string; + column_url: string; /** Format: uri */ - readonly content_url?: string; + content_url?: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; + id: number; + node_id: string; + note: string | null; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Project */ - readonly webhooks_project: { + webhooks_project: { /** @description Body of the project */ - readonly body: string | null; + body: string | null; /** Format: uri */ - readonly columns_url: string; + columns_url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; + name: string; + node_id: string; + number: number; /** Format: uri */ - readonly owner_url: string; + owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Project Column */ - readonly webhooks_project_column: { - readonly after_id?: number | null; + webhooks_project_column: { + after_id?: number | null; /** Format: uri */ - readonly cards_url: string; + cards_url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The unique identifier of the project column */ - readonly id: number; + id: number; /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - readonly "projects-v2": { - readonly id: number; - readonly node_id: string; - readonly owner: components["schemas"]["simple-user"]; - readonly creator: components["schemas"]["simple-user"]; - readonly title: string; - readonly description: string | null; - readonly public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly updated_at: string; - readonly number: number; - readonly short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly deleted_at: string | null; - readonly deleted_by: components["schemas"]["nullable-simple-user"]; - }; - readonly webhooks_project_changes: { - readonly archived_at?: { + webhooks_project_changes: { + archived_at?: { /** Format: date-time */ - readonly from?: string | null; + from?: string | null; /** Format: date-time */ - readonly to?: string | null; + to?: string | null; }; }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; /** * Projects v2 Item * @description An item belonging to a project */ - readonly "projects-v2-item": { - readonly id: number; - readonly node_id?: string; - readonly project_node_id?: string; - readonly content_node_id: string; - readonly content_type: components["schemas"]["projects-v2-item-content-type"]; - readonly creator?: components["schemas"]["simple-user"]; + "projects-v2-item": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The node ID of the project that contains this item. */ + project_node_id?: string; + /** @description The node ID of the content represented by this item. */ + content_node_id: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the item was created. * @example 2022-04-28T12:00:00Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time + * @description The time when the item was last updated. * @example 2022-04-28T12:00:00Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time + * @description The time when the item was archived. * @example 2022-04-28T12:00:00Z */ - readonly archived_at: string | null; + archived_at: string | null; }; /** * Projects v2 Single Select Option * @description An option for a single select field */ - readonly "projects-v2-single-select-option": { - readonly id: string; - readonly name: string; - readonly color?: string | null; - readonly description?: string | null; + "projects-v2-single-select-option": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option. */ + name: string; + /** @description The color associated with the option. */ + color?: string | null; + /** @description A short description of the option. */ + description?: string | null; }; /** * Projects v2 Iteration Setting * @description An iteration setting for an iteration field */ - readonly "projects-v2-iteration-setting": { - readonly id: string; - readonly title: string; - readonly duration?: number | null; - readonly start_date?: string | null; + "projects-v2-iteration-setting": { + /** @description The unique identifier of the iteration setting. */ + id: string; + /** @description The iteration title. */ + title: string; + /** @description The iteration title, rendered as HTML. */ + title_html?: string; + /** @description The duration of the iteration in days. */ + duration?: number | null; + /** @description The start date of the iteration. */ + start_date?: string | null; + /** @description Whether the iteration has been completed. */ + completed?: boolean; }; /** * Projects v2 Status Update * @description An status update belonging to a project */ - readonly "projects-v2-status-update": { - readonly id: number; - readonly node_id: string; - readonly project_node_id?: string; - readonly creator?: components["schemas"]["simple-user"]; + "projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the status update was created. * @example 2022-04-28T12:00:00Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time + * @description The time when the status update was last updated. * @example 2022-04-28T12:00:00Z */ - readonly updated_at: string; - /** @enum {string|null} */ - readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** * Format: date + * @description The start date of the period covered by the update. * @example 2022-04-28 */ - readonly start_date?: string; + start_date?: string; /** * Format: date + * @description The target date associated with the update. * @example 2022-04-28 */ - readonly target_date?: string; + target_date?: string; /** * @description Body of the status update * @example The project is off to a great start! */ - readonly body?: string | null; + body?: string | null; }; /** @description The pull request number. */ - readonly webhooks_number: number; - readonly "pull-request-webhook": components["schemas"]["pull-request"] & { + webhooks_number: number; + "pull-request-webhook": components["schemas"]["pull-request"] & { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; + allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. * - `PR_TITLE` - default to the pull request's title. @@ -38265,14 +41008,14 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: * - `PR_BODY` - default to the pull request's body. @@ -38280,349 +41023,359 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + 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 is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ - readonly use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ - readonly webhooks_pull_request_5: { - readonly _links: { + webhooks_pull_request_5: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -38631,7 +41384,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -38639,76 +41392,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -38717,7 +41470,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -38725,250 +41478,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - readonly use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -38977,7 +41740,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -38985,76 +41748,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -39063,7 +41826,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -39071,444 +41834,444 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - readonly use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ - readonly webhooks_review_comment: { - readonly _links: { + webhooks_review_comment: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -39516,138 +42279,138 @@ export type components = { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; + original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; /** Format: uri */ - readonly url: string; + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ - readonly webhooks_review: { - readonly _links: { + webhooks_review: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -39655,653 +42418,666 @@ export type components = { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the review. */ - readonly body: string | null; + body: string | null; /** @description A commit SHA for the review. */ - readonly commit_id: string; + commit_id: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** Format: uri */ - readonly pull_request_url: string; - readonly state: string; + pull_request_url: string; + state: string; + /** Format: date-time */ + submitted_at: string | null; /** Format: date-time */ - readonly submitted_at: string | null; + updated_at?: string | null; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly webhooks_nullable_string: string | null; + webhooks_nullable_string: string | null; /** * Release * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ - readonly webhooks_release: { - readonly assets: readonly { + webhooks_release: { + assets: { /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + browser_download_url: string; + content_type: string; /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; + created_at: string; + download_count: number; + id: number; + label: string | null; /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + name: string; + node_id: string; + size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded"; + state: "uploaded"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly uploader?: { + uploader?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly url: string; + url: string; }[]; /** Format: uri */ - readonly assets_url: string; + assets_url: string; /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ - readonly discussion_url?: string; + discussion_url?: string; /** @description Whether the release is a draft or published */ - readonly draft: boolean; + draft: boolean; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; + html_url: string; + id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; + name: string | null; + node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; + prerelease: boolean; /** Format: date-time */ - readonly published_at: string | null; + published_at: string | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** Format: uri */ - readonly tarball_url: string | null; + tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; + target_commitish: string; /** Format: uri-template */ - readonly upload_url: string; + upload_url: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly zipball_url: string | null; + zipball_url: string | null; }; /** * Release * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ - readonly webhooks_release_1: { - readonly assets: readonly ({ + webhooks_release_1: { + assets: ({ /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + browser_download_url: string; + content_type: string; /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; + created_at: string; + download_count: number; + id: number; + label: string | null; /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + name: string; + node_id: string; + size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded"; + state: "uploaded"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly uploader?: { + uploader?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; /** Format: uri */ - readonly assets_url: string; + assets_url: string; /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: uri */ - readonly discussion_url?: string; + discussion_url?: string; /** @description Whether the release is a draft or published */ - readonly draft: boolean; + draft: boolean; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; + html_url: string; + id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; + name: string | null; + node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; + prerelease: boolean; /** Format: date-time */ - readonly published_at: string | null; + published_at: string | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** Format: uri */ - readonly tarball_url: string | null; + tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; + target_commitish: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri-template */ - readonly upload_url: string; + upload_url: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly zipball_url: string | null; + zipball_url: string | null; }; /** * Repository Vulnerability Alert Alert * @description The security alert of the vulnerable dependency. */ - readonly webhooks_alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; + webhooks_alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; /** User */ - readonly dismisser?: { + dismisser?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly external_identifier: string; + external_identifier: string; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; + external_reference: string | null; + fix_reason?: string; /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - readonly state: "open"; + state: "auto_dismissed" | "open"; }; /** * @description The reason for resolving the alert. * @enum {string|null} */ - readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; - readonly "secret-scanning-alert-webhook": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; + "secret-scanning-alert-webhook": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - readonly locations_url?: string; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + locations_url?: string; + resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment to resolve an alert. */ - readonly resolution_comment?: string | null; + resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ - readonly secret_type_display_name?: string; + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} */ - readonly validity?: "active" | "inactive" | "unknown"; + validity?: "active" | "inactive" | "unknown"; /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly push_protection_bypassed_at?: string | null; - readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment when reviewing a push protection bypass. */ - readonly push_protection_bypass_request_reviewer_comment?: string | null; + push_protection_bypass_request_reviewer_comment?: string | null; /** @description An optional comment when requesting a push protection bypass. */ - readonly push_protection_bypass_request_comment?: string | null; + push_protection_bypass_request_comment?: string | null; /** * Format: uri * @description The URL to a push protection bypass request. */ - readonly push_protection_bypass_request_html_url?: string | null; + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ - readonly publicly_leaked?: boolean | null; + 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; + multi_repo?: boolean | null; + assigned_to?: components["schemas"]["nullable-simple-user"]; }; /** @description The details of the security advisory, including summary, description, and severity. */ - readonly webhooks_security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly cwes: readonly { - readonly cwe_id: string; - readonly name: string; + webhooks_security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + cwes: { + cwe_id: string; + name: string; }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: readonly { - readonly type: string; - readonly value: string; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; }[]; - readonly published_at: string; - readonly references: readonly { + published_at: string; + references: { /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: readonly { - readonly first_patched_version: { - readonly identifier: string; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; + package: { + ecosystem: string; + name: string; }; - readonly severity: string; - readonly vulnerable_version_range: string; + severity: string; + vulnerable_version_range: string; }[]; - readonly withdrawn_at: string | null; - }; - readonly webhooks_sponsorship: { - readonly created_at: string; - readonly maintainer?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; - }; - readonly node_id: string; - readonly privacy_level: string; + withdrawn_at: string | null; + }; + webhooks_sponsorship: { + created_at: string; + maintainer?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; + node_id: string; + privacy_level: string; /** User */ - readonly sponsor: { + sponsor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** User */ - readonly sponsorable: { + sponsorable: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + tier: { + created_at: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; }; }; /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - readonly webhooks_effective_date: string; - readonly webhooks_changes_8: { - readonly tier: { + webhooks_effective_date: string; + webhooks_changes_8: { + tier: { /** * Sponsorship Tier * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - readonly from: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + from: { + created_at: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; }; }; }; @@ -40309,14583 +43085,15980 @@ export type components = { * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly webhooks_team_1: { - readonly deleted?: boolean; + webhooks_team_1: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + notification_setting: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** branch protection configuration disabled event */ - readonly "webhook-branch-protection-configuration-disabled": { + "webhook-branch-protection-configuration-disabled": { /** @enum {string} */ - readonly action: "disabled"; - 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"]; + action: "disabled"; + 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"]; }; /** branch protection configuration enabled event */ - readonly "webhook-branch-protection-configuration-enabled": { + "webhook-branch-protection-configuration-enabled": { /** @enum {string} */ - readonly action: "enabled"; - 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"]; + action: "enabled"; + 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"]; }; /** branch protection rule created event */ - readonly "webhook-branch-protection-rule-created": { + "webhook-branch-protection-rule-created": { /** @enum {string} */ - readonly action: "created"; - 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 rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ - readonly "webhook-branch-protection-rule-deleted": { + "webhook-branch-protection-rule-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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 rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ - readonly "webhook-branch-protection-rule-edited": { + "webhook-branch-protection-rule-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description If the action was `edited`, the changes to the rule. */ - readonly changes?: { - readonly admin_enforced?: { - readonly from: boolean | null; + changes?: { + admin_enforced?: { + from: boolean | null; }; - readonly authorized_actor_names?: { - readonly from: readonly string[]; + authorized_actor_names?: { + from: string[]; }; - readonly authorized_actors_only?: { - readonly from: boolean | null; + authorized_actors_only?: { + from: boolean | null; }; - readonly authorized_dismissal_actors_only?: { - readonly from: boolean | null; + authorized_dismissal_actors_only?: { + from: boolean | null; }; - readonly linear_history_requirement_enforcement_level?: { + linear_history_requirement_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; - readonly lock_branch_enforcement_level?: { + lock_branch_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; - readonly lock_allows_fork_sync?: { - readonly from: boolean | null; + lock_allows_fork_sync?: { + from: boolean | null; }; - readonly pull_request_reviews_enforcement_level?: { + pull_request_reviews_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; - readonly require_last_push_approval?: { - readonly from: boolean | null; + require_last_push_approval?: { + from: boolean | null; }; - readonly required_status_checks?: { - readonly from: readonly string[]; + required_status_checks?: { + from: string[]; }; - readonly required_status_checks_enforcement_level?: { + required_status_checks_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; }; - 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 rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ - readonly "webhook-check-run-completed": { + "webhook-check-run-completed": { /** @enum {string} */ - readonly action?: "completed"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - 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"]; + action?: "completed"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event * @description The check_run.completed webhook encoded with URL encoding */ - readonly "webhook-check-run-completed-form-encoded": { + "webhook-check-run-completed-form-encoded": { /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** Check Run Created Event */ - readonly "webhook-check-run-created": { + "webhook-check-run-created": { /** @enum {string} */ - readonly action?: "created"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - 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"]; + action?: "created"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event * @description The check_run.created webhook encoded with URL encoding */ - readonly "webhook-check-run-created-form-encoded": { + "webhook-check-run-created-form-encoded": { /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** Check Run Requested Action Event */ - readonly "webhook-check-run-requested-action": { + "webhook-check-run-requested-action": { /** @enum {string} */ - readonly action: "requested_action"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + action: "requested_action"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** @description The action requested by the user. */ - readonly requested_action?: { + requested_action?: { /** @description The integrator reference of the action requested by the user. */ - readonly identifier?: string; + identifier?: string; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event * @description The check_run.requested_action webhook encoded with URL encoding */ - readonly "webhook-check-run-requested-action-form-encoded": { + "webhook-check-run-requested-action-form-encoded": { /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** Check Run Re-Requested Event */ - readonly "webhook-check-run-rerequested": { + "webhook-check-run-rerequested": { /** @enum {string} */ - readonly action?: "rerequested"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - 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"]; + action?: "rerequested"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event * @description The check_run.rerequested webhook encoded with URL encoding */ - readonly "webhook-check-run-rerequested-form-encoded": { + "webhook-check-run-rerequested-form-encoded": { /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** check_suite completed event */ - readonly "webhook-check-suite-completed": { + "webhook-check-suite-completed": { /** @enum {string} */ - readonly action: "completed"; + action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; + check_suite: { + after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly app: { + app: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The client ID of the GitHub app */ - readonly client_id?: string | null; + client_id?: string | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; }; - readonly before: string | null; + before: string | null; /** Format: uri */ - readonly check_runs_url: string; + check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL that points to the check suite API resource. */ - readonly url: string; + url: string; }; - 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"]; + 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"]; }; /** check_suite requested event */ - readonly "webhook-check-suite-requested": { + "webhook-check-suite-requested": { /** @enum {string} */ - readonly action: "requested"; + action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; + check_suite: { + after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly app: { + app: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description Client ID of the GitHub app */ - readonly client_id?: string | null; + client_id?: string | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; /** @enum {string} */ - readonly actions?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + artifact_metadata?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + attestations?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + copilot_requests?: "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + merge_queues?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + models?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly pages?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + packages?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; }; - readonly before: string | null; + before: string | null; /** Format: uri */ - readonly check_runs_url: string; + check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; + status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL that points to the check suite API resource. */ - readonly url: string; + url: string; }; - 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"]; + 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"]; }; /** check_suite rerequested event */ - readonly "webhook-check-suite-rerequested": { + "webhook-check-suite-rerequested": { /** @enum {string} */ - readonly action: "rerequested"; + action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; + check_suite: { + after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly app: { + app: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The Client ID for the GitHub app */ - readonly client_id?: string | null; + client_id?: string | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + artifact_metadata?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + attestations?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + copilot_requests?: "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + merge_queues?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + models?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; }; - readonly before: string | null; + before: string | null; /** Format: uri */ - readonly check_runs_url: string; + check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; + status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL that points to the check suite API resource. */ - readonly url: string; + url: string; }; - 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"]; + 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"]; }; /** code_scanning_alert appeared_in_branch event */ - readonly "webhook-code-scanning-alert-appeared-in-branch": { + "webhook-code-scanning-alert-appeared-in-branch": { /** @enum {string} */ - readonly action: "appeared_in_branch"; + action: "appeared_in_branch"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; + dismissed_at: string | null; /** User */ - readonly dismissed_by: { + dismissed_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; + description: string; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; + id: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; + severity: "none" | "note" | "warning" | "error" | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed" | null; - readonly tool: { + state: "open" | "dismissed" | "fixed" | null; + tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ - readonly "webhook-code-scanning-alert-closed-by-user": { + "webhook-code-scanning-alert-closed-by-user": { /** @enum {string} */ - readonly action: "closed_by_user"; + action: "closed_by_user"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string; + dismissed_at: string; /** User */ - readonly dismissed_by: { + dismissed_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "dismissed" | "fixed"; - readonly tool: { - readonly guid?: string | null; + state: "dismissed" | "fixed"; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; + /** User */ + dismissal_approved_by?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ - readonly "webhook-code-scanning-alert-created": { + "webhook-code-scanning-alert-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string | null; + created_at: string | null; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_at: unknown; + dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; + dismissed_reason: unknown; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; - readonly instances_url?: string; + html_url: string; + instances_url?: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "dismissed" | null; - readonly tool: { - readonly guid?: string | null; + state: "open" | "dismissed" | null; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; } | null; - readonly updated_at?: string | null; + updated_at?: string | null; /** Format: uri */ - readonly url: string; + url: string; + dismissal_approved_by?: unknown; + assignees?: components["schemas"]["simple-user"][]; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ - readonly "webhook-code-scanning-alert-fixed": { + "webhook-code-scanning-alert-fixed": { /** @enum {string} */ - readonly action: "fixed"; + action: "fixed"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; + dismissed_at: string | null; /** User */ - readonly dismissed_by: { + dismissed_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly instances_url?: string; + instances_url?: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "fixed" | null; - readonly tool: { - readonly guid?: string | null; + state: "fixed" | null; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ - readonly "webhook-code-scanning-alert-reopened": { + "webhook-code-scanning-alert-reopened": { /** @enum {string} */ - readonly action: "reopened"; + action: "reopened"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; - readonly dismissed_by: Record | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_at: string | null; + dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: string | null; + dismissed_reason: string | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; + instances_url?: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed" | null; - readonly tool: { - readonly guid?: string | null; + state: "open" | "dismissed" | "fixed" | null; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; + updated_at?: string | null; /** Format: uri */ - readonly url: string; - } | null; + url: string; + dismissal_approved_by?: unknown; + }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + commit_oid: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string | null; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + ref: string | null; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ - readonly "webhook-code-scanning-alert-reopened-by-user": { + "webhook-code-scanning-alert-reopened-by-user": { /** @enum {string} */ - readonly action: "reopened_by_user"; + action: "reopened_by_user"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_at: unknown; + dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; + dismissed_reason: unknown; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; + description: string; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; + id: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; + severity: "none" | "note" | "warning" | "error" | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "fixed" | null; - readonly tool: { + state: "open" | "fixed" | null; + tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** code_scanning_alert updated_assignment event */ + "webhook-code-scanning-alert-updated-assignment": { + /** @enum {string} */ + action: "updated_assignment"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | "fixed" | null; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + 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"]; }; /** commit_comment created event */ - readonly "webhook-commit-comment-created": { + "webhook-commit-comment-created": { /** * @description The action performed. Can be `created`. * @enum {string} */ - readonly action: "created"; + action: "created"; /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ - readonly comment: { + comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - readonly created_at: string; + commit_id: string; + created_at: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description The ID of the commit comment. */ - readonly id: number; + id: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the commit comment. */ - readonly node_id: string; + node_id: string; /** @description The relative path of the file to which the comment applies. */ - readonly path: string | null; + path: string | null; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + updated_at: string; + /** Format: uri */ + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + 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"]; }; /** create event */ - readonly "webhook-create": { + "webhook-create": { /** @description The repository's current description. */ - readonly description: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The name of the repository's default branch (usually `main`). */ - readonly master_branch: string; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; - readonly ref: components["schemas"]["webhooks_ref_0"]; + master_branch: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; /** * @description The type of Git ref object created in the repository. * @enum {string} */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ - readonly "webhook-custom-property-created": { + "webhook-custom-property-created": { /** @enum {string} */ - readonly action: "created"; - readonly definition: components["schemas"]["custom-property"]; - 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"]; + action: "created"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ - readonly "webhook-custom-property-deleted": { + "webhook-custom-property-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly definition: { + action: "deleted"; + definition: { /** @description The name of the property that was deleted. */ - readonly property_name: string; + property_name: string; }; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** custom property promoted to business event */ + "webhook-custom-property-promoted-to-enterprise": { + /** @enum {string} */ + action: "promote_to_enterprise"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ - readonly "webhook-custom-property-updated": { + "webhook-custom-property-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly definition: components["schemas"]["custom-property"]; - 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"]; + action: "updated"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ - readonly "webhook-custom-property-values-updated": { + "webhook-custom-property-values-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - 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"]; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + repository: components["schemas"]["repository-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ - readonly new_property_values: readonly components["schemas"]["custom-property-value"][]; + new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ - readonly old_property_values: readonly components["schemas"]["custom-property-value"][]; + old_property_values: components["schemas"]["custom-property-value"][]; }; /** delete event */ - readonly "webhook-delete": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; - readonly ref: components["schemas"]["webhooks_ref_0"]; + "webhook-delete": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; /** * @description The type of Git ref object deleted in the repository. * @enum {string} */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert assignees changed event */ + "webhook-dependabot-alert-assignees-changed": { + /** @enum {string} */ + action: "assignees_changed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ - readonly "webhook-dependabot-alert-auto-dismissed": { + "webhook-dependabot-alert-auto-dismissed": { /** @enum {string} */ - readonly action: "auto_dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ - readonly "webhook-dependabot-alert-auto-reopened": { + "webhook-dependabot-alert-auto-reopened": { /** @enum {string} */ - readonly action: "auto_reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ - readonly "webhook-dependabot-alert-created": { + "webhook-dependabot-alert-created": { /** @enum {string} */ - readonly action: "created"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ - readonly "webhook-dependabot-alert-dismissed": { + "webhook-dependabot-alert-dismissed": { /** @enum {string} */ - readonly action: "dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ - readonly "webhook-dependabot-alert-fixed": { + "webhook-dependabot-alert-fixed": { /** @enum {string} */ - readonly action: "fixed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "fixed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ - readonly "webhook-dependabot-alert-reintroduced": { + "webhook-dependabot-alert-reintroduced": { /** @enum {string} */ - readonly action: "reintroduced"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "reintroduced"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ - readonly "webhook-dependabot-alert-reopened": { + "webhook-dependabot-alert-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ - readonly "webhook-deploy-key-created": { + "webhook-deploy-key-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ - readonly "webhook-deploy-key-deleted": { + "webhook-deploy-key-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ - readonly "webhook-deployment-created": { + "webhook-deployment-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** * Deployment * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ - readonly deployment: { - readonly created_at: string; + deployment: { + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: Record | string; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: Record | string; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly production_environment?: boolean; - readonly ref: string; + production_environment?: boolean; + ref: string; /** Format: uri */ - readonly repository_url: string; - readonly sha: string; + repository_url: string; + sha: string; /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: unknown; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: unknown; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor?: { + triggering_actor?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; + url: string; + workflow_id: number; + workflow_url?: string; } | null; }; /** deployment protection rule requested event */ - readonly "webhook-deployment-protection-rule-requested": { + "webhook-deployment-protection-rule-requested": { /** @enum {string} */ - readonly action?: "requested"; + action?: "requested"; /** @description The name of the environment that has the deployment protection rule. */ - readonly environment?: string; + environment?: string; /** @description The event that triggered the deployment protection rule. */ - readonly event?: string; + event?: string; + /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + sha?: string; + /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + ref?: string; /** * Format: uri * @description The URL to review the deployment protection rule. */ - readonly deployment_callback_url?: string; - readonly deployment?: components["schemas"]["deployment"]; - readonly pull_requests?: readonly components["schemas"]["pull-request"][]; - 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"]; + deployment_callback_url?: string; + deployment?: components["schemas"]["nullable-deployment"]; + pull_requests?: components["schemas"]["pull-request"][]; + repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + sender?: components["schemas"]["simple-user"]; }; - readonly "webhook-deployment-review-approved": { + "webhook-deployment-review-approved": { /** @enum {string} */ - readonly action: "approved"; - readonly approver?: components["schemas"]["webhooks_approver"]; - readonly comment?: string; - 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 reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user"]; - readonly since: string; - readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; - readonly workflow_job_runs?: readonly { - readonly conclusion?: unknown; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; + action: "approved"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: unknown; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; }[]; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record | null; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; + url: string; + workflow_id: number; + workflow_url?: string; } | null; }; - readonly "webhook-deployment-review-rejected": { + "webhook-deployment-review-rejected": { /** @enum {string} */ - readonly action: "rejected"; - readonly approver?: components["schemas"]["webhooks_approver"]; - readonly comment?: string; - 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 reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user"]; - readonly since: string; - readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; - readonly workflow_job_runs?: readonly { - readonly conclusion?: string | null; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; + action: "rejected"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; }[]; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record | null; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; } | null; }; - readonly "webhook-deployment-review-requested": { + "webhook-deployment-review-requested": { /** @enum {string} */ - readonly action: "requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly environment: string; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly requestor: components["schemas"]["webhooks_user"]; - readonly reviewers: readonly { + action: "requested"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + environment: string; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + requestor: components["schemas"]["webhooks_user"]; + reviewers: { /** User */ - readonly reviewer?: { + reviewer?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login?: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @enum {string} */ - readonly type?: "User" | "Team"; + type?: "User" | "Team"; }[]; - readonly sender: components["schemas"]["simple-user"]; - readonly since: string; - readonly workflow_job_run: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly status: string; - readonly updated_at: string; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run: { + conclusion: unknown; + created_at: string; + environment: string; + html_url: string; + id: number; + name: string | null; + status: string; + updated_at: string; }; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record | null; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; } | null; }; /** deployment_status created event */ - readonly "webhook-deployment-status-created": { + "webhook-deployment-status-created": { /** @enum {string} */ - readonly action: "created"; - readonly check_run?: { + action: "created"; + check_run?: { /** Format: date-time */ - readonly completed_at: string | null; + completed_at: string | null; /** * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; /** Format: uri */ - readonly details_url: string; - readonly external_id: string; + details_url: string; + external_id: string; /** @description The SHA of the commit that is being checked. */ - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description The id of the check. */ - readonly id: number; + id: number; /** @description The name of the check run. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: date-time */ - readonly started_at: string; + started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; + status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; /** Format: uri */ - readonly url: string; + url: string; } | null; /** * Deployment * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ - readonly deployment: { - readonly created_at: string; + deployment: { + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: (string | Record) | null; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly production_environment?: boolean; - readonly ref: string; + production_environment?: boolean; + ref: string; /** Format: uri */ - readonly repository_url: string; - readonly sha: string; + repository_url: string; + sha: string; /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ - readonly deployment_status: { - readonly created_at: string; + deployment_status: { + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly deployment_url: string; + deployment_url: string; /** @description The optional human-readable description added to the status. */ - readonly description: string; - readonly environment: string; + description: string; + environment: string; /** Format: uri */ - readonly environment_url?: string; - readonly id: number; + environment_url?: string; + id: number; /** Format: uri */ - readonly log_url?: string; - readonly node_id: string; + log_url?: string; + node_id: string; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; /** Format: uri */ - readonly repository_url: string; + repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ - readonly state: string; + state: string; /** @description The optional link added to the status. */ - readonly target_url: string; - readonly updated_at: string; + target_url: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - 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"]; - readonly workflow?: components["schemas"]["webhooks_workflow"]; + 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"]; + workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ - readonly workflow_run?: { + workflow_run?: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: unknown; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: unknown; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; + url: string; + workflow_id: number; + workflow_url?: string; } | null; }; /** discussion answered event */ - readonly "webhook-discussion-answered": { + "webhook-discussion-answered": { /** @enum {string} */ - readonly action: "answered"; - readonly answer: components["schemas"]["webhooks_answer"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "answered"; + answer: components["schemas"]["webhooks_answer"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion category changed event */ - readonly "webhook-discussion-category-changed": { + "webhook-discussion-category-changed": { /** @enum {string} */ - readonly action: "category_changed"; - readonly changes: { - readonly category: { - readonly from: { + action: "category_changed"; + changes: { + category: { + from: { /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; }; }; }; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion closed event */ - readonly "webhook-discussion-closed": { + "webhook-discussion-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "closed"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion_comment created event */ - readonly "webhook-discussion-comment-created": { + "webhook-discussion-comment-created": { /** @enum {string} */ - readonly action: "created"; - readonly comment: components["schemas"]["webhooks_comment"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "created"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion_comment deleted event */ - readonly "webhook-discussion-comment-deleted": { + "webhook-discussion-comment-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly comment: components["schemas"]["webhooks_comment"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "deleted"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion_comment edited event */ - readonly "webhook-discussion-comment-edited": { + "webhook-discussion-comment-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body: { - readonly from: string; + action: "edited"; + changes: { + body: { + from: string; }; }; - readonly comment: components["schemas"]["webhooks_comment"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion created event */ - readonly "webhook-discussion-created": { + "webhook-discussion-created": { /** @enum {string} */ - readonly action: "created"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "created"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion deleted event */ - readonly "webhook-discussion-deleted": { + "webhook-discussion-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "deleted"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion edited event */ - readonly "webhook-discussion-edited": { + "webhook-discussion-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly body?: { - readonly from: string; + action: "edited"; + changes?: { + body?: { + from: string; }; - readonly title?: { - readonly from: string; + title?: { + from: string; }; }; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion labeled event */ - readonly "webhook-discussion-labeled": { + "webhook-discussion-labeled": { /** @enum {string} */ - readonly action: "labeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "labeled"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ - readonly "webhook-discussion-locked": { + "webhook-discussion-locked": { /** @enum {string} */ - readonly action: "locked"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "locked"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion pinned event */ - readonly "webhook-discussion-pinned": { + "webhook-discussion-pinned": { /** @enum {string} */ - readonly action: "pinned"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "pinned"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion reopened event */ - readonly "webhook-discussion-reopened": { + "webhook-discussion-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "reopened"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion transferred event */ - readonly "webhook-discussion-transferred": { + "webhook-discussion-transferred": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly new_discussion: components["schemas"]["discussion"]; - readonly new_repository: components["schemas"]["repository-webhooks"]; - }; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "transferred"; + changes: { + new_discussion: components["schemas"]["discussion"]; + new_repository: components["schemas"]["repository-webhooks"]; + }; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion unanswered event */ - readonly "webhook-discussion-unanswered": { + "webhook-discussion-unanswered": { /** @enum {string} */ - readonly action: "unanswered"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "unanswered"; + discussion: components["schemas"]["discussion"]; + old_answer: components["schemas"]["webhooks_answer"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ - readonly "webhook-discussion-unlabeled": { + "webhook-discussion-unlabeled": { /** @enum {string} */ - readonly action: "unlabeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unlabeled"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ - readonly "webhook-discussion-unlocked": { + "webhook-discussion-unlocked": { /** @enum {string} */ - readonly action: "unlocked"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "unlocked"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion unpinned event */ - readonly "webhook-discussion-unpinned": { + "webhook-discussion-unpinned": { /** @enum {string} */ - readonly action: "unpinned"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "unpinned"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** * fork event * @description A user forks a repository. */ - readonly "webhook-fork": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + "webhook-fork": { + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ - readonly forkee: { + forkee: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } & { - readonly allow_forking?: boolean; - readonly archive_url?: string; - readonly archived?: boolean; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly clone_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly created_at?: string; - readonly default_branch?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly disabled?: boolean; - readonly downloads_url?: string; - readonly events_url?: string; + allow_forking?: boolean; + archive_url?: string; + archived?: boolean; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + clone_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + created_at?: string; + default_branch?: string; + deployments_url?: string; + description?: string | null; + disabled?: boolean; + downloads_url?: string; + events_url?: string; /** @enum {boolean} */ - readonly fork?: true; - readonly forks?: number; - readonly forks_count?: number; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly has_downloads?: boolean; - readonly has_issues?: boolean; - readonly has_pages?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly homepage?: string | null; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly is_template?: boolean; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly language?: unknown; - readonly languages_url?: string; - readonly license?: Record | null; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly mirror_url?: unknown; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly open_issues?: number; - readonly open_issues_count?: number; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - }; - readonly private?: boolean; - readonly public?: boolean; - readonly pulls_url?: string; - readonly pushed_at?: string; - readonly releases_url?: string; - readonly size?: number; - readonly ssh_url?: string; - readonly stargazers_count?: number; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly svn_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly topics?: readonly unknown[]; - readonly trees_url?: string; - readonly updated_at?: string; - readonly url?: string; - readonly visibility?: string; - readonly watchers?: number; - readonly watchers_count?: number; - }; - 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"]; + fork?: true; + forks?: number; + forks_count?: number; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + has_downloads?: boolean; + has_issues?: boolean; + has_pages?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + homepage?: string | null; + hooks_url?: string; + html_url?: string; + id?: number; + is_template?: boolean; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + language?: unknown; + languages_url?: string; + license?: Record | null; + merges_url?: string; + milestones_url?: string; + mirror_url?: unknown; + name?: string; + node_id?: string; + notifications_url?: string; + open_issues?: number; + open_issues_count?: number; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + public?: boolean; + pulls_url?: string; + pushed_at?: string; + releases_url?: string; + size?: number; + ssh_url?: string; + stargazers_count?: number; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + svn_url?: string; + tags_url?: string; + teams_url?: string; + topics?: unknown[]; + trees_url?: string; + updated_at?: string; + url?: string; + visibility?: string; + watchers?: number; + watchers_count?: number; + }; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ - readonly "webhook-github-app-authorization-revoked": { + "webhook-github-app-authorization-revoked": { /** @enum {string} */ - readonly action: "revoked"; - readonly sender: components["schemas"]["simple-user"]; + action: "revoked"; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ - readonly "webhook-gollum": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + "webhook-gollum": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The pages that were updated. */ - readonly pages: readonly { + pages: { /** * @description The action that was performed on the page. Can be `created` or `edited`. * @enum {string} */ - readonly action: "created" | "edited"; + action: "created" | "edited"; /** * Format: uri * @description Points to the HTML wiki page. */ - readonly html_url: string; + html_url: string; /** @description The name of the page. */ - readonly page_name: string; + page_name: string; /** @description The latest commit SHA of the page. */ - readonly sha: string; - readonly summary: string | null; + sha: string; + summary: string | null; /** @description The current page title. */ - readonly title: string; + title: string; }[]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ - readonly "webhook-installation-created": { + "webhook-installation-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ - readonly "webhook-installation-deleted": { + "webhook-installation-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ - readonly "webhook-installation-new-permissions-accepted": { + "webhook-installation-new-permissions-accepted": { /** @enum {string} */ - readonly action: "new_permissions_accepted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; + action: "new_permissions_accepted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ - readonly "webhook-installation-repositories-added": { + "webhook-installation-repositories-added": { /** @enum {string} */ - readonly action: "added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: readonly { - readonly full_name?: string; + repositories_removed: { + full_name?: string; /** @description Unique identifier of the repository */ - readonly id?: number; + id?: number; /** @description The name of the repository. */ - readonly name?: string; - readonly node_id?: string; + name?: string; + node_id?: string; /** @description Whether the repository is private or public. */ - readonly private?: boolean; + private?: boolean; }[]; - 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"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ - readonly "webhook-installation-repositories-removed": { + "webhook-installation-repositories-removed": { /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: readonly { - readonly full_name: string; + repositories_removed: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[]; - 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"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ - readonly "webhook-installation-suspend": { + "webhook-installation-suspend": { /** @enum {string} */ - readonly action: "suspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; - }; - readonly "webhook-installation-target-renamed": { - readonly account: { - readonly archived_at?: string | null; - readonly avatar_url: string; - readonly created_at?: string; - readonly description?: unknown; - readonly events_url?: string; - readonly followers?: number; - readonly followers_url?: string; - readonly following?: number; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly has_organization_projects?: boolean; - readonly has_repository_projects?: boolean; - readonly hooks_url?: string; - readonly html_url: string; - readonly id: number; - readonly is_verified?: boolean; - readonly issues_url?: string; - readonly login?: string; - readonly members_url?: string; - readonly name?: string; - readonly node_id: string; - readonly organizations_url?: string; - readonly public_gists?: number; - readonly public_members_url?: string; - readonly public_repos?: number; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly slug?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly updated_at?: string; - readonly url?: string; - readonly website_url?: unknown; - readonly user_view_type?: string; + action: "suspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; + }; + "webhook-installation-target-renamed": { + account: { + archived_at?: string | null; + avatar_url: string; + created_at?: string; + description?: unknown; + events_url?: string; + followers?: number; + followers_url?: string; + following?: number; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + has_organization_projects?: boolean; + has_repository_projects?: boolean; + hooks_url?: string; + html_url: string; + id: number; + is_verified?: boolean; + issues_url?: string; + login?: string; + members_url?: string; + name?: string; + node_id: string; + organizations_url?: string; + public_gists?: number; + public_members_url?: string; + public_repos?: number; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + slug?: string; + starred_url?: string; + subscriptions_url?: string; + type?: string; + updated_at?: string; + url?: string; + website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly login?: { - readonly from: string; + action: "renamed"; + changes: { + login?: { + from: string; }; - readonly slug?: { - readonly from: string; + slug?: { + from: string; }; }; - 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"]; - readonly target_type: string; + 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"]; + target_type: string; }; /** installation unsuspend event */ - readonly "webhook-installation-unsuspend": { + "webhook-installation-unsuspend": { /** @enum {string} */ - readonly action: "unsuspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; + action: "unsuspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ - readonly "webhook-issue-comment-created": { + "webhook-issue-comment-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** * issue comment * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ - readonly comment: { + comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ - readonly body: string; + body: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the issue comment */ - readonly id: number; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly node_id: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue comment */ - readonly url: string; + url: string; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at?: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels: readonly { + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly labels_url?: string; - readonly locked: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - }; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ - readonly "webhook-issue-comment-deleted": { + "webhook-issue-comment-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly comment: components["schemas"]["webhooks_issue_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "deleted"; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at?: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels: readonly { + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly labels_url?: string; - readonly locked: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - 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"]; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; }; /** issue_comment edited event */ - readonly "webhook-issue-comment-edited": { + "webhook-issue-comment-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: components["schemas"]["webhooks_changes"]; - readonly comment: components["schemas"]["webhooks_issue_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at?: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels: readonly { + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly labels_url?: string; - readonly locked: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - }; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues assigned event */ - readonly "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "assigned"; - readonly assignee?: components["schemas"]["webhooks_user"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; - }; - /** issues closed event */ - readonly "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issue_comment pinned event */ + "webhook-issue-comment-pinned": { + /** @enum {string} */ + action: "pinned"; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + team_discussions?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly (Record | null)[]; - readonly labels_url?: string; - readonly locked?: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; - /** @enum {string} */ - readonly state: "closed" | "open"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - 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"]; - }; - /** issues deleted event */ - readonly "webhook-issues-deleted": { + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** issue_comment unpinned event */ + "webhook-issue-comment-unpinned": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly issue: { + action: "unpinned"; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + team_discussions?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues demilestoned event */ - readonly "webhook-issues-demilestoned": { + } & { + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** blocked by issue added event */ + "webhook-issue-dependencies-blocked-by-added": { + /** @enum {string} */ + action: "blocked_by_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocked by issue removed event */ + "webhook-issue-dependencies-blocked-by-removed": { + /** @enum {string} */ + action: "blocked_by_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue added event */ + "webhook-issue-dependencies-blocking-added": { /** @enum {string} */ - readonly action: "demilestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "blocking_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue removed event */ + "webhook-issue-dependencies-blocking-removed": { + /** @enum {string} */ + action: "blocking_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues assigned event */ + "webhook-issues-assigned": { /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * @description The action that was performed. + * @enum {string} */ - readonly issue: { + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; - } | null)[]; + url: string; + }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels?: (Record | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** @enum {string} */ + state: "closed" | "open"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; }; - /** issues edited event */ - readonly "webhook-issues-edited": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the issue. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title. */ - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - readonly "webhook-issues-labeled": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - readonly action: "labeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "demilestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; - }[]; + url: string; + } | null)[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly actions?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly administration?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; + type?: components["schemas"]["issue-type"]; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues edited event */ + "webhook-issues-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + /** @description Title of the issue */ + title: string; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { /** Format: uri */ - readonly url: string; - }; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues labeled event */ + "webhook-issues-labeled": { + /** @enum {string} */ + action: "labeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ - readonly "webhook-issues-locked": { + "webhook-issues-locked": { /** @enum {string} */ - readonly action: "locked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** @enum {boolean} */ - readonly locked: true; + locked: true; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ - readonly "webhook-issues-milestoned": { + "webhook-issues-milestoned": { /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ - readonly "webhook-issues-opened": { + "webhook-issues-opened": { /** @enum {string} */ - readonly action: "opened"; - readonly changes?: { + action: "opened"; + changes?: { /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly old_issue: { + old_issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees?: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body?: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at?: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; + comments_url?: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at?: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url?: string; /** Format: uri */ - readonly html_url: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url?: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone?: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id?: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url?: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title?: string; /** Format: date-time */ - readonly updated_at: string; + updated_at?: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url?: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - readonly user: { + user?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; } | null; /** * Repository * @description A git repository */ - readonly old_repository: { + old_repository: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** @description Whether the repository has discussions enabled. */ - readonly has_discussions?: boolean; + has_discussions?: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require commit signoff. */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ - readonly "webhook-issues-pinned": { + "webhook-issues-pinned": { /** @enum {string} */ - readonly action: "pinned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "pinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ - readonly "webhook-issues-reopened": { + "webhook-issues-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly state_reason?: string | null; + state: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ - readonly "webhook-issues-transferred": { + "webhook-issues-transferred": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { + action: "transferred"; + changes: { /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly new_issue: { + new_issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Repository * @description A git repository */ - readonly new_repository: { + new_repository: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues typed event */ + "webhook-issues-typed": { + /** @enum {string} */ + action: "typed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ - readonly "webhook-issues-unassigned": { + "webhook-issues-unassigned": { /** * @description The action that was performed. * @enum {string} */ - readonly action: "unassigned"; - readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ - readonly "webhook-issues-unlabeled": { + "webhook-issues-unlabeled": { /** @enum {string} */ - readonly action: "unlabeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: components["schemas"]["webhooks_issue"]; - 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"]; + action: "unlabeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ - readonly "webhook-issues-unlocked": { + "webhook-issues-unlocked": { /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "unlocked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** @enum {boolean} */ - readonly locked: false; + locked: false; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ - readonly "webhook-issues-unpinned": { + "webhook-issues-unpinned": { /** @enum {string} */ - readonly action: "unpinned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unpinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues untyped event */ + "webhook-issues-untyped": { + /** @enum {string} */ + action: "untyped"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ - readonly "webhook-label-created": { + "webhook-label-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ - readonly "webhook-label-deleted": { + "webhook-label-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ - readonly "webhook-label-edited": { + "webhook-label-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the label if the action was `edited`. */ - readonly changes?: { - readonly color?: { + changes?: { + color?: { /** @description The previous version of the color if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly description?: { + description?: { /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ - readonly "webhook-marketplace-purchase-cancelled": { + "webhook-marketplace-purchase-cancelled": { /** @enum {string} */ - readonly action: "cancelled"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - 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"]; + action: "cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + 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"]; }; /** marketplace_purchase changed event */ - readonly "webhook-marketplace-purchase-changed": { + "webhook-marketplace-purchase-changed": { /** @enum {string} */ - readonly action: "changed"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "changed"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean | null; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + previous_marketplace_purchase?: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean | null; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ - readonly "webhook-marketplace-purchase-pending-change": { + "webhook-marketplace-purchase-pending-change": { /** @enum {string} */ - readonly action: "pending_change"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "pending_change"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + previous_marketplace_purchase?: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ - readonly "webhook-marketplace-purchase-pending-change-cancelled": { + "webhook-marketplace-purchase-pending-change-cancelled": { /** @enum {string} */ - readonly action: "pending_change_cancelled"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "pending_change_cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** Marketplace Purchase */ - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: unknown; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; - 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"]; + 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"]; }; /** marketplace_purchase purchased event */ - readonly "webhook-marketplace-purchase-purchased": { + "webhook-marketplace-purchase-purchased": { /** @enum {string} */ - readonly action: "purchased"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - 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"]; + action: "purchased"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + 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"]; }; /** member added event */ - readonly "webhook-member-added": { + "webhook-member-added": { /** @enum {string} */ - readonly action: "added"; - readonly changes?: { + action: "added"; + changes?: { /** * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role * assigned to the collaborator, use the `role_name` field instead, which will provide the full * role name, including custom roles. */ - readonly permission?: { + permission?: { /** @enum {string} */ - readonly to: "write" | "admin" | "read"; + to: "write" | "admin" | "read"; }; /** @description The role assigned to the collaborator. */ - readonly role_name?: { - readonly to: string; + role_name?: { + to: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ - readonly "webhook-member-edited": { + "webhook-member-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the collaborator permissions */ - readonly changes: { - readonly old_permission?: { + changes: { + old_permission?: { /** @description The previous permissions of the collaborator if the action was edited. */ - readonly from: string; + from: string; }; - readonly permission?: { - readonly from?: string | null; - readonly to?: string | null; + permission?: { + from?: string | null; + to?: string | null; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ - readonly "webhook-member-removed": { + "webhook-member-removed": { /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ - readonly "webhook-membership-added": { + "webhook-membership-added": { /** @enum {string} */ - readonly action: "added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly member: components["schemas"]["webhooks_user"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** * @description The scope of the membership. Currently, can only be `team`. * @enum {string} */ - readonly scope: "team"; + scope: "team"; /** User */ - readonly sender: { + sender: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly team: components["schemas"]["webhooks_team"]; + team: components["schemas"]["webhooks_team"]; }; /** membership removed event */ - readonly "webhook-membership-removed": { + "webhook-membership-removed": { /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly member: components["schemas"]["webhooks_user"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** * @description The scope of the membership. Currently, can only be `team`. * @enum {string} */ - readonly scope: "team" | "organization"; + scope: "team" | "organization"; /** User */ - readonly sender: { + sender: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly team: components["schemas"]["webhooks_team"]; + team: components["schemas"]["webhooks_team"]; }; - readonly "webhook-merge-group-checks-requested": { + "webhook-merge-group-checks-requested": { /** @enum {string} */ - readonly action: "checks_requested"; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; - }; - readonly "webhook-merge-group-destroyed": { + action: "checks_requested"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + "webhook-merge-group-destroyed": { /** @enum {string} */ - readonly action: "destroyed"; + action: "destroyed"; /** * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). * @enum {string} */ - readonly reason?: "merged" | "invalidated" | "dequeued"; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + reason?: "merged" | "invalidated" | "dequeued"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ - readonly "webhook-meta-deleted": { + "webhook-meta-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ - readonly hook: { - readonly active: boolean; - readonly config: { + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + hook: { + active: boolean; + config: { /** @enum {string} */ - readonly content_type: "json" | "form"; - readonly insecure_ssl: string; - readonly secret?: string; + content_type: "json" | "form"; + insecure_ssl: string; + secret?: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly created_at: string; - readonly events: readonly ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; - readonly id: number; - readonly name: string; - readonly type: string; - readonly updated_at: string; + created_at: string; + events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; + id: number; + name: string; + type: string; + updated_at: string; }; /** @description The id of the modified webhook. */ - readonly hook_id: number; - 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"]; + hook_id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ - readonly "webhook-milestone-closed": { + "webhook-milestone-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ - readonly "webhook-milestone-created": { + "webhook-milestone-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ - readonly "webhook-milestone-deleted": { + "webhook-milestone-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ - readonly "webhook-milestone-edited": { + "webhook-milestone-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the milestone if the action was `edited`. */ - readonly changes: { - readonly description?: { + changes: { + description?: { /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly due_on?: { + due_on?: { /** @description The previous version of the due date if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly title?: { + title?: { /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ - readonly "webhook-milestone-opened": { + "webhook-milestone-opened": { /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ - readonly "webhook-org-block-blocked": { + "webhook-org-block-blocked": { /** @enum {string} */ - readonly action: "blocked"; - readonly blocked_user: components["schemas"]["webhooks_user"]; - 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"]; + action: "blocked"; + blocked_user: components["schemas"]["webhooks_user"]; + 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"]; }; /** org_block unblocked event */ - readonly "webhook-org-block-unblocked": { + "webhook-org-block-unblocked": { /** @enum {string} */ - readonly action: "unblocked"; - readonly blocked_user: components["schemas"]["webhooks_user"]; - 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"]; + action: "unblocked"; + blocked_user: components["schemas"]["webhooks_user"]; + 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"]; }; /** organization deleted event */ - readonly "webhook-organization-deleted": { + "webhook-organization-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ - readonly "webhook-organization-member-added": { + "webhook-organization-member-added": { /** @enum {string} */ - readonly action: "member_added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "member_added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ - readonly "webhook-organization-member-invited": { + "webhook-organization-member-invited": { /** @enum {string} */ - readonly action: "member_invited"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "member_invited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ - readonly invitation: { + invitation: { /** Format: date-time */ - readonly created_at: string; - readonly email: string | null; + created_at: string; + email: string | null; /** Format: date-time */ - readonly failed_at: string | null; - readonly failed_reason: string | null; - readonly id: number; + failed_at: string | null; + failed_reason: string | null; + id: number; /** Format: uri */ - readonly invitation_teams_url: string; + invitation_teams_url: string; /** User */ - readonly inviter: { + inviter: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly login: string | null; - readonly node_id: string; - readonly role: string; - readonly team_count: number; - readonly invitation_source?: string; + login: string | null; + node_id: string; + role: string; + team_count: number; + invitation_source?: string; }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - readonly user?: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ - readonly "webhook-organization-member-removed": { + "webhook-organization-member-removed": { /** @enum {string} */ - readonly action: "member_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "member_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ - readonly "webhook-organization-renamed": { + "webhook-organization-renamed": { /** @enum {string} */ - readonly action: "renamed"; - readonly changes?: { - readonly login?: { - readonly from?: string; + action: "renamed"; + changes?: { + login?: { + from?: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ - readonly "webhook-rubygems-metadata": { - readonly name?: string; - readonly description?: string; - readonly readme?: string; - readonly homepage?: string; - readonly version_info?: { - readonly version?: string; - }; - readonly platform?: string; - readonly metadata?: { - readonly [key: string]: string; - }; - readonly repo?: string; - readonly dependencies?: readonly { - readonly [key: string]: string; + "webhook-rubygems-metadata": { + name?: string; + description?: string; + readme?: string; + homepage?: string; + version_info?: { + version?: string; + }; + platform?: string; + metadata?: { + [key: string]: string; + }; + repo?: string; + dependencies?: { + [key: string]: string; }[]; - readonly commit_oid?: string; + commit_oid?: string; }; /** package published event */ - readonly "webhook-package-published": { + "webhook-package-published": { /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ - readonly package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; + package: { + created_at: string | null; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly package_type: string; - readonly package_version: { + package_type: string; + package_version: { /** User */ - readonly author?: { + author?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record | null; - readonly manifest?: Record | null; - readonly tag?: { - readonly digest?: string; - readonly name?: string; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; }; } | null; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: readonly { - readonly tags?: readonly string[]; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; }[]; - readonly draft?: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + /** Format: uri */ + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: Record | null; - readonly bugs?: Record | null; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: Record | null; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: Record | null; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: readonly Record[]; - readonly contributors?: readonly Record[]; - readonly engines?: Record; - readonly keywords?: readonly string[]; - readonly files?: readonly string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: Record | null; - readonly os?: readonly string[]; - readonly cpu?: readonly string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: Record | null; + bugs?: Record | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: Record | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: Record | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: Record[]; + contributors?: Record[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: Record | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; } | null; - readonly nuget_metadata?: readonly { - readonly id?: number | string; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; + nuget_metadata?: { + id?: number | string; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; }; }[] | null; - readonly package_files: readonly { - readonly content_type: string; - readonly created_at: string; - /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; + package_files: { + content_type: string; + created_at: string; + /** Format: uri */ + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { + package_url?: string; + prerelease?: boolean; + release?: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly created_at: string; - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; - /** Format: uri */ - readonly url: string; + created_at: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + /** Format: uri */ + url: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - readonly source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; } | null; - readonly registry: { + registry: { /** Format: uri */ - readonly about_url: string; - readonly name: string; - readonly type: string; + about_url: string; + name: string; + type: string; /** Format: uri */ - readonly url: string; - readonly vendor: string; + url: string; + vendor: string; } | null; - readonly updated_at: string | null; + updated_at: string | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ - readonly "webhook-package-updated": { + "webhook-package-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ - readonly package: { - readonly created_at: string; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; + package: { + created_at: string; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly package_type: string; - readonly package_version: { + package_type: string; + package_version: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: readonly { - readonly tags?: readonly string[]; + body: string; + body_html: string; + created_at: string; + description: string; + docker_metadata?: { + tags?: string[]; }[]; - readonly draft?: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + /** Format: uri */ + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly package_files: readonly { - readonly content_type: string; - readonly created_at: string; - /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string; - readonly size: number; - readonly state: string; - readonly updated_at: string; + name: string; + package_files: { + content_type: string; + created_at: string; + /** Format: uri */ + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string; + size: number; + state: string; + updated_at: string; }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { + package_url?: string; + prerelease?: boolean; + release?: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly created_at: string; - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; - /** Format: uri */ - readonly url: string; + created_at: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + /** Format: uri */ + url: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; /** Format: uri */ - readonly source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; - readonly registry: { + registry: { /** Format: uri */ - readonly about_url: string; - readonly name: string; - readonly type: string; + about_url: string; + name: string; + type: string; /** Format: uri */ - readonly url: string; - readonly vendor: string; + url: string; + vendor: string; } | null; - readonly updated_at: string; + updated_at: string; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ - readonly "webhook-page-build": { + "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ - readonly build: { - readonly commit: string | null; - readonly created_at: string; - readonly duration: number; - readonly error: { - readonly message: string | null; + build: { + commit: string | null; + created_at: string; + duration: number; + error: { + message: string | null; }; /** User */ - readonly pusher: { + pusher: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly status: string; - readonly updated_at: string; + status: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly id: number; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ - readonly "webhook-personal-access-token-request-approved": { + "webhook-personal-access-token-request-approved": { /** @enum {string} */ - readonly action: "approved"; - 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"]; - readonly installation: components["schemas"]["simple-installation"]; + action: "approved"; + 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"]; + installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ - readonly "webhook-personal-access-token-request-cancelled": { + "webhook-personal-access-token-request-cancelled": { /** @enum {string} */ - readonly action: "cancelled"; - 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"]; - readonly installation: components["schemas"]["simple-installation"]; + action: "cancelled"; + 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"]; + installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ - readonly "webhook-personal-access-token-request-created": { + "webhook-personal-access-token-request-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "created"; + 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"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ - readonly "webhook-personal-access-token-request-denied": { + "webhook-personal-access-token-request-denied": { /** @enum {string} */ - readonly action: "denied"; - 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"]; - readonly installation: components["schemas"]["simple-installation"]; + action: "denied"; + 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"]; + installation: components["schemas"]["simple-installation"]; }; - readonly "webhook-ping": { + "webhook-ping": { /** * Webhook * @description The webhook that is being pinged */ - readonly hook?: { + hook?: { /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ - readonly active: boolean; + active: boolean; /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ - readonly app_id?: number; - readonly config: { - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly url?: components["schemas"]["webhook-config-url"]; + app_id?: number; + config: { + content_type?: components["schemas"]["webhook-config-content-type"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + secret?: components["schemas"]["webhook-config-secret"]; + url?: components["schemas"]["webhook-config-url"]; }; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly deliveries_url?: string; + deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ - readonly events: readonly string[]; + events: string[]; /** @description Unique identifier of the webhook. */ - readonly id: number; - readonly last_response?: components["schemas"]["hook-response"]; + id: number; + last_response?: components["schemas"]["hook-response"]; /** * @description The type of webhook. The only valid value is 'web'. * @enum {string} */ - readonly name: "web"; + name: "web"; /** Format: uri */ - readonly ping_url?: string; + ping_url?: string; /** Format: uri */ - readonly test_url?: string; - readonly type: string; + test_url?: string; + type: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** @description The ID of the webhook that triggered the ping. */ - readonly hook_id?: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; + hook_id?: number; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ - readonly zen?: string; + zen?: string; }; /** @description The webhooks ping payload encoded with URL encoding. */ - readonly "webhook-ping-form-encoded": { + "webhook-ping-form-encoded": { /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** project_card converted event */ - readonly "webhook-project-card-converted": { + "webhook-project-card-converted": { /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly note: { - readonly from: string; + action: "converted"; + changes: { + note: { + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ - readonly "webhook-project-card-created": { + "webhook-project-card-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ - readonly "webhook-project-card-deleted": { + "webhook-project-card-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; + project_card: { + after_id?: number | null; /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number | null; + archived: boolean; + column_id: number | null; /** Format: uri */ - readonly column_url: string; + column_url: string; /** Format: uri */ - readonly content_url?: string; + content_url?: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; + id: number; + node_id: string; + note: string | null; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ - readonly "webhook-project-card-edited": { + "webhook-project-card-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly note: { - readonly from: string | null; + action: "edited"; + changes: { + note: { + from: string | null; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ - readonly "webhook-project-card-moved": { + "webhook-project-card-moved": { /** @enum {string} */ - readonly action: "moved"; - readonly changes?: { - readonly column_id: { - readonly from: number; + action: "moved"; + changes?: { + column_id: { + from: number; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly project_card: { - readonly after_id?: number | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: { + after_id?: number | null; /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; + archived: boolean; + column_id: number; /** Format: uri */ - readonly column_url: string; + column_url: string; /** Format: uri */ - readonly content_url?: string; + content_url?: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; + id: number; + node_id: string; + note: string | null; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } & { - readonly after_id: number | null; - readonly archived?: boolean; - readonly column_id?: number; - readonly column_url?: string; - readonly created_at?: string; - readonly creator?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + after_id: number | null; + archived?: boolean; + column_id?: number; + column_url?: string; + created_at?: string; + creator?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; } | null; - readonly id?: number; - readonly node_id?: string; - readonly note?: string | null; - readonly project_url?: string; - readonly updated_at?: string; - readonly url?: string; + id?: number; + node_id?: string; + note?: string | null; + project_url?: string; + updated_at?: string; + url?: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ - readonly "webhook-project-closed": { + "webhook-project-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ - readonly "webhook-project-column-created": { + "webhook-project-column-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ - readonly "webhook-project-column-deleted": { + "webhook-project-column-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ - readonly "webhook-project-column-edited": { + "webhook-project-column-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly name?: { - readonly from: string; + action: "edited"; + changes: { + name?: { + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ - readonly "webhook-project-column-moved": { + "webhook-project-column-moved": { /** @enum {string} */ - readonly action: "moved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "moved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ - readonly "webhook-project-created": { + "webhook-project-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ - readonly "webhook-project-deleted": { + "webhook-project-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ - readonly "webhook-project-edited": { + "webhook-project-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the project if the action was `edited`. */ - readonly changes?: { - readonly body?: { + changes?: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The changes to the project if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ - readonly "webhook-project-reopened": { + "webhook-project-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ - readonly "webhook-projects-v2-project-closed": { + "webhook-projects-v2-project-closed": { /** @enum {string} */ - readonly action: "closed"; - 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"]; + action: "closed"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ - readonly "webhook-projects-v2-project-created": { + "webhook-projects-v2-project-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ - readonly "webhook-projects-v2-project-deleted": { + "webhook-projects-v2-project-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ - readonly "webhook-projects-v2-project-edited": { + "webhook-projects-v2-project-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly description?: { - readonly from?: string | null; - readonly to?: string | null; + action: "edited"; + changes: { + description?: { + from?: string | null; + to?: string | null; }; - readonly public?: { - readonly from?: boolean; - readonly to?: boolean; + public?: { + from?: boolean; + to?: boolean; }; - readonly short_description?: { - readonly from?: string | null; - readonly to?: string | null; + short_description?: { + from?: string | null; + to?: string | null; }; - readonly title?: { - readonly from?: string; - readonly to?: string; + title?: { + from?: string; + to?: string; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ - readonly "webhook-projects-v2-item-archived": { + "webhook-projects-v2-item-archived": { /** @enum {string} */ - readonly action: "archived"; - readonly changes: components["schemas"]["webhooks_project_changes"]; - 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"]; + action: "archived"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ - readonly "webhook-projects-v2-item-converted": { + "webhook-projects-v2-item-converted": { /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly content_type?: { - readonly from?: string | null; - readonly to?: string; + action: "converted"; + changes: { + content_type?: { + from?: string | null; + to?: string; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ - readonly "webhook-projects-v2-item-created": { + "webhook-projects-v2-item-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ - readonly "webhook-projects-v2-item-deleted": { + "webhook-projects-v2-item-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ - readonly "webhook-projects-v2-item-edited": { + "webhook-projects-v2-item-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** * @description The changes made to the item may involve modifications in the item's fields and draft issue body. * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. */ - readonly changes?: { - readonly field_value: { - readonly field_node_id?: string; - readonly field_type?: string; - readonly field_name?: string; - readonly project_number?: number; - readonly from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; - readonly to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + changes?: { + field_value: { + field_node_id?: string; + field_type?: string; + field_name?: string; + project_number?: number; + from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { - readonly body: { - readonly from?: string | null; - readonly to?: string | null; + body: { + from?: string | null; + to?: string | null; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ - readonly "webhook-projects-v2-item-reordered": { + "webhook-projects-v2-item-reordered": { /** @enum {string} */ - readonly action: "reordered"; - readonly changes: { - readonly previous_projects_v2_item_node_id?: { - readonly from?: string | null; - readonly to?: string | null; + action: "reordered"; + changes: { + previous_projects_v2_item_node_id?: { + from?: string | null; + to?: string | null; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ - readonly "webhook-projects-v2-item-restored": { + "webhook-projects-v2-item-restored": { /** @enum {string} */ - readonly action: "restored"; - readonly changes: components["schemas"]["webhooks_project_changes"]; - 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"]; + action: "restored"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ - readonly "webhook-projects-v2-project-reopened": { + "webhook-projects-v2-project-reopened": { /** @enum {string} */ - readonly action: "reopened"; - 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"]; + action: "reopened"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ - readonly "webhook-projects-v2-status-update-created": { + "webhook-projects-v2-status-update-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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"]; }; /** Projects v2 Status Update Deleted Event */ - readonly "webhook-projects-v2-status-update-deleted": { + "webhook-projects-v2-status-update-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + 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"]; }; /** Projects v2 Status Update Edited Event */ - readonly "webhook-projects-v2-status-update-edited": { + "webhook-projects-v2-status-update-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly body?: { - readonly from?: string | null; - readonly to?: string | null; + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; }; - readonly status?: { + status?: { /** @enum {string|null} */ - readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** @enum {string|null} */ - readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; - readonly start_date?: { + start_date?: { /** Format: date */ - readonly from?: string | null; + from?: string | null; /** Format: date */ - readonly to?: string | null; + to?: string | null; }; - readonly target_date?: { + target_date?: { /** Format: date */ - readonly from?: string | null; + from?: string | null; /** Format: date */ - readonly to?: string | null; + to?: string | null; }; }; - 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"]; + 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"]; }; /** public event */ - readonly "webhook-public": { - 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"]; + "webhook-public": { + 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"]; }; /** pull_request assigned event */ - readonly "webhook-pull-request-assigned": { + "webhook-pull-request-assigned": { /** @enum {string} */ - readonly action: "assigned"; - readonly assignee: components["schemas"]["webhooks_user"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "assigned"; + assignee: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -54894,7 +59067,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -54902,76 +59075,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -54980,7 +59153,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -54988,250 +59161,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -55240,7 +59423,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -55248,76 +59431,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -55326,7 +59509,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -55334,765 +59517,775 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ - readonly "webhook-pull-request-auto-merge-disabled": { + "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ - readonly action: "auto_merge_disabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "auto_merge_disabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly has_pages: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -56101,7 +60294,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -56109,76 +60302,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -56187,7 +60380,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -56195,250 +60388,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -56447,7 +60650,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -56455,76 +60658,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -56533,7 +60736,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -56541,766 +60744,776 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly reason: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + reason: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ - readonly "webhook-pull-request-auto-merge-enabled": { + "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ - readonly action: "auto_merge_enabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "auto_merge_enabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -57309,7 +61522,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -57317,76 +61530,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -57395,7 +61608,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -57403,247 +61616,257 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -57652,7 +61875,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -57660,76 +61883,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -57738,7 +61961,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -57746,802 +61969,812 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly reason?: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + reason?: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ - readonly "webhook-pull-request-closed": { + "webhook-pull-request-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ - readonly "webhook-pull-request-converted-to-draft": { + "webhook-pull-request-converted-to-draft": { /** @enum {string} */ - readonly action: "converted_to_draft"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "converted_to_draft"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ - readonly "webhook-pull-request-demilestoned": { + "webhook-pull-request-demilestoned": { /** @enum {string} */ - readonly action: "demilestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "demilestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ - readonly "webhook-pull-request-dequeued": { + "webhook-pull-request-dequeued": { /** @enum {string} */ - readonly action: "dequeued"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "dequeued"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -58550,7 +62783,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -58558,76 +62791,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -58636,7 +62869,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -58644,250 +62877,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -58896,7 +63139,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -58904,76 +63147,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -58982,7 +63225,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -58990,798 +63233,808 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** @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"]; + 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"]; }; /** pull_request edited event */ - readonly "webhook-pull-request-edited": { + "webhook-pull-request-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the comment if the action was `edited`. */ - readonly changes: { - readonly base?: { - readonly ref: { - readonly from: string; + changes: { + base?: { + ref: { + from: string; }; - readonly sha: { - readonly from: string; + sha: { + from: string; }; }; - readonly body?: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly title?: { + title?: { /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ - readonly "webhook-pull-request-enqueued": { + "webhook-pull-request-enqueued": { /** @enum {string} */ - readonly action: "enqueued"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "enqueued"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -59790,7 +64043,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -59798,76 +64051,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -59876,7 +64129,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -59884,250 +64137,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -60136,7 +64399,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -60144,76 +64407,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -60222,7 +64485,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -60230,766 +64493,776 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ - readonly "webhook-pull-request-labeled": { + "webhook-pull-request-labeled": { /** @enum {string} */ - readonly action: "labeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly label?: components["schemas"]["webhooks_label"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "labeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -60998,7 +65271,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -61006,76 +65279,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -61084,7 +65357,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -61092,250 +65365,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -61344,7 +65627,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -61352,76 +65635,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -61430,7 +65713,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -61438,765 +65721,775 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ - readonly "webhook-pull-request-locked": { + "webhook-pull-request-locked": { /** @enum {string} */ - readonly action: "locked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -62205,7 +66498,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -62213,76 +66506,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -62291,7 +66584,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -62299,250 +66592,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -62551,7 +66854,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -62559,76 +66862,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -62637,7 +66940,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -62645,500 +66948,500 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ - readonly "webhook-pull-request-milestoned": { + "webhook-pull-request-milestoned": { /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ - readonly "webhook-pull-request-opened": { + "webhook-pull-request-opened": { /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ - readonly "webhook-pull-request-ready-for-review": { + "webhook-pull-request-ready-for-review": { /** @enum {string} */ - readonly action: "ready_for_review"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "ready_for_review"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ - readonly "webhook-pull-request-reopened": { + "webhook-pull-request-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ - readonly "webhook-pull-request-review-comment-created": { + "webhook-pull-request-review-comment-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ - readonly comment: { - readonly _links: { + comment: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -63146,456 +67449,466 @@ export type components = { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; + original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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 pull_request: { - readonly _links: { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + auto_merge?: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -63604,7 +67917,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -63612,76 +67925,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -63690,7 +68003,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -63698,243 +68011,253 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft?: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft?: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -63943,7 +68266,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -63951,76 +68274,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -64029,7 +68352,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -64037,711 +68360,721 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ - readonly "webhook-pull-request-review-comment-deleted": { + "webhook-pull-request-review-comment-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly comment: components["schemas"]["webhooks_review_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: { - readonly _links: { + action: "deleted"; + comment: components["schemas"]["webhooks_review_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + auto_merge?: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -64750,7 +69083,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -64758,76 +69091,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -64836,7 +69169,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -64844,243 +69177,253 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft?: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft?: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -65089,7 +69432,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -65097,76 +69440,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -65175,7 +69518,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -65183,713 +69526,723 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ - readonly "webhook-pull-request-review-comment-edited": { + "webhook-pull-request-review-comment-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: components["schemas"]["webhooks_changes"]; - readonly comment: components["schemas"]["webhooks_review_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: { - readonly _links: { + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_review_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + auto_merge?: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -65898,7 +70251,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -65906,76 +70259,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -65984,7 +70337,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -65992,243 +70345,253 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft?: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft?: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -66237,7 +70600,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -66245,76 +70608,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -66323,7 +70686,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -66331,711 +70694,721 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - readonly user_view_type?: string; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ - readonly url?: string; + url?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ - readonly "webhook-pull-request-review-dismissed": { + "webhook-pull-request-review-dismissed": { /** @enum {string} */ - readonly action: "dismissed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "dismissed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -67044,7 +71417,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -67052,76 +71425,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -67130,7 +71503,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -67138,243 +71511,253 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -67383,7 +71766,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -67391,76 +71774,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -67469,7 +71852,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -67477,386 +71860,386 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** @description The review that was affected. */ - readonly review: { - readonly _links: { + review: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -67864,1464 +72247,1476 @@ export type components = { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the review. */ - readonly body: string | null; + body: string | null; /** @description A commit SHA for the review. */ - readonly commit_id: string; + commit_id: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** Format: uri */ - readonly pull_request_url: string; + pull_request_url: string; /** @enum {string} */ - readonly state: "dismissed" | "approved" | "changes_requested"; + state: "dismissed" | "approved" | "changes_requested"; + /** Format: date-time */ + submitted_at: string; /** Format: date-time */ - readonly submitted_at: string; + updated_at?: string | null; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ - readonly "webhook-pull-request-review-edited": { + "webhook-pull-request-review-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body?: { + action: "edited"; + changes: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + review: components["schemas"]["webhooks_review"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ - readonly "webhook-pull-request-review-request-removed": { + "webhook-pull-request-review-request-removed": { /** @enum {string} */ - readonly action: "review_request_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_request_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -69330,7 +73725,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -69338,329 +73733,339 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title. * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -69669,7 +74074,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -69677,76 +74082,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -69755,7 +74160,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -69763,803 +74168,813 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** User */ - readonly requested_reviewer: { + requested_reviewer: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ - readonly action: "review_request_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_request_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -70568,7 +74983,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -70576,76 +74991,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -70654,7 +75069,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -70662,250 +75077,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -70914,7 +75339,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -70922,76 +75347,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -71000,7 +75425,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -71008,822 +75433,832 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly requested_team: { - readonly deleted?: boolean; + requested_team: { + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ - readonly "webhook-pull-request-review-requested": { + "webhook-pull-request-review-requested": { /** @enum {string} */ - readonly action: "review_requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_requested"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -71832,7 +76267,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -71840,76 +76275,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -71918,7 +76353,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -71926,250 +76361,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -72178,7 +76623,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -72186,76 +76631,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -72264,7 +76709,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -72272,803 +76717,813 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** User */ - readonly requested_reviewer: { + requested_reviewer: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ - readonly action: "review_requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_requested"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -73077,7 +77532,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -73085,76 +77540,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -73163,7 +77618,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -73171,250 +77626,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -73423,7 +77888,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -73431,76 +77896,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -73509,7 +77974,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -73517,818 +77982,828 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly requested_team: { - readonly deleted?: boolean; + requested_team: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ - readonly "webhook-pull-request-review-submitted": { + "webhook-pull-request-review-submitted": { /** @enum {string} */ - readonly action: "submitted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "submitted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -74337,7 +78812,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -74345,76 +78820,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -74423,7 +78898,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -74431,243 +78906,253 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -74676,7 +79161,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -74684,76 +79169,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -74762,7 +79247,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -74770,1461 +79255,1481 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + review: components["schemas"]["webhooks_review"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ - readonly "webhook-pull-request-review-thread-resolved": { + "webhook-pull-request-review-thread-resolved": { /** @enum {string} */ - readonly action: "resolved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "resolved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; - readonly thread: { - readonly comments: readonly { - readonly _links: { + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + thread: { + comments: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -76232,1213 +80737,1235 @@ export type components = { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; + original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }[]; - readonly node_id: string; + node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request_review_thread unresolved event */ - readonly "webhook-pull-request-review-thread-unresolved": { + "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ - readonly action: "unresolved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unresolved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + commit_title: string; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; - readonly thread: { - readonly comments: readonly { - readonly _links: { + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + thread: { + comments: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -77446,468 +81973,480 @@ export type components = { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; + original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }[]; - readonly node_id: string; + node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request synchronize event */ - readonly "webhook-pull-request-synchronize": { + "webhook-pull-request-synchronize": { /** @enum {string} */ - readonly action: "synchronize"; - readonly after: string; - readonly before: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "synchronize"; + after: string; + before: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -77916,7 +82455,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -77924,76 +82463,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -78002,7 +82541,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -78010,329 +82549,339 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit message title. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -78341,7 +82890,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -78349,766 +82898,776 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ - readonly "webhook-pull-request-unassigned": { + "webhook-pull-request-unassigned": { /** @enum {string} */ - readonly action: "unassigned"; - readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string | null; - readonly ref: string; + base: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -79117,7 +83676,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -79125,76 +83684,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -79203,7 +83762,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -79211,250 +83770,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -79463,7 +84032,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -79471,76 +84040,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -79549,7 +84118,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -79557,766 +84126,776 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ - readonly "webhook-pull-request-unlabeled": { + "webhook-pull-request-unlabeled": { /** @enum {string} */ - readonly action: "unlabeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly label?: components["schemas"]["webhooks_label"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unlabeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -80325,7 +84904,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -80333,76 +84912,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -80411,7 +84990,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -80419,329 +84998,339 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit message title. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -80750,7 +85339,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -80758,765 +85347,775 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ - readonly "webhook-pull-request-unlocked": { + "webhook-pull-request-unlocked": { /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unlocked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + commit_title: string; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -81525,7 +86124,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -81533,76 +86132,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -81611,7 +86210,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -81619,250 +86218,260 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -81871,7 +86480,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -81879,76 +86488,76 @@ export type components = { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -81957,7 +86566,7 @@ export type components = { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -81965,5727 +86574,6204 @@ export type components = { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ - readonly "webhook-push": { + "webhook-push": { /** @description The SHA of the most recent commit on `ref` after the push. */ - readonly after: string; - readonly base_ref: components["schemas"]["webhooks_nullable_string"]; + after: string; + base_ref: components["schemas"]["webhooks_nullable_string"]; /** @description The SHA of the most recent commit on `ref` before the push. */ - readonly before: string; + before: string; /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */ - readonly commits: readonly { + commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ - readonly added?: readonly string[]; + added?: string[]; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; + distinct: boolean; + id: string; /** @description The commit message. */ - readonly message: string; + message: string; /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */ - readonly modified?: readonly string[]; + modified?: string[]; /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ - readonly removed?: readonly string[]; + removed?: string[]; /** * Format: date-time * @description The ISO 8601 timestamp of the commit. */ - readonly timestamp: string; - readonly tree_id: string; + timestamp: string; + tree_id: string; /** * Format: uri * @description URL that points to the commit API resource. */ - readonly url: string; + url: string; }[]; /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ - readonly compare: string; + compare: string; /** @description Whether this push created the `ref`. */ - readonly created: boolean; + created: boolean; /** @description Whether this push deleted the `ref`. */ - readonly deleted: boolean; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + deleted: boolean; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ - readonly forced: boolean; + forced: boolean; /** Commit */ - readonly head_commit: { + head_commit: { /** @description An array of files added in the commit. */ - readonly added?: readonly string[]; + added?: string[]; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; + distinct: boolean; + id: string; /** @description The commit message. */ - readonly message: string; + message: string; /** @description An array of files modified by the commit. */ - readonly modified?: readonly string[]; + modified?: string[]; /** @description An array of files removed in the commit. */ - readonly removed?: readonly string[]; + removed?: string[]; /** * Format: date-time * @description The ISO 8601 timestamp of the commit. */ - readonly timestamp: string; - readonly tree_id: string; + timestamp: string; + tree_id: string; /** * Format: uri * @description URL that points to the commit API resource. */ - readonly url: string; + url: string; } | null; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly pusher: { + pusher: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email?: string | null; + email?: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ - readonly ref: string; + ref: string; /** * Repository * @description A git repository */ - readonly repository: { + repository: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sender?: components["schemas"]["simple-user"]; + sender?: components["schemas"]["simple-user"]; }; - readonly "webhook-registry-package-published": { + "webhook-registry-package-published": { /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; - }; - readonly package_type: string; - readonly package_version: { - readonly author?: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string | null; + description: string | null; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; + }; + package_type: string; + package_version: { + author?: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; }; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record | null; - readonly manifest?: Record | null; - readonly tag?: { - readonly digest?: string; - readonly name?: string; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; }; }; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: readonly { - readonly tags?: readonly string[]; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; }[]; - readonly draft?: boolean; - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: (string | Record) | null; - readonly bugs?: (string | Record) | null; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: (string | Record) | null; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: (string | Record) | null; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: readonly string[]; - readonly contributors?: readonly string[]; - readonly engines?: Record; - readonly keywords?: readonly string[]; - readonly files?: readonly string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: (string | Record) | null; - readonly os?: readonly string[]; - readonly cpu?: readonly string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: (string | Record) | null; + bugs?: (string | Record) | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: (string | Record) | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: (string | Record) | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: string[]; + contributors?: string[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: (string | Record) | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; } | null; - readonly nuget_metadata?: readonly { - readonly id?: (string | Record | number) | null; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; + nuget_metadata?: { + id?: (string | Record | number) | null; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; }; }[] | null; - readonly package_files: readonly { - readonly content_type: string; - readonly created_at: string; - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; + package_files: { + content_type: string; + created_at: string; + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + package_url: string; + prerelease?: boolean; + release?: { + author?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly prerelease?: boolean; - readonly published_at?: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly url?: string; + created_at?: string; + draft?: boolean; + html_url?: string; + id?: number; + name?: string | null; + prerelease?: boolean; + published_at?: string; + tag_name?: string; + target_commitish?: string; + url?: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; } | null; - readonly registry: { - readonly about_url?: string; - readonly name?: string; - readonly type?: string; - readonly url?: string; - readonly vendor?: string; + registry: { + about_url?: string; + name?: string; + type?: string; + url?: string; + vendor?: string; } | null; - readonly updated_at: string | null; + updated_at: string | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; - readonly "webhook-registry-package-updated": { + "webhook-registry-package-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string; - readonly description: unknown; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; - }; - readonly package_type: string; - readonly package_version: { - readonly author: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string; + description: unknown; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; + }; + package_type: string; + package_version: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; }; - readonly body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: readonly ({ - readonly tags?: readonly string[]; + body: string; + body_html: string; + created_at: string; + description: string; + docker_metadata?: ({ + tags?: string[]; } | null)[]; - readonly draft?: boolean; - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly package_files: readonly { - readonly content_type?: string; - readonly created_at?: string; - readonly download_url?: string; - readonly id?: number; - readonly md5?: string | null; - readonly name?: string; - readonly sha1?: string | null; - readonly sha256?: string; - readonly size?: number; - readonly state?: string; - readonly updated_at?: string; + name: string; + package_files: { + content_type?: string; + created_at?: string; + download_url?: string; + id?: number; + md5?: string | null; + name?: string; + sha1?: string | null; + sha256?: string; + size?: number; + state?: string; + updated_at?: string; }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; + package_url: string; + prerelease?: boolean; + release?: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; }; - readonly created_at: string; - readonly draft: boolean; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; - readonly url: string; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + url: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; - readonly registry: Record | null; - readonly updated_at: string; + registry: Record | null; + updated_at: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ - readonly "webhook-release-created": { + "webhook-release-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ - readonly "webhook-release-deleted": { + "webhook-release-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ - readonly "webhook-release-edited": { + "webhook-release-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body?: { + action: "edited"; + changes: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; + from: string; + }; + tag_name?: { + /** @description The previous version of the tag_name if the action was `edited`. */ + from: string; }; - readonly make_latest?: { + make_latest?: { /** @description Whether this release was explicitly `edited` to be the latest. */ - readonly to: boolean; + to: boolean; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ - readonly "webhook-release-prereleased": { + "webhook-release-prereleased": { /** @enum {string} */ - readonly action: "prereleased"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "prereleased"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** * Release * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ - readonly release: { - readonly assets: readonly ({ + release: { + assets: ({ /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + browser_download_url: string; + content_type: string; /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; + created_at: string; + download_count: number; + id: number; + label: string | null; /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + name: string; + node_id: string; + size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded"; + state: "uploaded"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly uploader?: { + uploader?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; /** Format: uri */ - readonly assets_url: string; + assets_url: string; /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: uri */ - readonly discussion_url?: string; + discussion_url?: string; /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; + name: string | null; + node_id: string; /** * @description Whether the release is identified as a prerelease or a full release. * @enum {boolean} */ - readonly prerelease: true; + prerelease: true; /** Format: date-time */ - readonly published_at: string | null; + published_at: string | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** Format: uri */ - readonly tarball_url: string | null; + tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; + target_commitish: string; /** Format: uri-template */ - readonly upload_url: string; + upload_url: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly zipball_url: string | null; + zipball_url: string | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ - readonly "webhook-release-published": { + "webhook-release-published": { /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ - readonly "webhook-release-released": { + "webhook-release-released": { /** @enum {string} */ - readonly action: "released"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "released"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ - readonly "webhook-release-unpublished": { + "webhook-release-unpublished": { /** @enum {string} */ - readonly action: "unpublished"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unpublished"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ - readonly "webhook-repository-advisory-published": { + "webhook-repository-advisory-published": { /** @enum {string} */ - readonly action: "published"; - 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 repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ - readonly "webhook-repository-advisory-reported": { + "webhook-repository-advisory-reported": { /** @enum {string} */ - readonly action: "reported"; - 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 repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "reported"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ - readonly "webhook-repository-archived": { + "webhook-repository-archived": { /** @enum {string} */ - readonly action: "archived"; - 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"]; + action: "archived"; + 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"]; }; /** repository created event */ - readonly "webhook-repository-created": { + "webhook-repository-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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"]; }; /** repository deleted event */ - readonly "webhook-repository-deleted": { + "webhook-repository-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + 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"]; }; /** repository_dispatch event */ - readonly "webhook-repository-dispatch-sample": { + "webhook-repository-dispatch-sample": { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ - readonly action: string; - readonly branch: string; + action: string; + branch: string; /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ - readonly client_payload: { - readonly [key: string]: unknown; + client_payload: { + [key: string]: unknown; } | 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"]; + 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"]; }; /** repository edited event */ - readonly "webhook-repository-edited": { + "webhook-repository-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly default_branch?: { - readonly from: string; + action: "edited"; + changes: { + default_branch?: { + from: string; }; - readonly description?: { - readonly from: string | null; + description?: { + from: string | null; }; - readonly homepage?: { - readonly from: string | null; + homepage?: { + from: string | null; }; - readonly topics?: { - readonly from?: readonly string[] | null; + topics?: { + from?: 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"]; + 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"]; }; /** repository_import event */ - readonly "webhook-repository-import": { - 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"]; + "webhook-repository-import": { + 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"]; /** @enum {string} */ - readonly status: "success" | "cancelled" | "failure"; + status: "success" | "cancelled" | "failure"; }; /** repository privatized event */ - readonly "webhook-repository-privatized": { + "webhook-repository-privatized": { /** @enum {string} */ - readonly action: "privatized"; - 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"]; + action: "privatized"; + 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"]; }; /** repository publicized event */ - readonly "webhook-repository-publicized": { + "webhook-repository-publicized": { /** @enum {string} */ - readonly action: "publicized"; - 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"]; + action: "publicized"; + 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"]; }; /** repository renamed event */ - readonly "webhook-repository-renamed": { + "webhook-repository-renamed": { /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly repository: { - readonly name: { - readonly from: string; + action: "renamed"; + changes: { + repository: { + name: { + from: string; }; }; }; - 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"]; + 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"]; }; /** repository ruleset created event */ - readonly "webhook-repository-ruleset-created": { + "webhook-repository-ruleset-created": { /** @enum {string} */ - readonly action: "created"; - 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 repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ - readonly "webhook-repository-ruleset-deleted": { + "webhook-repository-ruleset-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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 repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ - readonly "webhook-repository-ruleset-edited": { + "webhook-repository-ruleset-edited": { /** @enum {string} */ - readonly action: "edited"; - 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 repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly changes?: { - readonly name?: { - readonly from?: string; - }; - readonly enforcement?: { - readonly from?: string; - }; - readonly conditions?: { - readonly added?: readonly components["schemas"]["repository-ruleset-conditions"][]; - readonly deleted?: readonly components["schemas"]["repository-ruleset-conditions"][]; - readonly updated?: readonly { - readonly condition?: components["schemas"]["repository-ruleset-conditions"]; - readonly changes?: { - readonly condition_type?: { - readonly from?: string; + action: "edited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; }; - readonly target?: { - readonly from?: string; + target?: { + from?: string; }; - readonly include?: { - readonly from?: readonly string[]; + include?: { + from?: string[]; }; - readonly exclude?: { - readonly from?: readonly string[]; + exclude?: { + from?: string[]; }; }; }[]; }; - readonly rules?: { - readonly added?: readonly components["schemas"]["repository-rule"][]; - readonly deleted?: readonly components["schemas"]["repository-rule"][]; - readonly updated?: readonly { - readonly rule?: components["schemas"]["repository-rule"]; - readonly changes?: { - readonly configuration?: { - readonly from?: string; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; }; - readonly rule_type?: { - readonly from?: string; + rule_type?: { + from?: string; }; - readonly pattern?: { - readonly from?: string; + pattern?: { + from?: string; }; }; }[]; }; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ - readonly "webhook-repository-transferred": { + "webhook-repository-transferred": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly owner: { - readonly from: { + action: "transferred"; + changes: { + owner: { + from: { /** Organization */ - readonly organization?: { + organization?: { /** Format: uri */ - readonly avatar_url: string; - readonly description: string | null; + avatar_url: string; + description: string | null; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; + html_url?: string; + id: number; /** Format: uri */ - readonly issues_url: string; - readonly login: string; + issues_url: string; + login: string; /** Format: uri-template */ - readonly members_url: string; - readonly node_id: string; + members_url: string; + node_id: string; /** Format: uri-template */ - readonly public_members_url: string; + public_members_url: string; /** Format: uri */ - readonly repos_url: string; + repos_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** User */ - readonly user?: { + user?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + 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"]; }; /** repository unarchived event */ - readonly "webhook-repository-unarchived": { + "webhook-repository-unarchived": { /** @enum {string} */ - readonly action: "unarchived"; - 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"]; + action: "unarchived"; + 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"]; }; /** repository_vulnerability_alert create event */ - readonly "webhook-repository-vulnerability-alert-create": { + "webhook-repository-vulnerability-alert-create": { /** @enum {string} */ - readonly action: "create"; - readonly alert: components["schemas"]["webhooks_alert"]; - 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"]; + action: "create"; + alert: components["schemas"]["webhooks_alert"]; + 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"]; }; /** repository_vulnerability_alert dismiss event */ - readonly "webhook-repository-vulnerability-alert-dismiss": { + "webhook-repository-vulnerability-alert-dismiss": { /** @enum {string} */ - readonly action: "dismiss"; + action: "dismiss"; /** * Repository Vulnerability Alert Alert * @description The security alert of the vulnerable dependency. */ - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_comment?: string | null; - readonly dismiss_reason: string; - readonly dismissed_at: string; + alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_comment?: string | null; + dismiss_reason: string; + dismissed_at: string; /** User */ - readonly dismisser: { + dismisser: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly external_identifier: string; + external_identifier: string; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; + external_reference: string | null; + fix_reason?: string; /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - readonly state: "dismissed"; + state: "dismissed"; }; - 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"]; + 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"]; }; /** repository_vulnerability_alert reopen event */ - readonly "webhook-repository-vulnerability-alert-reopen": { + "webhook-repository-vulnerability-alert-reopen": { /** @enum {string} */ - readonly action: "reopen"; - readonly alert: components["schemas"]["webhooks_alert"]; - 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"]; + action: "reopen"; + alert: components["schemas"]["webhooks_alert"]; + 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"]; }; /** repository_vulnerability_alert resolve event */ - readonly "webhook-repository-vulnerability-alert-resolve": { + "webhook-repository-vulnerability-alert-resolve": { /** @enum {string} */ - readonly action: "resolve"; + action: "resolve"; /** * Repository Vulnerability Alert Alert * @description The security alert of the vulnerable dependency. */ - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; + alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; /** User */ - readonly dismisser?: { + dismisser?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly external_identifier: string; + external_identifier: string; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; + external_reference: string | null; + fix_reason?: string; /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - readonly state: "fixed" | "open"; + state: "fixed" | "open"; }; - 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"]; + 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 assigned event */ + "webhook-secret-scanning-alert-assigned": { + /** @enum {string} */ + action: "assigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 created event */ - readonly "webhook-secret-scanning-alert-created": { + "webhook-secret-scanning-alert-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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 Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created": { + "webhook-secret-scanning-alert-location-created": { /** @enum {string} */ - readonly action?: "created"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action?: "created"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + installation?: components["schemas"]["simple-installation"]; + location: components["schemas"]["secret-scanning-location"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created-form-encoded": { + "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; + payload: string; }; /** secret_scanning_alert publicly leaked event */ - readonly "webhook-secret-scanning-alert-publicly-leaked": { + "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"]; + 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 */ - readonly "webhook-secret-scanning-alert-reopened": { + "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ - readonly action: "reopened"; - 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"]; + action: "reopened"; + 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 resolved event */ - readonly "webhook-secret-scanning-alert-resolved": { + "webhook-secret-scanning-alert-resolved": { + /** @enum {string} */ + action: "resolved"; + 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 unassigned event */ + "webhook-secret-scanning-alert-unassigned": { /** @enum {string} */ - readonly action: "resolved"; - 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"]; + action: "unassigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 validated event */ - readonly "webhook-secret-scanning-alert-validated": { + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - readonly action: "validated"; - 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"]; + action: "validated"; + 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_scan completed event */ - readonly "webhook-secret-scanning-scan-completed": { + "webhook-secret-scanning-scan-completed": { /** @enum {string} */ - readonly action: "completed"; + action: "completed"; /** * @description What type of scan was completed * @enum {string} */ - readonly type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; /** * @description What type of content was scanned * @enum {string} */ - readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at: string; + started_at: string; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at: string; + completed_at: string; /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ - readonly secret_types?: readonly string[] | null; + secret_types?: string[] | null; /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ - readonly custom_pattern_name?: string | null; + custom_pattern_name?: string | null; /** * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ - readonly custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; - readonly repository?: components["schemas"]["repository-webhooks"]; - 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"]; + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ - readonly "webhook-security-advisory-published": { + "webhook-security-advisory-published": { /** @enum {string} */ - readonly action: "published"; - 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 security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ - readonly "webhook-security-advisory-updated": { + "webhook-security-advisory-updated": { /** @enum {string} */ - readonly action: "updated"; - 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 security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ - readonly "webhook-security-advisory-withdrawn": { + "webhook-security-advisory-withdrawn": { /** @enum {string} */ - readonly action: "withdrawn"; - 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"]; + action: "withdrawn"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly cwes: readonly { - readonly cwe_id: string; - readonly name: string; + security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + cwes: { + cwe_id: string; + name: string; }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: readonly { - readonly type: string; - readonly value: string; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; }[]; - readonly published_at: string; - readonly references: readonly { + published_at: string; + references: { /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: readonly { - readonly first_patched_version: { - readonly identifier: string; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; + package: { + ecosystem: string; + name: string; }; - readonly severity: string; - readonly vulnerable_version_range: string; + severity: string; + vulnerable_version_range: string; }[]; - readonly withdrawn_at: string; + withdrawn_at: string; }; - readonly sender?: components["schemas"]["simple-user"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ - readonly "webhook-security-and-analysis": { - readonly changes: { - readonly from?: { - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + "webhook-security-and-analysis": { + changes: { + from?: { + security_and_analysis?: components["schemas"]["security-and-analysis"]; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["full-repository"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ - readonly "webhook-sponsorship-cancelled": { + "webhook-sponsorship-cancelled": { /** @enum {string} */ - readonly action: "cancelled"; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "cancelled"; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ - readonly "webhook-sponsorship-created": { + "webhook-sponsorship-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "created"; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ - readonly "webhook-sponsorship-edited": { + "webhook-sponsorship-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly privacy_level?: { + action: "edited"; + changes: { + privacy_level?: { /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ - readonly from: string; + from: string; }; }; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ - readonly "webhook-sponsorship-pending-cancellation": { + "webhook-sponsorship-pending-cancellation": { /** @enum {string} */ - readonly action: "pending_cancellation"; - readonly effective_date?: components["schemas"]["webhooks_effective_date"]; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "pending_cancellation"; + effective_date?: components["schemas"]["webhooks_effective_date"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ - readonly "webhook-sponsorship-pending-tier-change": { + "webhook-sponsorship-pending-tier-change": { /** @enum {string} */ - readonly action: "pending_tier_change"; - readonly changes: components["schemas"]["webhooks_changes_8"]; - readonly effective_date?: components["schemas"]["webhooks_effective_date"]; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "pending_tier_change"; + changes: components["schemas"]["webhooks_changes_8"]; + effective_date?: components["schemas"]["webhooks_effective_date"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ - readonly "webhook-sponsorship-tier-changed": { + "webhook-sponsorship-tier-changed": { /** @enum {string} */ - readonly action: "tier_changed"; - readonly changes: components["schemas"]["webhooks_changes_8"]; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "tier_changed"; + changes: components["schemas"]["webhooks_changes_8"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ - readonly "webhook-star-created": { + "webhook-star-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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"]; /** @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; + starred_at: string | null; }; /** star deleted event */ - readonly "webhook-star-deleted": { + "webhook-star-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + 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"]; /** @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; + starred_at: unknown; }; /** status event */ - readonly "webhook-status": { + "webhook-status": { /** Format: uri */ - readonly avatar_url?: string | null; + avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ - readonly branches: readonly { - readonly commit: { - readonly sha: string | null; + branches: { + commit: { + sha: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; - readonly name: string; - readonly protected: boolean; + name: string; + protected: boolean; }[]; - readonly commit: { + commit: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly comments_url: string; - readonly commit: { - readonly author: { + comments_url: string; + commit: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; } & { - readonly date: string; - readonly email?: string; - readonly name?: string; + date: string; + email?: string; + name?: string; }; - readonly comment_count: number; - readonly committer: { + comment_count: number; + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; } & { - readonly date: string; - readonly email?: string; - readonly name?: string; + date: string; + email?: string; + name?: string; }; - readonly message: string; - readonly tree: { - readonly sha: string; + message: string; + tree: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly url: string; - readonly verification: { - readonly payload: string | null; + url: string; + verification: { + payload: string | null; /** @enum {string} */ - readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; - readonly signature: string | null; - readonly verified: boolean; - readonly verified_at?: string | null; + reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + signature: string | null; + verified: boolean; + verified_at: string | null; }; }; /** User */ - readonly committer: { + committer: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly html_url: string; - readonly node_id: string; - readonly parents: readonly { + html_url: string; + node_id: string; + parents: { /** Format: uri */ - readonly html_url: string; - readonly sha: string; + html_url: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly context: string; - readonly created_at: string; + context: string; + created_at: string; /** @description The optional human-readable description added to the status. */ - readonly description: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ - readonly id: number; - readonly installation?: components["schemas"]["simple-installation"]; - readonly name: string; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + id: number; + installation?: components["schemas"]["simple-installation"]; + name: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ - readonly sha: string; + sha: string; /** * @description The new state. Can be `pending`, `success`, `failure`, or `error`. * @enum {string} */ - readonly state: "pending" | "success" | "failure" | "error"; + state: "pending" | "success" | "failure" | "error"; /** @description The optional link added to the status. */ - readonly target_url: string | null; - readonly updated_at: string; + target_url: string | null; + updated_at: string; }; /** parent issue added event */ - readonly "webhook-sub-issues-parent-issue-added": { + "webhook-sub-issues-parent-issue-added": { /** @enum {string} */ - readonly action: "parent_issue_added"; + action: "parent_issue_added"; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - readonly parent_issue_repo: components["schemas"]["repository"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - 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"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ - readonly "webhook-sub-issues-parent-issue-removed": { + "webhook-sub-issues-parent-issue-removed": { /** @enum {string} */ - readonly action: "parent_issue_removed"; + action: "parent_issue_removed"; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - readonly parent_issue_repo: components["schemas"]["repository"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - 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"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ - readonly "webhook-sub-issues-sub-issue-added": { + "webhook-sub-issues-sub-issue-added": { /** @enum {string} */ - readonly action: "sub_issue_added"; + action: "sub_issue_added"; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - readonly sub_issue_repo: components["schemas"]["repository"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - 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"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ - readonly "webhook-sub-issues-sub-issue-removed": { + "webhook-sub-issues-sub-issue-removed": { /** @enum {string} */ - readonly action: "sub_issue_removed"; + action: "sub_issue_removed"; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - readonly sub_issue_repo: components["schemas"]["repository"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - 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"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** team_add event */ - readonly "webhook-team-add": { - 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"]; - readonly team: components["schemas"]["webhooks_team_1"]; + "webhook-team-add": { + 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"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ - readonly "webhook-team-added-to-repository": { + "webhook-team-added-to-repository": { /** @enum {string} */ - readonly action: "added_to_repository"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "added_to_repository"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ - readonly "webhook-team-created": { + "webhook-team-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ - readonly "webhook-team-deleted": { + "webhook-team-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ - readonly "webhook-team-edited": { + "webhook-team-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the team if the action was `edited`. */ - readonly changes: { - readonly description?: { + changes: { + description?: { /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly privacy?: { + privacy?: { /** @description The previous version of the team's privacy if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly notification_setting?: { + notification_setting?: { /** @description The previous version of the team's notification setting if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly repository?: { - readonly permissions: { - readonly from: { + repository?: { + permissions: { + from: { /** @description The previous version of the team member's `admin` permission on a repository, if the action was `edited`. */ - readonly admin?: boolean; + admin?: boolean; /** @description The previous version of the team member's `pull` permission on a repository, if the action was `edited`. */ - readonly pull?: boolean; + pull?: boolean; /** @description The previous version of the team member's `push` permission on a repository, if the action was `edited`. */ - readonly push?: boolean; + push?: boolean; }; }; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ - readonly "webhook-team-removed-from-repository": { + "webhook-team-removed-from-repository": { /** @enum {string} */ - readonly action: "removed_from_repository"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "removed_from_repository"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ - readonly "webhook-watch-started": { + "webhook-watch-started": { /** @enum {string} */ - readonly action: "started"; - 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"]; + action: "started"; + 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"]; }; /** workflow_dispatch event */ - readonly "webhook-workflow-dispatch": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly inputs: { - readonly [key: string]: unknown; + "webhook-workflow-dispatch": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + inputs: { + [key: string]: unknown; } | null; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - readonly workflow: string; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + workflow: string; }; /** workflow_job completed event */ - readonly "webhook-workflow-job-completed": { + "webhook-workflow-job-completed": { /** @enum {string} */ - readonly action: "completed"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; + action: "completed"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; + conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; + created_at: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; /** Format: uri */ - readonly run_url: string; + run_url: string; /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_id: number | null; + runner_group_id: number | null; /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_name: string | null; + runner_group_name: string | null; /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_id: number | null; + runner_id: number | null; /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_name: string | null; - readonly started_at: string; + runner_name: string | null; + started_at: string; /** * @description The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`. * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; + status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: readonly { - readonly completed_at: string | null; + workflow_name: string | null; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "queued"; + status: "in_progress" | "completed" | "queued"; }[]; /** Format: uri */ - readonly url: string; + url: string; } & { - readonly check_run_url?: string; - readonly completed_at?: string; + check_run_url?: string; + completed_at?: string; /** @enum {string} */ - readonly conclusion: "success" | "failure" | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; + conclusion: "success" | "failure" | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ - readonly created_at?: string; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly (string | null)[]; - readonly name?: string; - readonly node_id?: string; - readonly run_attempt?: number; - readonly run_id?: number; - readonly run_url?: string; - readonly runner_group_id?: number | null; - readonly runner_group_name?: string | null; - readonly runner_id?: number | null; - readonly runner_name?: string | null; - readonly started_at?: string; - readonly status?: string; + created_at?: string; + head_sha?: string; + html_url?: string; + id?: number; + labels?: (string | null)[]; + name?: string; + node_id?: string; + run_attempt?: number; + run_id?: number; + run_url?: string; + runner_group_id?: number | null; + runner_group_name?: string | null; + runner_id?: number | null; + runner_name?: string | null; + started_at?: string; + status?: string; /** @description The name of the current branch. */ - readonly head_branch?: string | null; + head_branch?: string | null; /** @description The name of the workflow. */ - readonly workflow_name?: string | null; - readonly steps?: readonly (Record | null)[]; - readonly url?: string; + workflow_name?: string | null; + steps?: (Record | null)[]; + url?: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_job in_progress event */ - readonly "webhook-workflow-job-in-progress": { + "webhook-workflow-job-in-progress": { /** @enum {string} */ - readonly action: "in_progress"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; + action: "in_progress"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | null | "cancelled" | "neutral"; + conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; + created_at: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; /** Format: uri */ - readonly run_url: string; + run_url: string; /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_id: number | null; + runner_group_id: number | null; /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_name: string | null; + runner_group_name: string | null; /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_id: number | null; + runner_id: number | null; /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_name: string | null; - readonly started_at: string; + runner_name: string | null; + started_at: string; /** * @description The current status of the job. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: readonly { - readonly completed_at: string | null; + workflow_name: string | null; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | null | "cancelled"; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | null | "cancelled"; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "queued" | "pending"; + status: "in_progress" | "completed" | "queued" | "pending"; }[]; /** Format: uri */ - readonly url: string; + url: string; } & { - readonly check_run_url?: string; - readonly completed_at?: string | null; - readonly conclusion?: string | null; + check_run_url?: string; + completed_at?: string | null; + conclusion?: string | null; /** @description The time that the job created. */ - readonly created_at?: string; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly string[]; - readonly name?: string; - readonly node_id?: string; - readonly run_attempt?: number; - readonly run_id?: number; - readonly run_url?: string; - readonly runner_group_id?: number | null; - readonly runner_group_name?: string | null; - readonly runner_id?: number | null; - readonly runner_name?: string | null; - readonly started_at?: string; + created_at?: string; + head_sha?: string; + html_url?: string; + id?: number; + labels?: string[]; + name?: string; + node_id?: string; + run_attempt?: number; + run_id?: number; + run_url?: string; + runner_group_id?: number | null; + runner_group_name?: string | null; + runner_id?: number | null; + runner_name?: string | null; + started_at?: string; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "queued"; + status: "in_progress" | "completed" | "queued"; /** @description The name of the current branch. */ - readonly head_branch?: string | null; + head_branch?: string | null; /** @description The name of the workflow. */ - readonly workflow_name?: string | null; - readonly steps: readonly { - readonly completed_at: string | null; - readonly conclusion: string | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + workflow_name?: string | null; + steps: { + completed_at: string | null; + conclusion: string | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "pending" | "queued"; + status: "in_progress" | "completed" | "pending" | "queued"; }[]; - readonly url?: string; + url?: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_job queued event */ - readonly "webhook-workflow-job-queued": { + "webhook-workflow-job-queued": { /** @enum {string} */ - readonly action: "queued"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; - readonly conclusion: string | null; + action: "queued"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; + conclusion: string | null; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; - /** Format: uri */ - readonly run_url: string; - readonly runner_group_id: number | null; - readonly runner_group_name: string | null; - readonly runner_id: number | null; - readonly runner_name: string | null; + created_at: string; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; + /** Format: uri */ + run_url: string; + runner_group_id: number | null; + runner_group_name: string | null; + runner_id: number | null; + runner_name: string | null; /** Format: date-time */ - readonly started_at: string; + started_at: string; /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; + status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: readonly { - readonly completed_at: string | null; + workflow_name: string | null; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending"; + status: "completed" | "in_progress" | "queued" | "pending"; }[]; /** Format: uri */ - readonly url: string; + url: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_job waiting event */ - readonly "webhook-workflow-job-waiting": { + "webhook-workflow-job-waiting": { /** @enum {string} */ - readonly action: "waiting"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; - readonly conclusion: string | null; + action: "waiting"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; + conclusion: string | null; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; - /** Format: uri */ - readonly run_url: string; - readonly runner_group_id: number | null; - readonly runner_group_name: string | null; - readonly runner_id: number | null; - readonly runner_name: string | null; + created_at: string; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; + /** Format: uri */ + run_url: string; + runner_group_id: number | null; + runner_group_name: string | null; + runner_id: number | null; + runner_name: string | null; /** Format: date-time */ - readonly started_at: string; + started_at: string; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; + workflow_name: string | null; /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; - readonly steps: readonly { - readonly completed_at: string | null; + status: "queued" | "in_progress" | "completed" | "waiting"; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; /** Format: uri */ - readonly url: string; + url: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_run completed event */ - readonly "webhook-workflow-run-completed": { + "webhook-workflow-run-completed": { /** @enum {string} */ - readonly action: "completed"; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + action: "completed"; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly artifacts_url: string; + artifacts_url: string; /** Format: uri */ - readonly cancel_url: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; + cancel_url: string; + check_suite_id: number; + check_suite_node_id: string; /** Format: uri */ - readonly check_suite_url: string; + check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string | null; + created_at: string; + event: string; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** Repository Lite */ - readonly head_repository: { + head_repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly jobs_url: string; + jobs_url: string; /** Format: uri */ - readonly logs_url: string; - readonly name: string | null; - readonly node_id: string; - readonly path: string; + logs_url: string; + name: string | null; + node_id: string; + path: string; /** Format: uri */ - readonly previous_attempt_url: string | null; - readonly pull_requests: readonly ({ - readonly base: { - readonly ref: string; + previous_attempt_url: string | null; + pull_requests: ({ + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; /** Repository Lite */ - readonly repository: { + repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly rerun_url: string; - readonly run_attempt: number; - readonly run_number: number; + rerun_url: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; + status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; + url: string; + workflow_id: number; /** Format: uri */ - readonly workflow_url: string; + workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. * @example Simple Workflow */ - readonly display_title?: string; + display_title?: string; }; }; /** workflow_run in_progress event */ - readonly "webhook-workflow-run-in-progress": { + "webhook-workflow-run-in-progress": { /** @enum {string} */ - readonly action: "in_progress"; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + action: "in_progress"; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly artifacts_url: string; + artifacts_url: string; /** Format: uri */ - readonly cancel_url: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; + cancel_url: string; + check_suite_id: number; + check_suite_node_id: string; /** Format: uri */ - readonly check_suite_url: string; + check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string | null; + created_at: string; + event: string; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** Repository Lite */ - readonly head_repository: { + head_repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string | null; - readonly node_id: string; + name: string | null; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly jobs_url: string; + jobs_url: string; /** Format: uri */ - readonly logs_url: string; - readonly name: string | null; - readonly node_id: string; - readonly path: string; + logs_url: string; + name: string | null; + node_id: string; + path: string; /** Format: uri */ - readonly previous_attempt_url: string | null; - readonly pull_requests: readonly ({ - readonly base: { - readonly ref: string; + previous_attempt_url: string | null; + pull_requests: ({ + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; /** Repository Lite */ - readonly repository: { + repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly rerun_url: string; - readonly run_attempt: number; - readonly run_number: number; + rerun_url: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; + url: string; + workflow_id: number; /** Format: uri */ - readonly workflow_url: string; + workflow_url: string; }; }; /** workflow_run requested event */ - readonly "webhook-workflow-run-requested": { + "webhook-workflow-run-requested": { /** @enum {string} */ - readonly action: "requested"; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + action: "requested"; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly artifacts_url: string; + artifacts_url: string; /** Format: uri */ - readonly cancel_url: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; + cancel_url: string; + check_suite_id: number; + check_suite_node_id: string; /** Format: uri */ - readonly check_suite_url: string; + check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string | null; + created_at: string; + event: string; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** Repository Lite */ - readonly head_repository: { + head_repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly jobs_url: string; + jobs_url: string; /** Format: uri */ - readonly logs_url: string; - readonly name: string | null; - readonly node_id: string; - readonly path: string; + logs_url: string; + name: string | null; + node_id: string; + path: string; /** Format: uri */ - readonly previous_attempt_url: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + previous_attempt_url: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; /** Repository Lite */ - readonly repository: { + repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly rerun_url: string; - readonly run_attempt: number; - readonly run_number: number; + rerun_url: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; + status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; + /** User */ + triggering_actor: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + /** Format: uri */ + workflow_url: string; + display_title: string; + }; + }; + /** CreateEvent */ + "create-event": { + ref: string; + ref_type: string; + full_ref: string; + master_branch: string; + description?: string | null; + pusher_type: string; + }; + /** DeleteEvent */ + "delete-event": { + ref: string; + ref_type: string; + full_ref: string; + pusher_type: string; + }; + /** DiscussionEvent */ + "discussion-event": { + action: string; + discussion: components["schemas"]["discussion"]; + }; + /** IssuesEvent */ + "issues-event": { + action: string; + issue: components["schemas"]["issue"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** IssueCommentEvent */ + "issue-comment-event": { + action: string; + issue: components["schemas"]["issue"]; + comment: components["schemas"]["issue-comment"]; + }; + /** ForkEvent */ + "fork-event": { + action: string; + forkee: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + private?: boolean; + owner?: components["schemas"]["simple-user"]; + html_url?: string; + description?: string | null; + fork?: boolean; + url?: string; + forks_url?: string; + keys_url?: string; + collaborators_url?: string; + teams_url?: string; + hooks_url?: string; + issue_events_url?: string; + events_url?: string; + assignees_url?: string; + branches_url?: string; + tags_url?: string; + blobs_url?: string; + git_tags_url?: string; + git_refs_url?: string; + trees_url?: string; + statuses_url?: string; + languages_url?: string; + stargazers_url?: string; + contributors_url?: string; + subscribers_url?: string; + subscription_url?: string; + commits_url?: string; + git_commits_url?: string; + comments_url?: string; + issue_comment_url?: string; + contents_url?: string; + compare_url?: string; + merges_url?: string; + archive_url?: string; + downloads_url?: string; + issues_url?: string; + pulls_url?: string; + milestones_url?: string; + notifications_url?: string; + labels_url?: string; + releases_url?: string; + deployments_url?: string; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + /** Format: date-time */ + pushed_at?: string | null; + git_url?: string; + ssh_url?: string; + clone_url?: string; + svn_url?: string; + homepage?: string | null; + size?: number; + stargazers_count?: number; + watchers_count?: number; + language?: string | null; + has_issues?: boolean; + has_projects?: boolean; + has_downloads?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + forks_count?: number; + mirror_url?: string | null; + archived?: boolean; + disabled?: boolean; + open_issues_count?: number; + license?: components["schemas"]["nullable-license-simple"]; + allow_forking?: boolean; + is_template?: boolean; + web_commit_signoff_required?: boolean; + topics?: string[]; + visibility?: string; + forks?: number; + open_issues?: number; + watchers?: number; + default_branch?: string; + public?: boolean; + }; + }; + /** GollumEvent */ + "gollum-event": { + pages: { + page_name?: string | null; + title?: string | null; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + /** MemberEvent */ + "member-event": { + action: string; + member: components["schemas"]["simple-user"]; + }; + /** PublicEvent */ + "public-event": Record; + /** PushEvent */ + "push-event": { + repository_id: number; + push_id: number; + ref: string; + head: string; + before: string; + }; + /** PullRequestEvent */ + "pull-request-event": { + action: string; + number: number; + pull_request: components["schemas"]["pull-request-minimal"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** PullRequestReviewCommentEvent */ + "pull-request-review-comment-event": { + action: string; + pull_request: components["schemas"]["pull-request-minimal"]; + comment: { + id: number; + node_id: string; + /** Format: uri */ + url: string; + pull_request_review_id: number | null; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + subject_type?: string | null; + commit_id: string; /** User */ - readonly triggering_actor: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + body: string; /** Format: date-time */ - readonly updated_at: string; + created_at: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; + html_url: string; + /** Format: uri */ + pull_request_url: string; + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + original_commit_id: string; + /** Reactions */ + reactions: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + /** Format: uri */ + url?: string; + }; + in_reply_to_id?: number; + }; + }; + /** PullRequestReviewEvent */ + "pull-request-review-event": { + action: string; + review: { + id?: number; + node_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + body?: string; + commit_id?: string; + submitted_at?: string | null; + state?: string; + /** Format: uri */ + html_url?: string; + /** Format: uri */ + pull_request_url?: string; + _links?: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + updated_at?: string; + }; + pull_request: components["schemas"]["pull-request-minimal"]; + }; + /** CommitCommentEvent */ + "commit-comment-event": { + action: string; + comment: { /** Format: uri */ - readonly workflow_url: string; - readonly display_title: string; + html_url?: string; + /** Format: uri */ + url?: string; + id?: number; + node_id?: string; + body?: string; + path?: string | null; + position?: number | null; + line?: number | null; + commit_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + }; + /** ReleaseEvent */ + "release-event": { + action: string; + release: components["schemas"]["release"] & { + is_short_description_html_truncated?: boolean; + short_description_html?: string; }; }; + /** WatchEvent */ + "watch-event": { + action: string; + }; }; responses: { /** @description Validation failed, or the endpoint has been spammed. */ - readonly validation_failed_simple: { + validation_failed_simple: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Resource not found */ - readonly not_found: { + not_found: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ - readonly bad_request: { + bad_request: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; + "application/json": components["schemas"]["basic-error"]; + "application/scim+json": components["schemas"]["scim-error"]; }; }; /** @description Validation failed, or the endpoint has been spammed. */ - readonly validation_failed: { + validation_failed: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"]; + "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ - readonly accepted: { + accepted: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": Record; + "application/json": Record; }; }; /** @description Not modified */ - readonly not_modified: { + not_modified: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Requires authentication */ - readonly requires_authentication: { + requires_authentication: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ - readonly forbidden: { + forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ - readonly conflict: { + conflict: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description A header with no content is returned. */ - readonly no_content: { + no_content: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Service unavailable */ - readonly service_unavailable: { + service_unavailable: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + code?: string; + message?: string; + documentation_url?: string; }; }; }; /** @description Forbidden Gist */ - readonly forbidden_gist: { + forbidden_gist: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly block?: { - readonly reason?: string; - readonly created_at?: string; - readonly html_url?: string | null; + "application/json": { + block?: { + reason?: string; + created_at?: string; + html_url?: string | null; }; - readonly message?: string; - readonly documentation_url?: string; + message?: string; + documentation_url?: string; }; }; }; /** @description Moved permanently */ - readonly moved_permanently: { + moved_permanently: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response when getting all budgets */ + get_all_budgets: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get_all_budgets"]; + }; + }; + /** @description Response when updating a budget */ + budget: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get-budget"]; + }; + }; + /** @description Response when deleting a budget */ + "delete-budget": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["delete-budget"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_org: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-premium-request-usage-report-org"]; }; }; /** @description Billing usage report response for an organization */ - readonly billing_usage_report_org: { + billing_usage_report_org: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["billing-usage-report"]; + "application/json": components["schemas"]["billing-usage-report"]; }; }; - /** @description Internal Error */ - readonly internal_error: { + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_org: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-summary-report-org"]; }; }; /** @description Response */ - readonly actions_runner_jitconfig: { + actions_runner_jitconfig: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly runner: components["schemas"]["runner"]; + "application/json": { + runner: components["schemas"]["runner"]; /** @description The base64 encoded runner configuration. */ - readonly encoded_jit_config: string; + encoded_jit_config: string; }; }; }; /** @description Response */ - readonly actions_runner_labels: { + actions_runner_labels: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly labels: readonly components["schemas"]["runner-label"][]; + "application/json": { + total_count: number; + labels: components["schemas"]["runner-label"][]; }; }; }; /** @description Response */ - readonly actions_runner_labels_readonly: { + actions_runner_labels_readonly: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly labels: readonly components["schemas"]["runner-label"][]; + "application/json": { + total_count: number; + labels: components["schemas"]["runner-label"][]; }; }; }; + /** @description Payload Too Large */ + too_large: { + headers: { + [name: string]: unknown; + }; + content: { + "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: { + usage_metrics_api_disabled: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - readonly package_es_list_error: { + package_es_list_error: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - /** @description Gone */ - readonly gone: { + /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */ + enterprise_team_unsupported: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Temporary Redirect */ + temporary_redirect: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Temporary Redirect */ - readonly temporary_redirect: { + /** @description Gone */ + gone: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ - readonly code_scanning_forbidden_read: { + code_scanning_forbidden_read: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ - readonly code_scanning_forbidden_write: { + code_scanning_forbidden_write: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ - readonly code_scanning_bad_request: { + code_scanning_bad_request: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ - readonly code_scanning_autofix_create_forbidden: { + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if analysis could not be processed */ + unprocessable_analysis: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ - readonly found: { + found: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ - readonly code_scanning_conflict: { + code_scanning_conflict: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ - readonly dependency_review_forbidden: { + /** @description Response if the configuration change cannot be made because the repository is not in the required state */ + code_scanning_invalid_state: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */ + dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unavailable due to service under maintenance. */ - readonly porter_maintenance: { + porter_maintenance: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ - readonly unacceptable: { + unacceptable: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report_user: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-summary-report-user"]; }; }; }; parameters: { /** @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 "pagination-before": string; + "pagination-before": string; /** @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 "pagination-after": string; + "pagination-after": string; /** @description The direction to sort the results by. */ - readonly direction: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: string; + ghsa_id: string; /** @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": number; + "per-page": number; /** @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: string; - readonly "delivery-id": number; + cursor: string; + "delivery-id": number; /** @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: number; + page: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since: string; + since: string; /** @description The unique identifier of the installation. */ - readonly "installation-id": number; + "installation-id": number; /** @description The client ID of the GitHub app. */ - readonly "client-id": string; - readonly "app-slug": string; + "client-id": string; + "app-slug": string; /** @description The unique identifier of the classroom assignment. */ - readonly "assignment-id": number; + "assignment-id": number; /** @description The unique identifier of the classroom. */ - readonly "classroom-id": number; - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: string; + "classroom-id": number; + /** @description The slug version of the enterprise name. */ + enterprise: string; /** @description The unique identifier of the code security configuration. */ - readonly "configuration-id": number; + "configuration-id": number; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly "dependabot-alert-comma-separated-states": string; + "dependabot-alert-comma-separated-states": string; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly "dependabot-alert-comma-separated-severities": string; + "dependabot-alert-comma-separated-severities": string; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly "dependabot-alert-comma-separated-ecosystems": string; + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly "dependabot-alert-comma-separated-packages": string; + "dependabot-alert-comma-separated-packages": string; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -87694,1748 +92780,2002 @@ export type components = { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly "dependabot-alert-comma-separated-epss": string; + "dependabot-alert-comma-separated-epss": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + "dependabot-alert-comma-separated-has": string | "patch"[]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + "dependabot-alert-comma-separated-assignees": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly "dependabot-alert-scope": "development" | "runtime"; + "dependabot-alert-scope": "development" | "runtime"; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly "pagination-first": number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly "pagination-last": number; - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly "secret-scanning-alert-secret-type": string; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly "secret-scanning-alert-resolution": string; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - 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; + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": string; + /** @description The handle for the GitHub user account. */ + username: string; + /** @description The organization name. The name is not case sensitive. */ + org: string; + /** @description The slug of the team name. */ + "team-slug": string; + /** @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)." */ + "public-events-per-page": number; /** @description The unique identifier of the gist. */ - readonly "gist-id": string; + "gist-id": string; /** @description The unique identifier of the comment. */ - readonly "comment-id": number; + "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels: string; + labels: string; /** @description account_id parameter */ - readonly "account-id": number; + "account-id": number; /** @description The unique identifier of the plan. */ - readonly "plan-id": number; + "plan-id": number; /** @description The property to sort the results by. */ - readonly sort: "created" | "updated"; + sort: "created" | "updated"; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: string; + owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: string; + repo: string; /** @description If `true`, show notifications marked as read. */ - readonly all: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before: string; + before: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly "thread-id": number; + "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - readonly "since-org": number; - /** @description The organization name. The name is not case sensitive. */ - readonly org: string; - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ - readonly "billing-usage-report-year": number; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - readonly "billing-usage-report-month": number; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ - readonly "billing-usage-report-day": number; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - readonly "billing-usage-report-hour": number; + "since-org": number; + /** @description The ID corresponding to the budget. */ + budget: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + "billing-usage-report-month-default": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + "billing-usage-report-day": number; + /** @description The user name to query usage for. The name is not case sensitive. */ + "billing-usage-report-user": string; + /** @description The model name to query usage for. The name is not case sensitive. */ + "billing-usage-report-model": string; + /** @description The product name to query usage for. The name is not case sensitive. */ + "billing-usage-report-product": string; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + "billing-usage-report-month": number; + /** @description The repository name to query for usage in the format owner/repository. */ + "billing-usage-report-repository": string; + /** @description The SKU to query for usage. */ + "billing-usage-report-sku": string; + /** @description Image definition ID of custom image */ + "actions-custom-image-definition-id": number; + /** @description Version of a custom image */ + "actions-custom-image-version": string; /** @description Unique identifier of the GitHub-hosted runner. */ - readonly "hosted-runner-id": number; + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ - readonly "repository-id": number; + "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - readonly "visible-to-repository": string; + "visible-to-repository": string; /** @description Unique identifier of the self-hosted runner group. */ - readonly "runner-group-id": number; + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ - readonly "runner-id": number; + "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ - readonly "runner-label-name": string; + "runner-label-name": string; /** @description The name of the secret. */ - readonly "secret-name": string; + "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly "variables-per-page": number; + "variables-per-page": number; /** @description The name of the variable. */ - readonly "variable-name": string; - /** @description The handle for the GitHub user account. */ - readonly username: string; + "variable-name": string; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + "subject-digest": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + "dependabot-alert-comma-separated-artifact-registry-urls": string; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + "dependabot-alert-comma-separated-artifact-registry": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + "dependabot-alert-comma-separated-runtime-risk": string; /** @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; + "hook-id": number; /** @description The type of the actor */ - readonly "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ - readonly "api-insights-actor-id": number; + "api-insights-actor-id": number; /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "api-insights-min-timestamp": string; + "api-insights-min-timestamp": string; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "api-insights-max-timestamp": string; + "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")[]; + "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - readonly "api-insights-api-route-substring": string; + "api-insights-api-route-substring": string; /** @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")[]; + "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - readonly "api-insights-subject-name-substring": string; + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ - readonly "api-insights-user-id": string; + "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; + "api-insights-timestamp-increment": string; /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - readonly "api-insights-actor-name-substring": string; + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ - readonly "invitation-id": number; + "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ - readonly "codespace-name": string; + "codespace-name": string; /** @description The unique identifier of the migration. */ - readonly "migration-id": number; + "migration-id": number; /** @description repo_name parameter */ - readonly "repo-name": string; - /** @description The slug of the team name. */ - readonly "team-slug": string; + "repo-name": string; /** @description The unique identifier of the role. */ - readonly "role-id": number; + "role-id": number; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly "package-visibility": "public" | "private" | "internal"; + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** @description The name of the package. */ - readonly "package-name": string; + "package-name": string; /** @description Unique identifier of the package version. */ - readonly "package-version-id": number; + "package-version-id": number; /** @description The property by which to sort the results. */ - readonly "personal-access-token-sort": "created_at"; + "personal-access-token-sort": "created_at"; /** @description A list of owner usernames to use to filter the results. */ - readonly "personal-access-token-owner": readonly string[]; + "personal-access-token-owner": string[]; /** @description The name of the repository to use to filter the results. */ - readonly "personal-access-token-repository": string; + "personal-access-token-repository": string; /** @description The permission to use to filter the results. */ - readonly "personal-access-token-permission": string; + "personal-access-token-permission": string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "personal-access-token-before": string; + "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "personal-access-token-after": string; + "personal-access-token-after": string; + /** @description The ID of the token */ + "personal-access-token-token-id": string[]; /** @description The unique identifier of the fine-grained personal access token. */ - readonly "fine-grained-personal-access-token-id": number; + "fine-grained-personal-access-token-id": number; + /** @description The project's number. */ + "project-number": number; + /** @description The unique identifier of the field. */ + "field-id": number; + /** @description The unique identifier of the project item. */ + "item-id": number; + /** @description The number that identifies the project view. */ + "view-number": number; /** @description The custom property name */ - readonly "custom-property-name": string; + "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; + "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; + "ref-in-query": string; /** @description The name of the repository to filter on. */ - readonly "repository-name-in-query": string; + "repository-name-in-query": string; /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ - readonly "time-period": "hour" | "day" | "week" | "month"; + "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - readonly "actor-name-in-query": string; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - readonly "rule-suite-result": "pass" | "fail" | "bypass" | "all"; + "actor-name-in-query": string; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + "rule-suite-result": "pass" | "fail" | "bypass" | "all"; /** * @description The unique identifier of the rule suite result. * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) * for organizations. */ - readonly "rule-suite-id": number; + "rule-suite-id": number; + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + "secret-scanning-alert-resolution": string; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + "secret-scanning-alert-assignee": string; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + "secret-scanning-alert-sort": "created" | "updated"; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - readonly "secret-scanning-pagination-before-org-repo": string; + "secret-scanning-pagination-before-org-repo": string; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - readonly "secret-scanning-pagination-after-org-repo": string; + "secret-scanning-pagination-after-org-repo": string; + /** @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 A boolean value representing whether or not to hide literal secrets in the results. */ + "secret-scanning-alert-hide-secret": boolean; /** @description Unique identifier of the hosted compute network configuration. */ - readonly "network-configuration-id": string; + "network-configuration-id": string; /** @description Unique identifier of the hosted compute network settings. */ - readonly "network-settings-id": string; - /** @description The number that identifies the discussion. */ - readonly "discussion-number": number; - /** @description The number that identifies the comment. */ - readonly "comment-number": number; - /** @description The unique identifier of the reaction. */ - readonly "reaction-id": number; - /** @description The unique identifier of the project. */ - readonly "project-id": number; + "network-settings-id": string; /** @description The security feature to enable or disable. */ - readonly "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; + "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; /** * @description The action to take. * * `enable_all` means to enable the specified security feature for all repositories in the organization. * `disable_all` means to disable the specified security feature for all repositories in the organization. */ - readonly "org-security-product-enablement": "enable_all" | "disable_all"; - /** @description The unique identifier of the card. */ - readonly "card-id": number; - /** @description The unique identifier of the column. */ - readonly "column-id": number; + "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - readonly "artifact-name": string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ - readonly "artifact-id": number; + "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - readonly "actions-cache-git-ref-full": string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - readonly "actions-cache-key": string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - readonly "actions-cache-list-sort": "created_at" | "last_accessed_at" | "size_in_bytes"; + "actions-cache-list-sort": "created_at" | "last_accessed_at" | "size_in_bytes"; /** @description A key for identifying the cache. */ - readonly "actions-cache-key-required": string; + "actions-cache-key-required": string; /** @description The unique identifier of the GitHub Actions cache. */ - readonly "cache-id": number; + "cache-id": number; /** @description The unique identifier of the job. */ - readonly "job-id": number; + "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly "workflow-run-branch": string; + "workflow-run-branch": string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event: string; + event: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ - readonly "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; + "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly "exclude-pull-requests": boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - readonly "workflow-run-head-sha": string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ - readonly "run-id": number; + "run-id": number; /** @description The attempt number of the workflow run. */ - readonly "attempt-number": number; + "attempt-number": number; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly "workflow-id": number | string; + "workflow-id": number | string; /** @description The unique identifier of the autolink. */ - readonly "autolink-id": number; + "autolink-id": number; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: string; + branch: string; /** @description The unique identifier of the check run. */ - readonly "check-run-id": number; + "check-run-id": number; /** @description The unique identifier of the check suite. */ - readonly "check-suite-id": number; + "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - readonly "check-name": string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - readonly status: "queued" | "in_progress" | "completed"; + 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"]; + "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; + "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"]; + "alert-number": components["schemas"]["alert-number"]; + /** @description The unique identifier of the reaction. */ + "reaction-id": number; /** @description The SHA of the commit. */ - readonly "commit-sha": string; + "commit-sha": string; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly "commit-ref": string; + "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - readonly "dependabot-alert-comma-separated-manifests": string; + "dependabot-alert-comma-separated-manifests": string; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, * or in `number` fields in the response from the * `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */ - readonly "dependabot-alert-number": components["schemas"]["alert-number"]; + "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - readonly "manifest-path": string; + "manifest-path": string; /** @description deployment_id parameter */ - readonly "deployment-id": number; + "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly "environment-name": string; + "environment-name": string; /** @description The unique identifier of the branch policy. */ - readonly "branch-policy-id": number; + "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ - readonly "protection-rule-id": number; + "protection-rule-id": number; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly "git-ref-only": string; + "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly "since-user": number; + "since-user": number; /** @description The number that identifies the issue. */ - readonly "issue-number": number; + "issue-number": number; /** @description The unique identifier of the key. */ - readonly "key-id": number; + "key-id": number; /** @description The number that identifies the milestone. */ - readonly "milestone-number": number; + "milestone-number": number; /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ - readonly "pages-deployment-id": number | string; + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ - readonly "pull-number": number; + "pull-number": number; /** @description The unique identifier of the review. */ - readonly "review-id": number; + "review-id": number; /** @description The unique identifier of the asset. */ - readonly "asset-id": number; + "asset-id": number; /** @description The unique identifier of the release. */ - readonly "release-id": number; - /** @description The unique identifier of the tag protection. */ - readonly "tag-protection-id": number; + "release-id": number; /** @description The time frame to display results for. */ - readonly per: "day" | "week"; + per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - readonly "since-repo": number; + "since-repo": number; /** @description 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"; + order: "desc" | "asc"; + /** + * @description Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + "issues-advanced-search": string; /** @description The unique identifier of the team. */ - readonly "team-id": number; + "team-id": number; /** @description ID of the Repository to filter on */ - readonly "repository-id-in-query": number; + "repository-id-in-query": number; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - readonly "export-id": string; + "export-id": string; /** @description The unique identifier of the GPG key. */ - readonly "gpg-key-id": number; + "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "since-repo-date": string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "before-repo-date": string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ - readonly "ssh-signing-key-id": number; + "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - readonly "sort-starred": "created" | "updated"; + "sort-starred": "created" | "updated"; + /** @description The unique identifier of the user. */ + "user-id": string; }; requestBodies: never; headers: { /** @example ; rel="next", ; rel="last" */ - readonly link: string; + link: string; /** @example text/html */ - readonly "content-type": string; + "content-type": string; /** @example 0.17.4 */ - readonly "x-common-marker-version": string; + "x-common-marker-version": string; /** @example 5000 */ - readonly "x-rate-limit-limit": number; + "x-rate-limit-limit": number; /** @example 4999 */ - readonly "x-rate-limit-remaining": number; + "x-rate-limit-remaining": number; /** @example 1590701888 */ - readonly "x-rate-limit-reset": number; + "x-rate-limit-reset": number; /** @example https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D */ - readonly location: string; + location: string; }; pathItems: never; -}; +} export type $defs = Record; export interface operations { - readonly "meta/root": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["root"]; + "application/json": components["schemas"]["root"]; }; }; }; }; - readonly "security-advisories/list-global-advisories": { - readonly parameters: { - readonly query?: { + "security-advisories/list-global-advisories": { + parameters: { + query?: { /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */ - readonly ghsa_id?: string; + ghsa_id?: string; /** @description If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. */ - readonly type?: "reviewed" | "malware" | "unreviewed"; + type?: "reviewed" | "malware" | "unreviewed"; /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ - readonly cve_id?: string; + cve_id?: string; /** @description If specified, only advisories for these ecosystems will be returned. */ - readonly ecosystem?: components["schemas"]["security-advisory-ecosystems"]; + ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ - readonly severity?: "unknown" | "low" | "medium" | "high" | "critical"; + severity?: "unknown" | "low" | "medium" | "high" | "critical"; /** * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. * * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` */ - readonly cwes?: string | readonly string[]; + cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ - readonly is_withdrawn?: boolean; + is_withdrawn?: boolean; /** * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ - readonly affects?: string | readonly string[]; + affects?: string | string[]; /** * @description If specified, only return advisories that were published on a date or date range. * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly published?: string; + published?: string; /** * @description If specified, only return advisories that were updated on a date or date range. * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly updated?: string; + updated?: string; /** * @description If specified, only show advisories that were updated or published on a date or date range. * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly modified?: string; + modified?: string; /** * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. * The EPSS percentage represents the likelihood of a CVE being exploited. */ - readonly epss_percentage?: string; + epss_percentage?: string; /** * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ - readonly epss_percentile?: string; + epss_percentile?: string; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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?: number; + per_page?: number; /** @description The property to sort the results by. */ - readonly sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["global-advisory"][]; + "application/json": components["schemas"]["global-advisory"][]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed_simple"]; /** @description Too many requests */ - readonly 429: { + 429: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "security-advisories/get-global-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/get-global-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["global-advisory"]; + "application/json": components["schemas"]["global-advisory"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/get-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"]; + "application/json": components["schemas"]["integration"]; }; }; }; }; - readonly "apps/create-from-manifest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly code: string; + "apps/create-from-manifest": { + parameters: { + query?: never; + header?: never; + path: { + code: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"] & ({ - readonly client_id: string; - readonly client_secret: string; - readonly webhook_secret: string | null; - readonly pem: string; + "application/json": components["schemas"]["integration"] & ({ + client_id: string; + client_secret: string; + webhook_secret: string | null; + pem: string; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }); }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "apps/get-webhook-config-for-app": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "apps/update-webhook-config-for-app": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + 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"]; + 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"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "apps/list-webhook-deliveries": { - readonly parameters: { - readonly query?: { + "apps/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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + cursor?: components["parameters"]["cursor"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly delivery_id: components["parameters"]["delivery-id"]; + "apps/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["hook-delivery"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/redeliver-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly delivery_id: components["parameters"]["delivery-id"]; + "apps/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/list-installation-requests-for-authenticated-app": { - readonly parameters: { - readonly query?: { + "apps/list-installation-requests-for-authenticated-app": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description List of integration installation requests */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration-installation-request"][]; + "application/json": components["schemas"]["integration-installation-request"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "apps/list-installations": { - readonly parameters: { - readonly query?: { + "apps/list-installations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; - readonly outdated?: string; + since?: components["parameters"]["since"]; + outdated?: string; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The permissions the installation has are included under the `permissions` key. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["installation"][]; + "application/json": components["schemas"]["installation"][]; }; }; }; }; - readonly "apps/get-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/delete-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/delete-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/create-installation-access-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/create-installation-access-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description List of repository names that the token should have access to */ - readonly repositories?: readonly string[]; + repositories?: string[]; /** * @description List of repository IDs that the token should have access to * @example [ * 1 * ] */ - readonly repository_ids?: readonly number[]; - readonly permissions?: components["schemas"]["app-permissions"]; + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation-token"]; + "application/json": components["schemas"]["installation-token"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/suspend-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/suspend-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/unsuspend-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/unsuspend-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/delete-authorization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/delete-authorization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The OAuth access token used to authenticate to the GitHub API. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/check-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/check-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The access_token of the OAuth or GitHub application. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authorization"]; + "application/json": components["schemas"]["authorization"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/delete-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/delete-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The OAuth access token used to authenticate to the GitHub API. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/reset-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/reset-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The access_token of the OAuth or GitHub application. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authorization"]; + "application/json": components["schemas"]["authorization"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/scope-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/scope-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - readonly access_token: string; + access_token: string; /** * @description The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified. * @example octocat */ - readonly target?: string; + target?: string; /** * @description The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified. * @example 1 */ - readonly target_id?: number; + target_id?: number; /** @description The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. */ - readonly repositories?: readonly string[]; + repositories?: string[]; /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ * 1 * ] */ - readonly repository_ids?: readonly number[]; - readonly permissions?: components["schemas"]["app-permissions"]; + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authorization"]; + "application/json": components["schemas"]["authorization"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-by-slug": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly app_slug: components["parameters"]["app-slug"]; + "apps/get-by-slug": { + parameters: { + query?: never; + header?: never; + path: { + app_slug: components["parameters"]["app-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"]; + "application/json": components["schemas"]["integration"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/get-an-assignment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "classroom/get-an-assignment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the classroom assignment. */ - readonly assignment_id: components["parameters"]["assignment-id"]; + assignment_id: components["parameters"]["assignment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["classroom-assignment"]; + "application/json": components["schemas"]["classroom-assignment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-accepted-assignments-for-an-assignment": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the classroom assignment. */ - readonly assignment_id: components["parameters"]["assignment-id"]; + assignment_id: components["parameters"]["assignment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["classroom-accepted-assignment"][]; + "application/json": components["schemas"]["classroom-accepted-assignment"][]; }; }; }; }; - readonly "classroom/get-assignment-grades": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "classroom/get-assignment-grades": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the classroom assignment. */ - readonly assignment_id: components["parameters"]["assignment-id"]; + assignment_id: components["parameters"]["assignment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["classroom-assignment-grade"][]; + "application/json": components["schemas"]["classroom-assignment-grade"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-classrooms": { - readonly parameters: { - readonly query?: { + "classroom/list-classrooms": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-classroom"][]; + "application/json": components["schemas"]["simple-classroom"][]; }; }; }; }; - readonly "classroom/get-a-classroom": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "classroom/get-a-classroom": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the classroom. */ - readonly classroom_id: components["parameters"]["classroom-id"]; + classroom_id: components["parameters"]["classroom-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["classroom"]; + "application/json": components["schemas"]["classroom"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-assignments-for-a-classroom": { - readonly parameters: { - readonly query?: { + "classroom/list-assignments-for-a-classroom": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the classroom. */ - readonly classroom_id: components["parameters"]["classroom-id"]; + classroom_id: components["parameters"]["classroom-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-classroom-assignment"][]; + "application/json": components["schemas"]["simple-classroom-assignment"][]; }; }; }; }; - readonly "codes-of-conduct/get-all-codes-of-conduct": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-of-conduct"][]; + "application/json": components["schemas"]["code-of-conduct"][]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "codes-of-conduct/get-conduct-code": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly key: string; + "codes-of-conduct/get-conduct-code": { + parameters: { + query?: never; + header?: never; + path: { + key: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-of-conduct"]; + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + }; + }; + "credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of credentials to be revoked, up to 1000 per request. */ + credentials: string[]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; + }; + responses: { + 202: components["responses"]["accepted"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "emojis/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly [key: string]: string; + "application/json": { + [key: string]: string; }; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; + }; + }; + "actions/get-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-configurations-for-enterprise": { - readonly parameters: { - readonly query?: { + "actions/set-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-configurations-for-enterprise": { + 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)." */ - readonly per_page?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + "application/json": components["schemas"]["code-security-configuration"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/create-configuration-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique within the enterprise. */ - readonly name: string; + name: string; /** @description A description of the code security configuration */ - readonly description: string; + description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @default disabled * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. * @default false */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @default disabled * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @default disabled * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @default disabled * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning validity checks * @default disabled * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non provider patterns * @default disabled * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @default enforced * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Successfully created code security configuration */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-default-configurations-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/get-default-configurations-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-default-configurations"]; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; }; }; - readonly "code-security/get-single-configuration-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/delete-configuration-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - }; - }; - readonly "code-security/update-enterprise-configuration": { - readonly parameters: { - readonly query?: never; - 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"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique across the enterprise. */ - readonly name?: string; + name?: string; /** @description A description of the code security configuration */ - readonly description?: string; + description?: string; /** - * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of code scanning default setup * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/attach-enterprise-configuration": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** - * @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` + * @description The type of repositories to attach the configuration to. * @enum {string} */ - readonly scope: "all" | "all_without_configurations"; + scope: "all" | "all_without_configurations"; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/set-configuration-as-default-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Specify which types of repository this security configuration should be applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; }; }; - readonly responses: { + responses: { /** @description Default successfully changed. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description Specifies which types of repository this security configuration is applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-repositories-for-enterprise-configuration": { - readonly parameters: { - readonly query?: { + "code-security/get-repositories-for-enterprise-configuration": { + 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)." */ - readonly per_page?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. * * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ - readonly status?: string; + status?: string; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependabot/list-alerts-for-enterprise": { - readonly parameters: { - readonly query?: { + "dependabot/list-alerts-for-enterprise": { + parameters: { + query?: { /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -89444,203 +94784,693 @@ export interface operations { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly scope?: components["parameters"]["dependabot-alert-scope"]; + scope?: components["parameters"]["dependabot-alert-scope"]; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly sort?: components["parameters"]["dependabot-alert-sort"]; + sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + 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"]; + 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly last?: components["parameters"]["pagination-last"]; + after?: components["parameters"]["pagination-after"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["dependabot-alert-with-repository"][]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "secret-scanning/list-alerts-for-enterprise": { - readonly parameters: { - readonly query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + "enterprise-teams/list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; - /** @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 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"]; + 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"]; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["enterprise-team"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-public-events": { - readonly parameters: { - readonly query?: { + "enterprise-teams/create": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description A description of the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be set. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + }; + }; + "enterprise-team-memberships/list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to add to the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully added team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to be removed from the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully removed team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User is a member of the enterprise team. */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["simple-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 503: components["responses"]["service_unavailable"]; }; }; - readonly "activity/get-feeds": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "enterprise-team-memberships/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { + /** @description Successfully added team member */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-team-organizations/get-assignments": { + 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 slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description An array of organizations the team is assigned to */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to assign the team to. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully assigned the enterprise team to organizations. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to unassign the team from. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully unassigned the enterprise team from organizations. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/get-assignment": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The team is assigned to the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + /** @description The team is not assigned to the organization */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully assigned the enterprise team to the organization. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + }; + }; + "enterprise-team-organizations/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully unassigned the enterprise team from the organization. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-teams/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A new name for the team. */ + name?: string | null; + /** @description A new description for the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be changed. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/list-public-events": { + 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"]["public-events-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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["feed"]; + "application/json": components["schemas"]["event"][]; }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "gists/list": { - readonly parameters: { - readonly query?: { + "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["feed"]; + }; + }; + }; + }; + "gists/list": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "gists/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Description of the gist * @example Example Ruby script */ - readonly description?: string; + description?: string; /** * @description Names and content for the files that make up the gist * @example { @@ -89649,164 +95479,164 @@ export interface operations { * } * } */ - readonly files: { - readonly [key: string]: { + files: { + [key: string]: { /** @description Content of the file */ - readonly content: string; + content: string; }; }; - readonly public?: boolean | ("true" | "false"); + public?: boolean | ("true" | "false"); }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/list-public": { - readonly parameters: { - readonly query?: { + "gists/list-public": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/list-starred": { - readonly parameters: { - readonly query?: { + "gists/list-starred": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "gists/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden_gist"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden_gist"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/delete": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The description of the gist. * @example Example Ruby script */ - readonly description?: string; + description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename * (including extension) of the targeted gist file. For example: `hello.py`. @@ -89820,1336 +95650,1776 @@ export interface operations { * } * } */ - readonly files?: { - readonly [key: string]: { + files?: { + [key: string]: { /** @description The new content of the file. */ - readonly content?: string; + content?: string; /** @description The new filename for the file. */ - readonly filename?: string | null; + filename?: string | null; } | null; }; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/list-comments": { - readonly parameters: { - readonly query?: { + "gists/list-comments": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gist-comment"][]; + "application/json": components["schemas"]["gist-comment"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/create-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/create-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-comment"]; + "application/json": components["schemas"]["gist-comment"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/get-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/get-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-comment"]; + "application/json": components["schemas"]["gist-comment"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden_gist"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden_gist"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/delete-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/delete-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/update-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/update-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-comment"]; + "application/json": components["schemas"]["gist-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/list-commits": { - readonly parameters: { - readonly query?: { + "gists/list-commits": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gist-commit"][]; + "application/json": components["schemas"]["gist-commit"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/list-forks": { - readonly parameters: { - readonly query?: { + "gists/list-forks": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gist-simple"][]; + "application/json": components["schemas"]["gist-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/fork": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/fork": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["base-gist"]; + "application/json": components["schemas"]["base-gist"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/check-is-starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/check-is-starred": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if gist is starred */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": Record; + "application/json": Record; }; }; }; }; - readonly "gists/star": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/star": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/unstar": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/unstar": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/get-revision": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/get-revision": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; - readonly sha: string; + gist_id: components["parameters"]["gist-id"]; + sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gitignore/get-all-templates": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "gitignore/get-template": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly name: string; + "gitignore/get-template": { + parameters: { + query?: never; + header?: never; + path: { + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gitignore-template"]; + "application/json": components["schemas"]["gitignore-template"]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "apps/list-repos-accessible-to-installation": { - readonly parameters: { - readonly query?: { + "apps/list-repos-accessible-to-installation": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; /** @example selected */ - readonly repository_selection?: string; + repository_selection?: string; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "apps/revoke-installation-access-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list": { - readonly parameters: { - readonly query?: { + "issues/list": { + parameters: { + query?: { /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; - readonly collab?: boolean; - readonly orgs?: boolean; - readonly owned?: boolean; - readonly pulls?: boolean; + since?: components["parameters"]["since"]; + collab?: boolean; + orgs?: boolean; + owned?: boolean; + pulls?: boolean; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "licenses/get-all-commonly-used": { - readonly parameters: { - readonly query?: { - readonly featured?: boolean; + "licenses/get-all-commonly-used": { + parameters: { + query?: { + featured?: boolean; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["license-simple"][]; + "application/json": components["schemas"]["license-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "licenses/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly license: string; + "licenses/get": { + parameters: { + query?: never; + header?: never; + path: { + license: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["license"]; + "application/json": components["schemas"]["license"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "markdown/render": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The Markdown text to render in HTML. */ - readonly text: string; + text: string; /** * @description The rendering mode. * @default markdown * @example markdown * @enum {string} */ - readonly mode?: "markdown" | "gfm"; + mode?: "markdown" | "gfm"; /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - readonly context?: string; + context?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly "Content-Type": components["headers"]["content-type"]; + "Content-Type": components["headers"]["content-type"]; /** @example 279 */ - readonly "Content-Length"?: string; - readonly "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; - readonly [name: string]: unknown; + "Content-Length"?: string; + "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { - readonly "text/html": string; + "text/html": string; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "markdown/render-raw": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "text/plain": string; - readonly "text/x-markdown": string; + requestBody?: { + content: { + "text/plain": string; + "text/x-markdown": string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; - readonly [name: string]: unknown; + "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { - readonly "text/html": string; + "text/html": string; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "apps/get-subscription-plan-for-account": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-subscription-plan-for-account": { + parameters: { + query?: never; + header?: never; + path: { /** @description account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; + account_id: components["parameters"]["account-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["marketplace-purchase"]; + "application/json": components["schemas"]["marketplace-purchase"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "apps/list-plans": { - readonly parameters: { - readonly query?: { + "apps/list-plans": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][]; + "application/json": components["schemas"]["marketplace-listing-plan"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/list-accounts-for-plan": { - readonly parameters: { - readonly query?: { + "apps/list-accounts-for-plan": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the plan. */ - readonly plan_id: components["parameters"]["plan-id"]; + plan_id: components["parameters"]["plan-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-purchase"][]; + "application/json": components["schemas"]["marketplace-purchase"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-subscription-plan-for-account-stubbed": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-subscription-plan-for-account-stubbed": { + parameters: { + query?: never; + header?: never; + path: { /** @description account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; + account_id: components["parameters"]["account-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["marketplace-purchase"]; + "application/json": components["schemas"]["marketplace-purchase"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "apps/list-plans-stubbed": { - readonly parameters: { - readonly query?: { + "apps/list-plans-stubbed": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][]; + "application/json": components["schemas"]["marketplace-listing-plan"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "apps/list-accounts-for-plan-stubbed": { - readonly parameters: { - readonly query?: { + "apps/list-accounts-for-plan-stubbed": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the plan. */ - readonly plan_id: components["parameters"]["plan-id"]; + plan_id: components["parameters"]["plan-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-purchase"][]; + "application/json": components["schemas"]["marketplace-purchase"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "meta/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-overview"]; + "application/json": components["schemas"]["api-overview"]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "activity/list-public-events-for-repo-network": { - readonly parameters: { - readonly query?: { + "activity/list-public-events-for-repo-network": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "activity/list-notifications-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-notifications-for-authenticated-user": { + parameters: { + query?: { /** @description If `true`, show notifications marked as read. */ - readonly all?: components["parameters"]["all"]; + all?: components["parameters"]["all"]; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating?: components["parameters"]["participating"]; + participating?: components["parameters"]["participating"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; + before?: components["parameters"]["before"]; /** @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"]; + page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; + per_page?: number; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["thread"][]; + "application/json": components["schemas"]["thread"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "activity/mark-notifications-as-read": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - readonly last_read_at?: string; + last_read_at?: string; /** @description Whether the notification has been read. */ - readonly read?: boolean; + read?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; + "application/json": { + message?: string; }; }; }; /** @description Reset Content */ - readonly 205: { + 205: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/get-thread": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/get-thread": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread"]; + "application/json": components["schemas"]["thread"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/mark-thread-as-done": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/mark-thread-as-done": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No content */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "activity/mark-thread-as-read": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/mark-thread-as-read": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Reset Content */ - readonly 205: { + 205: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/get-thread-subscription-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/get-thread-subscription-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread-subscription"]; + "application/json": components["schemas"]["thread-subscription"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/set-thread-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/set-thread-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to block all notifications from a thread. * @default false */ - readonly ignored?: boolean; + ignored?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread-subscription"]; + "application/json": components["schemas"]["thread-subscription"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/delete-thread-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/delete-thread-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "meta/get-octocat": { - readonly parameters: { - readonly query?: { + "meta/get-octocat": { + parameters: { + query?: { /** @description The words to show in Octocat's speech bubble */ - readonly s?: string; + s?: string; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/octocat-stream": string; + "application/octocat-stream": string; }; }; }; }; - readonly "orgs/list": { - readonly parameters: { - readonly query?: { + "orgs/list": { + parameters: { + query?: { /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-org"]; + since?: components["parameters"]["since-org"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + "actions/get-actions-cache-retention-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-retention-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-organization": { + 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": components["schemas"]["actions-cache-retention-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "billing/get-github-billing-usage-report-org": { - readonly parameters: { - readonly query?: { - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ - readonly year?: components["parameters"]["billing-usage-report-year"]; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - readonly month?: components["parameters"]["billing-usage-report-month"]; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ - readonly day?: components["parameters"]["billing-usage-report-day"]; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - readonly hour?: components["parameters"]["billing-usage-report-hour"]; + "actions/get-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; - readonly header?: never; - readonly path: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["billing_usage_report_org"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/repository-access-for-org": { + parameters: { + query?: { + /** @description The page number of results to fetch. */ + page?: number; + /** @description Number of results per page. */ + per_page?: number; + }; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-full"]; + "application/json": components["schemas"]["dependabot-repository-access-details"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/update-repository-access-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 List of repository IDs to add. */ + repository_ids_to_add?: number[]; + /** @description List of repository IDs to remove. */ + repository_ids_to_remove?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/set-repository-access-default-level": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + requestBody: { + content: { + "application/json": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string} + */ + default_level: "public" | "internal"; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "billing/get-all-budgets-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: never; + responses: { + 200: components["responses"]["get_all_budgets"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "billing/get-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/delete-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete-budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/update-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert?: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients?: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** @description The name of the entity to apply the budget to */ + budget_entity_name?: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + responses: { + /** @description Budget updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Budget successfully updated. */ + message?: string; + budget?: { + /** @description ID of the budget. */ + id?: string; + /** + * Format: float + * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. + */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @default + */ + budget_entity_name: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Budget not found or feature not enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "billing/get-github-billing-premium-request-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The user name to query usage for. The name is not case sensitive. */ + user?: components["parameters"]["billing-usage-report-user"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "orgs/get": { + parameters: { + query?: never; + 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"]["organization-full"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/update": { + 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 Billing email address. This address is not publicized. */ - readonly billing_email?: string; + billing_email?: string; /** @description The company name. */ - readonly company?: string; + company?: string; /** @description The publicly visible email address. */ - readonly email?: string; + email?: string; /** @description The Twitter username of the company. */ - readonly twitter_username?: string; + twitter_username?: string; /** @description The location. */ - readonly location?: string; + location?: string; /** @description The shorthand name of the company. */ - readonly name?: string; + name?: string; /** @description The description of the company. The maximum size is 160 characters. */ - readonly description?: string; + description?: string; /** @description Whether an organization can use organization projects. */ - readonly has_organization_projects?: boolean; + has_organization_projects?: boolean; /** @description Whether repositories that belong to the organization can use repository projects. */ - readonly has_repository_projects?: boolean; + has_repository_projects?: boolean; /** * @description Default permission level members have for organization repositories. * @default read * @enum {string} */ - readonly default_repository_permission?: "read" | "write" | "admin" | "none"; + default_repository_permission?: "read" | "write" | "admin" | "none"; /** * @description Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - readonly members_can_create_repositories?: boolean; + members_can_create_repositories?: boolean; /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean; /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean; /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_public_repositories?: boolean; + 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 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"; + members_allowed_repository_creation_type?: "all" | "private" | "none"; /** * @description Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_pages?: boolean; + members_can_create_pages?: boolean; /** * @description Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean; /** * @description Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean; /** * @description Whether organization members can fork private organization repositories. * @default false */ - readonly members_can_fork_private_repositories?: boolean; + members_can_fork_private_repositories?: boolean; /** * @description Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface. * @default false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ - readonly blog?: string; + blog?: string; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91160,7 +97430,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly advanced_security_enabled_for_new_repositories?: boolean; + advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91171,7 +97441,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly dependabot_alerts_enabled_for_new_repositories?: boolean; + dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91182,7 +97452,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; + dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91193,7 +97463,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly dependency_graph_enabled_for_new_repositories?: boolean; + dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91204,7 +97474,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly secret_scanning_enabled_for_new_repositories?: boolean; + secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91215,2340 +97485,3682 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean; + secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ - readonly secret_scanning_push_protection_custom_link_enabled?: boolean; + 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; + 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; + deploy_keys_enabled_for_repositories?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-full"]; + "application/json": components["schemas"]["organization-full"]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; /** @description Validation failed */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; }; }; }; }; - readonly "actions/get-actions-cache-usage-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-actions-cache-usage-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; + "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; }; }; }; }; - readonly "actions/get-actions-cache-usage-by-repo-for-org": { - readonly parameters: { - readonly query?: { + "actions/get-actions-cache-usage-by-repo-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repository_cache_usages: readonly components["schemas"]["actions-cache-usage-by-repository"][]; + "application/json": { + total_count: number; + repository_cache_usages: components["schemas"]["actions-cache-usage-by-repository"][]; }; }; }; }; }; - readonly "actions/list-hosted-runners-for-org": { - readonly parameters: { - readonly query?: { + "actions/list-hosted-runners-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; }; }; }; }; }; - readonly "actions/create-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name: string; + name: string; /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ - readonly image: { + image: { /** @description The unique identifier of the runner image. */ - readonly id?: string; + id?: string; /** * @description The source of the runner image. * @enum {string} */ - readonly source?: "github" | "partner" | "custom"; + source?: "github" | "partner" | "custom"; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ - readonly version?: string | null; + version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ - readonly size: string; + size: string; /** @description The existing runner group to add this runner to. */ - readonly runner_group_id: number; + runner_group_id: number; /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ - readonly maximum_runners?: number; + maximum_runners?: number; /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ - readonly enable_static_ip?: boolean; + enable_static_ip?: boolean; + /** + * @description Whether this runner should be used to generate custom images. + * @default false + */ + image_gen?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "actions/get-hosted-runners-github-owned-images-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-custom-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-custom-image"][]; }; }; }; }; }; - readonly "actions/get-hosted-runners-partner-images-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-custom-image-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image"]; + }; + }; + }; + }; + "actions/delete-custom-image-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-custom-image-versions-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + "application/json": { + total_count: number; + image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][]; }; }; }; }; }; - readonly "actions/get-hosted-runners-limits-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-custom-image-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner-limits"]; + "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"]; }; }; }; }; - readonly "actions/get-hosted-runners-machine-specs-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-custom-image-version-from-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly machine_specs: readonly components["schemas"]["actions-hosted-runner-machine-spec"][]; + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; }; }; - readonly "actions/get-hosted-runners-platforms-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly platforms: readonly string[]; + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; }; }; - readonly "actions/get-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-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 GitHub-hosted runner. */ - readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + hosted_runner_id: components["parameters"]["hosted-runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "actions/delete-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the GitHub-hosted runner. */ - readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + hosted_runner_id: components["parameters"]["hosted-runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "actions/update-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the GitHub-hosted runner. */ - readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + hosted_runner_id: components["parameters"]["hosted-runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name?: string; + name?: string; /** @description The existing runner group to add this runner to. */ - readonly runner_group_id?: number; + runner_group_id?: number; /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ - readonly maximum_runners?: number; + maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ - readonly enable_static_ip?: boolean; + enable_static_ip?: boolean; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size?: string; + /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image_id?: string; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ - readonly image_version?: string | null; + image_version?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "oidc/get-oidc-custom-sub-template-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "oidc/get-oidc-custom-sub-template-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description A JSON serialized template for OIDC subject claim customization */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["oidc-custom-sub"]; + "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - readonly "oidc/update-oidc-custom-sub-template-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "oidc/update-oidc-custom-sub-template-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["oidc-custom-sub"]; + requestBody: { + content: { + "application/json": components["schemas"]["oidc-custom-sub"]; }; }; - readonly responses: { + responses: { /** @description Empty response */ - readonly 201: { + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-github-actions-permissions-organization": { + parameters: { + query?: never; + 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: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["actions-organization-permissions"]; + }; + }; + }; + }; + "actions/set-github-actions-permissions-organization": { + 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": { + enabled_repositories: components["schemas"]["enabled-repositories"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "actions/get-github-actions-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-organization-permissions"]; + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-github-actions-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; }; - readonly cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly enabled_repositories: components["schemas"]["enabled-repositories"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; - readonly responses: { + }; + "actions/get-fork-pr-contributor-approval-permissions-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-organization": { + 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": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/list-selected-repositories-enabled-github-actions-organization": { - readonly parameters: { - readonly query?: { + "actions/set-private-repo-fork-pr-workflows-settings-organization": { + 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": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-enabled-github-actions-organization": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; }; }; }; }; }; - readonly "actions/set-selected-repositories-enabled-github-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-selected-repositories-enabled-github-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of repository IDs to enable for GitHub Actions. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/enable-selected-repository-github-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/enable-selected-repository-github-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/disable-selected-repository-github-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/disable-selected-repository-github-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-allowed-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-allowed-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["selected-actions"]; + "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - readonly "actions/set-allowed-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-allowed-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; + requestBody?: { + content: { + "application/json": components["schemas"]["selected-actions"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-github-actions-default-workflow-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-self-hosted-runners-permissions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; + "application/json": components["schemas"]["self-hosted-runners-settings"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-self-hosted-runners-permissions-organization": { + 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 The policy that controls whether self-hosted runners can be used in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-self-hosted-runners-organization": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-selected-repositories-self-hosted-runners-organization": { + 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 IDs of repositories that can use repository-level self-hosted runners */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/enable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/set-github-actions-default-workflow-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/disable-selected-repository-self-hosted-runners-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-github-actions-default-workflow-permissions-organization": { + parameters: { + query?: never; + 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"]["actions-get-default-workflow-permissions"]; + }; + }; + }; + }; + "actions/set-github-actions-default-workflow-permissions-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: { + content: { + "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; + }; + }; + responses: { /** @description Success response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runner-groups-for-org": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + 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"]; + visible_to_repository?: components["parameters"]["visible-to-repository"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runner_groups: readonly components["schemas"]["runner-groups-org"][]; + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; }; }; }; }; }; - readonly "actions/create-self-hosted-runner-group-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner group. */ - readonly name: string; + 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"; + visibility?: "selected" | "all" | "private"; /** @description List of repository IDs that can access the runner group. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; /** @description List of runner IDs to add to the runner group. */ - readonly runners?: readonly number[]; + runners?: number[]; /** * @description Whether the runner group can be used by `public` repositories. * @default false */ - readonly allows_public_repositories?: boolean; + 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; + 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[]; + selected_workflows?: string[]; /** @description The identifier of a hosted compute network configuration. */ - readonly network_configuration_id?: string; + network_configuration_id?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; + "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: { + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; + "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: { + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-self-hosted-runner-group-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner group. */ - readonly name: string; + 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"; + visibility?: "selected" | "all" | "private"; /** * @description Whether the runner group can be used by `public` repositories. * @default false */ - readonly allows_public_repositories?: boolean; + 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; + 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[]; + selected_workflows?: string[]; /** @description The identifier of a hosted compute network configuration. */ - readonly network_configuration_id?: string | null; + network_configuration_id?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; + "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - readonly "actions/list-github-hosted-runners-in-group-for-org": { - readonly parameters: { - readonly query?: { + "actions/list-github-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; }; }; }; }; }; - readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: 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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of repository IDs that can access the runner group. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runners-in-group-for-org": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; }; }; }; }; }; - readonly "actions/set-self-hosted-runners-in-group-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of runner IDs to add to the runner group. */ - readonly runners: readonly number[]; + runners: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runners-for-org": { - readonly parameters: { - readonly query?: { + "actions/list-self-hosted-runners-for-org": { + parameters: { + query?: { /** @description The name of a self-hosted runner. */ - readonly name?: string; + name?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; }; }; }; }; }; - readonly "actions/list-runner-applications-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-runner-applications-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; + "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - readonly "actions/generate-runner-jitconfig-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/generate-runner-jitconfig-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the new runner. */ - readonly name: string; + name: string; /** @description The ID of the runner group to register the runner to. */ - readonly runner_group_id: number; + runner_group_id: number; /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ - readonly labels: readonly string[]; + labels: string[]; /** * @description The working directory to be used for job execution, relative to the runner install directory. * @default _work */ - readonly work_folder?: string; + work_folder?: string; }; }; }; - readonly responses: { - readonly 201: components["responses"]["actions_runner_jitconfig"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/create-registration-token-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-registration-token-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/create-remove-token-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-remove-token-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/get-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner"]; + "application/json": components["schemas"]["runner"]; }; }; }; }; - readonly "actions/delete-self-hosted-runner-from-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-self-hosted-runner-from-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-labels-for-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-labels-for-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-custom-labels-for-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-custom-labels-for-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/add-custom-labels-to-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-custom-labels-to-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels_readonly"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/remove-custom-label-from-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-custom-label-from-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; /** @description The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; + name: components["parameters"]["runner-label-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-org-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-org-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["organization-actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-actions-secret"][]; }; }; }; }; }; - readonly "actions/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-public-key"]; + "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - readonly "actions/get-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-actions-secret"]; + "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - readonly "actions/create-or-update-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-or-update-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: { + "actions/list-selected-repos-for-org-secret": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; }; }; - readonly "actions/set-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-selected-repos-for-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/add-selected-repo-to-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-selected-repo-to-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type is not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/remove-selected-repo-from-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-selected-repo-from-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-org-variables": { - readonly parameters: { - readonly query?: { + "actions/list-org-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["organization-actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["organization-actions-variable"][]; }; }; }; }; }; - readonly "actions/create-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name: string; + name: string; /** @description The value of the variable. */ - readonly value: string; + value: string; /** * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a variable */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-actions-variable"]; + "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - readonly "actions/delete-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name?: string; + name?: string; /** @description The value of the variable. */ - readonly value?: string; + value?: string; /** * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. * @enum {string} */ - readonly visibility?: "all" | "private" | "selected"; + visibility?: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-selected-repos-for-org-variable": { - readonly parameters: { - readonly query?: { + "actions/list-selected-repos-for-org-variable": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/set-selected-repos-for-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-selected-repos-for-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The IDs of the repositories that can access the organization variable. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/add-selected-repo-to-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-selected-repo-to-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - readonly repository_id: number; + name: components["parameters"]["variable-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/remove-selected-repo-from-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-selected-repo-from-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - readonly repository_id: number; + name: components["parameters"]["variable-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "orgs/create-artifact-deployment-record": { + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** @description The hex encoded digest of the artifact. */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * @description The status of the artifact. Can be either deployed or decommissioned. + * @enum {string} + */ + status: "deployed" | "decommissioned"; + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The deployment cluster. */ + cluster?: string; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a cluster, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + */ + deployment_name: string; + /** @description The tags associated with the deployment. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact deployment record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/set-cluster-deployment-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The cluster name. */ + cluster: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The list of deployments to record. */ + deployments: { + /** + * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name parameter must also be identical across all entries. + */ + name: string; + /** + * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name and version parameters must also be identical across all entries. + */ + digest: string; + /** + * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + * the version parameter must also be identical across all entries. + * @example 1.2.3 + */ + version?: string; + /** + * @description The deployment status of the artifact. + * @enum {string} + */ + status?: "deployed" | "decommissioned"; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a record set, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + * The deployment_name must be unique across all entries in the deployments array. + */ + deployment_name: string; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + /** @description Key-value pairs to tag the deployment record. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + }[]; + }; + }; + }; + responses: { + /** @description Deployment records created or updated successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/create-artifact-storage-record": { + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** + * @description The digest of the artifact (algorithm:hex-encoded-digest). + * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * Format: uri + * @description The URL where the artifact is stored. + * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3 + */ + artifact_url?: string; + /** + * Format: uri + * @description The path of the artifact. + * @example com/github/bar/libfoo-1.2.3 + */ + path?: string; + /** + * Format: uri + * @description The base URL of the artifact registry. + * @example https://reg.example.com/artifactory/ + */ + registry_url: string; + /** + * @description The repository name within the registry. + * @example bar + */ + repository?: string; + /** + * @description The status of the artifact (e.g., active, inactive). + * @default active + * @example active + * @enum {string} + */ + status?: "active" | "eol" | "deleted"; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact metadata storage record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example 1 */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string | null; + registry_url?: string; + repository?: string | null; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-artifact-deployment-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + subject_digest: components["parameters"]["subject-digest"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The number of deployment records for this digest and organization + * @example 3 + */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/list-artifact-storage-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** + * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The number of storage records for this digest and organization + * @example 3 + */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string; + registry_url?: string; + repository?: string; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "orgs/delete-attestations-bulk": { + 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 List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-attestations": { - readonly parameters: { - readonly query?: { + "orgs/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-attestation-repositories": { + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + 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": { + id?: number; + name?: string; + }[]; + }; + }; + }; + }; + "orgs/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-attestations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - readonly subject_digest: string; + subject_digest: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly attestations?: readonly { + "application/json": { + attestations?: { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - readonly bundle?: { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly [key: string]: unknown; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; }; - readonly dsseEnvelope?: { - readonly [key: string]: unknown; + dsseEnvelope?: { + [key: string]: unknown; }; - }; - readonly repository_id?: number; - readonly bundle_url?: string; + } | null; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; }; }; }; - readonly "orgs/list-blocked-users": { - readonly parameters: { - readonly query?: { + "orgs/list-blocked-users": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "orgs/check-blocked-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/check-blocked-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If the user is blocked */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description If the user is not blocked */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "orgs/block-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/block-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/unblock-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/unblock-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "code-scanning/list-alerts-for-org": { - readonly parameters: { - readonly query?: { + "campaigns/list-org-campaigns": { + 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"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description If specified, only campaigns with this state will be returned. */ + state?: components["schemas"]["campaign-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated" | "ends_at" | "published"; + }; + 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: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"][]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/create-campaign": { + 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 The name of the campaign */ + name: string; + /** @description A description for the campaign */ + description: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign. The date must be in the future. + */ + ends_at: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + /** @description The code scanning alerts to include in this campaign */ + code_scanning_alerts?: { + /** @description The repository id */ + repository_id: number; + /** @description The alert numbers */ + alert_numbers: number[]; + }[] | null; + /** + * @description If true, will automatically generate issues for the campaign. The default is false. + * @default false + */ + generate_issues?: boolean; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Too Many Requests */ + 429: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/get-campaign-summary": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/delete-campaign": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Deletion successful */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/update-campaign": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the campaign */ + name?: string; + /** @description A description for the campaign */ + description?: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at?: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + state?: components["schemas"]["campaign-state"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/list-alerts-for-org": { + parameters: { + query?: { /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + tool_name?: components["parameters"]["tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components["parameters"]["tool-guid"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ - readonly state?: components["schemas"]["code-scanning-alert-state-query"]; + state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description The property by which to sort the results. */ - readonly sort?: "created" | "updated"; + sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this severity will be returned. */ - readonly severity?: components["schemas"]["code-scanning-alert-severity"]; + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-organization-alert-items"][]; + "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-security/get-configurations-for-org": { - readonly parameters: { - readonly query?: { + "code-security/get-configurations-for-org": { + parameters: { + query?: { /** @description The target type of the code security configuration */ - readonly target_type?: "global" | "all"; + target_type?: "global" | "all"; /** @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?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + "application/json": components["schemas"]["code-security-configuration"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/create-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/create-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name: string; + name: string; /** @description A description of the code security configuration */ - readonly description: string; + description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @default disabled * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. * @default false */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @default disabled * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @default disabled * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @default disabled + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default not_set + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @default disabled * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; + reviewer_id: number; /** * @description The type of the bypass reviewer * @enum {string} */ - readonly reviewer_type: "TEAM" | "ROLE"; + reviewer_type: "TEAM" | "ROLE"; }[]; }; /** @@ -93556,1168 +101168,1257 @@ export interface operations { * @default disabled * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non provider patterns * @default disabled * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @default enforced * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Successfully created code security configuration */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; }; }; - readonly "code-security/get-default-configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/get-default-configurations": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-default-configurations"]; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/detach-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/detach-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description An array of repository IDs to detach from configurations. */ - readonly selected_repository_ids?: readonly number[]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */ + selected_repository_ids?: number[]; }; }; }; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/get-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/get-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/delete-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/delete-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/update-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/update-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name?: string; + name?: string; /** @description A description of the code security configuration */ - readonly description?: string; + description?: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of code scanning default setup * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; + reviewer_id: number; /** * @description The type of the bypass reviewer * @enum {string} */ - readonly reviewer_type: "TEAM" | "ROLE"; + reviewer_type: "TEAM" | "ROLE"; }[]; }; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Response when a configuration is updated */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; /** @description Response when no new updates are made */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "code-security/attach-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/attach-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @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" | "all_without_configurations" | "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`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; + responses: { + 202: components["responses"]["accepted"]; }; }; - readonly "code-security/set-configuration-as-default": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/set-configuration-as-default": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Specify which types of repository this security configuration should be applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; }; }; - readonly responses: { + responses: { /** @description Default successfully changed. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description Specifies which types of repository this security configuration is applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-repositories-for-configuration": { - readonly parameters: { - readonly query?: { + "code-security/get-repositories-for-configuration": { + 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)." */ - readonly per_page?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. * * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ - readonly status?: string; + status?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/list-in-organization": { - readonly parameters: { - readonly query?: { + "codespaces/list-in-organization": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/set-codespaces-access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-codespaces-access": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. * @enum {string} */ - readonly visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; + visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ - readonly selected_usernames?: readonly string[]; + selected_usernames?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response when successfully modifying permissions. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/set-codespaces-access-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-codespaces-access-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members whose codespaces be billed to the organization. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response when successfully modifying permissions. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/delete-codespaces-access-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-codespaces-access-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response when successfully modifying permissions. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/list-org-secrets": { - readonly parameters: { - readonly query?: { + "codespaces/list-org-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["codespaces-org-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["codespaces-org-secret"][]; }; }; }; }; }; - readonly "codespaces/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - readonly "codespaces/get-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-org-secret"]; + "application/json": components["schemas"]["codespaces-org-secret"]; }; }; }; }; - readonly "codespaces/create-or-update-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-or-update-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/delete-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/list-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: { + "codespaces/list-selected-repos-for-org-secret": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/set-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-selected-repos-for-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/add-selected-repo-to-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/add-selected-repo-to-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/remove-selected-repo-from-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/remove-selected-repo-from-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "copilot/get-copilot-organization-details": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/get-copilot-organization-details": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["copilot-organization-details"]; + "application/json": components["schemas"]["copilot-organization-details"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description There is a problem with your account's associated payment method. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/list-copilot-seats": { - readonly parameters: { - readonly query?: { + "copilot/list-copilot-seats": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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?: number; + per_page?: number; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description Total number of Copilot seats for the organization currently being billed. */ - readonly total_seats?: number; - readonly seats?: readonly components["schemas"]["copilot-seat-details"][]; + total_seats?: number; + seats?: components["schemas"]["copilot-seat-details"][]; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-seats-for-teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/add-copilot-seats-for-teams": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of team names within the organization to which to grant access to GitHub Copilot. */ - readonly selected_teams: readonly string[]; + selected_teams: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_created: number; + "application/json": { + seats_created: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/cancel-copilot-seat-assignment-for-teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/cancel-copilot-seat-assignment-for-teams": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of teams from which to revoke access to GitHub Copilot. */ - readonly selected_teams: readonly string[]; + selected_teams: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_cancelled: number; + "application/json": { + seats_cancelled: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-seats-for-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/add-copilot-seats-for-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_created: number; + "application/json": { + seats_created: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/cancel-copilot-seat-assignment-for-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/cancel-copilot-seat-assignment-for-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_cancelled: number; + "application/json": { + seats_cancelled: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 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; + "copilot/copilot-content-exclusion-for-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; - readonly header?: never; - readonly path: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-organization-content-exclusion-details"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "copilot/set-copilot-content-exclusion-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + /** @description The content exclusion rules to set */ + requestBody: { + content: { + "application/json": { + [key: string]: (string | { + ifAnyMatch: string[]; + } | { + ifNoneMatch: string[]; + })[]; + }; + }; + }; + responses: { + /** @description Success */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": { + message?: string; + }; }; }; - 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"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 413: components["responses"]["too_large"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/usage-metrics-for-org": { - 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; + "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 100 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. */ - readonly until?: string; + 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; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 100). For 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; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "dependabot/list-alerts-for-org": { - readonly parameters: { - readonly query?: { + "dependabot/list-alerts-for-org": { + parameters: { + query?: { /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -94726,476 +102427,489 @@ export interface operations { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"]; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly scope?: components["parameters"]["dependabot-alert-scope"]; + scope?: components["parameters"]["dependabot-alert-scope"]; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly sort?: components["parameters"]["dependabot-alert-sort"]; + sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + 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"]; + 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly last?: components["parameters"]["pagination-last"]; + after?: components["parameters"]["pagination-after"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["dependabot-alert-with-repository"][]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "dependabot/list-org-secrets": { - readonly parameters: { - readonly query?: { + "dependabot/list-org-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["organization-dependabot-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-dependabot-secret"][]; }; }; }; }; }; - readonly "dependabot/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - readonly "dependabot/get-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-dependabot-secret"]; + "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - readonly "dependabot/create-or-update-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/create-or-update-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly string[]; + selected_repository_ids?: (number | string)[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/delete-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/delete-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/list-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: { + "dependabot/list-selected-repos-for-org-secret": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; }; }; - readonly "dependabot/set-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/set-selected-repos-for-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/add-selected-repo-to-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/add-selected-repo-to-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type is not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/remove-selected-repo-from-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/remove-selected-repo-from-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "packages/list-docker-migration-conflicting-packages-for-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/list-docker-migration-conflicting-packages-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-public-org-events": { - readonly parameters: { - readonly query?: { + "activity/list-public-org-events": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "orgs/list-failed-invitations": { - readonly parameters: { - readonly query?: { + "orgs/list-failed-invitations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-webhooks": { - readonly parameters: { - readonly query?: { + "orgs/list-webhooks": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-hook"][]; + "application/json": components["schemas"]["org-hook"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/create-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Must be passed as "web". */ - readonly name: string; + name: string; /** @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"]; + 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"]; /** @example "kdaigle" */ - readonly username?: string; + username?: string; /** @example "password" */ - readonly password?: string; + password?: string; }; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. @@ -95203,102 +102917,102 @@ export interface operations { * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["org-hook"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["org-hook"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/delete-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/delete-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "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"]; + 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. @@ -95306,678 +103020,678 @@ export interface operations { * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; /** @example "web" */ - readonly name?: string; + name?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["org-hook"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-config-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "orgs/update-webhook-config-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + 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"]; + 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"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "orgs/list-webhook-deliveries": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + cursor?: components["parameters"]["cursor"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["hook-delivery"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/redeliver-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/ping-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "api-insights/get-route-stats-by-actor": { - readonly parameters: { - readonly query: { + "api-insights/get-route-stats-by-actor": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["api-insights-route-stats-sort"]; + sort?: components["parameters"]["api-insights-route-stats-sort"]; /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - readonly api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The type of the actor */ - readonly actor_type: components["parameters"]["api-insights-actor-type"]; + actor_type: components["parameters"]["api-insights-actor-type"]; /** @description The ID of the actor */ - readonly actor_id: components["parameters"]["api-insights-actor-id"]; + actor_id: components["parameters"]["api-insights-actor-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-route-stats"]; + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; }; - readonly "api-insights/get-subject-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-subject-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["api-insights-sort"]; + sort?: components["parameters"]["api-insights-sort"]; /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - readonly subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-subject-stats"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; }; }; - readonly "api-insights/get-summary-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-summary-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "api-insights/get-summary-stats-by-user": { - readonly parameters: { - readonly query: { + "api-insights/get-summary-stats-by-user": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the user to query for stats */ - readonly user_id: components["parameters"]["api-insights-user-id"]; + user_id: components["parameters"]["api-insights-user-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "api-insights/get-summary-stats-by-actor": { - readonly parameters: { - readonly query: { + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The type of the actor */ - readonly actor_type: components["parameters"]["api-insights-actor-type"]; + actor_type: components["parameters"]["api-insights-actor-type"]; /** @description The ID of the actor */ - readonly actor_id: components["parameters"]["api-insights-actor-id"]; + actor_id: components["parameters"]["api-insights-actor-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "api-insights/get-time-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-time-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - readonly "api-insights/get-time-stats-by-user": { - readonly parameters: { - readonly query: { + "api-insights/get-time-stats-by-user": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the user to query for stats */ - readonly user_id: components["parameters"]["api-insights-user-id"]; + user_id: components["parameters"]["api-insights-user-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - readonly "api-insights/get-time-stats-by-actor": { - readonly parameters: { - readonly query: { + "api-insights/get-time-stats-by-actor": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The type of the actor */ - readonly actor_type: components["parameters"]["api-insights-actor-type"]; + actor_type: components["parameters"]["api-insights-actor-type"]; /** @description The ID of the actor */ - readonly actor_id: components["parameters"]["api-insights-actor-id"]; + actor_id: components["parameters"]["api-insights-actor-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - readonly "api-insights/get-user-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-user-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["api-insights-sort"]; + sort?: components["parameters"]["api-insights-sort"]; /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - readonly actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the user to query for stats */ - readonly user_id: components["parameters"]["api-insights-user-id"]; + user_id: components["parameters"]["api-insights-user-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-user-stats"]; + "application/json": components["schemas"]["api-insights-user-stats"]; }; }; }; }; - readonly "apps/get-org-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-org-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; }; }; - readonly "orgs/list-app-installations": { - readonly parameters: { - readonly query?: { + "orgs/list-app-installations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly installations: readonly components["schemas"]["installation"][]; + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; }; }; }; }; }; - readonly "interactions/get-restrictions-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/get-restrictions-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; }; }; - readonly "interactions/set-restrictions-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/set-restrictions-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "interactions/remove-restrictions-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/remove-restrictions-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/list-pending-invitations": { - readonly parameters: { - readonly query?: { + "orgs/list-pending-invitations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Filter invitations by their member role. */ - readonly role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; + role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; /** @description Filter invitations by their invitation source. */ - readonly invitation_source?: "all" | "member" | "scim"; + invitation_source?: "all" | "member" | "scim"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/create-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - readonly invitee_id?: number; + invitee_id?: number; /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - readonly email?: string; + email?: string; /** * @description The role for the new member. * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -95987,394 +103701,505 @@ export interface operations { * @default direct_member * @enum {string} */ - readonly role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; + role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; /** @description Specify IDs for the teams you want to invite new members to. */ - readonly team_ids?: readonly number[]; + team_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-invitation"]; + "application/json": components["schemas"]["organization-invitation"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/cancel-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/cancel-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/list-invitation-teams": { - readonly parameters: { - readonly query?: { + "orgs/list-invitation-teams": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-issue-types": { + parameters: { + query?: never; + 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"]["issue-type"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-issue-type": { + 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": components["schemas"]["organization-create-issue-type"]; }; - readonly cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["issue-type"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/update-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/delete-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "issues/list-for-org": { - readonly parameters: { - readonly query?: { + "issues/list-for-org": { + parameters: { + query?: { /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-members": { - readonly parameters: { - readonly query?: { - /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */ - readonly filter?: "2fa_disabled" | "all"; + "orgs/list-members": { + parameters: { + query?: { + /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; /** @description Filter members returned by their role. */ - readonly role?: "all" | "admin" | "member"; + role?: "all" | "admin" | "member"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/check-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/check-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if requester is an organization member and user is a member */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if requester is not an organization member */ - readonly 302: { + 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/remove-member": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-member": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "codespaces/get-codespaces-for-user-in-org": { - readonly parameters: { - readonly query?: { + "codespaces/get-codespaces-for-user-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/delete-from-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-from-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/stop-in-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/stop-in-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/get-copilot-seat-details-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/get-copilot-seat-details-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The user's GitHub Copilot seat details, including usage. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["copilot-seat-details"]; + "application/json": components["schemas"]["copilot-seat-details"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/get-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/set-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The role to give the user in the organization. Can be one of: * * `admin` - The user will become an owner of the organization. @@ -96382,1997 +104207,2506 @@ export interface operations { * @default member * @enum {string} */ - readonly role?: "admin" | "member"; + role?: "admin" | "member"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/remove-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/list-for-org": { - readonly parameters: { - readonly query?: { + "migrations/list-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ - readonly exclude?: readonly "repositories"[]; + exclude?: "repositories"[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["migration"][]; + "application/json": components["schemas"]["migration"][]; }; }; }; }; - readonly "migrations/start-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/start-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A list of arrays indicating which repositories should be migrated. */ - readonly repositories: readonly string[]; + repositories: string[]; /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @default false * @example true */ - readonly lock_repositories?: boolean; + lock_repositories?: boolean; /** * @description Indicates whether metadata should be excluded and only git source should be included for the migration. * @default false */ - readonly exclude_metadata?: boolean; + exclude_metadata?: boolean; /** * @description Indicates whether the repository git data should be excluded from the migration. * @default false */ - readonly exclude_git_data?: boolean; + exclude_git_data?: boolean; /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @default false * @example true */ - readonly exclude_attachments?: boolean; + exclude_attachments?: boolean; /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @default false * @example true */ - readonly exclude_releases?: boolean; + exclude_releases?: boolean; /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @default false * @example true */ - readonly exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean; /** * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). * @default false * @example true */ - readonly org_metadata_only?: boolean; + org_metadata_only?: boolean; /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ - readonly exclude?: readonly "repositories"[]; + exclude?: "repositories"[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "migrations/get-status-for-org": { - readonly parameters: { - readonly query?: { + "migrations/get-status-for-org": { + parameters: { + query?: { /** @description Exclude attributes from the API response to improve performance */ - readonly exclude?: readonly "repositories"[]; + exclude?: "repositories"[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** * @description * `pending`, which means the migration hasn't started yet. * * `exporting`, which means the migration is in progress. * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/download-archive-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/download-archive-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/delete-archive-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/delete-archive-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/unlock-repo-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/unlock-repo-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; /** @description repo_name parameter */ - readonly repo_name: components["parameters"]["repo-name"]; + repo_name: components["parameters"]["repo-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/list-repos-for-org": { - readonly parameters: { - readonly query?: { + "migrations/list-repos-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-org-roles": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/list-org-roles": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response - list of organization roles */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description The total number of organization roles available to the organization. */ - readonly total_count?: number; + total_count?: number; /** @description The list of organization roles available to the organization. */ - readonly roles?: readonly components["schemas"]["organization-role"][]; + roles?: components["schemas"]["organization-role"][]; }; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/revoke-all-org-roles-team": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-all-org-roles-team": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/assign-team-to-org-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/assign-team-to-org-role": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization, team or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/revoke-org-role-team": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-org-role-team": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/revoke-all-org-roles-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-all-org-roles-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/assign-user-to-org-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/assign-user-to-org-role": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization, user or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/revoke-org-role-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-org-role-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/get-org-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-org-role": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-role"]; + "application/json": components["schemas"]["organization-role"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/list-org-role-teams": { - readonly parameters: { - readonly query?: { + "orgs/list-org-role-teams": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response - List of assigned teams */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-role-assignment"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/list-org-role-users": { - readonly parameters: { - readonly query?: { + "orgs/list-org-role-users": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response - List of assigned users */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["user-role-assignment"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/list-outside-collaborators": { - readonly parameters: { - readonly query?: { - /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ - readonly filter?: "2fa_disabled" | "all"; + "orgs/list-outside-collaborators": { + parameters: { + query?: { + /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "orgs/convert-member-to-outside-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/convert-member-to-outside-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. * @default false */ - readonly async?: boolean; + async?: boolean; }; }; }; - readonly responses: { + responses: { /** @description User is getting converted asynchronously */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": Record; + "application/json": Record; }; }; /** @description User was converted */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/remove-outside-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-outside-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; }; }; - readonly "packages/list-packages-for-organization": { - readonly parameters: { - readonly query: { + "packages/list-packages-for-organization": { + parameters: { + query: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly visibility?: components["parameters"]["package-visibility"]; + visibility?: components["parameters"]["package-visibility"]; /** @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?: number; + page?: number; /** @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?: number; + per_page?: number; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 400: components["responses"]["package_es_list_error"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "packages/get-package-for-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package"]; + "application/json": components["schemas"]["package"]; }; }; }; }; - readonly "packages/delete-package-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-for-org": { - readonly parameters: { - readonly query?: { + "packages/restore-package-for-org": { + parameters: { + query?: { /** @description package token */ - readonly token?: string; + token?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-all-package-versions-for-package-owned-by-org": { - readonly parameters: { - readonly query?: { + "packages/get-all-package-versions-for-package-owned-by-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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ - readonly state?: "active" | "deleted"; + state?: "active" | "deleted"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; + "application/json": components["schemas"]["package-version"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-package-version-for-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-version-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["package-version"]; }; }; }; }; - readonly "packages/delete-package-version-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-version-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/restore-package-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-pat-grant-requests": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grant-requests": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The property by which to sort the results. */ - readonly sort?: components["parameters"]["personal-access-token-sort"]; + sort?: components["parameters"]["personal-access-token-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description A list of owner usernames to use to filter the results. */ - readonly owner?: components["parameters"]["personal-access-token-owner"]; + owner?: components["parameters"]["personal-access-token-owner"]; /** @description The name of the repository to use to filter the results. */ - readonly repository?: components["parameters"]["personal-access-token-repository"]; + repository?: components["parameters"]["personal-access-token-repository"]; /** @description The permission to use to filter the results. */ - readonly permission?: components["parameters"]["personal-access-token-permission"]; + permission?: components["parameters"]["personal-access-token-permission"]; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_before?: components["parameters"]["personal-access-token-before"]; + last_used_before?: components["parameters"]["personal-access-token-before"]; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_after?: components["parameters"]["personal-access-token-after"]; + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-programmatic-access-grant-request"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/review-pat-grant-requests-in-bulk": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/review-pat-grant-requests-in-bulk": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ - readonly pat_request_ids?: readonly number[]; + pat_request_ids?: number[]; /** * @description Action to apply to the requests. * @enum {string} */ - readonly action: "approve" | "deny"; + action: "approve" | "deny"; /** @description Reason for approving or denying the requests. Max 1024 characters. */ - readonly reason?: string | null; + reason?: string | null; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/review-pat-grant-request": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/review-pat-grant-request": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ - readonly pat_request_id: number; + pat_request_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Action to apply to the request. * @enum {string} */ - readonly action: "approve" | "deny"; + action: "approve" | "deny"; /** @description Reason for approving or denying the request. Max 1024 characters. */ - readonly reason?: string | null; + reason?: string | null; }; }; }; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/list-pat-grant-request-repositories": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grant-request-repositories": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ - readonly pat_request_id: number; + pat_request_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/list-pat-grants": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grants": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The property by which to sort the results. */ - readonly sort?: components["parameters"]["personal-access-token-sort"]; + sort?: components["parameters"]["personal-access-token-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description A list of owner usernames to use to filter the results. */ - readonly owner?: components["parameters"]["personal-access-token-owner"]; + owner?: components["parameters"]["personal-access-token-owner"]; /** @description The name of the repository to use to filter the results. */ - readonly repository?: components["parameters"]["personal-access-token-repository"]; + repository?: components["parameters"]["personal-access-token-repository"]; /** @description The permission to use to filter the results. */ - readonly permission?: components["parameters"]["personal-access-token-permission"]; + permission?: components["parameters"]["personal-access-token-permission"]; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_before?: components["parameters"]["personal-access-token-before"]; + last_used_before?: components["parameters"]["personal-access-token-before"]; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_after?: components["parameters"]["personal-access-token-after"]; + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-programmatic-access-grant"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/update-pat-accesses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-pat-accesses": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - readonly action: "revoke"; + action: "revoke"; /** @description The IDs of the fine-grained personal access tokens. */ - readonly pat_ids: readonly number[]; + pat_ids: number[]; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/update-pat-access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-pat-access": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the fine-grained personal access token. */ - readonly pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; + pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - readonly action: "revoke"; + action: "revoke"; }; }; }; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/list-pat-grant-repositories": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grant-repositories": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the fine-grained personal access token. */ - readonly pat_id: number; + pat_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "private-registries/list-org-private-registries": { - readonly parameters: { - readonly query?: { + "private-registries/list-org-private-registries": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly configurations: readonly components["schemas"]["org-private-registry-configuration"][]; + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; }; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/create-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The registry type. * @enum {string} */ - readonly registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url: string; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - readonly username?: string | null; + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - readonly encrypted_value: string; + encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ - readonly key_id: string; + key_id: string; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description The organization private registry configuration */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "private-registries/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The identifier for the key. * @example 012345678912345678 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 */ - readonly key: string; + key: string; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/get-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The specified private registry configuration for the organization */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-private-registry-configuration"]; + "application/json": components["schemas"]["org-private-registry-configuration"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/delete-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/update-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The registry type. * @enum {string} */ - readonly registry_type?: "maven_repository"; + registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - readonly username?: string | null; + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} */ - readonly visibility?: "all" | "private" | "selected"; + visibility?: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "projects/list-for-org": { - readonly parameters: { - readonly query?: { - /** @description Indicates the state of the projects to return. */ - readonly state?: "open" | "closed" | "all"; + "projects/list-for-org": { + parameters: { + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "projects/create-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "projects/get-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the project. */ - readonly name: string; - /** @description The description of the project. */ - readonly body?: string; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/create-draft-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; }; - readonly responses: { + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "orgs/get-all-custom-properties": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "projects/list-fields-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 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"]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "orgs/create-or-update-custom-properties": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "projects/add-field-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The ID of the IssueField to create the field for. */ + issue_field_id: number; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response for adding a field to an organization-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; }; - readonly cookie?: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + }; + "projects/get-field-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-org": { + parameters: { + query?: { + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/add-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-org-item": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/create-view-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in an organization-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "projects/list-view-items-for-org": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/custom-properties-for-repos-get-organization-definitions": { + parameters: { + query?: never; + 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"]["custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/custom-properties-for-repos-create-or-update-organization-definitions": { + 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 The array of custom properties to create or update. */ - readonly properties: readonly components["schemas"]["custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/get-custom-property": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-get-organization-definition": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The custom property name */ - readonly custom_property_name: components["parameters"]["custom-property-name"]; + custom_property_name: components["parameters"]["custom-property-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-or-update-custom-property": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-create-or-update-organization-definition": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The custom property name */ - readonly custom_property_name: components["parameters"]["custom-property-name"]; + custom_property_name: components["parameters"]["custom-property-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["custom-property-set-payload"]; + requestBody: { + content: { + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/remove-custom-property": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-delete-organization-definition": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The custom property name */ - readonly custom_property_name: components["parameters"]["custom-property-name"]; + custom_property_name: components["parameters"]["custom-property-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-custom-properties-values-for-repos": { - readonly parameters: { - readonly query?: { + "orgs/custom-properties-for-repos-get-organization-values": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - readonly repository_query?: string; + repository_query?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-repo-custom-property-values"][]; + "application/json": components["schemas"]["org-repo-custom-property-values"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-or-update-custom-properties-values-for-repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-create-or-update-organization-values": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of repositories that the custom property values will be applied to. */ - readonly repository_names: readonly string[]; + repository_names: string[]; /** @description List of custom property names and associated values to apply to the repositories. */ - readonly properties: readonly components["schemas"]["custom-property-value"][]; + properties: components["schemas"]["custom-property-value"][]; }; }; }; - readonly responses: { + responses: { /** @description No Content when custom property values are successfully created or updated */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/list-public-members": { - readonly parameters: { - readonly query?: { + "orgs/list-public-members": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "orgs/check-public-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/check-public-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if user is a public member */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if user is not a public member */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/set-public-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-public-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "orgs/remove-public-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-public-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-for-org": { - readonly parameters: { - readonly query?: { + "repos/list-for-org": { + parameters: { + query?: { /** @description Specifies the types of repositories you want returned. */ - readonly type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "repos/create-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the repository. */ - readonly name: string; + name: string; /** @description A short description of the repository. */ - readonly description?: string; + description?: string; /** @description A URL with more information about the repository. */ - readonly homepage?: string; + homepage?: string; /** * @description Whether the repository is private. * @default false */ - readonly private?: boolean; + private?: boolean; /** * @description The visibility of the repository. * @enum {string} */ - readonly visibility?: "public" | "private"; + visibility?: "public" | "private"; /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - readonly has_issues?: boolean; + has_issues?: boolean; /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - readonly has_projects?: boolean; + has_projects?: boolean; /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - readonly has_wiki?: boolean; + has_wiki?: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads?: boolean; + has_downloads?: boolean; /** * @description Either `true` to make this repo available as a template repository or `false` to prevent it. * @default false */ - readonly is_template?: boolean; + is_template?: boolean; /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - readonly team_id?: number; + team_id?: number; /** * @description Pass `true` to create an initial commit with empty README. * @default false */ - readonly auto_init?: boolean; + auto_init?: boolean; /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - readonly gitignore_template?: string; + gitignore_template?: string; /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - readonly license_template?: string; + license_template?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - readonly allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean; /** * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. * @default false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** * @default false */ - readonly delete_branch_on_merge?: boolean; + 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 is closing down. Please use `squash_merge_commit_title` instead. * @default false */ - readonly use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -98382,7 +106716,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -98391,7 +106725,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -98401,7 +106735,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -98410,2942 +106744,1713 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-org-rulesets": { - readonly parameters: { - readonly query?: { + "repos/get-org-rulesets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + 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"]; + targets?: components["parameters"]["ruleset-targets"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-ruleset"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/create-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name: string; + name: string; /** * @description The target of the ruleset * @default branch * @enum {string} */ - readonly target?: "branch" | "tag" | "push" | "repository"; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push" | "repository"; + enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["org-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["org-rules"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-org-rule-suites": { - readonly parameters: { - readonly query?: { + "repos/get-org-rule-suites": { + parameters: { + query?: { /** @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?: components["parameters"]["ref-in-query"]; + ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. */ - readonly repository_name?: components["parameters"]["repository-name-in-query"]; + repository_name?: components["parameters"]["repository-name-in-query"]; /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ - readonly time_period?: components["parameters"]["time-period"]; + time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - readonly actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["rule-suites"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-org-rule-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-org-rule-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** * @description The unique identifier of the rule suite result. * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) * for organizations. */ - readonly rule_suite_id: components["parameters"]["rule-suite-id"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["rule-suite"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/update-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name?: string; + name?: string; /** * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push" | "repository"; - readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push" | "repository"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["org-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["org-rules"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/delete-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "secret-scanning/list-alerts-for-org": { - readonly parameters: { - readonly query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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"]; + "orgs/get-org-ruleset-history": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; - /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; - /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - 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"]; + 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 The ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; }; - readonly header?: never; - readonly path: { + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "orgs/get-org-ruleset-version": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["ruleset-version-with-state"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "security-advisories/list-org-repository-advisories": { - readonly parameters: { - readonly query?: { + "secret-scanning/list-alerts-for-org": { + parameters: { + query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "published"; - /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; - /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ - readonly state?: "triage" | "draft" | "published" | "closed"; + direction?: components["parameters"]["direction"]; + /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ + 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-advisory"][]; + "application/json": components["schemas"]["organization-secret-scanning-alert"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "orgs/list-security-manager-teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/list-org-pattern-configs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-simple"][]; + "application/json": components["schemas"]["secret-scanning-pattern-configuration"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/add-security-manager-team": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/update-org-pattern-configs": { + parameters: { + query?: never; + header?: never; + 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 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; + org: components["parameters"]["org"]; }; + cookie?: never; }; - }; - readonly "orgs/remove-security-manager-team": { - 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 slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + requestBody: { + content: { + "application/json": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Pattern settings for provider patterns. */ + provider_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "not-set" | "disabled" | "enabled"; + }[]; + /** @description Pattern settings for custom patterns. */ + custom_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + custom_pattern_version?: components["schemas"]["secret-scanning-row-version"]; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "disabled" | "enabled"; + }[]; }; - content?: never; }; }; - }; - readonly "billing/get-github-actions-billing-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?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": { + /** @description The updated pattern configuration version. */ + pattern_config_version?: string; + }; }; }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "billing/get-github-packages-billing-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/list-org-repository-advisories": { + parameters: { + query?: { + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["repository-advisory"][]; }; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "billing/get-shared-storage-billing-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/list-security-manager-teams": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - readonly "hosted-compute/list-network-configurations-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: { + "orgs/add-security-manager-team": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly total_count: number; - readonly network_configurations: readonly components["schemas"]["network-configuration"][]; - }; + [name: string]: unknown; }; + content?: never; }; }; }; - readonly "hosted-compute/create-network-configuration-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-security-manager-team": { + parameters: { + query?: never; + header?: never; + 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 network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name: string; - /** - * @description The hosted compute service to use for the network configuration. - * @enum {string} - */ - readonly compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - readonly network_settings_ids: readonly string[]; - }; + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 204: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["network-configuration"]; + [name: string]: unknown; }; + content?: never; }; }; }; - readonly "hosted-compute/get-network-configuration-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + requestBody?: never; + responses: { + /** @description Immutable releases settings response */ + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["network-configuration"]; - }; - }; - }; - }; - readonly "hosted-compute/delete-network-configuration-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 hosted compute network configuration. */ - readonly network_configuration_id: components["parameters"]["network-configuration-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + "application/json": components["schemas"]["immutable-releases-organization-settings"]; }; - content?: never; }; }; }; - readonly "hosted-compute/update-network-configuration-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name?: string; + requestBody: { + content: { + "application/json": { /** - * @description The hosted compute service to use for the network configuration. + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all * @enum {string} */ - readonly compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - readonly network_settings_ids?: readonly string[]; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["network-configuration"]; + enforced_repositories: "all" | "none" | "selected"; + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids?: number[]; }; }; }; - }; - readonly "hosted-compute/get-network-settings-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 hosted compute network settings. */ - readonly network_settings_id: components["parameters"]["network-settings-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["network-settings"]; - }; - }; - }; - }; - 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"][]; + [name: string]: unknown; }; + content?: never; }; - 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?: { - /** @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; + "orgs/get-immutable-releases-settings-repositories": { + 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)." */ - 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"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; - readonly "teams/list": { - readonly parameters: { - readonly query?: { + 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 page number of the results to fetch. For 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; - readonly 403: components["responses"]["forbidden"]; }; }; - readonly "teams/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-immutable-releases-settings-repositories": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the team. */ - readonly name: string; - /** @description The description of the team. */ - readonly description?: string; - /** @description List GitHub IDs for organization members who will become team maintainers. */ - readonly maintainers?: readonly string[]; - /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - readonly repo_names?: readonly string[]; - /** - * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` - * @enum {string} - */ - readonly privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - readonly permission?: "pull" | "push"; - /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids: number[]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; }; - }; - readonly "teams/get-by-name": { - 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 slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "teams/delete-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/enable-selected-repository-immutable-releases-organization": { + parameters: { + query?: never; + header?: never; + 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"]; + org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/update-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/disable-selected-repository-immutable-releases-organization": { + parameters: { + query?: never; + header?: never; + 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?: { - readonly content: { - readonly "application/json": { - /** @description The name of the team. */ - readonly name?: string; - /** @description The description of the team. */ - readonly description?: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - readonly privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number | null; - }; + org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; - readonly responses: { - /** @description Response when the updated information already exists */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 204: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; + [name: string]: unknown; }; + content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/list-discussions-in-org": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + "hosted-compute/list-network-configurations-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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 Pinned discussions only filter */ - readonly pinned?: string; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + 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"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-discussion"][]; + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; }; }; }; }; - readonly "teams/create-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title: string; - /** @description The discussion post's body text. */ - readonly body: string; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false + * @description The hosted compute service to use for the network configuration. + * @enum {string} */ - readonly private?: boolean; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["network-configuration"]; }; }; }; }; - readonly "teams/get-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["network-configuration"]; }; }; }; }; - readonly "teams/delete-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/update-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title?: string; - /** @description The discussion post's body text. */ - readonly body?: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/list-discussion-comments-in-org": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - 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 components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - readonly "teams/create-discussion-comment-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["network-configuration"]; }; }; }; }; - readonly "teams/get-discussion-comment-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["network-settings"]; }; }; }; }; - readonly "teams/delete-discussion-comment-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; + "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 100 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 100). For 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; }; - }; - }; - readonly "teams/update-discussion-comment-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; - }; + team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "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"]; }; }; - readonly "reactions/list-for-team-discussion-comment-in-org": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + "teams/list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["team"][]; }; }; + 403: components["responses"]["forbidden"]; }; }; - readonly "reactions/create-for-team-discussion-comment-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/create": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; + /** @description List GitHub usernames for organization members who will become team maintainers. */ + maintainers?: string[]; + /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ + repo_names?: string[]; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The level of privacy this team should have. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` + * @enum {string} + */ + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} + */ + permission?: "pull" | "push"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number; }; }; }; - readonly responses: { - /** @description Response when the reaction type has already been added to this team discussion comment */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-team-discussion-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-by-name": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-full"]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/list-for-team-discussion-in-org": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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: { + "teams/delete-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + [name: string]: unknown; }; + content?: never; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - readonly "reactions/create-for-team-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/update-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { + /** @description The name of the team. */ + name?: string; + /** @description The description of the team. */ + description?: string; + /** + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * @enum {string} + */ + privacy?: "secret" | "closed"; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; - readonly responses: { - /** @description Response */ - readonly 200: { + responses: { + /** @description Response when the updated information already exists */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-team-discussion": { - 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 slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-pending-invitations-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-pending-invitations-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - readonly "teams/list-members-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-members-in-org": { + parameters: { + query?: { /** @description Filters members returned by their role in the team. */ - readonly role?: "member" | "maintainer" | "all"; + role?: "member" | "maintainer" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "teams/get-membership-for-user-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-membership-for-user-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-membership-for-user-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-membership-for-user-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The role that this user should have in the team. * @default member * @enum {string} */ - readonly role?: "member" | "maintainer"; + role?: "member" | "maintainer"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-membership-for-user-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-membership-for-user-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Forbidden if team synchronization is set up */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-projects-in-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 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 Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["team-project"][]; - }; - }; - }; - }; - readonly "teams/check-permissions-for-project-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + 403: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - readonly 404: { - headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-project-permissions-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - readonly permission?: "read" | "write" | "admin"; - } | null; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - }; - }; - readonly "teams/remove-project-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-repos-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-repos-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "teams/check-permissions-for-repo-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/check-permissions-for-repo-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Alternative response with repository permissions */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-repository"]; + "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if team does not have permission for the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-repo-permissions-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-repo-permissions-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ - readonly permission?: string; + permission?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-repo-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-repo-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/list-child-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-child-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if child teams exist */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; }; }; - readonly "orgs/enable-or-disable-security-product-on-all-org-repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/enable-or-disable-security-product-on-all-org-repos": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The security feature to enable or disable. */ - readonly security_product: components["parameters"]["security-product"]; + security_product: components["parameters"]["security-product"]; /** * @description The action to take. * * `enable_all` means to enable the specified security feature for all repositories in the organization. * `disable_all` means to disable the specified security feature for all repositories in the organization. */ - readonly enablement: components["parameters"]["org-security-product-enablement"]; + enablement: components["parameters"]["org-security-product-enablement"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. * @enum {string} */ - readonly query_suite?: "default" | "extended"; + query_suite?: "default" | "extended"; }; }; }; - readonly responses: { + responses: { /** @description Action started */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "projects/get-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/delete-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/update-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; + "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - readonly note?: string | null; - /** - * @description Whether or not the card is archived - * @example false - */ - readonly archived?: boolean; - }; - }; - }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; + "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; + "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["rate-limit-overview"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/move-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. - * @example bottom - */ - readonly position: string; - /** - * @description The unique identifier of the column the card should be moved to - * @example 42 - */ - readonly column_id?: number; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": Record; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - readonly resource?: string; - readonly field?: string; - }[]; - }; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - /** @description Response */ - readonly 503: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - readonly "projects/get-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/delete-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/update-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - readonly name: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/list-cards": { - readonly parameters: { - readonly query?: { - /** @description Filters the project cards that are returned by the card's state. */ - readonly archived_state?: "all" | "archived" | "not_archived"; - /** @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 unique identifier of the column. */ - readonly column_id: components["parameters"]["column-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 components["schemas"]["project-card"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/create-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - readonly note: string | null; - } | { - /** - * @description The unique identifier of the content associated with the card - * @example 42 - */ - readonly content_id: number; - /** - * @description The piece of content associated with the card - * @example PullRequest - */ - readonly content_type: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - /** @description Validation failed */ - readonly 422: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; - }; - }; - /** @description Response */ - readonly 503: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - readonly "projects/move-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. - * @example last - */ - readonly position: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": Record; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "projects/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Delete Success */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; - readonly "projects/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - readonly name?: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - readonly body?: string | null; - /** - * @description State of the project; either 'open' or 'closed' - * @example open - */ - readonly state?: string; - /** - * @description The baseline permission that all organization members have on this project - * @enum {string} - */ - readonly organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. */ - readonly private?: boolean; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - /** @description Not Found if the authenticated user does not have access to the project */ - readonly 404: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "projects/list-collaborators": { - readonly parameters: { - readonly query?: { - /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - readonly affiliation?: "outside" | "direct" | "all"; - /** @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 unique identifier of the project. */ - readonly project_id: components["parameters"]["project-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 components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/add-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The permission to grant the collaborator. - * @default write - * @example write - * @enum {string} - */ - readonly permission?: "read" | "write" | "admin"; - } | null; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/remove-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/get-permission-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/list-columns": { - 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 unique identifier of the project. */ - readonly project_id: components["parameters"]["project-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 components["schemas"]["project-column"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/create-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - readonly name: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "rate-limit/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; - readonly "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; - readonly "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 307: components["responses"]["temporary_redirect"]; + 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "repos/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the repository. */ - readonly name?: string; + name?: string; /** @description A short description of the repository. */ - readonly description?: string; + description?: string; /** @description A URL with more information about the repository. */ - readonly homepage?: string; + homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ - readonly private?: boolean; + private?: boolean; /** * @description The visibility of the repository. * @enum {string} */ - readonly visibility?: "public" | "private"; + visibility?: "public" | "private"; /** * @description Specify which security and analysis features to enable or disable for the repository. * @@ -101356,91 +108461,132 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ - readonly security_and_analysis?: { - /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ - readonly advanced_security?: { + security_and_analysis?: { + /** + * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. + * For more information, see "[About GitHub Advanced + * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ + advanced_security?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */ + code_security?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + status?: string; }; /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ - readonly secret_scanning?: { + secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + status?: string; }; /** @description Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ - readonly secret_scanning_push_protection?: { + secret_scanning_push_protection?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + 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?: { + secret_scanning_ai_detection?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + 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?: { + secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */ + secret_scanning_delegated_alert_dismissal?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */ + secret_scanning_delegated_bypass?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** + * @description Feature options for secret scanning delegated bypass. + * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + */ + secret_scanning_delegated_bypass_options?: { + /** + * @description The bypass reviewers for secret scanning delegated bypass. + * If you omit this field, the existing set of reviewers is unchanged. + */ + 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"; + }[]; }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - readonly has_issues?: boolean; + has_issues?: boolean; /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - readonly has_projects?: boolean; + has_projects?: boolean; /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - readonly has_wiki?: boolean; + has_wiki?: boolean; /** * @description Either `true` to make this repo available as a template repository or `false` to prevent it. * @default false */ - readonly is_template?: boolean; + is_template?: boolean; /** @description Updates the default branch for this repository. */ - readonly default_branch?: string; + default_branch?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - readonly allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean; /** * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. * @default false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. * @default false */ - readonly delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean; /** * @description Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. * @default false */ - readonly allow_update_branch?: boolean; + 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 is closing down. Please use `squash_merge_commit_title` instead. * @default false */ - readonly use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -101450,7 +108596,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -101459,7 +108605,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -101469,7 +108615,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -101478,1555 +108624,1838 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to archive this repository. `false` will unarchive a previously archived repository. * @default false */ - readonly archived?: boolean; + archived?: boolean; /** * @description Either `true` to allow private forks, or `false` to prevent private forks. * @default false */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits. * @default false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 307: components["responses"]["temporary_redirect"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 307: components["responses"]["temporary_redirect"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/list-artifacts-for-repo": { - readonly parameters: { - readonly query?: { + "actions/list-artifacts-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - readonly name?: components["parameters"]["artifact-name"]; + name?: components["parameters"]["artifact-name"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly artifacts: readonly components["schemas"]["artifact"][]; + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; }; }; }; }; }; - readonly "actions/get-artifact": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-artifact": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the artifact. */ - readonly artifact_id: components["parameters"]["artifact-id"]; + artifact_id: components["parameters"]["artifact-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["artifact"]; + "application/json": components["schemas"]["artifact"]; }; }; }; }; - readonly "actions/delete-artifact": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-artifact": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the artifact. */ - readonly artifact_id: components["parameters"]["artifact-id"]; + artifact_id: components["parameters"]["artifact-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/download-artifact": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-artifact": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the artifact. */ - readonly artifact_id: components["parameters"]["artifact-id"]; - readonly archive_format: string; + artifact_id: components["parameters"]["artifact-id"]; + archive_format: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { - readonly Location: components["headers"]["location"]; - readonly [name: string]: unknown; + Location: components["headers"]["location"]; + [name: string]: unknown; }; content?: never; }; - readonly 410: components["responses"]["gone"]; + 410: components["responses"]["gone"]; }; }; - readonly "actions/get-actions-cache-usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-actions-cache-retention-limit-for-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-usage-by-repository"]; + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/get-actions-cache-list": { - readonly parameters: { - readonly query?: { + "actions/get-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-usage": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-usage-by-repository"]; + }; + }; + }; + }; + "actions/get-actions-cache-list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["parameters"]["actions-cache-git-ref-full"]; + ref?: components["parameters"]["actions-cache-git-ref-full"]; /** @description An explicit key or prefix for identifying the cache */ - readonly key?: components["parameters"]["actions-cache-key"]; + key?: components["parameters"]["actions-cache-key"]; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - readonly sort?: components["parameters"]["actions-cache-list-sort"]; + sort?: components["parameters"]["actions-cache-list-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-list"]; + "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - readonly "actions/delete-actions-cache-by-key": { - readonly parameters: { - readonly query: { + "actions/delete-actions-cache-by-key": { + parameters: { + query: { /** @description A key for identifying the cache. */ - readonly key: components["parameters"]["actions-cache-key-required"]; + key: components["parameters"]["actions-cache-key-required"]; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["parameters"]["actions-cache-git-ref-full"]; + ref?: components["parameters"]["actions-cache-git-ref-full"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-list"]; + "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - readonly "actions/delete-actions-cache-by-id": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-actions-cache-by-id": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the GitHub Actions cache. */ - readonly cache_id: components["parameters"]["cache-id"]; + cache_id: components["parameters"]["cache-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-job-for-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-job-for-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the job. */ - readonly job_id: components["parameters"]["job-id"]; + job_id: components["parameters"]["job-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["job"]; + "application/json": components["schemas"]["job"]; }; }; }; }; - readonly "actions/download-job-logs-for-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-job-logs-for-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the job. */ - readonly job_id: components["parameters"]["job-id"]; + job_id: components["parameters"]["job-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/re-run-job-for-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/re-run-job-for-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the job. */ - readonly job_id: components["parameters"]["job-id"]; + job_id: components["parameters"]["job-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to enable debug logging for the re-run. * @default false */ - readonly enable_debug_logging?: boolean; + enable_debug_logging?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "actions/get-custom-oidc-sub-claim-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-custom-oidc-sub-claim-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Status response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["oidc-custom-sub-repo"]; + "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-custom-oidc-sub-claim-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-custom-oidc-sub-claim-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */ - readonly use_default: boolean; + use_default: boolean; /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */ - readonly include_claim_keys?: readonly string[]; + include_claim_keys?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Empty response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-repo-organization-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-repo-organization-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; }; }; }; }; }; - readonly "actions/list-repo-organization-variables": { - readonly parameters: { - readonly query?: { + "actions/list-repo-organization-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; }; }; }; }; }; - readonly "actions/get-github-actions-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-github-actions-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-repository-permissions"]; + }; + }; + }; + }; + "actions/set-github-actions-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/get-workflow-access-to-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-repository-permissions"]; + "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - readonly "actions/set-github-actions-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-workflow-access-to-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly enabled: components["schemas"]["actions-enabled"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-workflow-access-to-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + }; + }; + "actions/get-artifact-and-log-retention-settings-repository": { + 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"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/get-workflow-access-to-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-fork-pr-contributor-approval-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-workflow-access-to-repository"]; + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; }; }; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-workflow-access-to-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-fork-pr-contributor-approval-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["actions-workflow-access-to-repository"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/get-allowed-actions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-private-repo-fork-pr-workflows-settings-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["selected-actions"]; + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-allowed-actions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-private-repo-fork-pr-workflows-settings-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; }; }; - readonly responses: { + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-allowed-actions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + }; + "actions/set-allowed-actions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-github-actions-default-workflow-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-github-actions-default-workflow-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; + "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - readonly "actions/set-github-actions-default-workflow-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-github-actions-default-workflow-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; }; }; - readonly responses: { + responses: { /** @description Success response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runners-for-repo": { - readonly parameters: { - readonly query?: { + "actions/list-self-hosted-runners-for-repo": { + parameters: { + query?: { /** @description The name of a self-hosted runner. */ - readonly name?: string; + name?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; }; }; }; }; }; - readonly "actions/list-runner-applications-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-runner-applications-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; + "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - readonly "actions/generate-runner-jitconfig-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/generate-runner-jitconfig-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the new runner. */ - readonly name: string; + name: string; /** @description The ID of the runner group to register the runner to. */ - readonly runner_group_id: number; + runner_group_id: number; /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ - readonly labels: readonly string[]; + labels: string[]; /** * @description The working directory to be used for job execution, relative to the runner install directory. * @default _work */ - readonly work_folder?: string; + work_folder?: string; }; }; }; - readonly responses: { - readonly 201: components["responses"]["actions_runner_jitconfig"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/create-registration-token-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-registration-token-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/create-remove-token-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-remove-token-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/get-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner"]; + "application/json": components["schemas"]["runner"]; }; }; }; }; - readonly "actions/delete-self-hosted-runner-from-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-self-hosted-runner-from-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-labels-for-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-labels-for-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-custom-labels-for-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/add-custom-labels-to-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels_readonly"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/remove-custom-label-from-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; /** @description The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; + name: components["parameters"]["runner-label-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-workflow-runs-for-repo": { - readonly parameters: { - readonly query?: { + "actions/list-workflow-runs-for-repo": { + parameters: { + query?: { /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor?: components["parameters"]["actor"]; + actor?: components["parameters"]["actor"]; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly branch?: components["parameters"]["workflow-run-branch"]; + branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event?: components["parameters"]["event"]; + event?: components["parameters"]["event"]; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ - readonly status?: components["parameters"]["workflow-run-status"]; + status?: components["parameters"]["workflow-run-status"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created?: components["parameters"]["created"]; + created?: components["parameters"]["created"]; /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - readonly head_sha?: components["parameters"]["workflow-run-head-sha"]; + head_sha?: components["parameters"]["workflow-run-head-sha"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly workflow_runs: readonly components["schemas"]["workflow-run"][]; + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; }; }; }; }; }; - readonly "actions/get-workflow-run": { - readonly parameters: { - readonly query?: { + "actions/get-workflow-run": { + parameters: { + query?: { /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-run"]; + "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - readonly "actions/delete-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-reviews-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-reviews-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["environment-approvals"][]; + "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - readonly "actions/approve-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/approve-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/list-workflow-run-artifacts": { - readonly parameters: { - readonly query?: { + "actions/list-workflow-run-artifacts": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - readonly name?: components["parameters"]["artifact-name"]; + name?: components["parameters"]["artifact-name"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly artifacts: readonly components["schemas"]["artifact"][]; + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; }; }; }; }; }; - readonly "actions/get-workflow-run-attempt": { - readonly parameters: { - readonly query?: { + "actions/get-workflow-run-attempt": { + parameters: { + query?: { /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; /** @description The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; + attempt_number: components["parameters"]["attempt-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-run"]; + "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - readonly "actions/list-jobs-for-workflow-run-attempt": { - readonly parameters: { - readonly query?: { + "actions/list-jobs-for-workflow-run-attempt": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; /** @description The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; + attempt_number: components["parameters"]["attempt-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly jobs: readonly components["schemas"]["job"][]; + "application/json": { + total_count: number; + jobs: components["schemas"]["job"][]; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/download-workflow-run-attempt-logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-workflow-run-attempt-logs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; /** @description The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; + attempt_number: components["parameters"]["attempt-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/cancel-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/cancel-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "actions/review-custom-gates-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/review-custom-gates-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["review-custom-gates-comment-required"] | components["schemas"]["review-custom-gates-state-required"]; + requestBody: { + content: { + "application/json": components["schemas"]["review-custom-gates-comment-required"] | components["schemas"]["review-custom-gates-state-required"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/force-cancel-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/force-cancel-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "actions/list-jobs-for-workflow-run": { - readonly parameters: { - readonly query?: { + "actions/list-jobs-for-workflow-run": { + parameters: { + query?: { /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */ - readonly filter?: "latest" | "all"; + filter?: "latest" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly jobs: readonly components["schemas"]["job"][]; + "application/json": { + total_count: number; + jobs: components["schemas"]["job"][]; }; }; }; }; }; - readonly "actions/download-workflow-run-logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-workflow-run-logs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-workflow-run-logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-workflow-run-logs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "actions/get-pending-deployments-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-pending-deployments-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pending-deployment"][]; + "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - readonly "actions/review-pending-deployments-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/review-pending-deployments-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The list of environment ids to approve or reject * @example [ @@ -103034,4199 +110463,4227 @@ export interface operations { * 161171795 * ] */ - readonly environment_ids: readonly number[]; + environment_ids: number[]; /** * @description Whether to approve or reject deployment to the specified environments. * @example approved * @enum {string} */ - readonly state: "approved" | "rejected"; + state: "approved" | "rejected"; /** * @description A comment to accompany the deployment review * @example Ship it! */ - readonly comment: string; + comment: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deployment"][]; + "application/json": components["schemas"]["deployment"][]; }; }; }; }; - readonly "actions/re-run-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/re-run-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to enable debug logging for the re-run. * @default false */ - readonly enable_debug_logging?: boolean; + enable_debug_logging?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/re-run-workflow-failed-jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/re-run-workflow-failed-jobs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to enable debug logging for the re-run. * @default false */ - readonly enable_debug_logging?: boolean; + enable_debug_logging?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-workflow-run-usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-workflow-run-usage": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-run-usage"]; + "application/json": components["schemas"]["workflow-run-usage"]; }; }; }; }; - readonly "actions/list-repo-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-repo-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; }; }; }; }; }; - readonly "actions/get-repo-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-repo-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-public-key"]; + "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - readonly "actions/get-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-secret"]; + "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - readonly "actions/create-or-update-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-or-update-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-repo-variables": { - readonly parameters: { - readonly query?: { + "actions/list-repo-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; }; }; }; }; }; - readonly "actions/create-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name: string; + name: string; /** @description The value of the variable. */ - readonly value: string; + value: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-variable"]; + "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - readonly "actions/delete-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name?: string; + name?: string; /** @description The value of the variable. */ - readonly value?: string; + value?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-repo-workflows": { - readonly parameters: { - readonly query?: { + "actions/list-repo-workflows": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly workflows: readonly components["schemas"]["workflow"][]; + "application/json": { + total_count: number; + workflows: components["schemas"]["workflow"][]; }; }; }; }; }; - readonly "actions/get-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow"]; + "application/json": components["schemas"]["workflow"]; }; }; }; }; - readonly "actions/disable-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/disable-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/create-workflow-dispatch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-workflow-dispatch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - readonly ref: string; - /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - readonly inputs?: { - readonly [key: string]: unknown; + ref: string; + /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + inputs?: { + [key: string]: unknown; }; + /** @description Whether the response should include the workflow run ID and URLs. */ + return_run_details?: boolean; }; }; }; - readonly responses: { - /** @description Response */ - readonly 204: { + responses: { + /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["workflow-dispatch-response"]; + }; + }; + /** @description Empty response when `return_run_details` parameter is `false`. */ + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/enable-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/enable-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-workflow-runs": { - readonly parameters: { - readonly query?: { + "actions/list-workflow-runs": { + parameters: { + query?: { /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor?: components["parameters"]["actor"]; + actor?: components["parameters"]["actor"]; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly branch?: components["parameters"]["workflow-run-branch"]; + branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event?: components["parameters"]["event"]; + event?: components["parameters"]["event"]; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ - readonly status?: components["parameters"]["workflow-run-status"]; + status?: components["parameters"]["workflow-run-status"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created?: components["parameters"]["created"]; + created?: components["parameters"]["created"]; /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - readonly head_sha?: components["parameters"]["workflow-run-head-sha"]; + head_sha?: components["parameters"]["workflow-run-head-sha"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly workflow_runs: readonly components["schemas"]["workflow-run"][]; + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; }; }; }; }; }; - readonly "actions/get-workflow-usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-workflow-usage": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-usage"]; + "application/json": components["schemas"]["workflow-usage"]; }; }; }; }; - readonly "repos/list-activities": { - readonly parameters: { - readonly query?: { + "repos/list-activities": { + parameters: { + query?: { /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** * @description The Git reference for the activities you want to list. * * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. */ - readonly ref?: string; + ref?: string; /** @description The GitHub username to use to filter by the actor who performed the activity. */ - readonly actor?: string; + actor?: string; /** * @description The time period to filter by. * * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). */ - readonly time_period?: "day" | "week" | "month" | "quarter" | "year"; + time_period?: "day" | "week" | "month" | "quarter" | "year"; /** * @description The activity type to filter by. * * For example, you can choose to filter by "force_push", to see all force pushes to the repository. */ - readonly activity_type?: "push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge"; + activity_type?: "push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["activity"][]; + "application/json": components["schemas"]["activity"][]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "issues/list-assignees": { - readonly parameters: { - readonly query?: { + "issues/list-assignees": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/check-user-can-be-assigned": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/check-user-can-be-assigned": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly assignee: string; + repo: components["parameters"]["repo"]; + assignee: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Otherwise a `404` status code is returned. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "repos/create-attestation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-attestation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - readonly bundle: { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly [key: string]: unknown; + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; }; - readonly dsseEnvelope?: { - readonly [key: string]: unknown; + dsseEnvelope?: { + [key: string]: unknown; }; }; }; }; }; - readonly responses: { + responses: { /** @description response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description The ID of the attestation. */ - readonly id?: number; + id?: number; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-attestations": { - readonly parameters: { - readonly query?: { + "repos/list-attestations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - readonly subject_digest: string; + subject_digest: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly attestations?: readonly { + "application/json": { + attestations?: { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - readonly bundle?: { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly [key: string]: unknown; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; }; - readonly dsseEnvelope?: { - readonly [key: string]: unknown; + dsseEnvelope?: { + [key: string]: unknown; }; }; - readonly repository_id?: number; - readonly bundle_url?: string; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; }; }; }; - readonly "repos/list-autolinks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-autolinks": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["autolink"][]; + "application/json": components["schemas"]["autolink"][]; }; }; }; }; - readonly "repos/create-autolink": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-autolink": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. */ - readonly key_prefix: string; + key_prefix: string; /** @description The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. */ - readonly url_template: string; + url_template: string; /** * @description Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters. * @default true */ - readonly is_alphanumeric?: boolean; + is_alphanumeric?: boolean; }; }; }; - readonly responses: { + responses: { /** @description response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["autolink"]; + "application/json": components["schemas"]["autolink"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-autolink": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-autolink": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the autolink. */ - readonly autolink_id: components["parameters"]["autolink-id"]; + autolink_id: components["parameters"]["autolink-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["autolink"]; + "application/json": components["schemas"]["autolink"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-autolink": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-autolink": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the autolink. */ - readonly autolink_id: components["parameters"]["autolink-id"]; + autolink_id: components["parameters"]["autolink-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/check-automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if Dependabot is enabled */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-automated-security-fixes"]; + "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; /** @description Not Found if Dependabot is not enabled for the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/enable-automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/enable-automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/disable-automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-branches": { - readonly parameters: { - readonly query?: { + "repos/list-branches": { + parameters: { + query?: { /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - readonly protected?: boolean; + protected?: boolean; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["short-branch"][]; + "application/json": components["schemas"]["short-branch"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-with-protection"]; + "application/json": components["schemas"]["branch-with-protection"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-protection"]; + "application/json": components["schemas"]["branch-protection"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Require status checks to pass before merging. Set to `null` to disable. */ - readonly required_status_checks: { + required_status_checks: { /** @description Require branches to be up to date before merging. */ - readonly strict: boolean; + strict: boolean; /** * @deprecated * @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[]; + contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ - readonly checks?: readonly { + checks?: { /** @description The name of the required check */ - readonly context: string; + context: string; /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - readonly app_id?: number; + app_id?: number; }[]; } | null; /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - readonly enforce_admins: boolean | null; + enforce_admins: boolean | null; /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ - readonly required_pull_request_reviews: { + required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ - readonly dismissal_restrictions?: { + dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s with dismissal access */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s with dismissal access */ - readonly apps?: readonly string[]; + apps?: string[]; }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - readonly dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean; /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - readonly require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean; /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`. * @default false */ - readonly require_last_push_approval?: boolean; + require_last_push_approval?: boolean; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - readonly bypass_pull_request_allowances?: { + bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s allowed to bypass pull request requirements. */ - readonly apps?: readonly string[]; + apps?: string[]; }; } | null; /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ - readonly restrictions: { + restrictions: { /** @description The list of user `login`s with push access */ - readonly users: readonly string[]; + users: string[]; /** @description The list of team `slug`s with push access */ - readonly teams: readonly string[]; + teams: string[]; /** @description The list of app `slug`s with push access */ - readonly apps?: readonly string[]; + apps?: string[]; } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - readonly required_linear_history?: boolean; + required_linear_history?: boolean; /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - readonly allow_force_pushes?: boolean | null; + allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - readonly allow_deletions?: boolean; + allow_deletions?: boolean; /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */ - readonly block_creations?: boolean; + block_creations?: boolean; /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - readonly required_conversation_resolution?: boolean; + required_conversation_resolution?: boolean; /** * @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`. * @default false */ - readonly lock_branch?: boolean; + lock_branch?: boolean; /** * @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`. * @default false */ - readonly allow_fork_syncing?: boolean; + allow_fork_syncing?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch"]; + "application/json": components["schemas"]["protected-branch"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "repos/delete-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-admin-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-admin-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - readonly "repos/set-admin-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-admin-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - readonly "repos/delete-admin-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-admin-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-pull-request-review-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pull-request-review-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-pull-request-review"]; + "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - readonly "repos/delete-pull-request-review-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-pull-request-review-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-pull-request-review-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-pull-request-review-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ - readonly dismissal_restrictions?: { + dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s with dismissal access */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s with dismissal access */ - readonly apps?: readonly string[]; + apps?: string[]; }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - readonly dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean; /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - readonly require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean; /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false` * @default false */ - readonly require_last_push_approval?: boolean; + require_last_push_approval?: boolean; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - readonly bypass_pull_request_allowances?: { + bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s allowed to bypass pull request requirements. */ - readonly apps?: readonly string[]; + apps?: string[]; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-pull-request-review"]; + "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-commit-signature-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-commit-signature-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-commit-signature-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-commit-signature-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-commit-signature-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-commit-signature-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-status-checks-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-status-checks-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["status-check-policy"]; + "application/json": components["schemas"]["status-check-policy"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/remove-status-check-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-status-check-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-status-check-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-status-check-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Require branches to be up to date before merging. */ - readonly strict?: boolean; + strict?: boolean; /** * @deprecated * @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[]; + contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ - readonly checks?: readonly { + checks?: { /** @description The name of the required check */ - readonly context: string; + context: string; /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - readonly app_id?: number; + app_id?: number; }[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["status-check-policy"]; + "application/json": components["schemas"]["status-check-policy"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-all-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-all-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the status checks */ - readonly contexts: readonly string[]; - } | readonly string[]; + contexts: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the status checks */ - readonly contexts: readonly string[]; - } | readonly string[]; + contexts: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the status checks */ - readonly contexts: readonly string[]; - } | readonly string[]; + contexts: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-restriction-policy"]; + "application/json": components["schemas"]["branch-restriction-policy"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-apps-with-access-to-protected-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-apps-with-access-to-protected-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-app-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-app-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + 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. */ - readonly apps: readonly string[]; + apps: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-app-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-app-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + 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. */ - readonly apps: readonly string[]; + apps: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-app-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-app-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + 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. */ - readonly apps: readonly string[]; + apps: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-teams-with-access-to-protected-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-teams-with-access-to-protected-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-team-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-team-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The slug values for teams */ - readonly teams: readonly string[]; - } | readonly string[]; + teams: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-team-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-team-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The slug values for teams */ - readonly teams: readonly string[]; - } | readonly string[]; + teams: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-team-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-team-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The slug values for teams */ - readonly teams: readonly string[]; - } | readonly string[]; + teams: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-users-with-access-to-protected-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-users-with-access-to-protected-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-user-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-user-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username for users */ - readonly users: readonly string[]; + users: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-user-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-user-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username for users */ - readonly users: readonly string[]; + users: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-user-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-user-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username for users */ - readonly users: readonly string[]; + users: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/rename-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/rename-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The new name of the branch. */ - readonly new_name: string; + new_name: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-with-protection"]; + "application/json": components["schemas"]["branch-with-protection"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "checks/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/create": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the check. For example, "code-coverage". */ - readonly name: string; + name: string; /** @description The SHA of the commit. */ - readonly head_sha: string; + head_sha: string; /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - readonly details_url?: string; + details_url?: string; /** @description A reference for the run on the integrator's system. */ - readonly external_id?: string; + external_id?: string; /** * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @default queued * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at?: string; + completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ - readonly output?: { + output?: { /** @description The title of the check run. */ - readonly title: string; + title: string; /** @description The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */ - readonly summary: string; + summary: string; /** @description The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */ - readonly text?: string; + text?: string; /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */ - readonly annotations?: readonly { + annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - readonly path: string; + path: string; /** @description The start line of the annotation. Line numbers start at 1. */ - readonly start_line: number; + start_line: number; /** @description The end line of the annotation. */ - readonly end_line: number; + end_line: number; /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */ - readonly start_column?: number; + start_column?: number; /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly end_column?: number; + end_column?: number; /** * @description The level of the annotation. * @enum {string} */ - readonly annotation_level: "notice" | "warning" | "failure"; + annotation_level: "notice" | "warning" | "failure"; /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - readonly message: string; + message: string; /** @description The title that represents the annotation. The maximum size is 255 characters. */ - readonly title?: string; + title?: string; /** @description Details about this annotation. The maximum size is 64 KB. */ - readonly raw_details?: string; + raw_details?: string; }[]; /** @description Adds images to the output displayed in the GitHub pull request UI. */ - readonly images?: readonly { + images?: { /** @description The alternative text for the image. */ - readonly alt: string; + alt: string; /** @description The full URL of the image. */ - readonly image_url: string; + image_url: string; /** @description A short image description. */ - readonly caption?: string; + caption?: string; }[]; }; /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - readonly actions?: readonly { + actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - readonly label: string; + label: string; /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - readonly description: string; + description: string; /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - readonly identifier: string; + identifier: string; }[]; } & (({ /** @enum {unknown} */ - readonly status: "completed"; + status: "completed"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | ({ /** @enum {unknown} */ - readonly status?: "queued" | "in_progress"; + status?: "queued" | "in_progress"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; })); }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-run"]; + "application/json": components["schemas"]["check-run"]; }; }; }; }; - readonly "checks/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-run"]; + "application/json": components["schemas"]["check-run"]; }; }; }; }; - readonly "checks/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the check. For example, "code-coverage". */ - readonly name?: string; + name?: string; /** @description The URL of the integrator's site that has the full details of the check. */ - readonly details_url?: string; + details_url?: string; /** @description A reference for the run on the integrator's system. */ - readonly external_id?: string; + external_id?: string; /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + started_at?: string; /** * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at?: string; + completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ - readonly output?: { + output?: { /** @description **Required**. */ - readonly title?: string; + title?: string; /** @description Can contain Markdown. */ - readonly summary: string; + summary: string; /** @description Can contain Markdown. */ - readonly text?: string; + text?: string; /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */ - readonly annotations?: readonly { + annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - readonly path: string; + path: string; /** @description The start line of the annotation. Line numbers start at 1. */ - readonly start_line: number; + start_line: number; /** @description The end line of the annotation. */ - readonly end_line: number; + end_line: number; /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */ - readonly start_column?: number; + start_column?: number; /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly end_column?: number; + end_column?: number; /** * @description The level of the annotation. * @enum {string} */ - readonly annotation_level: "notice" | "warning" | "failure"; + annotation_level: "notice" | "warning" | "failure"; /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - readonly message: string; + message: string; /** @description The title that represents the annotation. The maximum size is 255 characters. */ - readonly title?: string; + title?: string; /** @description Details about this annotation. The maximum size is 64 KB. */ - readonly raw_details?: string; + raw_details?: string; }[]; /** @description Adds images to the output displayed in the GitHub pull request UI. */ - readonly images?: readonly { + images?: { /** @description The alternative text for the image. */ - readonly alt: string; + alt: string; /** @description The full URL of the image. */ - readonly image_url: string; + image_url: string; /** @description A short image description. */ - readonly caption?: string; + caption?: string; }[]; }; /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - readonly actions?: readonly { + actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - readonly label: string; + label: string; /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - readonly description: string; + description: string; /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - readonly identifier: string; + identifier: string; }[]; } | ({ /** @enum {unknown} */ - readonly status?: "completed"; + status?: "completed"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | ({ /** @enum {unknown} */ - readonly status?: "queued" | "in_progress"; + status?: "queued" | "in_progress"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }); }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-run"]; + "application/json": components["schemas"]["check-run"]; }; }; }; }; - readonly "checks/list-annotations": { - readonly parameters: { - readonly query?: { + "checks/list-annotations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["check-annotation"][]; + "application/json": components["schemas"]["check-annotation"][]; }; }; }; }; - readonly "checks/rerequest-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/rerequest-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "checks/create-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/create-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The sha of the head commit. */ - readonly head_sha: string; + head_sha: string; }; }; }; - readonly responses: { + responses: { /** @description Response when the suite already exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite"]; + "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite"]; + "application/json": components["schemas"]["check-suite"]; }; }; }; }; - readonly "checks/set-suites-preferences": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/set-suites-preferences": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. */ - readonly auto_trigger_checks?: readonly { + auto_trigger_checks?: { /** @description The `id` of the GitHub App. */ - readonly app_id: number; + app_id: number; /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - readonly setting: boolean; + setting: boolean; }[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite-preference"]; + "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - readonly "checks/get-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/get-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check suite. */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; + check_suite_id: components["parameters"]["check-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite"]; + "application/json": components["schemas"]["check-suite"]; }; }; }; }; - readonly "checks/list-for-suite": { - readonly parameters: { - readonly query?: { + "checks/list-for-suite": { + parameters: { + query?: { /** @description Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + check_name?: components["parameters"]["check-name"]; /** @description Returns check runs with the specified `status`. */ - readonly status?: components["parameters"]["status"]; + status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ - readonly filter?: "latest" | "all"; + filter?: "latest" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check suite. */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; + check_suite_id: components["parameters"]["check-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly check_runs: readonly components["schemas"]["check-run"][]; + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; }; }; }; }; }; - readonly "checks/rerequest-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/rerequest-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check suite. */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; + check_suite_id: components["parameters"]["check-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "code-scanning/list-alerts-for-repo": { - readonly parameters: { - readonly query?: { + "code-scanning/list-alerts-for-repo": { + parameters: { + query?: { /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + tool_name?: components["parameters"]["tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components["parameters"]["tool-guid"]; /** @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"]; + 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"]; + 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"]; + 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"]; + pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + 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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ - readonly sort?: "created" | "updated"; + sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ - readonly state?: components["schemas"]["code-scanning-alert-state-query"]; + state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description If specified, only code scanning alerts with this severity will be returned. */ - readonly severity?: components["schemas"]["code-scanning-alert-severity"]; + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-alert-items"][]; + "application/json": components["schemas"]["code-scanning-alert-items"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-alert"]; + "application/json": components["schemas"]["code-scanning-alert"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/update-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/update-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly state: components["schemas"]["code-scanning-alert-set-state"]; - readonly dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - }; + requestBody: { + content: { + "application/json": { + state?: components["schemas"]["code-scanning-alert-set-state"]; + dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + create_request?: components["schemas"]["code-scanning-alert-create-request"]; + assignees?: components["schemas"]["code-scanning-alert-assignees"]; + } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-alert"]; + "application/json": components["schemas"]["code-scanning-alert"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix"]; + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; - readonly 400: components["responses"]["code_scanning_bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/create-autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/create-autofix": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix"]; + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; /** @description Accepted */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix"]; + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; - readonly 400: components["responses"]["code_scanning_bad_request"]; - readonly 403: components["responses"]["code_scanning_autofix_create_forbidden"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; /** @description Unprocessable Entity */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/commit-autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["code-scanning-autofix-commits"]; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; }; }; - readonly responses: { + responses: { /** @description Created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; }; }; - readonly 400: components["responses"]["code_scanning_bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; /** @description Unprocessable Entity */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/list-alert-instances": { - readonly parameters: { - readonly query?: { + "code-scanning/list-alert-instances": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + 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"]; + 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"]; + pr?: components["parameters"]["pr-alias"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-alert-instance"][]; + "application/json": components["schemas"]["code-scanning-alert-instance-list"][]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/list-recent-analyses": { - readonly parameters: { - readonly query?: { + "code-scanning/list-recent-analyses": { + parameters: { + query?: { /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + tool_name?: components["parameters"]["tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components["parameters"]["tool-guid"]; /** @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"]; + 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"]; + 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"]; + 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"]; + ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ - readonly sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ - readonly sort?: "created"; + sort?: "created"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-analysis"][]; + "application/json": components["schemas"]["code-scanning-analysis"][]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-analysis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-analysis": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - readonly analysis_id: number; + analysis_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-analysis"]; - readonly "application/json+sarif": { - readonly [key: string]: unknown; + "application/json": components["schemas"]["code-scanning-analysis"]; + "application/sarif+json": { + [key: string]: unknown; }; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_analysis"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/delete-analysis": { - readonly parameters: { - readonly query?: { + "code-scanning/delete-analysis": { + parameters: { + query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - readonly confirm_delete?: string | null; + confirm_delete?: string | null; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - readonly analysis_id: number; + analysis_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-analysis-deletion"]; + "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/list-codeql-databases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/list-codeql-databases": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-codeql-database"][]; + "application/json": components["schemas"]["code-scanning-codeql-database"][]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-codeql-database": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The language of the CodeQL database. */ - readonly language: string; + language: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-codeql-database"]; + "application/json": components["schemas"]["code-scanning-codeql-database"]; }; }; - readonly 302: components["responses"]["found"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 302: components["responses"]["found"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/delete-codeql-database": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/delete-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The language of the CodeQL database. */ - readonly language: string; + language: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/create-variant-analysis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/create-variant-analysis": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly language: components["schemas"]["code-scanning-variant-analysis-language"]; + requestBody: { + content: { + "application/json": { + language: components["schemas"]["code-scanning-variant-analysis-language"]; /** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */ - readonly query_pack: string; + query_pack: string; /** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ - readonly repositories?: readonly string[]; + repositories?: string[]; /** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ - readonly repository_lists?: readonly string[]; + repository_lists?: string[]; /** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ - readonly repository_owners?: readonly string[]; + repository_owners?: string[]; } & (unknown | unknown | unknown); }; }; - readonly responses: { + responses: { /** @description Variant analysis submitted for processing */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-variant-analysis"]; + "application/json": components["schemas"]["code-scanning-variant-analysis"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Unable to process variant analysis submission */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-variant-analysis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-variant-analysis": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the variant analysis. */ - readonly codeql_variant_analysis_id: number; + codeql_variant_analysis_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-variant-analysis"]; + "application/json": components["schemas"]["code-scanning-variant-analysis"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-variant-analysis-repo-task": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-variant-analysis-repo-task": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; /** @description The name of the controller repository. */ - readonly repo: string; + repo: string; /** @description The ID of the variant analysis. */ - readonly codeql_variant_analysis_id: number; + codeql_variant_analysis_id: number; /** @description The account owner of the variant analysis repository. The name is not case sensitive. */ - readonly repo_owner: string; + repo_owner: string; /** @description The name of the variant analysis repository. */ - readonly repo_name: string; + repo_name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; + "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-default-setup": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-default-setup": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-default-setup"]; + "application/json": components["schemas"]["code-scanning-default-setup"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/update-default-setup": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/update-default-setup": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["code-scanning-default-setup-update"]; + requestBody: { + content: { + "application/json": components["schemas"]["code-scanning-default-setup-update"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; + "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["code_scanning_conflict"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["code_scanning_conflict"]; + 422: components["responses"]["code_scanning_invalid_state"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/upload-sarif": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/upload-sarif": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly ref: components["schemas"]["code-scanning-ref-full"]; - readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + requestBody: { + content: { + "application/json": { + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + ref: components["schemas"]["code-scanning-ref-full"]; + sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - readonly checkout_uri?: string; + checkout_uri?: string; /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - readonly tool_name?: string; + tool_name?: string; /** * @description Whether the SARIF file will be validated according to the code scanning specifications. * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. */ - readonly validate?: boolean; + validate?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; + "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ - readonly 413: { + 413: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-sarif": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-sarif": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ - readonly sarif_id: string; + sarif_id: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-sarifs-status"]; + "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; + 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-security/get-configuration-for-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration-for-repository"]; + "application/json": components["schemas"]["code-security-configuration-for-repository"]; }; }; - readonly 204: components["responses"]["no_content"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/codeowners-errors": { - readonly parameters: { - readonly query?: { + "repos/codeowners-errors": { + parameters: { + query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codeowners-errors"]; + "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/list-in-repository-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-in-repository-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/create-with-repo-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-with-repo-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Git ref (typically a branch name) for this codespace */ - readonly ref?: string; + ref?: string; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - readonly multi_repo_permissions_opt_out?: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - readonly retention_period_minutes?: number; + retention_period_minutes?: number; } | null; }; }; - readonly responses: { + responses: { /** @description Response when the codespace was successfully created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "codespaces/list-devcontainers-in-repository-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-devcontainers-in-repository-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly devcontainers: readonly { - readonly path: string; - readonly name?: string; - readonly display_name?: string; + "application/json": { + total_count: number; + devcontainers: { + path: string; + name?: string; + display_name?: string; }[]; }; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/repo-machines-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/repo-machines-for-authenticated-user": { + parameters: { + query?: { /** @description The location to check for available machines. Assigned by IP if not provided. */ - readonly location?: string; + location?: string; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description The branch or commit to check for prebuild availability and devcontainer restrictions. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly machines: readonly components["schemas"]["codespace-machine"][]; + "application/json": { + total_count: number; + machines: components["schemas"]["codespace-machine"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/pre-flight-with-repo-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/pre-flight-with-repo-for-authenticated-user": { + parameters: { + query?: { /** @description The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. */ - readonly ref?: string; + ref?: string; /** @description An alternative IP for default location auto-detection, such as when proxying a request. */ - readonly client_ip?: string; + client_ip?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when a user is able to create codespaces from the repository. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly billable_owner?: components["schemas"]["simple-user"]; - readonly defaults?: { - readonly location: string; - readonly devcontainer_path: string | null; + "application/json": { + billable_owner?: components["schemas"]["simple-user"]; + defaults?: { + location: string; + devcontainer_path: string | null; }; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/check-permissions-for-devcontainer": { - readonly parameters: { - readonly query: { + "codespaces/check-permissions-for-devcontainer": { + parameters: { + query: { /** @description The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: string; + ref: string; /** @description Path to the devcontainer.json configuration to use for the permission check. */ - readonly devcontainer_path: string; + devcontainer_path: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when the permission check is successful */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; + "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "codespaces/list-repo-secrets": { - readonly parameters: { - readonly query?: { + "codespaces/list-repo-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["repo-codespaces-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["repo-codespaces-secret"][]; }; }; }; }; }; - readonly "codespaces/get-repo-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-repo-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - readonly "codespaces/get-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repo-codespaces-secret"]; + "application/json": components["schemas"]["repo-codespaces-secret"]; }; }; }; }; - readonly "codespaces/create-or-update-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-or-update-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/delete-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-collaborators": { - readonly parameters: { - readonly query?: { + "repos/list-collaborators": { + parameters: { + query?: { /** @description Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - readonly affiliation?: "outside" | "direct" | "all"; + affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ - readonly permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + permission?: "pull" | "triage" | "push" | "maintain" | "admin"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["collaborator"][]; + "application/json": components["schemas"]["collaborator"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/check-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if user is a collaborator */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if user is not a collaborator */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/add-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. * @default push */ - readonly permission?: string; + permission?: string; }; }; }; - readonly responses: { + responses: { /** @description Response when a new invitation is created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-invitation"]; + "application/json": components["schemas"]["repository-invitation"]; }; }; /** @@ -107235,974 +114692,990 @@ export interface operations { * - an organization member is added as an individual collaborator * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + /** + * @description Response when: + * - validation failed, or the endpoint has been spammed + * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; }; }; - readonly "repos/remove-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when collaborator was removed from the repository. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-collaborator-permission-level": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-collaborator-permission-level": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if user has admin permissions */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-collaborator-permission"]; + "application/json": components["schemas"]["repository-collaborator-permission"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/list-commit-comments-for-repo": { - readonly parameters: { - readonly query?: { + "repos/list-commit-comments-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit-comment"][]; + "application/json": components["schemas"]["commit-comment"][]; }; }; }; }; - readonly "repos/get-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comment"]; + "application/json": components["schemas"]["commit-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comment"]; + "application/json": components["schemas"]["commit-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/list-for-commit-comment": { - readonly parameters: { - readonly query?: { + "reactions/list-for-commit-comment": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-commits": { - readonly parameters: { - readonly query?: { + "repos/list-commits": { + parameters: { + query?: { /** @description SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`). */ - readonly sha?: string; + sha?: string; /** @description Only commits containing this file path will be returned. */ - readonly path?: string; + path?: string; /** @description GitHub username or email address to use to filter by commit author. */ - readonly author?: string; + author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ - readonly committer?: string; + committer?: string; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ - readonly since?: string; + since?: string; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ - readonly until?: string; + until?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit"][]; + "application/json": components["schemas"]["commit"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/list-branches-for-head-commit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-branches-for-head-commit": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["branch-short"][]; + "application/json": components["schemas"]["branch-short"][]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-comments-for-commit": { - readonly parameters: { - readonly query?: { + "repos/list-comments-for-commit": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit-comment"][]; + "application/json": components["schemas"]["commit-comment"][]; }; }; }; }; - readonly "repos/create-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment. */ - readonly body: string; + body: string; /** @description Relative path of the file to comment on. */ - readonly path?: string; + path?: string; /** @description Line index in the diff to comment on. */ - readonly position?: number; + position?: number; /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ - readonly line?: number; + line?: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comment"]; + "application/json": components["schemas"]["commit-comment"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-pull-requests-associated-with-commit": { - readonly parameters: { - readonly query?: { + "repos/list-pull-requests-associated-with-commit": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-simple"][]; + "application/json": components["schemas"]["pull-request-simple"][]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "repos/get-commit": { - readonly parameters: { - readonly query?: { + "repos/get-commit": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit"]; + "application/json": components["schemas"]["commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "checks/list-for-ref": { - readonly parameters: { - readonly query?: { + "checks/list-for-ref": { + parameters: { + query?: { /** @description Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + check_name?: components["parameters"]["check-name"]; /** @description Returns check runs with the specified `status`. */ - readonly status?: components["parameters"]["status"]; + status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ - readonly filter?: "latest" | "all"; + filter?: "latest" | "all"; /** @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"]; + 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 app_id?: number; + page?: components["parameters"]["page"]; + app_id?: number; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly check_runs: readonly components["schemas"]["check-run"][]; + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; }; }; }; }; }; - readonly "checks/list-suites-for-ref": { - readonly parameters: { - readonly query?: { + "checks/list-suites-for-ref": { + parameters: { + query?: { /** * @description Filters check suites by GitHub App `id`. * @example 1 */ - readonly app_id?: number; + app_id?: number; /** @description Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + check_name?: components["parameters"]["check-name"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly check_suites: readonly components["schemas"]["check-suite"][]; + "application/json": { + total_count: number; + check_suites: components["schemas"]["check-suite"][]; }; }; }; }; }; - readonly "repos/get-combined-status-for-ref": { - readonly parameters: { - readonly query?: { + "repos/get-combined-status-for-ref": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["combined-commit-status"]; + "application/json": components["schemas"]["combined-commit-status"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/list-commit-statuses-for-ref": { - readonly parameters: { - readonly query?: { + "repos/list-commit-statuses-for-ref": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["status"][]; + "application/json": components["schemas"]["status"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; + 301: components["responses"]["moved_permanently"]; }; }; - readonly "repos/get-community-profile-metrics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-community-profile-metrics": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["community-profile"]; + "application/json": components["schemas"]["community-profile"]; }; }; }; }; - readonly "repos/compare-commits": { - readonly parameters: { - readonly query?: { + "repos/compare-commits": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. */ - readonly basehead: string; + basehead: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comparison"]; + "application/json": components["schemas"]["commit-comparison"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "repos/get-content": { - readonly parameters: { - readonly query?: { + "repos/get-content": { + parameters: { + query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description path parameter */ - readonly path: string; + path: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: { + content: { + "application/json": unknown; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/vnd.github.object": components["schemas"]["content-tree"]; - readonly "application/json": components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"]; + "application/vnd.github.object": components["schemas"]["content-tree"]; + "application/json": components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"]; }; }; - readonly 302: components["responses"]["found"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-or-update-file-contents": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-or-update-file-contents": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description path parameter */ - readonly path: string; + path: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The commit message. */ - readonly message: string; + message: string; /** @description The new file content, using Base64 encoding. */ - readonly content: string; + content: string; /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - readonly sha?: string; + sha?: string; /** @description The branch name. Default: the repository’s default branch. */ - readonly branch?: string; + branch?: string; /** @description The person that committed the file. Default: the authenticated user. */ - readonly committer?: { + committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - readonly name: string; + name: string; /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - readonly email: string; + email: string; /** @example "2013-01-05T13:13:22+05:00" */ - readonly date?: string; + date?: string; }; /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ - readonly author?: { + author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - readonly name: string; + name: string; /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - readonly email: string; + email: string; /** @example "2013-01-15T17:13:22+05:00" */ - readonly date?: string; + date?: string; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["file-commit"]; + "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["file-commit"]; + "application/json": components["schemas"]["file-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/delete-file": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-file": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description path parameter */ - readonly path: string; + path: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The commit message. */ - readonly message: string; + message: string; /** @description The blob SHA of the file being deleted. */ - readonly sha: string; + sha: string; /** @description The branch name. Default: the repository’s default branch */ - readonly branch?: string; + branch?: string; /** @description object containing information about the committer. */ - readonly committer?: { + committer?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + email?: string; }; /** @description object containing information about the author. */ - readonly author?: { + author?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + email?: string; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["file-commit"]; + "application/json": components["schemas"]["file-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "repos/list-contributors": { - readonly parameters: { - readonly query?: { + "repos/list-contributors": { + parameters: { + query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ - readonly anon?: string; + anon?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If repository contains content */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["contributor"][]; + "application/json": components["schemas"]["contributor"][]; }; }; /** @description Response if repository is empty */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependabot/list-alerts-for-repo": { - readonly parameters: { - readonly query?: { + "dependabot/list-alerts-for-repo": { + parameters: { + query?: { /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - readonly manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -108211,648 +115684,645 @@ export interface operations { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly scope?: components["parameters"]["dependabot-alert-scope"]; + scope?: components["parameters"]["dependabot-alert-scope"]; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly sort?: components["parameters"]["dependabot-alert-sort"]; + sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** - * @deprecated - * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. - */ - readonly page?: number; - /** - * @deprecated - * @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?: number; + 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"]; + 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly last?: components["parameters"]["pagination-last"]; + after?: components["parameters"]["pagination-after"]; + /** @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"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["dependabot-alert"][]; + "application/json": components["schemas"]["dependabot-alert"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "dependabot/get-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, * or in `number` fields in the response from the * `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */ - readonly alert_number: components["parameters"]["dependabot-alert-number"]; + alert_number: components["parameters"]["dependabot-alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-alert"]; + "application/json": components["schemas"]["dependabot-alert"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependabot/update-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/update-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, * or in `number` fields in the response from the * `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */ - readonly alert_number: components["parameters"]["dependabot-alert-number"]; + alert_number: components["parameters"]["dependabot-alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state of the Dependabot alert. * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ - readonly state: "dismissed" | "open"; + state?: "dismissed" | "open"; /** * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert. * @enum {string} */ - readonly dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; + dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; /** @description An optional comment associated with dismissing the alert. */ - readonly dismissed_comment?: string; - }; + dismissed_comment?: string; + /** + * @description Usernames to assign to this Dependabot Alert. + * Pass one or more user logins to _replace_ the set of assignees on this alert. + * Send an empty array (`[]`) to clear all assignees from the alert. + */ + assignees?: string[]; + } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-alert"]; + "application/json": components["schemas"]["dependabot-alert"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "dependabot/list-repo-secrets": { - readonly parameters: { - readonly query?: { + "dependabot/list-repo-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["dependabot-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["dependabot-secret"][]; }; }; }; }; }; - readonly "dependabot/get-repo-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-repo-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - readonly "dependabot/get-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-secret"]; + "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - readonly "dependabot/create-or-update-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/create-or-update-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/delete-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/delete-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependency-graph/diff-range": { - readonly parameters: { - readonly query?: { + "dependency-graph/diff-range": { + parameters: { + query?: { /** @description The full path, relative to the repository root, of the dependency manifest file. */ - readonly name?: components["parameters"]["manifest-path"]; + name?: components["parameters"]["manifest-path"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ - readonly basehead: string; + basehead: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependency-graph-diff"]; + "application/json": components["schemas"]["dependency-graph-diff"]; }; }; - readonly 403: components["responses"]["dependency_review_forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["dependency_review_forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependency-graph/export-sbom": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependency-graph/export-sbom": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; + "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependency-graph/create-repository-snapshot": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependency-graph/create-repository-snapshot": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["snapshot"]; + requestBody: { + content: { + "application/json": components["schemas"]["snapshot"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description ID of the created snapshot. */ - readonly id: number; + id: number; /** @description The time at which the snapshot was created. */ - readonly created_at: string; + created_at: string; /** @description Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. */ - readonly result: string; + result: string; /** @description A message providing further details about the result, such as why the dependencies were not updated. */ - readonly message: string; + message: string; }; }; }; }; }; - readonly "repos/list-deployments": { - readonly parameters: { - readonly query?: { + "repos/list-deployments": { + parameters: { + query?: { /** @description The SHA recorded at creation time. */ - readonly sha?: string; + sha?: string; /** @description The name of the ref. This can be a branch, tag, or SHA. */ - readonly ref?: string; + ref?: string; /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - readonly task?: string; + task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - readonly environment?: string | null; + environment?: string | null; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deployment"][]; + "application/json": components["schemas"]["deployment"][]; }; }; }; }; - readonly "repos/create-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - readonly ref: string; + ref: string; /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - readonly task?: string; + task?: string; /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - readonly auto_merge?: boolean; + auto_merge?: boolean; /** @description The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - readonly required_contexts?: readonly string[]; - readonly payload?: { - readonly [key: string]: unknown; + required_contexts?: string[]; + payload?: { + [key: string]: unknown; } | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - readonly environment?: string; + environment?: string; /** * @description Short description of the deployment. * @default */ - readonly description?: string | null; + description?: string | null; /** * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` * @default false */ - readonly transient_environment?: boolean; + transient_environment?: boolean; /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - readonly production_environment?: boolean; + production_environment?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment"]; + "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; + "application/json": { + message?: string; }; }; }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment"]; + "application/json": components["schemas"]["deployment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "repos/list-deployment-statuses": { - readonly parameters: { - readonly query?: { + "repos/list-deployment-statuses": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deployment-status"][]; + "application/json": components["schemas"]["deployment-status"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-deployment-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment-status": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - readonly state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. * @@ -108860,1613 +116330,1619 @@ export interface operations { * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ - readonly target_url?: string; + target_url?: string; /** * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` * @default */ - readonly log_url?: string; + log_url?: string; /** * @description A short description of the status. The maximum description length is 140 characters. * @default */ - readonly description?: string; + description?: string; /** @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. */ - readonly environment?: string; + environment?: string; /** * @description Sets the URL for accessing your environment. Default: `""` * @default */ - readonly environment_url?: string; + environment_url?: string; /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - readonly auto_inactive?: boolean; + auto_inactive?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-status"]; + "application/json": components["schemas"]["deployment-status"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-deployment-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deployment-status": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - readonly status_id: number; + deployment_id: components["parameters"]["deployment-id"]; + status_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-status"]; + "application/json": components["schemas"]["deployment-status"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-dispatch-event": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-dispatch-event": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ - readonly event_type: string; + 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. The total size of the JSON payload must be less than 64KB. */ - readonly client_payload?: { - readonly [key: string]: unknown; + client_payload?: { + [key: string]: unknown; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-all-environments": { - readonly parameters: { - readonly query?: { + "repos/get-all-environments": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The number of environments in this repository * @example 5 */ - readonly total_count?: number; - readonly environments?: readonly components["schemas"]["environment"][]; + total_count?: number; + environments?: components["schemas"]["environment"][]; }; }; }; }; }; - readonly "repos/get-environment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-environment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["environment"]; + "application/json": components["schemas"]["environment"]; }; }; }; }; - readonly "repos/create-or-update-environment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-or-update-environment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - readonly wait_timer?: components["schemas"]["wait-timer"]; - readonly prevent_self_review?: components["schemas"]["prevent-self-review"]; + requestBody?: { + content: { + "application/json": { + wait_timer?: components["schemas"]["wait-timer"]; + prevent_self_review?: components["schemas"]["prevent-self-review"]; /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - readonly reviewers?: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; + reviewers?: { + type?: components["schemas"]["deployment-reviewer-type"]; /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - readonly id?: number; + id?: number; }[] | null; - readonly deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; + deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["environment"]; + "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "repos/delete-an-environment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-an-environment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Default response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-deployment-branch-policies": { - readonly parameters: { - readonly query?: { + "repos/list-deployment-branch-policies": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The number of deployment branch policies for the environment. * @example 2 */ - readonly total_count: number; - readonly branch_policies: readonly components["schemas"]["deployment-branch-policy"][]; + total_count: number; + branch_policies: components["schemas"]["deployment-branch-policy"][]; }; }; }; }; }; - readonly "repos/create-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; + requestBody: { + content: { + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-branch-policy"]; + "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ - readonly 303: { + 303: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ - readonly branch_policy_id: components["parameters"]["branch-policy-id"]; + branch_policy_id: components["parameters"]["branch-policy-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-branch-policy"]; + "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - readonly "repos/update-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ - readonly branch_policy_id: components["parameters"]["branch-policy-id"]; + branch_policy_id: components["parameters"]["branch-policy-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + requestBody: { + content: { + "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-branch-policy"]; + "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - readonly "repos/delete-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ - readonly branch_policy_id: components["parameters"]["branch-policy-id"]; + branch_policy_id: components["parameters"]["branch-policy-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-all-deployment-protection-rules": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-all-deployment-protection-rules": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description List of deployment protection rules */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The number of enabled custom deployment protection rules for this environment * @example 10 */ - readonly total_count?: number; - readonly custom_deployment_protection_rules?: readonly components["schemas"]["deployment-protection-rule"][]; + total_count?: number; + custom_deployment_protection_rules?: components["schemas"]["deployment-protection-rule"][]; }; }; }; }; }; - readonly "repos/create-deployment-protection-rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment-protection-rule": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The ID of the custom app that will be enabled on the environment. */ - readonly integration_id?: number; + integration_id?: number; }; }; }; - readonly responses: { + responses: { /** @description The enabled custom deployment protection rule */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-protection-rule"]; + "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - readonly "repos/list-custom-deployment-rule-integrations": { - readonly parameters: { - readonly query?: { + "repos/list-custom-deployment-rule-integrations": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description A list of custom deployment rule integrations available for this environment. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The total number of custom deployment protection rule integrations available for this environment. * @example 35 */ - readonly total_count?: number; - readonly available_custom_deployment_protection_rule_integrations?: readonly components["schemas"]["custom-deployment-rule-app"][]; + total_count?: number; + available_custom_deployment_protection_rule_integrations?: components["schemas"]["custom-deployment-rule-app"][]; }; }; }; }; }; - readonly "repos/get-custom-deployment-protection-rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-custom-deployment-protection-rule": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the protection rule. */ - readonly protection_rule_id: components["parameters"]["protection-rule-id"]; + protection_rule_id: components["parameters"]["protection-rule-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-protection-rule"]; + "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - readonly "repos/disable-deployment-protection-rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-deployment-protection-rule": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; /** @description The unique identifier of the protection rule. */ - readonly protection_rule_id: components["parameters"]["protection-rule-id"]; + protection_rule_id: components["parameters"]["protection-rule-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-environment-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-environment-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; }; }; }; }; }; - readonly "actions/get-environment-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-environment-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-public-key"]; + "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - readonly "actions/get-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-environment-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-secret"]; + "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - readonly "actions/create-or-update-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-or-update-environment-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - readonly encrypted_value: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; + key_id: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-environment-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Default response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-environment-variables": { - readonly parameters: { - readonly query?: { + "actions/list-environment-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; }; }; }; }; }; - readonly "actions/create-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name: string; + name: string; /** @description The value of the variable. */ - readonly value: string; + value: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-variable"]; + "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - readonly "actions/delete-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name?: string; + name?: string; /** @description The value of the variable. */ - readonly value?: string; + value?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "activity/list-repo-events": { - readonly parameters: { - readonly query?: { + "activity/list-repo-events": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "repos/list-forks": { - readonly parameters: { - readonly query?: { + "repos/list-forks": { + parameters: { + query?: { /** @description The sort order. `stargazers` will sort by star count. */ - readonly sort?: "newest" | "oldest" | "stargazers" | "watchers"; + sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 400: components["responses"]["bad_request"]; + 400: components["responses"]["bad_request"]; }; }; - readonly "repos/create-fork": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-fork": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Optional parameter to specify the organization name if forking into an organization. */ - readonly organization?: string; + organization?: string; /** @description When forking from an existing repository, a new name for the fork. */ - readonly name?: string; + name?: string; /** @description When forking from an existing repository, fork with only the default branch. */ - readonly default_branch_only?: boolean; + default_branch_only?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/create-blob": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-blob": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The new blob's content. */ - readonly content: string; + content: string; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding?: string; + encoding?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["short-blob"]; + "application/json": components["schemas"]["short-blob"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; /** @description Validation failed */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; }; }; }; }; - readonly "git/get-blob": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-blob": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly file_sha: string; + repo: components["parameters"]["repo"]; + file_sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["blob"]; + "application/json": components["schemas"]["blob"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/create-commit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-commit": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The commit message */ - readonly message: string; + message: string; /** @description The SHA of the tree object this commit points to */ - readonly tree: string; + tree: string; /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - readonly parents?: readonly string[]; + parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ - readonly author?: { + author?: { /** @description The name of the author (or committer) of the commit */ - readonly name: string; + name: string; /** @description The email of the author (or committer) of the commit */ - readonly email: string; + email: string; /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; + date?: string; }; /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ - readonly committer?: { + committer?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + email?: string; /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; + date?: string; }; /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - readonly signature?: string; + signature?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-commit"]; + "application/json": components["schemas"]["git-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/get-commit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-commit": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-commit"]; + "application/json": components["schemas"]["git-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/list-matching-refs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/list-matching-refs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["git-ref"][]; + "application/json": components["schemas"]["git-ref"][]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/get-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-ref"]; + "application/json": components["schemas"]["git-ref"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/create-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - readonly ref: string; + ref: string; /** @description The SHA1 value for this reference. */ - readonly sha: string; + sha: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-ref"]; + "application/json": components["schemas"]["git-ref"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/delete-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/delete-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + 409: components["responses"]["conflict"]; + /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */ + 422: { + headers: { + [name: string]: unknown; }; content?: never; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "git/update-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/update-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The SHA1 value to set this reference to */ - readonly sha: string; + sha: string; /** * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. * @default false */ - readonly force?: boolean; + force?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-ref"]; + "application/json": components["schemas"]["git-ref"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/create-tag": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-tag": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - readonly tag: string; + tag: string; /** @description The tag message. */ - readonly message: string; + message: string; /** @description The SHA of the git object this is tagging. */ - readonly object: string; + object: string; /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - readonly type: "commit" | "tree" | "blob"; + type: "commit" | "tree" | "blob"; /** @description An object with information about the individual creating the tag. */ - readonly tagger?: { + tagger?: { /** @description The name of the author of the tag */ - readonly name: string; + name: string; /** @description The email of the author of the tag */ - readonly email: string; + email: string; /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; + date?: string; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tag"]; + "application/json": components["schemas"]["git-tag"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/get-tag": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-tag": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly tag_sha: string; + repo: components["parameters"]["repo"]; + tag_sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tag"]; + "application/json": components["schemas"]["git-tag"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/create-tree": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-tree": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ - readonly tree: readonly { + tree: { /** @description The file referenced in the tree. */ - readonly path?: string; + path?: string; /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - readonly mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - readonly type?: "blob" | "tree" | "commit"; + type?: "blob" | "tree" | "commit"; /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - readonly sha?: string | null; + sha?: string | null; /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - readonly content?: string; + content?: string; }[]; /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - readonly base_tree?: string; + base_tree?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tree"]; + "application/json": components["schemas"]["git-tree"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/get-tree": { - readonly parameters: { - readonly query?: { + "git/get-tree": { + parameters: { + query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - readonly recursive?: string; + recursive?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ - readonly tree_sha: string; + tree_sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tree"]; + "application/json": components["schemas"]["git-tree"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-webhooks": { - readonly parameters: { - readonly query?: { + "repos/list-webhooks": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook"][]; + "application/json": components["schemas"]["hook"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - readonly name?: string; + name?: string; /** @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"]; + 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. @@ -110474,1739 +117950,2029 @@ export interface operations { * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook"]; + "application/json": components["schemas"]["hook"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook"]; + "application/json": components["schemas"]["hook"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly config?: components["schemas"]["webhook-config"]; + requestBody: { + content: { + "application/json": { + config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - readonly add_events?: readonly string[]; + add_events?: string[]; /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - readonly remove_events?: readonly string[]; + remove_events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook"]; + "application/json": components["schemas"]["hook"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-webhook-config-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-webhook-config-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "repos/update-webhook-config-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-webhook-config-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + 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"]; + 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"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "repos/list-webhook-deliveries": { - readonly parameters: { - readonly query?: { + "repos/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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + cursor?: components["parameters"]["cursor"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["hook-delivery"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/redeliver-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/ping-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/test-push-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/test-push-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/get-import-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-immutable-releases": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { + /** @description Response if immutable releases are enabled */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["check-immutable-releases"]; + }; + }; + /** @description Not Found if immutable releases are not enabled for the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "repos/enable-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; + }; + }; + "repos/disable-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; + }; + }; + "migrations/get-import-status": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/start-import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/start-import": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The URL of the originating repository. */ - readonly vcs_url: string; + vcs_url: string; /** * @description The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - readonly vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; /** @description If authentication is required, the username to provide to `vcs_url`. */ - readonly vcs_username?: string; + vcs_username?: string; /** @description If authentication is required, the password to provide to `vcs_url`. */ - readonly vcs_password?: string; + vcs_password?: string; /** @description For a tfvc import, the name of the project that is being imported. */ - readonly tfvc_project?: string; + tfvc_project?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/spraints/socm/import */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/cancel-import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/cancel-import": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["porter_maintenance"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/update-import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/update-import": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The username to provide to the originating repository. */ - readonly vcs_username?: string; + vcs_username?: string; /** @description The password to provide to the originating repository. */ - readonly vcs_password?: string; + vcs_password?: string; /** * @description The type of version control system you are migrating from. * @example "git" * @enum {string} */ - readonly vcs?: "subversion" | "tfvc" | "git" | "mercurial"; + vcs?: "subversion" | "tfvc" | "git" | "mercurial"; /** * @description For a tfvc import, the name of the project that is being imported. * @example "project1" */ - readonly tfvc_project?: string; + tfvc_project?: string; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 503: components["responses"]["porter_maintenance"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/get-commit-authors": { - readonly parameters: { - readonly query?: { + "migrations/get-commit-authors": { + parameters: { + query?: { /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-user"]; + since?: components["parameters"]["since-user"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["porter-author"][]; + "application/json": components["schemas"]["porter-author"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/map-commit-author": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/map-commit-author": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly author_id: number; + repo: components["parameters"]["repo"]; + author_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The new Git author email. */ - readonly email?: string; + email?: string; /** @description The new Git author name. */ - readonly name?: string; + name?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["porter-author"]; + "application/json": components["schemas"]["porter-author"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/get-large-files": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/get-large-files": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["porter-large-file"][]; + "application/json": components["schemas"]["porter-large-file"][]; }; }; - readonly 503: components["responses"]["porter_maintenance"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/set-lfs-preference": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/set-lfs-preference": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import. * @enum {string} */ - readonly use_lfs: "opt_in" | "opt_out"; + use_lfs: "opt_in" | "opt_out"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["porter_maintenance"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "apps/get-repo-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-repo-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; }; }; - readonly "interactions/get-restrictions-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/get-restrictions-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; }; }; - readonly "interactions/set-restrictions-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/set-restrictions-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; /** @description Response */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "interactions/remove-restrictions-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/remove-restrictions-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-invitations": { - readonly parameters: { - readonly query?: { + "repos/list-invitations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-invitation"][]; + "application/json": components["schemas"]["repository-invitation"][]; }; }; }; }; - readonly "repos/delete-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - readonly permissions?: "read" | "write" | "maintain" | "triage" | "admin"; + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-invitation"]; + "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - readonly "issues/list-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-for-repo": { + parameters: { + query?: { /** @description If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - readonly milestone?: string; + milestone?: string; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - readonly assignee?: string; + assignee?: string; + /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */ + type?: string; /** @description The user that created the issue. */ - readonly creator?: string; + creator?: string; /** @description A user that's mentioned in the issue. */ - readonly mentioned?: string; + mentioned?: string; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The title of the issue. */ - readonly title: string | number; + title: string | number; /** @description The contents of the issue. */ - readonly body?: string; + 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 closing down.**_ */ - readonly assignee?: string | null; - readonly milestone?: (string | number) | null; + 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._ */ - readonly labels?: readonly (string | { - readonly id?: number; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; + labels?: (string | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - readonly assignees?: readonly string[]; + assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ + * @example Epic + */ + type?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "issues/list-comments-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-comments-for-repo": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-comment"][]; + "application/json": components["schemas"]["issue-comment"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-comment"]; + "application/json": components["schemas"]["issue-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/delete-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/delete-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/update-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-comment"]; + "application/json": components["schemas"]["issue-comment"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/list-for-issue-comment": { - readonly parameters: { - readonly query?: { + "issues/pin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unpin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "reactions/list-for-issue-comment": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-issue-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-issue-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-issue-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-issue-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list-events-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-events-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-event"][]; + "application/json": components["schemas"]["issue-event"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-event": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-event": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly event_id: number; + repo: components["parameters"]["repo"]; + event_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-event"]; + "application/json": components["schemas"]["issue-event"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": unknown; }; - readonly cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The title of the issue. */ - readonly title?: (string | number) | null; + title?: (string | number) | null; /** @description The contents of the issue. */ - readonly body?: string | null; + body?: string | null; /** @description Username to assign to this issue. **This field is closing down.** */ - readonly assignee?: string | null; + assignee?: string | null; /** * @description The open or closed state of the issue. * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ - readonly state_reason?: "completed" | "not_planned" | "reopened" | null; - readonly milestone?: (string | number) | null; + state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - readonly labels?: readonly (string | { - readonly id?: number; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; + labels?: (string | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ - readonly assignees?: readonly string[]; + assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + * @example Epic + */ + type?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "issues/add-assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/add-assignees": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - readonly assignees?: readonly string[]; + assignees?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; }; }; - readonly "issues/remove-assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-assignees": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - readonly assignees?: readonly string[]; + assignees?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; }; }; - readonly "issues/check-user-can-be-assigned-to-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/check-user-can-be-assigned-to-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; - readonly assignee: string; + issue_number: components["parameters"]["issue-number"]; + assignee: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "issues/list-comments": { - readonly parameters: { - readonly query?: { + "issues/list-comments": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-comment"][]; + "application/json": components["schemas"]["issue-comment"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/create-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-comment"]; + "application/json": components["schemas"]["issue-comment"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/list-events": { - readonly parameters: { - readonly query?: { + "issues/list-dependencies-blocked-by": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-event-for-issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/list-labels-on-issue": { - readonly parameters: { - readonly query?: { + "issues/add-blocked-by-dependency": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the issue that blocks the current issue */ + issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/remove-dependency-blocked-by": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + /** @description The id of the blocking issue to remove as a dependency */ + issue_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-dependencies-blocking": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/set-labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/list-events": { + 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 account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; }; - readonly cookie?: never; + 410: components["responses"]["gone"]; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + }; + "issues/list-labels-on-issue": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/set-labels": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */ - readonly labels?: readonly string[]; - } | readonly string[] | { - readonly labels?: readonly { - readonly name: string; + labels?: string[]; + } | string[] | { + labels?: { + name: string; }[]; - } | readonly { - readonly name: string; + } | { + name: string; }[] | string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/add-labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/add-labels": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ - readonly labels?: readonly string[]; - } | readonly string[] | { - readonly labels?: readonly { - readonly name: string; - }[]; - } | readonly { - readonly name: string; - }[] | string; + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ + labels?: string[]; + } | string[] | { + name: string; + }[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/remove-all-labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-all-labels": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/remove-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; - readonly name: string; + issue_number: components["parameters"]["issue-number"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/lock": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * * `off-topic` @@ -112215,9215 +119981,8547 @@ export interface operations { * * `spam` * @enum {string} */ - readonly lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/unlock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/unlock": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/get-parent": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "reactions/list-for-issue": { - readonly parameters: { - readonly query?: { + "reactions/list-for-issue": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "reactions/create-for-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/remove-sub-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The id of the sub-issue to remove */ - readonly sub_issue_id: number; + sub_issue_id: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/list-sub-issues": { - readonly parameters: { - readonly query?: { + "issues/list-sub-issues": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/add-sub-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ - readonly sub_issue_id: number; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */ + sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ - readonly replace_parent?: boolean; + replace_parent?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/reprioritize-sub-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The id of the sub-issue to reprioritize */ - readonly sub_issue_id: number; + sub_issue_id: number; /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ - readonly after_id?: number; + after_id?: number; /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ - readonly before_id?: number; + before_id?: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "issues/list-events-for-timeline": { - readonly parameters: { - readonly query?: { + "issues/list-events-for-timeline": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["timeline-issue-events"][]; + "application/json": components["schemas"]["timeline-issue-events"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "repos/list-deploy-keys": { - readonly parameters: { - readonly query?: { + "repos/list-deploy-keys": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deploy-key"][]; + "application/json": components["schemas"]["deploy-key"][]; }; }; }; }; - readonly "repos/create-deploy-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deploy-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A name for the key. */ - readonly title?: string; + title?: string; /** @description The contents of the key. */ - readonly key: string; + key: string; /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - readonly read_only?: boolean; + read_only?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deploy-key"]; + "application/json": components["schemas"]["deploy-key"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-deploy-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deploy-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deploy-key"]; + "application/json": components["schemas"]["deploy-key"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-deploy-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-deploy-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list-labels-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-labels-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/create-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - readonly name: string; + name: string; /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - readonly color?: string; + color?: string; /** @description A short description of the label. Must be 100 characters or fewer. */ - readonly description?: string; + description?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["label"]; + "application/json": components["schemas"]["label"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly name: string; + repo: components["parameters"]["repo"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["label"]; + "application/json": components["schemas"]["label"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/delete-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/delete-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly name: string; + repo: components["parameters"]["repo"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/update-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly name: string; + repo: components["parameters"]["repo"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - readonly new_name?: string; + new_name?: string; /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - readonly color?: string; + color?: string; /** @description A short description of the label. Must be 100 characters or fewer. */ - readonly description?: string; + description?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["label"]; + "application/json": components["schemas"]["label"]; }; }; }; }; - readonly "repos/list-languages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-languages": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["language"]; + "application/json": components["schemas"]["language"]; }; }; }; }; - readonly "licenses/get-for-repo": { - readonly parameters: { - readonly query?: { + "licenses/get-for-repo": { + parameters: { + query?: { /** @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"]; + ref?: components["parameters"]["git-ref"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["license-content"]; + "application/json": components["schemas"]["license-content"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/merge-upstream": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/merge-upstream": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the branch which should be updated to match upstream. */ - readonly branch: string; + branch: string; }; }; }; - readonly responses: { + responses: { /** @description The branch has been successfully synced with the upstream repository */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["merged-upstream"]; + "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description The branch could not be synced for some other reason */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/merge": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/merge": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the base branch that the head will be merged into. */ - readonly base: string; + base: string; /** @description The head to merge. This can be a branch name or a commit SHA1. */ - readonly head: string; + head: string; /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - readonly commit_message?: string; + commit_message?: string; }; }; }; - readonly responses: { + responses: { /** @description Successful Response (The resulting merge commit) */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit"]; + "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when there is a merge conflict */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/list-milestones": { - readonly parameters: { - readonly query?: { + "issues/list-milestones": { + parameters: { + query?: { /** @description The state of the milestone. Either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description What to sort results by. Either `due_on` or `completeness`. */ - readonly sort?: "due_on" | "completeness"; + sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["milestone"][]; + "application/json": components["schemas"]["milestone"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/create-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The title of the milestone. */ - readonly title: string; + title: string; /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** @description A description of the milestone. */ - readonly description?: string; + description?: string; /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly due_on?: string; + due_on?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["milestone"]; + "application/json": components["schemas"]["milestone"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["milestone"]; + "application/json": components["schemas"]["milestone"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/delete-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/delete-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/update-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The title of the milestone. */ - readonly title?: string; + title?: string; /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** @description A description of the milestone. */ - readonly description?: string; + description?: string; /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly due_on?: string; + due_on?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["milestone"]; + "application/json": components["schemas"]["milestone"]; }; }; }; }; - readonly "issues/list-labels-for-milestone": { - readonly parameters: { - readonly query?: { + "issues/list-labels-for-milestone": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; }; }; - readonly "activity/list-repo-notifications-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-repo-notifications-for-authenticated-user": { + parameters: { + query?: { /** @description If `true`, show notifications marked as read. */ - readonly all?: components["parameters"]["all"]; + all?: components["parameters"]["all"]; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating?: components["parameters"]["participating"]; + participating?: components["parameters"]["participating"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; + before?: components["parameters"]["before"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["thread"][]; + "application/json": components["schemas"]["thread"][]; }; }; }; }; - readonly "activity/mark-repo-notifications-as-read": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/mark-repo-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - readonly last_read_at?: string; + last_read_at?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; + "application/json": { + message?: string; + url?: string; }; }; }; /** @description Reset Content */ - readonly 205: { + 205: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-pages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; + "application/json": components["schemas"]["page"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-information-about-pages-site": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-information-about-pages-site": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ - readonly cname?: string | null; + cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ - readonly https_enforced?: boolean; + https_enforced?: boolean; /** * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. * @enum {string} */ - readonly build_type?: "legacy" | "workflow"; - readonly source?: ("gh-pages" | "master" | "master /docs") | { + build_type?: "legacy" | "workflow"; + source?: ("gh-pages" | "master" | "master /docs") | { /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; + branch: string; /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - readonly path: "/" | "/docs"; + path: "/" | "/docs"; }; } | unknown | unknown | unknown | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 400: components["responses"]["bad_request"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/create-pages-site": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-pages-site": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": ({ + requestBody: { + content: { + "application/json": ({ /** * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. * @enum {string} */ - readonly build_type?: "legacy" | "workflow"; + build_type?: "legacy" | "workflow"; /** @description The source branch and directory used to publish your Pages site. */ - readonly source?: { + source?: { /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; + branch: string; /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - readonly path?: "/" | "/docs"; + path?: "/" | "/docs"; }; } | unknown | unknown) | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; + "application/json": components["schemas"]["page"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/delete-pages-site": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-pages-site": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-pages-builds": { - readonly parameters: { - readonly query?: { + "repos/list-pages-builds": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["page-build"][]; + "application/json": components["schemas"]["page-build"][]; }; }; }; }; - readonly "repos/request-pages-build": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/request-pages-build": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build-status"]; + "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - readonly "repos/get-latest-pages-build": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-latest-pages-build": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["page-build"]; }; }; }; }; - readonly "repos/get-pages-build": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages-build": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly build_id: number; + repo: components["parameters"]["repo"]; + build_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["page-build"]; }; }; }; }; - readonly "repos/create-pages-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-pages-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ - readonly artifact_id?: number; + artifact_id?: number; /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ - readonly artifact_url?: string; + artifact_url?: string; /** * @description The target environment for this GitHub Pages deployment. * @default github-pages */ - readonly environment?: string; + environment?: string; /** * @description A unique string that represents the version of the build for this deployment. * @default GITHUB_SHA */ - readonly pages_build_version: string; + pages_build_version: string; /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ - readonly oidc_token: string; + oidc_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-deployment"]; + "application/json": components["schemas"]["page-deployment"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-pages-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ - readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pages-deployment-status"]; + "application/json": components["schemas"]["pages-deployment-status"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/cancel-pages-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/cancel-pages-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ - readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-pages-health-check": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages-health-check": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pages-health-check"]; + "application/json": components["schemas"]["pages-health-check"]; }; }; /** @description Empty response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Custom domains are not available for GitHub Pages */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description There isn't a CNAME for this page */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/check-private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Private vulnerability reporting status */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description Whether or not private vulnerability reporting is enabled for the repository. */ - readonly enabled: boolean; + enabled: boolean; }; }; }; - readonly 422: components["responses"]["bad_request"]; + 422: components["responses"]["bad_request"]; }; }; - readonly "repos/enable-private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/enable-private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 422: components["responses"]["bad_request"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; }; }; - readonly "repos/disable-private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 422: components["responses"]["bad_request"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; }; }; - readonly "projects/list-for-repo": { - readonly parameters: { - readonly query?: { - /** @description Indicates the state of the projects to return. */ - readonly state?: "open" | "closed" | "all"; - /** @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: { + "repos/custom-properties-for-repos-get-repository-values": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["project"][]; + "application/json": components["schemas"]["custom-property-value"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/create-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/custom-properties-for-repos-create-or-update-repository-values": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the project. */ - readonly name: string; - /** @description The description of the project. */ - readonly body?: string; - }; + repo: components["parameters"]["repo"]; }; + cookie?: never; }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "repos/get-custom-properties-values": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["custom-property-value"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/create-or-update-custom-properties-values": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A list of custom property names and associated values to apply to the repositories. */ - readonly properties: readonly components["schemas"]["custom-property-value"][]; + properties: components["schemas"]["custom-property-value"][]; }; }; }; - readonly responses: { + responses: { /** @description No Content when custom property values are successfully created or updated */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list": { - readonly parameters: { - readonly query?: { + "pulls/list": { + parameters: { + query?: { /** @description Either `open`, `closed`, or `all` to filter by state. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - readonly head?: string; + head?: string; /** @description Filter pulls by base branch name. Example: `gh-pages`. */ - readonly base?: string; + base?: string; /** @description What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ - readonly sort?: "created" | "updated" | "popularity" | "long-running"; + sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-simple"][]; + "application/json": components["schemas"]["pull-request-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The title of the new pull request. Required unless `issue` is specified. */ - readonly title?: string; + title?: string; /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - readonly head: string; + head: string; /** * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo */ - readonly head_repo?: string; + head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - readonly base: string; + base: string; /** @description The contents of the pull request. */ - readonly body?: string; + body?: string; /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - readonly maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean; /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - readonly draft?: boolean; + draft?: boolean; /** * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 */ - readonly issue?: number; + issue?: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request"]; + "application/json": components["schemas"]["pull-request"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list-review-comments-for-repo": { - readonly parameters: { - readonly query?: { - readonly sort?: "created" | "updated" | "created_at"; + "pulls/list-review-comments-for-repo": { + parameters: { + query?: { + sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-review-comment"][]; + "application/json": components["schemas"]["pull-request-review-comment"][]; }; }; }; }; - readonly "pulls/get-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/get-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/delete-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/delete-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/update-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The text of the reply to the review comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - readonly "reactions/list-for-pull-request-review-comment": { - readonly parameters: { - readonly query?: { + "reactions/list-for-pull-request-review-comment": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-pull-request-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-pull-request-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-pull-request-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-pull-request-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "pulls/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request"]; + "application/json": components["schemas"]["pull-request"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 406: components["responses"]["unacceptable"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 406: components["responses"]["unacceptable"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "pulls/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The title of the pull request. */ - readonly title?: string; + title?: string; /** @description The contents of the pull request. */ - readonly body?: string; + body?: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - readonly base?: string; + base?: string; /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - readonly maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request"]; + "application/json": components["schemas"]["pull-request"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/create-with-pr-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-with-pr-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - readonly multi_repo_permissions_opt_out?: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - readonly retention_period_minutes?: number; + retention_period_minutes?: number; } | null; }; }; - readonly responses: { + responses: { /** @description Response when the codespace was successfully created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "pulls/list-review-comments": { - readonly parameters: { - readonly query?: { + "pulls/list-review-comments": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-review-comment"][]; + "application/json": components["schemas"]["pull-request-review-comment"][]; }; }; }; }; - readonly "pulls/create-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The text of the review comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - readonly commit_id: string; + commit_id: string; /** @description The relative path to the file that necessitates a comment. */ - readonly path: string; + path: string; /** * @deprecated * @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; + position?: number; /** * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - readonly side?: "LEFT" | "RIGHT"; + side?: "LEFT" | "RIGHT"; /** @description **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - readonly line?: number; + line?: number; /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - readonly start_line?: number; + start_line?: number; /** * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - readonly start_side?: "LEFT" | "RIGHT" | "side"; + start_side?: "LEFT" | "RIGHT" | "side"; /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - readonly in_reply_to?: number; + in_reply_to?: number; /** * @description The level at which the comment is targeted. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/create-reply-for-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create-reply-for-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The text of the review comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/list-commits": { - readonly parameters: { - readonly query?: { + "pulls/list-commits": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit"][]; + "application/json": components["schemas"]["commit"][]; }; }; }; }; - readonly "pulls/list-files": { - readonly parameters: { - readonly query?: { + "pulls/list-files": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["diff-entry"][]; + "application/json": components["schemas"]["diff-entry"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "pulls/check-if-merged": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/check-if-merged": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if pull request has been merged */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if pull request has not been merged */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "pulls/merge": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/merge": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Title for the automatic commit message. */ - readonly commit_title?: string; + commit_title?: string; /** @description Extra detail to append to automatic commit message. */ - readonly commit_message?: string; + commit_message?: string; /** @description SHA that pull request head must match to allow merge. */ - readonly sha?: string; + sha?: string; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method?: "merge" | "squash" | "rebase"; + merge_method?: "merge" | "squash" | "rebase"; } | null; }; }; - readonly responses: { + responses: { /** @description if merge was successful */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-merge-result"]; + "application/json": components["schemas"]["pull-request-merge-result"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ - readonly 405: { + 405: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; /** @description Conflict if sha was provided and pull request head did not match */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list-requested-reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/list-requested-reviewers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-request"]; + "application/json": components["schemas"]["pull-request-review-request"]; }; }; }; }; - readonly "pulls/request-reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/request-reviewers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description An array of user `login`s that will be requested. */ - readonly reviewers?: readonly string[]; + reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ - readonly team_reviewers?: readonly string[]; + team_reviewers?: string[]; } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-simple"]; + "application/json": components["schemas"]["pull-request-simple"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "pulls/remove-requested-reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/remove-requested-reviewers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of user `login`s that will be removed. */ - readonly reviewers: readonly string[]; + reviewers: string[]; /** @description An array of team `slug`s that will be removed. */ - readonly team_reviewers?: readonly string[]; + team_reviewers?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-simple"]; + "application/json": components["schemas"]["pull-request-simple"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list-reviews": { - readonly parameters: { - readonly query?: { + "pulls/list-reviews": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The list of reviews returns in chronological order. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-review"][]; + "application/json": components["schemas"]["pull-request-review"][]; }; }; }; }; - readonly "pulls/create-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - readonly commit_id?: string; + commit_id?: string; /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - readonly body?: string; + body?: string; /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - readonly event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ - readonly comments?: readonly { + comments?: { /** @description The relative path to the file that necessitates a review comment. */ - readonly path: string; + path: string; /** @description 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; + position?: number; /** @description Text of the review comment. */ - readonly body: string; + body: string; /** @example 28 */ - readonly line?: number; + line?: number; /** @example RIGHT */ - readonly side?: string; + side?: string; /** @example 26 */ - readonly start_line?: number; + start_line?: number; /** @example LEFT */ - readonly start_side?: string; + start_side?: string; }[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/get-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/get-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/update-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The body text of the pull request review. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/delete-pending-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/delete-pending-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/list-comments-for-review": { - readonly parameters: { - readonly query?: { + "pulls/list-comments-for-review": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["review-comment"][]; + "application/json": components["schemas"]["review-comment"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/dismiss-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/dismiss-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The message for the pull request review dismissal */ - readonly message: string; + message: string; /** * @example "DISMISS" * @enum {string} */ - readonly event?: "DISMISS"; + event?: "DISMISS"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/submit-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/submit-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The body text of the pull request review */ - readonly body?: string; + body?: string; /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - readonly event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/update-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - readonly expected_head_sha?: string; + expected_head_sha?: string; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; + "application/json": { + message?: string; + url?: string; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-readme": { - readonly parameters: { - readonly query?: { + "repos/get-readme": { + parameters: { + query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["content-file"]; + "application/json": components["schemas"]["content-file"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-readme-in-directory": { - readonly parameters: { - readonly query?: { + "repos/get-readme-in-directory": { + parameters: { + query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ - readonly dir: string; + dir: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["content-file"]; + "application/json": components["schemas"]["content-file"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-releases": { - readonly parameters: { - readonly query?: { + "repos/list-releases": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["release"][]; + "application/json": components["schemas"]["release"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */ - readonly target_commitish?: string; + target_commitish?: string; /** @description The name of the release. */ - readonly name?: string; + name?: string; /** @description Text describing the contents of the tag. */ - readonly body?: string; + body?: string; /** * @description `true` to create a draft (unpublished) release, `false` to create a published one. * @default false */ - readonly draft?: boolean; + draft?: boolean; /** * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. * @default false */ - readonly prerelease?: boolean; + prerelease?: boolean; /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - readonly discussion_category_name?: string; + discussion_category_name?: string; /** * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. * @default false */ - readonly generate_release_notes?: boolean; + generate_release_notes?: boolean; /** * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. * @default true * @enum {string} */ - readonly make_latest?: "true" | "false" | "legacy"; + make_latest?: "true" | "false" | "legacy"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; /** @description Not Found if the discussion category name is invalid */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-release-asset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-release-asset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the asset. */ - readonly asset_id: components["parameters"]["asset-id"]; + asset_id: components["parameters"]["asset-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-asset"]; + "application/json": components["schemas"]["release-asset"]; }; }; - readonly 302: components["responses"]["found"]; - readonly 404: components["responses"]["not_found"]; + 302: components["responses"]["found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-release-asset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-release-asset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the asset. */ - readonly asset_id: components["parameters"]["asset-id"]; + asset_id: components["parameters"]["asset-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-release-asset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-release-asset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the asset. */ - readonly asset_id: components["parameters"]["asset-id"]; + asset_id: components["parameters"]["asset-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The file name of the asset. */ - readonly name?: string; + name?: string; /** @description An alternate short description of the asset. Used in place of the filename. */ - readonly label?: string; + label?: string; /** @example "uploaded" */ - readonly state?: string; + state?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-asset"]; + "application/json": components["schemas"]["release-asset"]; }; }; }; }; - readonly "repos/generate-release-notes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/generate-release-notes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The tag name for the release. This can be an existing tag or a new one. */ - readonly tag_name: string; + tag_name: string; /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - readonly target_commitish?: string; + target_commitish?: string; /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - readonly previous_tag_name?: string; + previous_tag_name?: string; /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - readonly configuration_file_path?: string; + configuration_file_path?: string; }; }; }; - readonly responses: { + responses: { /** @description Name and body of generated release notes */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-notes-content"]; + "application/json": components["schemas"]["release-notes-content"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-latest-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-latest-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; }; }; - readonly "repos/get-release-by-tag": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-release-by-tag": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description tag parameter */ - readonly tag: string; + tag: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ - readonly 401: { + 401: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/delete-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the tag. */ - readonly tag_name?: string; + tag_name?: string; /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */ - readonly target_commitish?: string; + target_commitish?: string; /** @description The name of the release. */ - readonly name?: string; + name?: string; /** @description Text describing the contents of the tag. */ - readonly body?: string; + body?: string; /** @description `true` makes the release a draft, and `false` publishes the release. */ - readonly draft?: boolean; + draft?: boolean; /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - readonly prerelease?: boolean; + prerelease?: boolean; /** * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. * @default true * @enum {string} */ - readonly make_latest?: "true" | "false" | "legacy"; + make_latest?: "true" | "false" | "legacy"; /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - readonly discussion_category_name?: string; + discussion_category_name?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; /** @description Not Found if the discussion category name is invalid */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "repos/list-release-assets": { - readonly parameters: { - readonly query?: { + "repos/list-release-assets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["release-asset"][]; + "application/json": components["schemas"]["release-asset"][]; }; }; }; }; - readonly "repos/upload-release-asset": { - readonly parameters: { - readonly query: { - readonly name: string; - readonly label?: string; + "repos/upload-release-asset": { + parameters: { + query: { + name: string; + label?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/octet-stream": string; + requestBody?: { + content: { + "application/octet-stream": string; }; }; - readonly responses: { + responses: { /** @description Response for successful upload */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-asset"]; + "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "reactions/list-for-release": { - readonly parameters: { - readonly query?: { + "reactions/list-for-release": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ - readonly content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ - readonly content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-branch-rules": { - readonly parameters: { - readonly query?: { + "repos/get-branch-rules": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-rule-detailed"][]; + "application/json": components["schemas"]["repository-rule-detailed"][]; }; }; }; }; - readonly "repos/get-repo-rulesets": { - readonly parameters: { - readonly query?: { + "repos/get-repo-rulesets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ - readonly includes_parents?: boolean; + 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"]; + targets?: components["parameters"]["ruleset-targets"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-ruleset"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/create-repo-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-repo-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name: string; + name: string; /** * @description The target of the ruleset * @default branch * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push"; + enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["repository-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["repository-rule"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-repo-rule-suites": { - readonly parameters: { - readonly query?: { + "repos/get-repo-rule-suites": { + parameters: { + query?: { /** @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?: components["parameters"]["ref-in-query"]; + ref?: components["parameters"]["ref-in-query"]; /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ - readonly time_period?: components["parameters"]["time-period"]; + time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - readonly actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["rule-suites"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-repo-rule-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-repo-rule-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The unique identifier of the rule suite result. * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) * for organizations. */ - readonly rule_suite_id: components["parameters"]["rule-suite-id"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["rule-suite"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-repo-ruleset": { - readonly parameters: { - readonly query?: { + "repos/get-repo-ruleset": { + parameters: { + query?: { /** @description Include rulesets configured at higher levels that apply to this repository */ - readonly includes_parents?: boolean; + includes_parents?: boolean; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/update-repo-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-repo-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name?: string; + name?: string; /** * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; - readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["repository-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["repository-rule"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/delete-repo-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-repo-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "secret-scanning/list-alerts-for-repo": { - readonly parameters: { - readonly query?: { + "repos/get-repo-ruleset-history": { + 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 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 ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-repo-ruleset-version": { + 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 ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "secret-scanning/list-alerts-for-repo": { + parameters: { + query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; + sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + 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"]; + 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"]; + 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"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["secret-scanning-alert"][]; + "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/get-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/get-alert": { + parameters: { + query?: { + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; + }; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-alert"]; + "application/json": components["schemas"]["secret-scanning-alert"]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/update-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/update-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly state: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - readonly resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; - }; + requestBody: { + content: { + "application/json": { + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; + assignee?: components["schemas"]["secret-scanning-alert-assignee"]; + } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-alert"]; + "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - /** @description State does not match the resolution or resolution comment */ - readonly 422: { + /** @description State does not match the resolution or resolution comment, or assignee does not have write access to the repository */ + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/list-locations-for-alert": { - readonly parameters: { - readonly query?: { + "secret-scanning/list-locations-for-alert": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["secret-scanning-location"][]; + "application/json": components["schemas"]["secret-scanning-location"][]; }; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/create-push-protection-bypass": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; - readonly placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; }; }; /** @description User does not have enough permissions to perform this action. */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Placeholder ID not found, or push protection is disabled on this repository. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Bad request, input data missing or incorrect. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/get-scan-history": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-scan-history"]; + "application/json": components["schemas"]["secret-scanning-scan-history"]; }; }; /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "security-advisories/list-repository-advisories": { - readonly parameters: { - readonly query?: { + "security-advisories/list-repository-advisories": { + parameters: { + query?: { /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "published"; + sort?: "created" | "updated" | "published"; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; + per_page?: number; /** @description Filter by state of the repository advisories. Only advisories of this state will be returned. */ - readonly state?: "triage" | "draft" | "published" | "closed"; + state?: "triage" | "draft" | "published" | "closed"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-advisory"][]; + "application/json": components["schemas"]["repository-advisory"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "security-advisories/create-repository-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-repository-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["repository-advisory-create"]; + requestBody: { + content: { + "application/json": components["schemas"]["repository-advisory-create"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "security-advisories/create-private-vulnerability-report": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-private-vulnerability-report": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["private-vulnerability-report-create"]; + requestBody: { + content: { + "application/json": components["schemas"]["private-vulnerability-report-create"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "security-advisories/get-repository-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/get-repository-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "security-advisories/update-repository-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/update-repository-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["repository-advisory-update"]; + requestBody: { + content: { + "application/json": components["schemas"]["repository-advisory-update"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Validation failed, or the endpoint has been spammed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"]; + "application/json": components["schemas"]["validation-error"]; }; }; }; }; - readonly "security-advisories/create-repository-advisory-cve-request": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-repository-advisory-cve-request": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "security-advisories/create-fork": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-fork": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "activity/list-stargazers-for-repo": { - readonly parameters: { - readonly query?: { + "activity/list-stargazers-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][] | readonly components["schemas"]["stargazer"][]; + "application/json": components["schemas"]["simple-user"][] | components["schemas"]["stargazer"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-code-frequency-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-code-frequency-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-frequency-stat"][]; + "application/json": components["schemas"]["code-frequency-stat"][]; }; }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; /** @description Repository contains more than 10,000 commits */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-commit-activity-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-commit-activity-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit-activity"][]; + "application/json": components["schemas"]["commit-activity"][]; }; }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; }; }; - readonly "repos/get-contributors-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-contributors-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["contributor-activity"][]; + "application/json": components["schemas"]["contributor-activity"][]; }; }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; }; }; - readonly "repos/get-participation-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-participation-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The array order is oldest week (index 0) to most recent week. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["participation-stats"]; + "application/json": components["schemas"]["participation-stats"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-punch-card-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-punch-card-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-frequency-stat"][]; + "application/json": components["schemas"]["code-frequency-stat"][]; }; }; - readonly 204: components["responses"]["no_content"]; + 204: components["responses"]["no_content"]; }; }; - readonly "repos/create-commit-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-commit-status": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly sha: string; + repo: components["parameters"]["repo"]; + sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state of the status. * @enum {string} */ - readonly state: "error" | "failure" | "pending" | "success"; + state: "error" | "failure" | "pending" | "success"; /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - readonly target_url?: string | null; + target_url?: string | null; /** @description A short description of the status. */ - readonly description?: string | null; + description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - readonly context?: string; + context?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["status"]; + "application/json": components["schemas"]["status"]; }; }; }; }; - readonly "activity/list-watchers-for-repo": { - readonly parameters: { - readonly query?: { + "activity/list-watchers-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "activity/get-repo-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/get-repo-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if you subscribe to the repository */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-subscription"]; + "application/json": components["schemas"]["repository-subscription"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "activity/set-repo-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/set-repo-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Determines if notifications should be received from this repository. */ - readonly subscribed?: boolean; + subscribed?: boolean; /** @description Determines if all notifications should be blocked from this repository. */ - readonly ignored?: boolean; + ignored?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-subscription"]; + "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - readonly "activity/delete-repo-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/delete-repo-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-tags": { - readonly parameters: { - readonly query?: { + "repos/list-tags": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["tag"][]; + "application/json": components["schemas"]["tag"][]; }; }; }; }; - readonly "repos/list-tag-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/download-tarball-archive": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; + ref: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["tag-protection"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/create-tag-protection": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description An optional glob pattern to match against when enforcing tag protection. */ - readonly pattern: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["tag-protection"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/delete-tag-protection": { - 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 unique identifier of the tag protection. */ - readonly tag_protection_id: components["parameters"]["tag-protection-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/download-tarball-archive": { - 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"]; - readonly ref: string; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-teams": { - readonly parameters: { - readonly query?: { + "repos/list-teams": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-all-topics": { - readonly parameters: { - readonly query?: { + "repos/get-all-topics": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["topic"]; + "application/json": components["schemas"]["topic"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/replace-all-topics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/replace-all-topics": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ - readonly names: readonly string[]; + names: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["topic"]; + "application/json": components["schemas"]["topic"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "repos/get-clones": { - readonly parameters: { - readonly query?: { + "repos/get-clones": { + parameters: { + query?: { /** @description The time frame to display results for. */ - readonly per?: components["parameters"]["per"]; + per?: components["parameters"]["per"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["clone-traffic"]; + "application/json": components["schemas"]["clone-traffic"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-top-paths": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-top-paths": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["content-traffic"][]; + "application/json": components["schemas"]["content-traffic"][]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-top-referrers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-top-referrers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["referrer-traffic"][]; + "application/json": components["schemas"]["referrer-traffic"][]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-views": { - readonly parameters: { - readonly query?: { + "repos/get-views": { + parameters: { + query?: { /** @description The time frame to display results for. */ - readonly per?: components["parameters"]["per"]; + per?: components["parameters"]["per"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["view-traffic"]; + "application/json": components["schemas"]["view-traffic"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/transfer": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/transfer": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username or organization name the repository will be transferred to. */ - readonly new_owner: string; + new_owner: string; /** @description The new name to be given to the repository. */ - readonly new_name?: string; + new_name?: string; /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - readonly team_ids?: readonly number[]; + team_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["minimal-repository"]; + "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - readonly "repos/check-vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if repository is enabled with vulnerability alerts */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/enable-vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/enable-vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/disable-vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/download-zipball-archive": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/download-zipball-archive": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly ref: string; + repo: components["parameters"]["repo"]; + ref: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/create-using-template": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-using-template": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the template repository. The name is not case sensitive. */ - readonly template_owner: string; + template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ - readonly template_repo: string; + template_repo: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - readonly owner?: string; + owner?: string; /** @description The name of the new repository. */ - readonly name: string; + name: string; /** @description A short description of the new repository. */ - readonly description?: string; + description?: string; /** * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. * @default false */ - readonly include_all_branches?: boolean; + include_all_branches?: boolean; /** * @description Either `true` to create a new private repository or `false` to create a new public one. * @default false */ - readonly private?: boolean; + private?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; }; }; - readonly "repos/list-public": { - readonly parameters: { - readonly query?: { + "repos/list-public": { + parameters: { + query?: { /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-repo"]; + since?: components["parameters"]["since-repo"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "search/code": { - readonly parameters: { - readonly query: { + "search/code": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** * @deprecated * @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"; + sort?: "indexed"; /** * @deprecated * @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"; + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["code-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["code-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "search/commits": { - readonly parameters: { - readonly query: { + "search/commits": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "author-date" | "committer-date"; + sort?: "author-date" | "committer-date"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["commit-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["commit-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "search/issues-and-pull-requests": { - readonly parameters: { - readonly query: { + "search/issues-and-pull-requests": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; + sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; + /** + * @description Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + advanced_search?: components["parameters"]["issues-advanced-search"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["issue-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["issue-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "search/labels": { - readonly parameters: { - readonly query: { + "search/labels": { + parameters: { + query: { /** @description The id of the repository. */ - readonly repository_id: number; + repository_id: number; /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ - readonly q: string; + q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "created" | "updated"; + sort?: "created" | "updated"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["label-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["label-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "search/repos": { - readonly parameters: { - readonly query: { + "search/repos": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["repo-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["repo-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "search/topics": { - readonly parameters: { - readonly query: { + "search/topics": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ - readonly q: string; + q: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["topic-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["topic-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "search/users": { - readonly parameters: { - readonly query: { + "search/users": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "followers" | "repositories" | "joined"; + sort?: "followers" | "repositories" | "joined"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["user-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["user-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; - readonly "teams/get-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "teams/delete-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-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 422: components["responses"]["validation_failed"]; - }; - }; - readonly "teams/update-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the team. */ - readonly name: string; - /** @description The description of the team. */ - readonly description?: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - readonly privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number | null; - }; - }; - }; - readonly responses: { - /** @description Response when the updated information already exists */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "teams/list-discussions-legacy": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-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 components["schemas"]["team-discussion"][]; - }; - }; - }; - }; - readonly "teams/create-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title: string; - /** @description The discussion post's body text. */ - readonly body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - readonly private?: boolean; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/get-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/delete-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/update-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title?: string; - /** @description The discussion post's body text. */ - readonly body?: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/list-discussion-comments-legacy": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - 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 components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - readonly "teams/create-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "teams/get-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["team-full"]; }; }; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/delete-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/delete-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/update-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/update-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - readonly "reactions/list-for-team-discussion-comment-legacy": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - 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 components["schemas"]["reaction"][]; - }; - }; - }; - }; - readonly "reactions/create-for-team-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["reaction"]; + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} + */ + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; - }; - readonly "reactions/list-for-team-discussion-legacy": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + responses: { + /** @description Response when the updated information already exists */ + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - }; - }; - readonly "reactions/create-for-team-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + "application/json": components["schemas"]["team-full"]; }; }; - }; - readonly responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/list-pending-invitations-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-pending-invitations-legacy": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; }; }; - readonly "teams/list-members-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-members-legacy": { + parameters: { + query?: { /** @description Filters members returned by their role in the team. */ - readonly role?: "member" | "maintainer" | "all"; + role?: "member" | "maintainer" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/get-member-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-member-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if user is a member */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description if user is not a member */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-member-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-member-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-member-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-member-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if team synchronization is setup */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/get-membership-for-user-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-membership-for-user-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/add-or-update-membership-for-user-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-membership-for-user-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The role that this user should have in the team. * @default member * @enum {string} */ - readonly role?: "member" | "maintainer"; + role?: "member" | "maintainer"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-membership-for-user-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-membership-for-user-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description if team synchronization is set up */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-projects-legacy": { - 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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-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 components["schemas"]["team-project"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "teams/check-permissions-for-project-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - readonly 404: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/add-or-update-project-permissions-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - readonly permission?: "read" | "write" | "admin"; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "teams/remove-project-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/list-repos-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-repos-legacy": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/check-permissions-for-repo-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/check-permissions-for-repo-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Alternative response with extra repository information */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-repository"]; + "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if repository is not managed by this team */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-repo-permissions-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-repo-permissions-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - readonly permission?: "pull" | "push" | "admin"; + permission?: "pull" | "push" | "admin"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/remove-repo-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-repo-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/list-child-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-child-legacy": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if child teams exist */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/get-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/update-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The new name of the user. * @example Omar Jahandar */ - readonly name?: string; + name?: string; /** * @description The publicly visible email address of the user. * @example omar@example.com */ - readonly email?: string; + email?: string; /** * @description The new blog URL of the user. * @example blog.example.com */ - readonly blog?: string; + blog?: string; /** * @description The new Twitter username of the user. * @example therealomarj */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** * @description The new company of the user. * @example Acme corporation */ - readonly company?: string; + company?: string; /** * @description The new location of the user. * @example Berlin, Germany */ - readonly location?: string; + location?: string; /** @description The new hiring availability of the user. */ - readonly hireable?: boolean; + hireable?: boolean; /** @description The new short biography of the user. */ - readonly bio?: string; + bio?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["private-user"]; + "application/json": components["schemas"]["private-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-blocked-by-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-blocked-by-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/check-blocked": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/check-blocked": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If the user is blocked */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; /** @description If the user is not blocked */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "users/block": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/block": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/unblock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/unblock": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description ID of the Repository to filter on */ - readonly repository_id?: components["parameters"]["repository-id-in-query"]; + repository_id?: components["parameters"]["repository-id-in-query"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/create-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "codespaces/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Repository id for this codespace */ - readonly repository_id: number; + repository_id: number; /** @description Git ref (typically a branch name) for this codespace */ - readonly ref?: string; + ref?: string; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - readonly multi_repo_permissions_opt_out?: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - readonly retention_period_minutes?: number; + retention_period_minutes?: number; } | { /** @description Pull request number for this codespace */ - readonly pull_request: { + pull_request: { /** @description Pull request number */ - readonly pull_request_number: number; + pull_request_number: number; /** @description Repository id for this codespace */ - readonly repository_id: number; + repository_id: number; }; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; }; }; }; - readonly responses: { + responses: { /** @description Response when the codespace was successfully created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "codespaces/list-secrets-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-secrets-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["codespaces-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["codespaces-secret"][]; }; }; }; }; }; - readonly "codespaces/get-public-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "codespaces/get-public-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-user-public-key"]; + "application/json": components["schemas"]["codespaces-user-public-key"]; }; }; }; }; - readonly "codespaces/get-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-secret"]; + "application/json": components["schemas"]["codespaces-secret"]; }; }; }; }; - readonly "codespaces/create-or-update-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-or-update-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; + key_id: string; /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */ - readonly selected_repository_ids?: readonly (number | string)[]; + selected_repository_ids?: (number | string)[]; }; }; }; - readonly responses: { + responses: { /** @description Response after successfully creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response after successfully updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/delete-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/list-repositories-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/list-repositories-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/set-repositories-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-repositories-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description No Content when repositories were added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/add-repository-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/add-repository-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/remove-repository-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/remove-repository-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/get-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/delete-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/update-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/update-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description A valid machine to transition this codespace to. */ - readonly machine?: string; + machine?: string; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - readonly recent_folders?: readonly string[]; + recent_folders?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/export-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/export-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace-export-details"]; + "application/json": components["schemas"]["codespace-export-details"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/get-export-details-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-export-details-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - readonly export_id: components["parameters"]["export-id"]; + export_id: components["parameters"]["export-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace-export-details"]; + "application/json": components["schemas"]["codespace-export-details"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/codespace-machines-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/codespace-machines-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly machines: readonly components["schemas"]["codespace-machine"][]; + "application/json": { + total_count: number; + machines: components["schemas"]["codespace-machine"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/publish-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/publish-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A name for the new repository. */ - readonly name?: string; + name?: string; /** * @description Whether the new repository should be private. * @default false */ - readonly private?: boolean; + private?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace-with-full-repository"]; + "application/json": components["schemas"]["codespace-with-full-repository"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/start-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; /** @description Payment required */ - readonly 402: { + 402: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/stop-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/stop-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; }; }; - readonly "users/set-primary-email-visibility-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/set-primary-email-visibility-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - readonly visibility: "public" | "private"; + visibility: "public" | "private"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-emails-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-emails-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/add-email-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example [] */ - readonly emails: readonly string[]; - } | readonly string[] | string; + emails: string[]; + } | string[] | string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/delete-email-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Email addresses associated with the GitHub user account. */ - readonly emails: readonly string[]; - } | readonly string[] | string; + emails: string[]; + } | string[] | string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-followers-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-followers-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/list-followed-by-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-followed-by-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/check-person-is-followed-by-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/check-person-is-followed-by-authenticated": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if the person is followed by the authenticated user */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "users/follow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/follow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/unfollow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/unfollow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-gpg-keys-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-gpg-keys-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gpg-key"][]; + "application/json": components["schemas"]["gpg-key"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/create-gpg-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A descriptive name for the new key. */ - readonly name?: string; + name?: string; /** @description A GPG key in ASCII-armored format. */ - readonly armored_public_key: string; + armored_public_key: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gpg-key"]; + "application/json": components["schemas"]["gpg-key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/get-gpg-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/get-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the GPG key. */ - readonly gpg_key_id: components["parameters"]["gpg-key-id"]; + gpg_key_id: components["parameters"]["gpg-key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gpg-key"]; + "application/json": components["schemas"]["gpg-key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/delete-gpg-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/delete-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the GPG key. */ - readonly gpg_key_id: components["parameters"]["gpg-key-id"]; + gpg_key_id: components["parameters"]["gpg-key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/list-installations-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "apps/list-installations-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly installations: readonly components["schemas"]["installation"][]; + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "apps/list-installation-repos-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "apps/list-installation-repos-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repository_selection?: string; - readonly repositories: readonly components["schemas"]["repository"][]; + "application/json": { + total_count: number; + repository_selection?: string; + repositories: components["schemas"]["repository"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/add-repo-to-installation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/add-repo-to-installation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/remove-repo-from-installation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/remove-repo-from-installation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "interactions/get-restrictions-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "interactions/get-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Default response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; /** @description Response when there are no restrictions */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "interactions/set-restrictions-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "interactions/set-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "interactions/remove-restrictions-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "interactions/remove-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "issues/list-for-authenticated-user": { + parameters: { + query?: { /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-public-ssh-keys-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-public-ssh-keys-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["key"][]; + "application/json": components["schemas"]["key"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/create-public-ssh-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - readonly title?: string; + title?: string; /** @description The public SSH key to add to your GitHub account. */ - readonly key: string; + key: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["key"]; + "application/json": components["schemas"]["key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/get-public-ssh-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/get-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["key"]; + "application/json": components["schemas"]["key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/delete-public-ssh-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/delete-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/list-subscriptions-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "apps/list-subscriptions-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["user-marketplace-purchase"][]; + "application/json": components["schemas"]["user-marketplace-purchase"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/list-subscriptions-for-authenticated-user-stubbed": { - readonly parameters: { - readonly query?: { + "apps/list-subscriptions-for-authenticated-user-stubbed": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["user-marketplace-purchase"][]; + "application/json": components["schemas"]["user-marketplace-purchase"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "orgs/list-memberships-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "orgs/list-memberships-for-authenticated-user": { + parameters: { + query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ - readonly state?: "active" | "pending"; + state?: "active" | "pending"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-membership"][]; + "application/json": components["schemas"]["org-membership"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - readonly state: "active"; + state: "active"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "migrations/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "migrations/list-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["migration"][]; + "application/json": components["schemas"]["migration"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "migrations/start-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - readonly lock_repositories?: boolean; + lock_repositories?: boolean; /** * @description Indicates whether metadata should be excluded and only git source should be included for the migration. * @example true */ - readonly exclude_metadata?: boolean; + exclude_metadata?: boolean; /** * @description Indicates whether the repository git data should be excluded from the migration. * @example true */ - readonly exclude_git_data?: boolean; + exclude_git_data?: boolean; /** * @description Do not include attachments in the migration * @example true */ - readonly exclude_attachments?: boolean; + exclude_attachments?: boolean; /** * @description Do not include releases in the migration * @example true */ - readonly exclude_releases?: boolean; + exclude_releases?: boolean; /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - readonly exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean; /** * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). * @default false * @example true */ - readonly org_metadata_only?: boolean; + org_metadata_only?: boolean; /** * @description Exclude attributes from the API response to improve performance * @example [ * "repositories" * ] */ - readonly exclude?: readonly "repositories"[]; - readonly repositories: readonly string[]; + exclude?: "repositories"[]; + repositories: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "migrations/get-status-for-authenticated-user": { - readonly parameters: { - readonly query?: { - readonly exclude?: readonly string[]; + "migrations/get-status-for-authenticated-user": { + parameters: { + query?: { + exclude?: string[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/get-archive-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/get-archive-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "migrations/delete-archive-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/delete-archive-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/unlock-repo-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/unlock-repo-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; /** @description repo_name parameter */ - readonly repo_name: components["parameters"]["repo-name"]; + repo_name: components["parameters"]["repo-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/list-repos-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "migrations/list-repos-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "orgs/list-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; + "application/json": components["schemas"]["organization-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "packages/list-packages-for-authenticated-user": { - readonly parameters: { - readonly query: { + "packages/list-packages-for-authenticated-user": { + parameters: { + query: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly visibility?: components["parameters"]["package-visibility"]; + visibility?: components["parameters"]["package-visibility"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 400: components["responses"]["package_es_list_error"]; + 400: components["responses"]["package_es_list_error"]; }; }; - readonly "packages/get-package-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package"]; + "application/json": components["schemas"]["package"]; }; }; }; }; - readonly "packages/delete-package-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "packages/restore-package-for-authenticated-user": { + parameters: { + query?: { /** @description package token */ - readonly token?: string; + token?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { - readonly parameters: { - readonly query?: { + "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ - readonly state?: "active" | "deleted"; + state?: "active" | "deleted"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; + "application/json": components["schemas"]["package-version"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-package-version-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-version-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["package-version"]; }; }; }; }; - readonly "packages/delete-package-version-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-version-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-version-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/restore-package-version-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/create-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - readonly name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - readonly body?: string | null; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "users/list-public-emails-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-public-emails-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "repos/list-for-authenticated-user": { + parameters: { + query?: { /** @description Limit results to repositories with the specified visibility. */ - readonly visibility?: "all" | "public" | "private"; + visibility?: "all" | "public" | "private"; /** * @description Comma-separated list of values. Can include: * * `owner`: Repositories that are owned by the authenticated user. * * `collaborator`: Repositories that the user has been added to as a collaborator. * * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - readonly affiliation?: string; + affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - readonly type?: "all" | "owner" | "public" | "private" | "member"; + type?: "all" | "owner" | "public" | "private" | "member"; /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since-repo-date"]; + since?: components["parameters"]["since-repo-date"]; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before-repo-date"]; + before?: components["parameters"]["before-repo-date"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository"][]; + "application/json": components["schemas"]["repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/create-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @description A short description of the repository. */ - readonly description?: string; + description?: string; /** @description A URL with more information about the repository. */ - readonly homepage?: string; + homepage?: string; /** * @description Whether the repository is private. * @default false */ - readonly private?: boolean; + private?: boolean; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues?: boolean; + has_issues?: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects?: boolean; + has_projects?: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki?: boolean; + has_wiki?: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions?: boolean; + has_discussions?: boolean; /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - readonly team_id?: number; + team_id?: number; /** * @description Whether the repository is initialized with a minimal README. * @default false */ - readonly auto_init?: boolean; + auto_init?: boolean; /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - readonly gitignore_template?: string; + gitignore_template?: string; /** * @description The license keyword of the open source license for this repository. * @example mit */ - readonly license_template?: string; + license_template?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -121433,7 +128531,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -121442,7 +128540,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -121452,7 +128550,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -121461,1615 +128559,2341 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads?: boolean; + has_downloads?: boolean; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template?: boolean; + is_template?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-invitations-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "repos/list-invitations-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-invitation"][]; + "application/json": components["schemas"]["repository-invitation"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/decline-invitation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/decline-invitation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "repos/accept-invitation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/accept-invitation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "users/list-social-accounts-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-social-accounts-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["social-account"][]; + "application/json": components["schemas"]["social-account"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/add-social-account-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Full URLs for the social media profiles to add. * @example [] */ - readonly account_urls: readonly string[]; + account_urls: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["social-account"][]; + "application/json": components["schemas"]["social-account"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/delete-social-account-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Full URLs for the social media profiles to delete. * @example [] */ - readonly account_urls: readonly string[]; + account_urls: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "users/list-ssh-signing-keys-for-authenticated-user": { + 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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ssh-signing-key"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description A descriptive name for the new key. + * @example Personal MacBook Air + */ + title?: string; + /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + key: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ssh-signing-key"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "users/get-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the SSH signing key. */ + ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ssh-signing-key"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the SSH signing key. */ + ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "activity/list-repos-starred-by-authenticated-user": { + parameters: { + query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ + sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/check-repo-is-starred-by-authenticated-user": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response if this repository is starred by you */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Not Found if this repository is not starred by you */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "activity/star-repo-for-authenticated-user": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "activity/unstar-repo-for-authenticated-user": { + 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"]; + }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-ssh-signing-keys-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-watched-repos-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["ssh-signing-key"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/create-ssh-signing-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description A descriptive name for the new key. - * @example Personal MacBook Air - */ - readonly title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ - readonly key: string; - }; + "teams/list-for-authenticated-user": { + 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?: never; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["ssh-signing-key"]; + "application/json": components["schemas"]["team-full"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/get-ssh-signing-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the SSH signing key. */ - readonly ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + "users/get-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description account_id parameter */ + account_id: components["parameters"]["account-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["ssh-signing-key"]; + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/delete-ssh-signing-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the SSH signing key. */ - readonly ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + "projects/create-draft-item-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; }; - readonly cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; }; - content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-repos-starred-by-authenticated-user": { - readonly parameters: { - readonly query?: { - /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - readonly sort?: components["parameters"]["sort-starred"]; - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + "users/list": { + parameters: { + query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ + since?: components["parameters"]["since-user"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + /** @example ; rel="next" */ + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository"][]; - readonly "application/vnd.github.v3.star+json": readonly components["schemas"]["starred-repository"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "activity/check-repo-is-starred-by-authenticated-user": { - 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"]; + "projects/create-view-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - /** @description Response if this repository is starred by you */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; }; - content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - /** @description Not Found if this repository is not starred by you */ - readonly 404: { + }; + responses: { + /** @description Response for creating a view in a user-owned project. */ + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["projects-v2-view"]; }; }; - }; - }; - readonly "activity/star-repo-for-authenticated-user": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "activity/unstar-repo-for-authenticated-user": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + content: { + "application/json": components["schemas"]["basic-error"]; }; - content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "activity/list-watched-repos-for-authenticated-user": { - 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"]; + "users/get-by-username": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-attestations-bulk": { + 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)." */ - 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"]; + per_page?: components["parameters"]["per-page"]; + /** @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"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-full"][]; + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "users/get-by-id": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; + "users/delete-attestations-bulk": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list": { - readonly parameters: { - readonly query?: { - /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-user"]; - /** @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"]; + "users/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + [name: string]: unknown; }; - content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/get-by-username": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; + /** @description Attestation ID */ + attestation_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; - content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-attestations": { - readonly parameters: { - readonly query?: { + "users/list-attestations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description Subject Digest */ - readonly subject_digest: string; + subject_digest: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly attestations?: readonly { - readonly bundle?: components["schemas"]["sigstore-bundle-0"]; - readonly repository_id?: number; - readonly bundle_url?: string; + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/list-docker-migration-conflicting-packages-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/list-docker-migration-conflicting-packages-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-events-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-events-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "activity/list-org-events-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-org-events-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "activity/list-public-events-for-user": { - readonly parameters: { - readonly query?: { + "activity/list-public-events-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "users/list-followers-for-user": { - readonly parameters: { - readonly query?: { + "users/list-followers-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "users/list-following-for-user": { - readonly parameters: { - readonly query?: { + "users/list-following-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "users/check-following-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/check-following-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - readonly target_user: string; + username: components["parameters"]["username"]; + target_user: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if the user follows the target user */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description if the user does not follow the target user */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "gists/list-for-user": { - readonly parameters: { - readonly query?: { + "gists/list-for-user": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-gpg-keys-for-user": { - readonly parameters: { - readonly query?: { + "users/list-gpg-keys-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gpg-key"][]; + "application/json": components["schemas"]["gpg-key"][]; }; }; }; }; - readonly "users/get-context-for-user": { - readonly parameters: { - readonly query?: { + "users/get-context-for-user": { + parameters: { + query?: { /** @description Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - readonly subject_type?: "organization" | "repository" | "issue" | "pull_request"; + subject_type?: "organization" | "repository" | "issue" | "pull_request"; /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - readonly subject_id?: string; + subject_id?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hovercard"]; + "application/json": components["schemas"]["hovercard"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-user-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-user-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; }; }; - readonly "users/list-public-keys-for-user": { - readonly parameters: { - readonly query?: { + "users/list-public-keys-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["key-simple"][]; + "application/json": components["schemas"]["key-simple"][]; }; }; }; }; - readonly "orgs/list-for-user": { - readonly parameters: { - readonly query?: { + "orgs/list-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; + "application/json": components["schemas"]["organization-simple"][]; }; }; }; }; - readonly "packages/list-packages-for-user": { - readonly parameters: { - readonly query: { + "packages/list-packages-for-user": { + parameters: { + query: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly visibility?: components["parameters"]["package-visibility"]; + visibility?: components["parameters"]["package-visibility"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 400: components["responses"]["package_es_list_error"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "packages/get-package-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package"]; + "application/json": components["schemas"]["package"]; }; }; }; }; - readonly "packages/delete-package-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-for-user": { - readonly parameters: { - readonly query?: { + "packages/restore-package-for-user": { + parameters: { + query?: { /** @description package token */ - readonly token?: string; + token?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-all-package-versions-for-package-owned-by-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-all-package-versions-for-package-owned-by-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; + "application/json": components["schemas"]["package-version"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-package-version-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-version-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["package-version"]; }; }; }; }; - readonly "packages/delete-package-version-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-version-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-version-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/restore-package-version-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/list-for-user": { - readonly parameters: { - readonly query?: { - /** @description Indicates the state of the projects to return. */ - readonly state?: "open" | "closed" | "all"; + "projects/list-for-user": { + parameters: { + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"][]; + }; }; - readonly header?: never; - readonly path: { + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-received-events-for-user": { - readonly parameters: { - readonly query?: { + "projects/list-fields-for-user": { + 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)." */ - 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"]; + per_page?: components["parameters"]["per-page"]; + /** @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"]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/add-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; }; - readonly header?: never; - readonly path: { + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-received-public-events-for-user": { - readonly parameters: { - readonly query?: { + "projects/list-items-for-user": { + parameters: { + query?: { + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/list-for-user": { - readonly parameters: { - readonly query?: { - /** @description Limit results to repositories of the specified type. */ - readonly type?: "all" | "owner" | "member"; - /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - readonly direction?: "asc" | "desc"; + "projects/add-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-user-item": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-view-items-for-user": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "billing/get-github-actions-billing-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/list-received-events-for-user": { + 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 handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "billing/get-github-packages-billing-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/list-received-public-events-for-user": { + 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 handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "billing/get-shared-storage-billing-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-for-user": { + parameters: { + query?: { + /** @description Limit results to repositories of the specified type. */ + type?: "all" | "owner" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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 handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "users/list-social-accounts-for-user": { - readonly parameters: { - readonly query?: { + "billing/get-github-billing-premium-request-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "users/list-social-accounts-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["social-account"][]; + "application/json": components["schemas"]["social-account"][]; }; }; }; }; - readonly "users/list-ssh-signing-keys-for-user": { - readonly parameters: { - readonly query?: { + "users/list-ssh-signing-keys-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["ssh-signing-key"][]; + "application/json": components["schemas"]["ssh-signing-key"][]; }; }; }; }; - readonly "activity/list-repos-starred-by-user": { - readonly parameters: { - readonly query?: { + "activity/list-repos-starred-by-user": { + parameters: { + query?: { /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - readonly sort?: components["parameters"]["sort-starred"]; + sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["starred-repository"][] | readonly components["schemas"]["repository"][]; + "application/json": components["schemas"]["starred-repository"][] | components["schemas"]["repository"][]; }; }; }; }; - readonly "activity/list-repos-watched-by-user": { - readonly parameters: { - readonly query?: { + "activity/list-repos-watched-by-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "meta/get-all-versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/get-all-versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "meta/get-zen": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": string; + "text/plain": string; }; }; }; diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index 2c9ec9141..07ce6c0b6 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -4,32 +4,32 @@ */ export interface paths { - readonly "/": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * GitHub API Root * @description Get Hypermedia links to resources accessible in GitHub's REST API */ - readonly get: operations["meta/root"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/root"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/advisories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List global security advisories @@ -37,41 +37,41 @@ export interface paths { * * By default, all responses will exclude advisories for malware, because malware are not standard vulnerabilities. To list advisories for malware, you must include the `type` parameter in your request, with the value `malware`. For more information about the different types of security advisories, see "[About the GitHub Advisory database](https://docs.github.com/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database#about-types-of-security-advisories)." */ - readonly get: operations["security-advisories/list-global-advisories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["security-advisories/list-global-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/advisories/{ghsa_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a global security advisory * @description Gets a global security advisory using its GitHub Security Advisory (GHSA) identifier. */ - readonly get: operations["security-advisories/get-global-advisory"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["security-advisories/get-global-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the authenticated app @@ -79,41 +79,41 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-authenticated"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/app-manifests/{code}/conversions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["apps/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/app-manifests/{code}/conversions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub App from a manifest * @description Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`. */ - readonly post: operations["apps/create-from-manifest"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/create-from-manifest"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/hook/config": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/hook/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook configuration for an app @@ -121,27 +121,27 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-webhook-config-for-app"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["apps/get-webhook-config-for-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an app * @description Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)." * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly patch: operations["apps/update-webhook-config-for-app"]; - readonly trace?: never; + patch: operations["apps/update-webhook-config-for-app"]; + trace?: never; }; - readonly "/app/hook/deliveries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/hook/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deliveries for an app webhook @@ -149,21 +149,21 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/list-webhook-deliveries"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/hook/deliveries/{delivery_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/hook/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a delivery for an app webhook @@ -171,63 +171,63 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-webhook-delivery"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/app/hook/deliveries/{delivery_id}/attempts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["apps/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/app/hook/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an app webhook * @description Redeliver a delivery for the webhook configured for a GitHub App. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly post: operations["apps/redeliver-webhook-delivery"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installation-requests": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installation-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List installation requests for the authenticated app * @description Lists all the pending installation requests for the authenticated GitHub App. */ - readonly get: operations["apps/list-installation-requests-for-authenticated-app"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installation-requests-for-authenticated-app"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List installations for the authenticated app @@ -235,21 +235,21 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/list-installations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations/{installation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations/{installation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an installation for the authenticated app @@ -257,30 +257,30 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-installation"]; - readonly put?: never; - readonly post?: never; + get: operations["apps/get-installation"]; + put?: never; + post?: never; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly delete: operations["apps/delete-installation"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/delete-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations/{installation_id}/access_tokens": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations/{installation_id}/access_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create an installation access token for an app * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. @@ -291,99 +291,99 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly post: operations["apps/create-installation-access-token"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/create-installation-access-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/app/installations/{installation_id}/suspended": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/app/installations/{installation_id}/suspended": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * @description Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly put: operations["apps/suspend-installation"]; - readonly post?: never; + put: operations["apps/suspend-installation"]; + post?: never; /** * Unsuspend an app installation * @description Removes a GitHub App installation suspension. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly delete: operations["apps/unsuspend-installation"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/unsuspend-installation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/applications/{client_id}/grant": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/applications/{client_id}/grant": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete an app authorization * @description OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted. * Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). */ - readonly delete: operations["apps/delete-authorization"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/delete-authorization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/applications/{client_id}/token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/applications/{client_id}/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Check a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. Invalid tokens will return `404 NOT FOUND`. */ - readonly post: operations["apps/check-token"]; + post: operations["apps/check-token"]; /** * Delete an app token * @description OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. */ - readonly delete: operations["apps/delete-token"]; - readonly options?: never; - readonly head?: never; + delete: operations["apps/delete-token"]; + options?: never; + head?: never; /** * Reset a token * @description OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. Invalid tokens will return `404 NOT FOUND`. */ - readonly patch: operations["apps/reset-token"]; - readonly trace?: never; + patch: operations["apps/reset-token"]; + trace?: never; }; - readonly "/applications/{client_id}/token/scoped": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/applications/{client_id}/token/scoped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a scoped access token * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify @@ -392,220 +392,312 @@ export interface paths { * * Invalid tokens will return `404 NOT FOUND`. */ - readonly post: operations["apps/scope-token"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["apps/scope-token"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/apps/{app_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/apps/{app_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an app * @description > [!NOTE] * > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). */ - readonly get: operations["apps/get-by-slug"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-by-slug"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/assignments/{assignment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/assignments/{assignment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an assignment * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - readonly get: operations["classroom/get-an-assignment"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/get-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/assignments/{assignment_id}/accepted_assignments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/assignments/{assignment_id}/accepted_assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * 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-assignments-for-an-assignment"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/list-accepted-assignments-for-an-assignment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/assignments/{assignment_id}/grades": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/assignments/{assignment_id}/grades": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get assignment grades * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment. */ - readonly get: operations["classroom/get-assignment-grades"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/get-assignment-grades"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/classrooms": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/classrooms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List classrooms * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms. */ - readonly get: operations["classroom/list-classrooms"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/list-classrooms"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/classrooms/{classroom_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/classrooms/{classroom_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a classroom * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom. */ - readonly get: operations["classroom/get-a-classroom"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/get-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/classrooms/{classroom_id}/assignments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/classrooms/{classroom_id}/assignments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List assignments for a classroom * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom. */ - readonly get: operations["classroom/list-assignments-for-a-classroom"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["classroom/list-assignments-for-a-classroom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/codes_of_conduct": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/codes_of_conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all codes of conduct * @description Returns array of all GitHub's codes of conduct. */ - readonly get: operations["codes-of-conduct/get-all-codes-of-conduct"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codes-of-conduct/get-all-codes-of-conduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/codes_of_conduct/{key}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/codes_of_conduct/{key}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code of conduct * @description Returns information about the specified GitHub code of conduct. */ - readonly get: operations["codes-of-conduct/get-conduct-code"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codes-of-conduct/get-conduct-code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/emojis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Revoke a list of credentials + * @description Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + * + * This endpoint currently accepts the following credential types: + * - Personal access tokens (classic) + * - Fine-grained personal access tokens + * + * Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + * GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + * + * To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + * + * > [!NOTE] + * > Any authenticated requests will return a 403. + */ + post: operations["credentials/revoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/emojis": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get emojis * @description Lists all the emojis available to use on GitHub. */ - readonly get: operations["emojis/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["emojis/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an enterprise + * @description Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-enterprise"]; + /** + * Set GitHub Actions cache retention limit for an enterprise + * @description Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an enterprise + * @description Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-enterprise"]; + /** + * Set GitHub Actions cache storage limit for an enterprise + * @description Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get code security configurations for an enterprise @@ -615,8 +707,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-configurations-for-enterprise"]; - readonly put?: never; + get: operations["code-security/get-configurations-for-enterprise"]; + put?: never; /** * Create a code security configuration for an enterprise * @description Creates a code security configuration in an enterprise. @@ -625,19 +717,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly post: operations["code-security/create-configuration-for-enterprise"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/create-configuration-for-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default code security configurations for an enterprise @@ -647,21 +739,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-default-configurations-for-enterprise"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-default-configurations-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Retrieve a code security configuration of an enterprise @@ -671,9 +763,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-single-configuration-for-enterprise"]; - readonly put?: never; - readonly post?: never; + get: operations["code-security/get-single-configuration-for-enterprise"]; + put?: never; + post?: never; /** * Delete a code security configuration for an enterprise * @description Deletes a code security configuration from an enterprise. @@ -684,9 +776,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly delete: operations["code-security/delete-configuration-for-enterprise"]; - readonly options?: never; - readonly head?: never; + delete: operations["code-security/delete-configuration-for-enterprise"]; + options?: never; + head?: never; /** * Update a custom code security configuration for an enterprise * @description Updates a code security configuration in an enterprise. @@ -695,18 +787,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly patch: operations["code-security/update-enterprise-configuration"]; - readonly trace?: never; + patch: operations["code-security/update-enterprise-configuration"]; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Attach an enterprise configuration to repositories * @description Attaches an enterprise code security configuration to repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. @@ -717,21 +809,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly post: operations["code-security/attach-enterprise-configuration"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/attach-enterprise-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Set a code security configuration as a default for an enterprise * @description Sets a code security configuration as a default to be applied to new repositories in your enterprise. @@ -742,20 +834,20 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. */ - readonly put: operations["code-security/set-configuration-as-default-for-enterprise"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["code-security/set-configuration-as-default-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repositories associated with an enterprise code security configuration @@ -765,21 +857,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:enterprise` scope to use this endpoint. */ - readonly get: operations["code-security/get-repositories-for-enterprise-configuration"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-repositories-for-enterprise-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/dependabot/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List Dependabot alerts for an enterprise @@ -791,68 +883,272 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. */ - readonly get: operations["dependabot/list-alerts-for-enterprise"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-alerts-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List enterprise teams + * @description List all teams in the enterprise for the authenticated user + */ + get: operations["enterprise-teams/list"]; + put?: never; + /** + * Create an enterprise team + * @description To create an enterprise team, the authenticated user must be an owner of the enterprise. + */ + post: operations["enterprise-teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members in an enterprise team + * @description Lists all team members in an enterprise team. + */ + get: operations["enterprise-team-memberships/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk add team members + * @description Add multiple team members to an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk remove team members + * @description Remove multiple team members from an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get enterprise team membership + * @description Returns whether the user is a member of the enterprise team. + */ + get: operations["enterprise-team-memberships/get"]; + /** + * Add team member + * @description Add a team member to an enterprise team. + */ + put: operations["enterprise-team-memberships/add"]; + post?: never; + /** + * Remove team membership + * @description Remove membership of a specific user from a particular team in an enterprise. + */ + delete: operations["enterprise-team-memberships/remove"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignments + * @description Get all organizations assigned to an enterprise team + */ + get: operations["enterprise-team-organizations/get-assignments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add organization assignments + * @description Assign an enterprise team to multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/enterprises/{enterprise}/secret-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Remove organization assignments + * @description Unassign an enterprise team from multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. + * Get organization assignment + * @description Check if an enterprise team is assigned to an organization + */ + get: operations["enterprise-team-organizations/get-assignment"]; + /** + * Add an organization assignment + * @description Assign an enterprise team to an organization. + */ + put: operations["enterprise-team-organizations/add"]; + post?: never; + /** + * Delete an organization assignment + * @description Unassign an enterprise team from an organization. + */ + delete: operations["enterprise-team-organizations/delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an enterprise team + * @description Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. + */ + get: operations["enterprise-teams/get"]; + put?: never; + post?: never; + /** + * Delete an enterprise team + * @description To delete an enterprise team, the authenticated user must be an enterprise owner. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + */ + delete: operations["enterprise-teams/delete"]; + options?: never; + head?: never; + /** + * Update an enterprise team + * @description To edit a team, the authenticated user must be an enterprise owner. */ - readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + patch: operations["enterprise-teams/update"]; + trace?: never; }; - readonly "/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/feeds": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get feeds @@ -871,28 +1167,28 @@ export interface paths { * > [!NOTE] * > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ - readonly get: operations["activity/get-feeds"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/get-feeds"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List gists for the authenticated user * @description Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists: */ - readonly get: operations["gists/list"]; - readonly put?: never; + get: operations["gists/list"]; + put?: never; /** * Create a gist * @description Allows you to add a new gist with one or more files. @@ -900,19 +1196,19 @@ export interface paths { * > [!NOTE] * > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. */ - readonly post: operations["gists/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["gists/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/public": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public gists @@ -920,41 +1216,41 @@ export interface paths { * * Note: With [pagination](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page. */ - readonly get: operations["gists/list-public"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List starred gists * @description List the authenticated user's starred gists: */ - readonly get: operations["gists/list-starred"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/list-starred"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/{gist_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gist @@ -965,13 +1261,13 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/get"]; - readonly put?: never; - readonly post?: never; + get: operations["gists/get"]; + put?: never; + post?: never; /** Delete a gist */ - readonly delete: operations["gists/delete"]; - readonly options?: never; - readonly head?: never; + delete: operations["gists/delete"]; + options?: never; + head?: never; /** * Update a gist * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files @@ -985,15 +1281,15 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly patch: operations["gists/update"]; - readonly trace?: never; + patch: operations["gists/update"]; + trace?: never; }; - readonly "/gists/{gist_id}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List gist comments @@ -1004,8 +1300,8 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/list-comments"]; - readonly put?: never; + get: operations["gists/list-comments"]; + put?: never; /** * Create a gist comment * @description Creates a comment on a gist. @@ -1015,19 +1311,19 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly post: operations["gists/create-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["gists/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/{gist_id}/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gist comment @@ -1038,13 +1334,13 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/get-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["gists/get-comment"]; + put?: never; + post?: never; /** Delete a gist comment */ - readonly delete: operations["gists/delete-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["gists/delete-comment"]; + options?: never; + head?: never; /** * Update a gist comment * @description Updates a comment on a gist. @@ -1054,72 +1350,72 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly patch: operations["gists/update-comment"]; - readonly trace?: never; + patch: operations["gists/update-comment"]; + trace?: never; }; - readonly "/gists/{gist_id}/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List gist commits */ - readonly get: operations["gists/list-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/gists/{gist_id}/forks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["gists/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/gists/{gist_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List gist forks */ - readonly get: operations["gists/list-forks"]; - readonly put?: never; + get: operations["gists/list-forks"]; + put?: never; /** Fork a gist */ - readonly post: operations["gists/fork"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/gists/{gist_id}/star": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["gists/fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/gists/{gist_id}/star": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Check if a gist is starred */ - readonly get: operations["gists/check-is-starred"]; + get: operations["gists/check-is-starred"]; /** * Star a gist * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["gists/star"]; - readonly post?: never; + put: operations["gists/star"]; + post?: never; /** Unstar a gist */ - readonly delete: operations["gists/unstar"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["gists/unstar"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gists/{gist_id}/{sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gists/{gist_id}/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gist revision @@ -1130,41 +1426,41 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type. * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ - readonly get: operations["gists/get-revision"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/get-revision"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gitignore/templates": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gitignore/templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all gitignore templates * @description List all templates available to pass as an option when [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). */ - readonly get: operations["gitignore/get-all-templates"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gitignore/get-all-templates"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/gitignore/templates/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/gitignore/templates/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a gitignore template @@ -1174,63 +1470,63 @@ export interface paths { * * - **`application/vnd.github.raw+json`**: Returns the raw .gitignore contents. */ - readonly get: operations["gitignore/get-template"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gitignore/get-template"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/installation/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/installation/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. */ - readonly get: operations["apps/list-repos-accessible-to-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/installation/token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["apps/list-repos-accessible-to-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/installation/token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Revoke an installation access token * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. */ - readonly delete: operations["apps/revoke-installation-access-token"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/revoke-installation-access-token"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issues assigned to the authenticated user @@ -1248,98 +1544,101 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/licenses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/licenses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all commonly used licenses * @description Lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ - readonly get: operations["licenses/get-all-commonly-used"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["licenses/get-all-commonly-used"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/licenses/{license}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/licenses/{license}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a license * @description Gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." */ - readonly get: operations["licenses/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/markdown": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** Render a Markdown document */ - readonly post: operations["markdown/render"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/markdown/raw": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["licenses/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/markdown": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Render a Markdown document + * @description Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + */ + post: operations["markdown/render"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/markdown/raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Render a Markdown document in raw mode * @description You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less. */ - readonly post: operations["markdown/render-raw"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["markdown/render-raw"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/accounts/{account_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a subscription plan for an account @@ -1347,21 +1646,21 @@ export interface paths { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/get-subscription-plan-for-account"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-subscription-plan-for-account"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/plans": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List plans @@ -1369,21 +1668,21 @@ export interface paths { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-plans"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-plans"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/plans/{plan_id}/accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List accounts for a plan @@ -1391,21 +1690,21 @@ export interface paths { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-accounts-for-plan"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-accounts-for-plan"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/stubbed/accounts/{account_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/stubbed/accounts/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a subscription plan for an account (stubbed) @@ -1413,21 +1712,21 @@ export interface paths { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/get-subscription-plan-for-account-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-subscription-plan-for-account-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/stubbed/plans": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/stubbed/plans": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List plans (stubbed) @@ -1435,21 +1734,21 @@ export interface paths { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-plans-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-plans-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/marketplace_listing/stubbed/plans/{plan_id}/accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List accounts for a plan (stubbed) @@ -1457,21 +1756,21 @@ export interface paths { * * GitHub Apps must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint. */ - readonly get: operations["apps/list-accounts-for-plan-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-accounts-for-plan-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/meta": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/meta": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub meta information @@ -1484,94 +1783,94 @@ export interface paths { * > [!NOTE] * > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. */ - readonly get: operations["meta/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/networks/{owner}/{repo}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/networks/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events for a network of repositories * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-events-for-repo-network"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-events-for-repo-network"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/notifications": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List notifications for the authenticated user * @description List all notifications for the current user, sorted by most recently updated. */ - readonly get: operations["activity/list-notifications-for-authenticated-user"]; + get: operations["activity/list-notifications-for-authenticated-user"]; /** * Mark notifications as read * @description Marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly put: operations["activity/mark-notifications-as-read"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["activity/mark-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/notifications/threads/{thread_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/notifications/threads/{thread_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a thread * @description Gets information about a notification thread. */ - readonly get: operations["activity/get-thread"]; - readonly put?: never; - readonly post?: never; + get: operations["activity/get-thread"]; + put?: never; + post?: never; /** * Mark a thread as done * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. */ - readonly delete: operations["activity/mark-thread-as-done"]; - readonly options?: never; - readonly head?: never; + delete: operations["activity/mark-thread-as-done"]; + options?: never; + head?: never; /** * Mark a thread as read * @description Marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub: https://github.com/notifications. */ - readonly patch: operations["activity/mark-thread-as-read"]; - readonly trace?: never; + patch: operations["activity/mark-thread-as-read"]; + trace?: never; }; - readonly "/notifications/threads/{thread_id}/subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/notifications/threads/{thread_id}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a thread subscription for the authenticated user @@ -1579,7 +1878,7 @@ export interface paths { * * Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. */ - readonly get: operations["activity/get-thread-subscription-for-authenticated-user"]; + get: operations["activity/get-thread-subscription-for-authenticated-user"]; /** * Set a thread subscription * @description If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**. @@ -1588,44 +1887,44 @@ export interface paths { * * Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription) endpoint. */ - readonly put: operations["activity/set-thread-subscription"]; - readonly post?: never; + put: operations["activity/set-thread-subscription"]; + post?: never; /** * Delete a thread subscription * @description Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. */ - readonly delete: operations["activity/delete-thread-subscription"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["activity/delete-thread-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/octocat": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/octocat": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Octocat * @description Get the octocat as ASCII art */ - readonly get: operations["meta/get-octocat"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get-octocat"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/organizations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organizations @@ -1634,21 +1933,228 @@ export interface paths { * > [!NOTE] * > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ - readonly get: operations["orgs/list"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an organization + * @description Gets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-organization"]; + /** + * Set GitHub Actions cache retention limit for an organization + * @description Sets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an organization + * @description Gets GitHub Actions cache storage limit for an organization. All repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-organization"]; + /** + * Set GitHub Actions cache storage limit for an organization + * @description Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists the repositories Dependabot can access in an organization + * @description Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + */ + get: operations["dependabot/repository-access-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Updates Dependabot's repository access list for an organization + * @description Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + * + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + * + * **Example request body:** + * ```json + * { + * "repository_ids_to_add": [123, 456], + * "repository_ids_to_remove": [789] + * } + * ``` + */ + patch: operations["dependabot/update-repository-access-for-org"]; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access/default-level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set the default repository access level for Dependabot + * @description Sets the default level of repository access Dependabot will have while performing an update. Available values are: + * - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + * - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + * + * Unauthorized users will not see the existence of this endpoint. + * + * This operation supports both server-to-server and user-to-server access. + */ + put: operations["dependabot/set-repository-access-default-level"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all budgets for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-all-budgets-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a budget by ID for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-budget-org"]; + put?: never; + post?: never; + /** + * Delete a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + */ + delete: operations["billing/delete-budget-org"]; + options?: never; + head?: never; + /** + * Update a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + */ + patch: operations["billing/update-budget-org"]; + trace?: never; }; - readonly "/organizations/{org}/settings/billing/usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/organizations/{org}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for an organization + * @description Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get billing usage report for an organization @@ -1656,27 +2162,52 @@ export interface paths { * * **Note:** This endpoint is only available to organizations with access to the enhanced billing platform. For more information, see "[About the enhanced billing platform](https://docs.github.com/billing/using-the-new-billing-platform)." */ - readonly get: operations["billing/get-github-billing-usage-report-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["billing/get-github-billing-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-usage-summary-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * @@ -1684,9 +2215,9 @@ export interface paths { * * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ - readonly get: operations["orgs/get"]; - readonly put?: never; - readonly post?: never; + get: operations["orgs/get"]; + put?: never; + post?: never; /** * Delete an organization * @description Deletes an organization and all its repositories. @@ -1697,9 +2228,9 @@ export interface paths { * * https://docs.github.com/site-policy/github-terms/github-terms-of-service */ - readonly delete: operations["orgs/delete"]; - readonly options?: never; - readonly head?: never; + delete: operations["orgs/delete"]; + options?: never; + head?: never; /** * Update an organization * @description > [!WARNING] @@ -1714,15 +2245,15 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ - readonly patch: operations["orgs/update"]; - readonly trace?: never; + patch: operations["orgs/update"]; + trace?: never; }; - readonly "/orgs/{org}/actions/cache/usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions cache usage for an organization @@ -1731,21 +2262,21 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-usage-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-actions-cache-usage-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/cache/usage-by-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/cache/usage-by-repository": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories with GitHub Actions cache usage for an organization @@ -1754,21 +2285,21 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub-hosted runners for an organization @@ -1776,126 +2307,226 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `manage_runner:org` scope to use this endpoint. */ - readonly get: operations["actions/list-hosted-runners-for-org"]; - readonly put?: never; + get: operations["actions/list-hosted-runners-for-org"]; + put?: never; /** * Create a GitHub-hosted runner for an organization * @description Creates a GitHub-hosted runner for an organization. * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. */ - readonly post: operations["actions/create-hosted-runner-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-hosted-runner-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List custom images for an organization + * @description List custom images for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a custom image definition for GitHub Actions Hosted Runners + * @description Get a custom image definition for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-for-org"]; + put?: never; + post?: never; + /** + * Delete a custom image from the organization + * @description Delete a custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/images/github-owned": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List image versions of a custom image for an organization + * @description List image versions of a custom image for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-image-versions-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an image version of a custom image for GitHub Actions Hosted Runners + * @description Get an image version of a custom image for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-version-for-org"]; + put?: never; + post?: never; + /** + * Delete an image version of custom image from the organization + * @description Delete an image version of custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-version-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/github-owned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub-owned images for GitHub-hosted runners in an organization * @description Get the list of GitHub-owned images available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-github-owned-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/images/partner": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/images/partner": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get partner images for GitHub-hosted runners in an organization * @description Get the list of partner images available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-partner-images-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-partner-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get limits on GitHub-hosted runners for an organization * @description Get the GitHub-hosted runners limits for an organization. */ - readonly get: operations["actions/get-hosted-runners-limits-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-limits-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/machine-sizes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/machine-sizes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub-hosted runners machine specs for an organization * @description Get the list of machine specs available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-machine-specs-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-machine-specs-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/platforms": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/platforms": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get platforms for GitHub-hosted runners in an organization * @description Get the list of platforms available for GitHub-hosted runners for an organization. */ - readonly get: operations["actions/get-hosted-runners-platforms-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-hosted-runners-platforms-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/hosted-runners/{hosted_runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a GitHub-hosted runner for an organization @@ -1903,30 +2534,30 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. */ - readonly get: operations["actions/get-hosted-runner-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a GitHub-hosted runner for an organization * @description Deletes a GitHub-hosted runner for an organization. */ - readonly delete: operations["actions/delete-hosted-runner-for-org"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-hosted-runner-for-org"]; + options?: never; + head?: never; /** * Update a GitHub-hosted runner for an organization * @description Updates a GitHub-hosted runner for an organization. * OAuth app tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. */ - readonly patch: operations["actions/update-hosted-runner-for-org"]; - readonly trace?: never; + patch: operations["actions/update-hosted-runner-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/actions/oidc/customization/sub": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the customization template for an OIDC subject claim for an organization @@ -1934,27 +2565,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["oidc/get-oidc-custom-sub-template-for-org"]; + get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly put: operations["oidc/update-oidc-custom-sub-template-for-org"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["oidc/update-oidc-custom-sub-template-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions permissions for an organization @@ -1962,27 +2593,107 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-permissions-organization"]; + get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-permissions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for an organization + * @description Gets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-organization"]; + /** + * Set artifact and log retention settings for an organization + * @description Sets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for an organization + * @description Gets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-organization"]; + /** + * Set fork PR contributor approval permissions for an organization + * @description Sets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for an organization + * @description Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-organization"]; + /** + * Set private repo fork PR workflow settings for an organization + * @description Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories enabled for GitHub Actions in an organization @@ -1990,7 +2701,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; + get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." @@ -1998,48 +2709,48 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Enable a selected repository for GitHub Actions in an organization * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/enable-selected-repository-github-actions-organization"]; - readonly post?: never; + put: operations["actions/enable-selected-repository-github-actions-organization"]; + post?: never; /** * Disable a selected repository for GitHub Actions in an organization * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["actions/disable-selected-repository-github-actions-organization"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/disable-selected-repository-github-actions-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/selected-actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get allowed actions and reusable workflows for an organization @@ -2047,27 +2758,111 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-allowed-actions-organization"]; + get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-allowed-actions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-allowed-actions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get self-hosted runners settings for an organization + * @description Gets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-self-hosted-runners-permissions-organization"]; + /** + * Set self-hosted runners settings for an organization + * @description Sets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repositories allowed to use self-hosted runners in an organization + * @description Lists repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/list-selected-repositories-self-hosted-runners-organization"]; + /** + * Set repositories allowed to use self-hosted runners in an organization + * @description Sets repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-selected-repositories-self-hosted-runners-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a repository to the list of repositories allowed to use self-hosted runners in an organization + * @description Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/enable-selected-repository-self-hosted-runners-organization"]; + post?: never; + /** + * Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + * @description Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + delete: operations["actions/disable-selected-repository-self-hosted-runners-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/permissions/workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default workflow permissions for an organization @@ -2077,7 +2872,7 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; + get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** * Set default workflow permissions for an organization * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an organization, and sets if GitHub Actions @@ -2086,20 +2881,20 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runner-groups": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runner-groups": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List self-hosted runner groups for an organization @@ -2107,27 +2902,27 @@ export interface paths { * * 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; + 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. */ - 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; + post: operations["actions/create-self-hosted-runner-group-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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 @@ -2135,33 +2930,33 @@ export interface paths { * * 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; + 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. */ - readonly delete: operations["actions/delete-self-hosted-runner-group-from-org"]; - readonly options?: never; - readonly head?: never; + 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. */ - readonly patch: operations["actions/update-self-hosted-runner-group-for-org"]; - readonly trace?: never; + patch: operations["actions/update-self-hosted-runner-group-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub-hosted runners in a group for an organization @@ -2169,21 +2964,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["actions/list-github-hosted-runners-in-group-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-github-hosted-runners-in-group-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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 @@ -2191,55 +2986,55 @@ export interface paths { * * 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"]; + 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; + 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; }; - 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; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: 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. */ - readonly put: operations["actions/add-repo-access-to-self-hosted-runner-group-in-org"]; - readonly post?: never; + 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. */ - 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; + delete: operations["actions/remove-repo-access-to-self-hosted-runner-group-in-org"]; + options?: never; + head?: never; + patch?: never; + 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; + "/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 @@ -2247,55 +3042,55 @@ export interface paths { * * 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"]; + 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; + put: operations["actions/set-self-hosted-runners-in-group-for-org"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: 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. */ - readonly put: operations["actions/add-self-hosted-runner-to-group-for-org"]; - readonly post?: never; + 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. */ - readonly delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-self-hosted-runner-from-group-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List self-hosted runners for an organization @@ -2305,21 +3100,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-self-hosted-runners-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-self-hosted-runners-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/downloads": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List runner applications for an organization @@ -2329,24 +3124,24 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-runner-applications-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/actions/runners/generate-jitconfig": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/list-runner-applications-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. @@ -2355,22 +3150,22 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/generate-runner-jitconfig-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/generate-runner-jitconfig-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/registration-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -2385,22 +3180,22 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-registration-token-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-registration-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/remove-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. @@ -2415,19 +3210,19 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-remove-token-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-remove-token-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/{runner_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a self-hosted runner for an organization @@ -2437,9 +3232,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/get-self-hosted-runner-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-self-hosted-runner-for-org"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. @@ -2448,18 +3243,18 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-from-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-self-hosted-runner-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/{runner_id}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for a self-hosted runner for an organization @@ -2469,7 +3264,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; + get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** * Set custom labels for a self-hosted runner for an organization * @description Remove all previous custom labels and set the new custom labels for a specific @@ -2479,7 +3274,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; + put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization * @description Adds custom labels to a self-hosted runner configured in an organization. @@ -2488,7 +3283,7 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; + post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** * Remove all custom labels from a self-hosted runner for an organization * @description Remove all custom labels from a self-hosted runner configured in an @@ -2498,22 +3293,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for an organization * @description Remove a custom label from a self-hosted runner configured @@ -2526,18 +3321,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization secrets @@ -2548,21 +3343,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-org-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization public key @@ -2573,21 +3368,21 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization secret @@ -2597,7 +3392,7 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-org-secret"]; + get: operations["actions/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using @@ -2607,8 +3402,8 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/create-or-update-org-secret"]; - readonly post?: never; + put: operations["actions/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. @@ -2617,18 +3412,18 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization secret @@ -2639,7 +3434,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-selected-repos-for-org-secret"]; + get: operations["actions/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` @@ -2650,22 +3445,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly put: operations["actions/set-selected-repos-for-org-secret"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for @@ -2676,8 +3471,8 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/add-selected-repo-to-org-secret"]; - readonly post?: never; + put: operations["actions/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` @@ -2688,18 +3483,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-selected-repo-from-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization variables @@ -2709,8 +3504,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-org-variables"]; - readonly put?: never; + get: operations["actions/list-org-variables"]; + put?: never; /** * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. @@ -2719,19 +3514,19 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-org-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-org-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization variable @@ -2741,9 +3536,9 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-org-variable"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-org-variable"]; + put?: never; + post?: never; /** * Delete an organization variable * @description Deletes an organization variable using the variable name. @@ -2752,9 +3547,9 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-org-variable"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-org-variable"]; + options?: never; + head?: never; /** * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. @@ -2763,15 +3558,15 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly patch: operations["actions/update-org-variable"]; - readonly trace?: never; + patch: operations["actions/update-org-variable"]; + trace?: never; }; - readonly "/orgs/{org}/actions/variables/{name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables/{name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization variable @@ -2782,7 +3577,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly get: operations["actions/list-selected-repos-for-org-variable"]; + get: operations["actions/list-selected-repos-for-org-variable"]; /** * Set selected repositories for an organization variable * @description Replaces all repositories for an organization variable that is available @@ -2793,22 +3588,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly put: operations["actions/set-selected-repos-for-org-variable"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-selected-repos-for-org-variable"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/actions/variables/{name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization variable * @description Adds a repository to an organization variable that is available to selected repositories. @@ -2818,8 +3613,8 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/add-selected-repo-to-org-variable"]; - readonly post?: never; + put: operations["actions/add-selected-repo-to-org-variable"]; + post?: never; /** * Remove selected repository from an organization variable * @description Removes a repository from an organization variable that is @@ -2830,18 +3625,242 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ - readonly delete: operations["actions/remove-selected-repo-from-org-variable"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/attestations/{subject_digest}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + delete: operations["actions/remove-selected-repo-from-org-variable"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an artifact deployment record + * @description Create or update deployment records for an artifact associated + * with an organization. + * This endpoint allows you to record information about a specific + * artifact, such as its name, digest, environments, cluster, and + * deployment. + * The deployment name has to be uniqe within a cluster (i.e a + * combination of logical, physical environment and cluster) as it + * identifies unique deployment. + * Multiple requests for the same combination of logical, physical + * environment, cluster and deployment name will only create one + * record, successive request will update the existing record. + * This allows for a stable tracking of a deployment where the actual + * deployed artifact can change over time. + */ + post: operations["orgs/create-artifact-deployment-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Set cluster deployment records + * @description Set deployment records for a given cluster. + * If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + * 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + * If no existing records match, new records will be created. + */ + post: operations["orgs/set-cluster-deployment-records"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/storage-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create artifact metadata storage record + * @description Create metadata storage records for artifacts associated with an organization. + * This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + * associated with a repository owned by the organization. + */ + post: operations["orgs/create-artifact-storage-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact deployment records + * @description List deployment records for an artifact metadata associated with an organization. + */ + get: operations["orgs/list-artifact-deployment-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact storage records + * @description List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + */ + get: operations["orgs/list-artifact-storage-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["orgs/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["orgs/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["orgs/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestation repositories + * @description List repositories owned by the provided organization that have created at least one attested artifact + * Results will be sorted in ascending order by repository ID + */ + get: operations["orgs/list-attestation-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + */ + delete: operations["orgs/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List attestations @@ -2851,69 +3870,144 @@ export interface paths { * * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly get: operations["orgs/list-attestations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/blocks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users blocked by an organization * @description List the users blocked by an organization. */ - readonly get: operations["orgs/list-blocked-users"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-blocked-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/blocks/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user is blocked by an organization * @description Returns a 204 if the given user is blocked by the given organization. Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. */ - readonly get: operations["orgs/check-blocked-user"]; + get: operations["orgs/check-blocked-user"]; /** * Block a user from an organization * @description Blocks the given user on behalf of the specified organization and returns a 204. If the organization cannot block the given user a 422 is returned. */ - readonly put: operations["orgs/block-user"]; - readonly post?: never; + put: operations["orgs/block-user"]; + post?: never; /** * Unblock a user from an organization * @description Unblocks the given user on behalf of the specified organization. */ - readonly delete: operations["orgs/unblock-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/unblock-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List campaigns for an organization + * @description Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/list-org-campaigns"]; + put?: never; + /** + * Create a campaign for an organization + * @description Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + post: operations["campaigns/create-campaign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns/{campaign_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a campaign for an organization + * @description Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/get-campaign-summary"]; + put?: never; + post?: never; + /** + * Delete a campaign for an organization + * @description Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + delete: operations["campaigns/delete-campaign"]; + options?: never; + head?: never; + /** + * Update a campaign + * @description Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + patch: operations["campaigns/update-campaign"]; + trace?: never; }; - readonly "/orgs/{org}/code-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List code scanning alerts for an organization @@ -2923,21 +4017,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly get: operations["code-scanning/list-alerts-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get code security configurations for an organization @@ -2945,10 +4039,10 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-configurations-for-org"]; - readonly put?: never; + get: operations["code-security/get-configurations-for-org"]; + put?: never; /** * Create a code security configuration * @description Creates a code security configuration in an organization. @@ -2957,19 +4051,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly post: operations["code-security/create-configuration"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/create-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default code security configurations @@ -2977,27 +4071,27 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-default-configurations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/code-security/configurations/detach": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["code-security/get-default-configurations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/code-security/configurations/detach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Detach configurations from repositories * @description Detach code security configuration(s) from a set of repositories. @@ -3007,18 +4101,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly delete: operations["code-security/detach-configuration"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["code-security/detach-configuration"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code security configuration @@ -3028,9 +4122,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-configuration"]; - readonly put?: never; - readonly post?: never; + get: operations["code-security/get-configuration"]; + put?: never; + post?: never; /** * Delete a code security configuration * @description Deletes the desired code security configuration from an organization. @@ -3041,9 +4135,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly delete: operations["code-security/delete-configuration"]; - readonly options?: never; - readonly head?: never; + delete: operations["code-security/delete-configuration"]; + options?: never; + head?: never; /** * Update a code security configuration * @description Updates a code security configuration in an organization. @@ -3052,18 +4146,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly patch: operations["code-security/update-configuration"]; - readonly trace?: never; + patch: operations["code-security/update-configuration"]; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}/attach": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Attach a configuration to repositories * @description Attach a code security configuration to a set of repositories. If the repositories specified are already attached to a configuration, they will be re-attached to the provided configuration. @@ -3074,21 +4168,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly post: operations["code-security/attach-configuration"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-security/attach-configuration"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}/defaults": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Set a code security configuration as a default for an organization * @description Sets a code security configuration as a default to be applied to new repositories in your organization. @@ -3099,20 +4193,20 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ - readonly put: operations["code-security/set-configuration-as-default"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["code-security/set-configuration-as-default"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/code-security/configurations/{configuration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repositories associated with a code security configuration @@ -3120,23 +4214,23 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ - readonly get: operations["code-security/get-repositories-for-configuration"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-repositories-for-configuration"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces for the organization @@ -3144,46 +4238,46 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/list-in-organization"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-in-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/set-codespaces-access"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["codespaces/set-codespaces-access"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/access/selected_users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/access/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Add users to Codespaces access for an organization * @deprecated @@ -3194,7 +4288,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["codespaces/set-codespaces-access-users"]; + post: operations["codespaces/set-codespaces-access-users"]; /** * Remove users from Codespaces access for an organization * @deprecated @@ -3205,18 +4299,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-codespaces-access-users"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-codespaces-access-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization secrets @@ -3225,42 +4319,42 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/list-org-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization public key * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization secret @@ -3268,7 +4362,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/get-org-secret"]; + get: operations["codespaces/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using @@ -3276,26 +4370,26 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/create-or-update-org-secret"]; - readonly post?: never; + put: operations["codespaces/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes an organization development environment secret using the secret name. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization secret @@ -3304,7 +4398,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/list-selected-repos-for-org-secret"]; + get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization development environment secret when the `visibility` @@ -3313,29 +4407,29 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/set-selected-repos-for-org-secret"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["codespaces/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["codespaces/add-selected-repo-to-org-secret"]; - readonly post?: never; + put: operations["codespaces/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization development environment secret when the `visibility` @@ -3344,18 +4438,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/billing": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/billing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Copilot seat information and settings for an organization @@ -3370,21 +4464,21 @@ export interface paths { * * 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/get-copilot-organization-details"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/get-copilot-organization-details"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/billing/seats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/billing/seats": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List all Copilot seat assignments for an organization @@ -3395,28 +4489,28 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * 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"]; - 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/billing/selected_teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["copilot/list-copilot-seats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/copilot/billing/selected_teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Add teams to the Copilot subscription for an organization * @description > [!NOTE] @@ -3433,7 +4527,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ - readonly post: operations["copilot/add-copilot-seats-for-teams"]; + post: operations["copilot/add-copilot-seats-for-teams"]; /** * Remove teams from the Copilot subscription for an organization * @description > [!NOTE] @@ -3449,21 +4543,21 @@ export interface paths { * * 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"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/billing/selected_users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/billing/selected_users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Add users to the Copilot subscription for an organization * @description > [!NOTE] @@ -3480,7 +4574,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. */ - readonly post: operations["copilot/add-copilot-seats-for-users"]; + post: operations["copilot/add-copilot-seats-for-users"]; /** * Remove users from the Copilot subscription for an organization * @description > [!NOTE] @@ -3496,83 +4590,100 @@ export interface paths { * * 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"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/copilot/metrics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/copilot/content_exclusion": { + 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. + * Get Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * > [!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. + * Gets information about an organization's Copilot content exclusion path rules. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." * - * 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. + * Organization owners can view details about Copilot content exclusion rules for the organization. * - * 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 `copilot` or `read:org` scopes to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + * > [!CAUTION] + * > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + * > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. */ - 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; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; + get: operations["copilot/copilot-content-exclusion-for-organization"]; /** - * Get a summary of Copilot usage for organization members + * Set Copilot content exclusion rules for an organization * @description > [!NOTE] * > 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. - * See the response schema tab for detailed metrics definitions. + * Sets Copilot content exclusion path rules for an organization. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + * + * Organization owners can set Copilot content exclusion rules for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + * + * > [!CAUTION] + * > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + * > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + */ + put: operations["copilot/set-copilot-content-exclusion-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + 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. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 100 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. * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + * 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/usage-metrics-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/copilot-metrics-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List Dependabot alerts for an organization @@ -3582,21 +4693,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["dependabot/list-alerts-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization secrets @@ -3605,21 +4716,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/list-org-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-org-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization public key @@ -3628,21 +4739,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization secret @@ -3650,7 +4761,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/get-org-secret"]; + get: operations["dependabot/get-org-secret"]; /** * Create or update an organization secret * @description Creates or updates an organization secret with an encrypted value. Encrypt your secret using @@ -3658,26 +4769,26 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["dependabot/create-or-update-org-secret"]; - readonly post?: never; + put: operations["dependabot/create-or-update-org-secret"]; + post?: never; /** * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["dependabot/delete-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["dependabot/delete-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for an organization secret @@ -3686,7 +4797,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["dependabot/list-selected-repos-for-org-secret"]; + get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret * @description Replaces all repositories for an organization secret when the `visibility` @@ -3695,22 +4806,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["dependabot/set-selected-repos-for-org-secret"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["dependabot/set-selected-repos-for-org-secret"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for @@ -3719,8 +4830,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["dependabot/add-selected-repo-to-org-secret"]; - readonly post?: never; + put: operations["dependabot/add-selected-repo-to-org-secret"]; + post?: never; /** * Remove selected repository from an organization secret * @description Removes a repository from an organization secret when the `visibility` @@ -3729,18 +4840,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["dependabot/remove-selected-repo-from-org-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/docker/conflicts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get list of conflicting packages during Docker migration for organization @@ -3748,62 +4859,62 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ - readonly get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public organization events * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-org-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-org-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/failed_invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/failed_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List failed organization invitations * @description The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ - readonly get: operations["orgs/list-failed-invitations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-failed-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization webhooks @@ -3814,8 +4925,8 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/list-webhooks"]; - readonly put?: never; + get: operations["orgs/list-webhooks"]; + put?: never; /** * Create an organization webhook * @description Create a hook that posts payloads in JSON format. @@ -3825,19 +4936,19 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or * edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly post: operations["orgs/create-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization webhook @@ -3849,9 +4960,9 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/get-webhook"]; - readonly put?: never; - readonly post?: never; + get: operations["orgs/get-webhook"]; + put?: never; + post?: never; /** * Delete an organization webhook * @description Delete a webhook for an organization. @@ -3861,9 +4972,9 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly delete: operations["orgs/delete-webhook"]; - readonly options?: never; - readonly head?: never; + delete: operations["orgs/delete-webhook"]; + options?: never; + head?: never; /** * Update an organization webhook * @description Updates a webhook configured in an organization. When you update a webhook, @@ -3877,15 +4988,15 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly patch: operations["orgs/update-webhook"]; - readonly trace?: never; + patch: operations["orgs/update-webhook"]; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/config": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook configuration for an organization @@ -3896,12 +5007,12 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/get-webhook-config-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/get-webhook-config-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." @@ -3911,15 +5022,15 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly patch: operations["orgs/update-webhook-config-for-org"]; - readonly trace?: never; + patch: operations["orgs/update-webhook-config-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deliveries for an organization webhook @@ -3930,21 +5041,21 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/list-webhook-deliveries"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook delivery for an organization webhook @@ -3955,24 +5066,24 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly get: operations["orgs/get-webhook-delivery"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["orgs/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. @@ -3982,22 +5093,22 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly post: operations["orgs/redeliver-webhook-delivery"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/hooks/{hook_id}/pings": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Ping an organization webhook * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) @@ -4008,199 +5119,199 @@ export interface paths { * OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit * webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. */ - readonly post: operations["orgs/ping-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-route-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/insights/api/subject-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: 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. */ - 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; + get: operations["api-insights/get-subject-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/insights/api/summary-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: 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. */ - 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; + get: operations["api-insights/get-summary-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-summary-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-summary-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/insights/api/time-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: 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. */ - 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; + get: operations["api-insights/get-time-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-time-stats-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-time-stats-by-actor"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + 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; + "/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. */ - 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; + get: operations["api-insights/get-user-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization installation for the authenticated app @@ -4208,21 +5319,21 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-org-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-org-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/installations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List app installations for an organization @@ -4233,49 +5344,49 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ - readonly get: operations["orgs/list-app-installations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-app-installations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/interaction-limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get interaction restrictions for an organization * @description Shows which type of GitHub user can interact with this organization and when the restriction expires. If there is no restrictions, you will see an empty response. */ - readonly get: operations["interactions/get-restrictions-for-org"]; + get: operations["interactions/get-restrictions-for-org"]; /** * Set interaction restrictions for an organization * @description Temporarily restricts interactions to a certain type of GitHub user in any public repository in the given organization. You must be an organization owner to set these restrictions. Setting the interaction limit at the organization level will overwrite any interaction limits that are set for individual repositories owned by the organization. */ - readonly put: operations["interactions/set-restrictions-for-org"]; - readonly post?: never; + put: operations["interactions/set-restrictions-for-org"]; + post?: never; /** * Remove interaction restrictions for an organization * @description Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions. */ - readonly delete: operations["interactions/remove-restrictions-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["interactions/remove-restrictions-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pending organization invitations @@ -4284,8 +5395,8 @@ export interface paths { * `billing_manager`, or `hiring_manager`. If the invitee is not a GitHub * member, the `login` field in the return hash will be `null`. */ - readonly get: operations["orgs/list-pending-invitations"]; - readonly put?: never; + get: operations["orgs/list-pending-invitations"]; + put?: never; /** * Create an organization invitation * @description Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. @@ -4293,61 +5404,124 @@ export interface paths { * 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)." */ - readonly post: operations["orgs/create-invitation"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/create-invitation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/invitations/{invitation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Cancel an organization invitation * @description Cancel an organization invitation. In order to cancel an organization invitation, the authenticated user must be an organization owner. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). */ - readonly delete: operations["orgs/cancel-invitation"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/cancel-invitation"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/invitations/{invitation_id}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/invitations/{invitation_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization invitation teams * @description List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner. */ - readonly get: operations["orgs/list-invitation-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-invitation-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/issue-types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + */ + get: operations["orgs/list-issue-types"]; + put?: never; + /** + * Create issue type for an organization + * @description Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-issue-type"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update issue type for an organization + * @description Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/update-issue-type"]; + post?: never; + /** + * Delete issue type for an organization + * @description Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-issue-type"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization issues assigned to the authenticated user @@ -4363,65 +5537,68 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization members * @description List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned. */ - readonly get: operations["orgs/list-members"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check organization membership for a user * @description Check if a user is, publicly or privately, a member of the organization. */ - readonly get: operations["orgs/check-membership-for-user"]; - readonly put?: never; - readonly post?: never; + get: operations["orgs/check-membership-for-user"]; + put?: never; + post?: never; /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ - readonly delete: operations["orgs/remove-member"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-member"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces for a user in organization @@ -4429,65 +5606,65 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["codespaces/get-codespaces-for-user-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["codespaces/get-codespaces-for-user-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/members/{username}/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Delete a codespace from the organization * @description Deletes a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-from-organization"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-from-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Stop a codespace for an organization user * @description Stops a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["codespaces/stop-in-organization"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/stop-in-organization"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/members/{username}/copilot": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/members/{username}/copilot": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Copilot seat assignment details for a user @@ -4497,33 +5674,33 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * Only organization owners can view Copilot seat assignment details for members of their organization. * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ - readonly get: operations["copilot/get-copilot-seat-details-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/get-copilot-seat-details-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/memberships/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get organization membership for a user * @description In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status. */ - readonly get: operations["orgs/get-membership-for-user"]; + get: operations["orgs/get-membership-for-user"]; /** * Set organization membership for a user * @description Only authenticated organization owners can add a member to the organization or update the member's role. @@ -4536,26 +5713,29 @@ export interface paths { * * To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period. */ - readonly put: operations["orgs/set-membership-for-user"]; - readonly post?: never; + put: operations["orgs/set-membership-for-user"]; + post?: never; /** * Remove organization membership for a user * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ - readonly delete: operations["orgs/remove-membership-for-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-membership-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization migrations @@ -4563,25 +5743,25 @@ export interface paths { * * A list of `repositories` is only returned for export migrations. */ - readonly get: operations["migrations/list-for-org"]; - readonly put?: never; + get: operations["migrations/list-for-org"]; + put?: never; /** * Start an organization migration * @description Initiates the generation of a migration archive. */ - readonly post: operations["migrations/start-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["migrations/start-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization migration status @@ -4594,85 +5774,85 @@ export interface paths { * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - readonly get: operations["migrations/get-status-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/get-status-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}/archive": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download an organization migration archive * @description Fetches the URL to a migration archive. */ - readonly get: operations["migrations/download-archive-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["migrations/download-archive-for-org"]; + put?: never; + post?: never; /** * Delete an organization migration archive * @description Deletes a previous migration archive. Migration archives are automatically deleted after seven days. */ - readonly delete: operations["migrations/delete-archive-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/delete-archive-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Unlock an organization repository * @description Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://docs.github.com/rest/repos/repos#delete-a-repository) when the migration is complete and you no longer need the source data. */ - readonly delete: operations["migrations/unlock-repo-for-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/unlock-repo-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/migrations/{migration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories in an organization migration * @description List all the repositories for this organization migration. */ - readonly get: operations["migrations/list-repos-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/list-repos-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all organization roles for an organization @@ -4685,25 +5865,25 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/list-org-roles"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/organization-roles/teams/{team_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["orgs/list-org-roles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/organization-roles/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a team * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4712,20 +5892,20 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-all-org-roles-team"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-all-org-roles-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/teams/{team_slug}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Assign an organization role to a team * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4734,8 +5914,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["orgs/assign-team-to-org-role"]; - readonly post?: never; + put: operations["orgs/assign-team-to-org-role"]; + post?: never; /** * Remove an organization role from a team * @description Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4744,22 +5924,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-org-role-team"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-org-role-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/users/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove all organization roles for a user * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4768,20 +5948,20 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-all-org-roles-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-all-org-roles-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/users/{username}/{role_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/users/{username}/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Assign an organization role to a user * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4790,8 +5970,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly put: operations["orgs/assign-user-to-org-role"]; - readonly post?: never; + put: operations["orgs/assign-user-to-org-role"]; + post?: never; /** * Remove an organization role from a user * @description Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." @@ -4800,18 +5980,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["orgs/revoke-org-role-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/revoke-org-role-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/{role_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/{role_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization role @@ -4824,21 +6004,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/get-org-role"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/get-org-role"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/{role_id}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/{role_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List teams that are assigned to an organization role @@ -4848,21 +6028,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/list-org-role-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-org-role-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/organization-roles/{role_id}/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/organization-roles/{role_id}/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users that are assigned to an organization role @@ -4872,65 +6052,65 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["orgs/list-org-role-users"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-org-role-users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/outside_collaborators": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/outside_collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List outside collaborators for an organization * @description List all users who are outside collaborators of an organization. */ - readonly get: operations["orgs/list-outside-collaborators"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-outside-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/outside_collaborators/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/outside_collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Convert an organization member to outside collaborator * @description When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see "[Converting an organization member to an outside collaborator](https://docs.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - readonly put: operations["orgs/convert-member-to-outside-collaborator"]; - readonly post?: never; + put: operations["orgs/convert-member-to-outside-collaborator"]; + post?: never; /** * Remove outside collaborator from an organization * @description Removing a user from this list will remove them from all the organization's repositories. */ - readonly delete: operations["orgs/remove-outside-collaborator"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-outside-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List packages for an organization @@ -4938,21 +6118,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-packages-for-organization"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package for an organization @@ -4960,9 +6140,9 @@ export interface paths { * * 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; - readonly post?: never; + get: operations["packages/get-package-for-organization"]; + put?: never; + post?: never; /** * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. @@ -4971,21 +6151,21 @@ export interface paths { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package for an organization * @description Restores an entire package in an organization. @@ -4998,19 +6178,19 @@ export interface paths { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List package versions for a package owned by an organization @@ -5018,21 +6198,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package version for an organization @@ -5040,9 +6220,9 @@ export interface paths { * * 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; - readonly post?: never; + get: operations["packages/get-package-version-for-organization"]; + put?: never; + post?: never; /** * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. @@ -5051,21 +6231,21 @@ export interface paths { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-version-for-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore package version for an organization * @description Restores a specific package version in an organization. @@ -5078,19 +6258,19 @@ export interface paths { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-version-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-token-requests": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-token-requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List requests to access organization resources with fine-grained personal access tokens @@ -5098,49 +6278,49 @@ export interface paths { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grant-requests"]; - readonly put?: never; + get: operations["orgs/list-pat-grant-requests"]; + put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/review-pat-grant-requests-in-bulk"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/review-pat-grant-requests-in-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-token-requests/{pat_request_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Review a request to access organization resources with a fine-grained personal access token * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/review-pat-grant-request"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/review-pat-grant-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories requested to be accessed by a fine-grained personal access token @@ -5148,21 +6328,21 @@ export interface paths { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grant-request-repositories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-pat-grant-request-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-tokens": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List fine-grained personal access tokens with access to organization resources @@ -5170,49 +6350,49 @@ export interface paths { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grants"]; - readonly put?: never; + get: operations["orgs/list-pat-grants"]; + put?: never; /** * Update the access to organization resources via fine-grained personal access tokens * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/update-pat-accesses"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/update-pat-accesses"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-tokens/{pat_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-tokens/{pat_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Update the access a fine-grained personal access token has to organization resources * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * * Only GitHub Apps can use this endpoint. */ - readonly post: operations["orgs/update-pat-access"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["orgs/update-pat-access"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/personal-access-tokens/{pat_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories a fine-grained personal access token has access to @@ -5220,184 +6400,342 @@ export interface paths { * * Only GitHub Apps can use this endpoint. */ - readonly get: operations["orgs/list-pat-grant-repositories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-pat-grant-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/private-registries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/private-registries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List private registries for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Lists all private registry configurations available at the organization-level without revealing their encrypted + * @description Lists all private registry configurations available at the organization-level without revealing their encrypted * values. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["private-registries/list-org-private-registries"]; - readonly put?: never; + get: operations["private-registries/list-org-private-registries"]; + put?: never; /** * Create a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly post: operations["private-registries/create-org-private-registry"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["private-registries/create-org-private-registry"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/private-registries/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/private-registries/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get private registries public key for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * @description Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["private-registries/get-org-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["private-registries/get-org-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/private-registries/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/private-registries/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * @description Get the configuration of a single private registry defined for an organization, omitting its encrypted value. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["private-registries/get-org-private-registry"]; - readonly put?: never; - readonly post?: never; + get: operations["private-registries/get-org-private-registry"]; + put?: never; + post?: never; /** * Delete a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Delete a private registry configuration at the organization-level. + * @description Delete a private registry configuration at the organization-level. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly delete: operations["private-registries/delete-org-private-registry"]; - readonly options?: never; - readonly head?: never; + delete: operations["private-registries/delete-org-private-registry"]; + options?: never; + head?: never; /** * Update a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly patch: operations["private-registries/update-org-private-registry"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly get: operations["projects/list-for-org"]; - readonly put?: never; + patch: operations["private-registries/update-org-private-registry"]; + trace?: never; + }; + "/orgs/{org}/projectsV2": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List projects for organization + * @description List all projects owned by a specific organization accessible by the authenticated user. + */ + get: operations["projects/list-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for organization + * @description Get a specific organization-owned project. + */ + get: operations["projects/get-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for organization owned project + * @description Create draft issue item for the specified organization owned project. + */ + post: operations["projects/create-draft-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for organization + * @description List all fields for a specific organization-owned project. + */ + get: operations["projects/list-fields-for-org"]; + put?: never; + /** + * Add a field to an organization-owned project. + * @description Add a field to an organization-owned project. + */ + post: operations["projects/add-field-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for organization + * @description Get a specific field for an organization-owned project. + */ + get: operations["projects/get-field-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization owned project + * @description List all items for a specific organization-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-org"]; + put?: never; + /** + * Add item to organization owned project + * @description Add an issue or pull request item to the specified organization owned project. + */ + post: operations["projects/add-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for an organization owned project + * @description Get a specific item from an organization-owned project. + */ + get: operations["projects/get-org-item"]; + put?: never; + post?: never; + /** + * Delete project item for organization + * @description Delete a specific item from an organization-owned project. + */ + delete: operations["projects/delete-item-for-org"]; + options?: never; + head?: never; + /** + * Update project item for organization + * @description Update a specific item in an organization-owned project. + */ + patch: operations["projects/update-item-for-org"]; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly post: operations["projects/create-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/properties/schema": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + * Create a view for an organization-owned project + * @description Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization project view + * @description List items in an organization project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/properties/schema": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. * Organization members can read these properties. */ - readonly get: operations["orgs/get-all-custom-properties"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/custom-properties-for-repos-get-organization-definitions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - readonly patch: operations["orgs/create-or-update-custom-properties"]; - readonly trace?: never; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-definitions"]; + trace?: never; }; - readonly "/orgs/{org}/properties/schema/{custom_property_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/properties/schema/{custom_property_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. * Organization members can read these properties. */ - readonly get: operations["orgs/get-custom-property"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definition"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. @@ -5406,8 +6744,8 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - readonly put: operations["orgs/create-or-update-custom-property"]; - readonly post?: never; + put: operations["orgs/custom-properties-for-repos-create-or-update-organization-definition"]; + post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. @@ -5416,30 +6754,30 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - readonly delete: operations["orgs/remove-custom-property"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/custom-properties-for-repos-delete-organization-definition"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/properties/values": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List custom property values for organization repositories * @description Lists organization repositories with all of their custom property values. * Organization members can read these properties. */ - readonly get: operations["orgs/list-custom-properties-values-for-repos"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/custom-properties-for-repos-get-organization-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for organization repositories * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. @@ -5453,65 +6791,65 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ - readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; - readonly trace?: never; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-values"]; + trace?: never; }; - readonly "/orgs/{org}/public_members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/public_members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. */ - readonly get: operations["orgs/list-public-members"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-public-members"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/public_members/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/public_members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check public organization membership for a user * @description Check if the provided user is a public member of the organization. */ - readonly get: operations["orgs/check-public-membership-for-user"]; + get: operations["orgs/check-public-membership-for-user"]; /** * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["orgs/set-public-membership-for-authenticated-user"]; - readonly post?: never; + put: operations["orgs/set-public-membership-for-authenticated-user"]; + post?: never; /** * Remove public organization membership for the authenticated user * @description Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. */ - readonly delete: operations["orgs/remove-public-membership-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-public-membership-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization repositories @@ -5520,93 +6858,93 @@ export interface paths { * > [!NOTE] * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." */ - readonly get: operations["repos/list-for-org"]; - readonly put?: never; + get: operations["repos/list-for-org"]; + put?: never; /** * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ - readonly post: operations["repos/create-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-in-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all organization repository rulesets * @description Get all the repository rulesets for an organization. */ - readonly get: operations["repos/get-org-rulesets"]; - readonly put?: never; + get: operations["repos/get-org-rulesets"]; + put?: never; /** * Create an organization repository ruleset * @description Create a repository ruleset for an organization. */ - readonly post: operations["repos/create-org-ruleset"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-org-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets/rule-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization rule suites * @description Lists suites of rule evaluations at the organization level. * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-org-rule-suites"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-org-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization rule suite * @description Gets information about a suite of rule evaluations from within an organization. * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-org-rule-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-org-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/rulesets/{ruleset_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization repository ruleset @@ -5615,29 +6953,69 @@ export interface paths { * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user * making the API request has write access to the ruleset. */ - readonly get: operations["repos/get-org-ruleset"]; + get: operations["repos/get-org-ruleset"]; /** * Update an organization repository ruleset * @description Update a ruleset for an organization. */ - readonly put: operations["repos/update-org-ruleset"]; - readonly post?: never; + put: operations["repos/update-org-ruleset"]; + post?: never; /** * Delete an organization repository ruleset * @description Delete a ruleset for an organization. */ - readonly delete: operations["repos/delete-org-ruleset"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/secret-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + delete: operations["repos/delete-org-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset history + * @description Get the history of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset version + * @description Get a version of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List secret scanning alerts for an organization @@ -5647,21 +7025,49 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/list-alerts-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["secret-scanning/list-alerts-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/secret-scanning/pattern-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization pattern configurations + * @description Lists the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `read:org` scope to use this endpoint. + */ + get: operations["secret-scanning/list-org-pattern-configs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update organization pattern configurations + * @description Updates the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["secret-scanning/update-org-pattern-configs"]; + trace?: never; }; - readonly "/orgs/{org}/security-advisories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository security advisories for an organization @@ -5671,21 +7077,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly get: operations["security-advisories/list-org-repository-advisories"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["security-advisories/list-org-repository-advisories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/security-managers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/security-managers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List security manager teams @@ -5693,121 +7099,133 @@ export interface paths { * @description > [!WARNING] * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ - readonly get: operations["orgs/list-security-manager-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-security-manager-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/security-managers/teams/{team_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/security-managers/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add a security manager team * @deprecated * @description > [!WARNING] * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ - readonly put: operations["orgs/add-security-manager-team"]; - readonly post?: never; + put: operations["orgs/add-security-manager-team"]; + post?: never; /** * Remove a security manager team * @deprecated * @description > [!WARNING] * > **Closing down notice:** This operation is closing down and will be removed starting January 1, 2026. Please use the "[Organization Roles](https://docs.github.com/rest/orgs/organization-roles)" endpoints instead. */ - readonly delete: operations["orgs/remove-security-manager-team"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/remove-security-manager-team"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/billing/actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get immutable releases settings for an organization + * @description Gets the immutable releases policy for repositories in an organization. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings"]; + /** + * Set immutable releases settings for an organization + * @description Sets the immutable releases policy for repositories in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["billing/get-github-actions-billing-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["orgs/set-immutable-releases-settings"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/billing/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/immutable-releases/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * List selected repositories for immutable releases enforcement + * @description List all of the repositories that have been selected for immutable releases enforcement in an organization. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings-repositories"]; + /** + * Set selected repositories for immutable releases enforcement + * @description Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["billing/get-github-packages-billing-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["orgs/set-immutable-releases-settings-repositories"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/billing/shared-storage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; + get?: never; /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Enable a selected repository for immutable releases in an organization + * @description Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/enable-selected-repository-immutable-releases-organization"]; + post?: never; + /** + * Disable a selected repository for immutable releases in an organization + * @description Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - readonly get: operations["billing/get-shared-storage-billing-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["orgs/disable-selected-repository-immutable-releases-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/network-configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/network-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List hosted compute network configurations for an organization @@ -5815,27 +7233,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. */ - readonly get: operations["hosted-compute/list-network-configurations-for-org"]; - readonly put?: never; + get: operations["hosted-compute/list-network-configurations-for-org"]; + put?: never; /** * Create a hosted compute network configuration for an organization * @description Creates a hosted compute network configuration for an organization. * * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. */ - readonly post: operations["hosted-compute/create-network-configuration-for-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["hosted-compute/create-network-configuration-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/network-configurations/{network_configuration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a hosted compute network configuration for an organization @@ -5843,33 +7261,33 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. */ - readonly get: operations["hosted-compute/get-network-configuration-for-org"]; - readonly put?: never; - readonly post?: never; + get: operations["hosted-compute/get-network-configuration-for-org"]; + put?: never; + post?: never; /** * Delete a hosted compute network configuration from an organization * @description Deletes a hosted compute network configuration from an organization. * * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. */ - readonly delete: operations["hosted-compute/delete-network-configuration-from-org"]; - readonly options?: never; - readonly head?: never; + delete: operations["hosted-compute/delete-network-configuration-from-org"]; + options?: never; + head?: never; /** * Update a hosted compute network configuration for an organization * @description Updates a hosted compute network configuration for an organization. * * OAuth app tokens and personal access tokens (classic) need the `write:network_configurations` scope to use this endpoint. */ - readonly patch: operations["hosted-compute/update-network-configuration-for-org"]; - readonly trace?: never; + patch: operations["hosted-compute/update-network-configuration-for-org"]; + trace?: never; }; - readonly "/orgs/{org}/settings/network-settings/{network_settings_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/settings/network-settings/{network_settings_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a hosted compute network settings resource for an organization @@ -5877,21 +7295,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:network_configurations` scope to use this endpoint. */ - readonly get: operations["hosted-compute/get-network-settings-for-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["hosted-compute/get-network-settings-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/team/{team_slug}/copilot/metrics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/team/{team_slug}/copilot/metrics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get Copilot metrics for a team @@ -5900,7 +7318,7 @@ export interface paths { * > [!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, + * The response contains metrics for up to 100 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. * @@ -5909,83 +7327,47 @@ export interface paths { * * 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; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a summary of Copilot usage for a team - * @description > [!NOTE] - * > 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. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - readonly get: operations["copilot/usage-metrics-for-team"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["copilot/copilot-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List teams * @description Lists all teams in an organization that are visible to the authenticated user. */ - readonly get: operations["teams/list"]; - readonly put?: never; + get: operations["teams/list"]; + put?: never; /** * Create a team * @description To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://docs.github.com/articles/setting-team-creation-permissions-in-your-organization)." * * When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". */ - readonly post: operations["teams/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a team by name @@ -5994,9 +7376,9 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. */ - readonly get: operations["teams/get-by-name"]; - readonly put?: never; - readonly post?: never; + get: operations["teams/get-by-name"]; + put?: never; + post?: never; /** * Delete a team * @description To delete a team, the authenticated user must be an organization owner or team maintainer. @@ -6006,9 +7388,9 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. */ - readonly delete: operations["teams/delete-in-org"]; - readonly options?: never; - readonly head?: never; + delete: operations["teams/delete-in-org"]; + options?: never; + head?: never; /** * Update a team * @description To edit a team, the authenticated user must either be an organization owner or a team maintainer. @@ -6016,295 +7398,15 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. */ - readonly patch: operations["teams/update-in-org"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussions-in-org"]; - readonly put?: never; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + patch: operations["teams/update-in-org"]; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-in-org"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-in-org"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-in-org"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussion-comments-in-org"]; - readonly put?: never; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-comment-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-comment-in-org"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-comment-in-org"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-comment-in-org"]; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-comment-in-org"]; - readonly put?: never; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-comment-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - /** - * Delete team discussion comment reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["reactions/delete-for-team-discussion-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-in-org"]; - readonly put?: never; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-in-org"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - /** - * Delete team discussion reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["reactions/delete-for-team-discussion"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pending team invitations @@ -6313,21 +7415,21 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. */ - readonly get: operations["teams/list-pending-invitations-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-pending-invitations-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team members @@ -6335,21 +7437,21 @@ export interface paths { * * To list members in a team, the team must be visible to the authenticated user. */ - readonly get: operations["teams/list-members-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-members-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get team membership for a user @@ -6365,7 +7467,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ - readonly get: operations["teams/get-membership-for-user-in-org"]; + get: operations["teams/get-membership-for-user-in-org"]; /** * Add or update team membership for a user * @description Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. @@ -6382,8 +7484,8 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly put: operations["teams/add-or-update-membership-for-user-in-org"]; - readonly post?: never; + put: operations["teams/add-or-update-membership-for-user-in-org"]; + post?: never; /** * Remove team membership for a user * @description To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. @@ -6396,78 +7498,18 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. */ - readonly delete: operations["teams/remove-membership-for-user-in-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ - readonly get: operations["teams/list-projects-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - readonly get: operations["teams/check-permissions-for-project-in-org"]; - /** - * Add or update team project permissions - * @description 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. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - readonly put: operations["teams/add-or-update-project-permissions-in-org"]; - readonly post?: never; - /** - * Remove a project from a team - * @description 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. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - readonly delete: operations["teams/remove-project-in-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-membership-for-user-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team repositories @@ -6476,21 +7518,21 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. */ - readonly get: operations["teams/list-repos-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-repos-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check team permissions for a repository @@ -6505,7 +7547,7 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly get: operations["teams/check-permissions-for-repo-in-org"]; + get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." @@ -6515,8 +7557,8 @@ export interface paths { * * For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". */ - readonly put: operations["teams/add-or-update-repo-permissions-in-org"]; - readonly post?: never; + put: operations["teams/add-or-update-repo-permissions-in-org"]; + post?: never; /** * Remove a repository from a team * @description If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. @@ -6524,18 +7566,18 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ - readonly delete: operations["teams/remove-repo-in-org"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-repo-in-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/orgs/{org}/teams/{team_slug}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/orgs/{org}/teams/{team_slug}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List child teams @@ -6544,24 +7586,24 @@ export interface paths { * > [!NOTE] * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. */ - readonly get: operations["teams/list-child-in-org"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/orgs/{org}/{security_product}/{enablement}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["teams/list-child-in-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/{security_product}/{enablement}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Enable or disable a security feature for an organization * @deprecated @@ -6574,240 +7616,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `admin:org`, `write:org`, or `repo` scopes to use this endpoint. */ - readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/columns/cards/{card_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a project card - * @description Gets information about a project card. - */ - readonly get: operations["projects/get-card"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a project card - * @description Deletes a project card - */ - readonly delete: operations["projects/delete-card"]; - readonly options?: never; - readonly head?: never; - /** Update an existing project card */ - readonly patch: operations["projects/update-card"]; - readonly trace?: never; - }; - readonly "/projects/columns/cards/{card_id}/moves": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** Move a project card */ - readonly post: operations["projects/move-card"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/columns/{column_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a project column - * @description Gets information about a project column. - */ - readonly get: operations["projects/get-column"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a project column - * @description Deletes a project column. - */ - readonly delete: operations["projects/delete-column"]; - readonly options?: never; - readonly head?: never; - /** Update an existing project column */ - readonly patch: operations["projects/update-column"]; - readonly trace?: never; - }; - readonly "/projects/columns/{column_id}/cards": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List project cards - * @description Lists the project cards in a project. - */ - readonly get: operations["projects/list-cards"]; - readonly put?: never; - /** Create a project card */ - readonly post: operations["projects/create-card"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/columns/{column_id}/moves": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** Move a project column */ - readonly post: operations["projects/move-column"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly get: operations["projects/get"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - readonly delete: operations["projects/delete"]; - readonly options?: never; - readonly head?: never; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly patch: operations["projects/update"]; - readonly trace?: never; - }; - readonly "/projects/{project_id}/collaborators": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - readonly get: operations["projects/list-collaborators"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}/collaborators/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - readonly put: operations["projects/add-collaborator"]; - readonly post?: never; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - readonly delete: operations["projects/remove-collaborator"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}/collaborators/{username}/permission": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - readonly get: operations["projects/get-permission-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/projects/{project_id}/columns": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List project columns - * @description Lists the project columns in a project. - */ - readonly get: operations["projects/list-columns"]; - readonly put?: never; - /** - * Create a project column - * @description Creates a new project column. - */ - readonly post: operations["projects/create-column"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/rate_limit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/rate_limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get rate limit status for the authenticated user @@ -6821,6 +7642,7 @@ export interface paths { * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -6828,32 +7650,33 @@ export interface paths { * > [!NOTE] * > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. */ - readonly get: operations["rate-limit/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["rate-limit/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * * > [!NOTE] - * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. */ - readonly get: operations["repos/get"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get"]; + put?: never; + post?: never; /** * Delete a repository * @description Deleting a repository requires admin access. @@ -6863,22 +7686,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete"]; + options?: never; + head?: never; /** * Update a repository * @description **Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. */ - readonly patch: operations["repos/update"]; - readonly trace?: never; + patch: operations["repos/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/artifacts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List artifacts for a repository @@ -6888,21 +7711,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-artifacts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-artifacts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an artifact @@ -6912,26 +7735,26 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-artifact"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-artifact"]; + put?: never; + post?: never; /** * Delete an artifact * @description Deletes an artifact for a workflow run. * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-artifact"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-artifact"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download an artifact @@ -6940,21 +7763,81 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-artifact"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/download-artifact"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for a repository + * @description Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-repository"]; + /** + * Set GitHub Actions cache retention limit for a repository + * @description Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for a repository + * @description Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-repository"]; + /** + * Set GitHub Actions cache storage limit for a repository + * @description Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/cache/usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/cache/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions cache usage for a repository @@ -6965,21 +7848,21 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-usage"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-actions-cache-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/caches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/caches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub Actions caches for a repository @@ -6987,49 +7870,49 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-actions-cache-list"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-actions-cache-list"]; + put?: never; + post?: never; /** * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-actions-cache-by-key"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-actions-cache-by-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/caches/{cache_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/caches/{cache_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-actions-cache-by-id"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-actions-cache-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a job for a workflow run @@ -7039,21 +7922,21 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-job-for-workflow-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-job-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download job logs for a workflow run @@ -7064,43 +7947,43 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-job-logs-for-workflow-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/download-job-logs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/re-run-job-for-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/re-run-job-for-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/oidc/customization/sub": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/oidc/customization/sub": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the customization template for an OIDC subject claim for a repository @@ -7108,27 +7991,27 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; + get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/organization-secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/organization-secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository organization secrets @@ -7139,21 +8022,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-organization-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-organization-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/organization-variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/organization-variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository organization variables @@ -7163,21 +8046,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-organization-variables"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-organization-variables"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Actions permissions for a repository @@ -7185,27 +8068,27 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-permissions-repository"]; + get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-permissions-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions/access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions/access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the level of access for workflows outside of the repository @@ -7215,7 +8098,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-workflow-access-to-repository"]; + get: operations["actions/get-workflow-access-to-repository"]; /** * Set the level of access for workflows outside of the repository * @description Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository. @@ -7224,20 +8107,104 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-workflow-access-to-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-workflow-access-to-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for a repository + * @description Gets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-repository"]; + /** + * Set artifact and log retention settings for a repository + * @description Sets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for a repository + * @description Gets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-repository"]; + /** + * Set fork PR contributor approval permissions for a repository + * @description Sets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for a repository + * @description Gets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-repository"]; + /** + * Set private repo fork PR workflow settings for a repository + * @description Sets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions/selected-actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get allowed actions and reusable workflows for a repository @@ -7245,27 +8212,27 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-allowed-actions-repository"]; + get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-allowed-actions-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-allowed-actions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/permissions/workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/permissions/workflow": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default workflow permissions for a repository @@ -7275,7 +8242,7 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; + get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** * Set default workflow permissions for a repository * @description Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions @@ -7284,20 +8251,20 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List self-hosted runners for a repository @@ -7307,21 +8274,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-self-hosted-runners-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-self-hosted-runners-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/downloads": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/downloads": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List runner applications for a repository @@ -7331,24 +8298,24 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-runner-applications-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/list-runner-applications-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. @@ -7357,22 +8324,22 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ - readonly post: operations["actions/generate-runner-jitconfig-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/generate-runner-jitconfig-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/registration-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/registration-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a registration token for a repository * @description Returns a token that you can pass to the `config` script. The token expires after one hour. @@ -7387,22 +8354,22 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-registration-token-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-registration-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/remove-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/remove-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a remove token for a repository * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. @@ -7417,19 +8384,19 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-remove-token-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-remove-token-for-repo"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a self-hosted runner for a repository @@ -7439,9 +8406,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-self-hosted-runner-for-repo"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-self-hosted-runner-for-repo"]; + put?: never; + post?: never; /** * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. @@ -7450,18 +8417,18 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-self-hosted-runner-from-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-self-hosted-runner-from-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for a self-hosted runner for a repository @@ -7471,7 +8438,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; + get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** * Set custom labels for a self-hosted runner for a repository * @description Remove all previous custom labels and set the new custom labels for a specific @@ -7481,7 +8448,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; + put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository * @description Adds custom labels to a self-hosted runner configured in a repository. @@ -7490,7 +8457,7 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; + post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** * Remove all custom labels from a self-hosted runner for a repository * @description Remove all custom labels from a self-hosted runner configured in a @@ -7500,22 +8467,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove a custom label from a self-hosted runner for a repository * @description Remove a custom label from a self-hosted runner configured @@ -7528,18 +8495,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List workflow runs for a repository @@ -7551,21 +8518,21 @@ export interface paths { * * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ - readonly get: operations["actions/list-workflow-runs-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-workflow-runs-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a workflow run @@ -7575,9 +8542,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-run"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-workflow-run"]; + put?: never; + post?: never; /** * Delete a workflow run * @description Deletes a specific workflow run. @@ -7586,18 +8553,18 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-workflow-run"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-workflow-run"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the review history for a workflow run @@ -7605,43 +8572,43 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-reviews-for-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/get-reviews-for-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/approve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/approve-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/approve-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List workflow run artifacts @@ -7651,21 +8618,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-workflow-run-artifacts"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-workflow-run-artifacts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a workflow run attempt @@ -7675,21 +8642,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-run-attempt"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List jobs for a workflow run attempt @@ -7700,21 +8667,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-jobs-for-workflow-run-attempt"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-jobs-for-workflow-run-attempt"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download workflow run attempt logs @@ -7725,46 +8692,46 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-workflow-run-attempt-logs"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["actions/download-workflow-run-attempt-logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a workflow run * @description Cancels a workflow run using its `id`. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/cancel-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Review custom deployment protection rules for a workflow run * @description Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." @@ -7774,22 +8741,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly post: operations["actions/review-custom-gates-for-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/review-custom-gates-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Force cancel a workflow run * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. @@ -7797,19 +8764,19 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/force-cancel-workflow-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/force-cancel-workflow-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List jobs for a workflow run @@ -7820,21 +8787,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-jobs-for-workflow-run"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-jobs-for-workflow-run"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download workflow run logs @@ -7845,27 +8812,27 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/download-workflow-run-logs"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/download-workflow-run-logs"]; + put?: never; + post?: never; /** * Delete workflow run logs * @description Deletes all logs for a workflow run. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-workflow-run-logs"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-workflow-run-logs"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get pending deployments for a workflow run @@ -7875,8 +8842,8 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-pending-deployments-for-run"]; - readonly put?: never; + get: operations["actions/get-pending-deployments-for-run"]; + put?: never; /** * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. @@ -7885,87 +8852,90 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/review-pending-deployments-for-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/review-pending-deployments-for-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Re-run a workflow * @description Re-runs your workflow run using its `id`. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/re-run-workflow"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/re-run-workflow"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Re-run failed jobs from a workflow run * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/re-run-workflow-failed-jobs"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/re-run-workflow-failed-jobs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get workflow run usage - * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-run-usage"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow-run-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository secrets @@ -7976,21 +8946,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository public key @@ -8001,21 +8971,21 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-repo-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository secret @@ -8025,7 +8995,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-repo-secret"]; + get: operations["actions/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using @@ -8035,8 +9005,8 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/create-or-update-repo-secret"]; - readonly post?: never; + put: operations["actions/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. @@ -8045,18 +9015,18 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-repo-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository variables @@ -8066,8 +9036,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-repo-variables"]; - readonly put?: never; + get: operations["actions/list-repo-variables"]; + put?: never; /** * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. @@ -8076,19 +9046,19 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-repo-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-repo-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository variable @@ -8098,9 +9068,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-repo-variable"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-repo-variable"]; + put?: never; + post?: never; /** * Delete a repository variable * @description Deletes a repository variable using the variable name. @@ -8109,9 +9079,9 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-repo-variable"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-repo-variable"]; + options?: never; + head?: never; /** * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. @@ -8120,15 +9090,15 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly patch: operations["actions/update-repo-variable"]; - readonly trace?: never; + patch: operations["actions/update-repo-variable"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository workflows @@ -8138,21 +9108,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/list-repo-workflows"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-repo-workflows"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a workflow @@ -8163,46 +9133,46 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Disable a workflow * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/disable-workflow"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/disable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a workflow dispatch event * @description You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. @@ -8211,41 +9181,41 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-workflow-dispatch"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-workflow-dispatch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Enable a workflow * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/enable-workflow"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["actions/enable-workflow"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List workflow runs for a workflow @@ -8257,25 +9227,28 @@ export interface paths { * * This endpoint will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`. */ - readonly get: operations["actions/list-workflow-runs"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-workflow-runs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get workflow usage - * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -8283,21 +9256,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["actions/get-workflow-usage"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-workflow-usage"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/activity": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository activities @@ -8306,41 +9279,41 @@ export interface paths { * For more information about viewing repository activity, * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." */ - readonly get: operations["repos/list-activities"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-activities"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List assignees * @description Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. */ - readonly get: operations["issues/list-assignees"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-assignees"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/assignees/{assignee}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user can be assigned @@ -8350,24 +9323,24 @@ export interface paths { * * Otherwise a `404` status code is returned. */ - readonly get: operations["issues/check-user-can-be-assigned"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/attestations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["issues/check-user-can-be-assigned"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/attestations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create an attestation * @description Store an artifact attestation and associate it with a repository. @@ -8376,19 +9349,19 @@ export interface paths { * * Artifact attestations are meant to be created using the [attest action](https://github.com/actions/attest). For more information, see our guide on [using artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly post: operations["repos/create-attestation"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-attestation"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/attestations/{subject_digest}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List attestations @@ -8398,21 +9371,21 @@ export interface paths { * * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly get: operations["repos/list-attestations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/autolinks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/autolinks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all autolinks of a repository @@ -8420,25 +9393,25 @@ export interface paths { * * Information about autolinks are only available to repository administrators. */ - readonly get: operations["repos/list-autolinks"]; - readonly put?: never; + get: operations["repos/list-autolinks"]; + put?: never; /** * Create an autolink reference for a repository * @description Users with admin access to the repository can create an autolink. */ - readonly post: operations["repos/create-autolink"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-autolink"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/autolinks/{autolink_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/autolinks/{autolink_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an autolink reference of a repository @@ -8446,95 +9419,95 @@ export interface paths { * * Information about autolinks are only available to repository administrators. */ - readonly get: operations["repos/get-autolink"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-autolink"]; + put?: never; + post?: never; /** * Delete an autolink reference from a repository * @description This deletes a single autolink reference by ID that was configured for the given repository. * * Information about autolinks are only available to repository administrators. */ - readonly delete: operations["repos/delete-autolink"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-autolink"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if Dependabot security updates are enabled for a repository * @description Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ - readonly get: operations["repos/check-automated-security-fixes"]; + get: operations["repos/check-automated-security-fixes"]; /** * Enable Dependabot security updates * @description Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ - readonly put: operations["repos/enable-automated-security-fixes"]; - readonly post?: never; + put: operations["repos/enable-automated-security-fixes"]; + post?: never; /** * Disable Dependabot security updates * @description Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "[Configuring Dependabot security updates](https://docs.github.com/articles/configuring-automated-security-fixes)". */ - readonly delete: operations["repos/disable-automated-security-fixes"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-automated-security-fixes"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List branches */ - readonly get: operations["repos/list-branches"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/list-branches"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get a branch */ - readonly get: operations["repos/get-branch"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/get-branch"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/branches/{branch}/protection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-branch-protection"]; + get: operations["repos/get-branch-protection"]; /** * Update branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8547,71 +9520,71 @@ export interface paths { * > [!NOTE] * > The list of users, apps, and teams in total is limited to 100 items. */ - readonly put: operations["repos/update-branch-protection"]; - readonly post?: never; + put: operations["repos/update-branch-protection"]; + post?: never; /** * Delete branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/delete-branch-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get admin branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-admin-branch-protection"]; - readonly put?: never; + get: operations["repos/get-admin-branch-protection"]; + put?: never; /** * Set admin branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly post: operations["repos/set-admin-branch-protection"]; + post: operations["repos/set-admin-branch-protection"]; /** * Delete admin branch protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly delete: operations["repos/delete-admin-branch-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-admin-branch-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get pull request review protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-pull-request-review-protection"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-pull-request-review-protection"]; + put?: never; + post?: never; /** * Delete pull request review protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/delete-pull-request-review-protection"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-pull-request-review-protection"]; + options?: never; + head?: never; /** * Update pull request review protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8621,15 +9594,15 @@ export interface paths { * > [!NOTE] * > Passing new arrays of `users` and `teams` replaces their previous values. */ - readonly patch: operations["repos/update-pull-request-review-protection"]; - readonly trace?: never; + patch: operations["repos/update-pull-request-review-protection"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get commit signature protection @@ -8640,95 +9613,95 @@ export interface paths { * > [!NOTE] * > You must enable branch protection to require signed commits. */ - readonly get: operations["repos/get-commit-signature-protection"]; - readonly put?: never; + get: operations["repos/get-commit-signature-protection"]; + put?: never; /** * Create commit signature protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly post: operations["repos/create-commit-signature-protection"]; + post: operations["repos/create-commit-signature-protection"]; /** * Delete commit signature protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits. */ - readonly delete: operations["repos/delete-commit-signature-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-commit-signature-protection"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get status checks protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-status-checks-protection"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-status-checks-protection"]; + put?: never; + post?: never; /** * Remove status check protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/remove-status-check-protection"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/remove-status-check-protection"]; + options?: never; + head?: never; /** * Update status check protection * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled. */ - readonly patch: operations["repos/update-status-check-protection"]; - readonly trace?: never; + patch: operations["repos/update-status-check-protection"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly get: operations["repos/get-all-status-check-contexts"]; + get: operations["repos/get-all-status-check-contexts"]; /** * Set status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly put: operations["repos/set-status-check-contexts"]; + put: operations["repos/set-status-check-contexts"]; /** * Add status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly post: operations["repos/add-status-check-contexts"]; + post: operations["repos/add-status-check-contexts"]; /** * Remove status check contexts * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. */ - readonly delete: operations["repos/remove-status-check-contexts"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-status-check-contexts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get access restrictions @@ -8739,27 +9712,27 @@ export interface paths { * > [!NOTE] * > Users, apps, and teams `restrictions` are only available for organization-owned repositories. */ - readonly get: operations["repos/get-access-restrictions"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-access-restrictions"]; + put?: never; + post?: never; /** * Delete access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Disables the ability to restrict who can push to this branch. */ - readonly delete: operations["repos/delete-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get apps with access to the protected branch @@ -8767,39 +9740,39 @@ export interface paths { * * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly get: operations["repos/get-apps-with-access-to-protected-branch"]; + get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly put: operations["repos/set-app-access-restrictions"]; + put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly post: operations["repos/add-app-access-restrictions"]; + post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ - readonly delete: operations["repos/remove-app-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-app-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get teams with access to the protected branch @@ -8807,39 +9780,39 @@ export interface paths { * * Lists the teams who have push access to this branch. The list includes child teams. */ - readonly get: operations["repos/get-teams-with-access-to-protected-branch"]; + get: operations["repos/get-teams-with-access-to-protected-branch"]; /** * Set team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams. */ - readonly put: operations["repos/set-team-access-restrictions"]; + put: operations["repos/set-team-access-restrictions"]; /** * Add team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Grants the specified teams push access for this branch. You can also give push access to child teams. */ - readonly post: operations["repos/add-team-access-restrictions"]; + post: operations["repos/add-team-access-restrictions"]; /** * Remove team access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * Removes the ability of a team to push to this branch. You can also remove push access for child teams. */ - readonly delete: operations["repos/remove-team-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-team-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get users with access to the protected branch @@ -8847,7 +9820,7 @@ export interface paths { * * Lists the people who have push access to this branch. */ - readonly get: operations["repos/get-users-with-access-to-protected-branch"]; + get: operations["repos/get-users-with-access-to-protected-branch"]; /** * Set user access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8858,7 +9831,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly put: operations["repos/set-user-access-restrictions"]; + put: operations["repos/set-user-access-restrictions"]; /** * Add user access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8869,7 +9842,7 @@ export interface paths { * | ------- | ----------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly post: operations["repos/add-user-access-restrictions"]; + post: operations["repos/add-user-access-restrictions"]; /** * Remove user access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -8880,21 +9853,21 @@ export interface paths { * | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- | * | `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. | */ - readonly delete: operations["repos/remove-user-access-restrictions"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-user-access-restrictions"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/branches/{branch}/rename": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/branches/{branch}/rename": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Rename a branch * @description Renames a branch in a repository. @@ -8906,22 +9879,22 @@ export interface paths { * * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ - readonly post: operations["repos/rename-branch"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/rename-branch"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a check run * @description Creates a new check run for a specific commit in a repository. @@ -8933,19 +9906,19 @@ export interface paths { * > [!NOTE] * > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ - readonly post: operations["checks/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["checks/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a check run @@ -8956,12 +9929,12 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["checks/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a check run * @description Updates a check run for a specific commit in a repository. @@ -8971,15 +9944,15 @@ export interface paths { * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly patch: operations["checks/update"]; - readonly trace?: never; + patch: operations["checks/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check run annotations @@ -8987,48 +9960,46 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-annotations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["checks/list-annotations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly post: operations["checks/rerequest-run"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["checks/rerequest-run"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a check suite * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". @@ -9038,40 +10009,40 @@ export interface paths { * * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly post: operations["checks/create-suite"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/check-suites/preferences": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + post: operations["checks/create-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/check-suites/preferences": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update repository preferences for check suites * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). * You must have admin permissions in the repository to set preferences for check suites. */ - readonly patch: operations["checks/set-suites-preferences"]; - readonly trace?: never; + patch: operations["checks/set-suites-preferences"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a check suite @@ -9082,21 +10053,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/get-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["checks/get-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check runs in a check suite @@ -9107,43 +10078,41 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-for-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["checks/list-for-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ - readonly post: operations["checks/rerequest-suite"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["checks/rerequest-suite"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List code scanning alerts for a repository @@ -9155,21 +10124,21 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/list-alerts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code scanning alert @@ -9177,26 +10146,26 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/get-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["code-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning alert * @description Updates the status of a single code scanning alert. * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly patch: operations["code-scanning/update-alert"]; - readonly trace?: never; + patch: operations["code-scanning/update-alert"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the status of an autofix for a code scanning alert @@ -9204,8 +10173,8 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/get-autofix"]; - readonly put?: never; + get: operations["code-scanning/get-autofix"]; + put?: never; /** * Create an autofix for a code scanning alert * @description Creates an autofix for a code scanning alert. @@ -9216,43 +10185,43 @@ export interface paths { * * 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. */ - readonly post: operations["code-scanning/create-autofix"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/create-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/autofix/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Commit an autofix for a code scanning alert * @description Commits an autofix for a code scanning alert. * - * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly post: operations["code-scanning/commit-autofix"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/commit-autofix"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List instances of a code scanning alert @@ -9260,21 +10229,21 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/list-alert-instances"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-alert-instances"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/analyses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List code scanning analyses for a repository @@ -9294,21 +10263,21 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/list-recent-analyses"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-recent-analyses"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code scanning analysis for a repository @@ -9330,9 +10299,9 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/get-analysis"]; - readonly put?: never; - readonly post?: never; + get: operations["code-scanning/get-analysis"]; + put?: never; + post?: never; /** * Delete a code scanning analysis from a repository * @description Deletes a specified code scanning analysis from a repository. @@ -9400,18 +10369,18 @@ export interface paths { * * 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-analysis"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["code-scanning/delete-analysis"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/databases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/databases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List CodeQL databases for a repository @@ -9419,21 +10388,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/list-codeql-databases"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a CodeQL database for a repository @@ -9447,30 +10416,30 @@ export interface paths { * * 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; + get: operations["code-scanning/get-codeql-database"]; + put?: never; + post?: 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; - readonly trace?: never; + delete: operations["code-scanning/delete-codeql-database"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a CodeQL variant analysis * @description Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories. @@ -9482,19 +10451,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["code-scanning/create-variant-analysis"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/create-variant-analysis"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the summary of a CodeQL variant analysis @@ -9502,21 +10471,21 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/get-variant-analysis"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/get-variant-analysis"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses/{codeql_variant_analysis_id}/repos/{repo_owner}/{repo_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the analysis status of a repository in a CodeQL variant analysis @@ -9524,21 +10493,21 @@ export interface paths { * * 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. */ - readonly get: operations["code-scanning/get-variant-analysis-repo-task"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/get-variant-analysis-repo-task"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/default-setup": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/default-setup": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a code scanning default setup configuration @@ -9546,30 +10515,30 @@ export interface paths { * * 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-default-setup"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["code-scanning/get-default-setup"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly patch: operations["code-scanning/update-default-setup"]; - readonly trace?: never; + patch: operations["code-scanning/update-default-setup"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/sarifs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/sarifs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Upload an analysis as SARIF data * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." @@ -9607,40 +10576,40 @@ export interface paths { * * This endpoint is limited to 1,000 requests per hour for each user or app installation calling it. */ - readonly post: operations["code-scanning/upload-sarif"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["code-scanning/upload-sarif"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get information about a SARIF upload * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ - readonly get: operations["code-scanning/get-sarif"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-scanning/get-sarif"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/code-security-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/code-security-configuration": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the code security configuration associated with a repository @@ -9650,21 +10619,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["code-security/get-configuration-for-repository"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["code-security/get-configuration-for-repository"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codeowners/errors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codeowners/errors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List CODEOWNERS errors @@ -9674,21 +10643,21 @@ export interface paths { * For more information about the correct CODEOWNERS syntax, * see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." */ - readonly get: operations["repos/codeowners-errors"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/codeowners-errors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces in a repository for the authenticated user @@ -9696,27 +10665,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-in-repository-for-authenticated-user"]; - readonly put?: never; + get: operations["codespaces/list-in-repository-for-authenticated-user"]; + put?: never; /** * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-with-repo-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/create-with-repo-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/devcontainers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/devcontainers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List devcontainer configurations in a repository for the authenticated user @@ -9725,21 +10694,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/machines": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List available machine types for a repository @@ -9747,21 +10716,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/repo-machines-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/repo-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/new": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/new": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get default attributes for a codespace @@ -9769,21 +10738,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/permissions_check": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/permissions_check": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if permissions defined by a devcontainer have been accepted by the authenticated user @@ -9791,21 +10760,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/check-permissions-for-devcontainer"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/check-permissions-for-devcontainer"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository secrets @@ -9814,21 +10783,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["codespaces/list-repo-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository public key @@ -9837,21 +10806,21 @@ export interface paths { * * 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"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository secret @@ -9859,61 +10828,61 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["codespaces/get-repo-secret"]; + get: operations["codespaces/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ - readonly put: operations["codespaces/create-or-update-repo-secret"]; - readonly post?: never; + put: operations["codespaces/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ - readonly delete: operations["codespaces/delete-repo-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/collaborators": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/collaborators": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. * * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. - * + * The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ - readonly get: operations["repos/list-collaborators"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-collaborators"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/collaborators/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/collaborators/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user is a repository collaborator @@ -9925,14 +10894,16 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ - readonly get: operations["repos/check-collaborator"]; + get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} @@ -9942,6 +10913,8 @@ export interface paths { * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * + * For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + * * **Updating an existing collaborator's permission level** * * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -9950,8 +10923,8 @@ export interface paths { * * You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. */ - readonly put: operations["repos/add-collaborator"]; - readonly post?: never; + put: operations["repos/add-collaborator"]; + post?: never; /** * Remove a repository collaborator * @description Removes a collaborator from a repository. @@ -9959,8 +10932,8 @@ export interface paths { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -9977,44 +10950,46 @@ export interface paths { * * For more information on fork permissions, see "[About permissions and visibility of forks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/working-with-forks/about-permissions-and-visibility-of-forks)". */ - readonly delete: operations["repos/remove-collaborator"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/remove-collaborator"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/collaborators/{username}/permission": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. - * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. - */ - readonly get: operations["repos/get-collaborator-permission-level"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + * @description Checks the repository permission and role of a collaborator. + * + * The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + * The `role_name` attribute provides the name of the assigned role, including custom roles. The + * `permission` can also be used to determine which base level of access the collaborator has to the repository. + * + * The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. + */ + get: operations["repos/get-collaborator-permission-level"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commit comments for a repository @@ -10027,21 +11002,21 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["repos/list-commit-comments-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-commit-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a commit comment @@ -10054,13 +11029,13 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["repos/get-commit-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-commit-comment"]; + put?: never; + post?: never; /** Delete a commit comment */ - readonly delete: operations["repos/delete-commit-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-commit-comment"]; + options?: never; + head?: never; /** * Update a commit comment * @description Updates the contents of a specified commit comment. @@ -10072,43 +11047,43 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["repos/update-commit-comment"]; - readonly trace?: never; + patch: operations["repos/update-commit-comment"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for a commit comment * @description List the reactions to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ - readonly get: operations["reactions/list-for-commit-comment"]; - readonly put?: never; + get: operations["reactions/list-for-commit-comment"]; + put?: never; /** * Create reaction for a commit comment * @description Create a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). A response with an HTTP `200` status means that you already added the reaction type to this commit comment. */ - readonly post: operations["reactions/create-for-commit-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a commit comment reaction * @description > [!NOTE] @@ -10116,18 +11091,18 @@ export interface paths { * * Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). */ - readonly delete: operations["reactions/delete-for-commit-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-commit-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commits @@ -10161,21 +11136,21 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/list-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List branches for HEAD commit @@ -10183,21 +11158,21 @@ export interface paths { * * Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch. */ - readonly get: operations["repos/list-branches-for-head-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-branches-for-head-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commit comments @@ -10210,8 +11185,8 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["repos/list-comments-for-commit"]; - readonly put?: never; + get: operations["repos/list-comments-for-commit"]; + put?: never; /** * Create a commit comment * @description Create a comment for a commit using its `:commit_sha`. @@ -10225,41 +11200,41 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["repos/create-commit-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-commit-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{commit_sha}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ - readonly get: operations["repos/list-pull-requests-associated-with-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-pull-requests-associated-with-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a commit @@ -10304,21 +11279,21 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/get-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/check-runs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check runs for a Git reference @@ -10331,21 +11306,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["checks/list-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/check-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List check suites for a Git reference @@ -10356,21 +11331,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ - readonly get: operations["checks/list-suites-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["checks/list-suites-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/status": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the combined status for a specific reference @@ -10383,21 +11358,21 @@ export interface paths { * * **pending** if there are no statuses or a context is `pending` * * **success** if the latest status for all contexts is `success` */ - readonly get: operations["repos/get-combined-status-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-combined-status-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/commits/{ref}/statuses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commit statuses for a reference @@ -10405,21 +11380,21 @@ export interface paths { * * This resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`. */ - readonly get: operations["repos/list-commit-statuses-for-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-commit-statuses-for-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/community/profile": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/community/profile": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get community profile metrics @@ -10435,21 +11410,21 @@ export interface paths { * * `content_reports_enabled` is only returned for organization-owned repositories. */ - readonly get: operations["repos/get-community-profile-metrics"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-community-profile-metrics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/compare/{basehead}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Compare two commits @@ -10505,21 +11480,21 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["repos/compare-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/compare-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/contents/{path}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/contents/{path}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repository content @@ -10549,7 +11524,7 @@ export interface paths { * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. * - Greater than 100 MB: This endpoint is not supported. */ - readonly get: operations["repos/get-content"]; + get: operations["repos/get-content"]; /** * Create or update file contents * @description Creates a new file or replaces an existing file in a repository. @@ -10559,8 +11534,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ - readonly put: operations["repos/create-or-update-file-contents"]; - readonly post?: never; + put: operations["repos/create-or-update-file-contents"]; + post?: never; /** * Delete a file * @description Deletes a file in a repository. @@ -10574,18 +11549,18 @@ export interface paths { * > [!NOTE] * > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. */ - readonly delete: operations["repos/delete-file"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-file"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/contributors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository contributors @@ -10593,67 +11568,67 @@ export interface paths { * * GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. */ - readonly get: operations["repos/list-contributors"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-contributors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List Dependabot alerts for a repository * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["dependabot/list-alerts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a Dependabot alert * @description OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["dependabot/get-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["dependabot/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a Dependabot alert * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly patch: operations["dependabot/update-alert"]; - readonly trace?: never; + patch: operations["dependabot/update-alert"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository secrets @@ -10662,21 +11637,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["dependabot/list-repo-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/list-repo-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository public key @@ -10686,21 +11661,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. */ - readonly get: operations["dependabot/get-repo-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependabot/get-repo-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository secret @@ -10708,7 +11683,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["dependabot/get-repo-secret"]; + get: operations["dependabot/get-repo-secret"]; /** * Create or update a repository secret * @description Creates or updates a repository secret with an encrypted value. Encrypt your secret using @@ -10716,69 +11691,69 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["dependabot/create-or-update-repo-secret"]; - readonly post?: never; + put: operations["dependabot/create-or-update-repo-secret"]; + post?: never; /** * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["dependabot/delete-repo-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["dependabot/delete-repo-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependency-graph/compare/{basehead}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a diff of the dependencies between commits * @description Gets the diff of the dependency changes between two commits of a repository, based on the changes to the dependency manifests made in those commits. */ - readonly get: operations["dependency-graph/diff-range"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["dependency-graph/diff-range"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/dependency-graph/sbom": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/dependency-graph/sbom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Export a software bill of materials (SBOM) for a repository. * @description Exports the software bill of materials (SBOM) for a repository in SPDX JSON format. */ - readonly get: operations["dependency-graph/export-sbom"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/dependency-graph/snapshots": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["dependency-graph/export-sbom"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/dependency-graph/snapshots": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a snapshot of dependencies for a repository * @description Create a new snapshot of a repository's dependencies. @@ -10787,26 +11762,26 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["dependency-graph/create-repository-snapshot"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["dependency-graph/create-repository-snapshot"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deployments * @description Simple filtering of deployments is available via query parameters: */ - readonly get: operations["repos/list-deployments"]; - readonly put?: never; + get: operations["repos/list-deployments"]; + put?: never; /** * Create a deployment * @description Deployments offer a few configurable parameters with certain defaults. @@ -10858,24 +11833,24 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get a deployment */ - readonly get: operations["repos/get-deployment"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-deployment"]; + put?: never; + post?: never; /** * Delete a deployment * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. @@ -10889,67 +11864,67 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ - readonly delete: operations["repos/delete-deployment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-deployment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deployment statuses * @description Users with pull access can view deployment statuses for a deployment: */ - readonly get: operations["repos/list-deployment-statuses"]; - readonly put?: never; + get: operations["repos/list-deployment-statuses"]; + put?: never; /** * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment-status"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a deployment status * @description Users with pull access can view a deployment status for a deployment: */ - readonly get: operations["repos/get-deployment-status"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/dispatches": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-deployment-status"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/dispatches": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository dispatch event * @description You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see "[RepositoryDispatchEvent](https://docs.github.com/webhooks/event-payloads/#repository_dispatch)." @@ -10960,19 +11935,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-dispatch-event"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-dispatch-event"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List environments @@ -10982,21 +11957,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-all-environments"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-all-environments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment @@ -11007,7 +11982,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-environment"]; + get: operations["repos/get-environment"]; /** * Create or update an environment * @description Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." @@ -11020,24 +11995,24 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["repos/create-or-update-environment"]; - readonly post?: never; + put: operations["repos/create-or-update-environment"]; + post?: never; /** * Delete an environment * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete-an-environment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-an-environment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deployment branch policies @@ -11047,27 +12022,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/list-deployment-branch-policies"]; - readonly put?: never; + get: operations["repos/list-deployment-branch-policies"]; + put?: never; /** * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment-branch-policy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment-branch-policy"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a deployment branch policy @@ -11077,33 +12052,33 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-deployment-branch-policy"]; + get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["repos/update-deployment-branch-policy"]; - readonly post?: never; + put: operations["repos/update-deployment-branch-policy"]; + post?: never; /** * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete-deployment-branch-policy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-deployment-branch-policy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all deployment protection rules for an environment @@ -11113,31 +12088,31 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-all-deployment-protection-rules"]; - readonly put?: never; + get: operations["repos/get-all-deployment-protection-rules"]; + put?: never; /** * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-deployment-protection-rule"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deployment-protection-rule"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List custom deployment rule integrations available for an environment @@ -11151,21 +12126,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/list-custom-deployment-rule-integrations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-custom-deployment-rule-integrations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a custom deployment protection rule @@ -11175,9 +12150,9 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/get-custom-deployment-protection-rule"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-custom-deployment-protection-rule"]; + put?: never; + post?: never; /** * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. @@ -11186,18 +12161,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/disable-deployment-protection-rule"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-deployment-protection-rule"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List environment secrets @@ -11208,21 +12183,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-environment-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment public key @@ -11233,21 +12208,21 @@ export interface paths { * * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-environment-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment secret @@ -11257,7 +12232,7 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-environment-secret"]; + get: operations["actions/get-environment-secret"]; /** * Create or update an environment secret * @description Creates or updates an environment secret with an encrypted value. Encrypt your secret using @@ -11267,8 +12242,8 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["actions/create-or-update-environment-secret"]; - readonly post?: never; + put: operations["actions/create-or-update-environment-secret"]; + post?: never; /** * Delete an environment secret * @description Deletes a secret in an environment using the secret name. @@ -11277,18 +12252,18 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-environment-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List environment variables @@ -11298,8 +12273,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/list-environment-variables"]; - readonly put?: never; + get: operations["actions/list-environment-variables"]; + put?: never; /** * Create an environment variable * @description Create an environment variable that you can reference in a GitHub Actions workflow. @@ -11308,19 +12283,19 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["actions/create-environment-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an environment variable @@ -11330,9 +12305,9 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["actions/get-environment-variable"]; - readonly put?: never; - readonly post?: never; + get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; /** * Delete an environment variable * @description Deletes an environment variable using the variable name. @@ -11341,9 +12316,9 @@ export interface paths { * * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["actions/delete-environment-variable"]; - readonly options?: never; - readonly head?: never; + delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; /** * Update an environment variable * @description Updates an environment variable that you can reference in a GitHub Actions workflow. @@ -11352,40 +12327,40 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly patch: operations["actions/update-environment-variable"]; - readonly trace?: never; + patch: operations["actions/update-environment-variable"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository events * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-repo-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/forks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["activity/list-repo-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List forks */ - readonly get: operations["repos/list-forks"]; - readonly put?: never; + get: operations["repos/list-forks"]; + put?: never; /** * Create a fork * @description Create a fork for the authenticated user. @@ -11396,36 +12371,36 @@ export interface paths { * > [!NOTE] * > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. */ - readonly post: operations["repos/create-fork"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/blobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + post: operations["repos/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/blobs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Create a blob */ - readonly post: operations["git/create-blob"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-blob"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/blobs/{file_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a blob @@ -11438,24 +12413,24 @@ export interface paths { * * **Note** This endpoint supports blobs up to 100 megabytes in size. */ - readonly get: operations["git/get-blob"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["git/get-blob"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit * @description Creates a new Git [commit object](https://git-scm.com/book/en/v2/Git-Internals-Git-Objects). @@ -11490,19 +12465,19 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly post: operations["git/create-commit"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-commit"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/commits/{commit_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a commit object @@ -11540,21 +12515,21 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["git/get-commit"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["git/get-commit"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/matching-refs/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/matching-refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List matching references @@ -11567,21 +12542,21 @@ export interface paths { * * If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. */ - readonly get: operations["git/list-matching-refs"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["git/list-matching-refs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/ref/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/ref/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a reference @@ -11590,68 +12565,68 @@ export interface paths { * > [!NOTE] * > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". */ - readonly get: operations["git/get-ref"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/refs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["git/get-ref"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/refs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a reference * @description Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches. */ - readonly post: operations["git/create-ref"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-ref"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/refs/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/refs/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a reference * @description Deletes the provided reference. */ - readonly delete: operations["git/delete-ref"]; - readonly options?: never; - readonly head?: never; + delete: operations["git/delete-ref"]; + options?: never; + head?: never; /** * Update a reference * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly patch: operations["git/update-ref"]; - readonly trace?: never; + patch: operations["git/update-ref"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/tags": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a tag object * @description Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/rest/git/refs#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/rest/git/refs#create-a-reference) the tag reference - this call would be unnecessary. @@ -11686,19 +12661,19 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly post: operations["git/create-tag"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-tag"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/tags/{tag_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a tag @@ -11732,24 +12707,24 @@ export interface paths { * | `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ - readonly get: operations["git/get-tag"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/git/trees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["git/get-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/git/trees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a tree * @description The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. @@ -11758,19 +12733,19 @@ export interface paths { * * Returns an error if you try to delete a file that does not exist. */ - readonly post: operations["git/create-tree"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["git/create-tree"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/git/trees/{tree_sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a tree @@ -11781,76 +12756,76 @@ export interface paths { * > [!NOTE] * > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. */ - readonly get: operations["git/get-tree"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["git/get-tree"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository webhooks * @description Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days. */ - readonly get: operations["repos/list-webhooks"]; - readonly put?: never; + get: operations["repos/list-webhooks"]; + put?: never; /** * Create a repository webhook * @description Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can * share the same `config` as long as those webhooks do not have any `events` that overlap. */ - readonly post: operations["repos/create-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository webhook * @description Returns a webhook configured in a repository. To get only the webhook `config` properties, see "[Get a webhook configuration for a repository](/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository)." */ - readonly get: operations["repos/get-webhook"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-webhook"]; + put?: never; + post?: never; /** * Delete a repository webhook * @description Delete a webhook for an organization. * * The authenticated user must be a repository owner, or have admin access in the repository, to delete the webhook. */ - readonly delete: operations["repos/delete-webhook"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-webhook"]; + options?: never; + head?: never; /** * Update a repository webhook * @description Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)." */ - readonly patch: operations["repos/update-webhook"]; - readonly trace?: never; + patch: operations["repos/update-webhook"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/config": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/config": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a webhook configuration for a repository @@ -11858,110 +12833,110 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-webhook-config-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["repos/get-webhook-config-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ - readonly patch: operations["repos/update-webhook-config-for-repo"]; - readonly trace?: never; + patch: operations["repos/update-webhook-config-for-repo"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List deliveries for a repository webhook * @description Returns a list of webhook deliveries for a webhook configured in a repository. */ - readonly get: operations["repos/list-webhook-deliveries"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-webhook-deliveries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a delivery for a repository webhook * @description Returns a delivery for a webhook configured in a repository. */ - readonly get: operations["repos/get-webhook-delivery"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-webhook-delivery"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Redeliver a delivery for a repository webhook * @description Redeliver a webhook delivery for a webhook configured in a repository. */ - readonly post: operations["repos/redeliver-webhook-delivery"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/redeliver-webhook-delivery"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Ping a repository webhook * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. */ - readonly post: operations["repos/ping-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/ping-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Test the push repository webhook * @description This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. @@ -11969,19 +12944,48 @@ export interface paths { * > [!NOTE] * > Previously `/repos/:owner/:repo/hooks/:hook_id/test` */ - readonly post: operations["repos/test-push-webhook"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/test-push-webhook"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Check if immutable releases are enabled for a repository + * @description Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + * enforced by the repository owner. The authenticated user must have admin read access to the repository. + */ + get: operations["repos/check-immutable-releases"]; + /** + * Enable immutable releases + * @description Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + put: operations["repos/enable-immutable-releases"]; + post?: never; + /** + * Disable immutable releases + * @description Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + delete: operations["repos/disable-immutable-releases"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/import": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an import status @@ -12024,7 +13028,7 @@ export interface paths { * * `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository. * * `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a "Get Large Files" request. */ - readonly get: operations["migrations/get-import-status"]; + get: operations["migrations/get-import-status"]; /** * Start an import * @deprecated @@ -12035,8 +13039,8 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly put: operations["migrations/start-import"]; - readonly post?: never; + put: operations["migrations/start-import"]; + post?: never; /** * Cancel an import * @deprecated @@ -12045,9 +13049,9 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly delete: operations["migrations/cancel-import"]; - readonly options?: never; - readonly head?: never; + delete: operations["migrations/cancel-import"]; + options?: never; + head?: never; /** * Update an import * @deprecated @@ -12061,15 +13065,15 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly patch: operations["migrations/update-import"]; - readonly trace?: never; + patch: operations["migrations/update-import"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/import/authors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/import/authors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get commit authors @@ -12081,28 +13085,28 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly get: operations["migrations/get-commit-authors"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/import/authors/{author_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["migrations/get-commit-authors"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/import/authors/{author_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Map a commit author * @deprecated @@ -12112,15 +13116,15 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly patch: operations["migrations/map-commit-author"]; - readonly trace?: never; + patch: operations["migrations/map-commit-author"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/import/large_files": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/import/large_files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get large files @@ -12130,28 +13134,28 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly get: operations["migrations/get-large-files"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/import/lfs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["migrations/get-large-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/import/lfs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update Git LFS preference * @deprecated @@ -12164,15 +13168,15 @@ export interface paths { * > [!WARNING] * > **Endpoint closing down notice:** Due to very low levels of usage and available alternatives, this endpoint is closing down and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ - readonly patch: operations["migrations/set-lfs-preference"]; - readonly trace?: never; + patch: operations["migrations/set-lfs-preference"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository installation for the authenticated app @@ -12180,87 +13184,87 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-repo-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-repo-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/interaction-limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get interaction restrictions for a repository * @description Shows which type of GitHub user can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response. */ - readonly get: operations["interactions/get-restrictions-for-repo"]; + get: operations["interactions/get-restrictions-for-repo"]; /** * Set interaction restrictions for a repository * @description Temporarily restricts interactions to a certain type of GitHub user within the given repository. You must have owner or admin access to set these restrictions. If an interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly put: operations["interactions/set-restrictions-for-repo"]; - readonly post?: never; + put: operations["interactions/set-restrictions-for-repo"]; + post?: never; /** * Remove interaction restrictions for a repository * @description Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions. If the interaction limit is set for the user or organization that owns this repository, you will receive a `409 Conflict` response and will not be able to use this endpoint to change the interaction limit for a single repository. */ - readonly delete: operations["interactions/remove-restrictions-for-repo"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["interactions/remove-restrictions-for-repo"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository invitations * @description When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations. */ - readonly get: operations["repos/list-invitations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/invitations/{invitation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["repos/list-invitations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Delete a repository invitation */ - readonly delete: operations["repos/delete-invitation"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-invitation"]; + options?: never; + head?: never; /** Update a repository invitation */ - readonly patch: operations["repos/update-invitation"]; - readonly trace?: never; + patch: operations["repos/update-invitation"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository issues @@ -12276,8 +13280,8 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-for-repo"]; - readonly put?: never; + get: operations["issues/list-for-repo"]; + put?: never; /** * Create an issue * @description Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. @@ -12292,19 +13296,19 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["issues/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue comments for a repository @@ -12319,21 +13323,21 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-comments-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an issue comment @@ -12346,16 +13350,16 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/get-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["issues/get-comment"]; + put?: never; + post?: never; /** * Delete an issue comment * @description You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. */ - readonly delete: operations["issues/delete-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["issues/delete-comment"]; + options?: never; + head?: never; /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. @@ -12367,43 +13371,74 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["issues/update-comment"]; - readonly trace?: never; + patch: operations["issues/update-comment"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Pin an issue comment + * @description You can use the REST API to pin comments on issues. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + put: operations["issues/pin-comment"]; + post?: never; + /** + * Unpin an issue comment + * @description You can use the REST API to unpin comments on issues. + */ + delete: operations["issues/unpin-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for an issue comment * @description List the reactions to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ - readonly get: operations["reactions/list-for-issue-comment"]; - readonly put?: never; + get: operations["reactions/list-for-issue-comment"]; + put?: never; /** * Create reaction for an issue comment * @description Create a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). A response with an HTTP `200` status means that you already added the reaction type to this issue comment. */ - readonly post: operations["reactions/create-for-issue-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-issue-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete an issue comment reaction * @description > [!NOTE] @@ -12411,58 +13446,58 @@ export interface paths { * * Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). */ - readonly delete: operations["reactions/delete-for-issue-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-issue-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue events for a repository * @description Lists events for a repository. */ - readonly get: operations["issues/list-events-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-events-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/events/{event_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/events/{event_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an issue event * @description Gets a single event by the event id. */ - readonly get: operations["issues/get-event"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/get-event"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an issue @@ -12483,12 +13518,12 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["issues/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an issue * @description Issue owners and users with push access or Triage role can edit an issue. @@ -12500,39 +13535,39 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["issues/update"]; - readonly trace?: never; + patch: operations["issues/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Add assignees to an issue * @description Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. */ - readonly post: operations["issues/add-assignees"]; + post: operations["issues/add-assignees"]; /** * Remove assignees from an issue * @description Removes one or more assignees from an issue. */ - readonly delete: operations["issues/remove-assignees"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-assignees"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user can be assigned to a issue @@ -12542,21 +13577,21 @@ export interface paths { * * Otherwise a `404` status code is returned. */ - readonly get: operations["issues/check-user-can-be-assigned-to-issue"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/check-user-can-be-assigned-to-issue"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue comments @@ -12571,8 +13606,8 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-comments"]; - readonly put?: never; + get: operations["issues/list-comments"]; + put?: never; /** * Create an issue comment * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. @@ -12589,145 +13624,271 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["issues/create-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocked by + * @description You can use the REST API to list the dependencies an issue is blocked by. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocked-by"]; + put?: never; + /** + * Add a dependency an issue is blocked by + * @description You can use the REST API to add a 'blocked by' relationship to an issue. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-blocked-by-dependency"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove dependency an issue is blocked by + * @description You can use the REST API to remove a dependency that an issue is blocked by. + * + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-dependency-blocked-by"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocking + * @description You can use the REST API to list the dependencies an issue is blocking. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocking"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List issue events * @description Lists all events for an issue. */ - readonly get: operations["issues/list-events"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-events"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for an issue * @description Lists all labels for an issue. */ - readonly get: operations["issues/list-labels-on-issue"]; + get: operations["issues/list-labels-on-issue"]; /** * Set labels for an issue * @description Removes any previous labels and sets the new labels for an issue. */ - readonly put: operations["issues/set-labels"]; + put: operations["issues/set-labels"]; /** * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. + * @description Adds labels to an issue. */ - readonly post: operations["issues/add-labels"]; + post: operations["issues/add-labels"]; /** * Remove all labels from an issue * @description Removes all labels from an issue. */ - readonly delete: operations["issues/remove-all-labels"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-all-labels"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove a label from an issue * @description Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ - readonly delete: operations["issues/remove-label"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-label"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["issues/lock"]; - readonly post?: never; + put: operations["issues/lock"]; + post?: never; /** * Unlock an issue * @description Users with push access can unlock an issue's conversation. */ - readonly delete: operations["issues/unlock"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/unlock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get parent issue + * @description You can use the REST API to get the parent issue of a sub-issue. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/get-parent"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for an issue * @description List the reactions to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ - readonly get: operations["reactions/list-for-issue"]; - readonly put?: never; + get: operations["reactions/list-for-issue"]; + put?: never; /** * Create reaction for an issue * @description Create a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). A response with an HTTP `200` status means that you already added the reaction type to this issue. */ - readonly post: operations["reactions/create-for-issue"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete an issue reaction * @description > [!NOTE] @@ -12735,22 +13896,22 @@ export interface paths { * * Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). */ - readonly delete: operations["reactions/delete-for-issue"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issue": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Remove sub-issue * @description You can use the REST API to remove a sub-issue from an issue. @@ -12763,32 +13924,32 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly delete: operations["issues/remove-sub-issue"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["issues/remove-sub-issue"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List sub-issues * @description You can use the REST API to list the sub-issues on an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-sub-issues"]; - readonly put?: never; + get: operations["issues/list-sub-issues"]; + put?: never; /** * Add sub-issue * @description You can use the REST API to add sub-issues to issues. @@ -12804,173 +13965,173 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["issues/add-sub-issue"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + post: operations["issues/add-sub-issue"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/sub_issues/priority": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Reprioritize sub-issue * @description You can use the REST API to reprioritize a sub-issue to a different position in the parent list. */ - readonly patch: operations["issues/reprioritize-sub-issue"]; - readonly trace?: never; + patch: operations["issues/reprioritize-sub-issue"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List timeline events for an issue * @description List all timeline events for an issue. */ - readonly get: operations["issues/list-events-for-timeline"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["issues/list-events-for-timeline"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List deploy keys */ - readonly get: operations["repos/list-deploy-keys"]; - readonly put?: never; + get: operations["repos/list-deploy-keys"]; + put?: never; /** * Create a deploy key * @description You can create a read-only deploy key. */ - readonly post: operations["repos/create-deploy-key"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-deploy-key"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/keys/{key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get a deploy key */ - readonly get: operations["repos/get-deploy-key"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-deploy-key"]; + put?: never; + post?: never; /** * Delete a deploy key * @description Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead. */ - readonly delete: operations["repos/delete-deploy-key"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-deploy-key"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for a repository * @description Lists all labels for a repository. */ - readonly get: operations["issues/list-labels-for-repo"]; - readonly put?: never; + get: operations["issues/list-labels-for-repo"]; + put?: never; /** * Create a label * @description Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). */ - readonly post: operations["issues/create-label"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create-label"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/labels/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/labels/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a label * @description Gets a label using the given name. */ - readonly get: operations["issues/get-label"]; - readonly put?: never; - readonly post?: never; + get: operations["issues/get-label"]; + put?: never; + post?: never; /** * Delete a label * @description Deletes a label using the given label name. */ - readonly delete: operations["issues/delete-label"]; - readonly options?: never; - readonly head?: never; + delete: operations["issues/delete-label"]; + options?: never; + head?: never; /** * Update a label * @description Updates a label using the given label name. */ - readonly patch: operations["issues/update-label"]; - readonly trace?: never; + patch: operations["issues/update-label"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/languages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/languages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository languages * @description Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language. */ - readonly get: operations["repos/list-languages"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-languages"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/license": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/license": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the license for a repository @@ -12981,151 +14142,151 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw contents of the license. * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ - readonly get: operations["licenses/get-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/merge-upstream": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["licenses/get-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/merge-upstream": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Sync a fork branch with the upstream repository * @description Sync a branch of a forked repository to keep it up-to-date with the upstream repository. */ - readonly post: operations["repos/merge-upstream"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/merges": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + post: operations["repos/merge-upstream"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/merges": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** Merge a branch */ - readonly post: operations["repos/merge"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/merge"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/milestones": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/milestones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List milestones * @description Lists milestones for a repository. */ - readonly get: operations["issues/list-milestones"]; - readonly put?: never; + get: operations["issues/list-milestones"]; + put?: never; /** * Create a milestone * @description Creates a milestone. */ - readonly post: operations["issues/create-milestone"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["issues/create-milestone"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/milestones/{milestone_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a milestone * @description Gets a milestone using the given milestone number. */ - readonly get: operations["issues/get-milestone"]; - readonly put?: never; - readonly post?: never; + get: operations["issues/get-milestone"]; + put?: never; + post?: never; /** * Delete a milestone * @description Deletes a milestone using the given milestone number. */ - readonly delete: operations["issues/delete-milestone"]; - readonly options?: never; - readonly head?: never; + delete: operations["issues/delete-milestone"]; + options?: never; + head?: never; /** Update a milestone */ - readonly patch: operations["issues/update-milestone"]; - readonly trace?: never; + patch: operations["issues/update-milestone"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List labels for issues in a milestone * @description Lists labels for issues in a milestone. */ - readonly get: operations["issues/list-labels-for-milestone"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-labels-for-milestone"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/notifications": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/notifications": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository notifications for the authenticated user * @description Lists all notifications for the current user in the specified repository. */ - readonly get: operations["activity/list-repo-notifications-for-authenticated-user"]; + get: operations["activity/list-repo-notifications-for-authenticated-user"]; /** * Mark repository notifications as read * @description Marks all notifications in a repository as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. */ - readonly put: operations["activity/mark-repo-notifications-as-read"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["activity/mark-repo-notifications-as-read"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a GitHub Pages site @@ -13133,7 +14294,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-pages"]; + get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). @@ -13142,7 +14303,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly put: operations["repos/update-information-about-pages-site"]; + put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." @@ -13151,7 +14312,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["repos/create-pages-site"]; + post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). @@ -13160,18 +14321,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly delete: operations["repos/delete-pages-site"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/delete-pages-site"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/builds": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/builds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GitHub Pages builds @@ -13179,27 +14340,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/list-pages-builds"]; - readonly put?: never; + get: operations["repos/list-pages-builds"]; + put?: never; /** * Request a GitHub Pages build * @description You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures. * * Build requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes. */ - readonly post: operations["repos/request-pages-build"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/request-pages-build"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/builds/latest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/builds/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get latest Pages build @@ -13207,21 +14368,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-latest-pages-build"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-latest-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/builds/{build_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get GitHub Pages build @@ -13229,43 +14390,43 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-pages-build"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/pages/deployments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-pages-build"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/pages/deployments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * * The authenticated user must have write permission to the repository. */ - readonly post: operations["repos/create-pages-deployment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the status of a GitHub Pages deployment @@ -13273,43 +14434,43 @@ export interface paths { * * The authenticated user must have read permission for the GitHub Pages site. */ - readonly get: operations["repos/get-pages-deployment"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-pages-deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Cancel a GitHub Pages deployment * @description Cancels a GitHub Pages deployment. * * The authenticated user must have write permissions for the GitHub Pages site. */ - readonly post: operations["repos/cancel-pages-deployment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/cancel-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/health": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pages/health": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a DNS health check for GitHub Pages @@ -13321,85 +14482,61 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["repos/get-pages-health-check"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-pages-health-check"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if private vulnerability reporting is enabled for a repository * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". */ - readonly get: operations["repos/check-private-vulnerability-reporting"]; + get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." */ - readonly put: operations["repos/enable-private-vulnerability-reporting"]; - readonly post?: never; + put: operations["repos/enable-private-vulnerability-reporting"]; + post?: never; /** * Disable private vulnerability reporting for a repository * @description Disables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". */ - readonly delete: operations["repos/disable-private-vulnerability-reporting"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-private-vulnerability-reporting"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly get: operations["projects/list-for-repo"]; - readonly put?: never; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly post: operations["projects/create-for-repo"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/properties/values": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/properties/values": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all custom property values for a repository * @description Gets all custom property values that are set for a repository. * Users with read access to the repository can use this endpoint. */ - readonly get: operations["repos/get-custom-properties-values"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["repos/custom-properties-for-repos-get-repository-values"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Create or update custom property values for a repository * @description Create new or update existing custom property values for a repository. @@ -13407,15 +14544,15 @@ export interface paths { * * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ - readonly patch: operations["repos/create-or-update-custom-properties-values"]; - readonly trace?: never; + patch: operations["repos/custom-properties-for-repos-create-or-update-repository-values"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pull requests @@ -13434,8 +14571,8 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list"]; - readonly put?: never; + get: operations["pulls/list"]; + put?: never; /** * Create a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -13451,19 +14588,19 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List review comments in a repository @@ -13477,21 +14614,21 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-review-comments-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-review-comments-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a review comment for a pull request @@ -13504,16 +14641,16 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/get-review-comment"]; - readonly put?: never; - readonly post?: never; + get: operations["pulls/get-review-comment"]; + put?: never; + post?: never; /** * Delete a review comment for a pull request * @description Deletes a review comment. */ - readonly delete: operations["pulls/delete-review-comment"]; - readonly options?: never; - readonly head?: never; + delete: operations["pulls/delete-review-comment"]; + options?: never; + head?: never; /** * Update a review comment for a pull request * @description Edits the content of a specified review comment. @@ -13525,43 +14662,43 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["pulls/update-review-comment"]; - readonly trace?: never; + patch: operations["pulls/update-review-comment"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for a pull request review comment * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ - readonly get: operations["reactions/list-for-pull-request-review-comment"]; - readonly put?: never; + get: operations["reactions/list-for-pull-request-review-comment"]; + put?: never; /** * Create reaction for a pull request review comment * @description Create a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment. */ - readonly post: operations["reactions/create-for-pull-request-review-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-pull-request-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a pull request comment reaction * @description > [!NOTE] @@ -13569,18 +14706,18 @@ export interface paths { * * Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ - readonly delete: operations["reactions/delete-for-pull-request-comment"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-pull-request-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a pull request @@ -13608,12 +14745,12 @@ export interface paths { * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ - readonly get: operations["pulls/get"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["pulls/get"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a pull request * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -13627,37 +14764,37 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly patch: operations["pulls/update"]; - readonly trace?: never; + patch: operations["pulls/update"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-with-pr-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/create-with-pr-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List review comments on a pull request @@ -13671,8 +14808,8 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-review-comments"]; - readonly put?: never; + get: operations["pulls/list-review-comments"]; + put?: never; /** * Create a review comment for a pull request * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." @@ -13691,22 +14828,22 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create-review-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a reply for a review comment * @description Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. @@ -13721,19 +14858,19 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create-reply-for-review-comment"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create-reply-for-review-comment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List commits on a pull request @@ -13748,21 +14885,21 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/files": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pull requests files @@ -13778,75 +14915,75 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-files"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-files"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a pull request has been merged * @description Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty. */ - readonly get: operations["pulls/check-if-merged"]; + get: operations["pulls/check-if-merged"]; /** * Merge a pull request * @description Merges a pull request into the base branch. * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ - readonly put: operations["pulls/merge"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["pulls/merge"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all requested reviewers for a pull request * @description Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request) operation. */ - readonly get: operations["pulls/list-requested-reviewers"]; - readonly put?: never; + get: operations["pulls/list-requested-reviewers"]; + put?: never; /** * Request reviewers for a pull request * @description Requests reviews for a pull request from a given set of users and/or teams. * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ - readonly post: operations["pulls/request-reviewers"]; + post: operations["pulls/request-reviewers"]; /** * Remove requested reviewers from a pull request * @description Removes review requests from a pull request for a given set of users and/or teams. */ - readonly delete: operations["pulls/remove-requested-reviewers"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["pulls/remove-requested-reviewers"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reviews for a pull request @@ -13859,8 +14996,8 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-reviews"]; - readonly put?: never; + get: operations["pulls/list-reviews"]; + put?: never; /** * Create a review for a pull request * @description Creates a review on a specified pull request. @@ -13881,19 +15018,19 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/create-review"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/create-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a review for a pull request @@ -13906,7 +15043,7 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/get-review"]; + get: operations["pulls/get-review"]; /** * Update a review for a pull request * @description Updates the contents of a specified review summary comment. @@ -13918,8 +15055,8 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly put: operations["pulls/update-review"]; - readonly post?: never; + put: operations["pulls/update-review"]; + post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. @@ -13931,18 +15068,18 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly delete: operations["pulls/delete-pending-review"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["pulls/delete-pending-review"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List comments for a pull request review @@ -13955,23 +15092,23 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["pulls/list-comments-for-review"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["pulls/list-comments-for-review"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Dismiss a review for a pull request * @description Dismisses a specified review on a pull request. @@ -13986,23 +15123,23 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly put: operations["pulls/dismiss-review"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["pulls/dismiss-review"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." @@ -14014,40 +15151,40 @@ export interface paths { * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly post: operations["pulls/submit-review"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["pulls/submit-review"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * 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; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["pulls/update-branch"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/readme": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/readme": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository README @@ -14058,21 +15195,21 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ - readonly get: operations["repos/get-readme"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-readme"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/readme/{dir}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/readme/{dir}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository README for a directory @@ -14083,21 +15220,21 @@ export interface paths { * - **`application/vnd.github.raw+json`**: Returns the raw file contents. This is the default if you do not specify a media type. * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ - readonly get: operations["repos/get-readme-in-directory"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-readme-in-directory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List releases @@ -14105,27 +15242,27 @@ export interface paths { * * Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. */ - readonly get: operations["repos/list-releases"]; - readonly put?: never; + get: operations["repos/list-releases"]; + put?: never; /** * Create a release * @description Users with push access to the repository can create a release. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." */ - readonly post: operations["repos/create-release"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/assets/{asset_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a release asset @@ -14137,46 +15274,46 @@ export interface paths { * The API will either redirect the client to the location, or stream it directly if possible. * API clients should handle both a `200` or `302` response. */ - readonly get: operations["repos/get-release-asset"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-release-asset"]; + put?: never; + post?: never; /** Delete a release asset */ - readonly delete: operations["repos/delete-release-asset"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-release-asset"]; + options?: never; + head?: never; /** * Update a release asset * @description Users with push access to the repository can edit a release asset. */ - readonly patch: operations["repos/update-release-asset"]; - readonly trace?: never; + patch: operations["repos/update-release-asset"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/generate-notes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/generate-notes": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Generate release notes content for a release * @description Generate a name and body describing a [release](https://docs.github.com/rest/releases/releases#get-a-release). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. */ - readonly post: operations["repos/generate-release-notes"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/generate-release-notes"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/latest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/latest": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the latest release @@ -14184,41 +15321,41 @@ export interface paths { * * The latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. */ - readonly get: operations["repos/get-latest-release"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-latest-release"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/tags/{tag}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/tags/{tag}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a release by tag name * @description Get a published release with the specified tag. */ - readonly get: operations["repos/get-release-by-tag"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-release-by-tag"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a release @@ -14227,33 +15364,33 @@ export interface paths { * > [!NOTE] * > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ - readonly get: operations["repos/get-release"]; - readonly put?: never; - readonly post?: never; + get: operations["repos/get-release"]; + put?: never; + post?: never; /** * Delete a release * @description Users with push access to the repository can delete a release. */ - readonly delete: operations["repos/delete-release"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/delete-release"]; + options?: never; + head?: never; /** * Update a release * @description Users with push access to the repository can edit a release. */ - readonly patch: operations["repos/update-release"]; - readonly trace?: never; + patch: operations["repos/update-release"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/assets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List release assets */ - readonly get: operations["repos/list-release-assets"]; - readonly put?: never; + get: operations["repos/list-release-assets"]; + put?: never; /** * Upload a release asset * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in @@ -14276,47 +15413,47 @@ export interface paths { * * To find the `release_id` query the [`GET /repos/{owner}/{repo}/releases/latest` endpoint](https://docs.github.com/rest/releases/releases#get-the-latest-release). * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. */ - readonly post: operations["repos/upload-release-asset"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/upload-release-asset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}/reactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List reactions for a release * @description List the reactions to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ - readonly get: operations["reactions/list-for-release"]; - readonly put?: never; + get: operations["reactions/list-for-release"]; + put?: never; /** * Create reaction for a release * @description Create a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). A response with a `Status: 200 OK` means that you already added the reaction type to this release. */ - readonly post: operations["reactions/create-for-release"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["reactions/create-for-release"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Delete a release reaction * @description > [!NOTE] @@ -14324,18 +15461,18 @@ export interface paths { * * Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). */ - readonly delete: operations["reactions/delete-for-release"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["reactions/delete-for-release"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rules/branches/{branch}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rules/branches/{branch}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get rules for a branch @@ -14344,87 +15481,87 @@ export interface paths { * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled" * enforcement statuses are not returned. */ - readonly get: operations["repos/get-branch-rules"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-branch-rules"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all repository rulesets * @description Get all the rulesets for a repository. */ - readonly get: operations["repos/get-repo-rulesets"]; - readonly put?: never; + get: operations["repos/get-repo-rulesets"]; + put?: never; /** * Create a repository ruleset * @description Create a ruleset for a repository. */ - readonly post: operations["repos/create-repo-ruleset"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-repo-ruleset"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets/rule-suites": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets/rule-suites": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository rule suites * @description Lists suites of rule evaluations at the repository level. * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-repo-rule-suites"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-repo-rule-suites"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository rule suite * @description Gets information about a suite of rule evaluations from within a repository. * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." */ - readonly get: operations["repos/get-repo-rule-suite"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-repo-rule-suite"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository ruleset @@ -14433,29 +15570,69 @@ export interface paths { * **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user * making the API request has write access to the ruleset. */ - readonly get: operations["repos/get-repo-ruleset"]; + get: operations["repos/get-repo-ruleset"]; /** * Update a repository ruleset * @description Update a ruleset for a repository. */ - readonly put: operations["repos/update-repo-ruleset"]; - readonly post?: never; + put: operations["repos/update-repo-ruleset"]; + post?: never; /** * Delete a repository ruleset * @description Delete a ruleset for a repository. */ - readonly delete: operations["repos/delete-repo-ruleset"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + delete: operations["repos/delete-repo-ruleset"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset history + * @description Get the history of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset version + * @description Get a version of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/secret-scanning/alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List secret scanning alerts for a repository @@ -14465,21 +15642,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/list-alerts-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["secret-scanning/list-alerts-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a secret scanning alert @@ -14489,29 +15666,31 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/get-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["secret-scanning/get-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * + * You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + * * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly patch: operations["secret-scanning/update-alert"]; - readonly trace?: never; + patch: operations["secret-scanning/update-alert"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List locations for a secret scanning alert @@ -14521,24 +15700,24 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/list-locations-for-alert"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["secret-scanning/list-locations-for-alert"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/secret-scanning/push-protection-bypasses": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a push protection bypass * @description Creates a bypass for a previously push protected secret. @@ -14547,41 +15726,44 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly post: operations["secret-scanning/create-push-protection-bypass"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["secret-scanning/create-push-protection-bypass"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/secret-scanning/scan-history": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/secret-scanning/scan-history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get secret scanning scan history for a repository * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * + * > [!NOTE] + * > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ - readonly get: operations["secret-scanning/get-scan-history"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["secret-scanning/get-scan-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository security advisories @@ -14591,8 +15773,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ - readonly get: operations["security-advisories/list-repository-advisories"]; - readonly put?: never; + get: operations["security-advisories/list-repository-advisories"]; + put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. @@ -14601,40 +15783,40 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly post: operations["security-advisories/create-repository-advisory"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-repository-advisory"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/reports": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/reports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Privately report a security vulnerability * @description Report a security vulnerability to the maintainers of the repository. * See "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)" for more information about private vulnerability reporting. */ - readonly post: operations["security-advisories/create-private-vulnerability-report"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-private-vulnerability-report"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository security advisory @@ -14647,12 +15829,12 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ - readonly get: operations["security-advisories/get-repository-advisory"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["security-advisories/get-repository-advisory"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. @@ -14662,18 +15844,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly patch: operations["security-advisories/update-repository-advisory"]; - readonly trace?: never; + patch: operations["security-advisories/update-repository-advisory"]; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Request a CVE for a repository security advisory * @description If you want a CVE identification number for the security vulnerability in your project, and don't already have one, you can request a CVE identification number from GitHub. For more information see "[Requesting a CVE identification number](https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#requesting-a-cve-identification-number-optional)." @@ -14684,22 +15866,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ - readonly post: operations["security-advisories/create-repository-advisory-cve-request"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-repository-advisory-cve-request"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Create a temporary private fork * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. @@ -14707,19 +15889,19 @@ export interface paths { * > [!NOTE] * > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. */ - readonly post: operations["security-advisories/create-fork"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["security-advisories/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stargazers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stargazers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List stargazers @@ -14729,21 +15911,21 @@ export interface paths { * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ - readonly get: operations["activity/list-stargazers-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-stargazers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/code_frequency": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/code_frequency": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the weekly commit activity @@ -14752,41 +15934,41 @@ export interface paths { * > [!NOTE] * > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. */ - readonly get: operations["repos/get-code-frequency-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-code-frequency-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/commit_activity": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/commit_activity": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the last year of commit activity * @description Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`. */ - readonly get: operations["repos/get-commit-activity-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-commit-activity-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/contributors": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/contributors": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all contributor commit activity @@ -14800,21 +15982,21 @@ export interface paths { * > [!NOTE] * > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ - readonly get: operations["repos/get-contributors-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-contributors-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/participation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/participation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the weekly commit count @@ -14824,21 +16006,21 @@ export interface paths { * * The most recent week is seven days ago at UTC midnight to today at UTC midnight. */ - readonly get: operations["repos/get-participation-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-participation-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/stats/punch_card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/stats/punch_card": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the hourly commit count for each day @@ -14850,168 +16032,108 @@ export interface paths { * * For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - readonly get: operations["repos/get-punch-card-stats"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/statuses/{sha}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-punch-card-stats"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/statuses/{sha}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a commit status * @description Users with push access in a repository can create commit statuses for a given SHA. * * Note: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error. */ - readonly post: operations["repos/create-commit-status"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-commit-status"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/subscribers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/subscribers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List watchers * @description Lists the people watching the specified repository. */ - readonly get: operations["activity/list-watchers-for-repo"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-watchers-for-repo"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/subscription": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a repository subscription * @description Gets information about whether the authenticated user is subscribed to the repository. */ - readonly get: operations["activity/get-repo-subscription"]; + get: operations["activity/get-repo-subscription"]; /** * Set a repository subscription * @description If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/rest/activity/watching#delete-a-repository-subscription) completely. */ - readonly put: operations["activity/set-repo-subscription"]; - readonly post?: never; + put: operations["activity/set-repo-subscription"]; + post?: never; /** * Delete a repository subscription * @description This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/rest/activity/watching#set-a-repository-subscription). */ - readonly delete: operations["activity/delete-repo-subscription"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["activity/delete-repo-subscription"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/tags": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/tags": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** List repository tags */ - readonly get: operations["repos/list-tags"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/tags/protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Closing down - List tag protection states for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - * - * This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ - readonly get: operations["repos/list-tag-protection"]; - readonly put?: never; - /** - * Closing down - Create a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - * - * This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - readonly post: operations["repos/create-tag-protection"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - /** - * Closing down - Delete a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - * - * This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - readonly delete: operations["repos/delete-tag-protection"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/tarball/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/list-tags"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/tarball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download a repository archive (tar) @@ -15022,21 +16144,21 @@ export interface paths { * > [!NOTE] * > For private repositories, these links are temporary and expire after five minutes. */ - readonly get: operations["repos/download-tarball-archive"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/download-tarball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository teams @@ -15046,169 +16168,169 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ - readonly get: operations["repos/list-teams"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/topics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["repos/list-teams"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Get all repository topics */ - readonly get: operations["repos/get-all-topics"]; + get: operations["repos/get-all-topics"]; /** Replace all repository topics */ - readonly put: operations["repos/replace-all-topics"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/traffic/clones": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + put: operations["repos/replace-all-topics"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/traffic/clones": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get repository clones * @description Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly get: operations["repos/get-clones"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-clones"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/traffic/popular/paths": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/traffic/popular/paths": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get top referral paths * @description Get the top 10 popular contents over the last 14 days. */ - readonly get: operations["repos/get-top-paths"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-top-paths"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/traffic/popular/referrers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/traffic/popular/referrers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get top referral sources * @description Get the top 10 referrers over the last 14 days. */ - readonly get: operations["repos/get-top-referrers"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/get-top-referrers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/traffic/views": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/traffic/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get page views * @description Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday. */ - readonly get: operations["repos/get-views"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{owner}/{repo}/transfer": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/get-views"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/transfer": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). */ - readonly post: operations["repos/transfer"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/transfer"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if vulnerability alerts are enabled for a repository * @description Shows whether dependency alerts are enabled or disabled for a repository. The authenticated user must have admin read access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly get: operations["repos/check-vulnerability-alerts"]; + get: operations["repos/check-vulnerability-alerts"]; /** * Enable vulnerability alerts * @description Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly put: operations["repos/enable-vulnerability-alerts"]; - readonly post?: never; + put: operations["repos/enable-vulnerability-alerts"]; + post?: never; /** * Disable vulnerability alerts * @description Disables dependency alerts and the dependency graph for a repository. * The authenticated user must have admin access to the repository. For more information, * see "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". */ - readonly delete: operations["repos/disable-vulnerability-alerts"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["repos/disable-vulnerability-alerts"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repos/{owner}/{repo}/zipball/{ref}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repos/{owner}/{repo}/zipball/{ref}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download a repository archive (zip) @@ -15219,43 +16341,43 @@ export interface paths { * > [!NOTE] * > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. */ - readonly get: operations["repos/download-zipball-archive"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repos/{template_owner}/{template_repo}/generate": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["repos/download-zipball-archive"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{template_owner}/{template_repo}/generate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ - readonly post: operations["repos/create-using-template"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-using-template"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public repositories @@ -15265,21 +16387,21 @@ export interface paths { * - For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. * - Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of repositories. */ - readonly get: operations["repos/list-public"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["repos/list-public"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/code": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/code": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search code @@ -15304,21 +16426,21 @@ export interface paths { * * This endpoint requires you to authenticate and limits you to 10 requests per minute. */ - readonly get: operations["search/code"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/code"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/commits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/commits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search commits @@ -15331,21 +16453,21 @@ export interface paths { * * `q=repo:octocat/Spoon-Knife+css` */ - readonly get: operations["search/commits"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/commits"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search issues and pull requests @@ -15363,21 +16485,21 @@ export interface paths { * > [!NOTE] * > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." */ - readonly get: operations["search/issues-and-pull-requests"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/issues-and-pull-requests"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/labels": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search labels @@ -15391,21 +16513,21 @@ export interface paths { * * The labels that best match the query appear first in the search results. */ - readonly get: operations["search/labels"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/labels"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search repositories @@ -15419,21 +16541,21 @@ export interface paths { * * This query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results. */ - readonly get: operations["search/repos"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/repos"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/topics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/topics": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search topics @@ -15447,21 +16569,21 @@ export interface paths { * * This query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results. */ - readonly get: operations["search/topics"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/topics"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/search/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/search/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Search users @@ -15477,21 +16599,21 @@ export interface paths { * * This endpoint does not accept authentication and will only include publicly visible users. As an alternative, you can use the GraphQL API. The GraphQL API requires authentication and will return private users, including Enterprise Managed Users (EMUs), that you are authorized to view. For more information, see "[GraphQL Queries](https://docs.github.com/graphql/reference/queries#search)." */ - readonly get: operations["search/users"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["search/users"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a team (Legacy) @@ -15499,9 +16621,9 @@ export interface paths { * @description > [!WARNING] * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. */ - readonly get: operations["teams/get-legacy"]; - readonly put?: never; - readonly post?: never; + get: operations["teams/get-legacy"]; + put?: never; + post?: never; /** * Delete a team (Legacy) * @deprecated @@ -15512,9 +16634,9 @@ export interface paths { * * If you are an organization owner, deleting a parent team will delete all of its child teams as well. */ - readonly delete: operations["teams/delete-legacy"]; - readonly options?: never; - readonly head?: never; + delete: operations["teams/delete-legacy"]; + options?: never; + head?: never; /** * Update a team (Legacy) * @deprecated @@ -15526,259 +16648,15 @@ export interface paths { * > [!NOTE] * > With nested teams, the `privacy` for parent teams cannot be `secret`. */ - readonly patch: operations["teams/update-legacy"]; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussions-legacy"]; - readonly put?: never; - /** - * Create a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-legacy"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-legacy"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-legacy"]; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/list-discussion-comments-legacy"]; - readonly put?: never; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["teams/create-discussion-comment-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["teams/get-discussion-comment-legacy"]; - readonly put?: never; - readonly post?: never; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly delete: operations["teams/delete-discussion-comment-legacy"]; - readonly options?: never; - readonly head?: never; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly patch: operations["teams/update-discussion-comment-legacy"]; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-comment-legacy"]; - readonly put?: never; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-comment-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/discussions/{discussion_number}/reactions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - readonly get: operations["reactions/list-for-team-discussion-legacy"]; - readonly put?: never; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - readonly post: operations["reactions/create-for-team-discussion-legacy"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + patch: operations["teams/update-legacy"]; + trace?: never; }; - readonly "/teams/{team_id}/invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List pending team invitations (Legacy) @@ -15788,21 +16666,21 @@ export interface paths { * * 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`. */ - readonly get: operations["teams/list-pending-invitations-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-pending-invitations-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/members": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/members": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team members (Legacy) @@ -15812,21 +16690,21 @@ export interface paths { * * Team members will include the members of child teams. */ - readonly get: operations["teams/list-members-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-members-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/members/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/members/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get team member (Legacy) @@ -15837,7 +16715,7 @@ export interface paths { * * To list members in a team, the team must be visible to the authenticated user. */ - readonly get: operations["teams/get-member-legacy"]; + get: operations["teams/get-member-legacy"]; /** * Add team member (Legacy) * @deprecated @@ -15854,8 +16732,8 @@ export interface paths { * * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["teams/add-member-legacy"]; - readonly post?: never; + put: operations["teams/add-member-legacy"]; + post?: never; /** * Remove team member (Legacy) * @deprecated @@ -15870,18 +16748,18 @@ export interface paths { * > [!NOTE] * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly delete: operations["teams/remove-member-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-member-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/memberships/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get team membership for a user (Legacy) @@ -15898,7 +16776,7 @@ export interface paths { * * The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). */ - readonly get: operations["teams/get-membership-for-user-legacy"]; + get: operations["teams/get-membership-for-user-legacy"]; /** * Add or update team membership for a user (Legacy) * @deprecated @@ -15916,8 +16794,8 @@ export interface paths { * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. */ - readonly put: operations["teams/add-or-update-membership-for-user-legacy"]; - readonly post?: never; + put: operations["teams/add-or-update-membership-for-user-legacy"]; + post?: never; /** * Remove team membership for a user (Legacy) * @deprecated @@ -15931,82 +16809,18 @@ export interface paths { * > [!NOTE] * > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." */ - readonly delete: operations["teams/remove-membership-for-user-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List team projects (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ - readonly get: operations["teams/list-projects-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/teams/{team_id}/projects/{project_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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. - */ - readonly get: operations["teams/check-permissions-for-project-legacy"]; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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. - */ - readonly put: operations["teams/add-or-update-project-permissions-legacy"]; - readonly post?: never; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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. - */ - readonly delete: operations["teams/remove-project-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-membership-for-user-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List team repositories (Legacy) @@ -16014,21 +16828,21 @@ export interface paths { * @description > [!WARNING] * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. */ - readonly get: operations["teams/list-repos-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-repos-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/repos/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/repos/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check team permissions for a repository (Legacy) @@ -16041,7 +16855,7 @@ export interface paths { * * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: */ - readonly get: operations["teams/check-permissions-for-repo-legacy"]; + get: operations["teams/check-permissions-for-repo-legacy"]; /** * Add or update team repository permissions (Legacy) * @deprecated @@ -16052,8 +16866,8 @@ export interface paths { * * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["teams/add-or-update-repo-permissions-legacy"]; - readonly post?: never; + put: operations["teams/add-or-update-repo-permissions-legacy"]; + post?: never; /** * Remove a repository from a team (Legacy) * @deprecated @@ -16062,18 +16876,18 @@ export interface paths { * * 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. */ - readonly delete: operations["teams/remove-repo-legacy"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["teams/remove-repo-legacy"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/teams/{team_id}/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/teams/{team_id}/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List child teams (Legacy) @@ -16081,93 +16895,93 @@ export interface paths { * @description > [!WARNING] * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. */ - readonly get: operations["teams/list-child-legacy"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-child-legacy"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ - readonly get: operations["users/get-authenticated"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["users/get-authenticated"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update the authenticated user * @description **Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. */ - readonly patch: operations["users/update-authenticated"]; - readonly trace?: never; + patch: operations["users/update-authenticated"]; + trace?: never; }; - readonly "/user/blocks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/blocks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users blocked by the authenticated user * @description List the users you've blocked on your personal account. */ - readonly get: operations["users/list-blocked-by-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-blocked-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/blocks/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/blocks/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a user is blocked by the authenticated user * @description Returns a 204 if the given user is blocked by the authenticated user. Returns a 404 if the given user is not blocked by the authenticated user, or if the given user account has been identified as spam by GitHub. */ - readonly get: operations["users/check-blocked"]; + get: operations["users/check-blocked"]; /** * Block a user * @description Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. */ - readonly put: operations["users/block"]; - readonly post?: never; + put: operations["users/block"]; + post?: never; /** * Unblock a user * @description Unblocks the given user and returns a 204. */ - readonly delete: operations["users/unblock"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/unblock"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List codespaces for the authenticated user @@ -16175,8 +16989,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/list-for-authenticated-user"]; - readonly put?: never; + get: operations["codespaces/list-for-authenticated-user"]; + put?: never; /** * Create a codespace for the authenticated user * @description Creates a new codespace, owned by the authenticated user. @@ -16185,19 +16999,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/create-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List secrets for the authenticated user @@ -16208,21 +17022,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/list-secrets-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/list-secrets-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get public key for the authenticated user @@ -16232,21 +17046,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/get-public-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-public-key-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a secret for the authenticated user @@ -16256,7 +17070,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/get-secret-for-authenticated-user"]; + get: operations["codespaces/get-secret-for-authenticated-user"]; /** * Create or update a secret for the authenticated user * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using @@ -16266,8 +17080,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; - readonly post?: never; + put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; + post?: never; /** * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. @@ -16276,18 +17090,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-secret-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/delete-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/{secret_name}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/{secret_name}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List selected repositories for a user secret @@ -16297,7 +17111,7 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; + get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. @@ -16306,22 +17120,22 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/secrets/{secret_name}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. @@ -16330,8 +17144,8 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; - readonly post?: never; + put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; + post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. @@ -16340,18 +17154,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ - readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a codespace for the authenticated user @@ -16359,18 +17173,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/get-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["codespaces/get-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly delete: operations["codespaces/delete-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; + delete: operations["codespaces/delete-for-authenticated-user"]; + options?: never; + head?: never; /** * Update a codespace for the authenticated user * @description Updates a codespace owned by the authenticated user. Currently only the codespace's machine type and recent folders can be modified using this endpoint. @@ -16379,18 +17193,18 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly patch: operations["codespaces/update-for-authenticated-user"]; - readonly trace?: never; + patch: operations["codespaces/update-for-authenticated-user"]; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/exports": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/exports": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Export a codespace for the authenticated user * @description Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. @@ -16399,19 +17213,19 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/export-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/export-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/exports/{export_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/exports/{export_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get details about a codespace export @@ -16419,21 +17233,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/get-export-details-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["codespaces/get-export-details-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/machines": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/machines": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List machine types for a codespace @@ -16441,24 +17255,24 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly get: operations["codespaces/codespace-machines-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/codespaces/{codespace_name}/publish": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; + get: operations["codespaces/codespace-machines-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/codespaces/{codespace_name}/publish": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; /** * Create a repository from an unpublished codespace * @description Publishes an unpublished codespace, creating a new repository and assigning it to the codespace. @@ -16469,63 +17283,63 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/publish-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/publish-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/start": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/start": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Start a codespace for the authenticated user * @description Starts a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/start-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/codespaces/{codespace_name}/stop": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/codespaces/{codespace_name}/stop": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Stop a codespace for the authenticated user * @description Stops a user's codespace. * * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ - readonly post: operations["codespaces/stop-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["codespaces/stop-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/docker/conflicts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get list of conflicting packages during Docker migration for authenticated-user @@ -16533,41 +17347,41 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ - readonly get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/email/visibility": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/email/visibility": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Set primary email visibility for the authenticated user * @description Sets the visibility for your primary email addresses. */ - readonly patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; - readonly trace?: never; + patch: operations["users/set-primary-email-visibility-for-authenticated-user"]; + trace?: never; }; - readonly "/user/emails": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List email addresses for the authenticated user @@ -16576,96 +17390,96 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ - readonly get: operations["users/list-emails-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-emails-for-authenticated-user"]; + put?: never; /** * Add an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly post: operations["users/add-email-for-authenticated-user"]; + post: operations["users/add-email-for-authenticated-user"]; /** * Delete an email address for the authenticated user * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly delete: operations["users/delete-email-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-email-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/followers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List followers of the authenticated user * @description Lists the people following the authenticated user. */ - readonly get: operations["users/list-followers-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-followers-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/following": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List the people the authenticated user follows * @description Lists the people who the authenticated user follows. */ - readonly get: operations["users/list-followed-by-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/following/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/list-followed-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/following/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Check if a person is followed by the authenticated user */ - readonly get: operations["users/check-person-is-followed-by-authenticated"]; + get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ - readonly put: operations["users/follow"]; - readonly post?: never; + put: operations["users/follow"]; + post?: never; /** * Unfollow a user * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ - readonly delete: operations["users/unfollow"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/unfollow"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/gpg_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GPG keys for the authenticated user @@ -16673,27 +17487,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ - readonly get: operations["users/list-gpg-keys-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-gpg-keys-for-authenticated-user"]; + put?: never; /** * Create a GPG key for the authenticated user * @description Adds a GPG key to the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ - readonly post: operations["users/create-gpg-key-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["users/create-gpg-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/gpg_keys/{gpg_key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/gpg_keys/{gpg_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a GPG key for the authenticated user @@ -16701,27 +17515,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ - readonly get: operations["users/get-gpg-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["users/get-gpg-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a GPG key for the authenticated user * @description Removes a GPG key from the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ - readonly delete: operations["users/delete-gpg-key-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-gpg-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/installations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/installations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List app installations accessible to the user access token @@ -16731,21 +17545,21 @@ export interface paths { * * You can find the permissions for the installation under the `permissions` key. */ - readonly get: operations["apps/list-installations-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/installations/{installation_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/installations/{installation_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories accessible to the user access token @@ -16755,77 +17569,77 @@ export interface paths { * * The access the user has to each repository is included in the hash under the `permissions` key. */ - readonly get: operations["apps/list-installation-repos-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-installation-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/installations/{installation_id}/repositories/{repository_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/installations/{installation_id}/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; + get?: never; /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. * * This endpoint only works for PATs (classic) with the `repo` scope. */ - readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"]; - readonly post?: never; + put: operations["apps/add-repo-to-installation-for-authenticated-user"]; + post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. * * This endpoint only works for PATs (classic) with the `repo` scope. */ - readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/interaction-limits": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/interaction-limits": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get interaction restrictions for your public repositories * @description Shows which type of GitHub user can interact with your public repositories and when the restriction expires. */ - readonly get: operations["interactions/get-restrictions-for-authenticated-user"]; + get: operations["interactions/get-restrictions-for-authenticated-user"]; /** * Set interaction restrictions for your public repositories * @description Temporarily restricts which type of GitHub user can interact with your public repositories. Setting the interaction limit at the user level will overwrite any interaction limits that are set for individual repositories owned by the user. */ - readonly put: operations["interactions/set-restrictions-for-authenticated-user"]; - readonly post?: never; + put: operations["interactions/set-restrictions-for-authenticated-user"]; + post?: never; /** * Remove interaction restrictions from your public repositories * @description Removes any interaction restrictions from your public repositories. */ - readonly delete: operations["interactions/remove-restrictions-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["interactions/remove-restrictions-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/issues": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/issues": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List user account issues assigned to the authenticated user @@ -16841,21 +17655,21 @@ export interface paths { * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ - readonly get: operations["issues/list-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["issues/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public SSH keys for the authenticated user @@ -16863,27 +17677,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ - readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-public-ssh-keys-for-authenticated-user"]; + put?: never; /** * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. */ - readonly post: operations["users/create-public-ssh-key-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["users/create-public-ssh-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/keys/{key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/keys/{key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a public SSH key for the authenticated user @@ -16891,135 +17705,135 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ - readonly get: operations["users/get-public-ssh-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["users/get-public-ssh-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a public SSH key for the authenticated user * @description Removes a public SSH key from the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ - readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/marketplace_purchases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/marketplace_purchases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List subscriptions for the authenticated user * @description Lists the active subscriptions for the authenticated user. */ - readonly get: operations["apps/list-subscriptions-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-subscriptions-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/marketplace_purchases/stubbed": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/marketplace_purchases/stubbed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List subscriptions for the authenticated user (stubbed) * @description Lists the active subscriptions for the authenticated user. */ - readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/memberships/orgs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/memberships/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization memberships for the authenticated user * @description Lists all of the authenticated user's organization memberships. */ - readonly get: operations["orgs/list-memberships-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-memberships-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/memberships/orgs/{org}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/memberships/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an organization membership for the authenticated user * @description If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. */ - readonly get: operations["orgs/get-membership-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; + get: operations["orgs/get-membership-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; /** * Update an organization membership for the authenticated user * @description Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization. */ - readonly patch: operations["orgs/update-membership-for-authenticated-user"]; - readonly trace?: never; + patch: operations["orgs/update-membership-for-authenticated-user"]; + trace?: never; }; - readonly "/user/migrations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List user migrations * @description Lists all migrations a user has started. */ - readonly get: operations["migrations/list-for-authenticated-user"]; - readonly put?: never; + get: operations["migrations/list-for-authenticated-user"]; + put?: never; /** * Start a user migration * @description Initiates the generation of a user migration archive. */ - readonly post: operations["migrations/start-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["migrations/start-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user migration status @@ -17032,21 +17846,21 @@ export interface paths { * * Once the migration has been `exported` you can [download the migration archive](https://docs.github.com/rest/migrations/users#download-a-user-migration-archive). */ - readonly get: operations["migrations/get-status-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/get-status-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}/archive": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}/archive": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Download a user migration archive @@ -17072,65 +17886,65 @@ export interface paths { * * The archive will also contain an `attachments` directory that includes all attachment files uploaded to GitHub.com and a `repositories` directory that contains the repository's Git data. */ - readonly get: operations["migrations/get-archive-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["migrations/get-archive-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a user migration archive * @description Deletes a previous migration archive. Downloadable migration archives are automatically deleted after seven days. Migration metadata, which is returned in the [List user migrations](https://docs.github.com/rest/migrations/users#list-user-migrations) and [Get a user migration status](https://docs.github.com/rest/migrations/users#get-a-user-migration-status) endpoints, will continue to be available even after an archive is deleted. */ - readonly delete: operations["migrations/delete-archive-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/delete-archive-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}/repos/{repo_name}/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}/repos/{repo_name}/lock": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get?: never; + put?: never; + post?: never; /** * Unlock a user repository * @description Unlocks a repository. You can lock repositories when you [start a user migration](https://docs.github.com/rest/migrations/users#start-a-user-migration). Once the migration is complete you can unlock each repository to begin using it again or [delete the repository](https://docs.github.com/rest/repos/repos#delete-a-repository) if you no longer need the source data. Returns a status of `404 Not Found` if the repository is not locked. */ - readonly delete: operations["migrations/unlock-repo-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["migrations/unlock-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/migrations/{migration_id}/repositories": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/migrations/{migration_id}/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories for a user migration * @description Lists all the repositories for this user migration. */ - readonly get: operations["migrations/list-repos-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["migrations/list-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/orgs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organizations for the authenticated user @@ -17141,21 +17955,21 @@ export interface paths { * > [!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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List packages for the authenticated user's namespace @@ -17163,21 +17977,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-packages-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package for the authenticated user @@ -17185,30 +17999,30 @@ export interface paths { * * 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; - readonly post?: never; + get: operations["packages/get-package-for-authenticated-user"]; + put?: never; + post?: never; /** * 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. 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package for the authenticated user * @description Restores a package owned by the authenticated user. @@ -17219,19 +18033,19 @@ export interface paths { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List package versions for a package owned by the authenticated user @@ -17239,21 +18053,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package version for the authenticated user @@ -17261,9 +18075,9 @@ export interface paths { * * 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; - readonly post?: never; + get: operations["packages/get-package-version-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete a package version for the authenticated user * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. @@ -17272,21 +18086,21 @@ export interface paths { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-version-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package version for the authenticated user * @description Restores a package version owned by the authenticated user. @@ -17297,39 +18111,19 @@ export interface paths { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - readonly post: operations["projects/create-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/public_emails": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["packages/restore-package-version-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/public_emails": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public email addresses for the authenticated user @@ -17339,21 +18133,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ - readonly get: operations["users/list-public-emails-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-public-emails-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories for the authenticated user @@ -17361,97 +18155,97 @@ export interface paths { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. */ - readonly get: operations["repos/list-for-authenticated-user"]; - readonly put?: never; + get: operations["repos/list-for-authenticated-user"]; + put?: never; /** * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ - readonly post: operations["repos/create-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["repos/create-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/repository_invitations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/repository_invitations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repository invitations for the authenticated user * @description When authenticating as a user, this endpoint will list all currently open repository invitations for that user. */ - readonly get: operations["repos/list-invitations-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/user/repository_invitations/{invitation_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly get?: never; - readonly put?: never; - readonly post?: never; + get: operations["repos/list-invitations-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/repository_invitations/{invitation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; /** Decline a repository invitation */ - readonly delete: operations["repos/decline-invitation-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; + delete: operations["repos/decline-invitation-for-authenticated-user"]; + options?: never; + head?: never; /** Accept a repository invitation */ - readonly patch: operations["repos/accept-invitation-for-authenticated-user"]; - readonly trace?: never; + patch: operations["repos/accept-invitation-for-authenticated-user"]; + trace?: never; }; - readonly "/user/social_accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List social accounts for the authenticated user * @description Lists all of your social accounts. */ - readonly get: operations["users/list-social-accounts-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-social-accounts-for-authenticated-user"]; + put?: never; /** * Add social accounts for the authenticated user * @description Add one or more social accounts to the authenticated user's profile. * * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly post: operations["users/add-social-account-for-authenticated-user"]; + post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user * @description Deletes one or more social accounts from the authenticated user's profile. * * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ - readonly delete: operations["users/delete-social-account-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-social-account-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/ssh_signing_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List SSH signing keys for the authenticated user @@ -17459,27 +18253,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ - readonly get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; - readonly put?: never; + get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; + put?: never; /** * Create a SSH signing key for the authenticated user * @description Creates an SSH signing key for the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ - readonly post: operations["users/create-ssh-signing-key-for-authenticated-user"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["users/create-ssh-signing-key-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/ssh_signing_keys/{ssh_signing_key_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get an SSH signing key for the authenticated user @@ -17487,27 +18281,27 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ - readonly get: operations["users/get-ssh-signing-key-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; + get: operations["users/get-ssh-signing-key-for-authenticated-user"]; + put?: never; + post?: never; /** * Delete an SSH signing key for the authenticated user * @description Deletes an SSH signing key from the authenticated user's GitHub account. * * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ - readonly delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories starred by the authenticated user @@ -17517,69 +18311,69 @@ export interface paths { * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ - readonly get: operations["activity/list-repos-starred-by-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-repos-starred-by-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/starred/{owner}/{repo}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/starred/{owner}/{repo}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Check if a repository is starred by the authenticated user * @description Whether the authenticated user has starred the repository. */ - readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"]; + get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ - readonly put: operations["activity/star-repo-for-authenticated-user"]; - readonly post?: never; + put: operations["activity/star-repo-for-authenticated-user"]; + post?: never; /** * Unstar a repository for the authenticated user * @description Unstar a repository that the authenticated user has previously starred. */ - readonly delete: operations["activity/unstar-repo-for-authenticated-user"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["activity/unstar-repo-for-authenticated-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/subscriptions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories watched by the authenticated user * @description Lists repositories the authenticated user is watching. */ - readonly get: operations["activity/list-watched-repos-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-watched-repos-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/teams": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List teams for the authenticated user @@ -17590,21 +18384,21 @@ export interface paths { * * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ - readonly get: operations["teams/list-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["teams/list-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/user/{account_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/user/{account_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user using their ID @@ -17616,21 +18410,41 @@ export interface paths { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ - readonly get: operations["users/get-by-id"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/get-by-id"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/user/{user_id}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for user owned project + * @description Create draft issue item for the specified user owned project. + */ + post: operations["projects/create-draft-item-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List users @@ -17638,21 +18452,41 @@ export interface paths { * * Note: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of users. */ - readonly get: operations["users/list"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/list"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{user_id}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for a user-owned project + * @description Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user @@ -17664,21 +18498,105 @@ export interface paths { * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see [Emails API](https://docs.github.com/rest/users/emails). */ - readonly get: operations["users/get-by-username"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/get-by-username"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/attestations/{subject_digest}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["users/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["users/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["users/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + */ + delete: operations["users/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List attestations @@ -17688,21 +18606,21 @@ export interface paths { * * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). */ - readonly get: operations["users/list-attestations"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-attestations"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/docker/conflicts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/docker/conflicts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get list of conflicting packages during Docker migration for user @@ -17710,21 +18628,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ - readonly get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List events for the authenticated user @@ -17733,21 +18651,21 @@ export interface paths { * > [!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. */ - readonly get: operations["activity/list-events-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/events/orgs/{org}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/events/orgs/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organization events for the authenticated user @@ -17756,139 +18674,139 @@ export interface paths { * > [!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. */ - readonly get: operations["activity/list-org-events-for-authenticated-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-org-events-for-authenticated-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/events/public": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events for a user * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-public-events-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/followers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/followers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List followers of a user * @description Lists the people following the specified user. */ - readonly get: operations["users/list-followers-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-followers-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/following": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/following": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List the people a user follows * @description Lists the people who the specified user follows. */ - readonly get: operations["users/list-following-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/following/{target_user}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/list-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/following/{target_user}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** Check if a user follows another user */ - readonly get: operations["users/check-following-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/gists": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + get: operations["users/check-following-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/gists": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List gists for a user * @description Lists public gists for the specified user: */ - readonly get: operations["gists/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["gists/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/gpg_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/gpg_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List GPG keys for a user * @description Lists the GPG keys for a user. This information is accessible by anyone. */ - readonly get: operations["users/list-gpg-keys-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-gpg-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/hovercard": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/hovercard": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get contextual information for a user @@ -17898,21 +18816,21 @@ export interface paths { * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ - readonly get: operations["users/get-context-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/get-context-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/installation": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a user installation for the authenticated app @@ -17920,41 +18838,41 @@ export interface paths { * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ - readonly get: operations["apps/get-user-installation"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["apps/get-user-installation"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public keys for a user * @description Lists the _verified_ public SSH keys for a user. This is accessible by anyone. */ - readonly get: operations["users/list-public-keys-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-public-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/orgs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/orgs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List organizations for a user @@ -17962,21 +18880,21 @@ export interface paths { * * This method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user) API instead. */ - readonly get: operations["orgs/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["orgs/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List packages for a user @@ -17984,21 +18902,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/list-packages-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package for a user @@ -18006,9 +18924,9 @@ export interface paths { * * 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; - readonly post?: never; + get: operations["packages/get-package-for-user"]; + put?: never; + post?: never; /** * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. @@ -18017,21 +18935,21 @@ export interface paths { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore a package for a user * @description Restores an entire package for a user. @@ -18044,19 +18962,19 @@ export interface paths { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + post: operations["packages/restore-package-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List package versions for a package owned by a user @@ -18064,21 +18982,21 @@ export interface paths { * * 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; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get a package version for a user @@ -18086,9 +19004,9 @@ export interface paths { * * 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; - readonly post?: never; + get: operations["packages/get-package-version-for-user"]; + put?: never; + post?: never; /** * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. @@ -18097,21 +19015,21 @@ export interface paths { * * 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; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + delete: operations["packages/delete-package-version-for-user"]; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly get?: never; - readonly put?: never; + get?: never; + put?: never; /** * Restore package version for a user * @description Restores a specific package version for a user. @@ -18124,39 +19042,175 @@ export interface paths { * * 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; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/projects": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List user projects - * @description Lists projects for a user. - */ - readonly get: operations["projects/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/received_events": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + post: operations["packages/restore-package-version-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List projects for user + * @description List all projects owned by a specific user accessible by the authenticated user. + */ + get: operations["projects/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for user + * @description Get a specific user-owned project. + */ + get: operations["projects/get-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for user + * @description List all fields for a specific user-owned project. + */ + get: operations["projects/list-fields-for-user"]; + put?: never; + /** + * Add field to user owned project + * @description Add a field to a specified user owned project. + */ + post: operations["projects/add-field-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for user + * @description Get a specific field for a user-owned project. + */ + get: operations["projects/get-field-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user owned project + * @description List all items for a specific user-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-user"]; + put?: never; + /** + * Add item to user owned project + * @description Add an issue or pull request item to the specified user owned project. + */ + post: operations["projects/add-item-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for a user owned project + * @description Get a specific item from a user-owned project. + */ + get: operations["projects/get-user-item"]; + put?: never; + post?: never; + /** + * Delete project item for user + * @description Delete a specific item from a user-owned project. + */ + delete: operations["projects/delete-item-for-user"]; + options?: never; + head?: never; + /** + * Update project item for user + * @description Update a specific item in a user-owned project. + */ + patch: operations["projects/update-item-for-user"]; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user project view + * @description List items in a user project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/received_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List events received by the authenticated user @@ -18166,174 +19220,171 @@ export interface paths { * > [!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. */ - readonly get: operations["activity/list-received-events-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-received-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/received_events/public": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/received_events/public": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List public events received by a user * @description > [!NOTE] * > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. */ - readonly get: operations["activity/list-received-public-events-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-received-public-events-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories for a user * @description Lists public repositories for the specified user. */ - readonly get: operations["repos/list-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/settings/billing/actions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. - * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ - readonly get: operations["billing/get-github-actions-billing-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/settings/billing/packages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - */ - readonly get: operations["billing/get-github-packages-billing-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/users/{username}/settings/billing/shared-storage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + get: operations["repos/list-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for a user + * @description Gets a report of premium request usage for a user. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/settings/billing/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage report for a user + * @description Gets a report of the total usage for a user. + * + * **Note:** This endpoint is only available to users with access to the enhanced billing platform. + */ + get: operations["billing/get-github-billing-usage-report-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for a user + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Gets a summary report of usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - readonly get: operations["billing/get-shared-storage-billing-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["billing/get-github-billing-usage-summary-report-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/social_accounts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/social_accounts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List social accounts for a user * @description Lists social media accounts for a user. This endpoint is accessible by anyone. */ - readonly get: operations["users/list-social-accounts-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-social-accounts-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/ssh_signing_keys": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/ssh_signing_keys": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List SSH signing keys for a user * @description Lists the SSH signing keys for a user. This operation is accessible by anyone. */ - readonly get: operations["users/list-ssh-signing-keys-for-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["users/list-ssh-signing-keys-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/starred": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories starred by a user @@ -18343,270 +19394,270 @@ export interface paths { * * - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created. */ - readonly get: operations["activity/list-repos-starred-by-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-repos-starred-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/users/{username}/subscriptions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/users/{username}/subscriptions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * List repositories watched by a user * @description Lists repositories a user is watching. */ - readonly get: operations["activity/list-repos-watched-by-user"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["activity/list-repos-watched-by-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get all API versions * @description Get all supported GitHub API versions. */ - readonly get: operations["meta/get-all-versions"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get-all-versions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; - readonly "/zen": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "/zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; /** * Get the Zen of GitHub * @description Get a random sentence from the Zen of GitHub */ - readonly get: operations["meta/get-zen"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; + get: operations["meta/get-zen"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; }; } export type webhooks = Record; export interface components { schemas: { - readonly root: { + root: { /** Format: uri-template */ - readonly current_user_url: string; + current_user_url: string; /** Format: uri-template */ - readonly current_user_authorizations_html_url: string; + current_user_authorizations_html_url: string; /** Format: uri-template */ - readonly authorizations_url: string; + authorizations_url: string; /** Format: uri-template */ - readonly code_search_url: string; + code_search_url: string; /** Format: uri-template */ - readonly commit_search_url: string; + commit_search_url: string; /** Format: uri-template */ - readonly emails_url: string; + emails_url: string; /** Format: uri-template */ - readonly emojis_url: string; + emojis_url: string; /** Format: uri-template */ - readonly events_url: string; + events_url: string; /** Format: uri-template */ - readonly feeds_url: string; + feeds_url: string; /** Format: uri-template */ - readonly followers_url: string; + followers_url: string; /** Format: uri-template */ - readonly following_url: string; + following_url: string; /** Format: uri-template */ - readonly gists_url: string; + gists_url: string; /** * Format: uri-template * @deprecated */ - readonly hub_url?: string; + hub_url?: string; /** Format: uri-template */ - readonly issue_search_url: string; + issue_search_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly label_search_url: string; + label_search_url: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** Format: uri-template */ - readonly organization_url: string; + organization_url: string; /** Format: uri-template */ - readonly organization_repositories_url: string; + organization_repositories_url: string; /** Format: uri-template */ - readonly organization_teams_url: string; + organization_teams_url: string; /** Format: uri-template */ - readonly public_gists_url: string; + public_gists_url: string; /** Format: uri-template */ - readonly rate_limit_url: string; + rate_limit_url: string; /** Format: uri-template */ - readonly repository_url: string; + repository_url: string; /** Format: uri-template */ - readonly repository_search_url: string; + repository_search_url: string; /** Format: uri-template */ - readonly current_user_repositories_url: string; + current_user_repositories_url: string; /** Format: uri-template */ - readonly starred_url: string; + starred_url: string; /** Format: uri-template */ - readonly starred_gists_url: string; + starred_gists_url: string; /** Format: uri-template */ - readonly topic_search_url?: string; + topic_search_url?: string; /** Format: uri-template */ - readonly user_url: string; + user_url: string; /** Format: uri-template */ - readonly user_organizations_url: string; + user_organizations_url: string; /** Format: uri-template */ - readonly user_repositories_url: string; + user_repositories_url: string; /** Format: uri-template */ - readonly user_search_url: string; + user_search_url: string; }; /** * @description The package's language or package management ecosystem. * @enum {string} */ - readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; + "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ - readonly vulnerability: { + vulnerability: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name: string | null; + name: string | null; } | null; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; + vulnerable_version_range: string | null; /** @description The package version that resolves the vulnerability. */ - readonly first_patched_version: string | null; + first_patched_version: string | null; /** @description The functions in the package that are affected by the vulnerability. */ - readonly vulnerable_functions: readonly string[] | null; + readonly vulnerable_functions: string[] | null; }; - readonly "cvss-severities": { - readonly cvss_v3?: { + "cvss-severities": { + cvss_v3?: { /** @description The CVSS 3 vector string. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS 3 score. */ readonly score: number | null; } | null; - readonly cvss_v4?: { + cvss_v4?: { /** @description The CVSS 4 vector string. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS 4 score. */ readonly score: number | null; } | null; } | null; /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ - readonly "security-advisory-epss": { - readonly percentage?: number; - readonly percentile?: number; + "security-advisory-epss": { + percentage?: number; + percentile?: number; } | null; /** * Simple User * @description A GitHub user. */ - readonly "simple-user": { - readonly name?: string | null; - readonly email?: string | null; + "simple-user": { + name?: string | null; + email?: string | null; /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; + starred_at?: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; }; /** * @description The type of credit the user is receiving. * @enum {string} */ - readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; + "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; /** @description A GitHub Security Advisory. */ - readonly "global-advisory": { + "global-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ @@ -18624,9 +19675,9 @@ export interface components { */ readonly repository_advisory_url: string | null; /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; + description: string | null; /** * @description The type of advisory. * @enum {string} @@ -18636,22 +19687,22 @@ export interface components { * @description The severity of the advisory. * @enum {string} */ - readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; + severity: "critical" | "high" | "medium" | "low" | "unknown"; /** * Format: uri * @description The URL of the advisory's source code. */ - readonly source_code_location: string | null; - readonly identifiers: readonly { + source_code_location: string | null; + readonly identifiers: { /** * @description The type of identifier. * @enum {string} */ - readonly type: "CVE" | "GHSA"; + type: "CVE" | "GHSA"; /** @description The identifier value. */ - readonly value: string; + value: string; }[] | null; - readonly references: readonly string[] | null; + references: string[] | null; /** * Format: date-time * @description The date and time of when the advisory was published, in ISO 8601 format. @@ -18679,140 +19730,140 @@ export interface components { */ readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["vulnerability"][] | null; - readonly cvss: { + vulnerabilities: components["schemas"]["vulnerability"][] | null; + cvss: { /** @description The CVSS vector. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS score. */ readonly score: number | null; } | null; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly epss?: components["schemas"]["security-advisory-epss"]; - readonly cwes: readonly { + cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; + cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; + cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; /** @description The users who contributed to the advisory. */ - readonly credits: readonly { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; + readonly credits: { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; }[] | null; }; /** * Basic Error * @description Basic Error */ - readonly "basic-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly url?: string; - readonly status?: string; + "basic-error": { + message?: string; + documentation_url?: string; + url?: string; + status?: string; }; /** * Validation Error Simple * @description Validation Error Simple */ - readonly "validation-error-simple": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: readonly string[]; + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; }; /** * Enterprise * @description An enterprise on GitHub. */ - readonly enterprise: { + enterprise: { /** @description A short description of the enterprise. */ - readonly description?: string | null; + description?: string | null; /** * Format: uri * @example https://github.com/enterprises/octo-business */ - readonly html_url: string; + html_url: string; /** * Format: uri * @description The enterprise's website URL. */ - readonly website_url?: string | null; + website_url?: string | null; /** * @description Unique identifier of the enterprise * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the enterprise. * @example Octo Business */ - readonly name: string; + name: string; /** * @description The slug url identifier for the enterprise. * @example octo-business */ - readonly slug: string; + slug: string; /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** Format: uri */ - readonly avatar_url: string; + avatar_url: string; }; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly integration: { + integration: { /** * @description Unique identifier of the GitHub app * @example 37 */ - readonly id: number; + id: number; /** * @description The slug name of the GitHub app * @example probot-owners */ - readonly slug?: string; + slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id: string; + node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; - readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; + client_id?: string; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners */ - readonly name: string; + name: string; /** @example The description of the app. */ - readonly description: string | null; + description: string | null; /** * Format: uri * @example https://example.com */ - readonly external_url: string; + external_url: string; /** * Format: uri * @example https://github.com/apps/super-ci */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly updated_at: string; + updated_at: string; /** * @description The set of permissions for the GitHub app * @example { @@ -18820,268 +19871,265 @@ export interface components { * "deployments": "write" * } */ - readonly permissions: { - readonly issues?: string; - readonly checks?: string; - readonly metadata?: string; - readonly contents?: string; - readonly deployments?: string; + permissions: { + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; } & { - readonly [key: string]: string; + [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" * ] */ - readonly events: readonly string[]; + events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ - readonly installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - readonly webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - readonly pem?: string; + installations_count?: number; } | null; /** * Format: uri * @description The URL to which the payloads will be delivered. * @example https://example.com/webhook */ - readonly "webhook-config-url": string; + "webhook-config-url": string; /** * @description The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. * @example "json" */ - readonly "webhook-config-content-type": string; + "webhook-config-content-type": string; /** * @description If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers). * @example "********" */ - readonly "webhook-config-secret": string; - readonly "webhook-config-insecure-ssl": string | number; + "webhook-config-secret": string; + "webhook-config-insecure-ssl": string | number; /** * Webhook Configuration * @description Configuration object of the webhook */ - readonly "webhook-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"]; + "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"]; }; /** * Simple webhook delivery * @description Delivery made by a webhook, without request and response information. */ - readonly "hook-delivery-item": { + "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ - readonly id: number; + id: number; /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - readonly guid: string; + guid: string; /** * Format: date-time * @description Time when the webhook delivery occurred. * @example 2021-05-12T20:33:44Z */ - readonly delivered_at: string; + delivered_at: string; /** * @description Whether the webhook delivery is a redelivery. * @example false */ - readonly redelivery: boolean; + redelivery: boolean; /** * @description Time spent delivering. * @example 0.03 */ - readonly duration: number; + duration: number; /** * @description Describes the response returned after attempting the delivery. * @example failed to connect */ - readonly status: string; + status: string; /** * @description Status code received when delivery was made. * @example 502 */ - readonly status_code: number; + status_code: number; /** * @description The event that triggered the delivery. * @example issues */ - readonly event: string; + event: string; /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - readonly action: string | null; + action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ - readonly installation_id: number | null; + installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ - readonly repository_id: number | null; + repository_id: number | null; /** * Format: date-time * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z */ - readonly throttled_at?: string | null; + throttled_at?: string | null; }; /** * Scim Error * @description Scim Error */ - readonly "scim-error": { - readonly message?: string | null; - readonly documentation_url?: string | null; - readonly detail?: string | null; - readonly status?: number; - readonly scimType?: string | null; - readonly schemas?: readonly string[]; + "scim-error": { + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; }; /** * Validation Error * @description Validation Error */ - readonly "validation-error": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: readonly { - readonly resource?: string; - readonly field?: string; - readonly message?: string; - readonly code: string; - readonly index?: number; - readonly value?: (string | null) | (number | null) | (readonly string[] | null); + "validation-error": { + message: string; + documentation_url: string; + errors?: { + resource?: string; + field?: string; + message?: string; + code: string; + index?: number; + value?: (string | null) | (number | null) | (string[] | null); }[]; }; /** * Webhook delivery * @description Delivery made by a webhook. */ - readonly "hook-delivery": { + "hook-delivery": { /** * @description Unique identifier of the delivery. * @example 42 */ - readonly id: number; + id: number; /** * @description Unique identifier for the event (shared with all deliveries for all webhooks that subscribe to this event). * @example 58474f00-b361-11eb-836d-0e4f3503ccbe */ - readonly guid: string; + guid: string; /** * Format: date-time * @description Time when the delivery was delivered. * @example 2021-05-12T20:33:44Z */ - readonly delivered_at: string; + delivered_at: string; /** * @description Whether the delivery is a redelivery. * @example false */ - readonly redelivery: boolean; + redelivery: boolean; /** * @description Time spent delivering. * @example 0.03 */ - readonly duration: number; + duration: number; /** * @description Description of the status of the attempted delivery * @example failed to connect */ - readonly status: string; + status: string; /** * @description Status code received when delivery was made. * @example 502 */ - readonly status_code: number; + status_code: number; /** * @description The event that triggered the delivery. * @example issues */ - readonly event: string; + event: string; /** * @description The type of activity for the event that triggered the delivery. * @example opened */ - readonly action: string | null; + action: string | null; /** * @description The id of the GitHub App installation associated with this event. * @example 123 */ - readonly installation_id: number | null; + installation_id: number | null; /** * @description The id of the repository associated with this event. * @example 123 */ - readonly repository_id: number | null; + repository_id: number | null; /** * Format: date-time * @description Time when the webhook delivery was throttled. * @example 2021-05-12T20:33:44Z */ - readonly throttled_at?: string | null; + throttled_at?: string | null; /** * @description The URL target of the delivery. * @example https://www.example.com */ - readonly url?: string; - readonly request: { + url?: string; + request: { /** @description The request headers sent with the webhook delivery. */ - readonly headers: { - readonly [key: string]: unknown; + headers: { + [key: string]: unknown; } | null; /** @description The webhook payload. */ - readonly payload: { - readonly [key: string]: unknown; + payload: { + [key: string]: unknown; } | null; }; - readonly response: { + response: { /** @description The response headers received when the delivery was made. */ - readonly headers: { - readonly [key: string]: unknown; + headers: { + [key: string]: unknown; } | null; /** @description The response payload received. */ - readonly payload: string | null; + payload: string | null; }; }; /** * Integration Installation Request * @description Request to install an integration on a target */ - readonly "integration-installation-request": { + "integration-installation-request": { /** * @description Unique identifier of the request installation. * @example 42 */ - readonly id: number; + id: number; /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id?: string; - readonly account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; - readonly requester: components["schemas"]["simple-user"]; + node_id?: string; + account: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; + requester: components["schemas"]["simple-user"]; /** * Format: date-time * @example 2022-07-08T16:18:44-04:00 */ - readonly created_at: string; + created_at: string; }; /** * App Permissions @@ -19093,707 +20141,746 @@ export interface components { * "single_file": "read" * } */ - readonly "app-permissions": { + "app-permissions": { /** * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. * @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. * @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create and retrieve build artifact metadata records. + * @enum {string} + */ + artifact_metadata?: "read" | "write"; + /** + * @description The level of permission to create and retrieve the access token for repository attestations. + * @enum {string} + */ + attestations?: "read" | "write"; /** * @description The level of permission to grant the access token for checks on code. * @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. * @enum {string} */ - readonly codespaces?: "read" | "write"; + codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** - * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @description The level of permission to grant the access token to manage Dependabot secrets. * @enum {string} */ - readonly dependabot_secrets?: "read" | "write"; + dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; + /** + * @description The level of permission to grant the access token for discussions and related comments and labels. + * @enum {string} + */ + discussions?: "read" | "write"; /** * @description The level of permission to grant the access token for managing repository environments. * @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. * @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the merge queues for a repository. + * @enum {string} + */ + merge_queues?: "read" | "write"; /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. * @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** * @description The level of permission to grant the access token for packages published to GitHub Packages. * @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. * @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. * @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. * @enum {string} */ - readonly repository_custom_properties?: "read" | "write"; + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. * @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. * @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** * @description The level of permission to grant the access token to manage repository secrets. * @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. * @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** * @description The level of permission to grant the access token to manage just a single file. * @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** * @description The level of permission to grant the access token for commit statuses. * @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** * @description The level of permission to grant the access token to manage Dependabot alerts. * @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. * @enum {string} */ - readonly workflows?: "write"; + workflows?: "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + * @enum {string} + */ + custom_properties_for_organizations?: "read" | "write"; /** * @description The level of permission to grant the access token for organization teams and members. * @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** * @description The level of permission to grant the access token to manage access to an organization. * @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ - readonly organization_custom_roles?: "read" | "write"; + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom organization roles management. * @enum {string} */ - readonly organization_custom_org_roles?: "read" | "write"; + organization_custom_org_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom property management. + * @description The level of permission to grant the access token for repository custom properties management at the organization level. * @enum {string} */ - readonly organization_custom_properties?: "read" | "write" | "admin"; + 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 public preview and is subject to change. * @enum {string} */ - readonly organization_copilot_seat_management?: "write"; + organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ - readonly organization_announcement_banners?: "read" | "write"; + organization_announcement_banners?: "read" | "write"; /** * @description The level of permission to grant the access token to view events triggered by an activity in an organization. * @enum {string} */ - readonly organization_events?: "read"; + organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. * @enum {string} */ - readonly organization_personal_access_tokens?: "read" | "write"; + organization_personal_access_tokens?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. * @enum {string} */ - readonly organization_personal_access_token_requests?: "read" | "write"; + organization_personal_access_token_requests?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing an organization's plan. * @enum {string} */ - readonly organization_plan?: "read"; + organization_plan?: "read"; /** * @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"; + organization_projects?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. * @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** * @description The level of permission to grant the access token to manage organization secrets. * @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. * @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. * @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; - /** - * @description The level of permission to grant the access token to manage team discussions and related comments. - * @enum {string} - */ - readonly team_discussions?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the email addresses belonging to a user. * @enum {string} */ - readonly email_addresses?: "read" | "write"; + email_addresses?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the followers belonging to a user. * @enum {string} */ - readonly followers?: "read" | "write"; + followers?: "read" | "write"; /** * @description The level of permission to grant the access token to manage git SSH keys. * @enum {string} */ - readonly git_ssh_keys?: "read" | "write"; + git_ssh_keys?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. * @enum {string} */ - readonly gpg_keys?: "read" | "write"; + gpg_keys?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage interaction limits on a repository. * @enum {string} */ - readonly interaction_limits?: "read" | "write"; + interaction_limits?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the profile settings belonging to a user. * @enum {string} */ - readonly profile?: "write"; + profile?: "write"; /** * @description The level of permission to grant the access token to list and manage repositories a user is starring. * @enum {string} */ - readonly starring?: "read" | "write"; + starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token for organization custom properties management at the enterprise level. + * @enum {string} + */ + enterprise_custom_properties_for_organizations?: "read" | "write" | "admin"; }; /** * Simple User * @description A GitHub user. */ - readonly "nullable-simple-user": { - readonly name?: string | null; - readonly email?: string | null; + "nullable-simple-user": { + name?: string | null; + email?: string | null; /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; + starred_at?: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; } | null; /** * Installation * @description Installation */ - readonly installation: { + installation: { /** * @description The ID of the installation. * @example 1 */ - readonly id: number; - readonly account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; + id: number; + account: (components["schemas"]["simple-user"] | components["schemas"]["enterprise"]) | null; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection: "all" | "selected"; + repository_selection: "all" | "selected"; /** * Format: uri * @example https://api.github.com/app/installations/1/access_tokens */ - readonly access_tokens_url: string; + access_tokens_url: string; /** * Format: uri * @example https://api.github.com/installation/repositories */ - readonly repositories_url: string; + repositories_url: string; /** * Format: uri * @example https://github.com/organizations/github/settings/installations/1 */ - readonly html_url: string; + html_url: string; /** @example 1 */ - readonly app_id: number; + app_id: number; + /** @example Iv1.ab1112223334445c */ + client_id?: string; /** @description The ID of the user or organization this token is being scoped to. */ - readonly target_id: number; + target_id: number; /** @example Organization */ - readonly target_type: string; - readonly permissions: components["schemas"]["app-permissions"]; - readonly events: readonly string[]; + target_type: string; + permissions: components["schemas"]["app-permissions"]; + events: string[]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** @example config.yaml */ - readonly single_file_name: string | null; + single_file_name: string | null; /** @example true */ - readonly has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean; /** * @example [ * "config.yml", * ".github/issue_TEMPLATE.md" * ] */ - readonly single_file_paths?: readonly string[]; + single_file_paths?: string[]; /** @example github-actions */ - readonly app_slug: string; - readonly suspended_by: components["schemas"]["nullable-simple-user"]; + app_slug: string; + suspended_by: components["schemas"]["nullable-simple-user"]; /** Format: date-time */ - readonly suspended_at: string | null; + suspended_at: string | null; /** @example "test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com" */ - readonly contact_email?: string | null; + contact_email?: string | null; }; /** * License Simple * @description License Simple */ - readonly "nullable-license-simple": { + "nullable-license-simple": { /** @example mit */ - readonly key: string; + key: string; /** @example MIT License */ - readonly name: string; + name: string; /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + url: string | null; /** @example MIT */ - readonly spdx_id: string | null; + spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + node_id: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; } | null; /** * Repository * @description A repository on GitHub. */ - readonly repository: { + repository: { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -19801,7 +20888,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -19810,7 +20897,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -19818,7 +20905,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -19827,503 +20914,508 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; }; /** * Installation Token * @description Authentication token for a GitHub App installed on a user or org. */ - readonly "installation-token": { - readonly token: string; - readonly expires_at: string; - readonly permissions?: components["schemas"]["app-permissions"]; + "installation-token": { + token: string; + expires_at: string; + permissions?: components["schemas"]["app-permissions"]; /** @enum {string} */ - readonly repository_selection?: "all" | "selected"; - readonly repositories?: readonly components["schemas"]["repository"][]; + repository_selection?: "all" | "selected"; + repositories?: components["schemas"]["repository"][]; /** @example README.md */ - readonly single_file?: string; + single_file?: string; /** @example true */ - readonly has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean; /** * @example [ * "config.yml", * ".github/issue_TEMPLATE.md" * ] */ - readonly single_file_paths?: readonly string[]; + single_file_paths?: string[]; }; /** Scoped Installation */ - readonly "nullable-scoped-installation": { - readonly permissions: components["schemas"]["app-permissions"]; + "nullable-scoped-installation": { + permissions: components["schemas"]["app-permissions"]; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection: "all" | "selected"; + repository_selection: "all" | "selected"; /** @example config.yaml */ - readonly single_file_name: string | null; + single_file_name: string | null; /** @example true */ - readonly has_multiple_single_files?: boolean; + has_multiple_single_files?: boolean; /** * @example [ * "config.yml", * ".github/issue_TEMPLATE.md" * ] */ - readonly single_file_paths?: readonly string[]; + single_file_paths?: string[]; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repositories_url: string; - readonly account: components["schemas"]["simple-user"]; + repositories_url: string; + account: components["schemas"]["simple-user"]; } | null; /** * Authorization * @description The authorization for an OAuth app, GitHub App, or a Personal Access Token. */ - readonly authorization: { + authorization: { /** Format: int64 */ - readonly id: number; + id: number; /** Format: uri */ - readonly url: string; + url: string; /** @description A list of scopes that this authorization is in. */ - readonly scopes: readonly string[] | null; - readonly token: string; - readonly token_last_eight: string | null; - readonly hashed_token: string | null; - readonly app: { - readonly client_id: string; - readonly name: string; + scopes: string[] | null; + token: string; + token_last_eight: string | null; + hashed_token: string | null; + app: { + client_id: string; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly note: string | null; + note: string | null; /** Format: uri */ - readonly note_url: string | null; + note_url: string | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly created_at: string; - readonly fingerprint: string | null; - readonly user?: components["schemas"]["nullable-simple-user"]; - readonly installation?: components["schemas"]["nullable-scoped-installation"]; + created_at: string; + fingerprint: string | null; + user?: components["schemas"]["nullable-simple-user"]; + installation?: components["schemas"]["nullable-scoped-installation"]; /** Format: date-time */ - readonly expires_at: string | null; + expires_at: string | null; }; /** * Simple Classroom Repository * @description A GitHub repository view for Classroom */ - readonly "simple-classroom-repository": { + "simple-classroom-repository": { /** * @description A unique identifier of the repository. * @example 1296269 */ - readonly id: number; + id: number; /** * @description The full, globally unique name of the repository. * @example octocat/Hello-World */ - readonly full_name: string; + full_name: string; /** * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** * @description The GraphQL identifier of the repository. * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @description Whether the repository is private. */ - readonly private: boolean; + private: boolean; /** * @description The default branch for the repository. * @example main */ - readonly default_branch: string; + default_branch: string; }; /** * Organization Simple for Classroom * @description A GitHub organization. */ - readonly "simple-classroom-organization": { + "simple-classroom-organization": { /** @example 1 */ - readonly id: number; + id: number; /** @example github */ - readonly login: string; + login: string; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/github */ - readonly html_url: string; + html_url: string; /** @example Github - Code thigns happen here */ - readonly name: string | null; + name: string | null; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; }; /** * Classroom * @description A GitHub Classroom classroom */ - readonly classroom: { + classroom: { /** * @description Unique identifier of the classroom. * @example 42 */ - readonly id: number; + id: number; /** * @description The name of the classroom. * @example Programming Elixir */ - readonly name: string; + name: string; /** * @description Whether classroom is archived. * @example false */ - readonly archived: boolean; - readonly organization: components["schemas"]["simple-classroom-organization"]; + archived: boolean; + organization: components["schemas"]["simple-classroom-organization"]; /** * @description The URL of the classroom on GitHub Classroom. * @example https://classroom.github.com/classrooms/1-programming-elixir */ - readonly url: string; + url: string; }; /** * Classroom Assignment * @description A GitHub Classroom assignment */ - readonly "classroom-assignment": { + "classroom-assignment": { /** * @description Unique identifier of the repository. * @example 42 */ - readonly id: number; + id: number; /** * @description Whether an accepted assignment creates a public repository. * @example true */ - readonly public_repo: boolean; + public_repo: boolean; /** * @description Assignment title. * @example Intro to Binaries */ - readonly title: string; + title: string; /** * @description Whether it's a group assignment or individual assignment. * @example individual * @enum {string} */ - readonly type: "individual" | "group"; + type: "individual" | "group"; /** * @description The link that a student can use to accept the assignment. * @example https://classroom.github.com/a/Lx7jiUgx */ - readonly invite_link: string; + invite_link: string; /** * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. * @example true */ - readonly invitations_enabled: boolean; + invitations_enabled: boolean; /** * @description Sluggified name of the assignment. * @example intro-to-binaries */ - readonly slug: string; + slug: string; /** * @description Whether students are admins on created repository when a student accepts the assignment. * @example true */ - readonly students_are_repo_admins: boolean; + students_are_repo_admins: boolean; /** * @description Whether feedback pull request will be created when a student accepts the assignment. * @example true */ - readonly feedback_pull_requests_enabled: boolean; + feedback_pull_requests_enabled: boolean; /** * @description The maximum allowable teams for the assignment. * @example 0 */ - readonly max_teams: number | null; + max_teams: number | null; /** * @description The maximum allowable members per team. * @example 0 */ - readonly max_members: number | null; + max_members: number | null; /** * @description The selected editor for the assignment. * @example codespaces */ - readonly editor: string; + editor: string; /** * @description The number of students that have accepted the assignment. * @example 25 */ - readonly accepted: number; + accepted: number; /** * @description The number of students that have submitted the assignment. * @example 10 */ - readonly submitted: number; + submitted: number; /** * @description The number of students that have passed the assignment. * @example 10 */ - readonly passing: number; + passing: number; /** * @description The programming language used in the assignment. * @example elixir */ - readonly language: string; + language: string; /** * Format: date-time * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z */ - readonly deadline: string | null; - readonly starter_code_repository: components["schemas"]["simple-classroom-repository"]; - readonly classroom: components["schemas"]["classroom"]; + deadline: string | null; + starter_code_repository: components["schemas"]["simple-classroom-repository"]; + classroom: components["schemas"]["classroom"]; }; /** * Simple Classroom User * @description A GitHub user simplified for Classroom. */ - readonly "simple-classroom-user": { + "simple-classroom-user": { /** @example 1 */ - readonly id: number; + id: number; /** @example octocat */ - readonly login: string; + login: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; }; /** * Simple Classroom * @description A GitHub Classroom classroom */ - readonly "simple-classroom": { + "simple-classroom": { /** * @description Unique identifier of the classroom. * @example 42 */ - readonly id: number; + id: number; /** * @description The name of the classroom. * @example Programming Elixir */ - readonly name: string; + name: string; /** * @description Returns whether classroom is archived or not. * @example false */ - readonly archived: boolean; + archived: boolean; /** * @description The url of the classroom on GitHub Classroom. * @example https://classroom.github.com/classrooms/1-programming-elixir */ - readonly url: string; + url: string; }; /** * Simple Classroom Assignment * @description A GitHub Classroom assignment */ - readonly "simple-classroom-assignment": { + "simple-classroom-assignment": { /** * @description Unique identifier of the repository. * @example 42 */ - readonly id: number; + id: number; /** * @description Whether an accepted assignment creates a public repository. * @example true */ - readonly public_repo: boolean; + public_repo: boolean; /** * @description Assignment title. * @example Intro to Binaries */ - readonly title: string; + title: string; /** * @description Whether it's a Group Assignment or Individual Assignment. * @example individual * @enum {string} */ - readonly type: "individual" | "group"; + type: "individual" | "group"; /** * @description The link that a student can use to accept the assignment. * @example https://classroom.github.com/a/Lx7jiUgx */ - readonly invite_link: string; + invite_link: string; /** * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. * @example true */ - readonly invitations_enabled: boolean; + invitations_enabled: boolean; /** * @description Sluggified name of the assignment. * @example intro-to-binaries */ - readonly slug: string; + slug: string; /** * @description Whether students are admins on created repository on accepted assignment. * @example true */ - readonly students_are_repo_admins: boolean; + students_are_repo_admins: boolean; /** * @description Whether feedback pull request will be created on assignment acceptance. * @example true */ - readonly feedback_pull_requests_enabled: boolean; + feedback_pull_requests_enabled: boolean; /** * @description The maximum allowable teams for the assignment. * @example 0 */ - readonly max_teams?: number | null; + max_teams?: number | null; /** * @description The maximum allowable members per team. * @example 0 */ - readonly max_members?: number | null; + max_members?: number | null; /** * @description The selected editor for the assignment. * @example codespaces */ - readonly editor: string; + editor: string; /** * @description The number of students that have accepted the assignment. * @example 25 */ - readonly accepted: number; + accepted: number; /** * @description The number of students that have submitted the assignment. * @example 10 */ - readonly submitted: number; + submitted: number; /** * @description The number of students that have passed the assignment. * @example 10 */ - readonly passing: number; + passing: number; /** * @description The programming language used in the assignment. * @example elixir */ - readonly language: string; + language: string; /** * Format: date-time * @description The time at which the assignment is due. * @example 2011-01-26T19:06:43Z */ - readonly deadline: string | null; - readonly classroom: components["schemas"]["simple-classroom"]; + deadline: string | null; + classroom: components["schemas"]["simple-classroom"]; }; /** * Classroom Accepted Assignment * @description A GitHub Classroom accepted assignment */ - readonly "classroom-accepted-assignment": { + "classroom-accepted-assignment": { /** * @description Unique identifier of the repository. * @example 42 */ - readonly id: number; + id: number; /** * @description Whether an accepted assignment has been submitted. * @example true */ - readonly submitted: boolean; + submitted: boolean; /** * @description Whether a submission passed. * @example true */ - readonly passing: boolean; + passing: boolean; /** * @description Count of student commits. * @example 5 */ - readonly commit_count: number; + commit_count: number; /** * @description Most recent grade. * @example 10/10 */ - readonly grade: string; - readonly students: readonly components["schemas"]["simple-classroom-user"][]; - readonly repository: components["schemas"]["simple-classroom-repository"]; - readonly assignment: components["schemas"]["simple-classroom-assignment"]; + grade: string; + students: components["schemas"]["simple-classroom-user"][]; + repository: components["schemas"]["simple-classroom-repository"]; + assignment: components["schemas"]["simple-classroom-assignment"]; }; /** * Classroom Assignment Grade * @description Grade for a student or groups GitHub Classroom assignment */ - readonly "classroom-assignment-grade": { + "classroom-assignment-grade": { /** @description Name of the assignment */ - readonly assignment_name: string; + assignment_name: string; /** @description URL of the assignment */ - readonly assignment_url: string; + assignment_url: string; /** @description URL of the starter code for the assignment */ - readonly starter_code_url: string; + starter_code_url: string; /** @description GitHub username of the student */ - readonly github_username: string; + github_username: string; /** @description Roster identifier of the student */ - readonly roster_identifier: string; + roster_identifier: string; /** @description Name of the student's assignment repository */ - readonly student_repository_name: string; + student_repository_name: string; /** @description URL of the student's assignment repository */ - readonly student_repository_url: string; + student_repository_url: string; /** @description Timestamp of the student's assignment submission */ - readonly submission_timestamp: string; + submission_timestamp: string; /** @description Number of points awarded to the student */ - readonly points_awarded: number; + points_awarded: number; /** @description Number of points available for the assignment */ - readonly points_available: number; + points_available: number; /** @description If a group assignment, name of the group the student is in */ - readonly group_name?: string; + group_name?: string; }; /** * Code Of Conduct * @description Code Of Conduct */ - readonly "code-of-conduct": { + "code-of-conduct": { /** @example contributor_covenant */ - readonly key: string; + key: string; /** @example Contributor Covenant */ - readonly name: string; + name: string; /** * Format: uri * @example https://api.github.com/codes_of_conduct/contributor_covenant */ - readonly url: string; + url: string; /** * @example # Contributor Covenant Code of Conduct * @@ -20371,413 +21463,472 @@ export interface components { * * This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/). */ - readonly body?: string; + body?: string; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; + }; + /** + * Actions cache retention limit for an enterprise + * @description GitHub Actions cache retention policy for an enterprise. + */ + "actions-cache-retention-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an enterprise + * @description GitHub Actions cache storage policy for an enterprise. + */ + "actions-cache-storage-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; }; /** @description A code security configuration */ - readonly "code-security-configuration": { + "code-security-configuration": { /** @description The ID of the code security configuration */ - readonly id?: number; + id?: number; /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name?: string; + name?: string; /** * @description The type of the code security configuration. * @enum {string} */ - readonly target_type?: "global" | "organization" | "enterprise"; + target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ - readonly description?: string; + description?: string; /** * @description The enablement status of GitHub Advanced Security * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal + * @enum {string|null} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set" | null; + /** @description Feature options for code scanning */ + code_scanning_options?: { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** * @description The enablement status of code scanning default setup * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; /** @description Feature options for code scanning default setup */ - readonly code_scanning_default_setup_options?: { + code_scanning_default_setup_options?: { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ - readonly runner_type?: "standard" | "labeled" | "not_set" | null; + runner_type?: "standard" | "labeled" | "not_set" | null; /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ - readonly runner_label?: string | null; + runner_label?: string | null; } | null; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; + reviewer_id: number; /** * @description The type of the bypass reviewer * @enum {string} */ - readonly reviewer_type: "TEAM" | "ROLE"; + reviewer_type: "TEAM" | "ROLE"; + /** @description The ID of the security configuration associated with this bypass reviewer */ + security_configuration_id?: number; }[]; }; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; /** * Format: uri * @description The URL of the configuration */ - readonly url?: string; + url?: string; /** * Format: uri * @description The URL of the configuration */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; }; + /** @description Security Configuration feature options for code scanning */ + "code-scanning-options": { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** @description Feature options for code scanning default setup */ - readonly "code-scanning-default-setup-options": { + "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ - readonly runner_type?: "standard" | "labeled" | "not_set"; + runner_type?: "standard" | "labeled" | "not_set"; /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ - readonly runner_label?: string | null; + runner_label?: string | null; } | null; /** @description A list of default code security configurations */ - readonly "code-security-default-configurations": readonly { + "code-security-default-configurations": { /** * @description The visibility of newly created repositories for which the code security configuration will be applied to by default * @enum {unknown} */ - readonly default_for_new_repos?: "public" | "private_and_internal" | "all"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; }[]; /** * Simple Repository * @description A GitHub repository. */ - readonly "simple-repository": { + "simple-repository": { /** * Format: int64 * @description A unique identifier of the repository. * @example 1296269 */ - readonly id: number; + id: number; /** * @description The GraphQL identifier of the repository. * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Hello-World */ - readonly name: string; + name: string; /** * @description The full, globally unique, name of the repository. * @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + owner: components["schemas"]["simple-user"]; /** @description Whether the repository is private. */ - readonly private: boolean; + private: boolean; /** * Format: uri * @description The URL to view the repository on GitHub.com. * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** * @description The repository description. * @example This your first repo! */ - readonly description: string | null; + description: string | null; /** @description Whether the repository is a fork. */ - readonly fork: boolean; + fork: boolean; /** * Format: uri * @description The URL to get more information about the repository from the GitHub API. * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** * @description A template for the API URL to download the repository as an archive. * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** * @description A template for the API URL to list the available assignees for issues in the repository. * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** * @description A template for the API URL to create or retrieve a raw Git blob in the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** * @description A template for the API URL to get information about branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** * @description A template for the API URL to get information about collaborators of the repository. * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** * @description A template for the API URL to get information about comments on the repository. * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** * @description A template for the API URL to get information about commits on the repository. * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** * @description A template for the API URL to compare two commits or refs. * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** * @description A template for the API URL to get the contents of the repository. * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @description A template for the API URL to list the contributors to the repository. * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @description The API URL to list the deployments of the repository. * @example https://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @description The API URL to list the downloads on the repository. * @example https://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @description The API URL to list the events of the repository. * @example https://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @description The API URL to list the forks of the repository. * @example https://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** * @description A template for the API URL to get information about Git commits of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** * @description A template for the API URL to get information about Git refs of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** * @description A template for the API URL to get information about Git tags of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** * @description A template for the API URL to get information about issue comments on the repository. * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** * @description A template for the API URL to get information about issue events on the repository. * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** * @description A template for the API URL to get information about issues on the repository. * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** * @description A template for the API URL to get information about deploy keys on the repository. * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** * @description A template for the API URL to get information about labels of the repository. * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @description The API URL to get information about the languages of the repository. * @example https://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @description The API URL to merge branches in the repository. * @example https://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** * @description A template for the API URL to get information about milestones of the repository. * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** * @description A template for the API URL to get information about notifications on the repository. * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** * @description A template for the API URL to get information about pull requests on the repository. * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** * @description A template for the API URL to get information about releases on the repository. * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** * Format: uri * @description The API URL to list the stargazers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** * @description A template for the API URL to get information about statuses of a commit. * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @description The API URL to list the subscribers on the repository. * @example https://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @description The API URL to subscribe to notifications for this repository. * @example https://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @description The API URL to get information about tags on the repository. * @example https://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @description The API URL to list the teams on the repository. * @example https://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** * @description A template for the API URL to create or retrieve a raw Git tree of the repository. * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** * Format: uri * @description The API URL to list the hooks on the repository. * @example https://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; }; /** @description Repositories associated with a code security configuration and attachment status */ - readonly "code-security-configuration-repositories": { + "code-security-configuration-repositories": { /** * @description The attachment status of the code security configuration on the repository. * @enum {string} */ - readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - readonly repository?: components["schemas"]["simple-repository"]; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ - readonly "alert-number": number; + "alert-number": number; /** @description Details for the vulnerable package. */ - readonly "dependabot-alert-package": { + "dependabot-alert-package": { /** @description The package's language or package management ecosystem. */ readonly ecosystem: string; /** @description The unique package name within its ecosystem. */ readonly name: string; }; /** @description Details pertaining to one vulnerable version range for the advisory. */ - readonly "dependabot-alert-security-vulnerability": { - readonly package: components["schemas"]["dependabot-alert-package"]; + "dependabot-alert-security-vulnerability": { + package: components["schemas"]["dependabot-alert-package"]; /** * @description The severity of the vulnerability. * @enum {string} @@ -20792,7 +21943,7 @@ export interface components { } | null; }; /** @description Details for the GitHub Security Advisory. */ - readonly "dependabot-alert-security-advisory": { + "dependabot-alert-security-advisory": { /** @description The unique GitHub Security Advisory ID assigned to the advisory. */ readonly ghsa_id: string; /** @description The unique CVE ID assigned to the advisory. */ @@ -20802,7 +21953,7 @@ export interface components { /** @description A long-form Markdown-supported description of the advisory. */ readonly description: string; /** @description Vulnerable version range information for the advisory. */ - readonly vulnerabilities: readonly components["schemas"]["dependabot-alert-security-vulnerability"][]; + readonly vulnerabilities: components["schemas"]["dependabot-alert-security-vulnerability"][]; /** * @description The severity of the advisory. * @enum {string} @@ -20815,17 +21966,17 @@ export interface components { /** @description The full CVSS vector string for the advisory. */ readonly vector_string: string | null; }; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly epss?: components["schemas"]["security-advisory-epss"]; + cvss_severities?: components["schemas"]["cvss-severities"]; + epss?: components["schemas"]["security-advisory-epss"]; /** @description Details for the advisory pertaining to Common Weakness Enumeration. */ - readonly cwes: readonly { + readonly cwes: { /** @description The unique CWE ID. */ readonly cwe_id: string; /** @description The short, plain text name of the CWE. */ readonly name: string; }[]; /** @description Values that identify this advisory among security information sources. */ - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of advisory identifier. * @enum {string} @@ -20835,7 +21986,7 @@ export interface components { readonly value: string; }[]; /** @description Links to additional advisory information. */ - readonly references: readonly { + readonly references: { /** * Format: uri * @description The URL of the reference. @@ -20862,40 +22013,70 @@ export interface components { * Format: uri * @description The REST API URL of the alert resource. */ - readonly "alert-url": string; + "alert-url": string; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly "alert-html-url": string; + "alert-html-url": string; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-created-at": string; + "alert-created-at": string; /** * Format: date-time * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-updated-at": string; + "alert-updated-at": string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-dismissed-at": string | null; + "alert-dismissed-at": string | null; /** * Format: date-time * @description The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-fixed-at": string | null; + "alert-fixed-at": string | null; /** * Format: date-time * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "alert-auto-dismissed-at": string | null; + "alert-auto-dismissed-at": string | null; + /** + * Dependabot alert dismissal request + * @description Information about an active dismissal request for this Dependabot alert. + */ + "dependabot-alert-dismissal-request-simple": { + /** @description The unique identifier of the dismissal request. */ + id?: number; + /** + * @description The current status of the dismissal request. + * @enum {string} + */ + status?: "pending" | "approved" | "rejected" | "cancelled"; + /** @description The user who requested the dismissal. */ + requester?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The login name of the user. */ + login?: string; + }; + /** + * Format: date-time + * @description The date and time when the dismissal request was created. + */ + created_at?: string; + /** + * Format: uri + * @description The API URL to get more information about this dismissal request. + */ + url?: string; + } | null; /** @description A Dependabot alert. */ - readonly "dependabot-alert-with-repository": { - readonly number: components["schemas"]["alert-number"]; + "dependabot-alert-with-repository": { + number: components["schemas"]["alert-number"]; /** * @description The state of the Dependabot alert. * @enum {string} @@ -20903,7 +22084,7 @@ export interface components { readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ readonly dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -20911,230 +22092,461 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; - readonly security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; - readonly security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at: components["schemas"]["alert-updated-at"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; + security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; + security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at: components["schemas"]["alert-updated-at"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; /** * @description The reason that the alert was dismissed. * @enum {string|null} */ - readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; + dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; /** @description An optional comment associated with the alert's dismissal. */ - readonly dismissed_comment: string | null; - readonly fixed_at: components["schemas"]["alert-fixed-at"]; - readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; - readonly repository: components["schemas"]["simple-repository"]; + dismissed_comment: string | null; + fixed_at: components["schemas"]["alert-fixed-at"]; + auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; + repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly "nullable-alert-updated-at": string | null; - /** - * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. - * @enum {string} - */ - readonly "secret-scanning-alert-state": "open" | "resolved"; - /** - * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. - * @enum {string|null} + * Enterprise Team + * @description Group of enterprise owners and/or members */ - readonly "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; - readonly "organization-secret-scanning-alert": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + description?: string; + slug: string; + /** Format: uri */ + url: string; /** - * Format: uri - * @description The REST API URL of the code locations for this alert. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example disabled | all */ - readonly locations_url?: string; - readonly state?: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + sync_to_organizations?: string; + /** @example disabled | selected | all */ + organization_selection_type?: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id: string | null; /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example Justice League */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + group_name?: string | null; /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league */ - readonly secret_type_display_name?: string; - /** @description The secret that was detected. */ - readonly secret?: string; - readonly repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * Format: uri + * @example https://api.github.com/orgs/github */ - readonly push_protection_bypassed_at?: string | null; - readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ - readonly push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ - readonly push_protection_bypass_request_comment?: string | null; + url: string; /** * Format: uri - * @description The URL to a push protection bypass request. + * @example https://api.github.com/orgs/github/repos */ - readonly push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ - readonly resolution_comment?: string | null; + repos_url: string; /** - * @description The token status as of the latest validity check. - * @enum {string} + * Format: uri + * @example https://api.github.com/orgs/github/events */ - 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; + 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; }; /** * Actor * @description Actor */ - readonly actor: { - readonly id: number; - readonly login: string; - readonly display_login?: string; - readonly gravatar_id: string | null; + actor: { + id: number; + login: string; + display_login?: string; + gravatar_id: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly avatar_url: string; + avatar_url: string; + }; + /** + * Label + * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + /** + * Format: int64 + * @description Unique identifier for the label. + * @example 208045946 + */ + id: number; + /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ + node_id: string; + /** + * Format: uri + * @description URL for the label + * @example https://api.github.com/repositories/42/labels/bug + */ + url: string; + /** + * @description The name of the label. + * @example bug + */ + name: string; + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ + description: string | null; + /** + * @description 6-character hex code, without the leading #, identifying the color + * @example FFFFFF + */ + color: string; + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ + default: boolean; + }; + /** + * Discussion + * @description A Discussion in a repository. + */ + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** Reactions */ + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + /** + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} + */ + state: "open" | "closed" | "locked" | "converting" | "transferring"; + /** + * @description The reason for the current state + * @example resolved + * @enum {string|null} + */ + state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + labels?: components["schemas"]["label"][]; }; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly "nullable-milestone": { + "nullable-milestone": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - readonly labels_url: string; + labels_url: string; /** @example 1002604 */ - readonly id: number; + id: number; /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - readonly node_id: string; + node_id: string; /** * @description The number of the milestone. * @example 42 */ - readonly number: number; + number: number; /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** * @description The title of the milestone. * @example v1.0 */ - readonly title: string; + title: string; /** @example Tracking milestone for version 1.0 */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ - readonly open_issues: number; + open_issues: number; /** @example 8 */ - readonly closed_issues: number; + closed_issues: number; /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - readonly closed_at: string | null; + closed_at: string | null; /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - readonly due_on: string | null; + due_on: string | null; + } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly "nullable-integration": { + "nullable-integration": { /** * @description Unique identifier of the GitHub app * @example 37 */ - readonly id: number; + id: number; /** * @description The slug name of the GitHub app * @example probot-owners */ - readonly slug?: string; + slug?: string; /** @example MDExOkludGVncmF0aW9uMQ== */ - readonly node_id: string; + node_id: string; /** @example "Iv1.25b5d1e65ffc4022" */ - readonly client_id?: string; - readonly owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; + client_id?: string; + owner: components["schemas"]["simple-user"] | components["schemas"]["enterprise"]; /** * @description The name of the GitHub app * @example Probot Owners */ - readonly name: string; + name: string; /** @example The description of the app. */ - readonly description: string | null; + description: string | null; /** * Format: uri * @example https://example.com */ - readonly external_url: string; + external_url: string; /** * Format: uri * @example https://github.com/apps/super-ci */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2017-07-08T16:18:44-04:00 */ - readonly updated_at: string; + updated_at: string; /** * @description The set of permissions for the GitHub app * @example { @@ -21142,34 +22554,28 @@ export interface components { * "deployments": "write" * } */ - readonly permissions: { - readonly issues?: string; - readonly checks?: string; - readonly metadata?: string; - readonly contents?: string; - readonly deployments?: string; + permissions: { + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; } & { - readonly [key: string]: string; + [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" * ] */ - readonly events: readonly string[]; + events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ - readonly installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - readonly client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - readonly webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - readonly pem?: string; + installations_count?: number; } | null; /** * author_association @@ -21177,77 +22583,182 @@ export interface components { * @example OWNER * @enum {string} */ - readonly "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + "author-association": "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** Reaction Rollup */ - readonly "reaction-rollup": { + "reaction-rollup": { /** Format: uri */ - readonly url: string; - readonly total_count: number; - readonly "+1": number; - readonly "-1": number; - readonly laugh: number; - readonly confused: number; - readonly heart: number; - readonly hooray: number; - readonly eyes: number; - readonly rocket: number; + url: string; + total_count: number; + "+1": number; + "-1": number; + laugh: number; + confused: number; + heart: number; + hooray: number; + eyes: number; + rocket: number; }; /** Sub-issues Summary */ - readonly "sub-issues-summary": { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; + "sub-issues-summary": { + total: number; + completed: number; + percent_completed: number; + }; + /** + * Pinned Issue Comment + * @description Context around who pinned an issue comment and when it was pinned. + */ + "nullable-pinned-issue-comment": { + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + pinned_at: string; + pinned_by: components["schemas"]["nullable-simple-user"]; + } | null; + /** + * Issue Comment + * @description Comments provide a way for people to collaborate on an issue. + */ + "nullable-issue-comment": { + /** + * Format: int64 + * @description Unique identifier of the issue comment + * @example 42 + */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the issue comment + * @example https://api.github.com/repositories/42/issues/comments/1 + */ + url: string; + /** + * @description Contents of the issue comment + * @example What version of Safari were you using when you observed this bug? + */ + body?: string; + body_text?: string; + body_html?: string; + /** Format: uri */ + html_url: string; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + updated_at: string; + /** Format: uri */ + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + } | null; + /** Issue Dependencies Summary */ + "issue-dependencies-summary": { + blocked_by: number; + blocking: number; + total_blocked_by: number; + total_blocking: number; + }; + /** + * Issue Field Value + * @description A value assigned to an issue field + */ + "issue-field-value": { + /** + * Format: int64 + * @description Unique identifier for the issue field. + * @example 1 + */ + issue_field_id: number; + /** @example IFT_GDKND */ + node_id: string; + /** + * @description The data type of the issue field + * @example text + * @enum {string} + */ + data_type: "text" | "single_select" | "number" | "date"; + /** @description The value of the issue field */ + value: (string | number) | null; + /** @description Details about the selected option (only present for single_select fields) */ + single_select_option?: { + /** + * Format: int64 + * @description Unique identifier for the option. + * @example 1 + */ + id: number; + /** + * @description The name of the option + * @example High + */ + name: string; + /** + * @description The color of the option + * @example red + */ + color: string; + } | null; }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - readonly issue: { + issue: { /** Format: int64 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - readonly url: string; + url: string; /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + repository_url: string; + labels_url: string; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - readonly number: number; + number: number; /** * @description State of the issue; either 'open' or 'closed' * @example open */ - readonly state: string; + state: string; /** * @description The reason for the current state * @example not_planned * @enum {string|null} */ - readonly state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - readonly title: string; + title: string; /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - readonly body?: string | null; - readonly user: components["schemas"]["nullable-simple-user"]; + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ @@ -21255,484 +22766,604 @@ export interface components { * "registration" * ] */ - readonly labels: readonly (string | { + labels: (string | { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - /** Format: uri */ - readonly url?: string; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; - readonly default?: boolean; + id?: number; + node_id?: string; + /** Format: uri */ + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; })[]; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly comments: number; - readonly pull_request?: { + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: components["schemas"]["nullable-milestone"]; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly diff_url: string | null; + diff_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly patch_url: string | null; + patch_url: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; /** Format: date-time */ - readonly closed_at: string | null; + closed_at: string | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly draft?: boolean; - readonly closed_by?: components["schemas"]["nullable-simple-user"]; - readonly body_html?: string; - readonly body_text?: string; + updated_at: string; + draft?: boolean; + closed_by?: components["schemas"]["nullable-simple-user"]; + body_html?: string; + body_text?: string; /** Format: uri */ - readonly timeline_url?: string; - readonly repository?: components["schemas"]["repository"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly author_association: components["schemas"]["author-association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + author_association?: components["schemas"]["author-association"]; + reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; }; /** * Issue Comment * @description Comments provide a way for people to collaborate on an issue. */ - readonly "issue-comment": { + "issue-comment": { /** * Format: int64 * @description Unique identifier of the issue comment * @example 42 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - readonly url: string; + url: string; /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - readonly body?: string; - readonly body_text?: string; - readonly body_html?: string; + body?: string; + body_text?: string; + body_html?: string; /** Format: uri */ - readonly html_url: string; - readonly user: components["schemas"]["nullable-simple-user"]; + html_url: string; + user: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly issue_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + }; + /** Pull Request Minimal */ + "pull-request-minimal": { + /** Format: int64 */ + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + }; + /** + * Release Asset + * @description Data related to a release. + */ + "release-asset": { + /** Format: uri */ + url: string; + /** Format: uri */ + browser_download_url: string; + id: number; + node_id: string; + /** + * @description The file name of the asset. + * @example Team Environment + */ + name: string; + label: string | null; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded" | "open"; + content_type: string; + size: number; + digest: string | null; + download_count: number; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + uploader: components["schemas"]["nullable-simple-user"]; + }; + /** + * Release + * @description A release. + */ + release: { + /** Format: uri */ + url: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + assets_url: string; + upload_url: string; + /** Format: uri */ + tarball_url: string | null; + /** Format: uri */ + zipball_url: string | null; + id: number; + node_id: string; + /** + * @description The name of the tag. + * @example v1.0.0 + */ + tag_name: string; + /** + * @description Specifies the commitish value that determines where the Git tag is created from. + * @example master + */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ + draft: boolean; + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ + prerelease: boolean; + /** + * @description Whether or not the release is immutable. + * @example false + */ + immutable?: boolean; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + published_at: string | null; + /** Format: date-time */ + updated_at?: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + mentions_count?: number; + /** + * Format: uri + * @description The URL of the release discussion. + */ + discussion_url?: string; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Event * @description Event */ - readonly event: { - readonly id: string; - readonly type: string | null; - readonly actor: components["schemas"]["actor"]; - readonly repo: { - readonly id: number; - readonly name: string; + event: { + id: string; + type: string | null; + actor: components["schemas"]["actor"]; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; - }; - readonly org?: components["schemas"]["actor"]; - readonly payload: { - readonly action?: string; - readonly issue?: components["schemas"]["issue"]; - readonly comment?: components["schemas"]["issue-comment"]; - readonly pages?: readonly { - readonly page_name?: string; - readonly title?: string; - readonly summary?: string | null; - readonly action?: string; - readonly sha?: string; - readonly html_url?: string; - }[]; + url: string; }; - readonly public: boolean; + org?: components["schemas"]["actor"]; + payload: components["schemas"]["create-event"] | components["schemas"]["delete-event"] | components["schemas"]["discussion-event"] | components["schemas"]["issues-event"] | components["schemas"]["issue-comment-event"] | components["schemas"]["fork-event"] | components["schemas"]["gollum-event"] | components["schemas"]["member-event"] | components["schemas"]["public-event"] | components["schemas"]["push-event"] | components["schemas"]["pull-request-event"] | components["schemas"]["pull-request-review-comment-event"] | components["schemas"]["pull-request-review-event"] | components["schemas"]["commit-comment-event"] | components["schemas"]["release-event"] | components["schemas"]["watch-event"]; + public: boolean; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; }; /** * Link With Type * @description Hypermedia Link with Type */ - readonly "link-with-type": { - readonly href: string; - readonly type: string; + "link-with-type": { + href: string; + type: string; }; /** * Feed * @description Feed */ - readonly feed: { + feed: { /** @example https://github.com/timeline */ - readonly timeline_url: string; + timeline_url: string; /** @example https://github.com/{user} */ - readonly user_url: string; + user_url: string; /** @example https://github.com/octocat */ - readonly current_user_public_url?: string; + current_user_public_url?: string; /** @example https://github.com/octocat.private?token=abc123 */ - readonly current_user_url?: string; + current_user_url?: string; /** @example https://github.com/octocat.private.actor?token=abc123 */ - readonly current_user_actor_url?: string; + current_user_actor_url?: string; /** @example https://github.com/octocat-org */ - readonly current_user_organization_url?: string; + current_user_organization_url?: string; /** * @example [ * "https://github.com/organizations/github/octocat.private.atom?token=abc123" * ] */ - readonly current_user_organization_urls?: readonly string[]; + current_user_organization_urls?: string[]; /** @example https://github.com/security-advisories */ - readonly security_advisories_url?: string; + security_advisories_url?: string; /** * @description A feed of discussions for a given repository. * @example https://github.com/{user}/{repo}/discussions */ - readonly repository_discussions_url?: string; + repository_discussions_url?: string; /** * @description A feed of discussions for a given repository and category. * @example https://github.com/{user}/{repo}/discussions/categories/{category} */ - readonly repository_discussions_category_url?: string; - readonly _links: { - readonly timeline: components["schemas"]["link-with-type"]; - readonly user: components["schemas"]["link-with-type"]; - readonly security_advisories?: components["schemas"]["link-with-type"]; - readonly current_user?: components["schemas"]["link-with-type"]; - readonly current_user_public?: components["schemas"]["link-with-type"]; - readonly current_user_actor?: components["schemas"]["link-with-type"]; - readonly current_user_organization?: components["schemas"]["link-with-type"]; - readonly current_user_organizations?: readonly components["schemas"]["link-with-type"][]; - readonly repository_discussions?: components["schemas"]["link-with-type"]; - readonly repository_discussions_category?: components["schemas"]["link-with-type"]; + repository_discussions_category_url?: string; + _links: { + timeline: components["schemas"]["link-with-type"]; + user: components["schemas"]["link-with-type"]; + security_advisories?: components["schemas"]["link-with-type"]; + current_user?: components["schemas"]["link-with-type"]; + current_user_public?: components["schemas"]["link-with-type"]; + current_user_actor?: components["schemas"]["link-with-type"]; + current_user_organization?: components["schemas"]["link-with-type"]; + current_user_organizations?: components["schemas"]["link-with-type"][]; + repository_discussions?: components["schemas"]["link-with-type"]; + repository_discussions_category?: components["schemas"]["link-with-type"]; }; }; /** * Base Gist * @description Base Gist */ - readonly "base-gist": { + "base-gist": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly forks_url: string; + forks_url: string; /** Format: uri */ - readonly commits_url: string; - readonly id: string; - readonly node_id: string; + commits_url: string; + id: string; + node_id: string; /** Format: uri */ - readonly git_pull_url: string; + git_pull_url: string; /** Format: uri */ - readonly git_push_url: string; + git_push_url: string; /** Format: uri */ - readonly html_url: string; - readonly files: { - readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding: string; + encoding: string; }; }; - readonly public: boolean; + public: boolean; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly description: string | null; - readonly comments: number; - readonly comments_enabled?: boolean; - readonly user: components["schemas"]["nullable-simple-user"]; + updated_at: string; + description: string | null; + comments: number; + comments_enabled?: boolean; + user: components["schemas"]["nullable-simple-user"]; /** Format: uri */ - readonly comments_url: string; - readonly owner?: components["schemas"]["simple-user"]; - readonly truncated?: boolean; - readonly forks?: readonly unknown[]; - readonly history?: readonly unknown[]; + comments_url: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; + forks?: unknown[]; + history?: unknown[]; }; /** * Public User * @description Public User */ - readonly "public-user": { - readonly login: string; + "public-user": { + login: string; /** Format: int64 */ - readonly id: number; + id: number; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly user_view_type: "public"; - readonly node_id: string; + user_view_type: "public"; + node_id: string; /** Format: uri */ - readonly avatar_url: string; - readonly gravatar_id: string | null; + avatar_url: string; + gravatar_id: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly starred_url: string; + followers_url: string; + following_url: string; + gists_url: string; + starred_url: string; /** Format: uri */ - readonly subscriptions_url: string; + subscriptions_url: string; /** Format: uri */ - readonly organizations_url: string; + organizations_url: string; /** Format: uri */ - readonly repos_url: string; - readonly events_url: string; + repos_url: string; + events_url: string; /** Format: uri */ - readonly received_events_url: string; - readonly type: string; - readonly site_admin: boolean; - readonly name: string | null; - readonly company: string | null; - readonly blog: string | null; - readonly location: string | null; + received_events_url: string; + type: string; + site_admin: boolean; + name: string | null; + company: string | null; + blog: string | null; + location: string | null; /** Format: email */ - readonly email: string | null; + email: string | null; /** Format: email */ - readonly notification_email?: string | null; - readonly hireable: boolean | null; - readonly bio: string | null; - readonly twitter_username?: string | null; - readonly public_repos: number; - readonly public_gists: number; - readonly followers: number; - readonly following: number; + notification_email?: string | null; + hireable: boolean | null; + bio: string | null; + twitter_username?: string | null; + public_repos: number; + public_gists: number; + followers: number; + following: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly plan?: { - readonly collaborators: number; - readonly name: string; - readonly space: number; - readonly private_repos: number; + updated_at: string; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; }; /** @example 1 */ - readonly private_gists?: number; + private_gists?: number; /** @example 2 */ - readonly total_private_repos?: number; + total_private_repos?: number; /** @example 2 */ - readonly owned_private_repos?: number; + owned_private_repos?: number; /** @example 1 */ - readonly disk_usage?: number; + disk_usage?: number; /** @example 3 */ - readonly collaborators?: number; + collaborators?: number; }; /** * Gist History * @description Gist History */ - readonly "gist-history": { - readonly user?: components["schemas"]["nullable-simple-user"]; - readonly version?: string; + "gist-history": { + user?: components["schemas"]["nullable-simple-user"]; + version?: string; /** Format: date-time */ - readonly committed_at?: string; - readonly change_status?: { - readonly total?: number; - readonly additions?: number; - readonly deletions?: number; + committed_at?: string; + change_status?: { + total?: number; + additions?: number; + deletions?: number; }; /** Format: uri */ - readonly url?: string; + url?: string; }; /** * Gist Simple * @description Gist Simple */ - readonly "gist-simple": { + "gist-simple": { /** @deprecated */ - readonly forks?: readonly { - readonly id?: string; + forks?: { + id?: string; /** Format: uri */ - readonly url?: string; - readonly user?: components["schemas"]["public-user"]; + url?: string; + user?: components["schemas"]["public-user"]; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; }[] | null; /** @deprecated */ - readonly history?: readonly components["schemas"]["gist-history"][] | null; + history?: components["schemas"]["gist-history"][] | null; /** * Gist * @description Gist */ - readonly fork_of?: { + fork_of?: { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly forks_url: string; + forks_url: string; /** Format: uri */ - readonly commits_url: string; - readonly id: string; - readonly node_id: string; + commits_url: string; + id: string; + node_id: string; /** Format: uri */ - readonly git_pull_url: string; + git_pull_url: string; /** Format: uri */ - readonly git_push_url: string; + git_push_url: string; /** Format: uri */ - readonly html_url: string; - readonly files: { - readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; + html_url: string; + files: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; }; }; - readonly public: boolean; + public: boolean; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly description: string | null; - readonly comments: number; - readonly comments_enabled?: boolean; - readonly user: components["schemas"]["nullable-simple-user"]; - /** Format: uri */ - readonly comments_url: string; - readonly owner?: components["schemas"]["nullable-simple-user"]; - readonly truncated?: boolean; - readonly forks?: readonly unknown[]; - readonly history?: readonly unknown[]; + updated_at: string; + description: string | null; + comments: number; + comments_enabled?: boolean; + user: components["schemas"]["nullable-simple-user"]; + /** Format: uri */ + comments_url: string; + owner?: components["schemas"]["nullable-simple-user"]; + truncated?: boolean; + forks?: unknown[]; + history?: unknown[]; } | null; - readonly url?: string; - readonly forks_url?: string; - readonly commits_url?: string; - readonly id?: string; - readonly node_id?: string; - readonly git_pull_url?: string; - readonly git_push_url?: string; - readonly html_url?: string; - readonly files?: { - readonly [key: string]: { - readonly filename?: string; - readonly type?: string; - readonly language?: string; - readonly raw_url?: string; - readonly size?: number; - readonly truncated?: boolean; - readonly content?: string; + url?: string; + forks_url?: string; + commits_url?: string; + id?: string; + node_id?: string; + git_pull_url?: string; + git_push_url?: string; + html_url?: string; + files?: { + [key: string]: { + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding: string; + encoding: string; } | null; }; - readonly public?: boolean; - readonly created_at?: string; - readonly updated_at?: string; - readonly description?: string | null; - readonly comments?: number; - readonly comments_enabled?: boolean; - readonly user?: string | null; - readonly comments_url?: string; - readonly owner?: components["schemas"]["simple-user"]; - readonly truncated?: boolean; + public?: boolean; + created_at?: string; + updated_at?: string; + description?: string | null; + comments?: number; + comments_enabled?: boolean; + user?: string | null; + comments_url?: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; }; /** * Gist Comment * @description A comment made to a gist. */ - readonly "gist-comment": { + "gist-comment": { /** @example 1 */ - readonly id: number; + id: number; /** @example MDExOkdpc3RDb21tZW50MQ== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - readonly url: string; + url: string; /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; - readonly user: components["schemas"]["nullable-simple-user"]; + body: string; + user: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-18T23:23:56Z */ - readonly updated_at: string; - readonly author_association: components["schemas"]["author-association"]; + updated_at: string; + author_association: components["schemas"]["author-association"]; }; /** * Gist Commit * @description Gist Commit */ - readonly "gist-commit": { + "gist-commit": { /** * Format: uri * @example https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f */ - readonly url: string; + url: string; /** @example 57a7f021a713b1c5a6a199b54cc514735d2d462f */ - readonly version: string; - readonly user: components["schemas"]["nullable-simple-user"]; - readonly change_status: { - readonly total?: number; - readonly additions?: number; - readonly deletions?: number; + version: string; + user: components["schemas"]["nullable-simple-user"]; + change_status: { + total?: number; + additions?: number; + deletions?: number; }; /** * Format: date-time * @example 2010-04-14T02:15:15Z */ - readonly committed_at: string; + committed_at: string; }; /** * Gitignore Template * @description Gitignore Template */ - readonly "gitignore-template": { + "gitignore-template": { /** @example C */ - readonly name: string; + name: string; /** * @example # Object files * *.o @@ -21752,56 +23383,56 @@ export interface components { * *.out * *.app */ - readonly source: string; + source: string; }; /** * License Simple * @description License Simple */ - readonly "license-simple": { + "license-simple": { /** @example mit */ - readonly key: string; + key: string; /** @example MIT License */ - readonly name: string; + name: string; /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + url: string | null; /** @example MIT */ - readonly spdx_id: string | null; + spdx_id: string | null; /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + node_id: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; }; /** * License * @description License */ - readonly license: { + license: { /** @example mit */ - readonly key: string; + key: string; /** @example MIT License */ - readonly name: string; + name: string; /** @example MIT */ - readonly spdx_id: string | null; + spdx_id: string | null; /** * Format: uri * @example https://api.github.com/licenses/mit */ - readonly url: string | null; + url: string | null; /** @example MDc6TGljZW5zZW1pdA== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example http://choosealicense.com/licenses/mit/ */ - readonly html_url: string; + html_url: string; /** @example A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty. */ - readonly description: string; + description: string; /** @example Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders. */ - readonly implementation: string; + implementation: string; /** * @example [ * "commercial-use", @@ -21811,19 +23442,19 @@ export interface components { * "private-use" * ] */ - readonly permissions: readonly string[]; + permissions: string[]; /** * @example [ * "include-copyright" * ] */ - readonly conditions: readonly string[]; + conditions: string[]; /** * @example [ * "no-liability" * ] */ - readonly limitations: readonly string[]; + limitations: string[]; /** * @example The MIT License (MIT) * @@ -21847,689 +23478,1178 @@ export interface components { * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ - readonly body: string; + body: string; /** @example true */ - readonly featured: boolean; + featured: boolean; }; /** * Marketplace Listing Plan * @description Marketplace Listing Plan */ - readonly "marketplace-listing-plan": { + "marketplace-listing-plan": { /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313 */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/marketplace_listing/plans/1313/accounts */ - readonly accounts_url: string; + accounts_url: string; /** @example 1313 */ - readonly id: number; + id: number; /** @example 3 */ - readonly number: number; + number: number; /** @example Pro */ - readonly name: string; + name: string; /** @example A professional-grade CI solution */ - readonly description: string; + description: string; /** @example 1099 */ - readonly monthly_price_in_cents: number; + monthly_price_in_cents: number; /** @example 11870 */ - readonly yearly_price_in_cents: number; + yearly_price_in_cents: number; /** * @example FLAT_RATE * @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; /** @example true */ - readonly has_free_trial: boolean; - readonly unit_name: string | null; + has_free_trial: boolean; + unit_name: string | null; /** @example published */ - readonly state: string; + state: string; /** * @example [ * "Up to 25 private repositories", * "11 concurrent builds" * ] */ - readonly bullets: readonly string[]; + bullets: string[]; }; /** * Marketplace Purchase * @description Marketplace Purchase */ - readonly "marketplace-purchase": { - readonly url: string; - readonly type: string; - readonly id: number; - readonly login: string; - readonly organization_billing_email?: string; - readonly email?: string | null; - readonly marketplace_pending_change?: { - readonly is_installed?: boolean; - readonly effective_date?: string; - readonly unit_count?: number | null; - readonly id?: number; - readonly plan?: components["schemas"]["marketplace-listing-plan"]; + "marketplace-purchase": { + url: string; + type: string; + id: number; + login: string; + organization_billing_email?: string; + email?: string | null; + marketplace_pending_change?: { + is_installed?: boolean; + effective_date?: string; + unit_count?: number | null; + id?: number; + plan?: components["schemas"]["marketplace-listing-plan"]; } | null; - readonly marketplace_purchase: { - readonly billing_cycle?: string; - readonly next_billing_date?: string | null; - readonly is_installed?: boolean; - readonly unit_count?: number | null; - readonly on_free_trial?: boolean; - readonly free_trial_ends_on?: string | null; - readonly updated_at?: string; - readonly plan?: components["schemas"]["marketplace-listing-plan"]; + marketplace_purchase: { + billing_cycle?: string; + next_billing_date?: string | null; + is_installed?: boolean; + unit_count?: number | null; + on_free_trial?: boolean; + free_trial_ends_on?: string | null; + updated_at?: string; + plan?: components["schemas"]["marketplace-listing-plan"]; }; }; /** * Api Overview * @description Api Overview */ - readonly "api-overview": { + "api-overview": { /** @example true */ - readonly verifiable_password_authentication: boolean; - readonly ssh_key_fingerprints?: { - readonly SHA256_RSA?: string; - readonly SHA256_DSA?: string; - readonly SHA256_ECDSA?: string; - readonly SHA256_ED25519?: string; + verifiable_password_authentication: boolean; + ssh_key_fingerprints?: { + SHA256_RSA?: string; + SHA256_DSA?: string; + SHA256_ECDSA?: string; + SHA256_ED25519?: string; }; /** * @example [ * "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ" * ] */ - readonly ssh_keys?: readonly string[]; + ssh_keys?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly hooks?: readonly string[]; + hooks?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly github_enterprise_importer?: readonly string[]; + github_enterprise_importer?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly web?: readonly string[]; + web?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly api?: readonly string[]; + api?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly git?: readonly string[]; + git?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly packages?: readonly string[]; + packages?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly pages?: readonly string[]; + pages?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly importer?: readonly string[]; + importer?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly actions?: readonly string[]; + actions?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly actions_macos?: readonly string[]; + actions_macos?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly codespaces?: readonly string[]; + codespaces?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly dependabot?: readonly string[]; + dependabot?: string[]; /** * @example [ * "192.0.2.1" * ] */ - readonly copilot?: readonly string[]; - readonly domains?: { - readonly website?: readonly string[]; - readonly codespaces?: readonly string[]; - readonly copilot?: readonly string[]; - readonly packages?: readonly string[]; - readonly actions?: readonly string[]; - readonly actions_inbound?: { - readonly full_domains?: readonly string[]; - readonly wildcard_domains?: readonly string[]; + copilot?: string[]; + domains?: { + website?: string[]; + codespaces?: string[]; + copilot?: string[]; + packages?: string[]; + actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; }; - readonly artifact_attestations?: { + artifact_attestations?: { /** * @example [ * "example" * ] */ - readonly trust_domain?: string; - readonly services?: readonly string[]; + trust_domain?: string; + services?: string[]; }; }; }; - readonly "security-and-analysis": { - readonly advanced_security?: { + "security-and-analysis": { + /** + * @description Enable or disable GitHub Advanced Security for the repository. + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ + advanced_security?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + code_security?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; }; /** @description Enable or disable Dependabot security updates for the repository. */ - readonly dependabot_security_updates?: { + dependabot_security_updates?: { /** * @description The enablement status of Dependabot security updates for the repository. * @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + secret_scanning?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; }; - readonly secret_scanning?: { + secret_scanning_push_protection?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - readonly secret_scanning_push_protection?: { + secret_scanning_non_provider_patterns?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - readonly secret_scanning_non_provider_patterns?: { + secret_scanning_ai_detection?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - readonly secret_scanning_ai_detection?: { + secret_scanning_delegated_alert_dismissal?: { /** @enum {string} */ - readonly status?: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + secret_scanning_delegated_bypass?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + 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"; + }[]; }; } | null; /** * Minimal Repository * @description Minimal Repository */ - readonly "minimal-repository": { + "minimal-repository": { /** * Format: int64 * @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @example Hello-World */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - readonly git_url?: string; + git_tags_url: string; + git_url?: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - readonly ssh_url?: string; + releases_url: string; + ssh_url?: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - readonly clone_url?: string; - readonly mirror_url?: string | null; + trees_url: string; + clone_url?: string; + mirror_url?: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; - readonly svn_url?: string; - readonly homepage?: string | null; - readonly language?: string | null; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; + hooks_url: string; + svn_url?: string; + homepage?: string | null; + language?: string | null; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly has_discussions?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived?: boolean; + disabled?: boolean; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string | null; + pushed_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at?: string | null; + created_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at?: string | null; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; + updated_at?: string | null; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; /** @example admin */ - readonly role_name?: string; - readonly temp_clone_token?: string; - readonly delete_branch_on_merge?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; - readonly license?: { - readonly key?: string; - readonly name?: string; - readonly spdx_id?: string; - readonly url?: string; - readonly node_id?: string; + role_name?: string; + temp_clone_token?: string; + delete_branch_on_merge?: boolean; + subscribers_count?: number; + network_count?: number; + code_of_conduct?: components["schemas"]["code-of-conduct"]; + license?: { + key?: string; + name?: string; + spdx_id?: string; + url?: string | null; + node_id?: string; } | null; /** @example 0 */ - readonly forks?: number; + forks?: number; /** @example 0 */ - readonly open_issues?: number; + open_issues?: number; /** @example 0 */ - readonly watchers?: number; - readonly allow_forking?: boolean; + watchers?: number; + allow_forking?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + web_commit_signoff_required?: boolean; + security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Thread * @description Thread */ - readonly thread: { - readonly id: string; - readonly repository: components["schemas"]["minimal-repository"]; - readonly subject: { - readonly title: string; - readonly url: string; - readonly latest_comment_url: string; - readonly type: string; - }; - readonly reason: string; - readonly unread: boolean; - readonly updated_at: string; - readonly last_read_at: string | null; - readonly url: string; + thread: { + id: string; + repository: components["schemas"]["minimal-repository"]; + subject: { + title: string; + url: string; + latest_comment_url: string; + type: string; + }; + reason: string; + unread: boolean; + updated_at: string; + last_read_at: string | null; + url: string; /** @example https://api.github.com/notifications/threads/2/subscription */ - readonly subscription_url: string; + subscription_url: string; }; /** * Thread Subscription * @description Thread Subscription */ - readonly "thread-subscription": { + "thread-subscription": { /** @example true */ - readonly subscribed: boolean; - readonly ignored: boolean; - readonly reason: string | null; + subscribed: boolean; + ignored: boolean; + reason: string | null; /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: uri * @example https://api.github.com/notifications/threads/1/subscription */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/notifications/threads/1 */ - readonly thread_url?: string; + thread_url?: string; /** * Format: uri * @example https://api.github.com/repos/1 */ - readonly repository_url?: string; + repository_url?: string; }; /** - * Organization Simple - * @description A GitHub organization. + * Actions cache retention limit for an organization + * @description GitHub Actions cache retention policy for an organization. */ - readonly "organization-simple": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + "actions-cache-retention-limit-for-organization": { + /** + * @description For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an organization + * @description GitHub Actions cache storage policy for an organization. + */ + "actions-cache-storage-limit-for-organization": { + /** + * @description For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; + /** + * Simple Repository + * @description A GitHub repository. + */ + "nullable-simple-repository": { + /** + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 + */ + id: number; + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ + node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World */ - readonly url: string; + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World + */ + url: string; + /** + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + */ + archive_url: string; + /** + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} + */ + assignees_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + */ + blobs_url: string; + /** + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} + */ + branches_url: string; + /** + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + */ + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly repos_url: string; + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - 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; + contributors_url: string; + /** + * Format: uri + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments + */ + deployments_url: string; + /** + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads + */ + downloads_url: string; + /** + * Format: uri + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events + */ + events_url: string; + /** + * Format: uri + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks + */ + forks_url: string; + /** + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + */ + git_commits_url: string; + /** + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + */ + git_refs_url: string; + /** + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + */ + git_tags_url: string; + /** + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + */ + issue_comment_url: string; + /** + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + */ + issue_events_url: string; + /** + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} + */ + issues_url: string; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; + } | null; + /** + * Dependabot Repository Access Details + * @description Information about repositories that Dependabot is able to access in an organization + */ + "dependabot-repository-access-details": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string|null} + */ + default_level?: "public" | "internal" | null; + accessible_repositories?: components["schemas"]["nullable-simple-repository"][]; }; - readonly "billing-usage-report": { - readonly usageItems?: readonly { + budget: { + /** + * @description The unique identifier for the budget + * @example 2066deda-923f-43f9-88d2-62395a28c0cdd + */ + id: string; + /** + * @description The type of pricing for the budget + * @example SkuPricing + * @enum {string} + */ + budget_type: "SkuPricing" | "ProductPricing"; + /** @description The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description The type of limit enforcement for the budget + * @example true + */ + prevent_further_usage: boolean; + /** + * @description The scope of the budget (enterprise, organization, repository, cost center) + * @example enterprise + */ + budget_scope: string; + /** + * @description The name of the entity for the budget (enterprise does not require a name). + * @example octocat/hello-world + */ + budget_entity_name?: string; + /** @description A single product or sku to apply the budget to. */ + budget_product_sku: string; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients: string[]; + }; + }; + get_all_budgets: { + /** @description Array of budget objects for the enterprise */ + budgets: components["schemas"]["budget"][]; + /** @description Indicates if there are more pages of results available (maps to hasNextPage from billing platform) */ + has_next_page?: boolean; + /** @description Total number of budgets matching the query */ + total_count?: number; + }; + "get-budget": { + /** @description ID of the budget. */ + id: string; + /** + * @description The type of scope for the budget + * @example enterprise + * @enum {string} + */ + budget_scope: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @example octocat/hello-world + */ + budget_entity_name: string; + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description Whether to prevent additional spending once the budget is exceeded + * @example true + */ + prevent_further_usage: boolean; + /** + * @description A single product or sku to apply the budget to. + * @example actions_linux + */ + budget_product_sku: string; + /** + * @description The type of pricing for the budget + * @example ProductPricing + * @enum {string} + */ + budget_type: "ProductPricing" | "SkuPricing"; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert?: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients?: string[]; + }; + }; + "delete-budget": { + /** @description A message indicating the result of the deletion operation */ + message: string; + /** @description The ID of the deleted budget */ + id: string; + }; + "billing-premium-request-usage-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the user for the usage report. */ + user?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report": { + usageItems?: { /** @description Date of the usage line item. */ - readonly date: string; + date: string; /** @description Product name. */ - readonly product: string; + product: string; /** @description SKU name. */ - readonly sku: string; + sku: string; /** @description Quantity of the usage line item. */ - readonly quantity: number; + quantity: number; /** @description Unit type of the usage line item. */ - readonly unitType: string; + unitType: string; /** @description Price per unit of the usage line item. */ - readonly pricePerUnit: number; + pricePerUnit: number; /** @description Gross amount of the usage line item. */ - readonly grossAmount: number; + grossAmount: number; /** @description Discount amount of the usage line item. */ - readonly discountAmount: number; + discountAmount: number; /** @description Net amount of the usage line item. */ - readonly netAmount: number; + netAmount: number; /** @description Name of the organization. */ - readonly organizationName: string; + organizationName: string; /** @description Name of the repository. */ - readonly repositoryName?: string; + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; }[]; }; /** * Organization Full * @description Organization Full */ - readonly "organization-full": { + "organization-full": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; /** @example github */ - readonly name?: string; + name?: string; /** @example GitHub */ - readonly company?: string; + company?: string; /** * Format: uri * @example https://github.com/blog */ - readonly blog?: string; + blog?: string; /** @example San Francisco */ - readonly location?: string; + location?: string; /** * Format: email * @example octocat@github.com */ - readonly email?: string; + email?: string; /** @example github */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** @example true */ - readonly is_verified?: boolean; + is_verified?: boolean; /** @example true */ - readonly has_organization_projects: boolean; + has_organization_projects: boolean; /** @example true */ - readonly has_repository_projects: boolean; + has_repository_projects: boolean; /** @example 2 */ - readonly public_repos: number; + public_repos: number; /** @example 1 */ - readonly public_gists: number; + public_gists: number; /** @example 20 */ - readonly followers: number; + followers: number; /** @example 0 */ - readonly following: number; + following: number; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** @example Organization */ - readonly type: string; + type: string; /** @example 100 */ - readonly total_private_repos?: number; + total_private_repos?: number; /** @example 100 */ - readonly owned_private_repos?: number; + owned_private_repos?: number; /** @example 81 */ - readonly private_gists?: number | null; + private_gists?: number | null; /** @example 10000 */ - readonly disk_usage?: 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. * @example 8 */ - readonly collaborators?: number | null; + collaborators?: number | null; /** * Format: email * @example org@example.com */ - readonly billing_email?: string | null; - readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; }; - readonly default_repository_permission?: string | null; + default_repository_permission?: string | null; + /** + * @description The default branch for repositories created in this organization. + * @example main + */ + default_repository_branch?: string | null; /** @example true */ - readonly members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null; /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null; /** @example all */ - readonly members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string; + /** @example true */ + members_can_create_public_repositories?: boolean; + /** @example true */ + members_can_create_private_repositories?: boolean; /** @example true */ - readonly members_can_create_public_repositories?: boolean; + members_can_create_internal_repositories?: boolean; /** @example true */ - readonly members_can_create_private_repositories?: boolean; + members_can_create_pages?: boolean; /** @example true */ - readonly members_can_create_internal_repositories?: boolean; + members_can_create_public_pages?: boolean; /** @example true */ - readonly members_can_create_pages?: boolean; + members_can_create_private_pages?: boolean; /** @example true */ - readonly members_can_create_public_pages?: boolean; + members_can_delete_repositories?: boolean; /** @example true */ - readonly members_can_create_private_pages?: boolean; + members_can_change_repo_visibility?: boolean; + /** @example true */ + members_can_invite_outside_collaborators?: boolean; + /** @example true */ + members_can_delete_issues?: boolean; + /** @example true */ + display_commenter_full_name_setting_enabled?: boolean; + /** @example true */ + readers_can_create_discussions?: boolean; + /** @example true */ + members_can_create_teams?: boolean; + /** @example true */ + members_can_view_dependency_insights?: boolean; /** @example false */ - readonly members_can_fork_private_repositories?: boolean | null; + members_can_fork_private_repositories?: boolean | null; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22539,7 +24659,7 @@ export interface components { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly advanced_security_enabled_for_new_repositories?: boolean; + advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22549,7 +24669,7 @@ export interface components { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly dependabot_alerts_enabled_for_new_repositories?: boolean; + dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22559,7 +24679,7 @@ export interface components { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; + dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22569,7 +24689,7 @@ export interface components { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly dependency_graph_enabled_for_new_repositories?: boolean; + dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22579,7 +24699,7 @@ export interface components { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly secret_scanning_enabled_for_new_repositories?: boolean; + secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -22589,2173 +24709,2440 @@ export interface components { * This field is only visible to organization owners or members of a team with the security manager role. * @example false */ - readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean; + secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** * @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. * @example false */ - readonly secret_scanning_push_protection_custom_link_enabled?: boolean; + secret_scanning_push_protection_custom_link_enabled?: boolean; /** * @description An optional URL string to display to contributors who are blocked from pushing a secret. * @example https://github.com/test-org/test-repo/blob/main/README.md */ - readonly secret_scanning_push_protection_custom_link?: string | null; + secret_scanning_push_protection_custom_link?: string | null; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly archived_at: string | null; + 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; + deploy_keys_enabled_for_repositories?: boolean; }; - readonly "actions-cache-usage-org-enterprise": { + "actions-cache-usage-org-enterprise": { /** @description The count of active caches across all repositories of an enterprise or an organization. */ - readonly total_active_caches_count: number; + total_active_caches_count: number; /** @description The total size in bytes of all active cache items across all repositories of an enterprise or an organization. */ - readonly total_active_caches_size_in_bytes: number; + total_active_caches_size_in_bytes: number; }; /** * Actions Cache Usage by repository * @description GitHub Actions Cache Usage by repository. */ - readonly "actions-cache-usage-by-repository": { + "actions-cache-usage-by-repository": { /** * @description The repository owner and name for the cache usage being shown. * @example octo-org/Hello-World */ - readonly full_name: string; + full_name: string; /** * @description The sum of the size in bytes of all the active cache items in the repository. * @example 2322142 */ - readonly active_caches_size_in_bytes: number; + active_caches_size_in_bytes: number; /** * @description The number of active caches in the repository. * @example 3 */ - readonly active_caches_count: number; + active_caches_count: number; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - readonly "nullable-actions-hosted-runner-pool-image": { + "nullable-actions-hosted-runner-pool-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 */ - readonly id: string; + id: string; /** * @description Image size in GB. * @example 86 */ - readonly size_gb: number; + size_gb: number; /** * @description Display name for this image. * @example 20.04 */ - readonly display_name: string; + display_name: string; /** * @description The image provider. * @enum {string} */ - readonly source: "github" | "partner" | "custom"; + source: "github" | "partner" | "custom"; /** * @description The image version of the hosted runner pool. * @example latest */ - readonly version: string; + version?: string; } | null; /** * Github-owned VM details. * @description Provides details of a particular machine spec. */ - readonly "actions-hosted-runner-machine-spec": { + "actions-hosted-runner-machine-spec": { /** * @description The ID used for the `size` parameter when creating a new runner. * @example 8-core */ - readonly id: string; + id: string; /** * @description The number of cores. * @example 8 */ - readonly cpu_cores: number; + cpu_cores: number; /** * @description The available RAM for the machine spec. * @example 32 */ - readonly memory_gb: number; + memory_gb: number; /** * @description The available SSD storage for the machine spec. * @example 300 */ - readonly storage_gb: number; + storage_gb: number; }; /** * Public IP for a GitHub-hosted larger runners. * @description Provides details of Public IP for a GitHub-hosted larger runners */ - readonly "public-ip": { + "public-ip": { /** * @description Whether public IP is enabled. * @example true */ - readonly enabled?: boolean; + enabled?: boolean; /** * @description The prefix for the public IP. * @example 20.80.208.150 */ - readonly prefix?: string; + prefix?: string; /** * @description The length of the IP prefix. * @example 28 */ - readonly length?: number; + length?: number; }; /** * GitHub-hosted hosted runner * @description A Github-hosted hosted runner. */ - readonly "actions-hosted-runner": { + "actions-hosted-runner": { /** * @description The unique identifier of the hosted runner. * @example 5 */ - readonly id: number; + id: number; /** * @description The name of the hosted runner. * @example my-github-hosted-runner */ - readonly name: string; + name: string; /** * @description The unique identifier of the group that the hosted runner belongs to. * @example 2 */ - readonly runner_group_id?: number; - readonly image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; - readonly machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; + runner_group_id?: number; + image_details: components["schemas"]["nullable-actions-hosted-runner-pool-image"]; + machine_size_details: components["schemas"]["actions-hosted-runner-machine-spec"]; /** * @description The status of the runner. * @example Ready * @enum {string} */ - readonly status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; + status: "Ready" | "Provisioning" | "Shutdown" | "Deleting" | "Stuck"; /** * @description The operating system of the image. * @example linux-x64 */ - readonly platform: string; + platform: string; /** * @description The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost. * @default 10 * @example 5 */ - readonly maximum_runners: number; + maximum_runners: number; /** * @description Whether public IP is enabled for the hosted runners. * @example true */ - readonly public_ip_enabled: boolean; + public_ip_enabled: boolean; /** @description The public IP ranges when public IP is enabled for the hosted runners. */ - readonly public_ips?: readonly components["schemas"]["public-ip"][]; + public_ips?: components["schemas"]["public-ip"][]; /** * Format: date-time * @description The time at which the runner was last used, in ISO 8601 format. * @example 2022-10-09T23:39:01Z */ - readonly last_active_on?: string | null; + last_active_on?: string | null; + /** @description Whether custom image generation is enabled for the hosted runners. */ + image_gen?: boolean; + }; + /** + * GitHub-hosted runner custom image details + * @description Provides details of a custom runner image + */ + "actions-hosted-runner-custom-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example 1 + */ + id: number; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Total size of all the image versions in GB. + * @example 200 + */ + total_versions_size: number; + /** + * @description Display name for this image. + * @example CustomImage + */ + name: string; + /** + * @description The image provider. + * @example custom + */ + source: string; + /** + * @description The number of image versions associated with the image. + * @example 4 + */ + versions_count: number; + /** + * @description The latest image version associated with the image. + * @example 1.3.0 + */ + latest_version: string; + /** + * @description The number of image versions associated with the image. + * @example Ready + */ + state: string; + }; + /** + * GitHub-hosted runner custom image version details. + * @description Provides details of a hosted runner custom image version + */ + "actions-hosted-runner-custom-image-version": { + /** + * @description The version of image. + * @example 1.0.0 + */ + version: string; + /** + * @description The state of image version. + * @example Ready + */ + state: string; + /** + * @description Image version size in GB. + * @example 30 + */ + size_gb: number; + /** + * @description The creation date time of the image version. + * @example 2024-11-09T23:39:01Z + */ + created_on: string; + /** + * @description The image version status details. + * @example None + */ + state_details: string; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - readonly "actions-hosted-runner-image": { + "actions-hosted-runner-curated-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 */ - readonly id: string; + id: string; /** * @description The operating system of the image. * @example linux-x64 */ - readonly platform: string; + platform: string; /** * @description Image size in GB. * @example 86 */ - readonly size_gb: number; + size_gb: number; /** * @description Display name for this image. * @example 20.04 */ - readonly display_name: string; + display_name: string; /** * @description The image provider. * @enum {string} */ - readonly source: "github" | "partner" | "custom"; + source: "github" | "partner" | "custom"; }; - readonly "actions-hosted-runner-limits": { + "actions-hosted-runner-limits": { /** * Static public IP Limits for GitHub-hosted Hosted Runners. * @description Provides details of static public IP limits for GitHub-hosted Hosted Runners */ - readonly public_ips: { + public_ips: { /** * @description The maximum number of static public IP addresses that can be used for Hosted Runners. * @example 50 */ - readonly maximum: number; + maximum: number; /** * @description The current number of static public IP addresses in use by Hosted Runners. * @example 17 */ - readonly current_usage: number; + current_usage: number; }; }; /** * Actions OIDC Subject customization * @description Actions OIDC Subject customization */ - readonly "oidc-custom-sub": { + "oidc-custom-sub": { /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */ - readonly include_claim_keys: readonly string[]; + include_claim_keys: string[]; }; /** * Empty Object * @description An object without any properties. */ - readonly "empty-object": Record; + "empty-object": Record; /** * @description The policy that controls the repositories in the organization that are allowed to run GitHub Actions. * @enum {string} */ - readonly "enabled-repositories": "all" | "none" | "selected"; + "enabled-repositories": "all" | "none" | "selected"; /** * @description The permissions policy that controls the actions and reusable workflows that are allowed to run. * @enum {string} */ - readonly "allowed-actions": "all" | "local_only" | "selected"; + "allowed-actions": "all" | "local_only" | "selected"; /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */ - readonly "selected-actions-url": string; - readonly "actions-organization-permissions": { - readonly enabled_repositories: components["schemas"]["enabled-repositories"]; + "selected-actions-url": string; + /** @description Whether actions must be pinned to a full-length commit SHA. */ + "sha-pinning-required": boolean; + "actions-organization-permissions": { + enabled_repositories: components["schemas"]["enabled-repositories"]; /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ - readonly selected_repositories_url?: string; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; + selected_repositories_url?: string; + allowed_actions?: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; - readonly "selected-actions": { + "actions-artifact-and-log-retention-response": { + /** @description The number of days artifacts and logs are retained */ + days: number; + /** @description The maximum number of days that can be configured */ + maximum_allowed_days: number; + }; + "actions-artifact-and-log-retention": { + /** @description The number of days to retain artifacts and logs */ + days: number; + }; + "actions-fork-pr-contributor-approval": { + /** + * @description The policy that controls when fork PR workflows require approval from a maintainer. + * @enum {string} + */ + approval_policy: "first_time_contributors_new_to_github" | "first_time_contributors" | "all_external_contributors"; + }; + "actions-fork-pr-workflows-private-repos": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows: boolean; + }; + "actions-fork-pr-workflows-private-repos-request": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows?: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables?: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows?: boolean; + }; + "selected-actions": { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - readonly github_owned_allowed?: boolean; + github_owned_allowed?: boolean; /** @description Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. */ - readonly verified_allowed?: boolean; + verified_allowed?: boolean; /** * @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * * > [!NOTE] * > The `patterns_allowed` setting only applies to public repositories. */ - readonly patterns_allowed?: readonly string[]; + patterns_allowed?: string[]; + }; + "self-hosted-runners-settings": { + /** + * @description The policy that controls whether self-hosted runners can be used by repositories in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + /** @description The URL to the endpoint for managing selected repositories for self-hosted runners in the organization */ + selected_repositories_url?: string; }; /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows. * @enum {string} */ - readonly "actions-default-workflow-permissions": "read" | "write"; + "actions-default-workflow-permissions": "read" | "write"; /** @description Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. */ - readonly "actions-can-approve-pull-request-reviews": boolean; - readonly "actions-get-default-workflow-permissions": { - 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 "actions-set-default-workflow-permissions": { - 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; + "actions-can-approve-pull-request-reviews": boolean; + "actions-get-default-workflow-permissions": { + default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; + can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; + }; + "actions-set-default-workflow-permissions": { + 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` */ - readonly selected_repositories_url?: string; - readonly runners_url: string; - readonly hosted_runners_url?: string; + selected_repositories_url?: string; + runners_url: string; + hosted_runners_url?: string; /** @description The identifier of a hosted compute network configuration. */ - readonly network_configuration_id?: string; - readonly inherited: boolean; - readonly inherited_allows_public_repositories?: boolean; - readonly allows_public_repositories: boolean; + network_configuration_id?: 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 */ - readonly workflow_restrictions_read_only: boolean; + 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; + 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[]; + selected_workflows?: string[]; }; /** * Self hosted runner label * @description A label for a self hosted runner */ - readonly "runner-label": { + "runner-label": { /** @description Unique identifier of the label. */ - readonly id?: number; + id?: number; /** @description Name of the label. */ - readonly name: string; + name: string; /** * @description The type of label. Read-only labels are applied automatically when the runner is configured. * @enum {string} */ - readonly type?: "read-only" | "custom"; + type?: "read-only" | "custom"; }; /** * Self hosted runners * @description A self hosted runner */ - readonly runner: { + runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ - readonly id: number; + id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ - readonly runner_group_id?: number; + runner_group_id?: number; /** * @description The name of the runner. * @example iMac */ - readonly name: string; + name: string; /** * @description The Operating System of the runner. * @example macos */ - readonly os: string; + os: string; /** * @description The status of the runner. * @example online */ - readonly status: string; - readonly busy: boolean; - readonly labels: readonly components["schemas"]["runner-label"][]; + status: string; + busy: boolean; + labels: components["schemas"]["runner-label"][]; + ephemeral?: boolean; }; /** * Runner Application * @description Runner Application */ - readonly "runner-application": { - readonly os: string; - readonly architecture: string; - readonly download_url: string; - readonly filename: string; + "runner-application": { + os: string; + architecture: string; + download_url: string; + filename: string; /** @description A short lived bearer token used to download the runner, if needed. */ - readonly temp_download_token?: string; - readonly sha256_checksum?: string; + temp_download_token?: string; + sha256_checksum?: string; }; /** * Authentication Token * @description Authentication Token */ - readonly "authentication-token": { + "authentication-token": { /** * @description The token used for authentication * @example v1.1f699f1069f60xxx */ - readonly token: string; + token: string; /** * Format: date-time * @description The time this token expires * @example 2016-07-11T22:14:10Z */ - readonly expires_at: string; + expires_at: string; /** * @example { * "issues": "read", * "deployments": "write" * } */ - readonly permissions?: Record; + permissions?: Record; /** @description The repositories this token has access to */ - readonly repositories?: readonly components["schemas"]["repository"][]; + repositories?: components["schemas"]["repository"][]; /** @example config.yaml */ - readonly single_file?: string | null; + single_file?: string | null; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly repository_selection?: "all" | "selected"; + repository_selection?: "all" | "selected"; }; /** * Actions Secret for an Organization * @description Secrets for GitHub Actions for an organization. */ - readonly "organization-actions-secret": { + "organization-actions-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @example https://api.github.com/organizations/org/secrets/my_secret/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; }; /** * ActionsPublicKey * @description The public key used for setting Actions Secrets. */ - readonly "actions-public-key": { + "actions-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; /** @example 2 */ - readonly id?: number; + id?: number; /** @example https://api.github.com/user/keys/2 */ - readonly url?: string; + url?: string; /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - readonly title?: string; + title?: string; /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; + created_at?: string; }; /** * Actions Variable for an Organization * @description Organization variable for GitHub Actions. */ - readonly "organization-actions-variable": { + "organization-actions-variable": { /** * @description The name of the variable. * @example USERNAME */ - readonly name: string; + name: string; /** * @description The value of the variable. * @example octocat */ - readonly value: string; + value: string; /** * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly updated_at: string; + updated_at: string; /** * @description Visibility of a variable * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @example https://api.github.com/organizations/org/variables/USERNAME/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; + }; + /** + * Artifact Deployment Record + * @description Artifact Metadata Deployment Record + */ + "artifact-deployment-record": { + id?: number; + digest?: string; + logical_environment?: string; + physical_environment?: string; + cluster?: string; + deployment_name?: string; + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + created_at?: string; + updated_at?: string; + /** @description The ID of the provenance attestation associated with the deployment record. */ + attestation_id?: number | null; + }; + /** + * Campaign state + * @description Indicates whether a campaign is open or closed + * @enum {string} + */ + "campaign-state": "open" | "closed"; + /** + * Campaign alert type + * @description Indicates the alert type of a campaign + * @enum {string} + */ + "campaign-alert-type": "code_scanning" | "secret_scanning"; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Campaign summary + * @description The campaign metadata and alert stats. + */ + "campaign-summary": { + /** @description The number of the newly created campaign */ + number: number; + /** + * Format: date-time + * @description The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** @description The campaign name */ + name?: string; + /** @description The campaign description */ + description: string; + /** @description The campaign managers */ + managers: components["schemas"]["simple-user"][]; + /** @description The campaign team managers */ + team_managers?: components["schemas"]["team"][]; + /** + * Format: date-time + * @description The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + published_at?: string; + /** + * Format: date-time + * @description The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at: string; + /** + * Format: date-time + * @description The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + */ + closed_at?: string | null; + state: components["schemas"]["campaign-state"]; + /** + * Format: uri + * @description The contact link of the campaign. + */ + contact_link: string | null; + alert_stats?: { + /** @description The number of open alerts */ + open_count: number; + /** @description The number of closed alerts */ + closed_count: number; + /** @description The number of in-progress alerts */ + in_progress_count: number; + }; }; /** @description The name of the tool used to generate the code scanning analysis. */ - readonly "code-scanning-analysis-tool-name": string; + "code-scanning-analysis-tool-name": string; /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - readonly "code-scanning-analysis-tool-guid": string | null; + "code-scanning-analysis-tool-guid": string | null; /** * @description State of a code scanning alert. * @enum {string} */ - readonly "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; + "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; /** * @description Severity of a code scanning alert. * @enum {string} */ - readonly "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; + "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; /** * Format: uri * @description The REST API URL for fetching the list of instances for an alert. */ - readonly "alert-instances-url": string; + "alert-instances-url": string; /** * @description State of a code scanning alert. * @enum {string|null} */ - readonly "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; + "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} */ - readonly "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; /** @description The dismissal comment associated with the dismissal of the alert. */ - readonly "code-scanning-alert-dismissed-comment": string | null; - readonly "code-scanning-alert-rule-summary": { + "code-scanning-alert-dismissed-comment": string | null; + "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; + id?: string | null; /** @description The name of the rule used to detect the alert. */ - readonly name?: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity?: "none" | "note" | "warning" | "error" | null; + severity?: "none" | "note" | "warning" | "error" | null; /** * @description The security severity of the alert. * @enum {string|null} */ - readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; + security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; + description?: string; /** @description A description of the rule used to detect the alert. */ - readonly full_description?: string; + full_description?: string; /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; + tags?: string[] | null; /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ - readonly "code-scanning-analysis-tool-version": string | null; - readonly "code-scanning-analysis-tool": { - readonly name?: components["schemas"]["code-scanning-analysis-tool-name"]; - readonly version?: components["schemas"]["code-scanning-analysis-tool-version"]; - readonly guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; + "code-scanning-analysis-tool-version": string | null; + "code-scanning-analysis-tool": { + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + version?: components["schemas"]["code-scanning-analysis-tool-version"]; + guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; /** * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, * `refs/heads/` or simply ``. */ - readonly "code-scanning-ref": string; + "code-scanning-ref": string; /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly "code-scanning-analysis-analysis-key": string; + "code-scanning-analysis-analysis-key": string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly "code-scanning-alert-environment": string; + "code-scanning-alert-environment": string; /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - readonly "code-scanning-analysis-category": string; + "code-scanning-analysis-category": string; /** @description Describe a region within a file for the alert. */ - readonly "code-scanning-alert-location": { - readonly path?: string; - readonly start_line?: number; - readonly end_line?: number; - readonly start_column?: number; - readonly end_column?: number; + "code-scanning-alert-location": { + path?: string; + start_line?: number; + end_line?: number; + start_column?: number; + end_column?: number; }; /** * @description A classification of the file. For example to identify it as generated. * @enum {string|null} */ - readonly "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; - readonly "code-scanning-alert-instance": { - readonly ref?: components["schemas"]["code-scanning-ref"]; - readonly analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - readonly environment?: components["schemas"]["code-scanning-alert-environment"]; - readonly category?: components["schemas"]["code-scanning-analysis-category"]; - readonly state?: components["schemas"]["code-scanning-alert-state"]; - readonly commit_sha?: string; - readonly message?: { - readonly text?: string; + "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; + "code-scanning-alert-instance": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-state"]; + commit_sha?: string; + message?: { + text?: string; }; - readonly location?: components["schemas"]["code-scanning-alert-location"]; - readonly html_url?: string; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - readonly classifications?: readonly components["schemas"]["code-scanning-alert-classification"][]; - }; - readonly "code-scanning-organization-alert-items": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - readonly repository: components["schemas"]["simple-repository"]; + classifications?: components["schemas"]["code-scanning-alert-classification"][]; + }; + "code-scanning-organization-alert-items": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["alert-updated-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + fixed_at?: components["schemas"]["alert-fixed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + repository: components["schemas"]["simple-repository"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * Codespace machine * @description A description of the machine powering a codespace. */ - readonly "nullable-codespace-machine": { + "nullable-codespace-machine": { /** * @description The name of the machine. * @example standardLinux */ - readonly name: string; + name: string; /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 16 GB RAM, 64 GB storage */ - readonly display_name: string; + display_name: string; /** * @description The operating system of the machine. * @example linux */ - readonly operating_system: string; + operating_system: string; /** * @description How much storage is available to the codespace. * @example 68719476736 */ - readonly storage_in_bytes: number; + storage_in_bytes: number; /** * @description How much memory is available to the codespace. * @example 17179869184 */ - readonly memory_in_bytes: number; + memory_in_bytes: number; /** * @description How many cores are available to the codespace. * @example 4 */ - readonly cpus: number; + cpus: number; /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} */ - readonly prebuild_availability: "none" | "ready" | "in_progress" | null; + prebuild_availability: "none" | "ready" | "in_progress" | null; } | null; /** * Codespace * @description A codespace. */ - readonly codespace: { + codespace: { /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - readonly name: string; + name: string; /** * @description Display name for this codespace. * @example bookish space pancake */ - readonly display_name?: string | null; + display_name?: string | null; /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - readonly environment_id: string | null; - readonly owner: components["schemas"]["simple-user"]; - readonly billable_owner: components["schemas"]["simple-user"]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null; + owner: components["schemas"]["simple-user"]; + billable_owner: components["schemas"]["simple-user"]; + repository: components["schemas"]["minimal-repository"]; + machine: components["schemas"]["nullable-codespace-machine"]; /** * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ - readonly devcontainer_path?: string | null; + devcontainer_path?: string | null; /** * @description Whether the codespace was created from a prebuild. * @example false */ - readonly prebuild: boolean | null; + prebuild: boolean | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - readonly last_used_at: string; + last_used_at: string; /** * @description State of this codespace. * @example Available * @enum {string} */ - readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; + state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** * Format: uri * @description API URL for this codespace. */ - readonly url: string; + url: string; /** @description Details about the codespace's git repository. */ - readonly git_status: { + git_status: { /** * @description The number of commits the local repository is ahead of the remote. * @example 0 */ - readonly ahead?: number; + ahead?: number; /** * @description The number of commits the local repository is behind the remote. * @example 0 */ - readonly behind?: number; + behind?: number; /** @description Whether the local repository has unpushed changes. */ - readonly has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean; /** @description Whether the local repository has uncommitted changes. */ - readonly has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean; /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - readonly ref?: string; + ref?: string; }; /** * @description The initally assigned location of a new codespace. * @example WestUs2 * @enum {string} */ - readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - readonly idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null; /** * Format: uri * @description URL to access this codespace on the web. */ - readonly web_url: string; + web_url: string; /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - readonly machines_url: string; + machines_url: string; /** * Format: uri * @description API URL to start this codespace. */ - readonly start_url: string; + start_url: string; /** * Format: uri * @description API URL to stop this codespace. */ - readonly stop_url: string; + stop_url: string; /** * Format: uri * @description API URL to publish this codespace to a new repository. */ - readonly publish_url?: string | null; + publish_url?: string | null; /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - readonly pulls_url: string | null; - readonly recent_folders: readonly string[]; - readonly runtime_constraints?: { + pulls_url: string | null; + recent_folders: string[]; + runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - readonly allowed_port_privacy_settings?: readonly string[] | null; + allowed_port_privacy_settings?: string[] | null; }; /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ - readonly pending_operation?: boolean | null; + pending_operation?: boolean | null; /** @description Text to show user when codespace is disabled by a pending operation */ - readonly pending_operation_disabled_reason?: string | null; + pending_operation_disabled_reason?: string | null; /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ - readonly idle_timeout_notice?: string | null; + idle_timeout_notice?: string | null; /** * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ - readonly retention_period_minutes?: number | null; + retention_period_minutes?: number | null; /** * Format: date-time * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z */ - readonly retention_expires_at?: string | null; + retention_expires_at?: string | null; /** * @description The text to display to a user when a codespace has been stopped for a potentially actionable reason. * @example you've used 100% of your spending limit for Codespaces */ - readonly last_known_stop_notice?: string | null; + last_known_stop_notice?: string | null; }; /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - readonly "codespaces-org-secret": { + "codespaces-org-secret": { /** * @description The name of the secret * @example SECRET_NAME */ - readonly name: string; + name: string; /** * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at: string; + updated_at: string; /** * @description The type of repositories in the organization that the secret is visible to * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; }; /** * CodespacesPublicKey * @description The public key used for setting Codespaces secrets. */ - readonly "codespaces-public-key": { + "codespaces-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; /** @example 2 */ - readonly id?: number; + id?: number; /** @example https://api.github.com/user/keys/2 */ - readonly url?: string; + url?: string; /** @example ssh-rsa AAAAB3NzaC1yc2EAAA */ - readonly title?: string; + title?: string; /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; + created_at?: string; }; /** - * Copilot Business Seat Breakdown + * Copilot Seat Breakdown * @description The breakdown of Copilot Business seats for the organization. */ - readonly "copilot-seat-breakdown": { + "copilot-organization-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ - readonly total?: number; + total?: number; /** @description Seats added during the current billing cycle. */ - readonly added_this_cycle?: number; + added_this_cycle?: number; /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ - readonly pending_cancellation?: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ - readonly pending_invitation?: number; + pending_cancellation?: number; + /** @description The number of users who have been invited to receive a Copilot seat through this organization. */ + pending_invitation?: number; /** @description The number of seats that have used Copilot during the current billing cycle. */ - readonly active_this_cycle?: number; + active_this_cycle?: number; /** @description The number of seats that have not used Copilot during the current billing cycle. */ - readonly inactive_this_cycle?: number; + inactive_this_cycle?: number; }; /** * 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"]; + "copilot-organization-details": { + seat_breakdown: components["schemas"]["copilot-organization-seat-breakdown"]; /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @description The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). * @enum {string} */ - readonly public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + public_code_suggestions: "allow" | "block" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @description The organization policy for allowing or disallowing Copilot Chat in the IDE. * @enum {string} */ - readonly ide_chat?: "enabled" | "disabled" | "unconfigured"; + ide_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @description The organization policy for allowing or disallowing Copilot features on GitHub.com. * @enum {string} */ - readonly platform_chat?: "enabled" | "disabled" | "unconfigured"; + platform_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @description The organization policy for allowing or disallowing Copilot CLI. * @enum {string} */ - readonly cli?: "enabled" | "disabled" | "unconfigured"; + cli?: "enabled" | "disabled" | "unconfigured"; /** * @description The mode of assigning new seats. * @enum {string} */ - readonly seat_management_setting: "assign_all" | "assign_selected" | "disabled" | "unconfigured"; + 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"; + plan_type?: "business" | "enterprise"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }; /** * Organization Simple * @description A GitHub organization. */ - readonly "nullable-organization-simple": { + "nullable-organization-simple": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - readonly id: number; - /** @example MDQ6VGVhbTE= */ - readonly node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - readonly url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - readonly name: string; - /** - * @description Description of the team - * @example A great team. - */ - readonly description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - readonly permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - readonly privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - readonly notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - readonly html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - readonly repositories_url: string; - /** @example justice-league */ - readonly slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - readonly ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission: string; - readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; - }; - /** Format: uri */ - readonly url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - readonly html_url: string; - readonly members_url: string; - /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - readonly "enterprise-team": { - /** Format: int64 */ - readonly id: number; - readonly name: string; - readonly slug: string; - /** Format: uri */ - readonly url: string; - /** @example disabled | all */ - readonly sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - readonly group_id?: string | null; - /** @example Justice League */ - readonly group_name?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league - */ - readonly html_url: string; - readonly members_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ - readonly "copilot-seat-details": { - readonly assignee: components["schemas"]["simple-user"]; - readonly organization?: components["schemas"]["nullable-organization-simple"]; + "copilot-seat-details": { + assignee?: components["schemas"]["nullable-simple-user"]; + 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; + assigning_team?: (components["schemas"]["team"] | components["schemas"]["enterprise-team"]) | null; /** * Format: date * @description The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle. */ - readonly pending_cancellation_date?: string | null; + pending_cancellation_date?: string | null; /** * Format: date-time * @description Timestamp of user's last GitHub Copilot activity, in ISO 8601 format. */ - readonly last_activity_at?: string | null; + last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ - readonly last_activity_editor?: string | null; + last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + */ + last_authenticated_at?: string | null; /** * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @deprecated * @description **Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format. */ - readonly updated_at?: string; + updated_at?: string; /** * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ - readonly plan_type?: "business" | "enterprise" | "unknown"; + plan_type?: "business" | "enterprise" | "unknown"; + }; + /** + * Copilot Organization Content Exclusion Details + * @description List all Copilot Content Exclusion rules for an organization. + */ + "copilot-organization-content-exclusion-details": { + [key: string]: string[]; }; /** @description Usage metrics for Copilot editor code completions in the IDE. */ - readonly "copilot-ide-code-completions": ({ + "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; + total_engaged_users?: number; /** @description Code completion metrics for active languages. */ - readonly languages?: readonly { + languages?: { /** @description Name of the language used for Copilot code completion suggestions. */ - readonly name?: string; + 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; + total_engaged_users?: number; }[]; - readonly editors?: readonly ({ + editors?: ({ /** @description Name of the given editor. */ - readonly name?: string; + 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; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { + models?: { /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; + 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; + total_engaged_users?: number; /** @description Code completion metrics for active languages, for the given editor. */ - readonly languages?: readonly { + languages?: { /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - readonly name?: string; + 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; + 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; + 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; + 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; + 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; + total_code_lines_accepted?: number; }[]; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; })[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; /** @description Usage metrics for Copilot Chat in the IDE. */ - readonly "copilot-ide-chat": ({ + "copilot-ide-chat": ({ /** @description Total number of users who prompted Copilot Chat in the IDE. */ - readonly total_engaged_users?: number; - readonly editors?: readonly { + total_engaged_users?: number; + editors?: { /** @description Name of the given editor. */ - readonly name?: string; + name?: string; /** @description The number of users who prompted Copilot Chat in the specified editor. */ - readonly total_engaged_users?: number; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + models?: { + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; + 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; + total_engaged_users?: number; /** @description The total number of chats initiated by users in the given editor and model. */ - readonly total_chats?: number; + 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; + 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; + total_chat_copy_events?: number; }[]; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ - readonly "copilot-dotcom-chat": ({ + /** @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. */ - readonly total_engaged_users?: number; + total_engaged_users?: number; /** @description List of model metrics for a custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + models?: { + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model (if applicable). */ - readonly custom_model_training_date?: string | null; + 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; + total_engaged_users?: number; /** @description Total number of chats initiated by users on github.com. */ - readonly total_chats?: number; + total_chats?: number; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; /** @description Usage metrics for Copilot for pull requests. */ - readonly "copilot-dotcom-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. */ - readonly total_engaged_users?: number; + total_engaged_users?: number; /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - readonly repositories?: readonly { + repositories?: { /** @description Repository name */ - readonly name?: string; + 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; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - readonly models?: readonly { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - readonly name?: string; + models?: { + /** @description Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - readonly is_custom_model?: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - readonly custom_model_training_date?: string | null; + 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; + 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; + total_engaged_users?: number; }[]; }[]; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | null; /** * Copilot Usage Metrics * @description Copilot usage metrics for a given day. */ - readonly "copilot-usage-metrics-day": { + "copilot-usage-metrics-day": { /** * Format: date * @description The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format. */ - readonly date: string; + 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; + 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"]; + 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"]; } & { - readonly [key: string]: unknown; - }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - readonly "copilot-usage-metrics": { - /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - readonly day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - readonly total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - readonly total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - readonly total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - readonly total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - readonly total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - readonly total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - readonly total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - readonly total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - readonly breakdown: readonly ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - readonly language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - readonly editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - readonly suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - readonly acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - readonly lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - readonly lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - readonly active_users?: number; - } & { - readonly [key: string]: unknown; - })[] | null; + [key: string]: unknown; }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. */ - readonly "organization-dependabot-secret": { + "organization-dependabot-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * @description Visibility of a secret * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @example https://api.github.com/organizations/org/dependabot/secrets/my_secret/repositories */ - readonly selected_repositories_url?: string; + selected_repositories_url?: string; }; /** * DependabotPublicKey * @description The public key used for setting Dependabot Secrets. */ - readonly "dependabot-public-key": { + "dependabot-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; }; /** * Minimal Repository * @description Minimal Repository */ - readonly "nullable-minimal-repository": { + "nullable-minimal-repository": { /** * Format: int64 * @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @example Hello-World */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - readonly git_url?: string; + git_tags_url: string; + git_url?: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - readonly ssh_url?: string; + releases_url: string; + ssh_url?: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - readonly clone_url?: string; - readonly mirror_url?: string | null; + trees_url: string; + clone_url?: string; + mirror_url?: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; - readonly svn_url?: string; - readonly homepage?: string | null; - readonly language?: string | null; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; + hooks_url: string; + svn_url?: string; + homepage?: string | null; + language?: string | null; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly has_discussions?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived?: boolean; + disabled?: boolean; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string | null; + pushed_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at?: string | null; + created_at?: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at?: string | null; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; + updated_at?: string | null; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; /** @example admin */ - readonly role_name?: string; - readonly temp_clone_token?: string; - readonly delete_branch_on_merge?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly code_of_conduct?: components["schemas"]["code-of-conduct"]; - readonly license?: { - readonly key?: string; - readonly name?: string; - readonly spdx_id?: string; - readonly url?: string; - readonly node_id?: string; + role_name?: string; + temp_clone_token?: string; + delete_branch_on_merge?: boolean; + subscribers_count?: number; + network_count?: number; + code_of_conduct?: components["schemas"]["code-of-conduct"]; + license?: { + key?: string; + name?: string; + spdx_id?: string; + url?: string | null; + node_id?: string; } | null; /** @example 0 */ - readonly forks?: number; + forks?: number; /** @example 0 */ - readonly open_issues?: number; + open_issues?: number; /** @example 0 */ - readonly watchers?: number; - readonly allow_forking?: boolean; + watchers?: number; + allow_forking?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + web_commit_signoff_required?: boolean; + security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; } | null; /** * Package * @description A software package */ - readonly package: { + package: { /** * @description Unique identifier of the package. * @example 1 */ - readonly id: number; + id: number; /** * @description The name of the package. * @example super-linter */ - readonly name: string; + name: string; /** * @example docker * @enum {string} */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** @example https://api.github.com/orgs/github/packages/container/super-linter */ - readonly url: string; + url: string; /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - readonly html_url: string; + html_url: string; /** * @description The number of versions of the package. * @example 1 */ - readonly version_count: number; + version_count: number; /** * @example private * @enum {string} */ - readonly visibility: "private" | "public"; - readonly owner?: components["schemas"]["nullable-simple-user"]; - readonly repository?: components["schemas"]["nullable-minimal-repository"]; + visibility: "private" | "public"; + owner?: components["schemas"]["nullable-simple-user"]; + repository?: components["schemas"]["nullable-minimal-repository"]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Organization Invitation * @description Organization Invitation */ - readonly "organization-invitation": { + "organization-invitation": { /** Format: int64 */ - readonly id: number; - readonly login: string | null; - readonly email: string | null; - readonly role: string; - readonly created_at: string; - readonly failed_at?: string | null; - readonly failed_reason?: string | null; - readonly inviter: components["schemas"]["simple-user"]; - readonly team_count: number; + id: number; + login: string | null; + email: string | null; + role: string; + created_at: string; + failed_at?: string | null; + failed_reason?: string | null; + inviter: components["schemas"]["simple-user"]; + team_count: number; /** @example "MDIyOk9yZ2FuaXphdGlvbkludml0YXRpb24x" */ - readonly node_id: string; + node_id: string; /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ - readonly invitation_teams_url: string; + invitation_teams_url: string; /** @example "member" */ - readonly invitation_source?: string; + invitation_source?: string; }; /** * Org Hook * @description Org Hook */ - readonly "org-hook": { + "org-hook": { /** @example 1 */ - readonly id: number; + id: number; /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/pings */ - readonly ping_url: string; + ping_url: string; /** * Format: uri * @example https://api.github.com/orgs/octocat/hooks/1/deliveries */ - readonly deliveries_url?: string; + deliveries_url?: string; /** @example web */ - readonly name: string; + name: string; /** * @example [ * "push", * "pull_request" * ] */ - readonly events: readonly string[]; + events: string[]; /** @example true */ - readonly active: boolean; - readonly config: { + active: boolean; + config: { /** @example "http://example.com/2" */ - readonly url?: string; + url?: string; /** @example "0" */ - readonly insecure_ssl?: string; + insecure_ssl?: string; /** @example "form" */ - readonly content_type?: string; + content_type?: string; /** @example "********" */ - readonly secret?: string; + secret?: string; }; /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; - readonly type: string; + created_at: string; + type: string; }; /** * Route Stats * @description API Insights usage route stats for an actor */ - readonly "api-insights-route-stats": readonly { + "api-insights-route-stats": { /** @description The HTTP method */ - readonly http_method?: string; + http_method?: string; /** @description The API path's route template */ - readonly api_route?: string; + api_route?: string; /** * Format: int64 * @description The total number of requests within the queried time period */ - readonly total_request_count?: number; + 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; + 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 */ - readonly "api-insights-subject-stats": readonly { - readonly subject_type?: string; - readonly subject_name?: string; + "api-insights-subject-stats": { + subject_type?: string; + 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; + 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 */ - readonly "api-insights-summary-stats": { + "api-insights-summary-stats": { /** * Format: int64 * @description The total number of requests within the queried time period */ - readonly total_request_count?: number; + 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; + 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; + "api-insights-time-stats": { + timestamp?: string; /** Format: int64 */ - readonly total_request_count?: number; + total_request_count?: number; /** Format: int64 */ - readonly rate_limited_request_count?: number; + 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; + "api-insights-user-stats": { + actor_type?: string; + actor_name?: string; /** Format: int64 */ - readonly actor_id?: number; + actor_id?: number; /** Format: int64 */ - readonly integration_id?: number | null; + 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; + 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 * @enum {string} */ - readonly "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; + "interaction-group": "existing_users" | "contributors_only" | "collaborators_only"; /** * Interaction Limits * @description Interaction limit settings. */ - readonly "interaction-limit-response": { - readonly limit: components["schemas"]["interaction-group"]; + "interaction-limit-response": { + limit: components["schemas"]["interaction-group"]; /** @example repository */ - readonly origin: string; + origin: string; /** * Format: date-time * @example 2018-08-17T04:18:39Z */ - readonly expires_at: string; + expires_at: string; }; /** * @description The duration of the interaction restriction. Default: `one_day`. * @example one_month * @enum {string} */ - readonly "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; + "interaction-expiry": "one_day" | "three_days" | "one_week" | "one_month" | "six_months"; /** * Interaction Restrictions * @description Limit interactions to a specific type of user for a specified duration */ - readonly "interaction-limit": { - readonly limit: components["schemas"]["interaction-group"]; - readonly expiry?: components["schemas"]["interaction-expiry"]; + "interaction-limit": { + limit: components["schemas"]["interaction-group"]; + expiry?: components["schemas"]["interaction-expiry"]; + }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; }; /** * Org Membership * @description Org Membership */ - readonly "org-membership": { + "org-membership": { /** * Format: uri * @example https://api.github.com/orgs/octocat/memberships/defunkt */ - readonly url: string; + url: string; /** * @description The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation. * @example active * @enum {string} */ - readonly state: "active" | "pending"; + state: "active" | "pending"; /** * @description The user's membership type in the organization. * @example admin * @enum {string} */ - readonly role: "admin" | "member" | "billing_manager"; + role: "admin" | "member" | "billing_manager"; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; /** * Format: uri * @example https://api.github.com/orgs/octocat */ - readonly organization_url: string; - readonly organization: components["schemas"]["organization-simple"]; - readonly user: components["schemas"]["nullable-simple-user"]; - readonly permissions?: { - readonly can_create_repository: boolean; + organization_url: string; + organization: components["schemas"]["organization-simple"]; + user: components["schemas"]["nullable-simple-user"]; + permissions?: { + can_create_repository: boolean; }; }; /** * Migration * @description A migration. */ - readonly migration: { + migration: { /** * Format: int64 * @example 79 */ - readonly id: number; - readonly owner: components["schemas"]["nullable-simple-user"]; + id: number; + owner: components["schemas"]["nullable-simple-user"]; /** @example 0b989ba4-242f-11e5-81e1-c7b6966d2516 */ - readonly guid: string; + guid: string; /** @example pending */ - readonly state: string; + state: string; /** @example true */ - readonly lock_repositories: boolean; - readonly exclude_metadata: boolean; - readonly exclude_git_data: boolean; - readonly exclude_attachments: boolean; - readonly exclude_releases: boolean; - readonly exclude_owner_projects: boolean; - readonly org_metadata_only: boolean; + lock_repositories: boolean; + exclude_metadata: boolean; + exclude_git_data: boolean; + exclude_attachments: boolean; + exclude_releases: boolean; + exclude_owner_projects: boolean; + org_metadata_only: boolean; /** @description The repositories included in the migration. Only returned for export migrations. */ - readonly repositories: readonly components["schemas"]["repository"][]; + repositories: components["schemas"]["repository"][]; /** * Format: uri * @example https://api.github.com/orgs/octo-org/migrations/79 */ - readonly url: string; + url: string; /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2015-07-06T15:33:38-07:00 */ - readonly updated_at: string; - readonly node_id: string; + updated_at: string; + node_id: string; /** Format: uri */ - readonly archive_url?: string; + archive_url?: string; /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ - readonly exclude?: readonly string[]; + exclude?: string[]; }; /** * Organization Role * @description Organization roles */ - readonly "organization-role": { + "organization-role": { /** * Format: int64 * @description The unique identifier of the role. */ - readonly id: number; + id: number; /** @description The name of the role. */ - readonly name: string; + name: string; /** @description A short description about who this role is for or what permissions it grants. */ - readonly description?: string | null; + description?: string | null; /** * @description The system role from which this role inherits permissions. * @enum {string|null} */ - readonly base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; + base_role?: "read" | "triage" | "write" | "maintain" | "admin" | null; /** * @description Source answers the question, "where did this role come from?" * @enum {string|null} */ - readonly source?: "Organization" | "Enterprise" | "Predefined" | null; + source?: "Organization" | "Enterprise" | "Predefined" | null; /** @description A list of permissions included in this role. */ - readonly permissions: readonly string[]; - readonly organization: components["schemas"]["nullable-simple-user"]; + permissions: string[]; + organization: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The date and time the role was created. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time the role was last updated. */ - readonly updated_at: string; + updated_at: string; }; /** * A Role Assignment for a Team * @description The Relationship a Team has with a role. */ - readonly "team-role-assignment": { + "team-role-assignment": { /** * @description Determines if the team has a direct, indirect, or mixed relationship to a role * @example direct * @enum {string} */ - readonly assignment?: "direct" | "indirect" | "mixed"; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly slug: string; - readonly description: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission: string; - readonly permissions?: { - readonly pull: boolean; - readonly triage: boolean; - readonly push: boolean; - readonly maintain: boolean; - readonly admin: boolean; + assignment?: "direct" | "indirect" | "mixed"; + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; }; /** Format: uri */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; - readonly members_url: string; + html_url: string; + members_url: string; /** Format: uri */ - readonly repositories_url: string; - readonly parent: components["schemas"]["nullable-team-simple"]; + repositories_url: string; + parent: components["schemas"]["nullable-team-simple"]; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Team Simple * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "team-simple": { + "team-simple": { /** * @description Unique identifier of the team * @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + url: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + members_url: string; /** * @description Name of the team * @example Justice League */ - readonly name: string; + name: string; /** * @description Description of the team * @example A great team. */ - readonly description: string | null; + description: string | null; /** * @description Permission that the team will have for its repositories * @example admin */ - readonly permission: string; + permission: string; /** * @description The level of privacy this team should have * @example closed */ - readonly privacy?: string; + privacy?: string; /** * @description The notification setting the team has set * @example notifications_enabled */ - readonly notification_setting?: string; + notification_setting?: string; /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; + repositories_url: string; /** @example justice-league */ - readonly slug: string; + slug: string; /** * @description Distinguished Name (DN) that team maps to within LDAP environment * @example uid=example,ou=users,dc=github,dc=com */ - readonly ldap_dn?: string; + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * A Role Assignment for a User * @description The Relationship a User has with a role. */ - readonly "user-role-assignment": { + "user-role-assignment": { /** * @description Determines if the user has a direct, indirect, or mixed relationship to a role * @example direct * @enum {string} */ - readonly assignment?: "direct" | "indirect" | "mixed"; + assignment?: "direct" | "indirect" | "mixed"; /** @description Team the user has gotten the role through */ - readonly inherited_from?: readonly components["schemas"]["team-simple"][]; - readonly name?: string | null; - readonly email?: string | null; + inherited_from?: components["schemas"]["team-simple"][]; + name?: string | null; + email?: string | null; /** @example octocat */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; + starred_at?: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; }; /** * Package Version * @description A version of a software package */ - readonly "package-version": { + "package-version": { /** * @description Unique identifier of the package version. * @example 1 */ - readonly id: number; + id: number; /** * @description The name of the package version. * @example latest */ - readonly name: string; + name: string; /** @example https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 */ - readonly url: string; + url: string; /** @example https://github.com/orgs/github/packages/container/package/super-linter */ - readonly package_html_url: string; + package_html_url: string; /** @example https://github.com/orgs/github/packages/container/super-linter/786068 */ - readonly html_url?: string; + html_url?: string; /** @example MIT */ - readonly license?: string; - readonly description?: string; + license?: string; + description?: string; /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly deleted_at?: string; + deleted_at?: string; /** Package Version Metadata */ - readonly metadata?: { + metadata?: { /** * @example docker * @enum {string} */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** Container Metadata */ - readonly container?: { - readonly tags: readonly string[]; + container?: { + tags: string[]; }; /** Docker Metadata */ - readonly docker?: { - readonly tag?: readonly string[]; + docker?: { + tag?: string[]; }; }; }; @@ -24763,602 +27150,1143 @@ export interface components { * Simple Organization Programmatic Access Grant Request * @description Minimal representation of an organization programmatic access grant request for enumerations */ - readonly "organization-programmatic-access-grant-request": { + "organization-programmatic-access-grant-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. The `pat_request_id` used to review PAT requests. */ - readonly id: number; + id: number; /** @description Reason for requesting access. */ - readonly reason: string | null; - readonly owner: components["schemas"]["simple-user"]; + reason: string | null; + owner: components["schemas"]["simple-user"]; /** * @description Type of repository selection requested. * @enum {string} */ - readonly repository_selection: "none" | "all" | "subset"; + repository_selection: "none" | "all" | "subset"; /** @description URL to the list of repositories requested to be accessed via fine-grained personal access token. Should only be followed when `repository_selection` is `subset`. */ - readonly repositories_url: string; + repositories_url: string; /** @description Permissions requested, categorized by type of permission. */ - readonly permissions: { - readonly organization?: { - readonly [key: string]: string; + permissions: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Date and time when the request for access was created. */ - readonly created_at: string; + 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; + 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; + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; + token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; + token_expires_at: string | null; /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + token_last_used_at: string | null; }; /** * Organization Programmatic Access Grant * @description Minimal representation of an organization programmatic access grant for enumerations */ - readonly "organization-programmatic-access-grant": { + "organization-programmatic-access-grant": { /** @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"]; + id: number; + owner: components["schemas"]["simple-user"]; /** * @description Type of repository selection requested. * @enum {string} */ - readonly repository_selection: "none" | "all" | "subset"; + repository_selection: "none" | "all" | "subset"; /** @description URL to the list of repositories the fine-grained personal access token can access. Only follow when `repository_selection` is `subset`. */ - readonly repositories_url: string; + repositories_url: string; /** @description Permissions requested, categorized by type of permission. */ - readonly permissions: { - readonly organization?: { - readonly [key: string]: string; + permissions: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Date and time when the fine-grained personal access token was approved to access the organization. */ - readonly access_granted_at: string; + 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; + 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; + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; + token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; + token_expires_at: string | null; /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + token_last_used_at: string | null; }; /** * Organization private registry * @description Private registry configuration for an organization */ - readonly "org-private-registry-configuration": { + "org-private-registry-configuration": { /** * @description The name of the private registry configuration. * @example MAVEN_REPOSITORY_SECRET */ - readonly name: string; + name: string; /** * @description The registry type. * @enum {string} */ - readonly registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ - readonly username?: string | null; + username?: string | null; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Organization private registry * @description Private registry configuration for an organization */ - readonly "org-private-registry-configuration-with-selected-repositories": { + "org-private-registry-configuration-with-selected-repositories": { /** * @description The name of the private registry configuration. * @example MAVEN_REPOSITORY_SECRET */ - readonly name: string; + name: string; /** * @description The registry type. * @enum {string} */ - readonly registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ - readonly username?: string; + username?: string; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** - * Project - * @description Projects are a way to organize columns and cards of work. + * Projects v2 Status Update + * @description An status update belonging to a project */ - readonly project: { + "nullable-projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the status update was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the status update was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @description The start date of the period covered by the update. + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @description The target date associated with the update. + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + } | null; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + /** @description The unique identifier of the project. */ + id: number; + /** @description The node ID of the project. */ + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + /** @description The project title. */ + title: string; + /** @description A short description of the project. */ + description: string | null; + /** @description Whether the project is visible to anyone with access to the owner. */ + public: boolean; + /** + * Format: date-time + * @description The time when the project was closed. + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @description The time when the project was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the project was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @description The project number. */ + number: number; + /** @description A concise summary of the project. */ + short_description: string | null; + /** + * Format: date-time + * @description The time when the project was deleted. + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: components["schemas"]["nullable-simple-user"]; + /** + * @description The current state of the project. + * @enum {string} + */ + state?: "open" | "closed"; + latest_status_update?: components["schemas"]["nullable-projects-v2-status-update"]; + /** @description Whether this project is a template */ + is_template?: boolean; + }; + /** + * Link + * @description Hypermedia Link + */ + link: { + href: string; + }; + /** + * Auto merge + * @description The status of auto merging a pull request. + */ + "auto-merge": { + enabled_by: components["schemas"]["simple-user"]; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + /** @description Title for the merge commit message. */ + commit_title: string; + /** @description Commit message for the merge commit. */ + commit_message: string; + } | null; + /** + * Pull Request Simple + * @description Pull Request Simple + */ + "pull-request-simple": { /** * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 + */ + url: string; + /** + * Format: int64 + * @example 1 */ - readonly owner_url: string; + id: number; + /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + node_id: string; /** * Format: uri - * @example https://api.github.com/projects/1002604 + * @example https://github.com/octocat/Hello-World/pull/1347 */ - readonly url: string; + html_url: string; /** * Format: uri - * @example https://github.com/api-playground/projects-test/projects/12 + * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - readonly html_url: string; + diff_url: string; /** * Format: uri - * @example https://api.github.com/projects/1002604/columns + * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - readonly columns_url: string; - /** @example 1002604 */ - readonly id: number; - /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ - readonly node_id: string; + patch_url: string; /** - * @description Name of the project - * @example Week One Sprint + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly name: string; + issue_url: string; /** - * @description Body of the project - * @example This project represents the sprint of the first week in January + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - readonly body: string | null; - /** @example 1 */ - readonly number: number; + commits_url: string; /** - * @description State of the project; either 'open' or 'closed' - * @example open + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + */ + review_comments_url: string; + /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ + review_comment_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - readonly state: string; - readonly creator: components["schemas"]["nullable-simple-user"]; + comments_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + statuses_url: string; + /** @example 1347 */ + number: number; + /** @example open */ + state: string; + /** @example true */ + locked: boolean; + /** @example new-feature */ + title: string; + user: components["schemas"]["nullable-simple-user"]; + /** @example Please pull these awesome changes */ + body: string | null; + labels: { + /** Format: int64 */ + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: components["schemas"]["nullable-milestone"]; + /** @example too heated */ + active_lock_reason?: string | null; /** * Format: date-time - * @example 2011-04-10T20:09:31Z + * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time - * @example 2014-03-03T18:58:10Z + * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + merged_at: string | null; + /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ + draft?: boolean; + }; + /** + * Draft Issue + * @description A draft issue in a project + */ + "projects-v2-draft-issue": { + /** @description The ID of the draft issue */ + id: number; + /** @description The node ID of the draft issue */ + node_id: string; + /** @description The title of the draft issue */ + title: string; + /** @description The body content of the draft issue */ + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time the draft issue was created + */ + created_at: string; + /** + * Format: date-time + * @description The time the draft issue was last updated + */ + updated_at: string; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-simple": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The content represented by the item. */ + content?: components["schemas"]["issue"] | components["schemas"]["pull-request-simple"] | components["schemas"]["projects-v2-draft-issue"]; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The URL of the project this item belongs to. + */ + project_url?: string; + /** + * Format: uri + * @description The URL of the item in the project. + */ + item_url?: string; + }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-options": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option, in raw text and HTML formats. */ + name: { + raw: string; + html: string; + }; + /** @description The description of the option, in raw text and HTML formats. */ + description: { + raw: string; + html: string; + }; + /** @description The color associated with the option. */ + color: string; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-settings": { + /** @description The unique identifier of the iteration setting. */ + id: string; /** - * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. + * Format: date + * @description The start date of the iteration. + */ + start_date: string; + /** @description The duration of the iteration in days. */ + duration: number; + /** @description The iteration title, in raw text and HTML formats. */ + title: { + raw: string; + html: string; + }; + /** @description Whether the iteration has been completed. */ + completed: boolean; + }; + /** + * Projects v2 Field + * @description A field inside a projects v2 project + */ + "projects-v2-field": { + /** @description The unique identifier of the field. */ + id: number; + /** @description The node ID of the field. */ + node_id?: string; + /** + * @description The API URL of the project that contains the field. + * @example https://api.github.com/projects/1 + */ + project_url: string; + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. * @enum {string} */ - readonly organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - readonly private?: boolean; + data_type: "assignees" | "linked_pull_requests" | "reviewers" | "labels" | "milestone" | "repository" | "title" | "text" | "single_select" | "number" | "date" | "iteration" | "issue_type" | "parent_issue" | "sub_issues_progress"; + /** @description The options available for single select fields. */ + options?: components["schemas"]["projects-v2-single-select-options"][]; + /** @description Configuration for iteration fields. */ + configuration?: { + /** @description The day of the week when the iteration starts. */ + start_day?: number; + /** @description The duration of the iteration in days. */ + duration?: number; + iterations?: components["schemas"]["projects-v2-iteration-settings"][]; + }; + /** + * Format: date-time + * @description The time when the field was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the field was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + }; + "projects-v2-field-single-select-option": { + /** @description The display name of the option. */ + name?: string; + /** + * @description The color associated with the option. + * @enum {string} + */ + color?: "BLUE" | "GRAY" | "GREEN" | "ORANGE" | "PINK" | "PURPLE" | "RED" | "YELLOW"; + /** @description The description of the option. */ + description?: string; + }; + /** @description The configuration for iteration fields. */ + "projects-v2-field-iteration-configuration": { + /** + * Format: date + * @description The start date of the first iteration. + */ + start_date?: string; + /** @description The default duration for iterations in days. Individual iterations can override this value. */ + duration?: number; + /** @description Zero or more iterations for the field. */ + iterations?: { + /** @description The title of the iteration. */ + title?: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date?: string; + /** @description The duration of the iteration in days. */ + duration?: number; + }[]; + }; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-with-content": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** + * Format: uri + * @description The API URL of the project that contains this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/3 + */ + project_url?: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + /** @description The content of the item, which varies by content type. */ + content?: { + [key: string]: unknown; + } | null; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The API URL of this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/items/3 + */ + item_url?: string | null; + /** @description The fields and values associated with this item. */ + fields?: { + [key: string]: unknown; + }[]; + }; + /** + * Projects v2 View + * @description A view inside a projects v2 project + */ + "projects-v2-view": { + /** @description The unique identifier of the view. */ + id: number; + /** @description The number of the view within the project. */ + number: number; + /** @description The name of the view. */ + name: string; + /** + * @description The layout of the view. + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** @description The node ID of the view. */ + node_id: string; + /** + * @description The API URL of the project that contains the view. + * @example https://api.github.com/orgs/octocat/projectsV2/1 + */ + project_url: string; + /** + * Format: uri + * @description The web URL of the view. + * @example https://github.com/orgs/octocat/projects/1/views/1 + */ + html_url: string; + creator: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the view was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the view was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The filter query for the view. + * @example is:issue is:open + */ + filter?: string | null; + /** @description The list of field IDs that are visible in the view. */ + visible_fields: number[]; + /** @description The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". */ + sort_by: (number | string)[][]; + /** @description The list of field IDs used for horizontal grouping. */ + group_by: number[]; + /** @description The list of field IDs used for vertical grouping (board layout). */ + vertical_group_by: number[]; }; /** * Organization Custom Property * @description Custom property defined on an organization */ - readonly "custom-property": { + "custom-property": { /** @description The name of the property */ - readonly property_name: string; + property_name: string; /** * Format: uri * @description The URL that can be used to fetch, update, or delete info about this property via the API. */ - readonly url?: string; + url?: string; /** * @description The source type of the property * @example organization * @enum {string} */ - readonly source_type?: "organization" | "enterprise"; + source_type?: "organization" | "enterprise"; /** * @description The type of the value for the property * @example single_select * @enum {string} */ - readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ - readonly required?: boolean; + required?: boolean; /** @description Default value of the property */ - readonly default_value?: (string | readonly string[]) | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ - readonly description?: string | null; + description?: string | null; /** * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ - readonly allowed_values?: readonly string[] | null; + allowed_values?: string[] | null; /** * @description Who can edit the values of the property * @example org_actors * @enum {string|null} */ - readonly values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Set Payload * @description Custom property set payload */ - readonly "custom-property-set-payload": { + "custom-property-set-payload": { /** * @description The type of the value for the property * @example single_select * @enum {string} */ - readonly value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ - readonly required?: boolean; + required?: boolean; /** @description Default value of the property */ - readonly default_value?: (string | readonly string[]) | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ - readonly description?: string | null; + description?: string | null; /** * @description An ordered list of the allowed values of the property. * The property can have up to 200 allowed values. */ - readonly allowed_values?: readonly string[] | null; + allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Value * @description Custom property name and associated value */ - readonly "custom-property-value": { + "custom-property-value": { /** @description The name of the property */ - readonly property_name: string; + property_name: string; /** @description The value assigned to the property */ - readonly value: (string | readonly string[]) | null; + value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values * @description List of custom property values for a repository */ - readonly "org-repo-custom-property-values": { + "org-repo-custom-property-values": { /** @example 1296269 */ - readonly repository_id: number; + repository_id: number; /** @example Hello-World */ - readonly repository_name: string; + repository_name: string; /** @example octocat/Hello-World */ - readonly repository_full_name: string; + repository_full_name: string; /** @description List of custom property names and associated values */ - readonly properties: readonly components["schemas"]["custom-property-value"][]; + properties: components["schemas"]["custom-property-value"][]; }; /** * Repository * @description A repository on GitHub. */ - readonly "nullable-repository": { + "nullable-repository": { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @deprecated * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -25366,7 +28294,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -25375,7 +28303,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -25383,7 +28311,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -25392,229 +28320,234 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; } | null; /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - readonly "code-of-conduct-simple": { + "code-of-conduct-simple": { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly url: string; + url: string; /** @example citizen_code_of_conduct */ - readonly key: string; + key: string; /** @example Citizen Code of Conduct */ - readonly name: string; + name: string; /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly html_url: string | null; + html_url: string | null; }; /** * Full Repository * @description Full Repository */ - readonly "full-repository": { + "full-repository": { /** * Format: int64 * @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** @example Hello-World */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; - readonly private: boolean; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** @example true */ - readonly is_template?: boolean; + is_template?: boolean; /** * @example [ * "octocat", @@ -25623,64 +28556,72 @@ export interface components { * "API" * ] */ - readonly topics?: readonly string[]; + topics?: string[]; /** @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** @example true */ - readonly has_downloads?: boolean; + has_downloads?: boolean; /** @example true */ - readonly has_discussions: boolean; - readonly archived: boolean; + has_discussions: boolean; + /** @example true */ + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @example public */ - readonly visibility?: string; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string; + pushed_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; + updated_at: string; + permissions?: { + admin: boolean; + maintain?: boolean; + push: boolean; + triage?: boolean; + pull: boolean; }; /** @example true */ - readonly allow_rebase_merge?: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string | null; + allow_rebase_merge?: boolean; + template_repository?: components["schemas"]["nullable-repository"]; + temp_clone_token?: string | null; /** @example true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** @example false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** @example false */ - readonly delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean; /** @example true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** @example true */ - readonly allow_update_branch?: boolean; + allow_update_branch?: boolean; /** @example false */ - readonly use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -25689,7 +28630,7 @@ export interface components { * @example PR_TITLE * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -25699,7 +28640,7 @@ export interface components { * @example PR_BODY * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -25708,7 +28649,7 @@ export interface components { * @example PR_TITLE * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -25718,120 +28659,120 @@ export interface components { * @example PR_BODY * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** @example true */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** @example 42 */ - readonly subscribers_count: number; + subscribers_count: number; /** @example 0 */ - readonly network_count: number; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly parent?: components["schemas"]["repository"]; - readonly source?: components["schemas"]["repository"]; - readonly forks: number; - readonly master_branch?: string; - readonly open_issues: number; - readonly watchers: number; + network_count: number; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + parent?: components["schemas"]["repository"]; + source?: components["schemas"]["repository"]; + forks: number; + master_branch?: string; + open_issues: number; + watchers: number; /** * @description Whether anonymous git access is allowed. * @default true */ - readonly anonymous_access_enabled: boolean; - readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + anonymous_access_enabled: boolean; + code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + security_and_analysis?: components["schemas"]["security-and-analysis"]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; }; /** * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). * @enum {string} */ - readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + "repository-rule-enforcement": "disabled" | "active" | "evaluate"; /** * Repository Ruleset Bypass Actor * @description An actor that can bypass rules in a ruleset */ - readonly "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ - readonly actor_id?: number | null; + "repository-ruleset-bypass-actor": { + /** @description The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. * @enum {string} */ - readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; + 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. Also, `pull_request` is only applicable to branch rulesets. + * @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. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. * @default always * @enum {string} */ - readonly bypass_mode: "always" | "pull_request"; + bypass_mode: "always" | "pull_request" | "exempt"; }; /** * Repository ruleset conditions for ref names * @description Parameters for a repository ruleset ref name condition */ - readonly "repository-ruleset-conditions": { - readonly ref_name?: { + "repository-ruleset-conditions": { + ref_name?: { /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - readonly include?: readonly string[]; + include?: string[]; /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: readonly string[]; + exclude?: string[]; }; }; /** * Repository ruleset conditions for repository names * @description Parameters for a repository name condition */ - readonly "repository-ruleset-conditions-repository-name-target": { - readonly repository_name: { + "repository-ruleset-conditions-repository-name-target": { + repository_name: { /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - readonly include?: readonly string[]; + include?: string[]; /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: readonly string[]; + exclude?: string[]; /** @description Whether renaming of target repositories is prevented. */ - readonly protected?: boolean; + protected?: boolean; }; }; /** * Repository ruleset conditions for repository IDs * @description Parameters for a repository ID condition */ - readonly "repository-ruleset-conditions-repository-id-target": { - readonly repository_id: { + "repository-ruleset-conditions-repository-id-target": { + repository_id: { /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - readonly repository_ids?: readonly number[]; + repository_ids?: number[]; }; }; /** * Repository ruleset property targeting definition * @description Parameters for a targeting a repository property */ - readonly "repository-ruleset-conditions-repository-property-spec": { + "repository-ruleset-conditions-repository-property-spec": { /** @description The name of the repository property to target */ - readonly name: string; + name: string; /** @description The values to match for the repository property */ - readonly property_values: readonly string[]; + property_values: string[]; /** * @description The source of the repository property. Defaults to 'custom' if not specified. * @enum {string} */ - readonly source?: "custom" | "system"; + source?: "custom" | "system"; }; /** * Repository ruleset conditions for repository properties * @description Parameters for a repository property condition */ - readonly "repository-ruleset-conditions-repository-property-target": { - readonly repository_property: { + "repository-ruleset-conditions-repository-property-target": { + repository_property: { /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ - readonly include?: readonly components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ - readonly exclude?: readonly components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; }; }; /** @@ -25841,545 +28782,966 @@ export interface components { * The push rulesets conditions object does not require the `ref_name` property. * For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_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"]); + "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"]); /** * creation * @description Only allow users with bypass permission to create matching refs. */ - readonly "repository-rule-creation": { + "repository-rule-creation": { /** @enum {string} */ - readonly type: "creation"; + type: "creation"; }; /** * update * @description Only allow users with bypass permission to update matching refs. */ - readonly "repository-rule-update": { + "repository-rule-update": { /** @enum {string} */ - readonly type: "update"; - readonly parameters?: { + type: "update"; + parameters?: { /** @description Branch can pull changes from its upstream repository */ - readonly update_allows_fetch_and_merge: boolean; + update_allows_fetch_and_merge: boolean; }; }; /** * deletion * @description Only allow users with bypass permissions to delete matching refs. */ - readonly "repository-rule-deletion": { + "repository-rule-deletion": { /** @enum {string} */ - readonly type: "deletion"; + type: "deletion"; }; /** * required_linear_history * @description Prevent merge commits from being pushed to matching refs. */ - readonly "repository-rule-required-linear-history": { + "repository-rule-required-linear-history": { /** @enum {string} */ - readonly type: "required_linear_history"; + type: "required_linear_history"; }; /** * merge_queue * @description Merges must be performed via a merge queue. */ - readonly "repository-rule-merge-queue": { + "repository-rule-merge-queue": { /** @enum {string} */ - readonly type: "merge_queue"; - readonly parameters?: { + type: "merge_queue"; + parameters?: { /** @description Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed */ - readonly check_response_timeout_minutes: number; + check_response_timeout_minutes: number; /** * @description When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge. * @enum {string} */ - readonly grouping_strategy: "ALLGREEN" | "HEADGREEN"; + grouping_strategy: "ALLGREEN" | "HEADGREEN"; /** @description Limit the number of queued pull requests requesting checks and workflow runs at the same time. */ - readonly max_entries_to_build: number; + max_entries_to_build: number; /** @description The maximum number of PRs that will be merged together in a group. */ - readonly max_entries_to_merge: number; + max_entries_to_merge: number; /** * @description Method to use when merging changes from queued pull requests. * @enum {string} */ - readonly merge_method: "MERGE" | "SQUASH" | "REBASE"; + merge_method: "MERGE" | "SQUASH" | "REBASE"; /** @description The minimum number of PRs that will be merged together in a group. */ - readonly min_entries_to_merge: number; + min_entries_to_merge: number; /** @description The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged. */ - readonly min_entries_to_merge_wait_minutes: number; + min_entries_to_merge_wait_minutes: number; }; }; /** * required_deployments * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. */ - readonly "repository-rule-required-deployments": { + "repository-rule-required-deployments": { /** @enum {string} */ - readonly type: "required_deployments"; - readonly parameters?: { + type: "required_deployments"; + parameters?: { /** @description The environments that must be successfully deployed to before branches can be merged. */ - readonly required_deployment_environments: readonly string[]; + required_deployment_environments: string[]; }; }; /** * required_signatures * @description Commits pushed to matching refs must have verified signatures. */ - readonly "repository-rule-required-signatures": { + "repository-rule-required-signatures": { /** @enum {string} */ - readonly type: "required_signatures"; + type: "required_signatures"; + }; + /** + * Reviewer + * @description A required reviewing team + */ + "repository-rule-params-reviewer": { + /** @description ID of the reviewer which must review changes to matching files. */ + id: number; + /** + * @description The type of the reviewer + * @enum {string} + */ + type: "Team"; }; /** * 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[]; + "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 fnmatch syntax. */ + 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. */ - readonly minimum_approvals: number; - /** @description Node ID of the team which must review changes to matching files. */ - readonly reviewer_id: string; + minimum_approvals: number; + reviewer: components["schemas"]["repository-rule-params-reviewer"]; }; /** * pull_request * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. */ - readonly "repository-rule-pull-request": { + "repository-rule-pull-request": { /** @enum {string} */ - readonly type: "pull_request"; - readonly parameters?: { - /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ - readonly allowed_merge_methods?: readonly string[]; + type: "pull_request"; + parameters?: { + /** @description Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. */ + allowed_merge_methods?: ("merge" | "squash" | "rebase")[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ - readonly dismiss_stale_reviews_on_push: boolean; + dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ - readonly require_code_owner_review: boolean; + require_code_owner_review: boolean; /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ - readonly require_last_push_approval: boolean; + require_last_push_approval: boolean; /** @description The number of approving reviews that are required before a pull request can be merged. */ - readonly required_approving_review_count: number; + required_approving_review_count: number; /** @description All conversations on code must be resolved before a pull request can be merged. */ - readonly required_review_thread_resolution: boolean; + required_review_thread_resolution: boolean; + /** + * @description > [!NOTE] + * > `required_reviewers` is in beta and subject to change. + * + * A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + */ + required_reviewers?: components["schemas"]["repository-rule-params-required-reviewer-configuration"][]; }; }; /** * StatusCheckConfiguration * @description Required status check */ - readonly "repository-rule-params-status-check-configuration": { + "repository-rule-params-status-check-configuration": { /** @description The status check context name that must be present on the commit. */ - readonly context: string; + context: string; /** @description The optional integration ID that this status check must originate from. */ - readonly integration_id?: number; + integration_id?: number; }; /** * required_status_checks * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. */ - readonly "repository-rule-required-status-checks": { + "repository-rule-required-status-checks": { /** @enum {string} */ - readonly type: "required_status_checks"; - readonly parameters?: { + type: "required_status_checks"; + parameters?: { /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ - readonly do_not_enforce_on_create?: boolean; + do_not_enforce_on_create?: boolean; /** @description Status checks that are required. */ - readonly required_status_checks: readonly components["schemas"]["repository-rule-params-status-check-configuration"][]; + required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ - readonly strict_required_status_checks_policy: boolean; + strict_required_status_checks_policy: boolean; }; }; /** * non_fast_forward * @description Prevent users with push access from force pushing to refs. */ - readonly "repository-rule-non-fast-forward": { + "repository-rule-non-fast-forward": { /** @enum {string} */ - readonly type: "non_fast_forward"; + type: "non_fast_forward"; }; /** * commit_message_pattern * @description Parameters to be used for the commit_message_pattern rule */ - readonly "repository-rule-commit-message-pattern": { + "repository-rule-commit-message-pattern": { /** @enum {string} */ - readonly type: "commit_message_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "commit_message_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * commit_author_email_pattern * @description Parameters to be used for the commit_author_email_pattern rule */ - readonly "repository-rule-commit-author-email-pattern": { + "repository-rule-commit-author-email-pattern": { /** @enum {string} */ - readonly type: "commit_author_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "commit_author_email_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * committer_email_pattern * @description Parameters to be used for the committer_email_pattern rule */ - readonly "repository-rule-committer-email-pattern": { + "repository-rule-committer-email-pattern": { /** @enum {string} */ - readonly type: "committer_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "committer_email_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * branch_name_pattern * @description Parameters to be used for the branch_name_pattern rule */ - readonly "repository-rule-branch-name-pattern": { + "repository-rule-branch-name-pattern": { /** @enum {string} */ - readonly type: "branch_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "branch_name_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; }; }; /** * tag_name_pattern * @description Parameters to be used for the tag_name_pattern rule */ - readonly "repository-rule-tag-name-pattern": { + "repository-rule-tag-name-pattern": { /** @enum {string} */ - readonly type: "tag_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; + type: "tag_name_pattern"; + parameters?: { + /** @description How this rule appears when configuring it. */ + name?: string; /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; + negate?: boolean; /** * @description The operator to use for matching. * @enum {string} */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + operator: "starts_with" | "ends_with" | "contains" | "regex"; /** @description The pattern to match with. */ - readonly pattern: string; + pattern: string; + }; + }; + /** + * file_path_restriction + * @description Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + */ + "repository-rule-file-path-restriction": { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + }; + /** + * max_file_path_length + * @description Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + */ + "repository-rule-max-file-path-length": { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths. */ + max_file_path_length: number; + }; + }; + /** + * file_extension_restriction + * @description Prevent commits that include files with specified file extensions from being pushed to the commit graph. + */ + "repository-rule-file-extension-restriction": { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + }; + /** + * max_file_size + * @description Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + */ + "repository-rule-max-file-size": { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; }; }; /** * RestrictedCommits * @description Restricted commit */ - readonly "repository-rule-params-restricted-commits": { + "repository-rule-params-restricted-commits": { /** @description Full or abbreviated commit hash to reject */ - readonly oid: string; + oid: string; /** @description Reason for restriction */ - readonly reason?: string; + reason?: string; }; /** * WorkflowFileReference * @description A workflow that must run for this rule to pass */ - readonly "repository-rule-params-workflow-file-reference": { + "repository-rule-params-workflow-file-reference": { /** @description The path to the workflow file */ - readonly path: string; + path: string; /** @description The ref (branch or tag) of the workflow file to use */ - readonly ref?: string; + ref?: string; /** @description The ID of the repository where the workflow is defined */ - readonly repository_id: number; + repository_id: number; /** @description The commit SHA of the workflow file to use */ - readonly sha?: string; + sha?: string; }; /** * workflows * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. */ - readonly "repository-rule-workflows": { + "repository-rule-workflows": { /** @enum {string} */ - readonly type: "workflows"; - readonly parameters?: { + type: "workflows"; + parameters?: { /** @description Allow repositories and branches to be created if a check would otherwise prohibit it. */ - readonly do_not_enforce_on_create?: boolean; + do_not_enforce_on_create?: boolean; /** @description Workflows that must pass for this rule to pass. */ - readonly workflows: readonly components["schemas"]["repository-rule-params-workflow-file-reference"][]; + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; /** * CodeScanningTool * @description A tool that must provide code scanning results for this rule to pass. */ - readonly "repository-rule-params-code-scanning-tool": { + "repository-rule-params-code-scanning-tool": { /** * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." * @enum {string} */ - readonly alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." * @enum {string} */ - readonly security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; + security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; /** @description The name of a code scanning tool */ - readonly tool: string; + tool: string; }; /** * code_scanning * @description Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated. */ - readonly "repository-rule-code-scanning": { + "repository-rule-code-scanning": { /** @enum {string} */ - readonly type: "code_scanning"; - readonly parameters?: { + type: "code_scanning"; + parameters?: { /** @description Tools that must provide code scanning results for this rule to pass. */ - readonly code_scanning_tools: readonly components["schemas"]["repository-rule-params-code-scanning-tool"][]; + code_scanning_tools: components["schemas"]["repository-rule-params-code-scanning-tool"][]; }; }; /** - * Repository Rule - * @description A repository rule. + * copilot_code_review + * @description Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. */ - readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { - /** @enum {string} */ - readonly type: "file_path_restriction"; - readonly parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - readonly restricted_file_paths: readonly string[]; - }; - } | { - /** @enum {string} */ - readonly type: "max_file_path_length"; - readonly parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - readonly max_file_path_length: number; - }; - } | { - /** @enum {string} */ - readonly type: "file_extension_restriction"; - readonly parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - readonly restricted_file_extensions: readonly string[]; - }; - } | { + "repository-rule-copilot-code-review": { /** @enum {string} */ - readonly type: "max_file_size"; - readonly parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - readonly max_file_size: number; + type: "copilot_code_review"; + parameters?: { + /** @description Copilot automatically reviews draft pull requests before they are marked as ready for review. */ + review_draft_pull_requests?: boolean; + /** @description Copilot automatically reviews each new push to the pull request. */ + review_on_push?: boolean; }; - } | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"]; + }; + /** + * CopilotCodeReviewAnalysisTool + * @description A tool that must provide code review results for this rule to pass. + */ + "repository-rule-params-copilot-code-review-analysis-tool": { + /** + * @description The name of a code review analysis tool + * @enum {string} + */ + name: "CodeQL" | "ESLint" | "PMD"; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. */ - readonly "repository-ruleset": { + "repository-ruleset": { /** @description The ID of the ruleset */ - readonly id: number; + id: number; /** @description The name of the ruleset */ - readonly name: string; + name: string; /** * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push" | "repository"; + target?: "branch" | "tag" | "push" | "repository"; /** * @description The type of the source of the ruleset * @enum {string} */ - readonly source_type?: "Repository" | "Organization" | "Enterprise"; + source_type?: "Repository" | "Organization" | "Enterprise"; /** @description The name of the source */ - readonly source: string; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + source: string; + enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** * @description The bypass type of the user making the API request for this ruleset. This field is only returned when * querying the repository-level endpoint. * @enum {string} */ - readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never"; - readonly node_id?: string; - readonly _links?: { - readonly self?: { + current_user_can_bypass?: "always" | "pull_requests_only" | "never" | "exempt"; + node_id?: string; + _links?: { + self?: { /** @description The URL of the ruleset */ - readonly href?: string; + href?: string; }; - readonly html?: { + html?: { /** @description The html URL of the ruleset */ - readonly href?: string; + href?: string; } | null; }; - readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; - readonly rules?: readonly components["schemas"]["repository-rule"][]; + conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; + rules?: components["schemas"]["repository-rule"][]; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; }; + /** + * Repository Rule + * @description A repository rule. + */ + "org-rules": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Rule Suites * @description Response */ - readonly "rule-suites": readonly { + "rule-suites": { /** @description The unique identifier of the rule insight. */ - readonly id?: number; + id?: number; /** @description The number that identifies the user. */ - readonly actor_id?: number; + actor_id?: number; /** @description The handle for the GitHub user account. */ - readonly actor_name?: string; + actor_name?: string; /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; + before_sha?: string; /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; + after_sha?: string; /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; + ref?: string; /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; + repository_id?: number; /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + repository_name?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string; + pushed_at?: string; /** * @description The result of the rule evaluations for rules with the `active` enforcement status. * @enum {string} */ - readonly result?: "pass" | "fail" | "bypass"; + result?: "pass" | "fail" | "bypass"; /** * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - readonly evaluation_result?: "pass" | "fail" | "bypass"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; + /** + * Pull request rule suite metadata + * @description Metadata for a pull request rule evaluation result. + */ + "rule-suite-pull-request": { + /** @description The pull request associated with the rule evaluation. */ + pull_request?: { + /** @description The unique identifier of the pull request. */ + id?: number; + /** @description The number of the pull request. */ + number?: number; + /** @description The user who created the pull request. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The reviews associated with the pull request. */ + reviews?: { + /** @description The unique identifier of the review. */ + id?: number; + /** @description The user who submitted the review. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The state of the review. */ + state?: string; + }[]; + }; + }; /** * Rule Suite * @description Response */ - readonly "rule-suite": { + "rule-suite": { /** @description The unique identifier of the rule insight. */ - readonly id?: number; + id?: number; /** @description The number that identifies the user. */ - readonly actor_id?: number | null; + actor_id?: number | null; /** @description The handle for the GitHub user account. */ - readonly actor_name?: string | null; - /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; + actor_name?: string | null; + /** @description The previous commit SHA of the ref. */ + before_sha?: string; + /** @description The new commit SHA of the ref. */ + after_sha?: string; /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; + ref?: string; /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; + repository_id?: number; /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + repository_name?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at?: string; + pushed_at?: string; /** * @description The result of the rule evaluations for rules with the `active` enforcement status. * @enum {string} */ - readonly result?: "pass" | "fail" | "bypass"; + result?: "pass" | "fail" | "bypass"; /** * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ - readonly evaluation_result?: "pass" | "fail" | "bypass" | null; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ - readonly rule_evaluations?: readonly { - readonly rule_source?: { + rule_evaluations?: { + rule_source?: { /** @description The type of rule source. */ - readonly type?: string; + type?: string; /** @description The ID of the rule source. */ - readonly id?: number | null; + id?: number | null; /** @description The name of the rule source. */ - readonly name?: string | null; + name?: string | null; }; /** * @description The enforcement level of this rule source. * @enum {string} */ - readonly enforcement?: "active" | "evaluate" | "deleted ruleset"; + enforcement?: "active" | "evaluate" | "deleted ruleset"; /** * @description The result of the evaluation of the individual rule. * @enum {string} */ - readonly result?: "pass" | "fail"; + result?: "pass" | "fail"; /** @description The type of rule. */ - readonly rule_type?: string; + rule_type?: string; /** @description The detailed failure message for the rule. Null if the rule passed. */ - readonly details?: string | null; + details?: string | null; }[]; }; + /** + * Ruleset version + * @description The historical version of a ruleset + */ + "ruleset-version": { + /** @description The ID of the previous version of the ruleset */ + version_id: number; + /** @description The actor who updated the ruleset */ + actor: { + id?: number; + type?: string; + }; + /** Format: date-time */ + updated_at: string; + }; + "ruleset-version-with-state": components["schemas"]["ruleset-version"] & { + /** @description The state of the ruleset version */ + state: Record; + }; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "nullable-alert-updated-at": string | null; + /** + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + * @enum {string} + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; + /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ + "secret-scanning-location-commit": { + /** + * @description The file path in the repository + * @example /example/secrets.txt + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** @description The API URL to get the associated blob resource */ + blob_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + commit_sha: string; + /** @description The API URL to get the associated commit resource */ + commit_url: string; + }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; + /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ + "secret-scanning-location-issue-title": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_title_url: string; + }; + /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ + "secret-scanning-location-issue-body": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_body_url: string; + }; + /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ + "secret-scanning-location-issue-comment": { + /** + * Format: uri + * @description The API URL to get the issue comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + issue_comment_url: string; + }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; + /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */ + "nullable-secret-scanning-first-detected-location": (components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]) | null; + "organization-secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; + /** @description The secret that was detected. */ + secret?: string; + repository?: components["schemas"]["simple-repository"]; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description The comment that was optionally added when this alert was closed */ + resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @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; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */ + "secret-scanning-row-version": string | null; + "secret-scanning-pattern-override": { + /** @description The ID of the pattern. */ + token_type?: string; + /** @description The version of this pattern if it's a custom pattern. */ + custom_pattern_version?: string | null; + /** @description The slug of the pattern. */ + slug?: string; + /** @description The user-friendly name for the pattern. */ + display_name?: string; + /** @description The total number of alerts generated by this pattern. */ + alert_total?: number; + /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */ + alert_total_percentage?: number; + /** @description The number of false positive alerts generated by this pattern. */ + false_positives?: number; + /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */ + false_positive_rate?: number; + /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */ + bypass_rate?: number; + /** + * @description The default push protection setting for this pattern. + * @enum {string} + */ + default_setting?: "disabled" | "enabled"; + /** + * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + * @enum {string|null} + */ + enterprise_setting?: "not-set" | "disabled" | "enabled" | null; + /** + * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + * @enum {string} + */ + setting?: "not-set" | "disabled" | "enabled"; + }; + /** + * Secret scanning pattern configuration + * @description A collection of secret scanning patterns and their settings related to push protection. + */ + "secret-scanning-pattern-configuration": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Overrides for partner patterns. */ + provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + /** @description Overrides for custom patterns defined by the organization. */ + custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly "repository-advisory-vulnerability": { + "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name: string | null; + name: string | null; } | null; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; + vulnerable_version_range: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions: string | null; + patched_versions: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions: readonly string[] | null; + vulnerable_functions: string[] | null; }; /** @description A credit given to a user for a repository security advisory. */ - readonly "repository-advisory-credit": { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; + "repository-advisory-credit": { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; /** * @description The state of the user's acceptance of the credit. * @enum {string} */ - readonly state: "accepted" | "declined" | "pending"; + state: "accepted" | "declined" | "pending"; }; /** @description A repository security advisory. */ - readonly "repository-advisory": { + "repository-advisory": { /** @description The GitHub Security Advisory ID. */ readonly ghsa_id: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; + cve_id: string | null; /** * Format: uri * @description The API URL for the advisory. @@ -26391,32 +29753,32 @@ export interface components { */ readonly html_url: string; /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; + description: string | null; /** * @description The severity of the advisory. * @enum {string|null} */ - readonly severity: "critical" | "high" | "medium" | "low" | null; + severity: "critical" | "high" | "medium" | "low" | null; /** @description The author of the advisory. */ readonly author: components["schemas"]["simple-user"] | null; /** @description The publisher of the advisory. */ readonly publisher: components["schemas"]["simple-user"] | null; - readonly identifiers: readonly { + readonly identifiers: { /** * @description The type of identifier. * @enum {string} */ - readonly type: "CVE" | "GHSA"; + type: "CVE" | "GHSA"; /** @description The identifier value. */ - readonly value: string; + value: string; }[]; /** * @description The state of the advisory. * @enum {string} */ - readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** * Format: date-time * @description The date and time of when the advisory was created, in ISO 8601 format. @@ -26446,1182 +29808,909 @@ export interface components { /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ readonly accepted: boolean; } | null; - readonly vulnerabilities: readonly components["schemas"]["repository-advisory-vulnerability"][] | null; - readonly cvss: { + vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + cvss: { /** @description The CVSS vector. */ - readonly vector_string: string | null; + vector_string: string | null; /** @description The CVSS score. */ readonly score: number | null; } | null; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly cwes: readonly { + cvss_severities?: components["schemas"]["cvss-severities"]; + readonly cwes: { /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; + cwe_id: string; /** @description The name of the CWE. */ readonly name: string; }[] | null; /** @description A list of only the CWE IDs. */ - readonly cwe_ids: readonly string[] | null; - readonly credits: readonly { + cwe_ids: string[] | null; + credits: { /** @description The username of the user credited. */ - readonly login?: string; - readonly type?: components["schemas"]["security-advisory-credit-types"]; + login?: string; + type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; - readonly credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null; + readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; /** @description A list of users that collaborate on the advisory. */ - readonly collaborating_users: readonly components["schemas"]["simple-user"][] | null; + collaborating_users: components["schemas"]["simple-user"][] | null; /** @description A list of teams that collaborate on the advisory. */ - readonly collaborating_teams: readonly components["schemas"]["team"][] | null; + collaborating_teams: components["schemas"]["team"][] | null; /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; - readonly "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - readonly total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - readonly total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - readonly included_minutes: number; - readonly minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - readonly UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - readonly MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - readonly WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - readonly ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - readonly ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - readonly ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - readonly ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - readonly ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - readonly windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - readonly windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - readonly windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - readonly windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - readonly windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - readonly macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - readonly total?: number; - }; - }; - readonly "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - readonly total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - readonly total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - readonly included_gigabytes_bandwidth: number; - }; - readonly "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - readonly days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - readonly estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - readonly estimated_storage_for_month: number; + /** + * Check immutable releases organization settings + * @description Check immutable releases settings for an organization. + */ + "immutable-releases-organization-settings": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */ + selected_repositories_url?: string; }; /** * Hosted compute network configuration * @description A hosted compute network configuration. */ - readonly "network-configuration": { + "network-configuration": { /** * @description The unique identifier of the network configuration. * @example 123ABC456DEF789 */ - readonly id: string; + id: string; /** * @description The name of the network configuration. * @example my-network-configuration */ - readonly name: string; + name: string; /** * @description The hosted compute service the network configuration supports. * @enum {string} */ - readonly compute_service?: "none" | "actions" | "codespaces"; + compute_service?: "none" | "actions" | "codespaces"; /** * @description The unique identifier of each network settings in the configuration. * @example 123ABC456DEF789 */ - readonly network_settings_ids?: readonly string[]; + network_settings_ids?: string[]; + /** + * @description The unique identifier of each failover network settings in the configuration. + * @example 123ABC456DEF789 + */ + failover_network_settings_ids?: string[]; + /** + * @description Indicates whether the failover network resource is enabled. + * @example true + */ + failover_network_enabled?: boolean; /** * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. * @example 2024-04-26T11:31:07Z */ - readonly created_on: string | null; + created_on: string | null; }; /** * Hosted compute network settings resource * @description A hosted compute network settings resource. */ - readonly "network-settings": { + "network-settings": { /** * @description The unique identifier of the network settings resource. * @example 220F78DACB92BBFBC5E6F22DE1CCF52309D */ - readonly id: string; + id: string; /** * @description The identifier of the network configuration that is using this settings resource. * @example 934E208B3EE0BD60CF5F752C426BFB53562 */ - readonly network_configuration_id?: string; + network_configuration_id?: string; /** * @description The name of the network settings resource. * @example my-network-settings */ - readonly name: string; + name: string; /** * @description The subnet this network settings resource is configured for. * @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet */ - readonly subnet_id: string; + subnet_id: string; /** * @description The location of the subnet this network settings resource is configured for. * @example eastus */ - readonly region: string; + region: string; }; /** * Team Organization * @description Team Organization */ - readonly "team-organization": { + "team-organization": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; /** @example github */ - readonly name?: string; + name?: string; /** @example GitHub */ - readonly company?: string; + company?: string; /** * Format: uri * @example https://github.com/blog */ - readonly blog?: string; + blog?: string; /** @example San Francisco */ - readonly location?: string; + location?: string; /** * Format: email * @example octocat@github.com */ - readonly email?: string; + email?: string; /** @example github */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** @example true */ - readonly is_verified?: boolean; + is_verified?: boolean; /** @example true */ - readonly has_organization_projects: boolean; + has_organization_projects: boolean; /** @example true */ - readonly has_repository_projects: boolean; + has_repository_projects: boolean; /** @example 2 */ - readonly public_repos: number; + public_repos: number; /** @example 1 */ - readonly public_gists: number; + public_gists: number; /** @example 20 */ - readonly followers: number; + followers: number; /** @example 0 */ - readonly following: number; + following: number; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + created_at: string; /** @example Organization */ - readonly type: string; + type: string; /** @example 100 */ - readonly total_private_repos?: number; + total_private_repos?: number; /** @example 100 */ - readonly owned_private_repos?: number; + owned_private_repos?: number; /** @example 81 */ - readonly private_gists?: number | null; + private_gists?: number | null; /** @example 10000 */ - readonly disk_usage?: number | null; + disk_usage?: number | null; /** @example 8 */ - readonly collaborators?: number | null; + collaborators?: number | null; /** * Format: email * @example org@example.com */ - readonly billing_email?: string | null; - readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; }; - readonly default_repository_permission?: string | null; + default_repository_permission?: string | null; /** @example true */ - readonly members_can_create_repositories?: boolean | null; + members_can_create_repositories?: boolean | null; /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; + two_factor_requirement_enabled?: boolean | null; /** @example all */ - readonly members_allowed_repository_creation_type?: string; + members_allowed_repository_creation_type?: string; /** @example true */ - readonly members_can_create_public_repositories?: boolean; + members_can_create_public_repositories?: boolean; /** @example true */ - readonly members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean; /** @example true */ - readonly members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean; /** @example true */ - readonly members_can_create_pages?: boolean; + members_can_create_pages?: boolean; /** @example true */ - readonly members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean; /** @example true */ - readonly members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean; /** @example false */ - readonly members_can_fork_private_repositories?: boolean | null; + members_can_fork_private_repositories?: boolean | null; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly archived_at: string | null; + archived_at: string | null; }; + /** + * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com + */ + "ldap-dn": string; /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "team-full": { + "team-full": { /** * @description Unique identifier of the team * @example 42 */ - readonly id: number; + id: number; /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @description URL for the team * @example https://api.github.com/organizations/1/team/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/orgs/rails/teams/core */ - readonly html_url: string; + html_url: string; /** * @description Name of the team * @example Developers */ - readonly name: string; + name: string; /** @example justice-league */ - readonly slug: string; + slug: string; /** @example A great team. */ - readonly description: string | null; + description: string | null; /** * @description The level of privacy this team should have * @example closed * @enum {string} */ - readonly privacy?: "closed" | "secret"; + privacy?: "closed" | "secret"; /** * @description The notification setting the team has set * @example notifications_enabled * @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** * @description Permission that the team will have for its repositories * @example push */ - readonly permission: string; + permission: string; /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + members_url: string; /** * Format: uri * @example https://api.github.com/organizations/1/team/1/repos */ - readonly repositories_url: string; - readonly parent?: components["schemas"]["nullable-team-simple"]; + repositories_url: string; + parent?: components["schemas"]["nullable-team-simple"]; /** @example 3 */ - readonly members_count: number; + members_count: number; /** @example 10 */ - readonly repos_count: number; + repos_count: number; /** * Format: date-time * @example 2017-07-14T16:53:42Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2017-08-17T12:37:15Z */ - readonly updated_at: string; - readonly organization: components["schemas"]["team-organization"]; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - readonly ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - readonly "team-discussion": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - readonly body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** @example 0 */ - readonly comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - readonly comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - readonly html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - readonly node_id: string; - /** - * @description The unique sequence number of a team discussion. - * @example 42 - */ - readonly number: number; - /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true - */ - readonly pinned: boolean; - /** - * @description Whether or not this discussion should be restricted to team members and organization owners. - * @example true - */ - readonly private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - readonly team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - readonly title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly updated_at: string; + updated_at: string; + organization: components["schemas"]["team-organization"]; + ldap_dn?: components["schemas"]["ldap-dn"]; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 - */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Team Discussion Comment - * @description A reply to a discussion within a team. - */ - readonly "team-discussion-comment": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - readonly body: string; - /** @example

Do you like apples?

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @description The ownership type of the team + * @enum {string} */ - readonly discussion_url: string; + type: "enterprise" | "organization"; /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @description Unique identifier of the organization to which this team belongs + * @example 37 */ - readonly html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - readonly node_id: string; + organization_id?: number; /** - * @description The unique sequence number of a team discussion comment. + * @description Unique identifier of the enterprise to which this team belongs * @example 42 */ - readonly number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - readonly reaction: { - /** @example 1 */ - readonly id: number; - /** @example MDg6UmVhY3Rpb24x */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z - */ - readonly created_at: string; + enterprise_id?: number; }; /** * Team Membership * @description Team Membership */ - readonly "team-membership": { + "team-membership": { /** Format: uri */ - readonly url: string; + url: string; /** * @description The role of the user in the team. * @default member * @example member * @enum {string} */ - readonly role: "member" | "maintainer"; + role: "member" | "maintainer"; /** * @description The state of the user's membership in the team. * @enum {string} */ - readonly state: "active" | "pending"; - }; - /** - * Team Project - * @description A team's access to a project. - */ - readonly "team-project": { - readonly owner_url: string; - readonly url: string; - readonly html_url: string; - readonly columns_url: string; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly body: string | null; - readonly number: number; - readonly state: string; - readonly creator: components["schemas"]["simple-user"]; - readonly created_at: string; - readonly updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - readonly organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - readonly private?: boolean; - readonly permissions: { - readonly read: boolean; - readonly write: boolean; - readonly admin: boolean; - }; + state: "active" | "pending"; }; /** * Team Repository * @description A team's access to a repository. */ - readonly "team-repository": { + "team-repository": { /** * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; }; /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; + role_name?: string; + owner: components["schemas"]["nullable-simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow forking this repo * @default false * @example false */ - readonly allow_forking: boolean; + allow_forking: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false * @example false */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - }; - /** - * Project Card - * @description Project cards represent a scope of work. - */ - readonly "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - readonly url: string; - /** - * Format: int64 - * @description The project card's ID - * @example 42 - */ - readonly id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - readonly node_id: string; - /** @example Add payload for delete Project column */ - readonly note: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @example 2016-09-05T14:21:06Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:20:22Z - */ - readonly updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - readonly archived?: boolean; - readonly column_name?: string; - readonly project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - readonly content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; - }; - /** - * Project Column - * @description Project columns contain cards of work. - */ - readonly "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - readonly cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - readonly id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ - readonly name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - readonly updated_at: string; - }; - /** - * Project Collaborator Permission - * @description Project Collaborator Permission - */ - readonly "project-collaborator-permission": { - readonly permission: string; - readonly user: components["schemas"]["nullable-simple-user"]; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; }; /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly used: number; + "rate-limit": { + limit: number; + remaining: number; + reset: number; + used: number; }; /** * Rate Limit Overview * @description Rate Limit Overview */ - readonly "rate-limit-overview": { - readonly resources: { - readonly core: components["schemas"]["rate-limit"]; - readonly graphql?: components["schemas"]["rate-limit"]; - readonly search: components["schemas"]["rate-limit"]; - readonly code_search?: components["schemas"]["rate-limit"]; - readonly source_import?: components["schemas"]["rate-limit"]; - readonly integration_manifest?: components["schemas"]["rate-limit"]; - readonly code_scanning_upload?: components["schemas"]["rate-limit"]; - readonly actions_runner_registration?: components["schemas"]["rate-limit"]; - readonly scim?: components["schemas"]["rate-limit"]; - readonly dependency_snapshots?: components["schemas"]["rate-limit"]; - readonly code_scanning_autofix?: components["schemas"]["rate-limit"]; + "rate-limit-overview": { + resources: { + core: components["schemas"]["rate-limit"]; + graphql?: components["schemas"]["rate-limit"]; + search: components["schemas"]["rate-limit"]; + code_search?: components["schemas"]["rate-limit"]; + source_import?: components["schemas"]["rate-limit"]; + integration_manifest?: components["schemas"]["rate-limit"]; + code_scanning_upload?: components["schemas"]["rate-limit"]; + actions_runner_registration?: components["schemas"]["rate-limit"]; + scim?: components["schemas"]["rate-limit"]; + dependency_snapshots?: components["schemas"]["rate-limit"]; + dependency_sbom?: components["schemas"]["rate-limit"]; + code_scanning_autofix?: components["schemas"]["rate-limit"]; }; - readonly rate: components["schemas"]["rate-limit"]; + rate: components["schemas"]["rate-limit"]; }; /** * Artifact * @description An artifact */ - readonly artifact: { + artifact: { /** @example 5 */ - readonly id: number; + id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + node_id: string; /** * @description The name of the artifact. * @example AdventureWorks.Framework */ - readonly name: string; + name: string; /** * @description The size in bytes of the artifact. * @example 12345 */ - readonly size_in_bytes: number; + size_in_bytes: number; /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */ - readonly url: string; + url: string; /** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */ - readonly archive_download_url: string; + archive_download_url: string; /** @description Whether or not the artifact has expired. */ - readonly expired: boolean; + expired: boolean; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: date-time */ - readonly expires_at: string | null; + expires_at: string | null; /** Format: date-time */ - readonly updated_at: string | null; - readonly workflow_run?: { + updated_at: string | null; + /** + * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + */ + digest?: string | null; + workflow_run?: { /** @example 10 */ - readonly id?: number; + id?: number; /** @example 42 */ - readonly repository_id?: number; + repository_id?: number; /** @example 42 */ - readonly head_repository_id?: number; + head_repository_id?: number; /** @example main */ - readonly head_branch?: string; + head_branch?: string; /** @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha?: string; + head_sha?: string; } | null; }; + /** + * Actions cache retention limit for a repository + * @description GitHub Actions cache retention policy for a repository. + */ + "actions-cache-retention-limit-for-repository": { + /** + * @description The maximum number of days to keep caches in this repository. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for a repository + * @description GitHub Actions cache storage policy for a repository. + */ + "actions-cache-storage-limit-for-repository": { + /** + * @description The maximum total cache size for this repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** * Repository actions caches * @description Repository actions caches */ - readonly "actions-cache-list": { + "actions-cache-list": { /** * @description Total number of caches * @example 2 */ - readonly total_count: number; + total_count: number; /** @description Array of caches */ - readonly actions_caches: readonly { + actions_caches: { /** @example 2 */ - readonly id?: number; + id?: number; /** @example refs/heads/main */ - readonly ref?: string; + ref?: string; /** @example Linux-node-958aff96db2d75d67787d1e634ae70b659de937b */ - readonly key?: string; + key?: string; /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ - readonly version?: string; + version?: string; /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - readonly last_accessed_at?: string; + last_accessed_at?: string; /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - readonly created_at?: string; + created_at?: string; /** @example 1024 */ - readonly size_in_bytes?: number; + size_in_bytes?: number; }[]; }; /** * Job * @description Information of a job execution in a workflow run */ - readonly job: { + job: { /** * @description The id of the job. * @example 21 */ - readonly id: number; + id: number; /** * @description The id of the associated workflow run. * @example 5 */ - readonly run_id: number; + run_id: number; /** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - readonly run_url: string; + run_url: string; /** * @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - readonly run_attempt?: number; + run_attempt?: number; /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; + node_id: string; /** * @description The SHA of the commit that is being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string | null; + html_url: string | null; /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description The outcome of the job. * @example success * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** * Format: date-time * @description The time that the job created, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the job started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly started_at: string; + started_at: string; /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly completed_at: string | null; + completed_at: string | null; /** * @description The name of the job. * @example test-coverage */ - readonly name: string; + name: string; /** @description Steps in this job. */ - readonly steps?: readonly { + steps?: { /** * @description The phase of the lifecycle that the job is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** * @description The outcome of the job. * @example success */ - readonly conclusion: string | null; + conclusion: string | null; /** * @description The name of the job. * @example test-coverage */ - readonly name: string; + name: string; /** @example 1 */ - readonly number: number; + number: number; /** * Format: date-time * @description The time that the step started, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly started_at?: string | null; + started_at?: string | null; /** * Format: date-time * @description The time that the job finished, in ISO 8601 format. * @example 2019-08-08T08:00:00-07:00 */ - readonly completed_at?: string | null; + completed_at?: string | null; }[]; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly check_run_url: string; + check_run_url: string; /** * @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file. * @example [ @@ -27630,96 +30719,97 @@ export interface components { * "bar" * ] */ - readonly labels: readonly string[]; + labels: string[]; /** * @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 1 */ - readonly runner_id: number | null; + runner_id: number | null; /** * @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner */ - readonly runner_name: string | null; + runner_name: string | null; /** * @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example 2 */ - readonly runner_group_id: number | null; + runner_group_id: number | null; /** * @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.) * @example my runner group */ - readonly runner_group_name: string | null; + runner_group_name: string | null; /** * @description The name of the workflow. * @example Build */ - readonly workflow_name: string | null; + workflow_name: string | null; /** * @description The name of the current branch. * @example main */ - readonly head_branch: string | null; + head_branch: string | null; }; /** * Actions OIDC subject customization for a repository * @description Actions OIDC subject customization for a repository */ - readonly "oidc-custom-sub-repo": { + "oidc-custom-sub-repo": { /** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */ - readonly use_default: boolean; + use_default: boolean; /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */ - readonly include_claim_keys?: readonly string[]; + include_claim_keys?: string[]; }; /** * Actions Secret * @description Set secrets for GitHub Actions. */ - readonly "actions-secret": { + "actions-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** Actions Variable */ - readonly "actions-variable": { + "actions-variable": { /** * @description The name of the variable. * @example USERNAME */ - readonly name: string; + name: string; /** * @description The value of the variable. * @example octocat */ - readonly value: string; + value: string; /** * Format: date-time * @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. * @example 2019-01-24T22:45:36.000Z */ - readonly updated_at: string; + updated_at: string; }; /** @description Whether GitHub Actions is enabled on the repository. */ - readonly "actions-enabled": boolean; - readonly "actions-repository-permissions": { - readonly enabled: components["schemas"]["actions-enabled"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; - readonly selected_actions_url?: components["schemas"]["selected-actions-url"]; + "actions-enabled": boolean; + "actions-repository-permissions": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; - readonly "actions-workflow-access-to-repository": { + "actions-workflow-access-to-repository": { /** * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the * repository. @@ -27727,508 +30817,501 @@ export interface components { * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ - readonly access_level: "none" | "user" | "organization"; + access_level: "none" | "user" | "organization"; }; /** * Referenced workflow * @description A workflow referenced/reused by the initial caller workflow */ - readonly "referenced-workflow": { - readonly path: string; - readonly sha: string; - readonly ref?: string; - }; - /** Pull Request Minimal */ - readonly "pull-request-minimal": { - /** Format: int64 */ - readonly id: number; - readonly number: number; - readonly url: string; - readonly head: { - readonly ref: string; - readonly sha: string; - readonly repo: { - /** Format: int64 */ - readonly id: number; - readonly url: string; - readonly name: string; - }; - }; - readonly base: { - readonly ref: string; - readonly sha: string; - readonly repo: { - /** Format: int64 */ - readonly id: number; - readonly url: string; - readonly name: string; - }; - }; + "referenced-workflow": { + path: string; + sha: string; + ref?: string; }; /** * Simple Commit * @description A commit. */ - readonly "nullable-simple-commit": { + "nullable-simple-commit": { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly id: string; + id: string; /** @description SHA for the commit's tree */ - readonly tree_id: string; + tree_id: string; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; + message: string; /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly timestamp: string; + timestamp: string; /** @description Information about the Git author */ - readonly author: { + author: { /** * @description Name of the commit's author * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; /** @description Information about the Git committer */ - readonly committer: { + committer: { /** * @description Name of the commit's committer * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; } | null; /** * Workflow Run * @description An invocation of a workflow */ - readonly "workflow-run": { + "workflow-run": { /** * @description The ID of the workflow run. * @example 5 */ - readonly id: number; + id: number; /** * @description The name of the workflow run. * @example Build */ - readonly name?: string | null; + name?: string | null; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + node_id: string; /** * @description The ID of the associated check suite. * @example 42 */ - readonly check_suite_id?: number; + check_suite_id?: number; /** * @description The node ID of the associated check suite. * @example MDEwOkNoZWNrU3VpdGU0Mg== */ - readonly check_suite_node_id?: string; + check_suite_node_id?: string; /** @example master */ - readonly head_branch: string | null; + head_branch: string | null; /** * @description The SHA of the head commit that points to the version of the workflow being run. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** * @description The full path of the workflow * @example octocat/octo-repo/.github/workflows/ci.yml@main */ - readonly path: string; + path: string; /** * @description The auto incrementing run number for the workflow run. * @example 106 */ - readonly run_number: number; + run_number: number; /** * @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run. * @example 1 */ - readonly run_attempt?: number; - readonly referenced_workflows?: readonly components["schemas"]["referenced-workflow"][] | null; + run_attempt?: number; + referenced_workflows?: components["schemas"]["referenced-workflow"][] | null; /** @example push */ - readonly event: string; + event: string; /** @example completed */ - readonly status: string | null; + status: string | null; /** @example neutral */ - readonly conclusion: string | null; + conclusion: string | null; /** * @description The ID of the parent workflow. * @example 5 */ - readonly workflow_id: number; + workflow_id: number; /** * @description The URL to the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5 */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/suites/4 */ - readonly html_url: string; + html_url: string; /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */ - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly actor?: components["schemas"]["simple-user"]; - readonly triggering_actor?: components["schemas"]["simple-user"]; + updated_at: string; + actor?: components["schemas"]["simple-user"]; + triggering_actor?: components["schemas"]["simple-user"]; /** * Format: date-time * @description The start time of the latest run. Resets on re-run. */ - readonly run_started_at?: string; + run_started_at?: string; /** * @description The URL to the jobs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs */ - readonly jobs_url: string; + jobs_url: string; /** * @description The URL to download the logs for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs */ - readonly logs_url: string; + logs_url: string; /** * @description The URL to the associated check suite. * @example https://api.github.com/repos/github/hello-world/check-suites/12 */ - readonly check_suite_url: string; + check_suite_url: string; /** * @description The URL to the artifacts for the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts */ - readonly artifacts_url: string; + artifacts_url: string; /** * @description The URL to cancel the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel */ - readonly cancel_url: string; + cancel_url: string; /** * @description The URL to rerun the workflow run. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun */ - readonly rerun_url: string; + rerun_url: string; /** * @description The URL to the previous attempted run of this workflow, if one exists. * @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 */ - readonly previous_attempt_url?: string | null; + previous_attempt_url?: string | null; /** * @description The URL to the workflow. * @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml */ - readonly workflow_url: string; - readonly head_commit: components["schemas"]["nullable-simple-commit"]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly head_repository: components["schemas"]["minimal-repository"]; + workflow_url: string; + head_commit: components["schemas"]["nullable-simple-commit"]; + repository: components["schemas"]["minimal-repository"]; + head_repository: components["schemas"]["minimal-repository"]; /** @example 5 */ - readonly head_repository_id?: number; + head_repository_id?: number; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. * @example Simple Workflow */ - readonly display_title: string; + display_title: string; }; /** * Environment Approval * @description An entry in the reviews log for environment deployments */ - readonly "environment-approvals": { + "environment-approvals": { /** @description The list of environments that were approved or rejected */ - readonly environments: readonly { + environments: { /** * @description The id of the environment. * @example 56780428 */ - readonly id?: number; + id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id?: string; + node_id?: string; /** * @description The name of the environment. * @example staging */ - readonly name?: string; + name?: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url?: string; + url?: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url?: string; + html_url?: string; /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly created_at?: string; + created_at?: string; /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly updated_at?: string; + updated_at?: string; }[]; /** * @description Whether deployment to the environment(s) was approved or rejected or pending (with comments) * @example approved * @enum {string} */ - readonly state: "approved" | "rejected" | "pending"; - readonly user: components["schemas"]["simple-user"]; + state: "approved" | "rejected" | "pending"; + user: components["schemas"]["simple-user"]; /** * @description The comment submitted with the deployment review * @example Ship it! */ - readonly comment: string; + comment: string; }; - readonly "review-custom-gates-comment-required": { + "review-custom-gates-comment-required": { /** @description The name of the environment to approve or reject. */ - readonly environment_name: string; + environment_name: string; /** @description Comment associated with the pending deployment protection rule. **Required when state is not provided.** */ - readonly comment: string; + comment: string; }; - readonly "review-custom-gates-state-required": { + "review-custom-gates-state-required": { /** @description The name of the environment to approve or reject. */ - readonly environment_name: string; + environment_name: string; /** * @description Whether to approve or reject deployment to the specified environments. * @enum {string} */ - readonly state: "approved" | "rejected"; + state: "approved" | "rejected"; /** @description Optional comment to include with the review. */ - readonly comment?: string; + comment?: string; }; /** * @description The type of reviewer. * @example User * @enum {string} */ - readonly "deployment-reviewer-type": "User" | "Team"; + "deployment-reviewer-type": "User" | "Team"; /** * Pending Deployment * @description Details of a deployment that is waiting for protection rules to pass */ - readonly "pending-deployment": { - readonly environment: { + "pending-deployment": { + environment: { /** * Format: int64 * @description The id of the environment. * @example 56780428 */ - readonly id?: number; + id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id?: string; + node_id?: string; /** * @description The name of the environment. * @example staging */ - readonly name?: string; + name?: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url?: string; + url?: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url?: string; + html_url?: string; }; /** * @description The set duration of the wait timer * @example 30 */ - readonly wait_timer: number; + wait_timer: number; /** * Format: date-time * @description The time that the wait timer began. * @example 2020-11-23T22:00:40Z */ - readonly wait_timer_started_at: string | null; + wait_timer_started_at: string | null; /** * @description Whether the currently authenticated user can approve the deployment * @example true */ - readonly current_user_can_approve: boolean; + current_user_can_approve: boolean; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - readonly reviewers: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; - readonly reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; + reviewers: { + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; }[]; }; /** * Deployment * @description A request for a specific ref(branch,sha,tag) to be deployed */ - readonly deployment: { + deployment: { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - readonly url: string; + url: string; /** * Format: int64 * @description Unique identifier of the deployment * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOkRlcGxveW1lbnQx */ - readonly node_id: string; + node_id: string; /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ - readonly sha: string; + sha: string; /** * @description The ref to deploy. This can be a branch, tag, or sha. * @example topic-branch */ - readonly ref: string; + ref: string; /** * @description Parameter to specify a task to execute * @example deploy */ - readonly task: string; - readonly payload: { - readonly [key: string]: unknown; + task: string; + payload: { + [key: string]: unknown; } | string; /** @example staging */ - readonly original_environment?: string; + original_environment?: string; /** * @description Name for the target deployment environment. * @example production */ - readonly environment: string; + environment: string; /** @example Deploy request from hubot */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - readonly transient_environment?: boolean; + transient_environment?: boolean; /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - readonly production_environment?: boolean; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * Workflow Run Usage * @description Workflow Run Usage */ - readonly "workflow-run-usage": { - readonly billable: { - readonly UBUNTU?: { - readonly total_ms: number; - readonly jobs: number; - readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; + "workflow-run-usage": { + billable: { + UBUNTU?: { + total_ms: number; + jobs: number; + job_runs?: { + job_id: number; + duration_ms: number; }[]; }; - readonly MACOS?: { - readonly total_ms: number; - readonly jobs: number; - readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; + MACOS?: { + total_ms: number; + jobs: number; + job_runs?: { + job_id: number; + duration_ms: number; }[]; }; - readonly WINDOWS?: { - readonly total_ms: number; - readonly jobs: number; - readonly job_runs?: readonly { - readonly job_id: number; - readonly duration_ms: number; + WINDOWS?: { + total_ms: number; + jobs: number; + job_runs?: { + job_id: number; + duration_ms: number; }[]; }; }; - readonly run_duration_ms?: number; + run_duration_ms?: number; }; /** * Workflow * @description A GitHub Actions workflow */ - readonly workflow: { + workflow: { /** @example 5 */ - readonly id: number; + id: number; /** @example MDg6V29ya2Zsb3cxMg== */ - readonly node_id: string; + node_id: string; /** @example CI */ - readonly name: string; + name: string; /** @example ruby.yaml */ - readonly path: string; + path: string; /** * @example active * @enum {string} */ - readonly state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; + state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually"; /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly updated_at: string; + updated_at: string; /** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */ - readonly url: string; + url: string; /** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */ - readonly html_url: string; + html_url: string; /** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */ - readonly badge_url: string; + badge_url: string; /** * Format: date-time * @example 2019-12-06T14:20:20.000Z */ - readonly deleted_at?: string; + deleted_at?: string; + }; + /** + * Workflow Run ID + * Format: int64 + * @description The ID of the workflow run. + */ + "workflow-run-id": number; + /** + * Workflow Dispatch Response + * @description Response containing the workflow run ID and URLs. + */ + "workflow-dispatch-response": { + workflow_run_id: components["schemas"]["workflow-run-id"]; + /** + * Format: uri + * @description The URL to the workflow run. + */ + run_url: string; + /** Format: uri */ + html_url: string; }; /** * Workflow Usage * @description Workflow Usage */ - readonly "workflow-usage": { - readonly billable: { - readonly UBUNTU?: { - readonly total_ms?: number; + "workflow-usage": { + billable: { + UBUNTU?: { + total_ms?: number; }; - readonly MACOS?: { - readonly total_ms?: number; + MACOS?: { + total_ms?: number; }; - readonly WINDOWS?: { - readonly total_ms?: number; + WINDOWS?: { + total_ms?: number; }; }; }; @@ -28236,998 +31319,1020 @@ export interface components { * Activity * @description Activity */ - readonly activity: { + activity: { /** @example 1296269 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The SHA of the commit before the activity. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly before: string; + before: string; /** * @description The SHA of the commit after the activity. * @example 827efc6d56897b048c772eb4087f854f46256132 */ - readonly after: string; + after: string; /** * @description The full Git reference, formatted as `refs/heads/`. * @example refs/heads/main */ - readonly ref: string; + ref: string; /** * Format: date-time * @description The time when the activity occurred. * @example 2011-01-26T19:06:43Z */ - readonly timestamp: string; + timestamp: string; /** * @description The type of the activity that was performed. * @example force_push * @enum {string} */ - readonly activity_type: "push" | "force_push" | "branch_deletion" | "branch_creation" | "pr_merge" | "merge_queue_merge"; - readonly actor: components["schemas"]["nullable-simple-user"]; + activity_type: "push" | "force_push" | "branch_deletion" | "branch_creation" | "pr_merge" | "merge_queue_merge"; + actor: components["schemas"]["nullable-simple-user"]; }; /** * Autolink reference * @description An autolink reference. */ - readonly autolink: { + autolink: { /** @example 3 */ - readonly id: number; + id: number; /** * @description The prefix of a key that is linkified. * @example TICKET- */ - readonly key_prefix: string; + key_prefix: string; /** * @description A template for the target URL that is generated if a key was found. * @example https://example.com/TICKET?query= */ - readonly url_template: string; + url_template: string; /** * @description Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters. * @example true */ - readonly is_alphanumeric: boolean; + is_alphanumeric: boolean; + /** Format: date-time */ + updated_at?: string | null; }; /** * Check Dependabot security updates * @description Check Dependabot security updates */ - readonly "check-automated-security-fixes": { + "check-automated-security-fixes": { /** * @description Whether Dependabot security updates are enabled for the repository. * @example true */ - readonly enabled: boolean; + enabled: boolean; /** * @description Whether Dependabot security updates are paused for the repository. * @example false */ - readonly paused: boolean; + paused: boolean; }; /** * Protected Branch Required Status Check * @description Protected Branch Required Status Check */ - readonly "protected-branch-required-status-check": { - readonly url?: string; - readonly enforcement_level?: string; - readonly contexts: readonly string[]; - readonly checks: readonly { - readonly context: string; - readonly app_id: number | null; + "protected-branch-required-status-check": { + url?: string; + enforcement_level?: string; + contexts: string[]; + checks: { + context: string; + app_id: number | null; }[]; - readonly contexts_url?: string; - readonly strict?: boolean; + contexts_url?: string; + strict?: boolean; }; /** * Protected Branch Admin Enforced * @description Protected Branch Admin Enforced */ - readonly "protected-branch-admin-enforced": { + "protected-branch-admin-enforced": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins */ - readonly url: string; + url: string; /** @example true */ - readonly enabled: boolean; + enabled: boolean; }; /** * Protected Branch Pull Request Review * @description Protected Branch Pull Request Review */ - readonly "protected-branch-pull-request-review": { + "protected-branch-pull-request-review": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions */ - readonly url?: string; - readonly dismissal_restrictions?: { + url?: string; + dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - readonly users?: readonly components["schemas"]["simple-user"][]; + users?: components["schemas"]["simple-user"][]; /** @description The list of teams with review dismissal access. */ - readonly teams?: readonly components["schemas"]["team"][]; + teams?: components["schemas"]["team"][]; /** @description The list of apps with review dismissal access. */ - readonly apps?: readonly components["schemas"]["integration"][]; + apps?: components["schemas"]["integration"][]; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - readonly url?: string; + url?: string; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - readonly users_url?: string; + users_url?: string; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - readonly teams_url?: string; + teams_url?: string; }; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - readonly bypass_pull_request_allowances?: { + bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - readonly users?: readonly components["schemas"]["simple-user"][]; + users?: components["schemas"]["simple-user"][]; /** @description The list of teams allowed to bypass pull request requirements. */ - readonly teams?: readonly components["schemas"]["team"][]; + teams?: components["schemas"]["team"][]; /** @description The list of apps allowed to bypass pull request requirements. */ - readonly apps?: readonly components["schemas"]["integration"][]; + apps?: components["schemas"]["integration"][]; }; /** @example true */ - readonly dismiss_stale_reviews: boolean; + dismiss_stale_reviews: boolean; /** @example true */ - readonly require_code_owner_reviews: boolean; + require_code_owner_reviews: boolean; /** @example 2 */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false * @example true */ - readonly require_last_push_approval: boolean; + require_last_push_approval: boolean; }; /** * Branch Restriction Policy * @description Branch Restriction Policy */ - readonly "branch-restriction-policy": { + "branch-restriction-policy": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly users_url: string; + users_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri */ - readonly apps_url: string; - readonly users: readonly { - readonly login?: string; + apps_url: string; + users: { + login?: string; /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - readonly user_view_type?: string; - }[]; - readonly teams: readonly { - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly name?: string; - readonly slug?: string; - readonly description?: string | null; - readonly privacy?: string; - readonly notification_setting?: string; - readonly permission?: string; - readonly members_url?: string; - readonly repositories_url?: string; - readonly parent?: string | null; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + user_view_type?: string; }[]; - readonly apps: readonly { - readonly id?: number; - readonly slug?: string; - readonly node_id?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly hooks_url?: string; - readonly issues_url?: string; - readonly members_url?: string; - readonly public_members_url?: string; - readonly avatar_url?: string; - readonly description?: string; + teams: components["schemas"]["team"][]; + apps: { + id?: number; + slug?: string; + node_id?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + url?: string; + repos_url?: string; + events_url?: string; + hooks_url?: string; + issues_url?: string; + members_url?: string; + public_members_url?: string; + avatar_url?: string; + description?: string; /** @example "" */ - readonly gravatar_id?: string; + gravatar_id?: string; /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - readonly html_url?: string; + html_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - readonly followers_url?: string; + followers_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - readonly following_url?: string; + following_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - readonly gists_url?: string; + gists_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - readonly starred_url?: string; + starred_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - readonly organizations_url?: string; + organizations_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - readonly received_events_url?: string; + received_events_url?: string; /** @example "Organization" */ - readonly type?: string; + type?: string; /** @example false */ - readonly site_admin?: boolean; + site_admin?: boolean; /** @example public */ - readonly user_view_type?: string; - }; - readonly name?: string; - readonly client_id?: string; - readonly description?: string; - readonly external_url?: string; - readonly html_url?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly metadata?: string; - readonly contents?: string; - readonly issues?: string; - readonly single_file?: string; - }; - readonly events?: readonly string[]; + user_view_type?: string; + }; + name?: string; + client_id?: string; + description?: string; + external_url?: string; + html_url?: string; + created_at?: string; + updated_at?: string; + permissions?: { + metadata?: string; + contents?: string; + issues?: string; + single_file?: string; + }; + events?: string[]; }[]; }; /** * Branch Protection * @description Branch Protection */ - readonly "branch-protection": { - readonly url?: string; - readonly enabled?: boolean; - readonly required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; - readonly enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; - readonly required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; - readonly restrictions?: components["schemas"]["branch-restriction-policy"]; - readonly required_linear_history?: { - readonly enabled?: boolean; + "branch-protection": { + url?: string; + enabled?: boolean; + required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; + enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; + required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_linear_history?: { + enabled?: boolean; }; - readonly allow_force_pushes?: { - readonly enabled?: boolean; + allow_force_pushes?: { + enabled?: boolean; }; - readonly allow_deletions?: { - readonly enabled?: boolean; + allow_deletions?: { + enabled?: boolean; }; - readonly block_creations?: { - readonly enabled?: boolean; + block_creations?: { + enabled?: boolean; }; - readonly required_conversation_resolution?: { - readonly enabled?: boolean; + required_conversation_resolution?: { + enabled?: boolean; }; /** @example "branch/with/protection" */ - readonly name?: string; + name?: string; /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - readonly protection_url?: string; - readonly required_signatures?: { + protection_url?: string; + required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - readonly url: string; + url: string; /** @example true */ - readonly enabled: boolean; + enabled: boolean; }; /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ - readonly lock_branch?: { + lock_branch?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */ - readonly allow_fork_syncing?: { + allow_fork_syncing?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; }; /** * Short Branch * @description Short Branch */ - readonly "short-branch": { - readonly name: string; - readonly commit: { - readonly sha: string; + "short-branch": { + name: string; + commit: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly protected: boolean; - readonly protection?: components["schemas"]["branch-protection"]; + protected: boolean; + protection?: components["schemas"]["branch-protection"]; /** Format: uri */ - readonly protection_url?: string; + protection_url?: string; }; /** * Git User * @description Metaproperties for Git author/committer information. */ - readonly "nullable-git-user": { + "nullable-git-user": { /** @example "Chris Wanstrath" */ - readonly name?: string; + name?: string; /** @example "chris@ozmm.org" */ - readonly email?: string; - /** @example "2007-10-29T02:42:39.000-07:00" */ - readonly date?: string; + email?: string; + /** + * Format: date-time + * @example "2007-10-29T02:42:39.000-07:00" + */ + date?: string; } | null; /** Verification */ - readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly payload: string | null; - readonly signature: string | null; - readonly verified_at?: string | null; + verification: { + verified: boolean; + reason: string; + payload: string | null; + signature: string | null; + verified_at: string | null; }; /** * Diff Entry * @description Diff Entry */ - readonly "diff-entry": { + "diff-entry": { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - readonly sha: string; + sha: string | null; /** @example file1.txt */ - readonly filename: string; + filename: string; /** * @example added * @enum {string} */ - readonly status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; + status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged"; /** @example 103 */ - readonly additions: number; + additions: number; /** @example 21 */ - readonly deletions: number; + deletions: number; /** @example 124 */ - readonly changes: number; + changes: number; /** * Format: uri * @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - readonly blob_url: string; + blob_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt */ - readonly raw_url: string; + raw_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly contents_url: string; + contents_url: string; /** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */ - readonly patch?: string; + patch?: string; /** @example file.txt */ - readonly previous_filename?: string; + previous_filename?: string; }; /** * Commit * @description Commit */ - readonly commit: { + commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly url: string; + url: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly sha: string; + sha: string; /** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments */ - readonly comments_url: string; - readonly commit: { + comments_url: string; + commit: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly url: string; - readonly author: components["schemas"]["nullable-git-user"]; - readonly committer: components["schemas"]["nullable-git-user"]; + url: string; + author: components["schemas"]["nullable-git-user"]; + committer: components["schemas"]["nullable-git-user"]; /** @example Fix all the bugs */ - readonly message: string; + message: string; /** @example 0 */ - readonly comment_count: number; - readonly tree: { + comment_count: number; + tree: { /** @example 827efc6d56897b048c772eb4087f854f46256132 */ - readonly sha: string; + sha: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132 */ - readonly url: string; + url: string; }; - readonly verification?: components["schemas"]["verification"]; + verification?: components["schemas"]["verification"]; }; - readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; - readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; - readonly parents: readonly { + author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null; + parents: { /** @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly html_url?: string; + html_url?: string; }[]; - readonly stats?: { - readonly additions?: number; - readonly deletions?: number; - readonly total?: number; + stats?: { + additions?: number; + deletions?: number; + total?: number; }; - readonly files?: readonly components["schemas"]["diff-entry"][]; + files?: components["schemas"]["diff-entry"][]; }; /** * Branch With Protection * @description Branch With Protection */ - readonly "branch-with-protection": { - readonly name: string; - readonly commit: components["schemas"]["commit"]; - readonly _links: { - readonly html: string; + "branch-with-protection": { + name: string; + commit: components["schemas"]["commit"]; + _links: { + html: string; /** Format: uri */ - readonly self: string; + self: string; }; - readonly protected: boolean; - readonly protection: components["schemas"]["branch-protection"]; + protected: boolean; + protection: components["schemas"]["branch-protection"]; /** Format: uri */ - readonly protection_url: string; + protection_url: string; /** @example "mas*" */ - readonly pattern?: string; + pattern?: string; /** @example 1 */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; }; /** * Status Check Policy * @description Status Check Policy */ - readonly "status-check-policy": { + "status-check-policy": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks */ - readonly url: string; + url: string; /** @example true */ - readonly strict: boolean; + strict: boolean; /** * @example [ * "continuous-integration/travis-ci" * ] */ - readonly contexts: readonly string[]; - readonly checks: readonly { + contexts: string[]; + checks: { /** @example continuous-integration/travis-ci */ - readonly context: string; - readonly app_id: number | null; + context: string; + app_id: number | null; }[]; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts */ - readonly contexts_url: string; + contexts_url: string; }; /** * Protected Branch * @description Branch protections protect branches */ - readonly "protected-branch": { + "protected-branch": { /** Format: uri */ - readonly url: string; - readonly required_status_checks?: components["schemas"]["status-check-policy"]; - readonly required_pull_request_reviews?: { - /** Format: uri */ - readonly url: string; - readonly dismiss_stale_reviews?: boolean; - readonly require_code_owner_reviews?: boolean; - readonly required_approving_review_count?: number; + url: string; + required_status_checks?: components["schemas"]["status-check-policy"]; + required_pull_request_reviews?: { + /** Format: uri */ + url: string; + dismiss_stale_reviews?: boolean; + require_code_owner_reviews?: boolean; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. * @default false */ - readonly require_last_push_approval: boolean; - readonly dismissal_restrictions?: { + require_last_push_approval: boolean; + dismissal_restrictions?: { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly users_url: string; + users_url: string; /** Format: uri */ - readonly teams_url: string; - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - readonly apps?: readonly components["schemas"]["integration"][]; + teams_url: string; + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; + apps?: components["schemas"]["integration"][]; }; - readonly bypass_pull_request_allowances?: { - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; - readonly apps?: readonly components["schemas"]["integration"][]; + bypass_pull_request_allowances?: { + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; + apps?: components["schemas"]["integration"][]; }; }; - readonly required_signatures?: { + required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures */ - readonly url: string; + url: string; /** @example true */ - readonly enabled: boolean; + enabled: boolean; }; - readonly enforce_admins?: { + enforce_admins?: { /** Format: uri */ - readonly url: string; - readonly enabled: boolean; + url: string; + enabled: boolean; }; - readonly required_linear_history?: { - readonly enabled: boolean; + required_linear_history?: { + enabled: boolean; }; - readonly allow_force_pushes?: { - readonly enabled: boolean; + allow_force_pushes?: { + enabled: boolean; }; - readonly allow_deletions?: { - readonly enabled: boolean; + allow_deletions?: { + enabled: boolean; }; - readonly restrictions?: components["schemas"]["branch-restriction-policy"]; - readonly required_conversation_resolution?: { - readonly enabled?: boolean; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_conversation_resolution?: { + enabled?: boolean; }; - readonly block_creations?: { - readonly enabled: boolean; + block_creations?: { + enabled: boolean; }; /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ - readonly lock_branch?: { + lock_branch?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */ - readonly allow_fork_syncing?: { + allow_fork_syncing?: { /** @default false */ - readonly enabled: boolean; + enabled: boolean; }; }; /** * Deployment * @description A deployment created as the result of an Actions check run from a workflow that references an environment */ - readonly "deployment-simple": { + "deployment-simple": { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1 */ - readonly url: string; + url: string; /** * @description Unique identifier of the deployment * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOkRlcGxveW1lbnQx */ - readonly node_id: string; + node_id: string; /** * @description Parameter to specify a task to execute * @example deploy */ - readonly task: string; + task: string; /** @example staging */ - readonly original_environment?: string; + original_environment?: string; /** * @description Name for the target deployment environment. * @example production */ - readonly environment: string; + environment: string; /** @example Deploy request from hubot */ - readonly description: string | null; + description: string | null; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/1/statuses */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; /** * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. * @example true */ - readonly transient_environment?: boolean; + transient_environment?: boolean; /** * @description Specifies if the given environment is one that end-users directly interact with. Default: false. * @example true */ - readonly production_environment?: boolean; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * CheckRun * @description A check performed on the code of a given code change */ - readonly "check-run": { + "check-run": { /** * Format: int64 * @description The id of the check. * @example 21 */ - readonly id: number; + id: number; /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; + node_id: string; /** @example 42 */ - readonly external_id: string | null; + external_id: string | null; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string | null; + html_url: string | null; /** @example https://example.com */ - readonly details_url: string | null; + details_url: string | null; /** * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly started_at: string | null; + started_at: string | null; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly completed_at: string | null; - readonly output: { - readonly title: string | null; - readonly summary: string | null; - readonly text: string | null; - readonly annotations_count: number; + completed_at: string | null; + output: { + title: string | null; + summary: string | null; + text: string | null; + annotations_count: number; /** Format: uri */ - readonly annotations_url: string; + annotations_url: string; }; /** * @description The name of the check. * @example test-coverage */ - readonly name: string; - readonly check_suite: { - readonly id: number; + name: string; + check_suite: { + id: number; } | null; - readonly app: components["schemas"]["nullable-integration"]; + app: components["schemas"]["nullable-integration"]; /** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. */ - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; - readonly deployment?: components["schemas"]["deployment-simple"]; + pull_requests: components["schemas"]["pull-request-minimal"][]; + deployment?: components["schemas"]["deployment-simple"]; }; /** * Check Annotation * @description Check Annotation */ - readonly "check-annotation": { + "check-annotation": { /** @example README.md */ - readonly path: string; + path: string; /** @example 2 */ - readonly start_line: number; + start_line: number; /** @example 2 */ - readonly end_line: number; + end_line: number; /** @example 5 */ - readonly start_column: number | null; + start_column: number | null; /** @example 10 */ - readonly end_column: number | null; + end_column: number | null; /** @example warning */ - readonly annotation_level: string | null; + annotation_level: string | null; /** @example Spell Checker */ - readonly title: string | null; + title: string | null; /** @example Check your spelling for 'banaas'. */ - readonly message: string | null; + message: string | null; /** @example Do you mean 'bananas' or 'banana'? */ - readonly raw_details: string | null; - readonly blob_href: string; + raw_details: string | null; + blob_href: string; }; /** * Simple Commit * @description A commit. */ - readonly "simple-commit": { + "simple-commit": { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly id: string; + id: string; /** @description SHA for the commit's tree */ - readonly tree_id: string; + tree_id: string; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; + message: string; /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly timestamp: string; + timestamp: string; /** @description Information about the Git author */ - readonly author: { + author: { /** * @description Name of the commit's author * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's author * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; /** @description Information about the Git committer */ - readonly committer: { + committer: { /** * @description Name of the commit's committer * @example Monalisa Octocat */ - readonly name: string; + name: string; /** * Format: email * @description Git email address of the commit's committer * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; } | null; }; /** * CheckSuite * @description A suite of checks performed on the code of a given code change */ - readonly "check-suite": { + "check-suite": { /** * Format: int64 * @example 5 */ - readonly id: number; + id: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id: string; + node_id: string; /** @example master */ - readonly head_branch: string | null; + head_branch: string | null; /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** * @example neutral * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - readonly url: string | null; + url: string | null; /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - readonly before: string | null; + before: string | null; /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - readonly after: string | null; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null; - readonly app: components["schemas"]["nullable-integration"]; - readonly repository: components["schemas"]["minimal-repository"]; + after: string | null; + pull_requests: components["schemas"]["pull-request-minimal"][] | null; + app: components["schemas"]["nullable-integration"]; + repository: components["schemas"]["minimal-repository"]; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: date-time */ - readonly updated_at: string | null; - readonly head_commit: components["schemas"]["simple-commit"]; - readonly latest_check_runs_count: number; - readonly check_runs_url: string; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + updated_at: string | null; + head_commit: components["schemas"]["simple-commit"]; + latest_check_runs_count: number; + check_runs_url: string; + rerequestable?: boolean; + runs_rerequestable?: boolean; }; /** * Check Suite Preference * @description Check suite configuration preferences for a repository. */ - readonly "check-suite-preference": { - readonly preferences: { - readonly auto_trigger_checks?: readonly { - readonly app_id: number; - readonly setting: boolean; + "check-suite-preference": { + preferences: { + auto_trigger_checks?: { + app_id: number; + setting: boolean; }[]; }; - readonly repository: components["schemas"]["minimal-repository"]; - }; - readonly "code-scanning-alert-items": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; - }; - readonly "code-scanning-alert-rule": { + repository: components["schemas"]["minimal-repository"]; + }; + "code-scanning-alert-items": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["alert-updated-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + fixed_at?: components["schemas"]["alert-fixed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + }; + "code-scanning-alert-rule": { /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; + id?: string | null; /** @description The name of the rule used to detect the alert. */ - readonly name?: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity?: "none" | "note" | "warning" | "error" | null; + severity?: "none" | "note" | "warning" | "error" | null; /** * @description The security severity of the alert. * @enum {string|null} */ - readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null; + security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; + description?: string; /** @description A description of the rule used to detect the alert. */ - readonly full_description?: string; + full_description?: string; /** @description A set of tags applicable for the rule. */ - readonly tags?: readonly string[] | null; + tags?: string[] | null; /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - }; - readonly "code-scanning-alert": { - readonly number: components["schemas"]["alert-number"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["alert-updated-at"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly instances_url: components["schemas"]["alert-instances-url"]; - readonly state: components["schemas"]["code-scanning-alert-state"]; - readonly fixed_at?: components["schemas"]["alert-fixed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + help_uri?: string | null; + }; + "code-scanning-alert": { + number: components["schemas"]["alert-number"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["alert-updated-at"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + instances_url: components["schemas"]["alert-instances-url"]; + state: components["schemas"]["code-scanning-alert-state"]; + fixed_at?: components["schemas"]["alert-fixed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + rule: components["schemas"]["code-scanning-alert-rule"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ - readonly "code-scanning-alert-set-state": "open" | "dismissed"; + "code-scanning-alert-set-state": "open" | "dismissed"; + /** @description If `true`, attempt to create an alert dismissal request. */ + "code-scanning-alert-create-request": boolean; + /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */ + "code-scanning-alert-assignees": string[]; /** * @description The status of an autofix. * @enum {string} */ - readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; + "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated"; /** @description The description of an autofix. */ - readonly "code-scanning-autofix-description": string | null; + "code-scanning-autofix-description": string | null; /** * Format: date-time * @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-autofix-started-at": string; - readonly "code-scanning-autofix": { - readonly status: components["schemas"]["code-scanning-autofix-status"]; - readonly description: components["schemas"]["code-scanning-autofix-description"]; - readonly started_at: components["schemas"]["code-scanning-autofix-started-at"]; + "code-scanning-autofix-started-at": string; + "code-scanning-autofix": { + status: components["schemas"]["code-scanning-autofix-status"]; + description: components["schemas"]["code-scanning-autofix-description"]; + started_at: components["schemas"]["code-scanning-autofix-started-at"]; }; /** @description Commit an autofix for a code scanning alert */ - readonly "code-scanning-autofix-commits": { + "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly target_ref?: string; + target_ref?: string; /** @description Commit message to be used. */ - readonly message?: string; + message?: string; } | null; - readonly "code-scanning-autofix-commits-response": { + "code-scanning-autofix-commits-response": { /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly target_ref?: string; + target_ref?: string; /** @description SHA of commit with autofix. */ - readonly sha?: string; + sha?: string; + }; + /** + * @description State of a code scanning alert instance. + * @enum {string|null} + */ + "code-scanning-alert-instance-state": "open" | "fixed" | null; + "code-scanning-alert-instance-list": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-instance-state"]; + commit_sha?: string; + message?: { + text?: string; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 */ - readonly "code-scanning-analysis-sarif-id": string; + "code-scanning-analysis-sarif-id": string; /** @description The SHA of the commit to which the analysis you are uploading relates. */ - readonly "code-scanning-analysis-commit-sha": string; + "code-scanning-analysis-commit-sha": string; /** @description Identifies the variable values associated with the environment in which this analysis was performed. */ - readonly "code-scanning-analysis-environment": string; + "code-scanning-analysis-environment": string; /** * Format: date-time * @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "code-scanning-analysis-created-at": string; + "code-scanning-analysis-created-at": string; /** * Format: uri * @description The REST API URL of the analysis resource. */ - readonly "code-scanning-analysis-url": string; - readonly "code-scanning-analysis": { - readonly ref: components["schemas"]["code-scanning-ref"]; - readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - readonly environment: components["schemas"]["code-scanning-analysis-environment"]; - readonly category?: components["schemas"]["code-scanning-analysis-category"]; + "code-scanning-analysis-url": string; + "code-scanning-analysis": { + ref: components["schemas"]["code-scanning-ref"]; + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment: components["schemas"]["code-scanning-analysis-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; /** @example error reading field xyz */ - readonly error: string; - readonly created_at: components["schemas"]["code-scanning-analysis-created-at"]; + error: string; + created_at: components["schemas"]["code-scanning-analysis-created-at"]; /** @description The total number of results in the analysis. */ - readonly results_count: number; + results_count: number; /** @description The total number of rules used in the analysis. */ - readonly rules_count: number; + rules_count: number; /** @description Unique identifier for this analysis. */ - readonly id: number; - readonly url: components["schemas"]["code-scanning-analysis-url"]; - readonly sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; - readonly tool: components["schemas"]["code-scanning-analysis-tool"]; - readonly deletable: boolean; + id: number; + url: components["schemas"]["code-scanning-analysis-url"]; + sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"]; + tool: components["schemas"]["code-scanning-analysis-tool"]; + deletable: boolean; /** * @description Warning generated when processing the analysis * @example 123 results were ignored */ - readonly warning: string; + warning: string; }; /** * Analysis deletion * @description Successful deletion of a code scanning analysis */ - readonly "code-scanning-analysis-deletion": { + "code-scanning-analysis-deletion": { /** * Format: uri * @description Next deletable analysis in chain, without last analysis deletion confirmation @@ -29243,304 +32348,314 @@ export interface components { * CodeQL Database * @description A CodeQL database. */ - readonly "code-scanning-codeql-database": { + "code-scanning-codeql-database": { /** @description The ID of the CodeQL database. */ - readonly id: number; + id: number; /** @description The name of the CodeQL database. */ - readonly name: string; + name: string; /** @description The language of the CodeQL database. */ - readonly language: string; - readonly uploader: components["schemas"]["simple-user"]; + language: string; + uploader: components["schemas"]["simple-user"]; /** @description The MIME type of the CodeQL database file. */ - readonly content_type: string; + content_type: string; /** @description The size of the CodeQL database file in bytes. */ - readonly size: number; + size: number; /** * Format: date-time * @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ - readonly url: string; + url: string; /** @description The commit SHA of the repository at the time the CodeQL database was created. */ - readonly commit_oid?: string | null; + commit_oid?: string | null; }; /** * @description The language targeted by the CodeQL query * @enum {string} */ - readonly "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift"; + "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift"; /** * Repository Identifier * @description Repository Identifier */ - readonly "code-scanning-variant-analysis-repository": { + "code-scanning-variant-analysis-repository": { /** * @description A unique identifier of the repository. * @example 1296269 */ - readonly id: number; + id: number; /** * @description The name of the repository. * @example Hello-World */ - readonly name: string; + name: string; /** * @description The full, globally unique, name of the repository. * @example octocat/Hello-World */ - readonly full_name: string; + full_name: string; /** @description Whether the repository is private. */ - readonly private: boolean; + private: boolean; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; }; /** * @description The new status of the CodeQL variant analysis repository task. * @enum {string} */ - readonly "code-scanning-variant-analysis-status": "pending" | "in_progress" | "succeeded" | "failed" | "canceled" | "timed_out"; - readonly "code-scanning-variant-analysis-skipped-repo-group": { + "code-scanning-variant-analysis-status": "pending" | "in_progress" | "succeeded" | "failed" | "canceled" | "timed_out"; + "code-scanning-variant-analysis-skipped-repo-group": { /** * @description The total number of repositories that were skipped for this reason. * @example 2 */ - readonly repository_count: number; + repository_count: number; /** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */ - readonly repositories: readonly components["schemas"]["code-scanning-variant-analysis-repository"][]; + repositories: components["schemas"]["code-scanning-variant-analysis-repository"][]; }; /** * Variant Analysis * @description A run of a CodeQL query against one or more repositories. */ - readonly "code-scanning-variant-analysis": { + "code-scanning-variant-analysis": { /** @description The ID of the variant analysis. */ - readonly id: number; - readonly controller_repo: components["schemas"]["simple-repository"]; - readonly actor: components["schemas"]["simple-user"]; - readonly query_language: components["schemas"]["code-scanning-variant-analysis-language"]; + id: number; + controller_repo: components["schemas"]["simple-repository"]; + actor: components["schemas"]["simple-user"]; + query_language: components["schemas"]["code-scanning-variant-analysis-language"]; /** @description The download url for the query pack. */ - readonly query_pack_url: string; + query_pack_url: string; /** * Format: date-time * @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at?: string; + created_at?: string; /** * Format: date-time * @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at?: string; + updated_at?: string; /** * Format: date-time * @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available. */ - readonly completed_at?: string | null; + completed_at?: string | null; /** @enum {string} */ - readonly status: "in_progress" | "succeeded" | "failed" | "cancelled"; + status: "in_progress" | "succeeded" | "failed" | "cancelled"; /** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */ - readonly actions_workflow_run_id?: number; + actions_workflow_run_id?: number; /** * @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed. * @enum {string} */ - readonly failure_reason?: "no_repos_queried" | "actions_workflow_run_failed" | "internal_error"; - readonly scanned_repositories?: readonly { - readonly repository: components["schemas"]["code-scanning-variant-analysis-repository"]; - readonly analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + failure_reason?: "no_repos_queried" | "actions_workflow_run_failed" | "internal_error"; + scanned_repositories?: { + repository: components["schemas"]["code-scanning-variant-analysis-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ - readonly result_count?: number; + result_count?: number; /** @description The size of the artifact. This is only available for successful analyses. */ - readonly artifact_size_in_bytes?: number; + artifact_size_in_bytes?: number; /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ - readonly failure_message?: string; + failure_message?: string; }[]; /** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */ - readonly skipped_repositories?: { - readonly access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; - readonly not_found_repos: { + skipped_repositories?: { + access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + not_found_repos: { /** * @description The total number of repositories that were skipped for this reason. * @example 2 */ - readonly repository_count: number; + repository_count: number; /** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */ - readonly repository_full_names: readonly string[]; + repository_full_names: string[]; }; - readonly no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; - readonly over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; + over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"]; }; }; - readonly "code-scanning-variant-analysis-repo-task": { - readonly repository: components["schemas"]["simple-repository"]; - readonly analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; + "code-scanning-variant-analysis-repo-task": { + repository: components["schemas"]["simple-repository"]; + analysis_status: components["schemas"]["code-scanning-variant-analysis-status"]; /** @description The size of the artifact. This is only available for successful analyses. */ - readonly artifact_size_in_bytes?: number; + artifact_size_in_bytes?: number; /** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */ - readonly result_count?: number; + result_count?: number; /** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */ - readonly failure_message?: string; + failure_message?: string; /** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */ - readonly database_commit_sha?: string; + database_commit_sha?: string; /** @description The source location prefix to use. This is only available for successful analyses. */ - readonly source_location_prefix?: string; + source_location_prefix?: string; /** @description The URL of the artifact. This is only available for successful analyses. */ - readonly artifact_url?: string; + artifact_url?: string; }; /** @description Configuration for code scanning default setup. */ - readonly "code-scanning-default-setup": { + "code-scanning-default-setup": { /** * @description Code scanning default setup has been configured or not. * @enum {string} */ - readonly state?: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description Runner type to be used. * @enum {string|null} */ - readonly runner_type?: "standard" | "labeled" | null; + runner_type?: "standard" | "labeled" | null; /** * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ - readonly runner_label?: string | null; + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ - readonly query_suite?: "default" | "extended"; + query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** * Format: date-time * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z */ - readonly updated_at?: string | null; + updated_at?: string | null; /** * @description The frequency of the periodic analysis. * @enum {string|null} */ - readonly schedule?: "weekly" | null; + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ - readonly "code-scanning-default-setup-update": { + "code-scanning-default-setup-update": { /** * @description The desired state of code scanning default setup. * @enum {string} */ - readonly state?: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description Runner type to be used. * @enum {string} */ - readonly runner_type?: "standard" | "labeled"; + runner_type?: "standard" | "labeled"; /** * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ - readonly runner_label?: string | null; + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ - readonly query_suite?: "default" | "extended"; + query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** @description CodeQL languages to be analyzed. */ - readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. * You should not rely on this always being an actions workflow run object. */ - readonly "code-scanning-default-setup-update-response": { + "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ - readonly run_id?: number; + run_id?: number; /** @description URL of the corresponding run. */ - readonly run_url?: string; + run_url?: string; }; /** * @description The full Git reference, formatted as `refs/heads/`, * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ - readonly "code-scanning-ref-full": string; + "code-scanning-ref-full": string; /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ - readonly "code-scanning-analysis-sarif-file": string; - readonly "code-scanning-sarifs-receipt": { - readonly id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + "code-scanning-analysis-sarif-file": string; + "code-scanning-sarifs-receipt": { + id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** * Format: uri * @description The REST API URL for checking the status of the upload. */ readonly url?: string; }; - readonly "code-scanning-sarifs-status": { + "code-scanning-sarifs-status": { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - readonly processing_status?: "pending" | "complete" | "failed"; + processing_status?: "pending" | "complete" | "failed"; /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - readonly errors?: readonly string[] | null; + readonly errors?: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ - readonly "code-security-configuration-for-repository": { + "code-security-configuration-for-repository": { /** * @description The attachment status of the code security configuration on the repository. * @enum {string} */ - readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; }; /** * CODEOWNERS errors * @description A list of errors found in a repo's CODEOWNERS file */ - readonly "codeowners-errors": { - readonly errors: readonly { + "codeowners-errors": { + errors: { /** * @description The line number where this errors occurs. * @example 7 */ - readonly line: number; + line: number; /** * @description The column number where this errors occurs. * @example 3 */ - readonly column: number; + column: number; /** * @description The contents of the line where the error occurs. * @example * user */ - readonly source?: string; + source?: string; /** * @description The type of error. * @example Invalid owner */ - readonly kind: string; + kind: string; /** * @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors. * @example The pattern `/` will never match anything, did you mean `*` instead? */ - readonly suggestion?: string | null; + suggestion?: string | null; /** * @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting). * @example Invalid owner on line 7: @@ -29548,891 +32663,750 @@ export interface components { * * user * ^ */ - readonly message: string; + message: string; /** * @description The path of the file where the error occured. * @example .github/CODEOWNERS */ - readonly path: string; + path: string; }[]; }; /** * Codespace machine * @description A description of the machine powering a codespace. */ - readonly "codespace-machine": { + "codespace-machine": { /** * @description The name of the machine. * @example standardLinux */ - readonly name: string; + name: string; /** * @description The display name of the machine includes cores, memory, and storage. * @example 4 cores, 16 GB RAM, 64 GB storage */ - readonly display_name: string; + display_name: string; /** * @description The operating system of the machine. * @example linux */ - readonly operating_system: string; + operating_system: string; /** * @description How much storage is available to the codespace. * @example 68719476736 */ - readonly storage_in_bytes: number; + storage_in_bytes: number; /** * @description How much memory is available to the codespace. * @example 17179869184 */ - readonly memory_in_bytes: number; + memory_in_bytes: number; /** * @description How many cores are available to the codespace. * @example 4 */ - readonly cpus: number; + cpus: number; /** * @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status. * @example ready * @enum {string|null} */ - readonly prebuild_availability: "none" | "ready" | "in_progress" | null; + prebuild_availability: "none" | "ready" | "in_progress" | null; }; /** * Codespaces Permissions Check * @description Permission check result for a given devcontainer config. */ - readonly "codespaces-permissions-check-for-devcontainer": { + "codespaces-permissions-check-for-devcontainer": { /** * @description Whether the user has accepted the permissions defined by the devcontainer config * @example true */ - readonly accepted: boolean; + accepted: boolean; }; /** * Codespaces Secret * @description Set repository secrets for GitHub Codespaces. */ - readonly "repo-codespaces-secret": { + "repo-codespaces-secret": { /** * @description The name of the secret. * @example SECRET_TOKEN */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Collaborator * @description Collaborator */ - readonly collaborator: { + collaborator: { /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; - readonly email?: string | null; - readonly name?: string | null; + id: number; + email?: string | null; + name?: string | null; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; - readonly permissions?: { - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - readonly admin: boolean; + type: string; + site_admin: boolean; + permissions?: { + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + admin: boolean; }; /** @example admin */ - readonly role_name: string; + role_name: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; }; /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - readonly "repository-invitation": { + "repository-invitation": { /** * Format: int64 * @description Unique identifier of the repository invitation. * @example 42 */ - readonly id: number; - readonly repository: components["schemas"]["minimal-repository"]; - readonly invitee: components["schemas"]["nullable-simple-user"]; - readonly inviter: components["schemas"]["nullable-simple-user"]; + id: number; + repository: components["schemas"]["minimal-repository"]; + invitee: components["schemas"]["nullable-simple-user"]; + inviter: components["schemas"]["nullable-simple-user"]; /** * @description The permission associated with the invitation. * @example read * @enum {string} */ - readonly permissions: "read" | "write" | "admin" | "triage" | "maintain"; + permissions: "read" | "write" | "admin" | "triage" | "maintain"; /** * Format: date-time * @example 2016-06-13T14:52:50-05:00 */ - readonly created_at: string; + created_at: string; /** @description Whether or not the invitation has expired */ - readonly expired?: boolean; + expired?: boolean; /** * @description URL for the repository invitation * @example https://api.github.com/user/repository-invitations/1 */ - readonly url: string; + url: string; /** @example https://github.com/octocat/Hello-World/invitations */ - readonly html_url: string; - readonly node_id: string; + html_url: string; + node_id: string; }; /** * Collaborator * @description Collaborator */ - readonly "nullable-collaborator": { + "nullable-collaborator": { /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; - readonly email?: string | null; - readonly name?: string | null; + id: number; + email?: string | null; + name?: string | null; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; - readonly permissions?: { - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - readonly admin: boolean; + type: string; + site_admin: boolean; + permissions?: { + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + admin: boolean; }; /** @example admin */ - readonly role_name: string; + role_name: string; /** @example public */ - readonly user_view_type?: string; + user_view_type?: string; } | null; /** * Repository Collaborator Permission * @description Repository Collaborator Permission */ - readonly "repository-collaborator-permission": { - readonly permission: string; + "repository-collaborator-permission": { + permission: string; /** @example admin */ - readonly role_name: string; - readonly user: components["schemas"]["nullable-collaborator"]; + role_name: string; + user: components["schemas"]["nullable-collaborator"]; }; /** * Commit Comment * @description Commit Comment */ - readonly "commit-comment": { + "commit-comment": { /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly url: string; - readonly id: number; - readonly node_id: string; - readonly body: string; - readonly path: string | null; - readonly position: number | null; - readonly line: number | null; - readonly commit_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + url: string; + id: number; + node_id: string; + body: string; + path: string | null; + position: number | null; + line: number | null; + commit_id: string; + user: components["schemas"]["nullable-simple-user"]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly author_association: components["schemas"]["author-association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Branch Short - * @description Branch Short - */ - readonly "branch-short": { - readonly name: string; - readonly commit: { - readonly sha: string; - readonly url: string; - }; - readonly protected: boolean; + updated_at: string; + author_association: components["schemas"]["author-association"]; + reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Link - * @description Hypermedia Link - */ - readonly link: { - readonly href: string; - }; - /** - * Auto merge - * @description The status of auto merging a pull request. + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - readonly "auto-merge": { - readonly enabled_by: components["schemas"]["simple-user"]; + reaction: { + /** @example 1 */ + id: number; + /** @example MDg6UmVhY3Rpb24x */ + node_id: string; + user: components["schemas"]["nullable-simple-user"]; /** - * @description The merge method to use. + * @description The reaction to use + * @example heart * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; - /** @description Title for the merge commit message. */ - readonly commit_title: string; - /** @description Commit message for the merge commit. */ - readonly commit_message: string; - } | null; - /** - * Pull Request Simple - * @description Pull Request Simple - */ - readonly "pull-request-simple": { - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 - */ - readonly url: string; - /** - * Format: int64 - * @example 1 - */ - readonly id: number; - /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347 - */ - readonly html_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.diff - */ - readonly diff_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.patch - */ - readonly patch_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - readonly issue_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - */ - readonly commits_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - */ - readonly review_comments_url: string; - /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - readonly review_comment_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - */ - readonly comments_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - */ - readonly statuses_url: string; - /** @example 1347 */ - readonly number: number; - /** @example open */ - readonly state: string; - /** @example true */ - readonly locked: boolean; - /** @example new-feature */ - readonly title: string; - readonly user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ - readonly body: string | null; - readonly labels: readonly { - /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly name: string; - readonly description: string; - readonly color: string; - readonly default: boolean; - }[]; - readonly milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ - readonly active_lock_reason?: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly updated_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly closed_at: string | null; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - readonly merge_commit_sha: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_teams?: readonly components["schemas"]["team"][] | null; - readonly head: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; - readonly base: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["nullable-simple-user"]; - }; - readonly _links: { - readonly comments: components["schemas"]["link"]; - readonly commits: components["schemas"]["link"]; - readonly statuses: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly issue: components["schemas"]["link"]; - readonly review_comments: components["schemas"]["link"]; - readonly review_comment: components["schemas"]["link"]; - readonly self: components["schemas"]["link"]; - }; - readonly author_association: components["schemas"]["author-association"]; - readonly auto_merge: components["schemas"]["auto-merge"]; - /** - * @description Indicates whether or not the pull request is a draft. - * @example false + * @example 2016-05-20T20:09:31Z */ - readonly draft?: boolean; + created_at: string; + }; + /** + * Branch Short + * @description Branch Short + */ + "branch-short": { + name: string; + commit: { + sha: string; + url: string; + }; + protected: boolean; }; /** Simple Commit Status */ - readonly "simple-commit-status": { - readonly description: string | null; - readonly id: number; - readonly node_id: string; - readonly state: string; - readonly context: string; + "simple-commit-status": { + description: string | null; + id: number; + node_id: string; + state: string; + context: string; /** Format: uri */ - readonly target_url: string | null; - readonly required?: boolean | null; + target_url: string | null; + required?: boolean | null; /** Format: uri */ - readonly avatar_url: string | null; + avatar_url: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Combined Commit Status * @description Combined Commit Status */ - readonly "combined-commit-status": { - readonly state: string; - readonly statuses: readonly components["schemas"]["simple-commit-status"][]; - readonly sha: string; - readonly total_count: number; - readonly repository: components["schemas"]["minimal-repository"]; + "combined-commit-status": { + state: string; + statuses: components["schemas"]["simple-commit-status"][]; + sha: string; + total_count: number; + repository: components["schemas"]["minimal-repository"]; /** Format: uri */ - readonly commit_url: string; + commit_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Status * @description The status of a commit. */ - readonly status: { - readonly url: string; - readonly avatar_url: string | null; - readonly id: number; - readonly node_id: string; - readonly state: string; - readonly description: string | null; - readonly target_url: string | null; - readonly context: string; - readonly created_at: string; - readonly updated_at: string; - readonly creator: components["schemas"]["nullable-simple-user"]; + status: { + url: string; + avatar_url: string | null; + id: number; + node_id: string; + state: string; + description: string | null; + target_url: string | null; + context: string; + created_at: string; + updated_at: string; + creator: components["schemas"]["nullable-simple-user"]; }; /** * Code Of Conduct Simple * @description Code of Conduct Simple */ - readonly "nullable-code-of-conduct-simple": { + "nullable-code-of-conduct-simple": { /** * Format: uri * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly url: string; + url: string; /** @example citizen_code_of_conduct */ - readonly key: string; + key: string; /** @example Citizen Code of Conduct */ - readonly name: string; + name: string; /** * Format: uri * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly html_url: string | null; + html_url: string | null; } | null; /** Community Health File */ - readonly "nullable-community-health-file": { + "nullable-community-health-file": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; } | null; /** * Community Profile * @description Community Profile */ - readonly "community-profile": { + "community-profile": { /** @example 100 */ - readonly health_percentage: number; + health_percentage: number; /** @example My first repository on GitHub! */ - readonly description: string | null; + description: string | null; /** @example example.com */ - readonly documentation: string | null; - readonly files: { - readonly code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; - readonly code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly contributing: components["schemas"]["nullable-community-health-file"]; - readonly readme: components["schemas"]["nullable-community-health-file"]; - readonly issue_template: components["schemas"]["nullable-community-health-file"]; - readonly pull_request_template: components["schemas"]["nullable-community-health-file"]; + documentation: string | null; + files: { + code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"]; + code_of_conduct_file: components["schemas"]["nullable-community-health-file"]; + license: components["schemas"]["nullable-license-simple"]; + contributing: components["schemas"]["nullable-community-health-file"]; + readme: components["schemas"]["nullable-community-health-file"]; + issue_template: components["schemas"]["nullable-community-health-file"]; + pull_request_template: components["schemas"]["nullable-community-health-file"]; }; /** * Format: date-time * @example 2017-02-28T19:09:29Z */ - readonly updated_at: string | null; + updated_at: string | null; /** @example true */ - readonly content_reports_enabled?: boolean; + content_reports_enabled?: boolean; }; /** * Commit Comparison * @description Commit Comparison */ - readonly "commit-comparison": { + "commit-comparison": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 */ - readonly permalink_url: string; + permalink_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.diff */ - readonly diff_url: string; + diff_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/compare/master...topic.patch */ - readonly patch_url: string; - readonly base_commit: components["schemas"]["commit"]; - readonly merge_base_commit: components["schemas"]["commit"]; + patch_url: string; + base_commit: components["schemas"]["commit"]; + merge_base_commit: components["schemas"]["commit"]; /** * @example ahead * @enum {string} */ - readonly status: "diverged" | "ahead" | "behind" | "identical"; + status: "diverged" | "ahead" | "behind" | "identical"; /** @example 4 */ - readonly ahead_by: number; + ahead_by: number; /** @example 5 */ - readonly behind_by: number; + behind_by: number; /** @example 6 */ - readonly total_commits: number; - readonly commits: readonly components["schemas"]["commit"][]; - readonly files?: readonly components["schemas"]["diff-entry"][]; + total_commits: number; + commits: components["schemas"]["commit"][]; + files?: components["schemas"]["diff-entry"][]; }; /** * Content Tree * @description Content Tree */ - readonly "content-tree": { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; - readonly content?: string; + "content-tree": { + type: string; + size: number; + name: string; + path: string; + sha: string; + content?: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly entries?: readonly { - readonly type: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + download_url: string | null; + entries?: { + type: string; + size: number; + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }[]; - readonly _links: { + encoding?: string; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }; /** * Content Directory * @description A list of directory items */ - readonly "content-directory": readonly { + "content-directory": { /** @enum {string} */ - readonly type: "dir" | "file" | "submodule" | "symlink"; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content?: string; - readonly sha: string; + type: "dir" | "file" | "submodule" | "symlink"; + size: number; + name: string; + path: string; + content?: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }[]; /** * Content File * @description Content File */ - readonly "content-file": { + "content-file": { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly type: "file"; - readonly encoding: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly content: string; - readonly sha: string; + type: "file"; + encoding: string; + size: number; + name: string; + path: string; + content: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; /** @example "actual/actual.md" */ - readonly target?: string; + target?: string; /** @example "git://example.com/defunkt/dotjs.git" */ - readonly submodule_git_url?: string; + submodule_git_url?: string; }; /** * Symlink Content * @description An object describing a symlink */ - readonly "content-symlink": { + "content-symlink": { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly type: "symlink"; - readonly target: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + type: "symlink"; + target: string; + size: number; + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }; /** * Submodule Content * @description An object describing a submodule */ - readonly "content-submodule": { + "content-submodule": { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly type: "submodule"; + type: "submodule"; /** Format: uri */ - readonly submodule_git_url: string; - readonly size: number; - readonly name: string; - readonly path: string; - readonly sha: string; + submodule_git_url: string; + size: number; + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly _links: { + download_url: string | null; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; }; /** * File Commit * @description File Commit */ - readonly "file-commit": { - readonly content: { - readonly name?: string; - readonly path?: string; - readonly sha?: string; - readonly size?: number; - readonly url?: string; - readonly html_url?: string; - readonly git_url?: string; - readonly download_url?: string; - readonly type?: string; - readonly _links?: { - readonly self?: string; - readonly git?: string; - readonly html?: string; + "file-commit": { + content: { + name?: string; + path?: string; + sha?: string; + size?: number; + url?: string; + html_url?: string; + git_url?: string; + download_url?: string; + type?: string; + _links?: { + self?: string; + git?: string; + html?: string; }; } | null; - readonly commit: { - readonly sha?: string; - readonly node_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly author?: { - readonly date?: string; - readonly name?: string; - readonly email?: string; - }; - readonly committer?: { - readonly date?: string; - readonly name?: string; - readonly email?: string; - }; - readonly message?: string; - readonly tree?: { - readonly url?: string; - readonly sha?: string; - }; - readonly parents?: readonly { - readonly url?: string; - readonly html_url?: string; - readonly sha?: string; + commit: { + sha?: string; + node_id?: string; + url?: string; + html_url?: string; + author?: { + date?: string; + name?: string; + email?: string; + }; + committer?: { + date?: string; + name?: string; + email?: string; + }; + message?: string; + tree?: { + url?: string; + sha?: string; + }; + parents?: { + url?: string; + html_url?: string; + sha?: string; }[]; - readonly verification?: { - readonly verified?: boolean; - readonly reason?: string; - readonly signature?: string | null; - readonly payload?: string | null; - readonly verified_at?: string | null; + verification?: { + verified?: boolean; + reason?: string; + signature?: string | null; + payload?: string | null; + verified_at?: string | null; }; }; }; /** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */ - readonly "secret-scanning-push-protection-bypass-placeholder-id": string; + "secret-scanning-push-protection-bypass-placeholder-id": string; /** @description Repository rule violation was detected */ - readonly "repository-rule-violation-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly status?: string; - readonly metadata?: { - readonly secret_scanning?: { - readonly bypass_placeholders?: readonly { - readonly placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; - readonly token_type?: string; + "repository-rule-violation-error": { + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; }[]; }; }; @@ -30441,41 +33415,41 @@ export interface components { * Contributor * @description Contributor */ - readonly contributor: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; + contributor: { + login?: string; + id?: number; + node_id?: string; /** Format: uri */ - readonly avatar_url?: string; - readonly gravatar_id?: string | null; + avatar_url?: string; + gravatar_id?: string | null; /** Format: uri */ - readonly url?: string; + url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: uri */ - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly events_url?: string; + repos_url?: string; + events_url?: string; /** Format: uri */ - readonly received_events_url?: string; - readonly type: string; - readonly site_admin?: boolean; - readonly contributions: number; - readonly email?: string; - readonly name?: string; - readonly user_view_type?: string; + received_events_url?: string; + type: string; + site_admin?: boolean; + contributions: number; + email?: string; + name?: string; + user_view_type?: string; }; /** @description A Dependabot alert. */ - readonly "dependabot-alert": { - readonly number: components["schemas"]["alert-number"]; + "dependabot-alert": { + number: components["schemas"]["alert-number"]; /** * @description The state of the Dependabot alert. * @enum {string} @@ -30483,7 +33457,7 @@ export interface components { readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ readonly dependency: { - readonly package?: components["schemas"]["dependabot-alert-package"]; + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ readonly manifest_path?: string; /** @@ -30491,200 +33465,211 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; - readonly security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; - readonly security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; - readonly url: components["schemas"]["alert-url"]; - readonly html_url: components["schemas"]["alert-html-url"]; - readonly created_at: components["schemas"]["alert-created-at"]; - readonly updated_at: components["schemas"]["alert-updated-at"]; - readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; - readonly dismissed_by: components["schemas"]["nullable-simple-user"]; + security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; + security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; + url: components["schemas"]["alert-url"]; + html_url: components["schemas"]["alert-html-url"]; + created_at: components["schemas"]["alert-created-at"]; + updated_at: components["schemas"]["alert-updated-at"]; + dismissed_at: components["schemas"]["alert-dismissed-at"]; + dismissed_by: components["schemas"]["nullable-simple-user"]; /** * @description The reason that the alert was dismissed. * @enum {string|null} */ - readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; + dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null; /** @description An optional comment associated with the alert's dismissal. */ - readonly dismissed_comment: string | null; - readonly fixed_at: components["schemas"]["alert-fixed-at"]; - readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissed_comment: string | null; + fixed_at: components["schemas"]["alert-fixed-at"]; + auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; }; /** * Dependabot Secret * @description Set secrets for Dependabot. */ - readonly "dependabot-secret": { + "dependabot-secret": { /** * @description The name of the secret. * @example MY_ARTIFACTORY_PASSWORD */ - readonly name: string; + name: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Dependency Graph Diff * @description A diff of the dependencies between two commits. */ - readonly "dependency-graph-diff": readonly { + "dependency-graph-diff": { /** @enum {string} */ - readonly change_type: "added" | "removed"; + change_type: "added" | "removed"; /** @example path/to/package-lock.json */ - readonly manifest: string; + manifest: string; /** @example npm */ - readonly ecosystem: string; + ecosystem: string; /** @example @actions/core */ - readonly name: string; + name: string; /** @example 1.0.0 */ - readonly version: string; + version: string; /** @example pkg:/npm/%40actions/core@1.1.0 */ - readonly package_url: string | null; + package_url: string | null; /** @example MIT */ - readonly license: string | null; + license: string | null; /** @example https://github.com/github/actions */ - readonly source_repository_url: string | null; - readonly vulnerabilities: readonly { + source_repository_url: string | null; + vulnerabilities: { /** @example critical */ - readonly severity: string; + severity: string; /** @example GHSA-rf4j-j272-fj86 */ - readonly advisory_ghsa_id: string; + advisory_ghsa_id: string; /** @example A summary of the advisory. */ - readonly advisory_summary: string; + advisory_summary: string; /** @example https://github.com/advisories/GHSA-rf4j-j272-fj86 */ - readonly advisory_url: string; + advisory_url: string; }[]; /** * @description Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment. * @enum {string} */ - readonly scope: "unknown" | "runtime" | "development"; + scope: "unknown" | "runtime" | "development"; }[]; /** * Dependency Graph SPDX SBOM * @description A schema for the SPDX JSON format returned by the Dependency Graph. */ - readonly "dependency-graph-spdx-sbom": { - readonly sbom: { + "dependency-graph-spdx-sbom": { + sbom: { /** * @description The SPDX identifier for the SPDX document. * @example SPDXRef-DOCUMENT */ - readonly SPDXID: string; + SPDXID: string; /** * @description The version of the SPDX specification that this document conforms to. * @example SPDX-2.3 */ - readonly spdxVersion: string; + 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: { + comment?: string; + creationInfo: { /** * @description The date and time the SPDX document was created. * @example 2021-11-03T00:00:00Z */ - readonly created: string; + created: string; /** @description The tools that were used to generate the SPDX document. */ - readonly creators: readonly string[]; + creators: string[]; }; /** * @description The name of the SPDX document. * @example github/github */ - readonly name: string; + name: string; /** * @description The license under which the SPDX document is licensed. * @example CC0-1.0 */ - readonly dataLicense: string; + dataLicense: string; /** * @description The namespace for the SPDX document. * @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 */ - readonly documentNamespace: string; - readonly packages: readonly { + documentNamespace: string; + packages: { /** * @description A unique SPDX identifier for the package. * @example SPDXRef-Package */ - readonly SPDXID?: string; + SPDXID?: string; /** * @description The name of the package. * @example github/github */ - readonly name?: string; + name?: string; /** * @description The version of the package. If the package does not have an exact version specified, * a version range is given. * @example 1.0.0 */ - readonly versionInfo?: string; + versionInfo?: string; /** * @description The location where the package can be downloaded, * or NOASSERTION if this has not been determined. * @example NOASSERTION */ - readonly downloadLocation?: string; + downloadLocation?: string; /** * @description Whether the package's file content has been subjected to * analysis during the creation of the SPDX document. * @example false */ - readonly filesAnalyzed?: boolean; + filesAnalyzed?: boolean; /** * @description The license of the package as determined while creating the SPDX document. * @example MIT */ - readonly licenseConcluded?: string; + licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information * was not available when the SPDX document was created. * @example NOASSERTION */ - readonly licenseDeclared?: string; + licenseDeclared?: string; /** * @description The distribution source of this package, or NOASSERTION if this was not determined. * @example NOASSERTION */ - readonly supplier?: string; + supplier?: string; /** * @description The copyright holders of the package, and any dates present with those notices, if available. * @example Copyright (c) 1985 GitHub.com */ - readonly copyrightText?: string; - readonly externalRefs?: readonly { + copyrightText?: string; + externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. * @example PACKAGE-MANAGER */ - readonly referenceCategory: string; + referenceCategory: string; /** * @description A locator for the particular external resource this reference refers to. * @example pkg:gem/rails@6.0.1 */ - readonly referenceLocator: string; + referenceLocator: string; /** * @description The category of reference to an external resource this reference refers to. * @example purl */ - readonly referenceType: string; + referenceType: string; }[]; }[]; - readonly relationships?: readonly { + relationships?: { /** * @description The type of relationship between the two SPDX elements. * @example DEPENDS_ON */ - readonly relationshipType?: string; + relationshipType?: string; /** @description The SPDX identifier of the package that is the source of the relationship. */ - readonly spdxElementId?: string; + spdxElementId?: string; /** @description The SPDX identifier of the package that is the target of the relationship. */ - readonly relatedSpdxElement?: string; + relatedSpdxElement?: string; }[]; }; }; @@ -30692,309 +33677,309 @@ export interface components { * metadata * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ - readonly metadata: { - readonly [key: string]: (string | number | boolean) | null; + metadata: { + [key: string]: (string | number | boolean) | null; }; - readonly dependency: { + dependency: { /** * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 */ - readonly package_url?: string; - readonly metadata?: components["schemas"]["metadata"]; + package_url?: string; + metadata?: components["schemas"]["metadata"]; /** * @description A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. * @example direct * @enum {string} */ - readonly relationship?: "direct" | "indirect"; + relationship?: "direct" | "indirect"; /** * @description A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. * @example runtime * @enum {string} */ - readonly scope?: "runtime" | "development"; + scope?: "runtime" | "development"; /** * @description Array of package-url (PURLs) of direct child dependencies. * @example @actions/http-client */ - readonly dependencies?: readonly string[]; + dependencies?: string[]; }; - readonly manifest: { + manifest: { /** * @description The name of the manifest. * @example package-lock.json */ - readonly name: string; - readonly file?: { + name: string; + file?: { /** * @description The path of the manifest file relative to the root of the Git repository. * @example /src/build/package-lock.json */ - readonly source_location?: string; + source_location?: string; }; - readonly metadata?: components["schemas"]["metadata"]; + metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ - readonly resolved?: { - readonly [key: string]: components["schemas"]["dependency"]; + resolved?: { + [key: string]: components["schemas"]["dependency"]; }; }; /** * snapshot * @description Create a new snapshot of a repository's dependencies. */ - readonly snapshot: { + snapshot: { /** @description The version of the repository snapshot submission. */ - readonly version: number; - readonly job: { + version: number; + job: { /** * @description The external ID of the job. * @example 5622a2b0-63f6-4732-8c34-a1ab27e102a11 */ - readonly id: string; + id: string; /** * @description Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation. * @example yourworkflowname_yourjobname */ - readonly correlator: string; + correlator: string; /** * @description The url for the job. * @example http://example.com/build */ - readonly html_url?: string; + html_url?: string; }; /** * @description The commit SHA associated with this dependency snapshot. Maximum length: 40 characters. * @example ddc951f4b1293222421f2c8df679786153acf689 */ - readonly sha: string; + sha: string; /** * @description The repository branch that triggered this snapshot. * @example refs/heads/main */ - readonly ref: string; + ref: string; /** @description A description of the detector used. */ - readonly detector: { + detector: { /** * @description The name of the detector used. * @example docker buildtime detector */ - readonly name: string; + name: string; /** * @description The version of the detector used. * @example 1.0.0 */ - readonly version: string; + version: string; /** * @description The url of the detector used. * @example http://example.com/docker-buildtimer-detector */ - readonly url: string; + url: string; }; - readonly metadata?: components["schemas"]["metadata"]; + metadata?: components["schemas"]["metadata"]; /** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */ - readonly manifests?: { - readonly [key: string]: components["schemas"]["manifest"]; + manifests?: { + [key: string]: components["schemas"]["manifest"]; }; /** * Format: date-time * @description The time at which the snapshot was scanned. * @example 2020-06-13T14:52:50-05:00 */ - readonly scanned: string; + scanned: string; }; /** * Deployment Status * @description The status of a deployment. */ - readonly "deployment-status": { + "deployment-status": { /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - readonly url: string; + url: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */ - readonly node_id: string; + node_id: string; /** * @description The state of the status. * @example success * @enum {string} */ - readonly state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; - readonly creator: components["schemas"]["nullable-simple-user"]; + state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress"; + creator: components["schemas"]["nullable-simple-user"]; /** * @description A short description of the status. * @default * @example Deployment finished successfully. */ - readonly description: string; + description: string; /** * @description The environment of the deployment that the status is for. * @default * @example production */ - readonly environment: string; + environment: string; /** * Format: uri * @description Closing down notice: the URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - readonly target_url: string; + target_url: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2012-07-20T01:19:13Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/deployments/42 */ - readonly deployment_url: string; + deployment_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; /** * Format: uri * @description The URL for accessing your environment. * @default * @example https://staging.example.com/ */ - readonly environment_url: string; + environment_url: string; /** * Format: uri * @description The URL to associate with this status. * @default * @example https://example.com/deployment/42/output */ - readonly log_url: string; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + log_url: string; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days). * @example 30 */ - readonly "wait-timer": number; + "wait-timer": number; /** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */ - readonly "deployment-branch-policy-settings": { + "deployment-branch-policy-settings": { /** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */ - readonly protected_branches: boolean; + protected_branches: boolean; /** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */ - readonly custom_branch_policies: boolean; + custom_branch_policies: boolean; } | null; /** * Environment * @description Details of a deployment environment */ - readonly environment: { + environment: { /** * Format: int64 * @description The id of the environment. * @example 56780428 */ - readonly id: number; + id: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - readonly node_id: string; + node_id: string; /** * @description The name of the environment. * @example staging */ - readonly name: string; + name: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - readonly url: string; + url: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - readonly html_url: string; + html_url: string; /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - readonly updated_at: string; + updated_at: string; /** @description Built-in deployment protection rules for the environment. */ - readonly protection_rules?: readonly ({ + protection_rules?: ({ /** @example 3515 */ - readonly id: number; + id: number; /** @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; /** @example wait_timer */ - readonly type: string; - readonly wait_timer?: components["schemas"]["wait-timer"]; + type: string; + wait_timer?: components["schemas"]["wait-timer"]; } | { /** @example 3755 */ - readonly id: number; + id: number; /** @example MDQ6R2F0ZTM3NTU= */ - readonly node_id: string; + node_id: string; /** * @description Whether deployments to this environment can be approved by the user who created the deployment. * @example false */ - readonly prevent_self_review?: boolean; + prevent_self_review?: boolean; /** @example required_reviewers */ - readonly type: string; + type: string; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - readonly reviewers?: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; - readonly reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; + reviewers?: { + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; }[]; } | { /** @example 3515 */ - readonly id: number; + id: number; /** @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; /** @example branch_policy */ - readonly type: string; + type: string; })[]; - readonly deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; + deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; }; /** * @description Whether or not a user who created the job is prevented from approving their own job. * @example false */ - readonly "prevent-self-review": boolean; + "prevent-self-review": boolean; /** * Deployment branch policy * @description Details of a deployment branch or tag policy. */ - readonly "deployment-branch-policy": { + "deployment-branch-policy": { /** * @description The unique identifier of the branch or tag policy. * @example 361471 */ - readonly id?: number; + id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ - readonly node_id?: string; + node_id?: string; /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ - readonly name?: string; + name?: string; /** * @description Whether this rule targets a branch or tag. * @example branch * @enum {string} */ - readonly type?: "branch" | "tag"; + type?: "branch" | "tag"; }; /** Deployment branch and tag policy name pattern */ - readonly "deployment-branch-policy-name-pattern-with-type": { + "deployment-branch-policy-name-pattern-with-type": { /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * @@ -31002,16 +33987,16 @@ export interface components { * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ - readonly name: string; + name: string; /** * @description Whether this rule targets a branch or tag * @example branch * @enum {string} */ - readonly type?: "branch" | "tag"; + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ - readonly "deployment-branch-policy-name-pattern": { + "deployment-branch-policy-name-pattern": { /** * @description The name pattern that branches must match in order to deploy to the environment. * @@ -31019,231 +34004,231 @@ export interface components { * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). * @example release/* */ - readonly name: string; + name: string; }; /** * Custom deployment protection rule app * @description A GitHub App that is providing a custom deployment protection rule. */ - readonly "custom-deployment-rule-app": { + "custom-deployment-rule-app": { /** * @description The unique identifier of the deployment protection rule integration. * @example 3515 */ - readonly id: number; + id: number; /** * @description The slugified name of the deployment protection rule integration. * @example my-custom-app */ - readonly slug: string; + slug: string; /** * @description The URL for the endpoint to get details about the app. * @example https://api.github.com/apps/custom-app-slug */ - readonly integration_url: string; + integration_url: string; /** * @description The node ID for the deployment protection rule integration. * @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; }; /** * Deployment protection rule * @description Deployment protection rule */ - readonly "deployment-protection-rule": { + "deployment-protection-rule": { /** * @description The unique identifier for the deployment protection rule. * @example 3515 */ - readonly id: number; + id: number; /** * @description The node ID for the deployment protection rule. * @example MDQ6R2F0ZTM1MTU= */ - readonly node_id: string; + node_id: string; /** * @description Whether the deployment protection rule is enabled for the environment. * @example true */ - readonly enabled: boolean; - readonly app: components["schemas"]["custom-deployment-rule-app"]; + enabled: boolean; + app: components["schemas"]["custom-deployment-rule-app"]; }; /** * Short Blob * @description Short Blob */ - readonly "short-blob": { - readonly url: string; - readonly sha: string; + "short-blob": { + url: string; + sha: string; }; /** * Blob * @description Blob */ - readonly blob: { - readonly content: string; - readonly encoding: string; + blob: { + content: string; + encoding: string; /** Format: uri */ - readonly url: string; - readonly sha: string; - readonly size: number | null; - readonly node_id: string; - readonly highlighted_content?: string; + url: string; + sha: string; + size: number | null; + node_id: string; + highlighted_content?: string; }; /** * Git Commit * @description Low-level Git commit operations within a repository */ - readonly "git-commit": { + "git-commit": { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; - readonly node_id: string; + sha: string; + node_id: string; /** Format: uri */ - readonly url: string; + url: string; /** @description Identifying information for the git-user */ - readonly author: { + author: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** @description Identifying information for the git-user */ - readonly committer: { + committer: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; - readonly tree: { + message: string; + tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly parents: readonly { + parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; }[]; - readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly signature: string | null; - readonly payload: string | null; - readonly verified_at?: string | null; + verification: { + verified: boolean; + reason: string; + signature: string | null; + payload: string | null; + verified_at: string | null; }; /** Format: uri */ - readonly html_url: string; + html_url: string; }; /** * Git Reference * @description Git references within a repository */ - readonly "git-ref": { - readonly ref: string; - readonly node_id: string; + "git-ref": { + ref: string; + node_id: string; /** Format: uri */ - readonly url: string; - readonly object: { - readonly type: string; + url: string; + object: { + type: string; /** * @description SHA for the reference * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; }; /** * Git Tag * @description Metadata for a Git tag */ - readonly "git-tag": { + "git-tag": { /** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */ - readonly node_id: string; + node_id: string; /** * @description Name of the tag * @example v0.0.1 */ - readonly tag: string; + tag: string; /** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly sha: string; + sha: string; /** * Format: uri * @description URL for the tag * @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly url: string; + url: string; /** * @description Message describing the purpose of the tag * @example Initial public release */ - readonly message: string; - readonly tagger: { - readonly date: string; - readonly email: string; - readonly name: string; + message: string; + tagger: { + date: string; + email: string; + name: string; }; - readonly object: { - readonly sha: string; - readonly type: string; + object: { + sha: string; + type: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly verification?: components["schemas"]["verification"]; + verification?: components["schemas"]["verification"]; }; /** * Git Tree * @description The hierarchy between files in a Git repository. */ - readonly "git-tree": { - readonly sha: string; + "git-tree": { + sha: string; /** Format: uri */ - readonly url: string; - readonly truncated: boolean; + url?: string; + truncated: boolean; /** * @description Objects specifying a tree structure * @example [ @@ -31253,80 +34238,52 @@ export interface components { * "type": "blob", * "size": 30, * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" - * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" - * ] + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" * } * ] */ - readonly tree: readonly { + tree: { /** @example test/file.rb */ - readonly path?: string; + path: string; /** @example 040000 */ - readonly mode?: string; + mode: string; /** @example tree */ - readonly type?: string; + type: string; /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - readonly sha?: string; + sha: string; /** @example 12 */ - readonly size?: number; + size?: number; /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - readonly url?: string; + url?: string; }[]; }; /** Hook Response */ - readonly "hook-response": { - readonly code: number | null; - readonly status: string | null; - readonly message: string | null; + "hook-response": { + code: number | null; + status: string | null; + message: string | null; }; /** * Webhook * @description Webhooks for repositories. */ - readonly hook: { - readonly type: string; + hook: { + type: string; /** * @description Unique identifier of the webhook. * @example 42 */ - readonly id: number; + id: number; /** * @description The name of a valid service, use 'web' for a webhook. * @example web */ - readonly name: string; + name: string; /** * @description Determines whether the hook is actually triggered on pushes. * @example true */ - readonly active: boolean; + active: boolean; /** * @description Determines what events the hook is triggered for. Default: ['push']. * @example [ @@ -31334,154 +34291,170 @@ export interface components { * "pull_request" * ] */ - readonly events: readonly string[]; - readonly config: components["schemas"]["webhook-config"]; + events: string[]; + config: components["schemas"]["webhook-config"]; /** * Format: date-time * @example 2011-09-06T20:39:23Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2011-09-06T17:26:27Z */ - readonly created_at: string; + created_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test */ - readonly test_url: string; + test_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings */ - readonly ping_url: string; + ping_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries */ - readonly deliveries_url?: string; - readonly last_response: components["schemas"]["hook-response"]; + deliveries_url?: string; + last_response: components["schemas"]["hook-response"]; + }; + /** + * Check immutable releases + * @description Check immutable releases + */ + "check-immutable-releases": { + /** + * @description Whether immutable releases are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether immutable releases are enforced by the repository owner. + * @example false + */ + enforced_by_owner: boolean; }; /** * Import * @description A repository import from an external source. */ - readonly import: { - readonly vcs: string | null; - readonly use_lfs?: boolean; + import: { + vcs: string | null; + use_lfs?: boolean; /** @description The URL of the originating repository. */ - readonly vcs_url: string; - readonly svc_root?: string; - readonly tfvc_project?: string; + vcs_url: string; + svc_root?: string; + tfvc_project?: string; /** @enum {string} */ - readonly status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; - readonly status_text?: string | null; - readonly failed_step?: string | null; - readonly error_message?: string | null; - readonly import_percent?: number | null; - readonly commit_count?: number | null; - readonly push_percent?: number | null; - readonly has_large_files?: boolean; - readonly large_files_size?: number; - readonly large_files_count?: number; - readonly project_choices?: readonly { - readonly vcs?: string; - readonly tfvc_project?: string; - readonly human_name?: string; + status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth"; + status_text?: string | null; + failed_step?: string | null; + error_message?: string | null; + import_percent?: number | null; + commit_count?: number | null; + push_percent?: number | null; + has_large_files?: boolean; + large_files_size?: number; + large_files_count?: number; + project_choices?: { + vcs?: string; + tfvc_project?: string; + human_name?: string; }[]; - readonly message?: string; - readonly authors_count?: number | null; + message?: string; + authors_count?: number | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly authors_url: string; + authors_url: string; /** Format: uri */ - readonly repository_url: string; - readonly svn_root?: string; + repository_url: string; + svn_root?: string; }; /** * Porter Author * @description Porter Author */ - readonly "porter-author": { - readonly id: number; - readonly remote_id: string; - readonly remote_name: string; - readonly email: string; - readonly name: string; + "porter-author": { + id: number; + remote_id: string; + remote_name: string; + email: string; + name: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly import_url: string; + import_url: string; }; /** * Porter Large File * @description Porter Large File */ - readonly "porter-large-file": { - readonly ref_name: string; - readonly path: string; - readonly oid: string; - readonly size: number; + "porter-large-file": { + ref_name: string; + path: string; + oid: string; + size: number; }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. */ - readonly "nullable-issue": { + "nullable-issue": { /** Format: int64 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue * @example https://api.github.com/repositories/42/issues/1 */ - readonly url: string; + url: string; /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + repository_url: string; + labels_url: string; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * @description Number uniquely identifying the issue within its repository * @example 42 */ - readonly number: number; + number: number; /** * @description State of the issue; either 'open' or 'closed' * @example open */ - readonly state: string; + state: string; /** * @description The reason for the current state * @example not_planned * @enum {string|null} */ - readonly state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 */ - readonly title: string; + title: string; /** * @description Contents of the issue * @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug? */ - readonly body?: string | null; - readonly user: components["schemas"]["nullable-simple-user"]; + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; /** * @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository * @example [ @@ -31489,1060 +34462,1033 @@ export interface components { * "registration" * ] */ - readonly labels: readonly (string | { + labels: (string | { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - /** Format: uri */ - readonly url?: string; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; - readonly default?: boolean; + id?: number; + node_id?: string; + /** Format: uri */ + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; })[]; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly comments: number; - readonly pull_request?: { + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + milestone: components["schemas"]["nullable-milestone"]; + locked: boolean; + active_lock_reason?: string | null; + comments: number; + pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly diff_url: string | null; + diff_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly patch_url: string | null; + patch_url: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; /** Format: date-time */ - readonly closed_at: string | null; + closed_at: string | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly draft?: boolean; - readonly closed_by?: components["schemas"]["nullable-simple-user"]; - readonly body_html?: string; - readonly body_text?: string; + updated_at: string; + draft?: boolean; + closed_by?: components["schemas"]["nullable-simple-user"]; + body_html?: string; + body_text?: string; /** Format: uri */ - readonly timeline_url?: string; - readonly repository?: components["schemas"]["repository"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly author_association: components["schemas"]["author-association"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; - readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + repository?: components["schemas"]["repository"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + author_association?: components["schemas"]["author-association"]; + reactions?: components["schemas"]["reaction-rollup"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; } | null; /** * Issue Event Label * @description Issue Event Label */ - readonly "issue-event-label": { - readonly name: string | null; - readonly color: string | null; + "issue-event-label": { + name: string | null; + color: string | null; }; /** Issue Event Dismissed Review */ - readonly "issue-event-dismissed-review": { - readonly state: string; - readonly review_id: number; - readonly dismissal_message: string | null; - readonly dismissal_commit_id?: string | null; + "issue-event-dismissed-review": { + state: string; + review_id: number; + dismissal_message: string | null; + dismissal_commit_id?: string | null; }; /** * Issue Event Milestone * @description Issue Event Milestone */ - readonly "issue-event-milestone": { - readonly title: string; + "issue-event-milestone": { + title: string; }; /** * Issue Event Project Card * @description Issue Event Project Card */ - readonly "issue-event-project-card": { + "issue-event-project-card": { /** Format: uri */ - readonly url: string; - readonly id: number; + url: string; + id: number; /** Format: uri */ - readonly project_url: string; - readonly project_id: number; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + project_id: number; + column_name: string; + previous_column_name?: string; }; /** * Issue Event Rename * @description Issue Event Rename */ - readonly "issue-event-rename": { - readonly from: string; - readonly to: string; + "issue-event-rename": { + from: string; + to: string; }; /** * Issue Event * @description Issue Event */ - readonly "issue-event": { + "issue-event": { /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDEwOklzc3VlRXZlbnQx */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/events/1 */ - readonly url: string; - readonly actor: components["schemas"]["nullable-simple-user"]; + url: string; + actor: components["schemas"]["nullable-simple-user"]; /** @example closed */ - readonly event: string; + event: string; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string | null; + commit_id: string | null; /** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_url: string | null; + commit_url: string | null; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; - readonly issue?: components["schemas"]["nullable-issue"]; - readonly label?: components["schemas"]["issue-event-label"]; - readonly assignee?: components["schemas"]["nullable-simple-user"]; - readonly assigner?: components["schemas"]["nullable-simple-user"]; - readonly review_requester?: components["schemas"]["nullable-simple-user"]; - readonly requested_reviewer?: components["schemas"]["nullable-simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; - readonly milestone?: components["schemas"]["issue-event-milestone"]; - readonly project_card?: components["schemas"]["issue-event-project-card"]; - readonly rename?: components["schemas"]["issue-event-rename"]; - readonly author_association?: components["schemas"]["author-association"]; - readonly lock_reason?: string | null; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; + created_at: string; + issue?: components["schemas"]["nullable-issue"]; + label?: components["schemas"]["issue-event-label"]; + assignee?: components["schemas"]["nullable-simple-user"]; + assigner?: components["schemas"]["nullable-simple-user"]; + review_requester?: components["schemas"]["nullable-simple-user"]; + requested_reviewer?: components["schemas"]["nullable-simple-user"]; + requested_team?: components["schemas"]["team"]; + dismissed_review?: components["schemas"]["issue-event-dismissed-review"]; + milestone?: components["schemas"]["issue-event-milestone"]; + project_card?: components["schemas"]["issue-event-project-card"]; + rename?: components["schemas"]["issue-event-rename"]; + author_association?: components["schemas"]["author-association"]; + lock_reason?: string | null; + performed_via_github_app?: components["schemas"]["nullable-integration"]; }; /** * Labeled Issue Event * @description Labeled Issue Event */ - readonly "labeled-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly label: { - readonly name: string; - readonly color: string; + "labeled-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + label: { + name: string; + color: string; }; }; /** * Unlabeled Issue Event * @description Unlabeled Issue Event */ - readonly "unlabeled-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly label: { - readonly name: string; - readonly color: string; + "unlabeled-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + label: { + name: string; + color: string; }; }; /** * Assigned Issue Event * @description Assigned Issue Event */ - readonly "assigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["integration"]; - readonly assignee: components["schemas"]["simple-user"]; - readonly assigner: components["schemas"]["simple-user"]; + "assigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["integration"]; + assignee: components["schemas"]["simple-user"]; + assigner: components["schemas"]["simple-user"]; }; /** * Unassigned Issue Event * @description Unassigned Issue Event */ - readonly "unassigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; - readonly assigner: components["schemas"]["simple-user"]; + "unassigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + assignee: components["schemas"]["simple-user"]; + assigner: components["schemas"]["simple-user"]; }; /** * Milestoned Issue Event * @description Milestoned Issue Event */ - readonly "milestoned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly milestone: { - readonly title: string; + "milestoned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + milestone: { + title: string; }; }; /** * Demilestoned Issue Event * @description Demilestoned Issue Event */ - readonly "demilestoned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly milestone: { - readonly title: string; + "demilestoned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + milestone: { + title: string; }; }; /** * Renamed Issue Event * @description Renamed Issue Event */ - readonly "renamed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly rename: { - readonly from: string; - readonly to: string; + "renamed-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + rename: { + from: string; + to: string; }; }; /** * Review Requested Issue Event * @description Review Requested Issue Event */ - readonly "review-requested-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly review_requester: components["schemas"]["simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly requested_reviewer?: components["schemas"]["simple-user"]; + "review-requested-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + review_requester: components["schemas"]["simple-user"]; + requested_team?: components["schemas"]["team"]; + requested_reviewer?: components["schemas"]["simple-user"]; }; /** * Review Request Removed Issue Event * @description Review Request Removed Issue Event */ - readonly "review-request-removed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly review_requester: components["schemas"]["simple-user"]; - readonly requested_team?: components["schemas"]["team"]; - readonly requested_reviewer?: components["schemas"]["simple-user"]; + "review-request-removed-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + review_requester: components["schemas"]["simple-user"]; + requested_team?: components["schemas"]["team"]; + requested_reviewer?: components["schemas"]["simple-user"]; }; /** * Review Dismissed Issue Event * @description Review Dismissed Issue Event */ - readonly "review-dismissed-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly dismissed_review: { - readonly state: string; - readonly review_id: number; - readonly dismissal_message: string | null; - readonly dismissal_commit_id?: string; + "review-dismissed-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + dismissed_review: { + state: string; + review_id: number; + dismissal_message: string | null; + dismissal_commit_id?: string; }; }; /** * Locked Issue Event * @description Locked Issue Event */ - readonly "locked-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + "locked-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; /** @example "off-topic" */ - readonly lock_reason: string | null; + lock_reason: string | null; }; /** * Added to Project Issue Event * @description Added to Project Issue Event */ - readonly "added-to-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly project_card?: { - readonly id: number; + "added-to-project-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Moved Column in Project Issue Event * @description Moved Column in Project Issue Event */ - readonly "moved-column-in-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly project_card?: { - readonly id: number; + "moved-column-in-project-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Removed from Project Issue Event * @description Removed from Project Issue Event */ - readonly "removed-from-project-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly project_card?: { - readonly id: number; + "removed-from-project-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Converted Note to Issue Issue Event * @description Converted Note to Issue Issue Event */ - readonly "converted-note-to-issue-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["integration"]; - readonly project_card?: { - readonly id: number; + "converted-note-to-issue-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["integration"]; + project_card?: { + id: number; /** Format: uri */ - readonly url: string; - readonly project_id: number; + url: string; + project_id: number; /** Format: uri */ - readonly project_url: string; - readonly column_name: string; - readonly previous_column_name?: string; + project_url: string; + column_name: string; + previous_column_name?: string; }; }; /** * Issue Event for Issue * @description Issue Event for Issue */ - readonly "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; - /** - * Label - * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). - */ - readonly label: { - /** - * Format: int64 - * @description Unique identifier for the label. - * @example 208045946 - */ - readonly id: number; - /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - * @example https://api.github.com/repositories/42/labels/bug - */ - readonly url: string; - /** - * @description The name of the label. - * @example bug - */ - readonly name: string; - /** - * @description Optional description of the label, such as its purpose. - * @example Something isn't working - */ - readonly description: string | null; - /** - * @description 6-character hex code, without the leading #, identifying the color - * @example FFFFFF - */ - readonly color: string; - /** - * @description Whether this label comes by default in a new repository. - * @example true - */ - readonly default: boolean; - }; + "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; /** * Timeline Comment Event * @description Timeline Comment Event */ - readonly "timeline-comment-event": { - readonly event: string; - readonly actor: components["schemas"]["simple-user"]; + "timeline-comment-event": { + event: string; + actor: components["schemas"]["simple-user"]; /** * @description Unique identifier of the issue comment * @example 42 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** * Format: uri * @description URL for the issue comment * @example https://api.github.com/repositories/42/issues/comments/1 */ - readonly url: string; + url: string; /** * @description Contents of the issue comment * @example What version of Safari were you using when you observed this bug? */ - readonly body?: string; - readonly body_text?: string; - readonly body_html?: string; + body?: string; + body_text?: string; + body_html?: string; /** Format: uri */ - readonly html_url: string; - readonly user: components["schemas"]["simple-user"]; + html_url: string; + user: components["schemas"]["simple-user"]; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly issue_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; + issue_url: string; + author_association: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** * Timeline Cross Referenced Event * @description Timeline Cross Referenced Event */ - readonly "timeline-cross-referenced-event": { - readonly event: string; - readonly actor?: components["schemas"]["simple-user"]; + "timeline-cross-referenced-event": { + event: string; + actor?: components["schemas"]["simple-user"]; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly source: { - readonly type?: string; - readonly issue?: components["schemas"]["issue"]; + updated_at: string; + source: { + type?: string; + issue?: components["schemas"]["issue"]; }; }; /** * Timeline Committed Event * @description Timeline Committed Event */ - readonly "timeline-committed-event": { - readonly event?: string; + "timeline-committed-event": { + event?: string; /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; - readonly node_id: string; + sha: string; + node_id: string; /** Format: uri */ - readonly url: string; + url: string; /** @description Identifying information for the git-user */ - readonly author: { + author: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** @description Identifying information for the git-user */ - readonly committer: { + committer: { /** * Format: date-time * @description Timestamp of the commit * @example 2014-08-09T08:02:04+12:00 */ - readonly date: string; + date: string; /** * @description Git email address of the user * @example monalisa.octocat@example.com */ - readonly email: string; + email: string; /** * @description Name of the git user * @example Monalisa Octocat */ - readonly name: string; + name: string; }; /** * @description Message describing the purpose of the commit * @example Fix #42 */ - readonly message: string; - readonly tree: { + message: string; + tree: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly parents: readonly { + parents: { /** * @description SHA for the commit * @example 7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; }[]; - readonly verification: { - readonly verified: boolean; - readonly reason: string; - readonly signature: string | null; - readonly payload: string | null; - readonly verified_at?: string | null; + verification: { + verified: boolean; + reason: string; + signature: string | null; + payload: string | null; + verified_at: string | null; }; /** Format: uri */ - readonly html_url: string; + html_url: string; }; /** * Timeline Reviewed Event * @description Timeline Reviewed Event */ - readonly "timeline-reviewed-event": { - readonly event: string; + "timeline-reviewed-event": { + event: string; /** * @description Unique identifier of the review * @example 42 */ - readonly id: number; + id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - readonly node_id: string; - readonly user: components["schemas"]["simple-user"]; + node_id: string; + user: components["schemas"]["simple-user"]; /** * @description The text of the review. * @example This looks great. */ - readonly body: string | null; + body: string | null; /** @example CHANGES_REQUESTED */ - readonly state: string; + state: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - readonly pull_request_url: string; - readonly _links: { - readonly html: { - readonly href: string; + pull_request_url: string; + _links: { + html: { + href: string; }; - readonly pull_request: { - readonly href: string; + pull_request: { + href: string; }; }; /** Format: date-time */ - readonly submitted_at?: string; + submitted_at?: string; + /** Format: date-time */ + updated_at?: string | null; /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - readonly commit_id: string; - readonly body_html?: string; - readonly body_text?: string; - readonly author_association: components["schemas"]["author-association"]; + commit_id: string; + body_html?: string; + body_text?: string; + author_association: components["schemas"]["author-association"]; }; /** * Pull Request Review Comment * @description Pull Request Review Comments are comments on a portion of the Pull Request's diff. */ - readonly "pull-request-review-comment": { + "pull-request-review-comment": { /** * @description URL for the pull request review comment * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly url: string; + url: string; /** * Format: int64 * @description The ID of the pull request review to which the comment belongs. * @example 42 */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: int64 * @description The ID of the pull request review comment. * @example 1 */ - readonly id: number; + id: number; /** * @description The node ID of the pull request review comment. * @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - readonly node_id: string; + node_id: string; /** * @description The diff of the line that the comment refers to. * @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - readonly diff_hunk: string; + diff_hunk: string; /** * @description The relative path of the file to which the comment applies. * @example config/database.yaml */ - readonly path: string; + path: string; /** * @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; + position?: number; /** * @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; + original_position?: number; /** * @description The SHA of the commit to which the comment applies. * @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string; + commit_id: string; /** * @description The SHA of the original commit to which the comment applies. * @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - readonly original_commit_id: string; + original_commit_id: string; /** * @description The comment ID to reply to. * @example 8 */ - readonly in_reply_to_id?: number; - readonly user: components["schemas"]["simple-user"]; + in_reply_to_id?: number; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the comment. * @example We should probably include a check for null values here. */ - readonly body: string; + body: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description HTML URL for the pull request review comment. * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @description URL for the pull request that the review comment belongs to. * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly pull_request_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly _links: { - readonly self: { + pull_request_url: string; + author_association: components["schemas"]["author-association"]; + _links: { + self: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly href: string; + href: string; }; - readonly html: { + html: { /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly href: string; + href: string; }; - readonly pull_request: { + pull_request: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly href: string; + href: string; }; }; /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly start_line?: number | null; + start_line?: number | null; /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly original_start_line?: number | null; + original_start_line?: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly line?: number; + line?: number; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly original_line?: number; + original_line?: number; /** * @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment * @default RIGHT * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; - readonly reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; + reactions?: components["schemas"]["reaction-rollup"]; /** @example "

comment body

" */ - readonly body_html?: string; + body_html?: string; /** @example "comment body" */ - readonly body_text?: string; + body_text?: string; }; /** * Timeline Line Commented Event * @description Timeline Line Commented Event */ - readonly "timeline-line-commented-event": { - readonly event?: string; - readonly node_id?: string; - readonly comments?: readonly components["schemas"]["pull-request-review-comment"][]; + "timeline-line-commented-event": { + event?: string; + node_id?: string; + comments?: components["schemas"]["pull-request-review-comment"][]; }; /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ - readonly "timeline-commit-commented-event": { - readonly event?: string; - readonly node_id?: string; - readonly commit_id?: string; - readonly comments?: readonly components["schemas"]["commit-comment"][]; + "timeline-commit-commented-event": { + event?: string; + node_id?: string; + commit_id?: string; + comments?: components["schemas"]["commit-comment"][]; }; /** * Timeline Assigned Issue Event * @description Timeline Assigned Issue Event */ - readonly "timeline-assigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; + "timeline-assigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + assignee: components["schemas"]["simple-user"]; }; /** * Timeline Unassigned Issue Event * @description Timeline Unassigned Issue Event */ - readonly "timeline-unassigned-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly assignee: components["schemas"]["simple-user"]; + "timeline-unassigned-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + assignee: components["schemas"]["simple-user"]; }; /** * State Change Issue Event * @description State Change Issue Event */ - readonly "state-change-issue-event": { - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly actor: components["schemas"]["simple-user"]; - readonly event: string; - readonly commit_id: string | null; - readonly commit_url: string | null; - readonly created_at: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; - readonly state_reason?: string | null; + "state-change-issue-event": { + id: number; + node_id: string; + url: string; + actor: components["schemas"]["simple-user"]; + event: string; + commit_id: string | null; + commit_url: string | null; + created_at: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; + state_reason?: string | null; }; /** * Timeline Event * @description Timeline Event */ - readonly "timeline-issue-events": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"] | components["schemas"]["timeline-comment-event"] | components["schemas"]["timeline-cross-referenced-event"] | components["schemas"]["timeline-committed-event"] | components["schemas"]["timeline-reviewed-event"] | components["schemas"]["timeline-line-commented-event"] | components["schemas"]["timeline-commit-commented-event"] | components["schemas"]["timeline-assigned-issue-event"] | components["schemas"]["timeline-unassigned-issue-event"] | components["schemas"]["state-change-issue-event"]; + "timeline-issue-events": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"] | components["schemas"]["timeline-comment-event"] | components["schemas"]["timeline-cross-referenced-event"] | components["schemas"]["timeline-committed-event"] | components["schemas"]["timeline-reviewed-event"] | components["schemas"]["timeline-line-commented-event"] | components["schemas"]["timeline-commit-commented-event"] | components["schemas"]["timeline-assigned-issue-event"] | components["schemas"]["timeline-unassigned-issue-event"] | components["schemas"]["state-change-issue-event"]; /** * Deploy Key * @description An SSH key granting access to a single repository. */ - readonly "deploy-key": { - readonly id: number; - readonly key: string; - readonly url: string; - readonly title: string; - readonly verified: boolean; - readonly created_at: string; - readonly read_only: boolean; - readonly added_by?: string | null; - readonly last_used?: string | null; - readonly enabled?: boolean; + "deploy-key": { + id: number; + key: string; + url: string; + title: string; + verified: boolean; + created_at: string; + read_only: boolean; + added_by?: string | null; + /** Format: date-time */ + last_used?: string | null; + enabled?: boolean; }; /** * Language * @description Language */ - readonly language: { - readonly [key: string]: number; + language: { + [key: string]: number; }; /** * License Content * @description License Content */ - readonly "license-content": { - readonly name: string; - readonly path: string; - readonly sha: string; - readonly size: number; + "license-content": { + name: string; + path: string; + sha: string; + size: number; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly git_url: string | null; + git_url: string | null; /** Format: uri */ - readonly download_url: string | null; - readonly type: string; - readonly content: string; - readonly encoding: string; - readonly _links: { + download_url: string | null; + type: string; + content: string; + encoding: string; + _links: { /** Format: uri */ - readonly git: string | null; + git: string | null; /** Format: uri */ - readonly html: string | null; + html: string | null; /** Format: uri */ - readonly self: string; + self: string; }; - readonly license: components["schemas"]["nullable-license-simple"]; + license: components["schemas"]["nullable-license-simple"]; }; /** * Merged upstream * @description Results of a successful merge upstream request */ - readonly "merged-upstream": { - readonly message?: string; + "merged-upstream": { + message?: string; /** @enum {string} */ - readonly merge_type?: "merge" | "fast-forward" | "none"; - readonly base_branch?: string; + merge_type?: "merge" | "fast-forward" | "none"; + base_branch?: string; }; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/milestones/v1.0 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels */ - readonly labels_url: string; + labels_url: string; /** @example 1002604 */ - readonly id: number; + id: number; /** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */ - readonly node_id: string; + node_id: string; /** * @description The number of the milestone. * @example 42 */ - readonly number: number; + number: number; /** * @description The state of the milestone. * @default open * @example open * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** * @description The title of the milestone. * @example v1.0 */ - readonly title: string; + title: string; /** @example Tracking milestone for version 1.0 */ - readonly description: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; /** @example 4 */ - readonly open_issues: number; + open_issues: number; /** @example 8 */ - readonly closed_issues: number; + closed_issues: number; /** * Format: date-time * @example 2011-04-10T20:09:31Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2014-03-03T18:58:10Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2013-02-12T13:22:01Z */ - readonly closed_at: string | null; + closed_at: string | null; /** * Format: date-time * @example 2012-10-09T23:39:01Z */ - readonly due_on: string | null; + due_on: string | null; }; /** Pages Source Hash */ - readonly "pages-source-hash": { - readonly branch: string; - readonly path: string; + "pages-source-hash": { + branch: string; + path: string; }; /** Pages Https Certificate */ - readonly "pages-https-certificate": { + "pages-https-certificate": { /** * @example approved * @enum {string} */ - readonly state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed"; + state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed"; /** @example Certificate is approved */ - readonly description: string; + description: string; /** * @description Array of the domain set and its alternate name (if it is configured) * @example [ @@ -32550,1091 +35496,852 @@ export interface components { * "www.example.com" * ] */ - readonly domains: readonly string[]; + domains: string[]; /** Format: date */ - readonly expires_at?: string; + expires_at?: string; }; /** * GitHub Pages * @description The configuration for GitHub Pages for a repository. */ - readonly page: { + page: { /** * Format: uri * @description The API address for accessing this Page resource. * @example https://api.github.com/repos/github/hello-world/pages */ - readonly url: string; + url: string; /** * @description The status of the most recent build of the Page. * @example built * @enum {string|null} */ - readonly status: "built" | "building" | "errored" | null; + status: "built" | "building" | "errored" | null; /** * @description The Pages site's custom domain * @example example.com */ - readonly cname: string | null; + cname: string | null; /** * @description The state if the domain is verified * @example pending * @enum {string|null} */ - readonly protected_domain_state?: "pending" | "verified" | "unverified" | null; + protected_domain_state?: "pending" | "verified" | "unverified" | null; /** * Format: date-time * @description The timestamp when a pending domain becomes unverified. */ - readonly pending_domain_unverified_at?: string | null; + pending_domain_unverified_at?: string | null; /** * @description Whether the Page has a custom 404 page. * @default false * @example false */ - readonly custom_404: boolean; + custom_404: boolean; /** * Format: uri * @description The web address the Page can be accessed from. * @example https://example.com */ - readonly html_url?: string; + html_url?: string; /** * @description The process in which the Page will be built. * @example legacy * @enum {string|null} */ - readonly build_type?: "legacy" | "workflow" | null; - readonly source?: components["schemas"]["pages-source-hash"]; + build_type?: "legacy" | "workflow" | null; + source?: components["schemas"]["pages-source-hash"]; /** * @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. * @example true */ - readonly public: boolean; - readonly https_certificate?: components["schemas"]["pages-https-certificate"]; + public: boolean; + https_certificate?: components["schemas"]["pages-https-certificate"]; /** * @description Whether https is enabled on the domain * @example true */ - readonly https_enforced?: boolean; + https_enforced?: boolean; }; /** * Page Build * @description Page Build */ - readonly "page-build": { + "page-build": { /** Format: uri */ - readonly url: string; - readonly status: string; - readonly error: { - readonly message: string | null; - }; - readonly pusher: components["schemas"]["nullable-simple-user"]; - readonly commit: string; - readonly duration: number; + url: string; + status: string; + error: { + message: string | null; + }; + pusher: components["schemas"]["nullable-simple-user"]; + commit: string; + duration: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** * Page Build Status * @description Page Build Status */ - readonly "page-build-status": { + "page-build-status": { /** * Format: uri * @example https://api.github.com/repos/github/hello-world/pages/builds/latest */ - readonly url: string; + url: string; /** @example queued */ - readonly status: string; + status: string; }; /** * GitHub Pages * @description The GitHub Pages deployment status. */ - readonly "page-deployment": { + "page-deployment": { /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ - readonly id: number | string; + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ - readonly status_url: string; + status_url: string; /** * Format: uri * @description The URI to the deployed GitHub Pages. * @example hello-world.github.io */ - readonly page_url: string; + page_url: string; /** * Format: uri * @description The URI to the deployed GitHub Pages preview. * @example monalisa-1231a2312sa32-23sda74.drafts.github.io */ - readonly preview_url?: string; + preview_url?: string; }; /** GitHub Pages deployment status */ - readonly "pages-deployment-status": { + "pages-deployment-status": { /** * @description The current status of the deployment. * @enum {string} */ - readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; }; /** * Pages Health Check Status * @description Pages Health Check Status */ - readonly "pages-health-check": { - readonly domain?: { - readonly host?: string; - readonly uri?: string; - readonly nameservers?: string; - readonly dns_resolves?: boolean; - readonly is_proxied?: boolean | null; - readonly is_cloudflare_ip?: boolean | null; - readonly is_fastly_ip?: boolean | null; - readonly is_old_ip_address?: boolean | null; - readonly is_a_record?: boolean | null; - readonly has_cname_record?: boolean | null; - readonly has_mx_records_present?: boolean | null; - readonly is_valid_domain?: boolean; - readonly is_apex_domain?: boolean; - readonly should_be_a_record?: boolean | null; - readonly is_cname_to_github_user_domain?: boolean | null; - readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; - readonly is_cname_to_fastly?: boolean | null; - readonly is_pointed_to_github_pages_ip?: boolean | null; - readonly is_non_github_pages_ip_present?: boolean | null; - readonly is_pages_domain?: boolean; - readonly is_served_by_pages?: boolean | null; - readonly is_valid?: boolean; - readonly reason?: string | null; - readonly responds_to_https?: boolean; - readonly enforces_https?: boolean; - readonly https_error?: string | null; - readonly is_https_eligible?: boolean | null; - readonly caa_error?: string | null; - }; - readonly alt_domain?: { - readonly host?: string; - readonly uri?: string; - readonly nameservers?: string; - readonly dns_resolves?: boolean; - readonly is_proxied?: boolean | null; - readonly is_cloudflare_ip?: boolean | null; - readonly is_fastly_ip?: boolean | null; - readonly is_old_ip_address?: boolean | null; - readonly is_a_record?: boolean | null; - readonly has_cname_record?: boolean | null; - readonly has_mx_records_present?: boolean | null; - readonly is_valid_domain?: boolean; - readonly is_apex_domain?: boolean; - readonly should_be_a_record?: boolean | null; - readonly is_cname_to_github_user_domain?: boolean | null; - readonly is_cname_to_pages_dot_github_dot_com?: boolean | null; - readonly is_cname_to_fastly?: boolean | null; - readonly is_pointed_to_github_pages_ip?: boolean | null; - readonly is_non_github_pages_ip_present?: boolean | null; - readonly is_pages_domain?: boolean; - readonly is_served_by_pages?: boolean | null; - readonly is_valid?: boolean; - readonly reason?: string | null; - readonly responds_to_https?: boolean; - readonly enforces_https?: boolean; - readonly https_error?: string | null; - readonly is_https_eligible?: boolean | null; - readonly caa_error?: string | null; + "pages-health-check": { + domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; + }; + alt_domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; } | null; }; /** * Pull Request * @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. */ - readonly "pull-request": { + "pull-request": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - readonly url: string; + url: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - readonly diff_url: string; + diff_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1347.patch */ - readonly patch_url: string; + patch_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly issue_url: string; + issue_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits */ - readonly commits_url: string; + commits_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments */ - readonly review_comments_url: string; + review_comments_url: string; /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - readonly review_comment_url: string; + review_comment_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments */ - readonly comments_url: string; + comments_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly statuses_url: string; + statuses_url: string; /** * @description Number uniquely identifying the pull request within its repository. * @example 42 */ - readonly number: number; + number: number; /** * @description State of this Pull Request. Either `open` or `closed`. * @example open * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @example true */ - readonly locked: boolean; + locked: boolean; /** * @description The title of the pull request. * @example Amazing new feature */ - readonly title: string; - readonly user: components["schemas"]["simple-user"]; + title: string; + user: components["schemas"]["simple-user"]; /** @example Please pull these awesome changes */ - readonly body: string | null; - readonly labels: readonly { + body: string | null; + labels: { /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly url: string; - readonly name: string; - readonly description: string | null; - readonly color: string; - readonly default: boolean; + id: number; + node_id: string; + url: string; + name: string; + description: string | null; + color: string; + default: boolean; }[]; - readonly milestone: components["schemas"]["nullable-milestone"]; + milestone: components["schemas"]["nullable-milestone"]; /** @example too heated */ - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly closed_at: string | null; + closed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly merged_at: string | null; + merged_at: string | null; /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - readonly merge_commit_sha: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null; - readonly requested_teams?: readonly components["schemas"]["team-simple"][] | null; - readonly head: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["simple-user"]; - }; - readonly base: { - readonly label: string; - readonly ref: string; - readonly repo: components["schemas"]["repository"]; - readonly sha: string; - readonly user: components["schemas"]["simple-user"]; - }; - readonly _links: { - readonly comments: components["schemas"]["link"]; - readonly commits: components["schemas"]["link"]; - readonly statuses: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly issue: components["schemas"]["link"]; - readonly review_comments: components["schemas"]["link"]; - readonly review_comment: components["schemas"]["link"]; - readonly self: components["schemas"]["link"]; - }; - readonly author_association: components["schemas"]["author-association"]; - readonly auto_merge: components["schemas"]["auto-merge"]; + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team-simple"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; /** * @description Indicates whether or not the pull request is a draft. * @example false */ - readonly draft?: boolean; - readonly merged: boolean; + draft?: boolean; + merged: boolean; /** @example true */ - readonly mergeable: boolean | null; + mergeable: boolean | null; /** @example true */ - readonly rebaseable?: boolean | null; + rebaseable?: boolean | null; /** @example clean */ - readonly mergeable_state: string; - readonly merged_by: components["schemas"]["nullable-simple-user"]; + mergeable_state: string; + merged_by: components["schemas"]["nullable-simple-user"]; /** @example 10 */ - readonly comments: number; + comments: number; /** @example 0 */ - readonly review_comments: number; + review_comments: number; /** * @description Indicates whether maintainers can modify the pull request. * @example true */ - readonly maintainer_can_modify: boolean; + maintainer_can_modify: boolean; /** @example 3 */ - readonly commits: number; + commits: number; /** @example 100 */ - readonly additions: number; + additions: number; /** @example 3 */ - readonly deletions: number; + deletions: number; /** @example 5 */ - readonly changed_files: number; + changed_files: number; }; /** * Pull Request Merge Result * @description Pull Request Merge Result */ - readonly "pull-request-merge-result": { - readonly sha: string; - readonly merged: boolean; - readonly message: string; + "pull-request-merge-result": { + sha: string; + merged: boolean; + message: string; }; /** * Pull Request Review Request * @description Pull Request Review Request */ - readonly "pull-request-review-request": { - readonly users: readonly components["schemas"]["simple-user"][]; - readonly teams: readonly components["schemas"]["team"][]; + "pull-request-review-request": { + users: components["schemas"]["simple-user"][]; + teams: components["schemas"]["team"][]; }; /** * Pull Request Review * @description Pull Request Reviews are reviews on pull requests. */ - readonly "pull-request-review": { + "pull-request-review": { /** * Format: int64 * @description Unique identifier of the review * @example 42 */ - readonly id: number; + id: number; /** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; + node_id: string; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the review. * @example This looks great. */ - readonly body: string; + body: string; /** @example CHANGES_REQUESTED */ - readonly state: string; + state: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/12 */ - readonly pull_request_url: string; - readonly _links: { - readonly html: { - readonly href: string; + pull_request_url: string; + _links: { + html: { + href: string; }; - readonly pull_request: { - readonly href: string; + pull_request: { + href: string; }; }; /** Format: date-time */ - readonly submitted_at?: string; + submitted_at?: string; /** * @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 */ - readonly commit_id: string | null; - readonly body_html?: string; - readonly body_text?: string; - readonly author_association: components["schemas"]["author-association"]; + commit_id: string | null; + body_html?: string; + body_text?: string; + author_association: components["schemas"]["author-association"]; }; /** * Legacy Review Comment * @description Legacy Review Comment */ - readonly "review-comment": { + "review-comment": { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly url: string; + url: string; /** * Format: int64 * @example 42 */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: int64 * @example 10 */ - readonly id: number; + id: number; /** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */ - readonly node_id: string; + node_id: string; /** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */ - readonly diff_hunk: string; + diff_hunk: string; /** @example file1.txt */ - readonly path: string; + path: string; /** @example 1 */ - readonly position: number | null; + position: number | null; /** @example 4 */ - readonly original_position: number; + original_position: number; /** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly commit_id: string; + commit_id: string; /** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */ - readonly original_commit_id: string; + original_commit_id: string; /** @example 8 */ - readonly in_reply_to_id?: number; - readonly user: components["schemas"]["nullable-simple-user"]; + in_reply_to_id?: number; + user: components["schemas"]["nullable-simple-user"]; /** @example Great stuff */ - readonly body: string; + body: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-04-14T16:00:49Z */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/pulls/1 */ - readonly pull_request_url: string; - readonly author_association: components["schemas"]["author-association"]; - readonly _links: { - readonly self: components["schemas"]["link"]; - readonly html: components["schemas"]["link"]; - readonly pull_request: components["schemas"]["link"]; + pull_request_url: string; + author_association: components["schemas"]["author-association"]; + _links: { + self: components["schemas"]["link"]; + html: components["schemas"]["link"]; + pull_request: components["schemas"]["link"]; }; - readonly body_text?: string; - readonly body_html?: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; + body_text?: string; + body_html?: string; + reactions?: components["schemas"]["reaction-rollup"]; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly line?: number; + line?: number; /** * @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment * @example 2 */ - readonly original_line?: number; + original_line?: number; /** * @description The first line of the range for a multi-line comment. * @example 2 */ - readonly start_line?: number | null; + start_line?: number | null; /** * @description The original first line of the range for a multi-line comment. * @example 2 */ - readonly original_start_line?: number | null; - }; - /** - * Release Asset - * @description Data related to a release. - */ - readonly "release-asset": { - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly browser_download_url: string; - readonly id: number; - readonly node_id: string; - /** - * @description The file name of the asset. - * @example Team Environment - */ - readonly name: string; - readonly label: string | null; + original_start_line?: number | null; /** - * @description State of the release asset. + * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly state: "uploaded" | "open"; - readonly content_type: string; - readonly size: number; - readonly download_count: number; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly updated_at: string; - readonly uploader: components["schemas"]["nullable-simple-user"]; - }; - /** - * Release - * @description A release. - */ - readonly release: { - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly html_url: string; - /** Format: uri */ - readonly assets_url: string; - readonly upload_url: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** Format: uri */ - readonly zipball_url: string | null; - readonly id: number; - readonly node_id: string; - /** - * @description The name of the tag. - * @example v1.0.0 - */ - readonly tag_name: string; - /** - * @description Specifies the commitish value that determines where the Git tag is created from. - * @example master - */ - readonly target_commitish: string; - readonly name: string | null; - readonly body?: string | null; - /** - * @description true to create a draft (unpublished) release, false to create a published one. - * @example false - */ - readonly draft: boolean; - /** - * @description Whether to identify the release as a prerelease or a full release. - * @example false - */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly created_at: string; - /** Format: date-time */ - readonly published_at: string | null; - readonly author: components["schemas"]["simple-user"]; - readonly assets: readonly components["schemas"]["release-asset"][]; - readonly body_html?: string; - readonly body_text?: string; - readonly mentions_count?: number; - /** - * Format: uri - * @description The URL of the release discussion. - */ - readonly discussion_url?: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; }; /** * Generated Release Notes Content * @description Generated name and body describing a release */ - readonly "release-notes-content": { + "release-notes-content": { /** * @description The generated name of the release * @example Release v1.0.0 is now available! */ - readonly name: string; + name: string; /** @description The generated body describing the contents of the release supporting markdown formatting */ - readonly body: string; + body: string; }; /** * repository ruleset data for rule * @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values. */ - readonly "repository-rule-ruleset-info": { + "repository-rule-ruleset-info": { /** * @description The type of source for the ruleset that includes this rule. * @enum {string} */ - readonly ruleset_source_type?: "Repository" | "Organization"; + ruleset_source_type?: "Repository" | "Organization"; /** @description The name of the source of the ruleset that includes this rule. */ - readonly ruleset_source?: string; + ruleset_source?: string; /** @description The ID of the ruleset that includes this rule. */ - readonly ruleset_id?: number; + ruleset_id?: number; }; /** * Repository Rule * @description A repository rule with ruleset details. */ - readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); - readonly "secret-scanning-alert": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]); + "secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - readonly locations_url?: string; - readonly state?: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment to resolve an alert. */ - readonly resolution_comment?: string | null; + resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ - readonly secret_type_display_name?: string; + secret_type_display_name?: string; /** @description The secret that was detected. */ - readonly secret?: string; + secret?: string; /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly push_protection_bypassed_at?: string | null; - readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment when reviewing a push protection bypass. */ - readonly push_protection_bypass_request_reviewer_comment?: string | null; + push_protection_bypass_request_reviewer_comment?: string | null; /** @description An optional comment when requesting a push protection bypass. */ - readonly push_protection_bypass_request_comment?: string | null; + push_protection_bypass_request_comment?: string | null; /** * Format: uri * @description The URL to a push protection bypass request. */ - readonly push_protection_bypass_request_html_url?: string | null; + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ - readonly validity?: "active" | "inactive" | "unknown"; + validity?: "active" | "inactive" | "unknown"; /** @description Whether the detected secret was publicly leaked. */ - readonly publicly_leaked?: boolean | null; + 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; - /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - readonly "secret-scanning-location-commit": { - /** - * @description The file path in the repository - * @example /example/secrets.txt - */ - readonly path: string; - /** @description Line number at which the secret starts in the file */ - readonly start_line: number; - /** @description Line number at which the secret ends in the file */ - readonly end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - readonly start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - readonly end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - readonly blob_sha: string; - /** @description The API URL to get the associated blob resource */ - readonly blob_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - readonly commit_sha: string; - /** @description The API URL to get the associated commit resource */ - readonly commit_url: string; - }; - /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ - readonly "secret-scanning-location-wiki-commit": { - /** - * @description The file path of the wiki page - * @example /example/Home.md - */ - readonly path: string; - /** @description Line number at which the secret starts in the file */ - readonly start_line: number; - /** @description Line number at which the secret ends in the file */ - readonly end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ - readonly start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ - readonly end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - readonly blob_sha: string; - /** - * @description The GitHub URL to get the associated wiki page - * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - readonly page_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - readonly commit_sha: string; - /** - * @description The GitHub URL to get the associated wiki commit - * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - readonly commit_url: string; - }; - /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ - readonly "secret-scanning-location-issue-title": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - readonly issue_title_url: string; - }; - /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ - readonly "secret-scanning-location-issue-body": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - readonly issue_body_url: string; - }; - /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ - readonly "secret-scanning-location-issue-comment": { - /** - * Format: uri - * @description The API URL to get the issue comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - readonly issue_comment_url: string; - }; - /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ - readonly "secret-scanning-location-discussion-title": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082 - */ - readonly discussion_title_url: string; - }; - /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ - readonly "secret-scanning-location-discussion-body": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussion-4566270 - */ - readonly discussion_body_url: string; - }; - /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ - readonly "secret-scanning-location-discussion-comment": { - /** - * Format: uri - * @description The API URL to get the discussion comment where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 - */ - readonly discussion_comment_url: string; - }; - /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ - readonly "secret-scanning-location-pull-request-title": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - readonly pull_request_title_url: string; - }; - /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ - readonly "secret-scanning-location-pull-request-body": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - readonly pull_request_body_url: string; - }; - /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ - readonly "secret-scanning-location-pull-request-comment": { - /** - * Format: uri - * @description The API URL to get the pull request comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - readonly pull_request_comment_url: string; - }; - /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ - readonly "secret-scanning-location-pull-request-review": { - /** - * Format: uri - * @description The API URL to get the pull request review where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - */ - readonly pull_request_review_url: string; - }; - /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ - readonly "secret-scanning-location-pull-request-review-comment": { - /** - * Format: uri - * @description The API URL to get the pull request review comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - */ - readonly pull_request_review_comment_url: string; - }; - readonly "secret-scanning-location": { + multi_repo?: boolean | null; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */ + "secret-scanning-alert-resolution-comment": string | null; + /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */ + "secret-scanning-alert-assignee": string | null; + "secret-scanning-location": { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; + type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; /** * @description The reason for bypassing push protection. * @enum {string} */ - readonly "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; - readonly "secret-scanning-push-protection-bypass": { - readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; + "secret-scanning-push-protection-bypass": { + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** * Format: date-time * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly expire_at?: string | null; + expire_at?: string | null; /** @description The token type this bypass is for. */ - readonly token_type?: string; + token_type?: string; }; /** @description Information on a single scan performed by secret scanning on the repository */ - readonly "secret-scanning-scan": { + "secret-scanning-scan": { /** @description The type of scan */ - readonly type?: string; + type?: string; /** @description The state of the scan. Either "completed", "running", or "pending" */ - readonly status?: string; + status?: string; /** * Format: date-time * @description The time that the scan was completed. Empty if the scan is running */ - readonly completed_at?: string | null; + completed_at?: string | null; /** * Format: date-time * @description The time that the scan was started. Empty if the scan is pending */ - readonly started_at?: string | null; + started_at?: string | null; }; - readonly "secret-scanning-scan-history": { - readonly incremental_scans?: readonly components["schemas"]["secret-scanning-scan"][]; - readonly pattern_update_scans?: readonly components["schemas"]["secret-scanning-scan"][]; - readonly backfill_scans?: readonly components["schemas"]["secret-scanning-scan"][]; - readonly custom_pattern_backfill_scans?: readonly (components["schemas"]["secret-scanning-scan"] & { + "secret-scanning-scan-history": { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { /** @description Name of the custom pattern for custom pattern scans */ - readonly pattern_name?: string; + pattern_name?: string; /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ - readonly pattern_scope?: string; + pattern_scope?: string; })[]; }; - readonly "repository-advisory-create": { + "repository-advisory-create": { /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory impacts. */ - readonly description: string; + description: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id?: string | null; + cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly vulnerabilities: readonly { + vulnerabilities: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name?: string | null; + name?: string | null; }; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range?: string | null; + vulnerable_version_range?: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions?: string | null; + patched_versions?: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions?: readonly string[] | null; + vulnerable_functions?: string[] | null; }[]; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - readonly cwe_ids?: readonly string[] | null; + cwe_ids?: string[] | null; /** @description A list of users receiving credit for their participation in the security advisory. */ - readonly credits?: readonly { + credits?: { /** @description The username of the user credited. */ - readonly login: string; - readonly type: components["schemas"]["security-advisory-credit-types"]; + login: string; + type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - readonly severity?: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - readonly cvss_vector_string?: string | null; + cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - readonly start_private_fork: boolean; + start_private_fork: boolean; }; - readonly "private-vulnerability-report-create": { + "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ - readonly summary: string; + summary: string; /** @description A detailed description of what the advisory impacts. */ - readonly description: string; + description: string; /** @description An array of products affected by the vulnerability detailed in a repository security advisory. */ - readonly vulnerabilities?: readonly { + vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name?: string | null; + name?: string | null; }; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range?: string | null; + vulnerable_version_range?: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions?: string | null; + patched_versions?: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions?: readonly string[] | null; + vulnerable_functions?: string[] | null; }[] | null; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - readonly cwe_ids?: readonly string[] | null; + cwe_ids?: string[] | null; /** * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - readonly severity?: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - readonly cvss_vector_string?: string | null; + cvss_vector_string?: string | null; /** * @description Whether to create a temporary private fork of the repository to collaborate on a fix. * @default false */ - readonly start_private_fork: boolean; + start_private_fork: boolean; }; - readonly "repository-advisory-update": { + "repository-advisory-update": { /** @description A short summary of the advisory. */ - readonly summary?: string; + summary?: string; /** @description A detailed description of what the advisory impacts. */ - readonly description?: string; + description?: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id?: string | null; + cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly vulnerabilities?: readonly { + vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; /** @description The unique package name within its ecosystem. */ - readonly name?: string | null; + name?: string | null; }; /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range?: string | null; + vulnerable_version_range?: string | null; /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions?: string | null; + patched_versions?: string | null; /** @description The functions in the package that are affected. */ - readonly vulnerable_functions?: readonly string[] | null; + vulnerable_functions?: string[] | null; }[]; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - readonly cwe_ids?: readonly string[] | null; + cwe_ids?: string[] | null; /** @description A list of users receiving credit for their participation in the security advisory. */ - readonly credits?: readonly { + credits?: { /** @description The username of the user credited. */ - readonly login: string; - readonly type: components["schemas"]["security-advisory-credit-types"]; + login: string; + type: components["schemas"]["security-advisory-credit-types"]; }[] | null; /** * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - readonly severity?: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - readonly cvss_vector_string?: string | null; + cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ - readonly state?: "published" | "closed" | "draft"; + state?: "published" | "closed" | "draft"; /** @description A list of usernames who have been granted write access to the advisory. */ - readonly collaborating_users?: readonly string[] | null; + collaborating_users?: string[] | null; /** @description A list of team slugs which have been granted write access to the advisory. */ - readonly collaborating_teams?: readonly string[] | null; + collaborating_teams?: string[] | null; }; /** * Stargazer * @description Stargazer */ - readonly stargazer: { + stargazer: { /** Format: date-time */ - readonly starred_at: string; - readonly user: components["schemas"]["nullable-simple-user"]; + starred_at: string; + user: components["schemas"]["nullable-simple-user"]; }; /** * Code Frequency Stat * @description Code Frequency Stat */ - readonly "code-frequency-stat": readonly number[]; + "code-frequency-stat": number[]; /** * Commit Activity * @description Commit Activity */ - readonly "commit-activity": { + "commit-activity": { /** * @example [ * 0, @@ -33646,20 +36353,20 @@ export interface components { * 0 * ] */ - readonly days: readonly number[]; + days: number[]; /** @example 89 */ - readonly total: number; + total: number; /** @example 1336280400 */ - readonly week: number; + week: number; }; /** * Contributor Activity * @description Contributor Activity */ - readonly "contributor-activity": { - readonly author: components["schemas"]["nullable-simple-user"]; + "contributor-activity": { + author: components["schemas"]["nullable-simple-user"]; /** @example 135 */ - readonly total: number; + total: number; /** * @example [ * { @@ -33670,486 +36377,475 @@ export interface components { * } * ] */ - readonly weeks: readonly { - readonly w?: number; - readonly a?: number; - readonly d?: number; - readonly c?: number; + weeks: { + w?: number; + a?: number; + d?: number; + c?: number; }[]; }; /** Participation Stats */ - readonly "participation-stats": { - readonly all: readonly number[]; - readonly owner: readonly number[]; + "participation-stats": { + all: number[]; + owner: number[]; }; /** * Repository Invitation * @description Repository invitations let you manage who you collaborate with. */ - readonly "repository-subscription": { + "repository-subscription": { /** * @description Determines if notifications should be received from this repository. * @example true */ - readonly subscribed: boolean; + subscribed: boolean; /** @description Determines if all notifications should be blocked from this repository. */ - readonly ignored: boolean; - readonly reason: string | null; + ignored: boolean; + reason: string | null; /** * Format: date-time * @example 2012-10-06T21:34:12Z */ - readonly created_at: string; + created_at: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example/subscription */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/repos/octocat/example */ - readonly repository_url: string; + repository_url: string; }; /** * Tag * @description Tag */ - readonly tag: { + tag: { /** @example v0.1 */ - readonly name: string; - readonly commit: { - readonly sha: string; + name: string; + commit: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Format: uri * @example https://github.com/octocat/Hello-World/zipball/v0.1 */ - readonly zipball_url: string; + zipball_url: string; /** * Format: uri * @example https://github.com/octocat/Hello-World/tarball/v0.1 */ - readonly tarball_url: string; - readonly node_id: string; - }; - /** - * Tag protection - * @description Tag protection - */ - readonly "tag-protection": { - /** @example 2 */ - readonly id?: number; - /** @example 2011-01-26T19:01:12Z */ - readonly created_at?: string; - /** @example 2011-01-26T19:01:12Z */ - readonly updated_at?: string; - /** @example true */ - readonly enabled?: boolean; - /** @example v1.* */ - readonly pattern: string; + tarball_url: string; + node_id: string; }; /** * Topic * @description A topic aggregates entities that are related to a subject. */ - readonly topic: { - readonly names: readonly string[]; + topic: { + names: string[]; }; /** Traffic */ - readonly traffic: { + traffic: { /** Format: date-time */ - readonly timestamp: string; - readonly uniques: number; - readonly count: number; + timestamp: string; + uniques: number; + count: number; }; /** * Clone Traffic * @description Clone Traffic */ - readonly "clone-traffic": { + "clone-traffic": { /** @example 173 */ - readonly count: number; + count: number; /** @example 128 */ - readonly uniques: number; - readonly clones: readonly components["schemas"]["traffic"][]; + uniques: number; + clones: components["schemas"]["traffic"][]; }; /** * Content Traffic * @description Content Traffic */ - readonly "content-traffic": { + "content-traffic": { /** @example /github/hubot */ - readonly path: string; + path: string; /** @example github/hubot: A customizable life embetterment robot. */ - readonly title: string; + title: string; /** @example 3542 */ - readonly count: number; + count: number; /** @example 2225 */ - readonly uniques: number; + uniques: number; }; /** * Referrer Traffic * @description Referrer Traffic */ - readonly "referrer-traffic": { + "referrer-traffic": { /** @example Google */ - readonly referrer: string; + referrer: string; /** @example 4 */ - readonly count: number; + count: number; /** @example 3 */ - readonly uniques: number; + uniques: number; }; /** * View Traffic * @description View Traffic */ - readonly "view-traffic": { + "view-traffic": { /** @example 14850 */ - readonly count: number; + count: number; /** @example 3782 */ - readonly uniques: number; - readonly views: readonly components["schemas"]["traffic"][]; + uniques: number; + views: components["schemas"]["traffic"][]; }; /** Search Result Text Matches */ - readonly "search-result-text-matches": readonly { - readonly object_url?: string; - readonly object_type?: string | null; - readonly property?: string; - readonly fragment?: string; - readonly matches?: readonly { - readonly text?: string; - readonly indices?: readonly number[]; + "search-result-text-matches": { + object_url?: string; + object_type?: string | null; + property?: string; + fragment?: string; + matches?: { + text?: string; + indices?: number[]; }[]; }[]; /** * Code Search Result Item * @description Code Search Result Item */ - readonly "code-search-result-item": { - readonly name: string; - readonly path: string; - readonly sha: string; + "code-search-result-item": { + name: string; + path: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** Format: uri */ - readonly html_url: string; - readonly repository: components["schemas"]["minimal-repository"]; - readonly score: number; - readonly file_size?: number; - readonly language?: string | null; + html_url: string; + repository: components["schemas"]["minimal-repository"]; + score: number; + file_size?: number; + language?: string | null; /** Format: date-time */ - readonly last_modified_at?: string; + last_modified_at?: string; /** * @example [ * "73..77", * "77..78" * ] */ - readonly line_numbers?: readonly string[]; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + line_numbers?: string[]; + text_matches?: components["schemas"]["search-result-text-matches"]; }; /** * Commit Search Result Item * @description Commit Search Result Item */ - readonly "commit-search-result-item": { + "commit-search-result-item": { /** Format: uri */ - readonly url: string; - readonly sha: string; + url: string; + sha: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly comments_url: string; - readonly commit: { - readonly author: { - readonly name: string; - readonly email: string; + comments_url: string; + commit: { + author: { + name: string; + email: string; /** Format: date-time */ - readonly date: string; + date: string; }; - readonly committer: components["schemas"]["nullable-git-user"]; - readonly comment_count: number; - readonly message: string; - readonly tree: { - readonly sha: string; + committer: components["schemas"]["nullable-git-user"]; + comment_count: number; + message: string; + tree: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly url: string; - readonly verification?: components["schemas"]["verification"]; - }; - readonly author: components["schemas"]["nullable-simple-user"]; - readonly committer: components["schemas"]["nullable-git-user"]; - readonly parents: readonly { - readonly url?: string; - readonly html_url?: string; - readonly sha?: string; + url: string; + verification?: components["schemas"]["verification"]; + }; + author: components["schemas"]["nullable-simple-user"]; + committer: components["schemas"]["nullable-git-user"]; + parents: { + url?: string; + html_url?: string; + sha?: string; }[]; - readonly repository: components["schemas"]["minimal-repository"]; - readonly score: number; - readonly node_id: string; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + repository: components["schemas"]["minimal-repository"]; + score: number; + node_id: string; + text_matches?: components["schemas"]["search-result-text-matches"]; }; /** * Issue Search Result Item * @description Issue Search Result Item */ - readonly "issue-search-result-item": { + "issue-search-result-item": { /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly repository_url: string; - readonly labels_url: string; + repository_url: string; + labels_url: string; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly title: string; - readonly locked: boolean; - readonly active_lock_reason?: string | null; - readonly assignees?: readonly components["schemas"]["simple-user"][] | null; - readonly user: components["schemas"]["nullable-simple-user"]; - readonly labels: readonly { + id: number; + node_id: string; + number: number; + title: string; + locked: boolean; + active_lock_reason?: string | null; + assignees?: components["schemas"]["simple-user"][] | null; + user: components["schemas"]["nullable-simple-user"]; + labels: { /** Format: int64 */ - readonly id?: number; - readonly node_id?: string; - readonly url?: string; - readonly name?: string; - readonly color?: string; - readonly default?: boolean; - readonly description?: string | null; + id?: number; + node_id?: string; + url?: string; + name?: string; + color?: string; + default?: boolean; + description?: string | null; }[]; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; - readonly state: string; - readonly state_reason?: string | null; - readonly assignee: components["schemas"]["nullable-simple-user"]; - readonly milestone: components["schemas"]["nullable-milestone"]; - readonly comments: number; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + state: string; + state_reason?: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + milestone: components["schemas"]["nullable-milestone"]; + comments: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly closed_at: string | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly pull_request?: { + closed_at: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + pull_request?: { /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly diff_url: string | null; + diff_url: string | null; /** Format: uri */ - readonly html_url: string | null; + html_url: string | null; /** Format: uri */ - readonly patch_url: string | null; + patch_url: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; - readonly body?: string; - readonly score: number; - readonly author_association: components["schemas"]["author-association"]; - readonly draft?: boolean; - readonly repository?: components["schemas"]["repository"]; - readonly body_html?: string; - readonly body_text?: string; + body?: string; + score: number; + author_association: components["schemas"]["author-association"]; + draft?: boolean; + repository?: components["schemas"]["repository"]; + body_html?: string; + body_text?: string; /** Format: uri */ - readonly timeline_url?: string; - readonly performed_via_github_app?: components["schemas"]["nullable-integration"]; - readonly reactions?: components["schemas"]["reaction-rollup"]; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Label Search Result Item * @description Label Search Result Item */ - readonly "label-search-result-item": { - readonly id: number; - readonly node_id: string; + "label-search-result-item": { + id: number; + node_id: string; /** Format: uri */ - readonly url: string; - readonly name: string; - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly score: number; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; + url: string; + name: string; + color: string; + default: boolean; + description: string | null; + score: number; + text_matches?: components["schemas"]["search-result-text-matches"]; }; /** * Repo Search Result Item * @description Repo Search Result Item */ - readonly "repo-search-result-item": { - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly full_name: string; - readonly owner: components["schemas"]["nullable-simple-user"]; - readonly private: boolean; + "repo-search-result-item": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["nullable-simple-user"]; + private: boolean; /** Format: uri */ - readonly html_url: string; - readonly description: string | null; - readonly fork: boolean; + html_url: string; + description: string | null; + fork: boolean; /** Format: uri */ - readonly url: string; + url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: date-time */ - readonly pushed_at: string; + pushed_at: string; /** Format: uri */ - readonly homepage: string | null; - readonly size: number; - readonly stargazers_count: number; - readonly watchers_count: number; - readonly language: string | null; - readonly forks_count: number; - readonly open_issues_count: number; - readonly master_branch?: string; - readonly default_branch: string; - readonly score: number; + homepage: string | null; + size: number; + stargazers_count: number; + watchers_count: number; + language: string | null; + forks_count: number; + open_issues_count: number; + master_branch?: string; + default_branch: string; + score: number; /** Format: uri */ - readonly forks_url: string; - readonly keys_url: string; - readonly collaborators_url: string; + forks_url: string; + keys_url: string; + collaborators_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri */ - readonly hooks_url: string; - readonly issue_events_url: string; + hooks_url: string; + issue_events_url: string; /** Format: uri */ - readonly events_url: string; - readonly assignees_url: string; - readonly branches_url: string; + events_url: string; + assignees_url: string; + branches_url: string; /** Format: uri */ - readonly tags_url: string; - readonly blobs_url: string; - readonly git_tags_url: string; - readonly git_refs_url: string; - readonly trees_url: string; - readonly statuses_url: string; + tags_url: string; + blobs_url: string; + git_tags_url: string; + git_refs_url: string; + trees_url: string; + statuses_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; - readonly commits_url: string; - readonly git_commits_url: string; - readonly comments_url: string; - readonly issue_comment_url: string; - readonly contents_url: string; - readonly compare_url: string; + subscription_url: string; + commits_url: string; + git_commits_url: string; + comments_url: string; + issue_comment_url: string; + contents_url: string; + compare_url: string; /** Format: uri */ - readonly merges_url: string; - readonly archive_url: string; + merges_url: string; + archive_url: string; /** Format: uri */ - readonly downloads_url: string; - readonly issues_url: string; - readonly pulls_url: string; - readonly milestones_url: string; - readonly notifications_url: string; - readonly labels_url: string; - readonly releases_url: string; + downloads_url: string; + issues_url: string; + pulls_url: string; + milestones_url: string; + notifications_url: string; + labels_url: string; + releases_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly git_url: string; - readonly ssh_url: string; - readonly clone_url: string; + deployments_url: string; + git_url: string; + ssh_url: string; + clone_url: string; /** Format: uri */ - readonly svn_url: string; - readonly forks: number; - readonly open_issues: number; - readonly watchers: number; - readonly topics?: readonly string[]; + svn_url: string; + forks: number; + open_issues: number; + watchers: number; + topics?: string[]; /** Format: uri */ - readonly mirror_url: string | null; - readonly has_issues: boolean; - readonly has_projects: boolean; - readonly has_pages: boolean; - readonly has_wiki: boolean; - readonly has_downloads: boolean; - readonly has_discussions?: boolean; - readonly archived: boolean; + mirror_url: string | null; + has_issues: boolean; + has_projects: boolean; + has_pages: boolean; + has_wiki: boolean; + has_downloads: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** @description The repository visibility: public, private, or internal. */ - readonly visibility?: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly temp_clone_token?: string; - readonly allow_merge_commit?: boolean; - readonly allow_squash_merge?: boolean; - readonly allow_rebase_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_forking?: boolean; - readonly is_template?: boolean; + visibility?: string; + license: components["schemas"]["nullable-license-simple"]; + permissions?: { + admin: boolean; + maintain?: boolean; + push: boolean; + triage?: boolean; + pull: boolean; + }; + text_matches?: components["schemas"]["search-result-text-matches"]; + temp_clone_token?: string; + allow_merge_commit?: boolean; + allow_squash_merge?: boolean; + allow_rebase_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_forking?: boolean; + is_template?: boolean; /** @example false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; /** * Topic Search Result Item * @description Topic Search Result Item */ - readonly "topic-search-result-item": { - readonly name: string; - readonly display_name: string | null; - readonly short_description: string | null; - readonly description: string | null; - readonly created_by: string | null; - readonly released: string | null; + "topic-search-result-item": { + name: string; + display_name: string | null; + short_description: string | null; + description: string | null; + created_by: string | null; + released: string | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly updated_at: string; - readonly featured: boolean; - readonly curated: boolean; - readonly score: number; - readonly repository_count?: number | null; + updated_at: string; + featured: boolean; + curated: boolean; + score: number; + repository_count?: number | null; /** Format: uri */ - readonly logo_url?: string | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly related?: readonly { - readonly topic_relation?: { - readonly id?: number; - readonly name?: string; - readonly topic_id?: number; - readonly relation_type?: string; + logo_url?: string | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + related?: { + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; }; }[] | null; - readonly aliases?: readonly { - readonly topic_relation?: { - readonly id?: number; - readonly name?: string; - readonly topic_id?: number; - readonly relation_type?: string; + aliases?: { + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; }; }[] | null; }; @@ -34157,466 +36853,466 @@ export interface components { * User Search Result Item * @description User Search Result Item */ - readonly "user-search-result-item": { - readonly login: string; + "user-search-result-item": { + login: string; /** Format: int64 */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** Format: uri */ - readonly avatar_url: string; - readonly gravatar_id: string | null; + avatar_url: string; + gravatar_id: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly followers_url: string; + followers_url: string; /** Format: uri */ - readonly subscriptions_url: string; + subscriptions_url: string; /** Format: uri */ - readonly organizations_url: string; + organizations_url: string; /** Format: uri */ - readonly repos_url: string; + repos_url: string; /** Format: uri */ - readonly received_events_url: string; - readonly type: string; - readonly score: number; - readonly following_url: string; - readonly gists_url: string; - readonly starred_url: string; - readonly events_url: string; - readonly public_repos?: number; - readonly public_gists?: number; - readonly followers?: number; - readonly following?: number; + received_events_url: string; + type: string; + score: number; + following_url: string; + gists_url: string; + starred_url: string; + events_url: string; + public_repos?: number; + public_gists?: number; + followers?: number; + following?: number; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** Format: date-time */ - readonly updated_at?: string; - readonly name?: string | null; - readonly bio?: string | null; + updated_at?: string; + name?: string | null; + bio?: string | null; /** Format: email */ - readonly email?: string | null; - readonly location?: string | null; - readonly site_admin: boolean; - readonly hireable?: boolean | null; - readonly text_matches?: components["schemas"]["search-result-text-matches"]; - readonly blog?: string | null; - readonly company?: string | null; + email?: string | null; + location?: string | null; + site_admin: boolean; + hireable?: boolean | null; + text_matches?: components["schemas"]["search-result-text-matches"]; + blog?: string | null; + company?: string | null; /** Format: date-time */ - readonly suspended_at?: string | null; - readonly user_view_type?: string; + suspended_at?: string | null; + user_view_type?: string; }; /** * Private User * @description Private User */ - readonly "private-user": { + "private-user": { /** @example octocat */ - readonly login: string; + login: string; /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ - readonly user_view_type: "private"; + user_view_type: "private"; /** @example MDQ6VXNlcjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; + gravatar_id: string | null; /** * Format: uri * @example https://api.github.com/users/octocat */ - readonly url: string; + url: string; /** * Format: uri * @example https://github.com/octocat */ - readonly html_url: string; + html_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/followers */ - readonly followers_url: string; + followers_url: string; /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; + following_url: string; /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; + gists_url: string; /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; + starred_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/subscriptions */ - readonly subscriptions_url: string; + subscriptions_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/orgs */ - readonly organizations_url: string; + organizations_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/repos */ - readonly repos_url: string; + repos_url: string; /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example https://api.github.com/users/octocat/received_events */ - readonly received_events_url: string; + received_events_url: string; /** @example User */ - readonly type: string; - readonly site_admin: boolean; + type: string; + site_admin: boolean; /** @example monalisa octocat */ - readonly name: string | null; + name: string | null; /** @example GitHub */ - readonly company: string | null; + company: string | null; /** @example https://github.com/blog */ - readonly blog: string | null; + blog: string | null; /** @example San Francisco */ - readonly location: string | null; + location: string | null; /** * Format: email * @example octocat@github.com */ - readonly email: string | null; + email: string | null; /** * Format: email * @example octocat@github.com */ - readonly notification_email?: string | null; - readonly hireable: boolean | null; + notification_email?: string | null; + hireable: boolean | null; /** @example There once was... */ - readonly bio: string | null; + bio: string | null; /** @example monalisa */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** @example 2 */ - readonly public_repos: number; + public_repos: number; /** @example 1 */ - readonly public_gists: number; + public_gists: number; /** @example 20 */ - readonly followers: number; + followers: number; /** @example 0 */ - readonly following: number; + following: number; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2008-01-14T04:33:35Z */ - readonly updated_at: string; + updated_at: string; /** @example 81 */ - readonly private_gists: number; + private_gists: number; /** @example 100 */ - readonly total_private_repos: number; + total_private_repos: number; /** @example 100 */ - readonly owned_private_repos: number; + owned_private_repos: number; /** @example 10000 */ - readonly disk_usage: number; + disk_usage: number; /** @example 8 */ - readonly collaborators: number; + collaborators: number; /** @example true */ - readonly two_factor_authentication: boolean; - readonly plan?: { - readonly collaborators: number; - readonly name: string; - readonly space: number; - readonly private_repos: number; + two_factor_authentication: boolean; + plan?: { + collaborators: number; + name: string; + space: number; + private_repos: number; }; - readonly business_plus?: boolean; - readonly ldap_dn?: string; + business_plus?: boolean; + ldap_dn?: string; }; /** * Codespaces Secret * @description Secrets for a GitHub Codespace. */ - readonly "codespaces-secret": { + "codespaces-secret": { /** * @description The name of the secret * @example SECRET_NAME */ - readonly name: string; + name: string; /** * Format: date-time * @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - readonly updated_at: string; + updated_at: string; /** * @description The type of repositories in the organization that the secret is visible to * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** * Format: uri * @description The API URL at which the list of repositories this secret is visible to can be retrieved * @example https://api.github.com/user/secrets/SECRET_NAME/repositories */ - readonly selected_repositories_url: string; + selected_repositories_url: string; }; /** * CodespacesUserPublicKey * @description The public key used for setting user Codespaces' Secrets. */ - readonly "codespaces-user-public-key": { + "codespaces-user-public-key": { /** * @description The identifier for the key. * @example 1234567 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= */ - readonly key: string; + key: string; }; /** * Fetches information about an export of a codespace. * @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest */ - readonly "codespace-export-details": { + "codespace-export-details": { /** * @description State of the latest export * @example succeeded | failed | in_progress */ - readonly state?: string | null; + state?: string | null; /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - readonly completed_at?: string | null; + completed_at?: string | null; /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - readonly branch?: string | null; + branch?: string | null; /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - readonly sha?: string | null; + sha?: string | null; /** * @description Id for the export details * @example latest */ - readonly id?: string; + id?: string; /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - readonly export_url?: string; + export_url?: string; /** * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ - readonly html_url?: string | null; + html_url?: string | null; }; /** * Codespace * @description A codespace. */ - readonly "codespace-with-full-repository": { + "codespace-with-full-repository": { /** * Format: int64 * @example 1 */ - readonly id: number; + id: number; /** * @description Automatically generated name of this codespace. * @example monalisa-octocat-hello-world-g4wpq6h95q */ - readonly name: string; + name: string; /** * @description Display name for this codespace. * @example bookish space pancake */ - readonly display_name?: string | null; + display_name?: string | null; /** * @description UUID identifying this codespace's environment. * @example 26a7c758-7299-4a73-b978-5a92a7ae98a0 */ - readonly environment_id: string | null; - readonly owner: components["schemas"]["simple-user"]; - readonly billable_owner: components["schemas"]["simple-user"]; - readonly repository: components["schemas"]["full-repository"]; - readonly machine: components["schemas"]["nullable-codespace-machine"]; + environment_id: string | null; + owner: components["schemas"]["simple-user"]; + billable_owner: components["schemas"]["simple-user"]; + repository: components["schemas"]["full-repository"]; + machine: components["schemas"]["nullable-codespace-machine"]; /** * @description Path to devcontainer.json from repo root used to create Codespace. * @example .devcontainer/example/devcontainer.json */ - readonly devcontainer_path?: string | null; + devcontainer_path?: string | null; /** * @description Whether the codespace was created from a prebuild. * @example false */ - readonly prebuild: boolean | null; + prebuild: boolean | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time * @description Last known time this codespace was started. * @example 2011-01-26T19:01:12Z */ - readonly last_used_at: string; + last_used_at: string; /** * @description State of this codespace. * @example Available * @enum {string} */ - readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; + state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding"; /** * Format: uri * @description API URL for this codespace. */ - readonly url: string; + url: string; /** @description Details about the codespace's git repository. */ - readonly git_status: { + git_status: { /** * @description The number of commits the local repository is ahead of the remote. * @example 0 */ - readonly ahead?: number; + ahead?: number; /** * @description The number of commits the local repository is behind the remote. * @example 0 */ - readonly behind?: number; + behind?: number; /** @description Whether the local repository has unpushed changes. */ - readonly has_unpushed_changes?: boolean; + has_unpushed_changes?: boolean; /** @description Whether the local repository has uncommitted changes. */ - readonly has_uncommitted_changes?: boolean; + has_uncommitted_changes?: boolean; /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - readonly ref?: string; + ref?: string; }; /** * @description The initally assigned location of a new codespace. * @example WestUs2 * @enum {string} */ - readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; + location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2"; /** * @description The number of minutes of inactivity after which this codespace will be automatically stopped. * @example 60 */ - readonly idle_timeout_minutes: number | null; + idle_timeout_minutes: number | null; /** * Format: uri * @description URL to access this codespace on the web. */ - readonly web_url: string; + web_url: string; /** * Format: uri * @description API URL to access available alternate machine types for this codespace. */ - readonly machines_url: string; + machines_url: string; /** * Format: uri * @description API URL to start this codespace. */ - readonly start_url: string; + start_url: string; /** * Format: uri * @description API URL to stop this codespace. */ - readonly stop_url: string; + stop_url: string; /** * Format: uri * @description API URL to publish this codespace to a new repository. */ - readonly publish_url?: string | null; + publish_url?: string | null; /** * Format: uri * @description API URL for the Pull Request associated with this codespace, if any. */ - readonly pulls_url: string | null; - readonly recent_folders: readonly string[]; - readonly runtime_constraints?: { + pulls_url: string | null; + recent_folders: string[]; + runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - readonly allowed_port_privacy_settings?: readonly string[] | null; + allowed_port_privacy_settings?: string[] | null; }; /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ - readonly pending_operation?: boolean | null; + pending_operation?: boolean | null; /** @description Text to show user when codespace is disabled by a pending operation */ - readonly pending_operation_disabled_reason?: string | null; + pending_operation_disabled_reason?: string | null; /** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */ - readonly idle_timeout_notice?: string | null; + idle_timeout_notice?: string | null; /** * @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). * @example 60 */ - readonly retention_period_minutes?: number | null; + retention_period_minutes?: number | null; /** * Format: date-time * @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at" * @example 2011-01-26T20:01:12Z */ - readonly retention_expires_at?: string | null; + retention_expires_at?: string | null; }; /** * Email * @description Email */ - readonly email: { + email: { /** * Format: email * @example octocat@github.com */ - readonly email: string; + email: string; /** @example true */ - readonly primary: boolean; + primary: boolean; /** @example true */ - readonly verified: boolean; + verified: boolean; /** @example public */ - readonly visibility: string | null; + visibility: string | null; }; /** * GPG Key * @description A unique encryption key */ - readonly "gpg-key": { + "gpg-key": { /** * Format: int64 * @example 3 */ - readonly id: number; + id: number; /** @example Octocat's GPG Key */ - readonly name?: string | null; - readonly primary_key_id: number | null; + name?: string | null; + primary_key_id: number | null; /** @example 3262EFF25BA0D270 */ - readonly key_id: string; + key_id: string; /** @example xsBNBFayYZ... */ - readonly public_key: string; + public_key: string; /** * @example [ * { @@ -34625,9 +37321,9 @@ export interface components { * } * ] */ - readonly emails: readonly { - readonly email?: string; - readonly verified?: boolean; + emails: { + email?: string; + verified?: boolean; }[]; /** * @example [ @@ -34647,185 +37343,256 @@ export interface components { * } * ] */ - readonly subkeys: readonly { + subkeys: { /** Format: int64 */ - readonly id?: number; - readonly primary_key_id?: number; - readonly key_id?: string; - readonly public_key?: string; - readonly emails?: readonly { - readonly email?: string; - readonly verified?: boolean; + id?: number; + primary_key_id?: number; + key_id?: string; + public_key?: string; + emails?: { + email?: string; + verified?: boolean; }[]; - readonly subkeys?: readonly unknown[]; - readonly can_sign?: boolean; - readonly can_encrypt_comms?: boolean; - readonly can_encrypt_storage?: boolean; - readonly can_certify?: boolean; - readonly created_at?: string; - readonly expires_at?: string | null; - readonly raw_key?: string | null; - readonly revoked?: boolean; + subkeys?: unknown[]; + can_sign?: boolean; + can_encrypt_comms?: boolean; + can_encrypt_storage?: boolean; + can_certify?: boolean; + created_at?: string; + expires_at?: string | null; + raw_key?: string | null; + revoked?: boolean; }[]; /** @example true */ - readonly can_sign: boolean; - readonly can_encrypt_comms: boolean; - readonly can_encrypt_storage: boolean; + can_sign: boolean; + can_encrypt_comms: boolean; + can_encrypt_storage: boolean; /** @example true */ - readonly can_certify: boolean; + can_certify: boolean; /** * Format: date-time * @example 2016-03-24T11:31:04-06:00 */ - readonly created_at: string; + created_at: string; /** Format: date-time */ - readonly expires_at: string | null; + expires_at: string | null; /** @example true */ - readonly revoked: boolean; - readonly raw_key: string | null; + revoked: boolean; + raw_key: string | null; }; /** * Key * @description Key */ - readonly key: { - readonly key: string; + key: { + key: string; /** Format: int64 */ - readonly id: number; - readonly url: string; - readonly title: string; + id: number; + url: string; + title: string; + /** Format: date-time */ + created_at: string; + verified: boolean; + read_only: boolean; /** Format: date-time */ - readonly created_at: string; - readonly verified: boolean; - readonly read_only: boolean; + last_used?: string | null; }; /** Marketplace Account */ - readonly "marketplace-account": { + "marketplace-account": { /** Format: uri */ - readonly url: string; - readonly id: number; - readonly type: string; - readonly node_id?: string; - readonly login: string; + url: string; + id: number; + type: string; + node_id?: string; + login: string; /** Format: email */ - readonly email?: string | null; + email?: string | null; /** Format: email */ - readonly organization_billing_email?: string | null; + organization_billing_email?: string | null; }; /** * User Marketplace Purchase * @description User Marketplace Purchase */ - readonly "user-marketplace-purchase": { + "user-marketplace-purchase": { /** @example monthly */ - readonly billing_cycle: string; + billing_cycle: string; /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - readonly next_billing_date: string | null; - readonly unit_count: number | null; + next_billing_date: string | null; + unit_count: number | null; /** @example true */ - readonly on_free_trial: boolean; + on_free_trial: boolean; /** * Format: date-time * @example 2017-11-11T00:00:00Z */ - readonly free_trial_ends_on: string | null; + free_trial_ends_on: string | null; /** * Format: date-time * @example 2017-11-02T01:12:12Z */ - readonly updated_at: string | null; - readonly account: components["schemas"]["marketplace-account"]; - readonly plan: components["schemas"]["marketplace-listing-plan"]; + updated_at: string | null; + account: components["schemas"]["marketplace-account"]; + plan: components["schemas"]["marketplace-listing-plan"]; }; /** * Social account * @description Social media account */ - readonly "social-account": { + "social-account": { /** @example linkedin */ - readonly provider: string; + provider: string; /** @example https://www.linkedin.com/company/github/ */ - readonly url: string; + url: string; }; /** * SSH Signing Key * @description A public SSH key used to sign Git commits */ - readonly "ssh-signing-key": { - readonly key: string; - readonly id: number; - readonly title: string; + "ssh-signing-key": { + key: string; + id: number; + title: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; }; /** * Starred Repository * @description Starred Repository */ - readonly "starred-repository": { + "starred-repository": { /** Format: date-time */ - readonly starred_at: string; - readonly repo: components["schemas"]["repository"]; - }; - /** - * Sigstore Bundle v0.1 - * @description Sigstore Bundle v0.1 - */ - readonly "sigstore-bundle-0": { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly x509CertificateChain?: { - readonly certificates?: readonly { - readonly rawBytes?: string; - }[]; - }; - readonly tlogEntries?: readonly { - readonly logIndex?: string; - readonly logId?: { - readonly keyId?: string; - }; - readonly kindVersion?: { - readonly kind?: string; - readonly version?: string; - }; - readonly integratedTime?: string; - readonly inclusionPromise?: { - readonly signedEntryTimestamp?: string; - }; - readonly inclusionProof?: string | null; - readonly canonicalizedBody?: string; - }[]; - readonly timestampVerificationData?: string | null; - }; - readonly dsseEnvelope?: { - readonly payload?: string; - readonly payloadType?: string; - readonly signatures?: readonly { - readonly sig?: string; - readonly keyid?: string; - }[]; - }; + starred_at: string; + repo: components["schemas"]["repository"]; }; /** * Hovercard * @description Hovercard */ - readonly hovercard: { - readonly contexts: readonly { - readonly message: string; - readonly octicon: string; + hovercard: { + contexts: { + message: string; + octicon: string; }[]; }; /** * Key Simple * @description Key Simple */ - readonly "key-simple": { - readonly id: number; - readonly key: string; + "key-simple": { + id: number; + key: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + last_used?: string | null; + }; + "billing-premium-request-usage-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report-user": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; /** * Enterprise @@ -34833,48 +37600,48 @@ export interface components { * on an enterprise account or an organization that's part of an enterprise account. For more information, * see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)." */ - readonly "enterprise-webhooks": { + "enterprise-webhooks": { /** @description A short description of the enterprise. */ - readonly description?: string | null; + description?: string | null; /** * Format: uri * @example https://github.com/enterprises/octo-business */ - readonly html_url: string; + html_url: string; /** * Format: uri * @description The enterprise's website URL. */ - readonly website_url?: string | null; + website_url?: string | null; /** * @description Unique identifier of the enterprise * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the enterprise. * @example Octo Business */ - readonly name: string; + name: string; /** * @description The slug url identifier for the enterprise. * @example octo-business */ - readonly slug: string; + slug: string; /** * Format: date-time * @example 2019-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2019-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** Format: uri */ - readonly avatar_url: string; + avatar_url: string; }; /** * Simple Installation @@ -34882,440 +37649,451 @@ export interface components { * for and sent to a GitHub App. For more information, * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." */ - readonly "simple-installation": { + "simple-installation": { /** * @description The ID of the installation. * @example 1 */ - readonly id: number; + id: number; /** * @description The global node ID of the installation. * @example MDQ6VXNlcjU4MzIzMQ== */ - readonly node_id: string; + node_id: string; }; /** * Organization Simple * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an * organization, or when the event occurs from activity in a repository owned by an organization. */ - readonly "organization-simple-webhooks": { + "organization-simple-webhooks": { /** @example github */ - readonly login: string; + login: string; /** @example 1 */ - readonly id: number; + id: number; /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + node_id: string; /** * Format: uri * @example https://api.github.com/orgs/github */ - readonly url: string; + url: string; /** * Format: uri * @example https://api.github.com/orgs/github/repos */ - readonly repos_url: string; + repos_url: string; /** * Format: uri * @example https://api.github.com/orgs/github/events */ - readonly events_url: string; + events_url: string; /** @example https://api.github.com/orgs/github/hooks */ - readonly hooks_url: string; + hooks_url: string; /** @example https://api.github.com/orgs/github/issues */ - readonly issues_url: string; + issues_url: string; /** @example https://api.github.com/orgs/github/members{/member} */ - readonly members_url: string; + members_url: string; /** @example https://api.github.com/orgs/github/public_members{/member} */ - readonly public_members_url: string; + public_members_url: string; /** @example https://github.com/images/error/octocat_happy.gif */ - readonly avatar_url: string; + avatar_url: string; /** @example A great organization */ - readonly description: string | null; + description: string | null; }; /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ - readonly "repository-webhooks": { + "repository-webhooks": { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; + allow_rebase_merge: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + 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; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -35323,7 +38101,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -35332,7 +38110,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -35340,7 +38118,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -35349,42 +38127,42 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; } | null; - readonly temp_clone_token?: string; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -35392,7 +38170,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -35401,7 +38179,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -35409,7 +38187,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -35418,2228 +38196,2192 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; }; /** * 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. */ - readonly webhooks_rule: { - readonly admin_enforced: boolean; + webhooks_rule: { + admin_enforced: boolean; /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: readonly string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; /** Format: date-time */ - readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; - readonly id: number; - readonly ignore_approvals_from_contributors: boolean; + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; /** * @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone. * @enum {string} */ - readonly lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; + lock_branch_enforcement_level: "off" | "non_admins" | "everyone"; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */ - readonly lock_allows_fork_sync?: boolean; + lock_allows_fork_sync?: boolean; /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - readonly name: string; + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; + require_last_push_approval?: boolean; + required_approving_review_count: number; /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: readonly string[]; + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; /** @enum {string} */ - readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; /** @enum {string} */ - readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; + signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + strict_required_status_checks_policy: boolean; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; }; /** @description A suite of checks performed on the code of a given code change */ - readonly "simple-check-suite": { + "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - readonly after?: string | null; - readonly app?: components["schemas"]["integration"]; + after?: string | null; + app?: components["schemas"]["integration"]; /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - readonly before?: string | null; + before?: string | null; /** * @example neutral * @enum {string|null} */ - readonly conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; /** Format: date-time */ - readonly created_at?: string; + created_at?: string; /** @example master */ - readonly head_branch?: string | null; + head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha?: string; + head_sha?: string; /** @example 5 */ - readonly id?: number; + id?: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - readonly node_id?: string; - readonly pull_requests?: readonly components["schemas"]["pull-request-minimal"][]; - readonly repository?: components["schemas"]["minimal-repository"]; + node_id?: string; + pull_requests?: components["schemas"]["pull-request-minimal"][]; + repository?: components["schemas"]["minimal-repository"]; /** * @example completed * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; + status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; /** Format: date-time */ - readonly updated_at?: string; + updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - readonly url?: string; + url?: string; }; /** * CheckRun * @description A check performed on the code of a given code change */ - readonly "check-run-with-simple-check-suite": { - readonly app: components["schemas"]["nullable-integration"]; - readonly check_suite: components["schemas"]["simple-check-suite"]; + "check-run-with-simple-check-suite": { + app: components["schemas"]["integration"]; + check_suite: components["schemas"]["simple-check-suite"]; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly completed_at: string | null; + completed_at: string | null; /** * @example neutral * @enum {string|null} */ - readonly conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; - readonly deployment?: components["schemas"]["deployment-simple"]; + conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; + deployment?: components["schemas"]["deployment-simple"]; /** @example https://example.com */ - readonly details_url: string; + details_url: string; /** @example 42 */ - readonly external_id: string; + external_id: string; /** * @description The SHA of the commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - readonly head_sha: string; + head_sha: string; /** @example https://github.com/github/hello-world/runs/4 */ - readonly html_url: string; + html_url: string; /** * @description The id of the check. * @example 21 */ - readonly id: number; + id: number; /** * @description The name of the check. * @example test-coverage */ - readonly name: string; + name: string; /** @example MDg6Q2hlY2tSdW40 */ - readonly node_id: string; - readonly output: { - readonly annotations_count: number; + node_id: string; + output: { + annotations_count: number; /** Format: uri */ - readonly annotations_url: string; - readonly summary: string | null; - readonly text: string | null; - readonly title: string | null; + annotations_url: string; + summary: string | null; + text: string | null; + title: string | null; }; - readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][]; + pull_requests: components["schemas"]["pull-request-minimal"][]; /** * Format: date-time * @example 2018-05-04T01:14:52Z */ - readonly started_at: string; + started_at: string; /** * @description The phase of the lifecycle that the check is currently in. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "pending"; + status: "queued" | "in_progress" | "completed" | "pending"; /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ - readonly url: string; + url: string; }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly webhooks_code_scanning_commit_oid: string; + webhooks_code_scanning_commit_oid: string; /** @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 webhooks_code_scanning_ref: string; + webhooks_code_scanning_ref: string; /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - readonly webhooks_deploy_pusher_type: string; + webhooks_deploy_pusher_type: string; /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - readonly webhooks_ref_0: string; + webhooks_ref_0: string; /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - readonly webhooks_deploy_key: { - readonly added_by?: string | null; - readonly created_at: string; - readonly id: number; - readonly key: string; - readonly last_used?: string | null; - readonly read_only: boolean; - readonly title: string; + webhooks_deploy_key: { + added_by?: string | null; + created_at: string; + id: number; + key: string; + last_used?: string | null; + read_only: boolean; + title: string; /** Format: uri */ - readonly url: string; - readonly verified: boolean; - readonly enabled?: boolean; + url: string; + verified: boolean; + enabled?: boolean; }; /** Workflow */ - readonly webhooks_workflow: { + webhooks_workflow: { /** Format: uri */ - readonly badge_url: string; + badge_url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly webhooks_approver: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; - }; - readonly webhooks_reviewers: readonly { + /** + * Deployment + * @description A request for a specific ref(branch,sha,tag) to be deployed + */ + "nullable-deployment": { + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1 + */ + url: string; + /** + * Format: int64 + * @description Unique identifier of the deployment + * @example 42 + */ + id: number; + /** @example MDEwOkRlcGxveW1lbnQx */ + node_id: string; + /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ + sha: string; + /** + * @description The ref to deploy. This can be a branch, tag, or sha. + * @example topic-branch + */ + ref: string; + /** + * @description Parameter to specify a task to execute + * @example deploy + */ + task: string; + payload: { + [key: string]: unknown; + } | string; + /** @example staging */ + original_environment?: string; + /** + * @description Name for the target deployment environment. + * @example production + */ + environment: string; + /** @example Deploy request from hubot */ + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + created_at: string; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + */ + statuses_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example + */ + repository_url: string; + /** + * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. + * @example true + */ + transient_environment?: boolean; + /** + * @description Specifies if the given environment is one that end-users directly interact with. Default: false. + * @example true + */ + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + } | null; + webhooks_approver: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; + webhooks_reviewers: { /** User */ - readonly reviewer?: { + reviewer?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** @enum {string} */ - readonly type?: "User"; + type?: "User"; }[]; - readonly webhooks_workflow_job_run: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: unknown; - readonly status: string; - readonly updated_at: string; + webhooks_workflow_job_run: { + conclusion: unknown; + created_at: string; + environment: string; + html_url: string; + id: number; + name: unknown; + status: string; + updated_at: string; }; /** User */ - readonly webhooks_user: { + webhooks_user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly webhooks_answer: { + webhooks_answer: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - readonly body: string; - readonly child_comment_count: number; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; /** Format: date-time */ - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: unknown; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: unknown; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly repository_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** User */ - readonly user: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - }; - /** - * Discussion - * @description A Discussion in a repository. - */ - readonly discussion: { - readonly active_lock_reason: string | null; - readonly answer_chosen_at: string | null; - /** User */ - readonly answer_chosen_by: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; - /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; - } | null; - readonly answer_html_url: string | null; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - readonly body: string; - readonly category: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - readonly comments: number; - /** Format: date-time */ - readonly created_at: string; - readonly html_url: string; - readonly id: number; - readonly locked: boolean; - readonly node_id: string; - readonly number: number; - /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; - readonly timeline_url?: string; - readonly title: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly labels?: readonly components["schemas"]["label"][]; }; - readonly webhooks_comment: { + webhooks_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: number | null; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly repository_url: string; - readonly updated_at: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + updated_at: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Label */ - readonly webhooks_label: { + webhooks_label: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }; /** @description An array of repository objects that the installation can access. */ - readonly webhooks_repositories: readonly { - readonly full_name: string; + webhooks_repositories: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[]; /** @description An array of repository objects, which were added to the installation. */ - readonly webhooks_repositories_added: readonly { - readonly full_name: string; + webhooks_repositories_added: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[]; /** * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - readonly webhooks_repository_selection: "all" | "selected"; + webhooks_repository_selection: "all" | "selected"; /** * issue comment * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ - readonly webhooks_issue_comment: { + webhooks_issue_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ - readonly body: string; + body: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the issue comment */ - readonly id: number; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly node_id: string; - readonly performed_via_github_app: components["schemas"]["integration"]; + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["integration"]; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** @description The changes to the comment. */ - readonly webhooks_changes: { - readonly body?: { + webhooks_changes: { + body?: { /** @description The previous version of the body. */ - readonly from: string; + from: string; }; }; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly webhooks_issue: { + webhooks_issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly webhooks_milestone: { + webhooks_milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly webhooks_issue_2: { + webhooks_issue_2: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** User */ - readonly webhooks_user_mannequin: { + webhooks_user_mannequin: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Marketplace Purchase */ - readonly webhooks_marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly (string | null)[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + webhooks_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: (string | null)[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; /** Marketplace Purchase */ - readonly webhooks_previous_marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + webhooks_previous_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: unknown; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly webhooks_team: { - readonly deleted?: boolean; + webhooks_team: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + notification_setting: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Merge Group * @description A group of pull requests that the merge queue has grouped together to be merged. */ - readonly "merge-group": { + "merge-group": { /** @description The SHA of the merge group. */ - readonly head_sha: string; + head_sha: string; /** @description The full ref of the merge group. */ - readonly head_ref: string; + head_ref: string; /** @description The SHA of the merge group's parent commit. */ - readonly base_sha: string; + base_sha: string; /** @description The full ref of the branch the merge group will be merged into. */ - readonly base_ref: string; - readonly head_commit: components["schemas"]["simple-commit"]; + base_ref: string; + head_commit: components["schemas"]["simple-commit"]; }; /** * Repository * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property * when the event occurs from activity in a repository. */ - readonly "nullable-repository-webhooks": { + "nullable-repository-webhooks": { /** * Format: int64 * @description Unique identifier of the repository * @example 42 */ - readonly id: number; + id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + node_id: string; /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** * @description Whether the repository is private or public. * @default false */ - readonly private: boolean; + private: boolean; /** * Format: uri * @example https://github.com/octocat/Hello-World */ - readonly html_url: string; + html_url: string; /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + description: string | null; + fork: boolean; /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World */ - readonly url: string; + url: string; /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; + archive_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; + assignees_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; + blobs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; + branches_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; + collaborators_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; + comments_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; + commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; + compare_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + contents_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly contributors_url: string; + contributors_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly deployments_url: string; + deployments_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly downloads_url: string; + downloads_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly events_url: string; + events_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly forks_url: string; + forks_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; + git_commits_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; + git_refs_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; + git_tags_url: string; /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; + git_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; + issue_comment_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; + issue_events_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; + issues_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; + keys_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + labels_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly languages_url: string; + languages_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly merges_url: string; + merges_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; + milestones_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; + notifications_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; + pulls_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; + releases_url: string; /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + ssh_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly stargazers_url: string; + stargazers_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + statuses_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly subscribers_url: string; + subscribers_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly subscription_url: string; + subscription_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly tags_url: string; + tags_url: string; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly teams_url: string; + teams_url: string; /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; + trees_url: string; /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + clone_url: string; /** * Format: uri * @example git:git.example.com/octocat/Hello-World */ - readonly mirror_url: string | null; + mirror_url: string | null; /** * Format: uri * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly hooks_url: string; + hooks_url: string; /** * Format: uri * @example https://svn.github.com/octocat/Hello-World */ - readonly svn_url: string; + svn_url: string; /** * Format: uri * @example https://github.com */ - readonly homepage: string | null; - readonly language: string | null; + homepage: string | null; + language: string | null; /** @example 9 */ - readonly forks_count: number; + forks_count: number; /** @example 80 */ - readonly stargazers_count: number; + stargazers_count: number; /** @example 80 */ - readonly watchers_count: number; + watchers_count: number; /** * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ - readonly size: number; + size: number; /** * @description The default branch of the repository. * @example master */ - readonly default_branch: string; + default_branch: string; /** @example 0 */ - readonly open_issues_count: number; + open_issues_count: number; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template: boolean; - readonly topics?: readonly string[]; + is_template: boolean; + topics?: string[]; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + has_wiki: boolean; + has_pages: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + disabled: boolean; /** * @description The repository visibility: public, private, or internal. * @default public */ - readonly visibility: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + updated_at: string | null; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: readonly string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; + allow_rebase_merge: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + 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; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -37647,7 +40389,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -37656,7 +40398,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -37664,7 +40406,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -37673,42 +40415,42 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; } | null; - readonly temp_clone_token?: string; + temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge: boolean; + allow_squash_merge: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. * @default false * @example false */ - readonly allow_update_branch: boolean; + allow_update_branch: boolean; /** * @deprecated * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** * @description The default value for a squash merge commit title: * @@ -37716,7 +40458,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -37725,7 +40467,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -37733,7 +40475,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -37742,522 +40484,523 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to require contributors to sign off on web-based commits * @default false */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; + starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; + anonymous_access_enabled?: boolean; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly webhooks_milestone_3: { + webhooks_milestone_3: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** * Membership * @description The membership between the user and the organization. Not present when the action is `member_invited`. */ - readonly webhooks_membership: { + webhooks_membership: { /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; + organization_url: string; + role: string; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; + state: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Personal Access Token Request * @description Details of a Personal Access Token Request. */ - readonly "personal-access-token-request": { + "personal-access-token-request": { /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ - readonly id: number; - readonly owner: components["schemas"]["simple-user"]; + id: number; + owner: components["schemas"]["simple-user"]; /** @description New requested permissions, categorized by type of permission. */ - readonly permissions_added: { - readonly organization?: { - readonly [key: string]: string; + permissions_added: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ - readonly permissions_upgraded: { - readonly organization?: { - readonly [key: string]: string; + permissions_upgraded: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ - readonly permissions_result: { - readonly organization?: { - readonly [key: string]: string; + permissions_result: { + organization?: { + [key: string]: string; }; - readonly repository?: { - readonly [key: string]: string; + repository?: { + [key: string]: string; }; - readonly other?: { - readonly [key: string]: string; + other?: { + [key: string]: string; }; }; /** * @description Type of repository selection requested. * @enum {string} */ - readonly repository_selection: "none" | "all" | "subset"; + repository_selection: "none" | "all" | "subset"; /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repository_count: number | null; + repository_count: number | null; /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repositories: readonly { - readonly full_name: string; + repositories: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[] | null; /** @description Date and time when the request for access was created. */ - readonly created_at: string; + 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; + 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; + token_name: string; /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; + token_expired: boolean; /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; + token_expires_at: string | null; /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + token_last_used_at: string | null; }; /** Project Card */ - readonly webhooks_project_card: { - readonly after_id?: number | null; + webhooks_project_card: { + after_id?: number | null; /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; + archived: boolean; + column_id: number; /** Format: uri */ - readonly column_url: string; + column_url: string; /** Format: uri */ - readonly content_url?: string; + content_url?: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; + id: number; + node_id: string; + note: string | null; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Project */ - readonly webhooks_project: { + webhooks_project: { /** @description Body of the project */ - readonly body: string | null; + body: string | null; /** Format: uri */ - readonly columns_url: string; + columns_url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; + name: string; + node_id: string; + number: number; /** Format: uri */ - readonly owner_url: string; + owner_url: string; /** * @description State of the project; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Project Column */ - readonly webhooks_project_column: { - readonly after_id?: number | null; + webhooks_project_column: { + after_id?: number | null; /** Format: uri */ - readonly cards_url: string; + cards_url: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The unique identifier of the project column */ - readonly id: number; + id: number; /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - readonly "projects-v2": { - readonly id: number; - readonly node_id: string; - readonly owner: components["schemas"]["simple-user"]; - readonly creator: components["schemas"]["simple-user"]; - readonly title: string; - readonly description: string | null; - readonly public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly updated_at: string; - readonly number: number; - readonly short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly deleted_at: string | null; - readonly deleted_by: components["schemas"]["nullable-simple-user"]; - }; - readonly webhooks_project_changes: { - readonly archived_at?: { + webhooks_project_changes: { + archived_at?: { /** Format: date-time */ - readonly from?: string | null; + from?: string | null; /** Format: date-time */ - readonly to?: string | null; + to?: string | null; }; }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; /** * Projects v2 Item * @description An item belonging to a project */ - readonly "projects-v2-item": { - readonly id: number; - readonly node_id?: string; - readonly project_node_id?: string; - readonly content_node_id: string; - readonly content_type: components["schemas"]["projects-v2-item-content-type"]; - readonly creator?: components["schemas"]["simple-user"]; + "projects-v2-item": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The node ID of the project that contains this item. */ + project_node_id?: string; + /** @description The node ID of the content represented by this item. */ + content_node_id: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the item was created. * @example 2022-04-28T12:00:00Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time + * @description The time when the item was last updated. * @example 2022-04-28T12:00:00Z */ - readonly updated_at: string; + updated_at: string; /** * Format: date-time + * @description The time when the item was archived. * @example 2022-04-28T12:00:00Z */ - readonly archived_at: string | null; + archived_at: string | null; }; /** * Projects v2 Single Select Option * @description An option for a single select field */ - readonly "projects-v2-single-select-option": { - readonly id: string; - readonly name: string; - readonly color?: string | null; - readonly description?: string | null; + "projects-v2-single-select-option": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option. */ + name: string; + /** @description The color associated with the option. */ + color?: string | null; + /** @description A short description of the option. */ + description?: string | null; }; /** * Projects v2 Iteration Setting * @description An iteration setting for an iteration field */ - readonly "projects-v2-iteration-setting": { - readonly id: string; - readonly title: string; - readonly duration?: number | null; - readonly start_date?: string | null; + "projects-v2-iteration-setting": { + /** @description The unique identifier of the iteration setting. */ + id: string; + /** @description The iteration title. */ + title: string; + /** @description The iteration title, rendered as HTML. */ + title_html?: string; + /** @description The duration of the iteration in days. */ + duration?: number | null; + /** @description The start date of the iteration. */ + start_date?: string | null; + /** @description Whether the iteration has been completed. */ + completed?: boolean; }; /** * Projects v2 Status Update * @description An status update belonging to a project */ - readonly "projects-v2-status-update": { - readonly id: number; - readonly node_id: string; - readonly project_node_id?: string; - readonly creator?: components["schemas"]["simple-user"]; + "projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the status update was created. * @example 2022-04-28T12:00:00Z */ - readonly created_at: string; + created_at: string; /** * Format: date-time + * @description The time when the status update was last updated. * @example 2022-04-28T12:00:00Z */ - readonly updated_at: string; - /** @enum {string|null} */ - readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** * Format: date + * @description The start date of the period covered by the update. * @example 2022-04-28 */ - readonly start_date?: string; + start_date?: string; /** * Format: date + * @description The target date associated with the update. * @example 2022-04-28 */ - readonly target_date?: string; + target_date?: string; /** * @description Body of the status update * @example The project is off to a great start! */ - readonly body?: string | null; + body?: string | null; }; /** @description The pull request number. */ - readonly webhooks_number: number; - readonly "pull-request-webhook": components["schemas"]["pull-request"] & { + webhooks_number: number; + "pull-request-webhook": components["schemas"]["pull-request"] & { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; + allow_update_branch?: boolean; /** * @description Whether to delete head branches when pull requests are merged. * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** * @description The default value for a merge commit message. * - `PR_TITLE` - default to the pull request's title. @@ -38265,14 +41008,14 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * - `PR_TITLE` - default to the pull request's title. * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a squash merge commit message: * - `PR_BODY` - default to the pull request's body. @@ -38280,349 +41023,359 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * - `PR_TITLE` - default to the pull request's title. * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + 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 is closing down. Please use `squash_merge_commit_title` instead.** * @default false */ - readonly use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default: boolean; }; /** Pull Request */ - readonly webhooks_pull_request_5: { - readonly _links: { + webhooks_pull_request_5: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -38631,7 +41384,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -38639,76 +41392,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -38717,7 +41470,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -38725,250 +41478,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - readonly use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -38977,7 +41740,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -38985,76 +41748,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -39063,7 +41826,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -39071,444 +41834,444 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash merge commit can use the pull request title as default. * @default false */ - readonly use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ - readonly webhooks_review_comment: { - readonly _links: { + webhooks_review_comment: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -39516,138 +42279,138 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; + original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; /** Format: uri */ - readonly url: string; + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** @description The review that was affected. */ - readonly webhooks_review: { - readonly _links: { + webhooks_review: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -39655,653 +42418,666 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the review. */ - readonly body: string | null; + body: string | null; /** @description A commit SHA for the review. */ - readonly commit_id: string; + commit_id: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** Format: uri */ - readonly pull_request_url: string; - readonly state: string; + pull_request_url: string; + state: string; + /** Format: date-time */ + submitted_at: string | null; /** Format: date-time */ - readonly submitted_at: string | null; + updated_at?: string | null; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly webhooks_nullable_string: string | null; + webhooks_nullable_string: string | null; /** * Release * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ - readonly webhooks_release: { - readonly assets: readonly { + webhooks_release: { + assets: { /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + browser_download_url: string; + content_type: string; /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; + created_at: string; + download_count: number; + id: number; + label: string | null; /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + name: string; + node_id: string; + size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded"; + state: "uploaded"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly uploader?: { + uploader?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly url: string; + url: string; }[]; /** Format: uri */ - readonly assets_url: string; + assets_url: string; /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ - readonly discussion_url?: string; + discussion_url?: string; /** @description Whether the release is a draft or published */ - readonly draft: boolean; + draft: boolean; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; + html_url: string; + id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; + name: string | null; + node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; + prerelease: boolean; /** Format: date-time */ - readonly published_at: string | null; + published_at: string | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** Format: uri */ - readonly tarball_url: string | null; + tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; + target_commitish: string; /** Format: uri-template */ - readonly upload_url: string; + upload_url: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly zipball_url: string | null; + zipball_url: string | null; }; /** * Release * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ - readonly webhooks_release_1: { - readonly assets: readonly ({ + webhooks_release_1: { + assets: ({ /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + browser_download_url: string; + content_type: string; /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; + created_at: string; + download_count: number; + id: number; + label: string | null; /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + name: string; + node_id: string; + size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded"; + state: "uploaded"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly uploader?: { + uploader?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; /** Format: uri */ - readonly assets_url: string; + assets_url: string; /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: uri */ - readonly discussion_url?: string; + discussion_url?: string; /** @description Whether the release is a draft or published */ - readonly draft: boolean; + draft: boolean; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; + html_url: string; + id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; + name: string | null; + node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; + prerelease: boolean; /** Format: date-time */ - readonly published_at: string | null; + published_at: string | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** Format: uri */ - readonly tarball_url: string | null; + tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; + target_commitish: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri-template */ - readonly upload_url: string; + upload_url: string; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly zipball_url: string | null; + zipball_url: string | null; }; /** * Repository Vulnerability Alert Alert * @description The security alert of the vulnerable dependency. */ - readonly webhooks_alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; + webhooks_alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; /** User */ - readonly dismisser?: { + dismisser?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly external_identifier: string; + external_identifier: string; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; + external_reference: string | null; + fix_reason?: string; /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - readonly state: "open"; + state: "auto_dismissed" | "open"; }; /** * @description The reason for resolving the alert. * @enum {string|null} */ - readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; - readonly "secret-scanning-alert-webhook": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; + "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; + "secret-scanning-alert-webhook": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - readonly locations_url?: string; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + locations_url?: string; + resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment to resolve an alert. */ - readonly resolution_comment?: string | null; + resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; + secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ - readonly secret_type_display_name?: string; + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} */ - readonly validity?: "active" | "inactive" | "unknown"; + validity?: "active" | "inactive" | "unknown"; /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly push_protection_bypassed_at?: string | null; - readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment when reviewing a push protection bypass. */ - readonly push_protection_bypass_request_reviewer_comment?: string | null; + push_protection_bypass_request_reviewer_comment?: string | null; /** @description An optional comment when requesting a push protection bypass. */ - readonly push_protection_bypass_request_comment?: string | null; + push_protection_bypass_request_comment?: string | null; /** * Format: uri * @description The URL to a push protection bypass request. */ - readonly push_protection_bypass_request_html_url?: string | null; + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ - readonly publicly_leaked?: boolean | null; + 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; + multi_repo?: boolean | null; + assigned_to?: components["schemas"]["nullable-simple-user"]; }; /** @description The details of the security advisory, including summary, description, and severity. */ - readonly webhooks_security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly cwes: readonly { - readonly cwe_id: string; - readonly name: string; + webhooks_security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + cwes: { + cwe_id: string; + name: string; }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: readonly { - readonly type: string; - readonly value: string; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; }[]; - readonly published_at: string; - readonly references: readonly { + published_at: string; + references: { /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: readonly { - readonly first_patched_version: { - readonly identifier: string; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; + package: { + ecosystem: string; + name: string; }; - readonly severity: string; - readonly vulnerable_version_range: string; + severity: string; + vulnerable_version_range: string; }[]; - readonly withdrawn_at: string | null; - }; - readonly webhooks_sponsorship: { - readonly created_at: string; - readonly maintainer?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; - }; - readonly node_id: string; - readonly privacy_level: string; + withdrawn_at: string | null; + }; + webhooks_sponsorship: { + created_at: string; + maintainer?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; + node_id: string; + privacy_level: string; /** User */ - readonly sponsor: { + sponsor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** User */ - readonly sponsorable: { + sponsorable: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Sponsorship Tier * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + tier: { + created_at: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; }; }; /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - readonly webhooks_effective_date: string; - readonly webhooks_changes_8: { - readonly tier: { + webhooks_effective_date: string; + webhooks_changes_8: { + tier: { /** * Sponsorship Tier * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - readonly from: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + from: { + created_at: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; }; }; }; @@ -40309,14583 +43085,15980 @@ export interface components { * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly webhooks_team_1: { - readonly deleted?: boolean; + webhooks_team_1: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + notification_setting: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** branch protection configuration disabled event */ - readonly "webhook-branch-protection-configuration-disabled": { + "webhook-branch-protection-configuration-disabled": { /** @enum {string} */ - readonly action: "disabled"; - 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"]; + action: "disabled"; + 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"]; }; /** branch protection configuration enabled event */ - readonly "webhook-branch-protection-configuration-enabled": { + "webhook-branch-protection-configuration-enabled": { /** @enum {string} */ - readonly action: "enabled"; - 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"]; + action: "enabled"; + 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"]; }; /** branch protection rule created event */ - readonly "webhook-branch-protection-rule-created": { + "webhook-branch-protection-rule-created": { /** @enum {string} */ - readonly action: "created"; - 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 rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule deleted event */ - readonly "webhook-branch-protection-rule-deleted": { + "webhook-branch-protection-rule-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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 rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user"]; }; /** branch protection rule edited event */ - readonly "webhook-branch-protection-rule-edited": { + "webhook-branch-protection-rule-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description If the action was `edited`, the changes to the rule. */ - readonly changes?: { - readonly admin_enforced?: { - readonly from: boolean | null; + changes?: { + admin_enforced?: { + from: boolean | null; }; - readonly authorized_actor_names?: { - readonly from: readonly string[]; + authorized_actor_names?: { + from: string[]; }; - readonly authorized_actors_only?: { - readonly from: boolean | null; + authorized_actors_only?: { + from: boolean | null; }; - readonly authorized_dismissal_actors_only?: { - readonly from: boolean | null; + authorized_dismissal_actors_only?: { + from: boolean | null; }; - readonly linear_history_requirement_enforcement_level?: { + linear_history_requirement_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; - readonly lock_branch_enforcement_level?: { + lock_branch_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; - readonly lock_allows_fork_sync?: { - readonly from: boolean | null; + lock_allows_fork_sync?: { + from: boolean | null; }; - readonly pull_request_reviews_enforcement_level?: { + pull_request_reviews_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; - readonly require_last_push_approval?: { - readonly from: boolean | null; + require_last_push_approval?: { + from: boolean | null; }; - readonly required_status_checks?: { - readonly from: readonly string[]; + required_status_checks?: { + from: string[]; }; - readonly required_status_checks_enforcement_level?: { + required_status_checks_enforcement_level?: { /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; + from: "off" | "non_admins" | "everyone"; }; }; - 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 rule: components["schemas"]["webhooks_rule"]; - readonly sender: components["schemas"]["simple-user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user"]; }; /** Check Run Completed Event */ - readonly "webhook-check-run-completed": { + "webhook-check-run-completed": { /** @enum {string} */ - readonly action?: "completed"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - 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"]; + action?: "completed"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Completed Event * @description The check_run.completed webhook encoded with URL encoding */ - readonly "webhook-check-run-completed-form-encoded": { + "webhook-check-run-completed-form-encoded": { /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** Check Run Created Event */ - readonly "webhook-check-run-created": { + "webhook-check-run-created": { /** @enum {string} */ - readonly action?: "created"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - 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"]; + action?: "created"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Created Event * @description The check_run.created webhook encoded with URL encoding */ - readonly "webhook-check-run-created-form-encoded": { + "webhook-check-run-created-form-encoded": { /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** Check Run Requested Action Event */ - readonly "webhook-check-run-requested-action": { + "webhook-check-run-requested-action": { /** @enum {string} */ - readonly action: "requested_action"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + action: "requested_action"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** @description The action requested by the user. */ - readonly requested_action?: { + requested_action?: { /** @description The integrator reference of the action requested by the user. */ - readonly identifier?: string; + identifier?: string; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Requested Action Event * @description The check_run.requested_action webhook encoded with URL encoding */ - readonly "webhook-check-run-requested-action-form-encoded": { + "webhook-check-run-requested-action-form-encoded": { /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** Check Run Re-Requested Event */ - readonly "webhook-check-run-rerequested": { + "webhook-check-run-rerequested": { /** @enum {string} */ - readonly action?: "rerequested"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - 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"]; + action?: "rerequested"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** * Check Run Re-Requested Event * @description The check_run.rerequested webhook encoded with URL encoding */ - readonly "webhook-check-run-rerequested-form-encoded": { + "webhook-check-run-rerequested-form-encoded": { /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** check_suite completed event */ - readonly "webhook-check-suite-completed": { + "webhook-check-suite-completed": { /** @enum {string} */ - readonly action: "completed"; + action: "completed"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; + check_suite: { + after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly app: { + app: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The client ID of the GitHub app */ - readonly client_id?: string | null; + client_id?: string | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; }; - readonly before: string | null; + before: string | null; /** Format: uri */ - readonly check_runs_url: string; + check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL that points to the check suite API resource. */ - readonly url: string; + url: string; }; - 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"]; + 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"]; }; /** check_suite requested event */ - readonly "webhook-check-suite-requested": { + "webhook-check-suite-requested": { /** @enum {string} */ - readonly action: "requested"; + action: "requested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; + check_suite: { + after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly app: { + app: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description Client ID of the GitHub app */ - readonly client_id?: string | null; + client_id?: string | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; /** @enum {string} */ - readonly actions?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + artifact_metadata?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + attestations?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + copilot_requests?: "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + merge_queues?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + models?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly pages?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + packages?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; }; - readonly before: string | null; + before: string | null; /** Format: uri */ - readonly check_runs_url: string; + check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; + status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL that points to the check suite API resource. */ - readonly url: string; + url: string; }; - 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"]; + 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"]; }; /** check_suite rerequested event */ - readonly "webhook-check-suite-rerequested": { + "webhook-check-suite-rerequested": { /** @enum {string} */ - readonly action: "rerequested"; + action: "rerequested"; /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; + check_suite: { + after: string | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly app: { + app: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The Client ID for the GitHub app */ - readonly client_id?: string | null; + client_id?: string | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + artifact_metadata?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + attestations?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + copilot_requests?: "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + merge_queues?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + models?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; }; - readonly before: string | null; + before: string | null; /** Format: uri */ - readonly check_runs_url: string; + check_runs_url: string; /** * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. * @enum {string|null} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; + status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL that points to the check suite API resource. */ - readonly url: string; + url: string; }; - 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"]; + 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"]; }; /** code_scanning_alert appeared_in_branch event */ - readonly "webhook-code-scanning-alert-appeared-in-branch": { + "webhook-code-scanning-alert-appeared-in-branch": { /** @enum {string} */ - readonly action: "appeared_in_branch"; + action: "appeared_in_branch"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; + dismissed_at: string | null; /** User */ - readonly dismissed_by: { + dismissed_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; + description: string; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; + id: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; + severity: "none" | "note" | "warning" | "error" | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed" | null; - readonly tool: { + state: "open" | "dismissed" | "fixed" | null; + tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert closed_by_user event */ - readonly "webhook-code-scanning-alert-closed-by-user": { + "webhook-code-scanning-alert-closed-by-user": { /** @enum {string} */ - readonly action: "closed_by_user"; + action: "closed_by_user"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string; + dismissed_at: string; /** User */ - readonly dismissed_by: { + dismissed_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "dismissed" | "fixed"; - readonly tool: { - readonly guid?: string | null; + state: "dismissed" | "fixed"; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; + /** User */ + dismissal_approved_by?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert created event */ - readonly "webhook-code-scanning-alert-created": { + "webhook-code-scanning-alert-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string | null; + created_at: string | null; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_at: unknown; + dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; + dismissed_reason: unknown; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; - readonly instances_url?: string; + html_url: string; + instances_url?: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "dismissed" | null; - readonly tool: { - readonly guid?: string | null; + state: "open" | "dismissed" | null; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; } | null; - readonly updated_at?: string | null; + updated_at?: string | null; /** Format: uri */ - readonly url: string; + url: string; + dismissal_approved_by?: unknown; + assignees?: components["schemas"]["simple-user"][]; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert fixed event */ - readonly "webhook-code-scanning-alert-fixed": { + "webhook-code-scanning-alert-fixed": { /** @enum {string} */ - readonly action: "fixed"; + action: "fixed"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** * Format: date-time * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; + dismissed_at: string | null; /** User */ - readonly dismissed_by: { + dismissed_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** * @description The reason for dismissing or closing the alert. * @enum {string|null} */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Format: uri */ - readonly instances_url?: string; + instances_url?: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "fixed" | null; - readonly tool: { - readonly guid?: string | null; + state: "fixed" | null; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened event */ - readonly "webhook-code-scanning-alert-reopened": { + "webhook-code-scanning-alert-reopened": { /** @enum {string} */ - readonly action: "reopened"; + action: "reopened"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; - readonly dismissed_by: Record | null; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_at: string | null; + dismissed_by: Record | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: string | null; + dismissed_reason: string | null; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; + instances_url?: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; + description: string; + full_description?: string; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; + help_uri?: string | null; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; + id: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: readonly string[] | null; + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "dismissed" | "fixed" | null; - readonly tool: { - readonly guid?: string | null; + state: "open" | "dismissed" | "fixed" | null; + tool: { + guid?: string | null; /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; + updated_at?: string | null; /** Format: uri */ - readonly url: string; - } | null; + url: string; + dismissal_approved_by?: unknown; + }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + commit_oid: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string | null; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + ref: string | null; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** code_scanning_alert reopened_by_user event */ - readonly "webhook-code-scanning-alert-reopened-by-user": { + "webhook-code-scanning-alert-reopened-by-user": { /** @enum {string} */ - readonly action: "reopened_by_user"; + action: "reopened_by_user"; /** @description The code scanning alert involved in the event. */ - readonly alert: { + alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - readonly created_at: string; + created_at: string; /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + dismissed_at: unknown; + dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; + dismissed_reason: unknown; /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly fixed_at?: unknown; + fixed_at?: unknown; /** * Format: uri * @description The GitHub URL of the alert resource. */ - readonly html_url: string; + html_url: string; /** Alert Instance */ - readonly most_recent_instance?: { + most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; + analysis_key: string; /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: readonly string[]; - readonly commit_sha?: string; + category?: string; + classifications?: string[]; + commit_sha?: string; /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; - readonly message?: { - readonly text?: string; + message?: { + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; + ref: string; /** * @description State of a code scanning alert. * @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; + state: "open" | "dismissed" | "fixed"; } | null; /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { + number: number; + rule: { /** @description A short description of the rule used to detect the alert. */ - readonly description: string; + description: string; /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; + id: string; /** * @description The severity of the alert. * @enum {string|null} */ - readonly severity: "none" | "note" | "warning" | "error" | null; + severity: "none" | "note" | "warning" | "error" | null; }; /** * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. * @enum {string|null} */ - readonly state: "open" | "fixed" | null; - readonly tool: { + state: "open" | "fixed" | null; + tool: { /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; + name: string; /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; + version: string | null; }; /** Format: uri */ - readonly url: string; + url: string; }; - readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** code_scanning_alert updated_assignment event */ + "webhook-code-scanning-alert-updated-assignment": { + /** @enum {string} */ + action: "updated_assignment"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | "fixed" | null; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + 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"]; }; /** commit_comment created event */ - readonly "webhook-commit-comment-created": { + "webhook-commit-comment-created": { /** * @description The action performed. Can be `created`. * @enum {string} */ - readonly action: "created"; + action: "created"; /** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */ - readonly comment: { + comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - readonly created_at: string; + commit_id: string; + created_at: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description The ID of the commit comment. */ - readonly id: number; + id: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the commit comment. */ - readonly node_id: string; + node_id: string; /** @description The relative path of the file to which the comment applies. */ - readonly path: string | null; + path: string | null; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + updated_at: string; + /** Format: uri */ + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + 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"]; }; /** create event */ - readonly "webhook-create": { + "webhook-create": { /** @description The repository's current description. */ - readonly description: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The name of the repository's default branch (usually `main`). */ - readonly master_branch: string; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; - readonly ref: components["schemas"]["webhooks_ref_0"]; + master_branch: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; /** * @description The type of Git ref object created in the repository. * @enum {string} */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** custom property created event */ - readonly "webhook-custom-property-created": { + "webhook-custom-property-created": { /** @enum {string} */ - readonly action: "created"; - readonly definition: components["schemas"]["custom-property"]; - 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"]; + action: "created"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property deleted event */ - readonly "webhook-custom-property-deleted": { + "webhook-custom-property-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly definition: { + action: "deleted"; + definition: { /** @description The name of the property that was deleted. */ - readonly property_name: string; + property_name: string; }; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + /** custom property promoted to business event */ + "webhook-custom-property-promoted-to-enterprise": { + /** @enum {string} */ + action: "promote_to_enterprise"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** custom property updated event */ - readonly "webhook-custom-property-updated": { + "webhook-custom-property-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly definition: components["schemas"]["custom-property"]; - 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"]; + action: "updated"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Custom property values updated event */ - readonly "webhook-custom-property-values-updated": { + "webhook-custom-property-values-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - 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"]; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + repository: components["schemas"]["repository-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description The new custom property values for the repository. */ - readonly new_property_values: readonly components["schemas"]["custom-property-value"][]; + new_property_values: components["schemas"]["custom-property-value"][]; /** @description The old custom property values for the repository. */ - readonly old_property_values: readonly components["schemas"]["custom-property-value"][]; + old_property_values: components["schemas"]["custom-property-value"][]; }; /** delete event */ - readonly "webhook-delete": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; - readonly ref: components["schemas"]["webhooks_ref_0"]; + "webhook-delete": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; /** * @description The type of Git ref object deleted in the repository. * @enum {string} */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** Dependabot alert assignees changed event */ + "webhook-dependabot-alert-assignees-changed": { + /** @enum {string} */ + action: "assignees_changed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-dismissed event */ - readonly "webhook-dependabot-alert-auto-dismissed": { + "webhook-dependabot-alert-auto-dismissed": { /** @enum {string} */ - readonly action: "auto_dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert auto-reopened event */ - readonly "webhook-dependabot-alert-auto-reopened": { + "webhook-dependabot-alert-auto-reopened": { /** @enum {string} */ - readonly action: "auto_reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert created event */ - readonly "webhook-dependabot-alert-created": { + "webhook-dependabot-alert-created": { /** @enum {string} */ - readonly action: "created"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert dismissed event */ - readonly "webhook-dependabot-alert-dismissed": { + "webhook-dependabot-alert-dismissed": { /** @enum {string} */ - readonly action: "dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert fixed event */ - readonly "webhook-dependabot-alert-fixed": { + "webhook-dependabot-alert-fixed": { /** @enum {string} */ - readonly action: "fixed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "fixed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reintroduced event */ - readonly "webhook-dependabot-alert-reintroduced": { + "webhook-dependabot-alert-reintroduced": { /** @enum {string} */ - readonly action: "reintroduced"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "reintroduced"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Dependabot alert reopened event */ - readonly "webhook-dependabot-alert-reopened": { + "webhook-dependabot-alert-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key created event */ - readonly "webhook-deploy-key-created": { + "webhook-deploy-key-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deploy_key deleted event */ - readonly "webhook-deploy-key-deleted": { + "webhook-deploy-key-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** deployment created event */ - readonly "webhook-deployment-created": { + "webhook-deployment-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** * Deployment * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ - readonly deployment: { - readonly created_at: string; + deployment: { + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: Record | string; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: Record | string; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly production_environment?: boolean; - readonly ref: string; + production_environment?: boolean; + ref: string; /** Format: uri */ - readonly repository_url: string; - readonly sha: string; + repository_url: string; + sha: string; /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: unknown; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: unknown; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor?: { + triggering_actor?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; + url: string; + workflow_id: number; + workflow_url?: string; } | null; }; /** deployment protection rule requested event */ - readonly "webhook-deployment-protection-rule-requested": { + "webhook-deployment-protection-rule-requested": { /** @enum {string} */ - readonly action?: "requested"; + action?: "requested"; /** @description The name of the environment that has the deployment protection rule. */ - readonly environment?: string; + environment?: string; /** @description The event that triggered the deployment protection rule. */ - readonly event?: string; + event?: string; + /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + sha?: string; + /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + ref?: string; /** * Format: uri * @description The URL to review the deployment protection rule. */ - readonly deployment_callback_url?: string; - readonly deployment?: components["schemas"]["deployment"]; - readonly pull_requests?: readonly components["schemas"]["pull-request"][]; - 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"]; + deployment_callback_url?: string; + deployment?: components["schemas"]["nullable-deployment"]; + pull_requests?: components["schemas"]["pull-request"][]; + repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + sender?: components["schemas"]["simple-user"]; }; - readonly "webhook-deployment-review-approved": { + "webhook-deployment-review-approved": { /** @enum {string} */ - readonly action: "approved"; - readonly approver?: components["schemas"]["webhooks_approver"]; - readonly comment?: string; - 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 reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user"]; - readonly since: string; - readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; - readonly workflow_job_runs?: readonly { - readonly conclusion?: unknown; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; + action: "approved"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: unknown; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; }[]; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record | null; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; + url: string; + workflow_id: number; + workflow_url?: string; } | null; }; - readonly "webhook-deployment-review-rejected": { + "webhook-deployment-review-rejected": { /** @enum {string} */ - readonly action: "rejected"; - readonly approver?: components["schemas"]["webhooks_approver"]; - readonly comment?: string; - 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 reviewers?: components["schemas"]["webhooks_reviewers"]; - readonly sender: components["schemas"]["simple-user"]; - readonly since: string; - readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; - readonly workflow_job_runs?: readonly { - readonly conclusion?: string | null; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; + action: "rejected"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; }[]; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record | null; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; } | null; }; - readonly "webhook-deployment-review-requested": { + "webhook-deployment-review-requested": { /** @enum {string} */ - readonly action: "requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly environment: string; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly requestor: components["schemas"]["webhooks_user"]; - readonly reviewers: readonly { + action: "requested"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + environment: string; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + requestor: components["schemas"]["webhooks_user"]; + reviewers: { /** User */ - readonly reviewer?: { + reviewer?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login?: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @enum {string} */ - readonly type?: "User" | "Team"; + type?: "User" | "Team"; }[]; - readonly sender: components["schemas"]["simple-user"]; - readonly since: string; - readonly workflow_job_run: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly status: string; - readonly updated_at: string; + sender: components["schemas"]["simple-user"]; + since: string; + workflow_job_run: { + conclusion: unknown; + created_at: string; + environment: string; + html_url: string; + id: number; + name: string | null; + status: string; + updated_at: string; }; /** Deployment Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record | null; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; } | null; }; /** deployment_status created event */ - readonly "webhook-deployment-status-created": { + "webhook-deployment-status-created": { /** @enum {string} */ - readonly action: "created"; - readonly check_run?: { + action: "created"; + check_run?: { /** Format: date-time */ - readonly completed_at: string | null; + completed_at: string | null; /** * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; /** Format: uri */ - readonly details_url: string; - readonly external_id: string; + details_url: string; + external_id: string; /** @description The SHA of the commit that is being checked. */ - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description The id of the check. */ - readonly id: number; + id: number; /** @description The name of the check run. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: date-time */ - readonly started_at: string; + started_at: string; /** * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; + status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; /** Format: uri */ - readonly url: string; + url: string; } | null; /** * Deployment * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). */ - readonly deployment: { - readonly created_at: string; + deployment: { + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: (string | Record) | null; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: (string | Record) | null; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly production_environment?: boolean; - readonly ref: string; + production_environment?: boolean; + ref: string; /** Format: uri */ - readonly repository_url: string; - readonly sha: string; + repository_url: string; + sha: string; /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ - readonly deployment_status: { - readonly created_at: string; + deployment_status: { + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly deployment_url: string; + deployment_url: string; /** @description The optional human-readable description added to the status. */ - readonly description: string; - readonly environment: string; + description: string; + environment: string; /** Format: uri */ - readonly environment_url?: string; - readonly id: number; + environment_url?: string; + id: number; /** Format: uri */ - readonly log_url?: string; - readonly node_id: string; + log_url?: string; + node_id: string; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; /** Format: uri */ - readonly repository_url: string; + repository_url: string; /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ - readonly state: string; + state: string; /** @description The optional link added to the status. */ - readonly target_url: string; - readonly updated_at: string; + target_url: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - 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"]; - readonly workflow?: components["schemas"]["webhooks_workflow"]; + 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"]; + workflow?: components["schemas"]["webhooks_workflow"]; /** Deployment Workflow Run */ - readonly workflow_run?: { + workflow_run?: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: unknown; + head_repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: unknown; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; - readonly repository?: { - 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; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + repository?: { + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - readonly private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; + url: string; + workflow_id: number; + workflow_url?: string; } | null; }; /** discussion answered event */ - readonly "webhook-discussion-answered": { + "webhook-discussion-answered": { /** @enum {string} */ - readonly action: "answered"; - readonly answer: components["schemas"]["webhooks_answer"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "answered"; + answer: components["schemas"]["webhooks_answer"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion category changed event */ - readonly "webhook-discussion-category-changed": { + "webhook-discussion-category-changed": { /** @enum {string} */ - readonly action: "category_changed"; - readonly changes: { - readonly category: { - readonly from: { + action: "category_changed"; + changes: { + category: { + from: { /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; }; }; }; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion closed event */ - readonly "webhook-discussion-closed": { + "webhook-discussion-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "closed"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion_comment created event */ - readonly "webhook-discussion-comment-created": { + "webhook-discussion-comment-created": { /** @enum {string} */ - readonly action: "created"; - readonly comment: components["schemas"]["webhooks_comment"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "created"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion_comment deleted event */ - readonly "webhook-discussion-comment-deleted": { + "webhook-discussion-comment-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly comment: components["schemas"]["webhooks_comment"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "deleted"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion_comment edited event */ - readonly "webhook-discussion-comment-edited": { + "webhook-discussion-comment-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body: { - readonly from: string; + action: "edited"; + changes: { + body: { + from: string; }; }; - readonly comment: components["schemas"]["webhooks_comment"]; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion created event */ - readonly "webhook-discussion-created": { + "webhook-discussion-created": { /** @enum {string} */ - readonly action: "created"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "created"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion deleted event */ - readonly "webhook-discussion-deleted": { + "webhook-discussion-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "deleted"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion edited event */ - readonly "webhook-discussion-edited": { + "webhook-discussion-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly body?: { - readonly from: string; + action: "edited"; + changes?: { + body?: { + from: string; }; - readonly title?: { - readonly from: string; + title?: { + from: string; }; }; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion labeled event */ - readonly "webhook-discussion-labeled": { + "webhook-discussion-labeled": { /** @enum {string} */ - readonly action: "labeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "labeled"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion locked event */ - readonly "webhook-discussion-locked": { + "webhook-discussion-locked": { /** @enum {string} */ - readonly action: "locked"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "locked"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion pinned event */ - readonly "webhook-discussion-pinned": { + "webhook-discussion-pinned": { /** @enum {string} */ - readonly action: "pinned"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "pinned"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion reopened event */ - readonly "webhook-discussion-reopened": { + "webhook-discussion-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "reopened"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion transferred event */ - readonly "webhook-discussion-transferred": { + "webhook-discussion-transferred": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly new_discussion: components["schemas"]["discussion"]; - readonly new_repository: components["schemas"]["repository-webhooks"]; - }; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "transferred"; + changes: { + new_discussion: components["schemas"]["discussion"]; + new_repository: components["schemas"]["repository-webhooks"]; + }; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion unanswered event */ - readonly "webhook-discussion-unanswered": { + "webhook-discussion-unanswered": { /** @enum {string} */ - readonly action: "unanswered"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "unanswered"; + discussion: components["schemas"]["discussion"]; + old_answer: components["schemas"]["webhooks_answer"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** discussion unlabeled event */ - readonly "webhook-discussion-unlabeled": { + "webhook-discussion-unlabeled": { /** @enum {string} */ - readonly action: "unlabeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unlabeled"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** discussion unlocked event */ - readonly "webhook-discussion-unlocked": { + "webhook-discussion-unlocked": { /** @enum {string} */ - readonly action: "unlocked"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "unlocked"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** discussion unpinned event */ - readonly "webhook-discussion-unpinned": { + "webhook-discussion-unpinned": { /** @enum {string} */ - readonly action: "unpinned"; - readonly discussion: components["schemas"]["discussion"]; - 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"]; + action: "unpinned"; + discussion: components["schemas"]["discussion"]; + 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"]; }; /** * fork event * @description A user forks a repository. */ - readonly "webhook-fork": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + "webhook-fork": { + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ - readonly forkee: { + forkee: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } & { - readonly allow_forking?: boolean; - readonly archive_url?: string; - readonly archived?: boolean; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly clone_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly created_at?: string; - readonly default_branch?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly disabled?: boolean; - readonly downloads_url?: string; - readonly events_url?: string; + allow_forking?: boolean; + archive_url?: string; + archived?: boolean; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + clone_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + created_at?: string; + default_branch?: string; + deployments_url?: string; + description?: string | null; + disabled?: boolean; + downloads_url?: string; + events_url?: string; /** @enum {boolean} */ - readonly fork?: true; - readonly forks?: number; - readonly forks_count?: number; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly has_downloads?: boolean; - readonly has_issues?: boolean; - readonly has_pages?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly homepage?: string | null; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly is_template?: boolean; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly language?: unknown; - readonly languages_url?: string; - readonly license?: Record | null; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly mirror_url?: unknown; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly open_issues?: number; - readonly open_issues_count?: number; - readonly owner?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - }; - readonly private?: boolean; - readonly public?: boolean; - readonly pulls_url?: string; - readonly pushed_at?: string; - readonly releases_url?: string; - readonly size?: number; - readonly ssh_url?: string; - readonly stargazers_count?: number; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly svn_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly topics?: readonly unknown[]; - readonly trees_url?: string; - readonly updated_at?: string; - readonly url?: string; - readonly visibility?: string; - readonly watchers?: number; - readonly watchers_count?: number; - }; - 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"]; + fork?: true; + forks?: number; + forks_count?: number; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + has_downloads?: boolean; + has_issues?: boolean; + has_pages?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + homepage?: string | null; + hooks_url?: string; + html_url?: string; + id?: number; + is_template?: boolean; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + language?: unknown; + languages_url?: string; + license?: Record | null; + merges_url?: string; + milestones_url?: string; + mirror_url?: unknown; + name?: string; + node_id?: string; + notifications_url?: string; + open_issues?: number; + open_issues_count?: number; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + private?: boolean; + public?: boolean; + pulls_url?: string; + pushed_at?: string; + releases_url?: string; + size?: number; + ssh_url?: string; + stargazers_count?: number; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + svn_url?: string; + tags_url?: string; + teams_url?: string; + topics?: unknown[]; + trees_url?: string; + updated_at?: string; + url?: string; + visibility?: string; + watchers?: number; + watchers_count?: number; + }; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** github_app_authorization revoked event */ - readonly "webhook-github-app-authorization-revoked": { + "webhook-github-app-authorization-revoked": { /** @enum {string} */ - readonly action: "revoked"; - readonly sender: components["schemas"]["simple-user"]; + action: "revoked"; + sender: components["schemas"]["simple-user"]; }; /** gollum event */ - readonly "webhook-gollum": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + "webhook-gollum": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description The pages that were updated. */ - readonly pages: readonly { + pages: { /** * @description The action that was performed on the page. Can be `created` or `edited`. * @enum {string} */ - readonly action: "created" | "edited"; + action: "created" | "edited"; /** * Format: uri * @description Points to the HTML wiki page. */ - readonly html_url: string; + html_url: string; /** @description The name of the page. */ - readonly page_name: string; + page_name: string; /** @description The latest commit SHA of the page. */ - readonly sha: string; - readonly summary: string | null; + sha: string; + summary: string | null; /** @description The current page title. */ - readonly title: string; + title: string; }[]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** installation created event */ - readonly "webhook-installation-created": { + "webhook-installation-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: components["schemas"]["webhooks_user"]; - readonly sender: components["schemas"]["simple-user"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user"]; }; /** installation deleted event */ - readonly "webhook-installation-deleted": { + "webhook-installation-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; }; /** installation new_permissions_accepted event */ - readonly "webhook-installation-new-permissions-accepted": { + "webhook-installation-new-permissions-accepted": { /** @enum {string} */ - readonly action: "new_permissions_accepted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; + action: "new_permissions_accepted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories added event */ - readonly "webhook-installation-repositories-added": { + "webhook-installation-repositories-added": { /** @enum {string} */ - readonly action: "added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: readonly { - readonly full_name?: string; + repositories_removed: { + full_name?: string; /** @description Unique identifier of the repository */ - readonly id?: number; + id?: number; /** @description The name of the repository. */ - readonly name?: string; - readonly node_id?: string; + name?: string; + node_id?: string; /** @description Whether the repository is private or public. */ - readonly private?: boolean; + private?: boolean; }[]; - 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"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user"]; }; /** installation_repositories removed event */ - readonly "webhook-installation-repositories-removed": { + "webhook-installation-repositories-removed": { /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: readonly { - readonly full_name: string; + repositories_removed: { + full_name: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; }[]; - 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"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user"]; }; /** installation suspend event */ - readonly "webhook-installation-suspend": { + "webhook-installation-suspend": { /** @enum {string} */ - readonly action: "suspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; - }; - readonly "webhook-installation-target-renamed": { - readonly account: { - readonly archived_at?: string | null; - readonly avatar_url: string; - readonly created_at?: string; - readonly description?: unknown; - readonly events_url?: string; - readonly followers?: number; - readonly followers_url?: string; - readonly following?: number; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly has_organization_projects?: boolean; - readonly has_repository_projects?: boolean; - readonly hooks_url?: string; - readonly html_url: string; - readonly id: number; - readonly is_verified?: boolean; - readonly issues_url?: string; - readonly login?: string; - readonly members_url?: string; - readonly name?: string; - readonly node_id: string; - readonly organizations_url?: string; - readonly public_gists?: number; - readonly public_members_url?: string; - readonly public_repos?: number; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly slug?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly updated_at?: string; - readonly url?: string; - readonly website_url?: unknown; - readonly user_view_type?: string; + action: "suspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; + }; + "webhook-installation-target-renamed": { + account: { + archived_at?: string | null; + avatar_url: string; + created_at?: string; + description?: unknown; + events_url?: string; + followers?: number; + followers_url?: string; + following?: number; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + has_organization_projects?: boolean; + has_repository_projects?: boolean; + hooks_url?: string; + html_url: string; + id: number; + is_verified?: boolean; + issues_url?: string; + login?: string; + members_url?: string; + name?: string; + node_id: string; + organizations_url?: string; + public_gists?: number; + public_members_url?: string; + public_repos?: number; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + slug?: string; + starred_url?: string; + subscriptions_url?: string; + type?: string; + updated_at?: string; + url?: string; + website_url?: unknown; + user_view_type?: string; }; /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly login?: { - readonly from: string; + action: "renamed"; + changes: { + login?: { + from: string; }; - readonly slug?: { - readonly from: string; + slug?: { + from: string; }; }; - 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"]; - readonly target_type: string; + 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"]; + target_type: string; }; /** installation unsuspend event */ - readonly "webhook-installation-unsuspend": { + "webhook-installation-unsuspend": { /** @enum {string} */ - readonly action: "unsuspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repositories?: components["schemas"]["webhooks_repositories"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user"]; + action: "unsuspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user"]; }; /** issue_comment created event */ - readonly "webhook-issue-comment-created": { + "webhook-issue-comment-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** * issue comment * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ - readonly comment: { + comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue comment */ - readonly body: string; + body: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the issue comment */ - readonly id: number; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly node_id: string; - readonly performed_via_github_app: components["schemas"]["nullable-integration"]; + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["nullable-integration"]; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue comment */ - readonly url: string; + url: string; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at?: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels: readonly { + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly labels_url?: string; - readonly locked: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - }; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issue_comment deleted event */ - readonly "webhook-issue-comment-deleted": { + "webhook-issue-comment-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly comment: components["schemas"]["webhooks_issue_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "deleted"; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at?: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels: readonly { + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly labels_url?: string; - readonly locked: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - 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"]; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; }; /** issue_comment edited event */ - readonly "webhook-issue-comment-edited": { + "webhook-issue-comment-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: components["schemas"]["webhooks_changes"]; - readonly comment: components["schemas"]["webhooks_issue_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; + active_lock_reason?: string | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at?: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels: readonly { + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly labels_url?: string; - readonly locked: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - }; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues assigned event */ - readonly "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "assigned"; - readonly assignee?: components["schemas"]["webhooks_user"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; - }; - /** issues closed event */ - readonly "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + }; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issue_comment pinned event */ + "webhook-issue-comment-pinned": { + /** @enum {string} */ + action: "pinned"; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + team_discussions?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record | null; - readonly assignees?: readonly (Record | null)[]; - readonly author_association?: string; - readonly body?: string | null; - readonly closed_at: string | null; - readonly comments?: number; - readonly comments_url?: string; - readonly created_at?: string; - readonly events_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly (Record | null)[]; - readonly labels_url?: string; - readonly locked?: boolean; - readonly milestone?: Record | null; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: Record | null; - readonly reactions?: { - readonly "+1"?: number; - readonly "-1"?: number; - readonly confused?: number; - readonly eyes?: number; - readonly heart?: number; - readonly hooray?: number; - readonly laugh?: number; - readonly rocket?: number; - readonly total_count?: number; - readonly url?: string; - }; - readonly repository_url?: string; - /** @enum {string} */ - readonly state: "closed" | "open"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - 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"]; - }; - /** issues deleted event */ - readonly "webhook-issues-deleted": { + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** issue_comment unpinned event */ + "webhook-issue-comment-unpinned": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly issue: { + action: "unpinned"; + comment: components["schemas"]["webhooks_issue_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + team_discussions?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - }; - /** issues demilestoned event */ - readonly "webhook-issues-demilestoned": { + } & { + active_lock_reason?: string | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** blocked by issue added event */ + "webhook-issue-dependencies-blocked-by-added": { + /** @enum {string} */ + action: "blocked_by_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocked by issue removed event */ + "webhook-issue-dependencies-blocked-by-removed": { + /** @enum {string} */ + action: "blocked_by_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue added event */ + "webhook-issue-dependencies-blocking-added": { /** @enum {string} */ - readonly action: "demilestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "blocking_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue removed event */ + "webhook-issue-dependencies-blocking-removed": { + /** @enum {string} */ + action: "blocking_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues assigned event */ + "webhook-issues-assigned": { /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * @description The action that was performed. + * @enum {string} */ - readonly issue: { + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; - } | null)[]; + url: string; + }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels?: (Record | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** @enum {string} */ + state: "closed" | "open"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; }; - /** issues edited event */ - readonly "webhook-issues-edited": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the issue. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title. */ - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { - /** @enum {string} */ - readonly actions?: "read" | "write"; + permissions?: { /** @enum {string} */ - readonly administration?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; - /** issues labeled event */ - readonly "webhook-issues-labeled": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - readonly action: "labeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "demilestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; - }[]; + url: string; + } | null)[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly actions?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly administration?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; + type?: components["schemas"]["issue-type"]; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues edited event */ + "webhook-issues-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly workflows?: "read" | "write"; + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + /** @description Title of the issue */ + title: string; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { /** Format: uri */ - readonly url: string; - }; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues labeled event */ + "webhook-issues-labeled": { + /** @enum {string} */ + action: "labeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues locked event */ - readonly "webhook-issues-locked": { + "webhook-issues-locked": { /** @enum {string} */ - readonly action: "locked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** @enum {boolean} */ - readonly locked: true; + locked: true; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues milestoned event */ - readonly "webhook-issues-milestoned": { + "webhook-issues-milestoned": { /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues opened event */ - readonly "webhook-issues-opened": { + "webhook-issues-opened": { /** @enum {string} */ - readonly action: "opened"; - readonly changes?: { + action: "opened"; + changes?: { /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly old_issue: { + old_issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees?: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body?: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at?: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; + comments_url?: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at?: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url?: string; /** Format: uri */ - readonly html_url: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url?: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone?: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id?: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url?: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title?: string; /** Format: date-time */ - readonly updated_at: string; + updated_at?: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url?: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - readonly user: { + user?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; } | null; /** * Repository * @description A git repository */ - readonly old_repository: { + old_repository: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** @description Whether the repository has discussions enabled. */ - readonly has_discussions?: boolean; + has_discussions?: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require commit signoff. */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues pinned event */ - readonly "webhook-issues-pinned": { + "webhook-issues-pinned": { /** @enum {string} */ - readonly action: "pinned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "pinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues reopened event */ - readonly "webhook-issues-reopened": { + "webhook-issues-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - readonly state_reason?: string | null; + state: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues transferred event */ - readonly "webhook-issues-transferred": { + "webhook-issues-transferred": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { + action: "transferred"; + changes: { /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly new_issue: { + new_issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly { + id: number; + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + labels_url: string; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** * Repository * @description A git repository */ - readonly new_repository: { + new_repository: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues typed event */ + "webhook-issues-typed": { + /** @enum {string} */ + action: "typed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unassigned event */ - readonly "webhook-issues-unassigned": { + "webhook-issues-unassigned": { /** * @description The action that was performed. * @enum {string} */ - readonly action: "unassigned"; - readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlabeled event */ - readonly "webhook-issues-unlabeled": { + "webhook-issues-unlabeled": { /** @enum {string} */ - readonly action: "unlabeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: components["schemas"]["webhooks_issue"]; - 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"]; + action: "unlabeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unlocked event */ - readonly "webhook-issues-unlocked": { + "webhook-issues-unlocked": { /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "unlocked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** * Issue * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly issue: { + issue: { /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee?: { + assignee?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments: number; + closed_at: string | null; + comments: number; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + created_at: string; + draft?: boolean; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** Format: int64 */ - readonly id: number; - readonly labels?: readonly ({ + id: number; + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; } | null)[]; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** @enum {boolean} */ - readonly locked: false; + locked: false; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** * App * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. */ - readonly performed_via_github_app?: { + performed_via_github_app?: { /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; + created_at: string | null; + description: string | null; /** @description The list of events for the GitHub app */ - readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ - readonly external_url: string | null; + external_url: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the GitHub app */ - readonly id: number | null; + id: number | null; /** @description The name of the GitHub app */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The set of permissions for the GitHub app */ - readonly permissions?: { + permissions?: { /** @enum {string} */ - readonly actions?: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - readonly administration?: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - readonly checks?: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - readonly content_references?: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - readonly contents?: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - readonly deployments?: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - readonly discussions?: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - readonly emails?: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - readonly environments?: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - readonly issues?: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - readonly keys?: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - readonly members?: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - readonly metadata?: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - readonly organization_administration?: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - readonly organization_hooks?: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - readonly organization_packages?: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - readonly organization_plan?: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - readonly organization_projects?: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - readonly organization_secrets?: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - readonly organization_self_hosted_runners?: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - readonly organization_user_blocking?: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - readonly packages?: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - readonly pages?: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - readonly pull_requests?: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - readonly repository_hooks?: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - readonly secret_scanning_alerts?: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - readonly secrets?: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - readonly security_events?: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - readonly security_scanning_alert?: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - readonly single_file?: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - readonly statuses?: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - readonly team_discussions?: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - readonly vulnerability_alerts?: "read" | "write"; - /** @enum {string} */ - readonly workflows?: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ - readonly slug?: string; + slug?: string; /** Format: date-time */ - readonly updated_at: string | null; + updated_at: string | null; } | null; - readonly pull_request?: { + pull_request?: { /** Format: uri */ - readonly diff_url?: string; + diff_url?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: date-time */ - readonly merged_at?: string | null; + merged_at?: string | null; /** Format: uri */ - readonly patch_url?: string; + patch_url?: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; - /** Sub-issues Summary */ - readonly sub_issues_summary?: { - readonly total: number; - readonly completed: number; - readonly percent_completed: number; - }; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - readonly timeline_url?: string; + timeline_url?: string; /** @description Title of the issue */ - readonly title: string; + title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the issue */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** issues unpinned event */ - readonly "webhook-issues-unpinned": { + "webhook-issues-unpinned": { /** @enum {string} */ - readonly action: "unpinned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unpinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues untyped event */ + "webhook-issues-untyped": { + /** @enum {string} */ + action: "untyped"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label created event */ - readonly "webhook-label-created": { + "webhook-label-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** label deleted event */ - readonly "webhook-label-deleted": { + "webhook-label-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** label edited event */ - readonly "webhook-label-edited": { + "webhook-label-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the label if the action was `edited`. */ - readonly changes?: { - readonly color?: { + changes?: { + color?: { /** @description The previous version of the color if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly description?: { + description?: { /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase cancelled event */ - readonly "webhook-marketplace-purchase-cancelled": { + "webhook-marketplace-purchase-cancelled": { /** @enum {string} */ - readonly action: "cancelled"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - 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"]; + action: "cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + 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"]; }; /** marketplace_purchase changed event */ - readonly "webhook-marketplace-purchase-changed": { + "webhook-marketplace-purchase-changed": { /** @enum {string} */ - readonly action: "changed"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "changed"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean | null; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + previous_marketplace_purchase?: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean | null; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change event */ - readonly "webhook-marketplace-purchase-pending-change": { + "webhook-marketplace-purchase-pending-change": { /** @enum {string} */ - readonly action: "pending_change"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "pending_change"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + previous_marketplace_purchase?: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** marketplace_purchase pending_change_cancelled event */ - readonly "webhook-marketplace-purchase-pending-change-cancelled": { + "webhook-marketplace-purchase-pending-change-cancelled": { /** @enum {string} */ - readonly action: "pending_change_cancelled"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "pending_change_cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** Marketplace Purchase */ - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: readonly string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; + marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: unknown; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; }; - readonly unit_count: number; + unit_count: number; }; - 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"]; + 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"]; }; /** marketplace_purchase purchased event */ - readonly "webhook-marketplace-purchase-purchased": { + "webhook-marketplace-purchase-purchased": { /** @enum {string} */ - readonly action: "purchased"; - readonly effective_date: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; - 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"]; + action: "purchased"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + 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"]; }; /** member added event */ - readonly "webhook-member-added": { + "webhook-member-added": { /** @enum {string} */ - readonly action: "added"; - readonly changes?: { + action: "added"; + changes?: { /** * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role * assigned to the collaborator, use the `role_name` field instead, which will provide the full * role name, including custom roles. */ - readonly permission?: { + permission?: { /** @enum {string} */ - readonly to: "write" | "admin" | "read"; + to: "write" | "admin" | "read"; }; /** @description The role assigned to the collaborator. */ - readonly role_name?: { - readonly to: string; + role_name?: { + to: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member edited event */ - readonly "webhook-member-edited": { + "webhook-member-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the collaborator permissions */ - readonly changes: { - readonly old_permission?: { + changes: { + old_permission?: { /** @description The previous permissions of the collaborator if the action was edited. */ - readonly from: string; + from: string; }; - readonly permission?: { - readonly from?: string | null; - readonly to?: string | null; + permission?: { + from?: string | null; + to?: string | null; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** member removed event */ - readonly "webhook-member-removed": { + "webhook-member-removed": { /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** membership added event */ - readonly "webhook-membership-added": { + "webhook-membership-added": { /** @enum {string} */ - readonly action: "added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly member: components["schemas"]["webhooks_user"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** * @description The scope of the membership. Currently, can only be `team`. * @enum {string} */ - readonly scope: "team"; + scope: "team"; /** User */ - readonly sender: { + sender: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly team: components["schemas"]["webhooks_team"]; + team: components["schemas"]["webhooks_team"]; }; /** membership removed event */ - readonly "webhook-membership-removed": { + "webhook-membership-removed": { /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly member: components["schemas"]["webhooks_user"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** * @description The scope of the membership. Currently, can only be `team`. * @enum {string} */ - readonly scope: "team" | "organization"; + scope: "team" | "organization"; /** User */ - readonly sender: { + sender: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly team: components["schemas"]["webhooks_team"]; + team: components["schemas"]["webhooks_team"]; }; - readonly "webhook-merge-group-checks-requested": { + "webhook-merge-group-checks-requested": { /** @enum {string} */ - readonly action: "checks_requested"; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; - }; - readonly "webhook-merge-group-destroyed": { + action: "checks_requested"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; + "webhook-merge-group-destroyed": { /** @enum {string} */ - readonly action: "destroyed"; + action: "destroyed"; /** * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). * @enum {string} */ - readonly reason?: "merged" | "invalidated" | "dequeued"; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + reason?: "merged" | "invalidated" | "dequeued"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** meta deleted event */ - readonly "webhook-meta-deleted": { + "webhook-meta-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ - readonly hook: { - readonly active: boolean; - readonly config: { + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + hook: { + active: boolean; + config: { /** @enum {string} */ - readonly content_type: "json" | "form"; - readonly insecure_ssl: string; - readonly secret?: string; + content_type: "json" | "form"; + insecure_ssl: string; + secret?: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly created_at: string; - readonly events: readonly ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; - readonly id: number; - readonly name: string; - readonly type: string; - readonly updated_at: string; + created_at: string; + events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; + id: number; + name: string; + type: string; + updated_at: string; }; /** @description The id of the modified webhook. */ - readonly hook_id: number; - 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"]; + hook_id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** milestone closed event */ - readonly "webhook-milestone-closed": { + "webhook-milestone-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone created event */ - readonly "webhook-milestone-created": { + "webhook-milestone-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone deleted event */ - readonly "webhook-milestone-deleted": { + "webhook-milestone-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone edited event */ - readonly "webhook-milestone-edited": { + "webhook-milestone-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the milestone if the action was `edited`. */ - readonly changes: { - readonly description?: { + changes: { + description?: { /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly due_on?: { + due_on?: { /** @description The previous version of the due date if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly title?: { + title?: { /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** milestone opened event */ - readonly "webhook-milestone-opened": { + "webhook-milestone-opened": { /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** org_block blocked event */ - readonly "webhook-org-block-blocked": { + "webhook-org-block-blocked": { /** @enum {string} */ - readonly action: "blocked"; - readonly blocked_user: components["schemas"]["webhooks_user"]; - 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"]; + action: "blocked"; + blocked_user: components["schemas"]["webhooks_user"]; + 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"]; }; /** org_block unblocked event */ - readonly "webhook-org-block-unblocked": { + "webhook-org-block-unblocked": { /** @enum {string} */ - readonly action: "unblocked"; - readonly blocked_user: components["schemas"]["webhooks_user"]; - 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"]; + action: "unblocked"; + blocked_user: components["schemas"]["webhooks_user"]; + 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"]; }; /** organization deleted event */ - readonly "webhook-organization-deleted": { + "webhook-organization-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_added event */ - readonly "webhook-organization-member-added": { + "webhook-organization-member-added": { /** @enum {string} */ - readonly action: "member_added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "member_added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization member_invited event */ - readonly "webhook-organization-member-invited": { + "webhook-organization-member-invited": { /** @enum {string} */ - readonly action: "member_invited"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "member_invited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The invitation for the user or email if the action is `member_invited`. */ - readonly invitation: { + invitation: { /** Format: date-time */ - readonly created_at: string; - readonly email: string | null; + created_at: string; + email: string | null; /** Format: date-time */ - readonly failed_at: string | null; - readonly failed_reason: string | null; - readonly id: number; + failed_at: string | null; + failed_reason: string | null; + id: number; /** Format: uri */ - readonly invitation_teams_url: string; + invitation_teams_url: string; /** User */ - readonly inviter: { + inviter: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly login: string | null; - readonly node_id: string; - readonly role: string; - readonly team_count: number; - readonly invitation_source?: string; + login: string | null; + node_id: string; + role: string; + team_count: number; + invitation_source?: string; }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - readonly user?: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + user?: components["schemas"]["webhooks_user"]; }; /** organization member_removed event */ - readonly "webhook-organization-member-removed": { + "webhook-organization-member-removed": { /** @enum {string} */ - readonly action: "member_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "member_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** organization renamed event */ - readonly "webhook-organization-renamed": { + "webhook-organization-renamed": { /** @enum {string} */ - readonly action: "renamed"; - readonly changes?: { - readonly login?: { - readonly from?: string; + action: "renamed"; + changes?: { + login?: { + from?: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Ruby Gems metadata */ - readonly "webhook-rubygems-metadata": { - readonly name?: string; - readonly description?: string; - readonly readme?: string; - readonly homepage?: string; - readonly version_info?: { - readonly version?: string; - }; - readonly platform?: string; - readonly metadata?: { - readonly [key: string]: string; - }; - readonly repo?: string; - readonly dependencies?: readonly { - readonly [key: string]: string; + "webhook-rubygems-metadata": { + name?: string; + description?: string; + readme?: string; + homepage?: string; + version_info?: { + version?: string; + }; + platform?: string; + metadata?: { + [key: string]: string; + }; + repo?: string; + dependencies?: { + [key: string]: string; }[]; - readonly commit_oid?: string; + commit_oid?: string; }; /** package published event */ - readonly "webhook-package-published": { + "webhook-package-published": { /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ - readonly package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; + package: { + created_at: string | null; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly package_type: string; - readonly package_version: { + package_type: string; + package_version: { /** User */ - readonly author?: { + author?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record | null; - readonly manifest?: Record | null; - readonly tag?: { - readonly digest?: string; - readonly name?: string; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; }; } | null; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: readonly { - readonly tags?: readonly string[]; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; }[]; - readonly draft?: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + /** Format: uri */ + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: Record | null; - readonly bugs?: Record | null; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: Record | null; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: Record | null; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: readonly Record[]; - readonly contributors?: readonly Record[]; - readonly engines?: Record; - readonly keywords?: readonly string[]; - readonly files?: readonly string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: Record | null; - readonly os?: readonly string[]; - readonly cpu?: readonly string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: Record | null; + bugs?: Record | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: Record | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: Record | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: Record[]; + contributors?: Record[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: Record | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; } | null; - readonly nuget_metadata?: readonly { - readonly id?: number | string; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; + nuget_metadata?: { + id?: number | string; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; }; }[] | null; - readonly package_files: readonly { - readonly content_type: string; - readonly created_at: string; - /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; + package_files: { + content_type: string; + created_at: string; + /** Format: uri */ + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { + package_url?: string; + prerelease?: boolean; + release?: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly created_at: string; - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; - /** Format: uri */ - readonly url: string; + created_at: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + /** Format: uri */ + url: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - readonly source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; } | null; - readonly registry: { + registry: { /** Format: uri */ - readonly about_url: string; - readonly name: string; - readonly type: string; + about_url: string; + name: string; + type: string; /** Format: uri */ - readonly url: string; - readonly vendor: string; + url: string; + vendor: string; } | null; - readonly updated_at: string | null; + updated_at: string | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** package updated event */ - readonly "webhook-package-updated": { + "webhook-package-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** @description Information about the package. */ - readonly package: { - readonly created_at: string; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; + package: { + created_at: string; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly package_type: string; - readonly package_version: { + package_type: string; + package_version: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: readonly { - readonly tags?: readonly string[]; + body: string; + body_html: string; + created_at: string; + description: string; + docker_metadata?: { + tags?: string[]; }[]; - readonly draft?: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + /** Format: uri */ + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly package_files: readonly { - readonly content_type: string; - readonly created_at: string; - /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string; - readonly size: number; - readonly state: string; - readonly updated_at: string; + name: string; + package_files: { + content_type: string; + created_at: string; + /** Format: uri */ + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string; + size: number; + state: string; + updated_at: string; }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { + package_url?: string; + prerelease?: boolean; + release?: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly created_at: string; - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; - /** Format: uri */ - readonly url: string; + created_at: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + /** Format: uri */ + url: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; /** Format: uri */ - readonly source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; - readonly registry: { + registry: { /** Format: uri */ - readonly about_url: string; - readonly name: string; - readonly type: string; + about_url: string; + name: string; + type: string; /** Format: uri */ - readonly url: string; - readonly vendor: string; + url: string; + vendor: string; } | null; - readonly updated_at: string; + updated_at: string; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** page_build event */ - readonly "webhook-page-build": { + "webhook-page-build": { /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ - readonly build: { - readonly commit: string | null; - readonly created_at: string; - readonly duration: number; - readonly error: { - readonly message: string | null; + build: { + commit: string | null; + created_at: string; + duration: number; + error: { + message: string | null; }; /** User */ - readonly pusher: { + pusher: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly status: string; - readonly updated_at: string; + status: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly id: number; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** personal_access_token_request approved event */ - readonly "webhook-personal-access-token-request-approved": { + "webhook-personal-access-token-request-approved": { /** @enum {string} */ - readonly action: "approved"; - 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"]; - readonly installation: components["schemas"]["simple-installation"]; + action: "approved"; + 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"]; + installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request cancelled event */ - readonly "webhook-personal-access-token-request-cancelled": { + "webhook-personal-access-token-request-cancelled": { /** @enum {string} */ - readonly action: "cancelled"; - 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"]; - readonly installation: components["schemas"]["simple-installation"]; + action: "cancelled"; + 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"]; + installation: components["schemas"]["simple-installation"]; }; /** personal_access_token_request created event */ - readonly "webhook-personal-access-token-request-created": { + "webhook-personal-access-token-request-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "created"; + 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"]; + installation?: components["schemas"]["simple-installation"]; }; /** personal_access_token_request denied event */ - readonly "webhook-personal-access-token-request-denied": { + "webhook-personal-access-token-request-denied": { /** @enum {string} */ - readonly action: "denied"; - 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"]; - readonly installation: components["schemas"]["simple-installation"]; + action: "denied"; + 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"]; + installation: components["schemas"]["simple-installation"]; }; - readonly "webhook-ping": { + "webhook-ping": { /** * Webhook * @description The webhook that is being pinged */ - readonly hook?: { + hook?: { /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ - readonly active: boolean; + active: boolean; /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ - readonly app_id?: number; - readonly config: { - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly url?: components["schemas"]["webhook-config-url"]; + app_id?: number; + config: { + content_type?: components["schemas"]["webhook-config-content-type"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + secret?: components["schemas"]["webhook-config-secret"]; + url?: components["schemas"]["webhook-config-url"]; }; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** Format: uri */ - readonly deliveries_url?: string; + deliveries_url?: string; /** @description Determines what events the hook is triggered for. Default: ['push']. */ - readonly events: readonly string[]; + events: string[]; /** @description Unique identifier of the webhook. */ - readonly id: number; - readonly last_response?: components["schemas"]["hook-response"]; + id: number; + last_response?: components["schemas"]["hook-response"]; /** * @description The type of webhook. The only valid value is 'web'. * @enum {string} */ - readonly name: "web"; + name: "web"; /** Format: uri */ - readonly ping_url?: string; + ping_url?: string; /** Format: uri */ - readonly test_url?: string; - readonly type: string; + test_url?: string; + type: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url?: string; + url?: string; }; /** @description The ID of the webhook that triggered the ping. */ - readonly hook_id?: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; + hook_id?: number; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ - readonly zen?: string; + zen?: string; }; /** @description The webhooks ping payload encoded with URL encoding. */ - readonly "webhook-ping-form-encoded": { + "webhook-ping-form-encoded": { /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + payload: string; }; /** project_card converted event */ - readonly "webhook-project-card-converted": { + "webhook-project-card-converted": { /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly note: { - readonly from: string; + action: "converted"; + changes: { + note: { + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card created event */ - readonly "webhook-project-card-created": { + "webhook-project-card-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card deleted event */ - readonly "webhook-project-card-deleted": { + "webhook-project-card-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; + project_card: { + after_id?: number | null; /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number | null; + archived: boolean; + column_id: number | null; /** Format: uri */ - readonly column_url: string; + column_url: string; /** Format: uri */ - readonly content_url?: string; + content_url?: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; + id: number; + node_id: string; + note: string | null; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card edited event */ - readonly "webhook-project-card-edited": { + "webhook-project-card-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly note: { - readonly from: string | null; + action: "edited"; + changes: { + note: { + from: string | null; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_card moved event */ - readonly "webhook-project-card-moved": { + "webhook-project-card-moved": { /** @enum {string} */ - readonly action: "moved"; - readonly changes?: { - readonly column_id: { - readonly from: number; + action: "moved"; + changes?: { + column_id: { + from: number; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly project_card: { - readonly after_id?: number | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: { + after_id?: number | null; /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; + archived: boolean; + column_id: number; /** Format: uri */ - readonly column_url: string; + column_url: string; /** Format: uri */ - readonly content_url?: string; + content_url?: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; + id: number; + node_id: string; + note: string | null; /** Format: uri */ - readonly project_url: string; + project_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } & { - readonly after_id: number | null; - readonly archived?: boolean; - readonly column_id?: number; - readonly column_url?: string; - readonly created_at?: string; - readonly creator?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; + after_id: number | null; + archived?: boolean; + column_id?: number; + column_url?: string; + created_at?: string; + creator?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; } | null; - readonly id?: number; - readonly node_id?: string; - readonly note?: string | null; - readonly project_url?: string; - readonly updated_at?: string; - readonly url?: string; + id?: number; + node_id?: string; + note?: string | null; + project_url?: string; + updated_at?: string; + url?: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project closed event */ - readonly "webhook-project-closed": { + "webhook-project-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project_column created event */ - readonly "webhook-project-column-created": { + "webhook-project-column-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column deleted event */ - readonly "webhook-project-column-deleted": { + "webhook-project-column-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column edited event */ - readonly "webhook-project-column-edited": { + "webhook-project-column-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly name?: { - readonly from: string; + action: "edited"; + changes: { + name?: { + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project_column moved event */ - readonly "webhook-project-column-moved": { + "webhook-project-column-moved": { /** @enum {string} */ - readonly action: "moved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "moved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project created event */ - readonly "webhook-project-created": { + "webhook-project-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** project deleted event */ - readonly "webhook-project-deleted": { + "webhook-project-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project edited event */ - readonly "webhook-project-edited": { + "webhook-project-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the project if the action was `edited`. */ - readonly changes?: { - readonly body?: { + changes?: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The changes to the project if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** project reopened event */ - readonly "webhook-project-reopened": { + "webhook-project-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Closed Event */ - readonly "webhook-projects-v2-project-closed": { + "webhook-projects-v2-project-closed": { /** @enum {string} */ - readonly action: "closed"; - 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"]; + action: "closed"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** @description A project was created */ - readonly "webhook-projects-v2-project-created": { + "webhook-projects-v2-project-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Deleted Event */ - readonly "webhook-projects-v2-project-deleted": { + "webhook-projects-v2-project-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Edited Event */ - readonly "webhook-projects-v2-project-edited": { + "webhook-projects-v2-project-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly description?: { - readonly from?: string | null; - readonly to?: string | null; + action: "edited"; + changes: { + description?: { + from?: string | null; + to?: string | null; }; - readonly public?: { - readonly from?: boolean; - readonly to?: boolean; + public?: { + from?: boolean; + to?: boolean; }; - readonly short_description?: { - readonly from?: string | null; - readonly to?: string | null; + short_description?: { + from?: string | null; + to?: string | null; }; - readonly title?: { - readonly from?: string; - readonly to?: string; + title?: { + from?: string; + to?: string; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Archived Event */ - readonly "webhook-projects-v2-item-archived": { + "webhook-projects-v2-item-archived": { /** @enum {string} */ - readonly action: "archived"; - readonly changes: components["schemas"]["webhooks_project_changes"]; - 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"]; + action: "archived"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Converted Event */ - readonly "webhook-projects-v2-item-converted": { + "webhook-projects-v2-item-converted": { /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly content_type?: { - readonly from?: string | null; - readonly to?: string; + action: "converted"; + changes: { + content_type?: { + from?: string | null; + to?: string; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Created Event */ - readonly "webhook-projects-v2-item-created": { + "webhook-projects-v2-item-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Deleted Event */ - readonly "webhook-projects-v2-item-deleted": { + "webhook-projects-v2-item-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Edited Event */ - readonly "webhook-projects-v2-item-edited": { + "webhook-projects-v2-item-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** * @description The changes made to the item may involve modifications in the item's fields and draft issue body. * It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field. */ - readonly changes?: { - readonly field_value: { - readonly field_node_id?: string; - readonly field_type?: string; - readonly field_name?: string; - readonly project_number?: number; - readonly from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; - readonly to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + changes?: { + field_value: { + field_node_id?: string; + field_type?: string; + field_name?: string; + project_number?: number; + from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { - readonly body: { - readonly from?: string | null; - readonly to?: string | null; + body: { + from?: string | null; + to?: string | null; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Reordered Event */ - readonly "webhook-projects-v2-item-reordered": { + "webhook-projects-v2-item-reordered": { /** @enum {string} */ - readonly action: "reordered"; - readonly changes: { - readonly previous_projects_v2_item_node_id?: { - readonly from?: string | null; - readonly to?: string | null; + action: "reordered"; + changes: { + previous_projects_v2_item_node_id?: { + from?: string | null; + to?: string | null; }; }; - 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"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Item Restored Event */ - readonly "webhook-projects-v2-item-restored": { + "webhook-projects-v2-item-restored": { /** @enum {string} */ - readonly action: "restored"; - readonly changes: components["schemas"]["webhooks_project_changes"]; - 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"]; + action: "restored"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Project Reopened Event */ - readonly "webhook-projects-v2-project-reopened": { + "webhook-projects-v2-project-reopened": { /** @enum {string} */ - readonly action: "reopened"; - 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"]; + action: "reopened"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user"]; }; /** Projects v2 Status Update Created Event */ - readonly "webhook-projects-v2-status-update-created": { + "webhook-projects-v2-status-update-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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"]; }; /** Projects v2 Status Update Deleted Event */ - readonly "webhook-projects-v2-status-update-deleted": { + "webhook-projects-v2-status-update-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + 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"]; }; /** Projects v2 Status Update Edited Event */ - readonly "webhook-projects-v2-status-update-edited": { + "webhook-projects-v2-status-update-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly body?: { - readonly from?: string | null; - readonly to?: string | null; + action: "edited"; + changes?: { + body?: { + from?: string | null; + to?: string | null; }; - readonly status?: { + status?: { /** @enum {string|null} */ - readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** @enum {string|null} */ - readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; - readonly start_date?: { + start_date?: { /** Format: date */ - readonly from?: string | null; + from?: string | null; /** Format: date */ - readonly to?: string | null; + to?: string | null; }; - readonly target_date?: { + target_date?: { /** Format: date */ - readonly from?: string | null; + from?: string | null; /** Format: date */ - readonly to?: string | null; + to?: string | null; }; }; - 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"]; + 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"]; }; /** public event */ - readonly "webhook-public": { - 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"]; + "webhook-public": { + 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"]; }; /** pull_request assigned event */ - readonly "webhook-pull-request-assigned": { + "webhook-pull-request-assigned": { /** @enum {string} */ - readonly action: "assigned"; - readonly assignee: components["schemas"]["webhooks_user"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "assigned"; + assignee: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -54894,7 +59067,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -54902,76 +59075,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -54980,7 +59153,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -54988,250 +59161,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -55240,7 +59423,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -55248,76 +59431,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -55326,7 +59509,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -55334,765 +59517,775 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_disabled event */ - readonly "webhook-pull-request-auto-merge-disabled": { + "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ - readonly action: "auto_merge_disabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "auto_merge_disabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; + has_issues: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly has_pages: boolean; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -56101,7 +60294,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -56109,76 +60302,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -56187,7 +60380,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -56195,250 +60388,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -56447,7 +60650,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -56455,76 +60658,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -56533,7 +60736,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -56541,766 +60744,776 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly reason: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + reason: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request auto_merge_enabled event */ - readonly "webhook-pull-request-auto-merge-enabled": { + "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ - readonly action: "auto_merge_enabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "auto_merge_enabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -57309,7 +61522,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -57317,76 +61530,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -57395,7 +61608,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -57403,247 +61616,257 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -57652,7 +61875,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -57660,76 +61883,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -57738,7 +61961,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -57746,802 +61969,812 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly reason?: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + reason?: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request closed event */ - readonly "webhook-pull-request-closed": { + "webhook-pull-request-closed": { /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request converted_to_draft event */ - readonly "webhook-pull-request-converted-to-draft": { + "webhook-pull-request-converted-to-draft": { /** @enum {string} */ - readonly action: "converted_to_draft"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "converted_to_draft"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request demilestoned event */ - readonly "webhook-pull-request-demilestoned": { + "webhook-pull-request-demilestoned": { /** @enum {string} */ - readonly action: "demilestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "demilestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request dequeued event */ - readonly "webhook-pull-request-dequeued": { + "webhook-pull-request-dequeued": { /** @enum {string} */ - readonly action: "dequeued"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "dequeued"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -58550,7 +62783,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -58558,76 +62791,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -58636,7 +62869,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -58644,250 +62877,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -58896,7 +63139,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -58904,76 +63147,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -58982,7 +63225,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -58990,798 +63233,808 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** @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"]; + 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"]; }; /** pull_request edited event */ - readonly "webhook-pull-request-edited": { + "webhook-pull-request-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the comment if the action was `edited`. */ - readonly changes: { - readonly base?: { - readonly ref: { - readonly from: string; + changes: { + base?: { + ref: { + from: string; }; - readonly sha: { - readonly from: string; + sha: { + from: string; }; }; - readonly body?: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly title?: { + title?: { /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request enqueued event */ - readonly "webhook-pull-request-enqueued": { + "webhook-pull-request-enqueued": { /** @enum {string} */ - readonly action: "enqueued"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "enqueued"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -59790,7 +64043,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -59798,76 +64051,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -59876,7 +64129,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -59884,250 +64137,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -60136,7 +64399,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -60144,76 +64407,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -60222,7 +64485,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -60230,766 +64493,776 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request labeled event */ - readonly "webhook-pull-request-labeled": { + "webhook-pull-request-labeled": { /** @enum {string} */ - readonly action: "labeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly label?: components["schemas"]["webhooks_label"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "labeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -60998,7 +65271,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -61006,76 +65279,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -61084,7 +65357,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -61092,250 +65365,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -61344,7 +65627,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -61352,76 +65635,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -61430,7 +65713,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -61438,765 +65721,775 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request locked event */ - readonly "webhook-pull-request-locked": { + "webhook-pull-request-locked": { /** @enum {string} */ - readonly action: "locked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -62205,7 +66498,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -62213,76 +66506,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -62291,7 +66584,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -62299,250 +66592,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -62551,7 +66854,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -62559,76 +66862,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -62637,7 +66940,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -62645,500 +66948,500 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request milestoned event */ - readonly "webhook-pull-request-milestoned": { + "webhook-pull-request-milestoned": { /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request opened event */ - readonly "webhook-pull-request-opened": { + "webhook-pull-request-opened": { /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request ready_for_review event */ - readonly "webhook-pull-request-ready-for-review": { + "webhook-pull-request-ready-for-review": { /** @enum {string} */ - readonly action: "ready_for_review"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "ready_for_review"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request reopened event */ - readonly "webhook-pull-request-reopened": { + "webhook-pull-request-reopened": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - 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"]; + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment created event */ - readonly "webhook-pull-request-review-comment-created": { + "webhook-pull-request-review-comment-created": { /** @enum {string} */ - readonly action: "created"; + action: "created"; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. */ - readonly comment: { - readonly _links: { + comment: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -63146,456 +67449,466 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; + original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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 pull_request: { - readonly _links: { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + auto_merge?: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -63604,7 +67917,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -63612,76 +67925,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -63690,7 +68003,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -63698,243 +68011,253 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft?: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft?: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -63943,7 +68266,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -63951,76 +68274,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -64029,7 +68352,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -64037,711 +68360,721 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment deleted event */ - readonly "webhook-pull-request-review-comment-deleted": { + "webhook-pull-request-review-comment-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly comment: components["schemas"]["webhooks_review_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: { - readonly _links: { + action: "deleted"; + comment: components["schemas"]["webhooks_review_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + auto_merge?: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -64750,7 +69083,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -64758,76 +69091,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -64836,7 +69169,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -64844,243 +69177,253 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft?: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft?: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -65089,7 +69432,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -65097,76 +69440,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -65175,7 +69518,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -65183,713 +69526,723 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_comment edited event */ - readonly "webhook-pull-request-review-comment-edited": { + "webhook-pull-request-review-comment-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: components["schemas"]["webhooks_changes"]; - readonly comment: components["schemas"]["webhooks_review_comment"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: { - readonly _links: { + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_review_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + auto_merge?: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -65898,7 +70251,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -65906,76 +70259,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -65984,7 +70337,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -65992,243 +70345,253 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft?: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft?: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -66237,7 +70600,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -66245,76 +70608,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -66323,7 +70686,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -66331,711 +70694,721 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - readonly user_view_type?: string; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + user_view_type?: string; /** Format: uri */ - readonly url?: string; + url?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review dismissed event */ - readonly "webhook-pull-request-review-dismissed": { + "webhook-pull-request-review-dismissed": { /** @enum {string} */ - readonly action: "dismissed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "dismissed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -67044,7 +71417,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -67052,76 +71425,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -67130,7 +71503,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -67138,243 +71511,253 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -67383,7 +71766,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -67391,76 +71774,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -67469,7 +71852,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -67477,386 +71860,386 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** @description The review that was affected. */ - readonly review: { - readonly _links: { + review: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -67864,1464 +72247,1476 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the review. */ - readonly body: string | null; + body: string | null; /** @description A commit SHA for the review. */ - readonly commit_id: string; + commit_id: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; + id: number; + node_id: string; /** Format: uri */ - readonly pull_request_url: string; + pull_request_url: string; /** @enum {string} */ - readonly state: "dismissed" | "approved" | "changes_requested"; + state: "dismissed" | "approved" | "changes_requested"; + /** Format: date-time */ + submitted_at: string; /** Format: date-time */ - readonly submitted_at: string; + updated_at?: string | null; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review edited event */ - readonly "webhook-pull-request-review-edited": { + "webhook-pull-request-review-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body?: { + action: "edited"; + changes: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + review: components["schemas"]["webhooks_review"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_request_removed event */ - readonly "webhook-pull-request-review-request-removed": { + "webhook-pull-request-review-request-removed": { /** @enum {string} */ - readonly action: "review_request_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_request_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -69330,7 +73725,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -69338,329 +73733,339 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title. * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -69669,7 +74074,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -69677,76 +74082,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -69755,7 +74160,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -69763,803 +74168,813 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** User */ - readonly requested_reviewer: { + requested_reviewer: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ - readonly action: "review_request_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_request_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -70568,7 +74983,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -70576,76 +74991,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -70654,7 +75069,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -70662,250 +75077,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -70914,7 +75339,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -70922,76 +75347,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -71000,7 +75425,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -71008,822 +75433,832 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly requested_team: { - readonly deleted?: boolean; + requested_team: { + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request review_requested event */ - readonly "webhook-pull-request-review-requested": { + "webhook-pull-request-review-requested": { /** @enum {string} */ - readonly action: "review_requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_requested"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -71832,7 +76267,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -71840,76 +76275,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -71918,7 +76353,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -71926,250 +76361,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -72178,7 +76623,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -72186,76 +76631,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -72264,7 +76709,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -72272,803 +76717,813 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** User */ - readonly requested_reviewer: { + requested_reviewer: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; } | { /** @enum {string} */ - readonly action: "review_requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + action: "review_requested"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -73077,7 +77532,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -73085,76 +77540,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -73163,7 +77618,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -73171,250 +77626,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -73423,7 +77888,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -73431,76 +77896,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -73509,7 +77974,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -73517,818 +77982,828 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; /** * Team * @description Groups of organization members that gives permissions on specified repositories. */ - readonly requested_team: { - readonly deleted?: boolean; + requested_team: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review submitted event */ - readonly "webhook-pull-request-review-submitted": { + "webhook-pull-request-review-submitted": { /** @enum {string} */ - readonly action: "submitted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "submitted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -74337,7 +78812,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -74345,76 +78820,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -74423,7 +78898,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -74431,243 +78906,253 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -74676,7 +79161,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -74684,76 +79169,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -74762,7 +79247,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -74770,1461 +79255,1481 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly review: components["schemas"]["webhooks_review"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + review: components["schemas"]["webhooks_review"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request_review_thread resolved event */ - readonly "webhook-pull-request-review-thread-resolved": { + "webhook-pull-request-review-thread-resolved": { /** @enum {string} */ - readonly action: "resolved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "resolved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; - readonly thread: { - readonly comments: readonly { - readonly _links: { + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + thread: { + comments: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -76232,1213 +80737,1235 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; + original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }[]; - readonly node_id: string; + node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request_review_thread unresolved event */ - readonly "webhook-pull-request-review-thread-unresolved": { + "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ - readonly action: "unresolved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unresolved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + commit_title: string; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly closed_at: string | null; + body: string | null; + closed_at: string | null; /** Format: uri */ - readonly comments_url: string; + comments_url: string; /** Format: uri */ - readonly commits_url: string; - readonly created_at: string; + commits_url: string; + created_at: string; /** Format: uri */ - readonly diff_url: string; - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + diff_url: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; - readonly merge_commit_sha: string | null; - readonly merged_at: string | null; + locked: boolean; + merge_commit_sha: string | null; + merged_at: string | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; - readonly number: number; + node_id: string; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly requested_reviewers: readonly (({ + patch_url: string; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; + review_comment_url: string; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; - readonly title: string; - readonly updated_at: string; + statuses_url: string; + title: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; - readonly thread: { - readonly comments: readonly { - readonly _links: { + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; + thread: { + comments: { + _links: { /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly pull_request: { + pull_request: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @@ -77446,468 +81973,480 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description The text of the comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; + commit_id: string; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; + diff_hunk: string; /** * Format: uri * @description HTML URL for the pull request review comment. */ - readonly html_url: string; + html_url: string; /** @description The ID of the pull request review comment. */ - readonly id: number; + id: number; /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; + in_reply_to_id?: number; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; + line: number | null; /** @description The node ID of the pull request review comment. */ - readonly node_id: string; + node_id: string; /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; + original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; + original_line: number; /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; + original_position: number; /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; + original_start_line: number | null; /** @description The relative path of the file to which the comment applies. */ - readonly path: string; + path: string; /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; + position: number | null; /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; + pull_request_review_id: number | null; /** * Format: uri * @description URL for the pull request that the review comment belongs to. */ - readonly pull_request_url: string; + pull_request_url: string; /** Reactions */ - readonly reactions: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** * @description The side of the first line of the range for a multi-line comment. * @enum {string} */ - readonly side: "LEFT" | "RIGHT"; + side: "LEFT" | "RIGHT"; /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; + start_line: number | null; /** * @description The side of the first line of the range for a multi-line comment. * @default RIGHT * @enum {string|null} */ - readonly start_side: "LEFT" | "RIGHT" | null; + start_side: "LEFT" | "RIGHT" | null; /** * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** * Format: uri * @description URL for the pull request review comment */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }[]; - readonly node_id: string; + node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request synchronize event */ - readonly "webhook-pull-request-synchronize": { + "webhook-pull-request-synchronize": { /** @enum {string} */ - readonly action: "synchronize"; - readonly after: string; - readonly before: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "synchronize"; + after: string; + before: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -77916,7 +82455,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -77924,76 +82463,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -78002,7 +82541,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -78010,329 +82549,339 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit message title. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -78341,7 +82890,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -78349,766 +82898,776 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unassigned event */ - readonly "webhook-pull-request-unassigned": { + "webhook-pull-request-unassigned": { /** @enum {string} */ - readonly action: "unassigned"; - readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string | null; - readonly ref: string; + base: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -79117,7 +83676,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -79125,76 +83684,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -79203,7 +83762,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -79211,250 +83770,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -79463,7 +84032,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -79471,76 +84040,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -79549,7 +84118,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -79557,766 +84126,776 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** pull_request unlabeled event */ - readonly "webhook-pull-request-unlabeled": { + "webhook-pull-request-unlabeled": { /** @enum {string} */ - readonly action: "unlabeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly label?: components["schemas"]["webhooks_label"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unlabeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + commit_title: string | null; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -80325,7 +84904,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -80333,76 +84912,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -80411,7 +84990,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -80419,329 +84998,339 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + draft: boolean; + head: { + label: string | null; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit message title. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -80750,7 +85339,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -80758,765 +85347,775 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { + name: string; + node_id: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** pull_request unlocked event */ - readonly "webhook-pull-request-unlocked": { + "webhook-pull-request-unlocked": { /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: components["schemas"]["webhooks_number"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "unlocked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ - readonly pull_request: { - readonly _links: { + pull_request: { + _links: { /** Link */ - readonly comments: { + comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly commits: { + commits: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly html: { + html: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly issue: { + issue: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comment: { + review_comment: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly review_comments: { + review_comments: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly self: { + self: { /** Format: uri-template */ - readonly href: string; + href: string; }; /** Link */ - readonly statuses: { + statuses: { /** Format: uri-template */ - readonly href: string; + href: string; }; }; /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - readonly assignee: { + assignee: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly assignees: readonly ({ + assignees: ({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null)[]; /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ - readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + auto_merge: { /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; + commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + commit_title: string; /** User */ - readonly enabled_by: { + enabled_by: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method: "merge" | "squash" | "rebase"; + merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; + base: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -81525,7 +86124,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -81533,76 +86132,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -81611,7 +86210,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -81619,250 +86218,260 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly body: string | null; - readonly changed_files?: number; + body: string | null; + changed_files?: number; /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; + closed_at: string | null; + comments?: number; /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; + comments_url: string; + commits?: number; /** Format: uri */ - readonly commits_url: string; + commits_url: string; /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; + created_at: string; + deletions?: number; /** Format: uri */ - readonly diff_url: string; + diff_url: string; /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + draft: boolean; + head: { + label: string; + ref: string; /** * Repository * @description A git repository */ - readonly repo: { + repo: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** * @description The default value for a merge commit message. * @@ -81871,7 +86480,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -81879,76 +86488,76 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; + releases_url: string; + role_name?: string | null; + size: number; /** * @description The default value for a squash merge commit message: * @@ -81957,7 +86566,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a squash merge commit title: * @@ -81965,5727 +86574,6204 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** * @description Whether a squash 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; + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; } | null; - readonly sha: string; + sha: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly issue_url: string; - readonly labels: readonly { + issue_url: string; + labels: { /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; - readonly id: number; + color: string; + default: boolean; + description: string | null; + id: number; /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** * Format: uri * @description URL for the label */ - readonly url: string; + url: string; }[]; - readonly locked: boolean; + locked: boolean; /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; /** Format: date-time */ - readonly merged_at: string | null; + merged_at: string | null; /** User */ - readonly merged_by?: { + merged_by?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** * Milestone * @description A collection of related issues and pull requests. */ - readonly milestone: { + milestone: { /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - readonly created_at: string; + created_at: string; /** User */ - readonly creator: { + creator: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly description: string | null; + description: string | null; /** Format: date-time */ - readonly due_on: string | null; + due_on: string | null; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly labels_url: string; - readonly node_id: string; + labels_url: string; + node_id: string; /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + number: number; + open_issues: number; /** * @description The state of the milestone. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** @description The title of the milestone. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; } | null; - readonly node_id: string; + node_id: string; /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; + number: number; /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: readonly (({ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null) | { - readonly deleted?: boolean; + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; })[]; - readonly requested_teams: readonly { - readonly deleted?: boolean; + requested_teams: { + deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + description?: string | null; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url?: string; + members_url?: string; /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { + name: string; + node_id?: string; + parent?: { /** @description Description of the team */ - readonly description: string | null; + description: string | null; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the team */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly members_url: string; + members_url: string; /** @description Name of the team */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + permission: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + url?: string; }[]; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + review_comment_url: string; + review_comments?: number; /** Format: uri */ - readonly review_comments_url: string; + review_comments_url: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state: "open" | "closed"; + state: "open" | "closed"; /** Format: uri */ - readonly statuses_url: string; + statuses_url: string; /** @description The title of the pull request. */ - readonly title: string; + title: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** User */ - readonly user: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** push event */ - readonly "webhook-push": { + "webhook-push": { /** @description The SHA of the most recent commit on `ref` after the push. */ - readonly after: string; - readonly base_ref: components["schemas"]["webhooks_nullable_string"]; + after: string; + base_ref: components["schemas"]["webhooks_nullable_string"]; /** @description The SHA of the most recent commit on `ref` before the push. */ - readonly before: string; + before: string; /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */ - readonly commits: readonly { + commits: { /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ - readonly added?: readonly string[]; + added?: string[]; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; + distinct: boolean; + id: string; /** @description The commit message. */ - readonly message: string; + message: string; /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */ - readonly modified?: readonly string[]; + modified?: string[]; /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ - readonly removed?: readonly string[]; + removed?: string[]; /** * Format: date-time * @description The ISO 8601 timestamp of the commit. */ - readonly timestamp: string; - readonly tree_id: string; + timestamp: string; + tree_id: string; /** * Format: uri * @description URL that points to the commit API resource. */ - readonly url: string; + url: string; }[]; /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ - readonly compare: string; + compare: string; /** @description Whether this push created the `ref`. */ - readonly created: boolean; + created: boolean; /** @description Whether this push deleted the `ref`. */ - readonly deleted: boolean; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + deleted: boolean; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description Whether this push was a force push of the `ref`. */ - readonly forced: boolean; + forced: boolean; /** Commit */ - readonly head_commit: { + head_commit: { /** @description An array of files added in the commit. */ - readonly added?: readonly string[]; + added?: string[]; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; + distinct: boolean; + id: string; /** @description The commit message. */ - readonly message: string; + message: string; /** @description An array of files modified by the commit. */ - readonly modified?: readonly string[]; + modified?: string[]; /** @description An array of files removed in the commit. */ - readonly removed?: readonly string[]; + removed?: string[]; /** * Format: date-time * @description The ISO 8601 timestamp of the commit. */ - readonly timestamp: string; - readonly tree_id: string; + timestamp: string; + tree_id: string; /** * Format: uri * @description URL that points to the commit API resource. */ - readonly url: string; + url: string; } | null; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly pusher: { + pusher: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email?: string | null; + email?: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ - readonly ref: string; + ref: string; /** * Repository * @description A git repository */ - readonly repository: { + repository: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; + has_wiki: boolean; /** * @description Whether discussions are enabled. * @default false */ - readonly has_discussions: boolean; - readonly homepage: string | null; + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; - readonly sender?: components["schemas"]["simple-user"]; + sender?: components["schemas"]["simple-user"]; }; - readonly "webhook-registry-package-published": { + "webhook-registry-package-published": { /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; - }; - readonly package_type: string; - readonly package_version: { - readonly author?: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string | null; + description: string | null; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; + }; + package_type: string; + package_version: { + author?: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; }; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record | null; - readonly manifest?: Record | null; - readonly tag?: { - readonly digest?: string; - readonly name?: string; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; }; }; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: readonly { - readonly tags?: readonly string[]; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; }[]; - readonly draft?: boolean; - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: (string | Record) | null; - readonly bugs?: (string | Record) | null; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: (string | Record) | null; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: (string | Record) | null; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: readonly string[]; - readonly contributors?: readonly string[]; - readonly engines?: Record; - readonly keywords?: readonly string[]; - readonly files?: readonly string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: (string | Record) | null; - readonly os?: readonly string[]; - readonly cpu?: readonly string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: (string | Record) | null; + bugs?: (string | Record) | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: (string | Record) | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: (string | Record) | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: string[]; + contributors?: string[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: (string | Record) | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; } | null; - readonly nuget_metadata?: readonly { - readonly id?: (string | Record | number) | null; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; + nuget_metadata?: { + id?: (string | Record | number) | null; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; }; }[] | null; - readonly package_files: readonly { - readonly content_type: string; - readonly created_at: string; - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; + package_files: { + content_type: string; + created_at: string; + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author?: { - readonly avatar_url?: string; - readonly events_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organizations_url?: string; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly url?: string; - readonly user_view_type?: string; + package_url: string; + prerelease?: boolean; + release?: { + author?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly prerelease?: boolean; - readonly published_at?: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly url?: string; + created_at?: string; + draft?: boolean; + html_url?: string; + id?: number; + name?: string | null; + prerelease?: boolean; + published_at?: string; + tag_name?: string; + target_commitish?: string; + url?: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; } | null; - readonly registry: { - readonly about_url?: string; - readonly name?: string; - readonly type?: string; - readonly url?: string; - readonly vendor?: string; + registry: { + about_url?: string; + name?: string; + type?: string; + url?: string; + vendor?: string; } | null; - readonly updated_at: string | null; + updated_at: string | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; - readonly "webhook-registry-package-updated": { + "webhook-registry-package-updated": { /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string; - readonly description: unknown; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; - }; - readonly package_type: string; - readonly package_version: { - readonly author: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string; + description: unknown; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; + }; + package_type: string; + package_version: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; }; - readonly body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: readonly ({ - readonly tags?: readonly string[]; + body: string; + body_html: string; + created_at: string; + description: string; + docker_metadata?: ({ + tags?: string[]; } | null)[]; - readonly draft?: boolean; - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: readonly { - readonly [key: string]: unknown; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; }[]; - readonly name: string; - readonly package_files: readonly { - readonly content_type?: string; - readonly created_at?: string; - readonly download_url?: string; - readonly id?: number; - readonly md5?: string | null; - readonly name?: string; - readonly sha1?: string | null; - readonly sha256?: string; - readonly size?: number; - readonly state?: string; - readonly updated_at?: string; + name: string; + package_files: { + content_type?: string; + created_at?: string; + download_url?: string; + id?: number; + md5?: string | null; + name?: string; + sha1?: string | null; + sha256?: string; + size?: number; + state?: string; + updated_at?: string; }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; - readonly html_url: string; - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organizations_url: string; - readonly received_events_url: string; - readonly repos_url: string; - readonly site_admin: boolean; - readonly starred_url: string; - readonly subscriptions_url: string; - readonly type: string; - readonly url: string; - readonly user_view_type?: string; + package_url: string; + prerelease?: boolean; + release?: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; + user_view_type?: string; }; - readonly created_at: string; - readonly draft: boolean; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; - readonly url: string; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + url: string; }; - readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; - readonly registry: Record | null; - readonly updated_at: string; + registry: Record | null; + updated_at: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release created event */ - readonly "webhook-release-created": { + "webhook-release-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release deleted event */ - readonly "webhook-release-deleted": { + "webhook-release-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** release edited event */ - readonly "webhook-release-edited": { + "webhook-release-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body?: { + action: "edited"; + changes: { + body?: { /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; + from: string; + }; + tag_name?: { + /** @description The previous version of the tag_name if the action was `edited`. */ + from: string; }; - readonly make_latest?: { + make_latest?: { /** @description Whether this release was explicitly `edited` to be the latest. */ - readonly to: boolean; + to: boolean; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release prereleased event */ - readonly "webhook-release-prereleased": { + "webhook-release-prereleased": { /** @enum {string} */ - readonly action: "prereleased"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; + action: "prereleased"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; /** * Release * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. */ - readonly release: { - readonly assets: readonly ({ + release: { + assets: ({ /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + browser_download_url: string; + content_type: string; /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; + created_at: string; + download_count: number; + id: number; + label: string | null; /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + name: string; + node_id: string; + size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} */ - readonly state: "uploaded"; + state: "uploaded"; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** User */ - readonly uploader?: { + uploader?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; /** Format: uri */ - readonly assets_url: string; + assets_url: string; /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly body: string | null; + body: string | null; /** Format: date-time */ - readonly created_at: string | null; + created_at: string | null; /** Format: uri */ - readonly discussion_url?: string; + discussion_url?: string; /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; + name: string | null; + node_id: string; /** * @description Whether the release is identified as a prerelease or a full release. * @enum {boolean} */ - readonly prerelease: true; + prerelease: true; /** Format: date-time */ - readonly published_at: string | null; + published_at: string | null; /** Reactions */ - readonly reactions?: { - readonly "+1": number; - readonly "-1": number; - readonly confused: number; - readonly eyes: number; - readonly heart: number; - readonly hooray: number; - readonly laugh: number; - readonly rocket: number; - readonly total_count: number; - /** Format: uri */ - readonly url: string; + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; }; /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** Format: uri */ - readonly tarball_url: string | null; + tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; + target_commitish: string; /** Format: uri-template */ - readonly upload_url: string; + upload_url: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ - readonly url: string; + url: string; /** Format: uri */ - readonly zipball_url: string | null; + zipball_url: string | null; }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release published event */ - readonly "webhook-release-published": { + "webhook-release-published": { /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release released event */ - readonly "webhook-release-released": { + "webhook-release-released": { /** @enum {string} */ - readonly action: "released"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "released"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** release unpublished event */ - readonly "webhook-release-unpublished": { + "webhook-release-unpublished": { /** @enum {string} */ - readonly action: "unpublished"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action: "unpublished"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory published event */ - readonly "webhook-repository-advisory-published": { + "webhook-repository-advisory-published": { /** @enum {string} */ - readonly action: "published"; - 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 repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** Repository advisory reported event */ - readonly "webhook-repository-advisory-reported": { + "webhook-repository-advisory-reported": { /** @enum {string} */ - readonly action: "reported"; - 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 repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "reported"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** repository archived event */ - readonly "webhook-repository-archived": { + "webhook-repository-archived": { /** @enum {string} */ - readonly action: "archived"; - 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"]; + action: "archived"; + 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"]; }; /** repository created event */ - readonly "webhook-repository-created": { + "webhook-repository-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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"]; }; /** repository deleted event */ - readonly "webhook-repository-deleted": { + "webhook-repository-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + 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"]; }; /** repository_dispatch event */ - readonly "webhook-repository-dispatch-sample": { + "webhook-repository-dispatch-sample": { /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ - readonly action: string; - readonly branch: string; + action: string; + branch: string; /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ - readonly client_payload: { - readonly [key: string]: unknown; + client_payload: { + [key: string]: unknown; } | 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"]; + 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"]; }; /** repository edited event */ - readonly "webhook-repository-edited": { + "webhook-repository-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly default_branch?: { - readonly from: string; + action: "edited"; + changes: { + default_branch?: { + from: string; }; - readonly description?: { - readonly from: string | null; + description?: { + from: string | null; }; - readonly homepage?: { - readonly from: string | null; + homepage?: { + from: string | null; }; - readonly topics?: { - readonly from?: readonly string[] | null; + topics?: { + from?: 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"]; + 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"]; }; /** repository_import event */ - readonly "webhook-repository-import": { - 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"]; + "webhook-repository-import": { + 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"]; /** @enum {string} */ - readonly status: "success" | "cancelled" | "failure"; + status: "success" | "cancelled" | "failure"; }; /** repository privatized event */ - readonly "webhook-repository-privatized": { + "webhook-repository-privatized": { /** @enum {string} */ - readonly action: "privatized"; - 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"]; + action: "privatized"; + 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"]; }; /** repository publicized event */ - readonly "webhook-repository-publicized": { + "webhook-repository-publicized": { /** @enum {string} */ - readonly action: "publicized"; - 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"]; + action: "publicized"; + 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"]; }; /** repository renamed event */ - readonly "webhook-repository-renamed": { + "webhook-repository-renamed": { /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly repository: { - readonly name: { - readonly from: string; + action: "renamed"; + changes: { + repository: { + name: { + from: string; }; }; }; - 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"]; + 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"]; }; /** repository ruleset created event */ - readonly "webhook-repository-ruleset-created": { + "webhook-repository-ruleset-created": { /** @enum {string} */ - readonly action: "created"; - 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 repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset deleted event */ - readonly "webhook-repository-ruleset-deleted": { + "webhook-repository-ruleset-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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 repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user"]; }; /** repository ruleset edited event */ - readonly "webhook-repository-ruleset-edited": { + "webhook-repository-ruleset-edited": { /** @enum {string} */ - readonly action: "edited"; - 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 repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly changes?: { - readonly name?: { - readonly from?: string; - }; - readonly enforcement?: { - readonly from?: string; - }; - readonly conditions?: { - readonly added?: readonly components["schemas"]["repository-ruleset-conditions"][]; - readonly deleted?: readonly components["schemas"]["repository-ruleset-conditions"][]; - readonly updated?: readonly { - readonly condition?: components["schemas"]["repository-ruleset-conditions"]; - readonly changes?: { - readonly condition_type?: { - readonly from?: string; + action: "edited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; }; - readonly target?: { - readonly from?: string; + target?: { + from?: string; }; - readonly include?: { - readonly from?: readonly string[]; + include?: { + from?: string[]; }; - readonly exclude?: { - readonly from?: readonly string[]; + exclude?: { + from?: string[]; }; }; }[]; }; - readonly rules?: { - readonly added?: readonly components["schemas"]["repository-rule"][]; - readonly deleted?: readonly components["schemas"]["repository-rule"][]; - readonly updated?: readonly { - readonly rule?: components["schemas"]["repository-rule"]; - readonly changes?: { - readonly configuration?: { - readonly from?: string; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; }; - readonly rule_type?: { - readonly from?: string; + rule_type?: { + from?: string; }; - readonly pattern?: { - readonly from?: string; + pattern?: { + from?: string; }; }; }[]; }; }; - readonly sender: components["schemas"]["simple-user"]; + sender: components["schemas"]["simple-user"]; }; /** repository transferred event */ - readonly "webhook-repository-transferred": { + "webhook-repository-transferred": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly owner: { - readonly from: { + action: "transferred"; + changes: { + owner: { + from: { /** Organization */ - readonly organization?: { + organization?: { /** Format: uri */ - readonly avatar_url: string; - readonly description: string | null; + avatar_url: string; + description: string | null; /** Format: uri */ - readonly events_url: string; + events_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; + html_url?: string; + id: number; /** Format: uri */ - readonly issues_url: string; - readonly login: string; + issues_url: string; + login: string; /** Format: uri-template */ - readonly members_url: string; - readonly node_id: string; + members_url: string; + node_id: string; /** Format: uri-template */ - readonly public_members_url: string; + public_members_url: string; /** Format: uri */ - readonly repos_url: string; + repos_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** User */ - readonly user?: { + user?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; + html_url?: string; /** Format: int64 */ - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + 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"]; + 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"]; }; /** repository unarchived event */ - readonly "webhook-repository-unarchived": { + "webhook-repository-unarchived": { /** @enum {string} */ - readonly action: "unarchived"; - 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"]; + action: "unarchived"; + 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"]; }; /** repository_vulnerability_alert create event */ - readonly "webhook-repository-vulnerability-alert-create": { + "webhook-repository-vulnerability-alert-create": { /** @enum {string} */ - readonly action: "create"; - readonly alert: components["schemas"]["webhooks_alert"]; - 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"]; + action: "create"; + alert: components["schemas"]["webhooks_alert"]; + 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"]; }; /** repository_vulnerability_alert dismiss event */ - readonly "webhook-repository-vulnerability-alert-dismiss": { + "webhook-repository-vulnerability-alert-dismiss": { /** @enum {string} */ - readonly action: "dismiss"; + action: "dismiss"; /** * Repository Vulnerability Alert Alert * @description The security alert of the vulnerable dependency. */ - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_comment?: string | null; - readonly dismiss_reason: string; - readonly dismissed_at: string; + alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_comment?: string | null; + dismiss_reason: string; + dismissed_at: string; /** User */ - readonly dismisser: { + dismisser: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly external_identifier: string; + external_identifier: string; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; + external_reference: string | null; + fix_reason?: string; /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - readonly state: "dismissed"; + state: "dismissed"; }; - 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"]; + 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"]; }; /** repository_vulnerability_alert reopen event */ - readonly "webhook-repository-vulnerability-alert-reopen": { + "webhook-repository-vulnerability-alert-reopen": { /** @enum {string} */ - readonly action: "reopen"; - readonly alert: components["schemas"]["webhooks_alert"]; - 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"]; + action: "reopen"; + alert: components["schemas"]["webhooks_alert"]; + 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"]; }; /** repository_vulnerability_alert resolve event */ - readonly "webhook-repository-vulnerability-alert-resolve": { + "webhook-repository-vulnerability-alert-resolve": { /** @enum {string} */ - readonly action: "resolve"; + action: "resolve"; /** * Repository Vulnerability Alert Alert * @description The security alert of the vulnerable dependency. */ - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; + alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; /** User */ - readonly dismisser?: { + dismisser?: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; - readonly external_identifier: string; + external_identifier: string; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; + external_reference: string | null; + fix_reason?: string; /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - readonly state: "fixed" | "open"; + state: "fixed" | "open"; }; - 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"]; + 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 assigned event */ + "webhook-secret-scanning-alert-assigned": { + /** @enum {string} */ + action: "assigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 created event */ - readonly "webhook-secret-scanning-alert-created": { + "webhook-secret-scanning-alert-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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 Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created": { + "webhook-secret-scanning-alert-location-created": { /** @enum {string} */ - readonly action?: "created"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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"]; + action?: "created"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + installation?: components["schemas"]["simple-installation"]; + location: components["schemas"]["secret-scanning-location"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; }; /** Secret Scanning Alert Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created-form-encoded": { + "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; + payload: string; }; /** secret_scanning_alert publicly leaked event */ - readonly "webhook-secret-scanning-alert-publicly-leaked": { + "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"]; + 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 */ - readonly "webhook-secret-scanning-alert-reopened": { + "webhook-secret-scanning-alert-reopened": { /** @enum {string} */ - readonly action: "reopened"; - 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"]; + action: "reopened"; + 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 resolved event */ - readonly "webhook-secret-scanning-alert-resolved": { + "webhook-secret-scanning-alert-resolved": { + /** @enum {string} */ + action: "resolved"; + 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 unassigned event */ + "webhook-secret-scanning-alert-unassigned": { /** @enum {string} */ - readonly action: "resolved"; - 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"]; + action: "unassigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 validated event */ - readonly "webhook-secret-scanning-alert-validated": { + "webhook-secret-scanning-alert-validated": { /** @enum {string} */ - readonly action: "validated"; - 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"]; + action: "validated"; + 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_scan completed event */ - readonly "webhook-secret-scanning-scan-completed": { + "webhook-secret-scanning-scan-completed": { /** @enum {string} */ - readonly action: "completed"; + action: "completed"; /** * @description What type of scan was completed * @enum {string} */ - readonly type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; + type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill"; /** * @description What type of content was scanned * @enum {string} */ - readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; + source: "git" | "issues" | "pull-requests" | "discussions" | "wiki"; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at: string; + started_at: string; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at: string; + completed_at: string; /** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */ - readonly secret_types?: readonly string[] | null; + secret_types?: string[] | null; /** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */ - readonly custom_pattern_name?: string | null; + custom_pattern_name?: string | null; /** * @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated * @enum {string|null} */ - readonly custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; - readonly repository?: components["schemas"]["repository-webhooks"]; - 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"]; + custom_pattern_scope?: "repository" | "organization" | "enterprise" | null; + repository?: components["schemas"]["repository-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory published event */ - readonly "webhook-security-advisory-published": { + "webhook-security-advisory-published": { /** @enum {string} */ - readonly action: "published"; - 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 security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory updated event */ - readonly "webhook-security-advisory-updated": { + "webhook-security-advisory-updated": { /** @enum {string} */ - readonly action: "updated"; - 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 security_advisory: components["schemas"]["webhooks_security_advisory"]; - readonly sender?: components["schemas"]["simple-user"]; + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user"]; }; /** security_advisory withdrawn event */ - readonly "webhook-security-advisory-withdrawn": { + "webhook-security-advisory-withdrawn": { /** @enum {string} */ - readonly action: "withdrawn"; - 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"]; + action: "withdrawn"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cvss_severities?: components["schemas"]["cvss-severities"]; - readonly cwes: readonly { - readonly cwe_id: string; - readonly name: string; + security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cvss_severities?: components["schemas"]["cvss-severities"]; + cwes: { + cwe_id: string; + name: string; }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: readonly { - readonly type: string; - readonly value: string; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; }[]; - readonly published_at: string; - readonly references: readonly { + published_at: string; + references: { /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: readonly { - readonly first_patched_version: { - readonly identifier: string; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; + package: { + ecosystem: string; + name: string; }; - readonly severity: string; - readonly vulnerable_version_range: string; + severity: string; + vulnerable_version_range: string; }[]; - readonly withdrawn_at: string; + withdrawn_at: string; }; - readonly sender?: components["schemas"]["simple-user"]; + sender?: components["schemas"]["simple-user"]; }; /** security_and_analysis event */ - readonly "webhook-security-and-analysis": { - readonly changes: { - readonly from?: { - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + "webhook-security-and-analysis": { + changes: { + from?: { + security_and_analysis?: components["schemas"]["security-and-analysis"]; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - 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"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["full-repository"]; + sender?: components["schemas"]["simple-user"]; }; /** sponsorship cancelled event */ - readonly "webhook-sponsorship-cancelled": { + "webhook-sponsorship-cancelled": { /** @enum {string} */ - readonly action: "cancelled"; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "cancelled"; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship created event */ - readonly "webhook-sponsorship-created": { + "webhook-sponsorship-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "created"; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship edited event */ - readonly "webhook-sponsorship-edited": { + "webhook-sponsorship-edited": { /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly privacy_level?: { + action: "edited"; + changes: { + privacy_level?: { /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ - readonly from: string; + from: string; }; }; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_cancellation event */ - readonly "webhook-sponsorship-pending-cancellation": { + "webhook-sponsorship-pending-cancellation": { /** @enum {string} */ - readonly action: "pending_cancellation"; - readonly effective_date?: components["schemas"]["webhooks_effective_date"]; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "pending_cancellation"; + effective_date?: components["schemas"]["webhooks_effective_date"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship pending_tier_change event */ - readonly "webhook-sponsorship-pending-tier-change": { + "webhook-sponsorship-pending-tier-change": { /** @enum {string} */ - readonly action: "pending_tier_change"; - readonly changes: components["schemas"]["webhooks_changes_8"]; - readonly effective_date?: components["schemas"]["webhooks_effective_date"]; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "pending_tier_change"; + changes: components["schemas"]["webhooks_changes_8"]; + effective_date?: components["schemas"]["webhooks_effective_date"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** sponsorship tier_changed event */ - readonly "webhook-sponsorship-tier-changed": { + "webhook-sponsorship-tier-changed": { /** @enum {string} */ - readonly action: "tier_changed"; - readonly changes: components["schemas"]["webhooks_changes_8"]; - 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"]; - readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + action: "tier_changed"; + changes: components["schemas"]["webhooks_changes_8"]; + 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"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ - readonly "webhook-star-created": { + "webhook-star-created": { /** @enum {string} */ - readonly action: "created"; - 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"]; + action: "created"; + 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"]; /** @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; + starred_at: string | null; }; /** star deleted event */ - readonly "webhook-star-deleted": { + "webhook-star-deleted": { /** @enum {string} */ - readonly action: "deleted"; - 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"]; + action: "deleted"; + 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"]; /** @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; + starred_at: unknown; }; /** status event */ - readonly "webhook-status": { + "webhook-status": { /** Format: uri */ - readonly avatar_url?: string | null; + avatar_url?: string | null; /** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */ - readonly branches: readonly { - readonly commit: { - readonly sha: string | null; + branches: { + commit: { + sha: string | null; /** Format: uri */ - readonly url: string | null; + url: string | null; }; - readonly name: string; - readonly protected: boolean; + name: string; + protected: boolean; }[]; - readonly commit: { + commit: { /** User */ - readonly author: { + author: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly comments_url: string; - readonly commit: { - readonly author: { + comments_url: string; + commit: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; } & { - readonly date: string; - readonly email?: string; - readonly name?: string; + date: string; + email?: string; + name?: string; }; - readonly comment_count: number; - readonly committer: { + comment_count: number; + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; } & { - readonly date: string; - readonly email?: string; - readonly name?: string; + date: string; + email?: string; + name?: string; }; - readonly message: string; - readonly tree: { - readonly sha: string; + message: string; + tree: { + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly url: string; - readonly verification: { - readonly payload: string | null; + url: string; + verification: { + payload: string | null; /** @enum {string} */ - readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; - readonly signature: string | null; - readonly verified: boolean; - readonly verified_at?: string | null; + reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; + signature: string | null; + verified: boolean; + verified_at: string | null; }; }; /** User */ - readonly committer: { + committer: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id?: number; - readonly login?: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly html_url: string; - readonly node_id: string; - readonly parents: readonly { + html_url: string; + node_id: string; + parents: { /** Format: uri */ - readonly html_url: string; - readonly sha: string; + html_url: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly sha: string; + sha: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly context: string; - readonly created_at: string; + context: string; + created_at: string; /** @description The optional human-readable description added to the status. */ - readonly description: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; /** @description The unique identifier of the status. */ - readonly id: number; - readonly installation?: components["schemas"]["simple-installation"]; - readonly name: string; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; + id: number; + installation?: components["schemas"]["simple-installation"]; + name: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; /** @description The Commit SHA. */ - readonly sha: string; + sha: string; /** * @description The new state. Can be `pending`, `success`, `failure`, or `error`. * @enum {string} */ - readonly state: "pending" | "success" | "failure" | "error"; + state: "pending" | "success" | "failure" | "error"; /** @description The optional link added to the status. */ - readonly target_url: string | null; - readonly updated_at: string; + target_url: string | null; + updated_at: string; }; /** parent issue added event */ - readonly "webhook-sub-issues-parent-issue-added": { + "webhook-sub-issues-parent-issue-added": { /** @enum {string} */ - readonly action: "parent_issue_added"; + action: "parent_issue_added"; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - readonly parent_issue_repo: components["schemas"]["repository"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - 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"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** parent issue removed event */ - readonly "webhook-sub-issues-parent-issue-removed": { + "webhook-sub-issues-parent-issue-removed": { /** @enum {string} */ - readonly action: "parent_issue_removed"; + action: "parent_issue_removed"; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - readonly parent_issue_repo: components["schemas"]["repository"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + parent_issue_repo: components["schemas"]["repository"]; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - 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"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue added event */ - readonly "webhook-sub-issues-sub-issue-added": { + "webhook-sub-issues-sub-issue-added": { /** @enum {string} */ - readonly action: "sub_issue_added"; + action: "sub_issue_added"; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - readonly sub_issue_repo: components["schemas"]["repository"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - 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"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** sub-issue removed event */ - readonly "webhook-sub-issues-sub-issue-removed": { + "webhook-sub-issues-sub-issue-removed": { /** @enum {string} */ - readonly action: "sub_issue_removed"; + action: "sub_issue_removed"; /** @description The ID of the sub-issue. */ - readonly sub_issue_id: number; - readonly sub_issue: components["schemas"]["issue"]; - readonly sub_issue_repo: components["schemas"]["repository"]; + sub_issue_id: number; + sub_issue: components["schemas"]["issue"]; + sub_issue_repo: components["schemas"]["repository"]; /** @description The ID of the parent issue. */ - readonly parent_issue_id: number; - readonly parent_issue: components["schemas"]["issue"]; - 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"]; + parent_issue_id: number; + parent_issue: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; }; /** team_add event */ - readonly "webhook-team-add": { - 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"]; - readonly team: components["schemas"]["webhooks_team_1"]; + "webhook-team-add": { + 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"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ - readonly "webhook-team-added-to-repository": { + "webhook-team-added-to-repository": { /** @enum {string} */ - readonly action: "added_to_repository"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "added_to_repository"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ - readonly "webhook-team-created": { + "webhook-team-created": { /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ - readonly "webhook-team-deleted": { + "webhook-team-deleted": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender?: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender?: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ - readonly "webhook-team-edited": { + "webhook-team-edited": { /** @enum {string} */ - readonly action: "edited"; + action: "edited"; /** @description The changes to the team if the action was `edited`. */ - readonly changes: { - readonly description?: { + changes: { + description?: { /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly name?: { + name?: { /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly privacy?: { + privacy?: { /** @description The previous version of the team's privacy if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly notification_setting?: { + notification_setting?: { /** @description The previous version of the team's notification setting if the action was `edited`. */ - readonly from: string; + from: string; }; - readonly repository?: { - readonly permissions: { - readonly from: { + repository?: { + permissions: { + from: { /** @description The previous version of the team member's `admin` permission on a repository, if the action was `edited`. */ - readonly admin?: boolean; + admin?: boolean; /** @description The previous version of the team member's `pull` permission on a repository, if the action was `edited`. */ - readonly pull?: boolean; + pull?: boolean; /** @description The previous version of the team member's `push` permission on a repository, if the action was `edited`. */ - readonly push?: boolean; + push?: boolean; }; }; }; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ - readonly "webhook-team-removed-from-repository": { + "webhook-team-removed-from-repository": { /** @enum {string} */ - readonly action: "removed_from_repository"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; + action: "removed_from_repository"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; /** * Repository * @description A git repository */ - readonly repository?: { + repository?: { /** * @description Whether to allow auto-merge for pull requests. * @default false */ - readonly allow_auto_merge: boolean; + allow_auto_merge: boolean; /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true */ - readonly allow_merge_commit: boolean; + allow_merge_commit: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true */ - readonly allow_rebase_merge: boolean; + allow_rebase_merge: boolean; /** * @description Whether to allow squash merges for pull requests. * @default true */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** * @description Whether the repository is archived. * @default false */ - readonly archived: boolean; + archived: boolean; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri */ - readonly clone_url: string; + clone_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; + contributors_url: string; + created_at: number | string; /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; /** @description The default branch of the repository. */ - readonly default_branch: string; + default_branch: string; /** * @description Whether to delete head branches when pull requests are merged * @default false */ - readonly delete_branch_on_merge: boolean; + delete_branch_on_merge: boolean; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + disabled?: boolean; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly git_url: string; + git_url: string; /** * @description Whether downloads are enabled. * @default true */ - readonly has_downloads: boolean; + has_downloads: boolean; /** * @description Whether issues are enabled. * @default true */ - readonly has_issues: boolean; - readonly has_pages: boolean; + has_issues: boolean; + has_pages: boolean; /** * @description Whether projects are enabled. * @default true */ - readonly has_projects: boolean; + has_projects: boolean; /** * @description Whether the wiki is enabled. * @default true */ - readonly has_wiki: boolean; - readonly homepage: string | null; + has_wiki: boolean; + homepage: string | null; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** * Format: int64 * @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; + id: number; + is_template?: boolean; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + labels_url: string; + language: string | null; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - readonly url: string | null; + url: string | null; } | null; - readonly master_branch?: string; + master_branch?: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** Format: uri */ - readonly mirror_url: string | null; + mirror_url: string | null; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; + private: boolean; + public?: boolean; /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + pulls_url: string; + pushed_at: (number | string) | null; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly svn_url: string; + svn_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: readonly string[]; + teams_url: string; + topics: string[]; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; + url: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; }; - readonly sender: components["schemas"]["simple-user"]; - readonly team: components["schemas"]["webhooks_team_1"]; + sender: components["schemas"]["simple-user"]; + team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ - readonly "webhook-watch-started": { + "webhook-watch-started": { /** @enum {string} */ - readonly action: "started"; - 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"]; + action: "started"; + 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"]; }; /** workflow_dispatch event */ - readonly "webhook-workflow-dispatch": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly inputs: { - readonly [key: string]: unknown; + "webhook-workflow-dispatch": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + inputs: { + [key: string]: unknown; } | null; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user"]; - readonly workflow: string; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + workflow: string; }; /** workflow_job completed event */ - readonly "webhook-workflow-job-completed": { + "webhook-workflow-job-completed": { /** @enum {string} */ - readonly action: "completed"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; + action: "completed"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; + conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; + created_at: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; /** Format: uri */ - readonly run_url: string; + run_url: string; /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_id: number | null; + runner_group_id: number | null; /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_name: string | null; + runner_group_name: string | null; /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_id: number | null; + runner_id: number | null; /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_name: string | null; - readonly started_at: string; + runner_name: string | null; + started_at: string; /** * @description The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`. * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; + status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: readonly { - readonly completed_at: string | null; + workflow_name: string | null; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "queued"; + status: "in_progress" | "completed" | "queued"; }[]; /** Format: uri */ - readonly url: string; + url: string; } & { - readonly check_run_url?: string; - readonly completed_at?: string; + check_run_url?: string; + completed_at?: string; /** @enum {string} */ - readonly conclusion: "success" | "failure" | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; + conclusion: "success" | "failure" | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out"; /** @description The time that the job created. */ - readonly created_at?: string; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly (string | null)[]; - readonly name?: string; - readonly node_id?: string; - readonly run_attempt?: number; - readonly run_id?: number; - readonly run_url?: string; - readonly runner_group_id?: number | null; - readonly runner_group_name?: string | null; - readonly runner_id?: number | null; - readonly runner_name?: string | null; - readonly started_at?: string; - readonly status?: string; + created_at?: string; + head_sha?: string; + html_url?: string; + id?: number; + labels?: (string | null)[]; + name?: string; + node_id?: string; + run_attempt?: number; + run_id?: number; + run_url?: string; + runner_group_id?: number | null; + runner_group_name?: string | null; + runner_id?: number | null; + runner_name?: string | null; + started_at?: string; + status?: string; /** @description The name of the current branch. */ - readonly head_branch?: string | null; + head_branch?: string | null; /** @description The name of the workflow. */ - readonly workflow_name?: string | null; - readonly steps?: readonly (Record | null)[]; - readonly url?: string; + workflow_name?: string | null; + steps?: (Record | null)[]; + url?: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_job in_progress event */ - readonly "webhook-workflow-job-in-progress": { + "webhook-workflow-job-in-progress": { /** @enum {string} */ - readonly action: "in_progress"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; + action: "in_progress"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | null | "cancelled" | "neutral"; + conclusion: "success" | "failure" | null | "cancelled" | "neutral"; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; + created_at: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */ - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; /** Format: uri */ - readonly run_url: string; + run_url: string; /** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_id: number | null; + runner_group_id: number | null; /** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_group_name: string | null; + runner_group_name: string | null; /** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_id: number | null; + runner_id: number | null; /** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */ - readonly runner_name: string | null; - readonly started_at: string; + runner_name: string | null; + started_at: string; /** * @description The current status of the job. Can be `queued`, `in_progress`, or `completed`. * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed"; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: readonly { - readonly completed_at: string | null; + workflow_name: string | null; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | null | "cancelled"; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | null | "cancelled"; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "queued" | "pending"; + status: "in_progress" | "completed" | "queued" | "pending"; }[]; /** Format: uri */ - readonly url: string; + url: string; } & { - readonly check_run_url?: string; - readonly completed_at?: string | null; - readonly conclusion?: string | null; + check_run_url?: string; + completed_at?: string | null; + conclusion?: string | null; /** @description The time that the job created. */ - readonly created_at?: string; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly labels?: readonly string[]; - readonly name?: string; - readonly node_id?: string; - readonly run_attempt?: number; - readonly run_id?: number; - readonly run_url?: string; - readonly runner_group_id?: number | null; - readonly runner_group_name?: string | null; - readonly runner_id?: number | null; - readonly runner_name?: string | null; - readonly started_at?: string; + created_at?: string; + head_sha?: string; + html_url?: string; + id?: number; + labels?: string[]; + name?: string; + node_id?: string; + run_attempt?: number; + run_id?: number; + run_url?: string; + runner_group_id?: number | null; + runner_group_name?: string | null; + runner_id?: number | null; + runner_name?: string | null; + started_at?: string; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "queued"; + status: "in_progress" | "completed" | "queued"; /** @description The name of the current branch. */ - readonly head_branch?: string | null; + head_branch?: string | null; /** @description The name of the workflow. */ - readonly workflow_name?: string | null; - readonly steps: readonly { - readonly completed_at: string | null; - readonly conclusion: string | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + workflow_name?: string | null; + steps: { + completed_at: string | null; + conclusion: string | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "in_progress" | "completed" | "pending" | "queued"; + status: "in_progress" | "completed" | "pending" | "queued"; }[]; - readonly url?: string; + url?: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_job queued event */ - readonly "webhook-workflow-job-queued": { + "webhook-workflow-job-queued": { /** @enum {string} */ - readonly action: "queued"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; - readonly conclusion: string | null; + action: "queued"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; + conclusion: string | null; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; - /** Format: uri */ - readonly run_url: string; - readonly runner_group_id: number | null; - readonly runner_group_name: string | null; - readonly runner_id: number | null; - readonly runner_name: string | null; + created_at: string; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; + /** Format: uri */ + run_url: string; + runner_group_id: number | null; + runner_group_name: string | null; + runner_id: number | null; + runner_name: string | null; /** Format: date-time */ - readonly started_at: string; + started_at: string; /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; + status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: readonly { - readonly completed_at: string | null; + workflow_name: string | null; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending"; + status: "completed" | "in_progress" | "queued" | "pending"; }[]; /** Format: uri */ - readonly url: string; + url: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_job waiting event */ - readonly "webhook-workflow-job-waiting": { + "webhook-workflow-job-waiting": { /** @enum {string} */ - readonly action: "waiting"; - 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"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; - readonly conclusion: string | null; + action: "waiting"; + 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"]; + workflow_job: { + /** Format: uri */ + check_run_url: string; + completed_at: string | null; + conclusion: string | null; /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly labels: readonly string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; - /** Format: uri */ - readonly run_url: string; - readonly runner_group_id: number | null; - readonly runner_group_name: string | null; - readonly runner_id: number | null; - readonly runner_name: string | null; + created_at: string; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + labels: string[]; + name: string; + node_id: string; + run_attempt: number; + run_id: number; + /** Format: uri */ + run_url: string; + runner_group_id: number | null; + runner_group_name: string | null; + runner_id: number | null; + runner_name: string | null; /** Format: date-time */ - readonly started_at: string; + started_at: string; /** @description The name of the current branch. */ - readonly head_branch: string | null; + head_branch: string | null; /** @description The name of the workflow. */ - readonly workflow_name: string | null; + workflow_name: string | null; /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; - readonly steps: readonly { - readonly completed_at: string | null; + status: "queued" | "in_progress" | "completed" | "waiting"; + steps: { + completed_at: string | null; /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; }[]; /** Format: uri */ - readonly url: string; + url: string; }; - readonly deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["deployment"]; }; /** workflow_run completed event */ - readonly "webhook-workflow-run-completed": { + "webhook-workflow-run-completed": { /** @enum {string} */ - readonly action: "completed"; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + action: "completed"; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly artifacts_url: string; + artifacts_url: string; /** Format: uri */ - readonly cancel_url: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; + cancel_url: string; + check_suite_id: number; + check_suite_node_id: string; /** Format: uri */ - readonly check_suite_url: string; + check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string | null; + created_at: string; + event: string; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** Repository Lite */ - readonly head_repository: { + head_repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly jobs_url: string; + jobs_url: string; /** Format: uri */ - readonly logs_url: string; - readonly name: string | null; - readonly node_id: string; - readonly path: string; + logs_url: string; + name: string | null; + node_id: string; + path: string; /** Format: uri */ - readonly previous_attempt_url: string | null; - readonly pull_requests: readonly ({ - readonly base: { - readonly ref: string; + previous_attempt_url: string | null; + pull_requests: ({ + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; /** Repository Lite */ - readonly repository: { + repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly rerun_url: string; - readonly run_attempt: number; - readonly run_number: number; + rerun_url: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; + status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; + url: string; + workflow_id: number; /** Format: uri */ - readonly workflow_url: string; + workflow_url: string; /** * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. * @example Simple Workflow */ - readonly display_title?: string; + display_title?: string; }; }; /** workflow_run in_progress event */ - readonly "webhook-workflow-run-in-progress": { + "webhook-workflow-run-in-progress": { /** @enum {string} */ - readonly action: "in_progress"; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + action: "in_progress"; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: uri */ - readonly artifacts_url: string; + artifacts_url: string; /** Format: uri */ - readonly cancel_url: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; + cancel_url: string; + check_suite_id: number; + check_suite_node_id: string; /** Format: uri */ - readonly check_suite_url: string; + check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string | null; + created_at: string; + event: string; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** Repository Lite */ - readonly head_repository: { + head_repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string | null; - readonly node_id: string; + name: string | null; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly jobs_url: string; + jobs_url: string; /** Format: uri */ - readonly logs_url: string; - readonly name: string | null; - readonly node_id: string; - readonly path: string; + logs_url: string; + name: string | null; + node_id: string; + path: string; /** Format: uri */ - readonly previous_attempt_url: string | null; - readonly pull_requests: readonly ({ - readonly base: { - readonly ref: string; + previous_attempt_url: string | null; + pull_requests: ({ + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; } | null)[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; /** Repository Lite */ - readonly repository: { + repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly rerun_url: string; - readonly run_attempt: number; - readonly run_number: number; + rerun_url: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending"; + status: "requested" | "in_progress" | "completed" | "queued" | "pending"; /** User */ - readonly triggering_actor: { + triggering_actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; + url?: string; } | null; /** Format: date-time */ - readonly updated_at: string; + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; + url: string; + workflow_id: number; /** Format: uri */ - readonly workflow_url: string; + workflow_url: string; }; }; /** workflow_run requested event */ - readonly "webhook-workflow-run-requested": { + "webhook-workflow-run-requested": { /** @enum {string} */ - readonly action: "requested"; - 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"]; - readonly workflow: components["schemas"]["webhooks_workflow"]; + action: "requested"; + 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"]; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ - readonly workflow_run: { + workflow_run: { /** User */ - readonly actor: { + actor: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** Format: uri */ - readonly artifacts_url: string; + artifacts_url: string; /** Format: uri */ - readonly cancel_url: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; + cancel_url: string; + check_suite_id: number; + check_suite_node_id: string; /** Format: uri */ - readonly check_suite_url: string; + check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string | null; + created_at: string; + event: string; + head_branch: string | null; /** SimpleCommit */ - readonly head_commit: { + head_commit: { /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly author: { + author: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; /** * Committer * @description Metaproperties for Git author/committer information. */ - readonly committer: { + committer: { /** Format: date-time */ - readonly date?: string; + date?: string; /** Format: email */ - readonly email: string | null; + email: string | null; /** @description The git author's name. */ - readonly name: string; - readonly username?: string; + name: string; + username?: string; }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; + id: string; + message: string; + timestamp: string; + tree_id: string; }; /** Repository Lite */ - readonly head_repository: { + head_repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly head_sha: string; + head_sha: string; /** Format: uri */ - readonly html_url: string; - readonly id: number; + html_url: string; + id: number; /** Format: uri */ - readonly jobs_url: string; + jobs_url: string; /** Format: uri */ - readonly logs_url: string; - readonly name: string | null; - readonly node_id: string; - readonly path: string; + logs_url: string; + name: string | null; + node_id: string; + path: string; /** Format: uri */ - readonly previous_attempt_url: string | null; - readonly pull_requests: readonly { - readonly base: { - readonly ref: string; + previous_attempt_url: string | null; + pull_requests: { + base: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly head: { - readonly ref: string; + head: { + ref: string; /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; + repo: { + id: number; + name: string; /** Format: uri */ - readonly url: string; + url: string; }; - readonly sha: string; + sha: string; }; - readonly id: number; - readonly number: number; + id: number; + number: number; /** Format: uri */ - readonly url: string; + url: string; }[]; - readonly referenced_workflows?: readonly { - readonly path: string; - readonly ref?: string; - readonly sha: string; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; }[] | null; /** Repository Lite */ - readonly repository: { + repository: { /** Format: uri-template */ - readonly archive_url: string; + archive_url: string; /** Format: uri-template */ - readonly assignees_url: string; + assignees_url: string; /** Format: uri-template */ - readonly blobs_url: string; + blobs_url: string; /** Format: uri-template */ - readonly branches_url: string; + branches_url: string; /** Format: uri-template */ - readonly collaborators_url: string; + collaborators_url: string; /** Format: uri-template */ - readonly comments_url: string; + comments_url: string; /** Format: uri-template */ - readonly commits_url: string; + commits_url: string; /** Format: uri-template */ - readonly compare_url: string; + compare_url: string; /** Format: uri-template */ - readonly contents_url: string; + contents_url: string; /** Format: uri */ - readonly contributors_url: string; + contributors_url: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; + deployments_url: string; + description: string | null; /** Format: uri */ - readonly downloads_url: string; + downloads_url: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; + events_url: string; + fork: boolean; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; + forks_url: string; + full_name: string; /** Format: uri-template */ - readonly git_commits_url: string; + git_commits_url: string; /** Format: uri-template */ - readonly git_refs_url: string; + git_refs_url: string; /** Format: uri-template */ - readonly git_tags_url: string; + git_tags_url: string; /** Format: uri */ - readonly hooks_url: string; + hooks_url: string; /** Format: uri */ - readonly html_url: string; + html_url: string; /** @description Unique identifier of the repository */ - readonly id: number; + id: number; /** Format: uri-template */ - readonly issue_comment_url: string; + issue_comment_url: string; /** Format: uri-template */ - readonly issue_events_url: string; + issue_events_url: string; /** Format: uri-template */ - readonly issues_url: string; + issues_url: string; /** Format: uri-template */ - readonly keys_url: string; + keys_url: string; /** Format: uri-template */ - readonly labels_url: string; + labels_url: string; /** Format: uri */ - readonly languages_url: string; + languages_url: string; /** Format: uri */ - readonly merges_url: string; + merges_url: string; /** Format: uri-template */ - readonly milestones_url: string; + milestones_url: string; /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + name: string; + node_id: string; /** Format: uri-template */ - readonly notifications_url: string; + notifications_url: string; /** User */ - readonly owner: { + owner: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; /** @description Whether the repository is private or public. */ - readonly private: boolean; + private: boolean; /** Format: uri-template */ - readonly pulls_url: string; + pulls_url: string; /** Format: uri-template */ - readonly releases_url: string; + releases_url: string; /** Format: uri */ - readonly stargazers_url: string; + stargazers_url: string; /** Format: uri-template */ - readonly statuses_url: string; + statuses_url: string; /** Format: uri */ - readonly subscribers_url: string; + subscribers_url: string; /** Format: uri */ - readonly subscription_url: string; + subscription_url: string; /** Format: uri */ - readonly tags_url: string; + tags_url: string; /** Format: uri */ - readonly teams_url: string; + teams_url: string; /** Format: uri-template */ - readonly trees_url: string; + trees_url: string; /** Format: uri */ - readonly url: string; + url: string; }; /** Format: uri */ - readonly rerun_url: string; - readonly run_attempt: number; - readonly run_number: number; + rerun_url: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - readonly run_started_at: string; + run_started_at: string; /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; + status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting"; + /** User */ + triggering_actor: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + /** Format: uri */ + workflow_url: string; + display_title: string; + }; + }; + /** CreateEvent */ + "create-event": { + ref: string; + ref_type: string; + full_ref: string; + master_branch: string; + description?: string | null; + pusher_type: string; + }; + /** DeleteEvent */ + "delete-event": { + ref: string; + ref_type: string; + full_ref: string; + pusher_type: string; + }; + /** DiscussionEvent */ + "discussion-event": { + action: string; + discussion: components["schemas"]["discussion"]; + }; + /** IssuesEvent */ + "issues-event": { + action: string; + issue: components["schemas"]["issue"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** IssueCommentEvent */ + "issue-comment-event": { + action: string; + issue: components["schemas"]["issue"]; + comment: components["schemas"]["issue-comment"]; + }; + /** ForkEvent */ + "fork-event": { + action: string; + forkee: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + private?: boolean; + owner?: components["schemas"]["simple-user"]; + html_url?: string; + description?: string | null; + fork?: boolean; + url?: string; + forks_url?: string; + keys_url?: string; + collaborators_url?: string; + teams_url?: string; + hooks_url?: string; + issue_events_url?: string; + events_url?: string; + assignees_url?: string; + branches_url?: string; + tags_url?: string; + blobs_url?: string; + git_tags_url?: string; + git_refs_url?: string; + trees_url?: string; + statuses_url?: string; + languages_url?: string; + stargazers_url?: string; + contributors_url?: string; + subscribers_url?: string; + subscription_url?: string; + commits_url?: string; + git_commits_url?: string; + comments_url?: string; + issue_comment_url?: string; + contents_url?: string; + compare_url?: string; + merges_url?: string; + archive_url?: string; + downloads_url?: string; + issues_url?: string; + pulls_url?: string; + milestones_url?: string; + notifications_url?: string; + labels_url?: string; + releases_url?: string; + deployments_url?: string; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + /** Format: date-time */ + pushed_at?: string | null; + git_url?: string; + ssh_url?: string; + clone_url?: string; + svn_url?: string; + homepage?: string | null; + size?: number; + stargazers_count?: number; + watchers_count?: number; + language?: string | null; + has_issues?: boolean; + has_projects?: boolean; + has_downloads?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + forks_count?: number; + mirror_url?: string | null; + archived?: boolean; + disabled?: boolean; + open_issues_count?: number; + license?: components["schemas"]["nullable-license-simple"]; + allow_forking?: boolean; + is_template?: boolean; + web_commit_signoff_required?: boolean; + topics?: string[]; + visibility?: string; + forks?: number; + open_issues?: number; + watchers?: number; + default_branch?: string; + public?: boolean; + }; + }; + /** GollumEvent */ + "gollum-event": { + pages: { + page_name?: string | null; + title?: string | null; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + /** MemberEvent */ + "member-event": { + action: string; + member: components["schemas"]["simple-user"]; + }; + /** PublicEvent */ + "public-event": Record; + /** PushEvent */ + "push-event": { + repository_id: number; + push_id: number; + ref: string; + head: string; + before: string; + }; + /** PullRequestEvent */ + "pull-request-event": { + action: string; + number: number; + pull_request: components["schemas"]["pull-request-minimal"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** PullRequestReviewCommentEvent */ + "pull-request-review-comment-event": { + action: string; + pull_request: components["schemas"]["pull-request-minimal"]; + comment: { + id: number; + node_id: string; + /** Format: uri */ + url: string; + pull_request_review_id: number | null; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + subject_type?: string | null; + commit_id: string; /** User */ - readonly triggering_actor: { + user: { /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - readonly events_url?: string; + events_url?: string; /** Format: uri */ - readonly followers_url?: string; + followers_url?: string; /** Format: uri-template */ - readonly following_url?: string; + following_url?: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - readonly organizations_url?: string; + organizations_url?: string; /** Format: uri */ - readonly received_events_url?: string; + received_events_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - readonly starred_url?: string; + starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly url?: string; - readonly user_view_type?: string; + url?: string; + user_view_type?: string; } | null; + body: string; /** Format: date-time */ - readonly updated_at: string; + created_at: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - readonly url: string; - readonly workflow_id: number; + html_url: string; + /** Format: uri */ + pull_request_url: string; + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + original_commit_id: string; + /** Reactions */ + reactions: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + /** Format: uri */ + url?: string; + }; + in_reply_to_id?: number; + }; + }; + /** PullRequestReviewEvent */ + "pull-request-review-event": { + action: string; + review: { + id?: number; + node_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + body?: string; + commit_id?: string; + submitted_at?: string | null; + state?: string; + /** Format: uri */ + html_url?: string; + /** Format: uri */ + pull_request_url?: string; + _links?: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + updated_at?: string; + }; + pull_request: components["schemas"]["pull-request-minimal"]; + }; + /** CommitCommentEvent */ + "commit-comment-event": { + action: string; + comment: { /** Format: uri */ - readonly workflow_url: string; - readonly display_title: string; + html_url?: string; + /** Format: uri */ + url?: string; + id?: number; + node_id?: string; + body?: string; + path?: string | null; + position?: number | null; + line?: number | null; + commit_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + }; + /** ReleaseEvent */ + "release-event": { + action: string; + release: components["schemas"]["release"] & { + is_short_description_html_truncated?: boolean; + short_description_html?: string; }; }; + /** WatchEvent */ + "watch-event": { + action: string; + }; }; responses: { /** @description Validation failed, or the endpoint has been spammed. */ - readonly validation_failed_simple: { + validation_failed_simple: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["validation-error-simple"]; }; }; /** @description Resource not found */ - readonly not_found: { + not_found: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ - readonly bad_request: { + bad_request: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; - readonly "application/scim+json": components["schemas"]["scim-error"]; + "application/json": components["schemas"]["basic-error"]; + "application/scim+json": components["schemas"]["scim-error"]; }; }; /** @description Validation failed, or the endpoint has been spammed. */ - readonly validation_failed: { + validation_failed: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"]; + "application/json": components["schemas"]["validation-error"]; }; }; /** @description Accepted */ - readonly accepted: { + accepted: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": Record; + "application/json": Record; }; }; /** @description Not modified */ - readonly not_modified: { + not_modified: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Requires authentication */ - readonly requires_authentication: { + requires_authentication: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Forbidden */ - readonly forbidden: { + forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Internal Error */ + internal_error: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Conflict */ - readonly conflict: { + conflict: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description A header with no content is returned. */ - readonly no_content: { + no_content: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Service unavailable */ - readonly service_unavailable: { + service_unavailable: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + code?: string; + message?: string; + documentation_url?: string; }; }; }; /** @description Forbidden Gist */ - readonly forbidden_gist: { + forbidden_gist: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly block?: { - readonly reason?: string; - readonly created_at?: string; - readonly html_url?: string | null; + "application/json": { + block?: { + reason?: string; + created_at?: string; + html_url?: string | null; }; - readonly message?: string; - readonly documentation_url?: string; + message?: string; + documentation_url?: string; }; }; }; /** @description Moved permanently */ - readonly moved_permanently: { + moved_permanently: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response when getting all budgets */ + get_all_budgets: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get_all_budgets"]; + }; + }; + /** @description Response when updating a budget */ + budget: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get-budget"]; + }; + }; + /** @description Response when deleting a budget */ + "delete-budget": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["delete-budget"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-org"]; }; }; /** @description Billing usage report response for an organization */ - readonly billing_usage_report_org: { + billing_usage_report_org: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["billing-usage-report"]; + "application/json": components["schemas"]["billing-usage-report"]; }; }; - /** @description Internal Error */ - readonly internal_error: { + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_org: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-summary-report-org"]; }; }; /** @description Response */ - readonly actions_runner_jitconfig: { + actions_runner_jitconfig: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly runner: components["schemas"]["runner"]; + "application/json": { + runner: components["schemas"]["runner"]; /** @description The base64 encoded runner configuration. */ - readonly encoded_jit_config: string; + encoded_jit_config: string; }; }; }; /** @description Response */ - readonly actions_runner_labels: { + actions_runner_labels: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly labels: readonly components["schemas"]["runner-label"][]; + "application/json": { + total_count: number; + labels: components["schemas"]["runner-label"][]; }; }; }; /** @description Response */ - readonly actions_runner_labels_readonly: { + actions_runner_labels_readonly: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly labels: readonly components["schemas"]["runner-label"][]; + "application/json": { + total_count: number; + labels: components["schemas"]["runner-label"][]; }; }; }; + /** @description Payload Too Large */ + too_large: { + headers: { + [name: string]: unknown; + }; + content: { + "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: { + usage_metrics_api_disabled: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */ - readonly package_es_list_error: { + package_es_list_error: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - /** @description Gone */ - readonly gone: { + /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */ + enterprise_team_unsupported: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Temporary Redirect */ + temporary_redirect: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Temporary Redirect */ - readonly temporary_redirect: { + /** @description Gone */ + gone: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if GitHub Advanced Security is not enabled for this repository */ - readonly code_scanning_forbidden_read: { + code_scanning_forbidden_read: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */ - readonly code_scanning_forbidden_write: { + code_scanning_forbidden_write: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Bad Request */ - readonly code_scanning_bad_request: { + code_scanning_bad_request: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */ - readonly code_scanning_autofix_create_forbidden: { + code_scanning_autofix_create_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response if analysis could not be processed */ + unprocessable_analysis: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Found */ - readonly found: { + found: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if there is already a validation run in progress with a different default setup configuration */ - readonly code_scanning_conflict: { + code_scanning_conflict: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ - readonly dependency_review_forbidden: { + /** @description Response if the configuration change cannot be made because the repository is not in the required state */ + code_scanning_invalid_state: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */ + dependency_review_forbidden: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unavailable due to service under maintenance. */ - readonly porter_maintenance: { + porter_maintenance: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; /** @description Unacceptable */ - readonly unacceptable: { + unacceptable: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report_user: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-summary-report-user"]; }; }; }; parameters: { /** @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 "pagination-before": string; + "pagination-before": string; /** @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 "pagination-after": string; + "pagination-after": string; /** @description The direction to sort the results by. */ - readonly direction: "asc" | "desc"; + direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: string; + ghsa_id: string; /** @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": number; + "per-page": number; /** @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: string; - readonly "delivery-id": number; + cursor: string; + "delivery-id": number; /** @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: number; + page: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since: string; + since: string; /** @description The unique identifier of the installation. */ - readonly "installation-id": number; + "installation-id": number; /** @description The client ID of the GitHub app. */ - readonly "client-id": string; - readonly "app-slug": string; + "client-id": string; + "app-slug": string; /** @description The unique identifier of the classroom assignment. */ - readonly "assignment-id": number; + "assignment-id": number; /** @description The unique identifier of the classroom. */ - readonly "classroom-id": number; - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ - readonly enterprise: string; + "classroom-id": number; + /** @description The slug version of the enterprise name. */ + enterprise: string; /** @description The unique identifier of the code security configuration. */ - readonly "configuration-id": number; + "configuration-id": number; /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly "dependabot-alert-comma-separated-states": string; + "dependabot-alert-comma-separated-states": string; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly "dependabot-alert-comma-separated-severities": string; + "dependabot-alert-comma-separated-severities": string; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly "dependabot-alert-comma-separated-ecosystems": string; + "dependabot-alert-comma-separated-ecosystems": string; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly "dependabot-alert-comma-separated-packages": string; + "dependabot-alert-comma-separated-packages": string; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -87694,1748 +92780,2002 @@ export interface components { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly "dependabot-alert-comma-separated-epss": string; + "dependabot-alert-comma-separated-epss": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + "dependabot-alert-comma-separated-has": string | "patch"[]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + "dependabot-alert-comma-separated-assignees": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly "dependabot-alert-scope": "development" | "runtime"; + "dependabot-alert-scope": "development" | "runtime"; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly "pagination-first": number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly "pagination-last": number; - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly "secret-scanning-alert-secret-type": string; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly "secret-scanning-alert-resolution": string; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - 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; + "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": string; + /** @description The handle for the GitHub user account. */ + username: string; + /** @description The organization name. The name is not case sensitive. */ + org: string; + /** @description The slug of the team name. */ + "team-slug": string; + /** @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)." */ + "public-events-per-page": number; /** @description The unique identifier of the gist. */ - readonly "gist-id": string; + "gist-id": string; /** @description The unique identifier of the comment. */ - readonly "comment-id": number; + "comment-id": number; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels: string; + labels: string; /** @description account_id parameter */ - readonly "account-id": number; + "account-id": number; /** @description The unique identifier of the plan. */ - readonly "plan-id": number; + "plan-id": number; /** @description The property to sort the results by. */ - readonly sort: "created" | "updated"; + sort: "created" | "updated"; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: string; + owner: string; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: string; + repo: string; /** @description If `true`, show notifications marked as read. */ - readonly all: boolean; + all: boolean; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating: boolean; + participating: boolean; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before: string; + before: string; /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly "thread-id": number; + "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - readonly "since-org": number; - /** @description The organization name. The name is not case sensitive. */ - readonly org: string; - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ - readonly "billing-usage-report-year": number; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - readonly "billing-usage-report-month": number; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ - readonly "billing-usage-report-day": number; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - readonly "billing-usage-report-hour": number; + "since-org": number; + /** @description The ID corresponding to the budget. */ + budget: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + "billing-usage-report-year": number; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + "billing-usage-report-month-default": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + "billing-usage-report-day": number; + /** @description The user name to query usage for. The name is not case sensitive. */ + "billing-usage-report-user": string; + /** @description The model name to query usage for. The name is not case sensitive. */ + "billing-usage-report-model": string; + /** @description The product name to query usage for. The name is not case sensitive. */ + "billing-usage-report-product": string; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + "billing-usage-report-month": number; + /** @description The repository name to query for usage in the format owner/repository. */ + "billing-usage-report-repository": string; + /** @description The SKU to query for usage. */ + "billing-usage-report-sku": string; + /** @description Image definition ID of custom image */ + "actions-custom-image-definition-id": number; + /** @description Version of a custom image */ + "actions-custom-image-version": string; /** @description Unique identifier of the GitHub-hosted runner. */ - readonly "hosted-runner-id": number; + "hosted-runner-id": number; /** @description The unique identifier of the repository. */ - readonly "repository-id": number; + "repository-id": number; /** @description Only return runner groups that are allowed to be used by this repository. */ - readonly "visible-to-repository": string; + "visible-to-repository": string; /** @description Unique identifier of the self-hosted runner group. */ - readonly "runner-group-id": number; + "runner-group-id": number; /** @description Unique identifier of the self-hosted runner. */ - readonly "runner-id": number; + "runner-id": number; /** @description The name of a self-hosted runner's custom label. */ - readonly "runner-label-name": string; + "runner-label-name": string; /** @description The name of the secret. */ - readonly "secret-name": string; + "secret-name": string; /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly "variables-per-page": number; + "variables-per-page": number; /** @description The name of the variable. */ - readonly "variable-name": string; - /** @description The handle for the GitHub user account. */ - readonly username: string; + "variable-name": string; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + "subject-digest": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; + "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + "dependabot-alert-comma-separated-artifact-registry-urls": string; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + "dependabot-alert-comma-separated-artifact-registry": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + "dependabot-alert-comma-separated-runtime-risk": string; /** @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; + "hook-id": number; /** @description The type of the actor */ - readonly "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; + "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server"; /** @description The ID of the actor */ - readonly "api-insights-actor-id": number; + "api-insights-actor-id": number; /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "api-insights-min-timestamp": string; + "api-insights-min-timestamp": string; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "api-insights-max-timestamp": string; + "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")[]; + "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[]; /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - readonly "api-insights-api-route-substring": string; + "api-insights-api-route-substring": string; /** @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")[]; + "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[]; /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - readonly "api-insights-subject-name-substring": string; + "api-insights-subject-name-substring": string; /** @description The ID of the user to query for stats */ - readonly "api-insights-user-id": string; + "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; + "api-insights-timestamp-increment": string; /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - readonly "api-insights-actor-name-substring": string; + "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ - readonly "invitation-id": number; + "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ - readonly "codespace-name": string; + "codespace-name": string; /** @description The unique identifier of the migration. */ - readonly "migration-id": number; + "migration-id": number; /** @description repo_name parameter */ - readonly "repo-name": string; - /** @description The slug of the team name. */ - readonly "team-slug": string; + "repo-name": string; /** @description The unique identifier of the role. */ - readonly "role-id": number; + "role-id": number; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly "package-visibility": "public" | "private" | "internal"; + "package-visibility": "public" | "private" | "internal"; /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** @description The name of the package. */ - readonly "package-name": string; + "package-name": string; /** @description Unique identifier of the package version. */ - readonly "package-version-id": number; + "package-version-id": number; /** @description The property by which to sort the results. */ - readonly "personal-access-token-sort": "created_at"; + "personal-access-token-sort": "created_at"; /** @description A list of owner usernames to use to filter the results. */ - readonly "personal-access-token-owner": readonly string[]; + "personal-access-token-owner": string[]; /** @description The name of the repository to use to filter the results. */ - readonly "personal-access-token-repository": string; + "personal-access-token-repository": string; /** @description The permission to use to filter the results. */ - readonly "personal-access-token-permission": string; + "personal-access-token-permission": string; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "personal-access-token-before": string; + "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "personal-access-token-after": string; + "personal-access-token-after": string; + /** @description The ID of the token */ + "personal-access-token-token-id": string[]; /** @description The unique identifier of the fine-grained personal access token. */ - readonly "fine-grained-personal-access-token-id": number; + "fine-grained-personal-access-token-id": number; + /** @description The project's number. */ + "project-number": number; + /** @description The unique identifier of the field. */ + "field-id": number; + /** @description The unique identifier of the project item. */ + "item-id": number; + /** @description The number that identifies the project view. */ + "view-number": number; /** @description The custom property name */ - readonly "custom-property-name": string; + "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; + "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; + "ref-in-query": string; /** @description The name of the repository to filter on. */ - readonly "repository-name-in-query": string; + "repository-name-in-query": string; /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ - readonly "time-period": "hour" | "day" | "week" | "month"; + "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - readonly "actor-name-in-query": string; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - readonly "rule-suite-result": "pass" | "fail" | "bypass" | "all"; + "actor-name-in-query": string; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + "rule-suite-result": "pass" | "fail" | "bypass" | "all"; /** * @description The unique identifier of the rule suite result. * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) * for organizations. */ - readonly "rule-suite-id": number; + "rule-suite-id": number; + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + "secret-scanning-alert-resolution": string; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + "secret-scanning-alert-assignee": string; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + "secret-scanning-alert-sort": "created" | "updated"; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - readonly "secret-scanning-pagination-before-org-repo": string; + "secret-scanning-pagination-before-org-repo": string; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - readonly "secret-scanning-pagination-after-org-repo": string; + "secret-scanning-pagination-after-org-repo": string; + /** @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 A boolean value representing whether or not to hide literal secrets in the results. */ + "secret-scanning-alert-hide-secret": boolean; /** @description Unique identifier of the hosted compute network configuration. */ - readonly "network-configuration-id": string; + "network-configuration-id": string; /** @description Unique identifier of the hosted compute network settings. */ - readonly "network-settings-id": string; - /** @description The number that identifies the discussion. */ - readonly "discussion-number": number; - /** @description The number that identifies the comment. */ - readonly "comment-number": number; - /** @description The unique identifier of the reaction. */ - readonly "reaction-id": number; - /** @description The unique identifier of the project. */ - readonly "project-id": number; + "network-settings-id": string; /** @description The security feature to enable or disable. */ - readonly "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; + "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; /** * @description The action to take. * * `enable_all` means to enable the specified security feature for all repositories in the organization. * `disable_all` means to disable the specified security feature for all repositories in the organization. */ - readonly "org-security-product-enablement": "enable_all" | "disable_all"; - /** @description The unique identifier of the card. */ - readonly "card-id": number; - /** @description The unique identifier of the column. */ - readonly "column-id": number; + "org-security-product-enablement": "enable_all" | "disable_all"; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - readonly "artifact-name": string; + "artifact-name": string; /** @description The unique identifier of the artifact. */ - readonly "artifact-id": number; + "artifact-id": number; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - readonly "actions-cache-git-ref-full": string; + "actions-cache-git-ref-full": string; /** @description An explicit key or prefix for identifying the cache */ - readonly "actions-cache-key": string; + "actions-cache-key": string; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - readonly "actions-cache-list-sort": "created_at" | "last_accessed_at" | "size_in_bytes"; + "actions-cache-list-sort": "created_at" | "last_accessed_at" | "size_in_bytes"; /** @description A key for identifying the cache. */ - readonly "actions-cache-key-required": string; + "actions-cache-key-required": string; /** @description The unique identifier of the GitHub Actions cache. */ - readonly "cache-id": number; + "cache-id": number; /** @description The unique identifier of the job. */ - readonly "job-id": number; + "job-id": number; /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor: string; + actor: string; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly "workflow-run-branch": string; + "workflow-run-branch": string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event: string; + event: string; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ - readonly "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; + "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created: string; + created: string; /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly "exclude-pull-requests": boolean; + "exclude-pull-requests": boolean; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly "workflow-run-check-suite-id": number; + "workflow-run-check-suite-id": number; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - readonly "workflow-run-head-sha": string; + "workflow-run-head-sha": string; /** @description The unique identifier of the workflow run. */ - readonly "run-id": number; + "run-id": number; /** @description The attempt number of the workflow run. */ - readonly "attempt-number": number; + "attempt-number": number; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly "workflow-id": number | string; + "workflow-id": number | string; /** @description The unique identifier of the autolink. */ - readonly "autolink-id": number; + "autolink-id": number; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: string; + branch: string; /** @description The unique identifier of the check run. */ - readonly "check-run-id": number; + "check-run-id": number; /** @description The unique identifier of the check suite. */ - readonly "check-suite-id": number; + "check-suite-id": number; /** @description Returns check runs with the specified `name`. */ - readonly "check-name": string; + "check-name": string; /** @description Returns check runs with the specified `status`. */ - readonly status: "queued" | "in_progress" | "completed"; + 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"]; + "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; + "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"]; + "alert-number": components["schemas"]["alert-number"]; + /** @description The unique identifier of the reaction. */ + "reaction-id": number; /** @description The SHA of the commit. */ - readonly "commit-sha": string; + "commit-sha": string; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly "commit-ref": string; + "commit-ref": string; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - readonly "dependabot-alert-comma-separated-manifests": string; + "dependabot-alert-comma-separated-manifests": string; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, * or in `number` fields in the response from the * `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */ - readonly "dependabot-alert-number": components["schemas"]["alert-number"]; + "dependabot-alert-number": components["schemas"]["alert-number"]; /** @description The full path, relative to the repository root, of the dependency manifest file. */ - readonly "manifest-path": string; + "manifest-path": string; /** @description deployment_id parameter */ - readonly "deployment-id": number; + "deployment-id": number; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly "environment-name": string; + "environment-name": string; /** @description The unique identifier of the branch policy. */ - readonly "branch-policy-id": number; + "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ - readonly "protection-rule-id": number; + "protection-rule-id": number; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly "git-ref-only": string; + "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly "since-user": number; + "since-user": number; /** @description The number that identifies the issue. */ - readonly "issue-number": number; + "issue-number": number; /** @description The unique identifier of the key. */ - readonly "key-id": number; + "key-id": number; /** @description The number that identifies the milestone. */ - readonly "milestone-number": number; + "milestone-number": number; /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ - readonly "pages-deployment-id": number | string; + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ - readonly "pull-number": number; + "pull-number": number; /** @description The unique identifier of the review. */ - readonly "review-id": number; + "review-id": number; /** @description The unique identifier of the asset. */ - readonly "asset-id": number; + "asset-id": number; /** @description The unique identifier of the release. */ - readonly "release-id": number; - /** @description The unique identifier of the tag protection. */ - readonly "tag-protection-id": number; + "release-id": number; /** @description The time frame to display results for. */ - readonly per: "day" | "week"; + per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - readonly "since-repo": number; + "since-repo": number; /** @description 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"; + order: "desc" | "asc"; + /** + * @description Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + "issues-advanced-search": string; /** @description The unique identifier of the team. */ - readonly "team-id": number; + "team-id": number; /** @description ID of the Repository to filter on */ - readonly "repository-id-in-query": number; + "repository-id-in-query": number; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - readonly "export-id": string; + "export-id": string; /** @description The unique identifier of the GPG key. */ - readonly "gpg-key-id": number; + "gpg-key-id": number; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "since-repo-date": string; + "since-repo-date": string; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly "before-repo-date": string; + "before-repo-date": string; /** @description The unique identifier of the SSH signing key. */ - readonly "ssh-signing-key-id": number; + "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - readonly "sort-starred": "created" | "updated"; + "sort-starred": "created" | "updated"; + /** @description The unique identifier of the user. */ + "user-id": string; }; requestBodies: never; headers: { /** @example ; rel="next", ; rel="last" */ - readonly link: string; + link: string; /** @example text/html */ - readonly "content-type": string; + "content-type": string; /** @example 0.17.4 */ - readonly "x-common-marker-version": string; + "x-common-marker-version": string; /** @example 5000 */ - readonly "x-rate-limit-limit": number; + "x-rate-limit-limit": number; /** @example 4999 */ - readonly "x-rate-limit-remaining": number; + "x-rate-limit-remaining": number; /** @example 1590701888 */ - readonly "x-rate-limit-reset": number; + "x-rate-limit-reset": number; /** @example https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D */ - readonly location: string; + location: string; }; pathItems: never; } export type $defs = Record; export interface operations { - readonly "meta/root": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/root": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["root"]; + "application/json": components["schemas"]["root"]; }; }; }; }; - readonly "security-advisories/list-global-advisories": { - readonly parameters: { - readonly query?: { + "security-advisories/list-global-advisories": { + parameters: { + query?: { /** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */ - readonly ghsa_id?: string; + ghsa_id?: string; /** @description If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. */ - readonly type?: "reviewed" | "malware" | "unreviewed"; + type?: "reviewed" | "malware" | "unreviewed"; /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ - readonly cve_id?: string; + cve_id?: string; /** @description If specified, only advisories for these ecosystems will be returned. */ - readonly ecosystem?: components["schemas"]["security-advisory-ecosystems"]; + ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ - readonly severity?: "unknown" | "low" | "medium" | "high" | "critical"; + severity?: "unknown" | "low" | "medium" | "high" | "critical"; /** * @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. * * Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22` */ - readonly cwes?: string | readonly string[]; + cwes?: string | string[]; /** @description Whether to only return advisories that have been withdrawn. */ - readonly is_withdrawn?: boolean; + is_withdrawn?: boolean; /** * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ - readonly affects?: string | readonly string[]; + affects?: string | string[]; /** * @description If specified, only return advisories that were published on a date or date range. * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly published?: string; + published?: string; /** * @description If specified, only return advisories that were updated on a date or date range. * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly updated?: string; + updated?: string; /** * @description If specified, only show advisories that were updated or published on a date or date range. * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly modified?: string; + modified?: string; /** * @description If specified, only return advisories that have an EPSS percentage score that matches the provided value. * The EPSS percentage represents the likelihood of a CVE being exploited. */ - readonly epss_percentage?: string; + epss_percentage?: string; /** * @description If specified, only return advisories that have an EPSS percentile score that matches the provided value. * The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. */ - readonly epss_percentile?: string; + epss_percentile?: string; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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?: number; + per_page?: number; /** @description The property to sort the results by. */ - readonly sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; + sort?: "updated" | "published" | "epss_percentage" | "epss_percentile"; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["global-advisory"][]; + "application/json": components["schemas"]["global-advisory"][]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed_simple"]; /** @description Too many requests */ - readonly 429: { + 429: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "security-advisories/get-global-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/get-global-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["global-advisory"]; + "application/json": components["schemas"]["global-advisory"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/get-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"]; + "application/json": components["schemas"]["integration"]; }; }; }; }; - readonly "apps/create-from-manifest": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly code: string; + "apps/create-from-manifest": { + parameters: { + query?: never; + header?: never; + path: { + code: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"] & ({ - readonly client_id: string; - readonly client_secret: string; - readonly webhook_secret: string | null; - readonly pem: string; + "application/json": components["schemas"]["integration"] & ({ + client_id: string; + client_secret: string; + webhook_secret: string | null; + pem: string; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }); }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "apps/get-webhook-config-for-app": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/get-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "apps/update-webhook-config-for-app": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/update-webhook-config-for-app": { + parameters: { + query?: never; + header?: never; + path?: never; + 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"]; + 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"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "apps/list-webhook-deliveries": { - readonly parameters: { - readonly query?: { + "apps/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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + cursor?: components["parameters"]["cursor"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly delivery_id: components["parameters"]["delivery-id"]; + "apps/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["hook-delivery"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/redeliver-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly delivery_id: components["parameters"]["delivery-id"]; + "apps/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/list-installation-requests-for-authenticated-app": { - readonly parameters: { - readonly query?: { + "apps/list-installation-requests-for-authenticated-app": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description List of integration installation requests */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration-installation-request"][]; + "application/json": components["schemas"]["integration-installation-request"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "apps/list-installations": { - readonly parameters: { - readonly query?: { + "apps/list-installations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; - readonly outdated?: string; + since?: components["parameters"]["since"]; + outdated?: string; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The permissions the installation has are included under the `permissions` key. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["installation"][]; + "application/json": components["schemas"]["installation"][]; }; }; }; }; - readonly "apps/get-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/delete-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/delete-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/create-installation-access-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/create-installation-access-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description List of repository names that the token should have access to */ - readonly repositories?: readonly string[]; + repositories?: string[]; /** * @description List of repository IDs that the token should have access to * @example [ * 1 * ] */ - readonly repository_ids?: readonly number[]; - readonly permissions?: components["schemas"]["app-permissions"]; + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation-token"]; + "application/json": components["schemas"]["installation-token"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/suspend-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/suspend-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/unsuspend-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/unsuspend-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/delete-authorization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/delete-authorization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The OAuth access token used to authenticate to the GitHub API. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/check-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/check-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The access_token of the OAuth or GitHub application. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authorization"]; + "application/json": components["schemas"]["authorization"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/delete-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/delete-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The OAuth access token used to authenticate to the GitHub API. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/reset-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/reset-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The access_token of the OAuth or GitHub application. */ - readonly access_token: string; + access_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authorization"]; + "application/json": components["schemas"]["authorization"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/scope-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/scope-token": { + parameters: { + query?: never; + header?: never; + path: { /** @description The client ID of the GitHub app. */ - readonly client_id: components["parameters"]["client-id"]; + client_id: components["parameters"]["client-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The access token used to authenticate to the GitHub API. * @example e72e16c7e42f292c6912e7710c838347ae178b4a */ - readonly access_token: string; + access_token: string; /** * @description The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified. * @example octocat */ - readonly target?: string; + target?: string; /** * @description The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified. * @example 1 */ - readonly target_id?: number; + target_id?: number; /** @description The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. */ - readonly repositories?: readonly string[]; + repositories?: string[]; /** * @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified. * @example [ * 1 * ] */ - readonly repository_ids?: readonly number[]; - readonly permissions?: components["schemas"]["app-permissions"]; + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authorization"]; + "application/json": components["schemas"]["authorization"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-by-slug": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly app_slug: components["parameters"]["app-slug"]; + "apps/get-by-slug": { + parameters: { + query?: never; + header?: never; + path: { + app_slug: components["parameters"]["app-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["integration"]; + "application/json": components["schemas"]["integration"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/get-an-assignment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "classroom/get-an-assignment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the classroom assignment. */ - readonly assignment_id: components["parameters"]["assignment-id"]; + assignment_id: components["parameters"]["assignment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["classroom-assignment"]; + "application/json": components["schemas"]["classroom-assignment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-accepted-assignments-for-an-assignment": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the classroom assignment. */ - readonly assignment_id: components["parameters"]["assignment-id"]; + assignment_id: components["parameters"]["assignment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["classroom-accepted-assignment"][]; + "application/json": components["schemas"]["classroom-accepted-assignment"][]; }; }; }; }; - readonly "classroom/get-assignment-grades": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "classroom/get-assignment-grades": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the classroom assignment. */ - readonly assignment_id: components["parameters"]["assignment-id"]; + assignment_id: components["parameters"]["assignment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["classroom-assignment-grade"][]; + "application/json": components["schemas"]["classroom-assignment-grade"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-classrooms": { - readonly parameters: { - readonly query?: { + "classroom/list-classrooms": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-classroom"][]; + "application/json": components["schemas"]["simple-classroom"][]; }; }; }; }; - readonly "classroom/get-a-classroom": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "classroom/get-a-classroom": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the classroom. */ - readonly classroom_id: components["parameters"]["classroom-id"]; + classroom_id: components["parameters"]["classroom-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["classroom"]; + "application/json": components["schemas"]["classroom"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "classroom/list-assignments-for-a-classroom": { - readonly parameters: { - readonly query?: { + "classroom/list-assignments-for-a-classroom": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the classroom. */ - readonly classroom_id: components["parameters"]["classroom-id"]; + classroom_id: components["parameters"]["classroom-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-classroom-assignment"][]; + "application/json": components["schemas"]["simple-classroom-assignment"][]; }; }; }; }; - readonly "codes-of-conduct/get-all-codes-of-conduct": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "codes-of-conduct/get-all-codes-of-conduct": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-of-conduct"][]; + "application/json": components["schemas"]["code-of-conduct"][]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "codes-of-conduct/get-conduct-code": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly key: string; + "codes-of-conduct/get-conduct-code": { + parameters: { + query?: never; + header?: never; + path: { + key: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-of-conduct"]; + "application/json": components["schemas"]["code-of-conduct"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "emojis/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + /** @description A list of credentials to be revoked, up to 1000 per request. */ + credentials: string[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; + }; + }; + "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly [key: string]: string; + "application/json": { + [key: string]: string; }; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "code-security/get-configurations-for-enterprise": { - readonly parameters: { - readonly query?: { + "actions/get-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "code-security/get-configurations-for-enterprise": { + 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)." */ - readonly per_page?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + "application/json": components["schemas"]["code-security-configuration"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/create-configuration-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/create-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique within the enterprise. */ - readonly name: string; + name: string; /** @description A description of the code security configuration */ - readonly description: string; + description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @default disabled * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. * @default false */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @default disabled * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @default disabled * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @default disabled * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning validity checks * @default disabled * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non provider patterns * @default disabled * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @default enforced * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Successfully created code security configuration */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-default-configurations-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/get-default-configurations-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-default-configurations"]; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; }; }; - readonly "code-security/get-single-configuration-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/get-single-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/delete-configuration-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/delete-configuration-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - }; - }; - readonly "code-security/update-enterprise-configuration": { - readonly parameters: { - readonly query?: never; - 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"]; + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + }; + }; + "code-security/update-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique across the enterprise. */ - readonly name?: string; + name?: string; /** @description A description of the code security configuration */ - readonly description?: string; + description?: string; /** - * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of code scanning default setup * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/attach-enterprise-configuration": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/attach-enterprise-configuration": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** - * @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` + * @description The type of repositories to attach the configuration to. * @enum {string} */ - readonly scope: "all" | "all_without_configurations"; + scope: "all" | "all_without_configurations"; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/set-configuration-as-default-for-enterprise": { - readonly parameters: { - readonly query?: never; - 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"]; + "code-security/set-configuration-as-default-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Specify which types of repository this security configuration should be applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; }; }; - readonly responses: { + responses: { /** @description Default successfully changed. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description Specifies which types of repository this security configuration is applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-repositories-for-enterprise-configuration": { - readonly parameters: { - readonly query?: { + "code-security/get-repositories-for-enterprise-configuration": { + 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)." */ - readonly per_page?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. * * Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ - readonly status?: string; + status?: string; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependabot/list-alerts-for-enterprise": { - readonly parameters: { - readonly query?: { + "dependabot/list-alerts-for-enterprise": { + parameters: { + query?: { /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -89444,203 +94784,693 @@ export interface operations { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly scope?: components["parameters"]["dependabot-alert-scope"]; + scope?: components["parameters"]["dependabot-alert-scope"]; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly sort?: components["parameters"]["dependabot-alert-sort"]; + sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + 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"]; + 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly last?: components["parameters"]["pagination-last"]; + after?: components["parameters"]["pagination-after"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["dependabot-alert-with-repository"][]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "secret-scanning/list-alerts-for-enterprise": { - readonly parameters: { - readonly query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + "enterprise-teams/list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; - /** @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 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"]; + 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"]; }; - 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"]; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["enterprise-team"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-public-events": { - readonly parameters: { - readonly query?: { + "enterprise-teams/create": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description A description of the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be set. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + }; + }; + "enterprise-team-memberships/list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; + }; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to add to the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully added team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to be removed from the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully removed team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User is a member of the enterprise team. */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["simple-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 503: components["responses"]["service_unavailable"]; }; }; - readonly "activity/get-feeds": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "enterprise-team-memberships/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { + /** @description Successfully added team member */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-team-organizations/get-assignments": { + 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 slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description An array of organizations the team is assigned to */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to assign the team to. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully assigned the enterprise team to organizations. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to unassign the team from. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully unassigned the enterprise team from organizations. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/get-assignment": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The team is assigned to the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + /** @description The team is not assigned to the organization */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully assigned the enterprise team to the organization. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + }; + }; + "enterprise-team-organizations/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully unassigned the enterprise team from the organization. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-teams/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A new name for the team. */ + name?: string | null; + /** @description A new description for the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be changed. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/list-public-events": { + 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"]["public-events-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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["feed"]; + "application/json": components["schemas"]["event"][]; }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "gists/list": { - readonly parameters: { - readonly query?: { + "activity/get-feeds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["feed"]; + }; + }; + }; + }; + "gists/list": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "gists/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "gists/create": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Description of the gist * @example Example Ruby script */ - readonly description?: string; + description?: string; /** * @description Names and content for the files that make up the gist * @example { @@ -89649,164 +95479,164 @@ export interface operations { * } * } */ - readonly files: { - readonly [key: string]: { + files: { + [key: string]: { /** @description Content of the file */ - readonly content: string; + content: string; }; }; - readonly public?: boolean | ("true" | "false"); + public?: boolean | ("true" | "false"); }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/list-public": { - readonly parameters: { - readonly query?: { + "gists/list-public": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/list-starred": { - readonly parameters: { - readonly query?: { + "gists/list-starred": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "gists/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden_gist"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden_gist"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/delete": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The description of the gist. * @example Example Ruby script */ - readonly description?: string; + description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename * (including extension) of the targeted gist file. For example: `hello.py`. @@ -89820,1336 +95650,1776 @@ export interface operations { * } * } */ - readonly files?: { - readonly [key: string]: { + files?: { + [key: string]: { /** @description The new content of the file. */ - readonly content?: string; + content?: string; /** @description The new filename for the file. */ - readonly filename?: string | null; + filename?: string | null; } | null; }; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/list-comments": { - readonly parameters: { - readonly query?: { + "gists/list-comments": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gist-comment"][]; + "application/json": components["schemas"]["gist-comment"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/create-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/create-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-comment"]; + "application/json": components["schemas"]["gist-comment"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/get-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/get-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-comment"]; + "application/json": components["schemas"]["gist-comment"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden_gist"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden_gist"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/delete-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/delete-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/update-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/update-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The comment text. * @example Body of the attachment */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-comment"]; + "application/json": components["schemas"]["gist-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/list-commits": { - readonly parameters: { - readonly query?: { + "gists/list-commits": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gist-commit"][]; + "application/json": components["schemas"]["gist-commit"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/list-forks": { - readonly parameters: { - readonly query?: { + "gists/list-forks": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gist-simple"][]; + "application/json": components["schemas"]["gist-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/fork": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/fork": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/gists/aa5a315d61ae9438b18d */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["base-gist"]; + "application/json": components["schemas"]["base-gist"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gists/check-is-starred": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/check-is-starred": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if gist is starred */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; /** @description Not Found if gist is not starred */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": Record; + "application/json": Record; }; }; }; }; - readonly "gists/star": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/star": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/unstar": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/unstar": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; + gist_id: components["parameters"]["gist-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "gists/get-revision": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "gists/get-revision": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the gist. */ - readonly gist_id: components["parameters"]["gist-id"]; - readonly sha: string; + gist_id: components["parameters"]["gist-id"]; + sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gist-simple"]; + "application/json": components["schemas"]["gist-simple"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "gitignore/get-all-templates": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "gitignore/get-all-templates": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "gitignore/get-template": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly name: string; + "gitignore/get-template": { + parameters: { + query?: never; + header?: never; + path: { + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gitignore-template"]; + "application/json": components["schemas"]["gitignore-template"]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "apps/list-repos-accessible-to-installation": { - readonly parameters: { - readonly query?: { + "apps/list-repos-accessible-to-installation": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; /** @example selected */ - readonly repository_selection?: string; + repository_selection?: string; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "apps/revoke-installation-access-token": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "apps/revoke-installation-access-token": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list": { - readonly parameters: { - readonly query?: { + "issues/list": { + parameters: { + query?: { /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; - readonly collab?: boolean; - readonly orgs?: boolean; - readonly owned?: boolean; - readonly pulls?: boolean; + since?: components["parameters"]["since"]; + collab?: boolean; + orgs?: boolean; + owned?: boolean; + pulls?: boolean; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "licenses/get-all-commonly-used": { - readonly parameters: { - readonly query?: { - readonly featured?: boolean; + "licenses/get-all-commonly-used": { + parameters: { + query?: { + featured?: boolean; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["license-simple"][]; + "application/json": components["schemas"]["license-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "licenses/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - readonly license: string; + "licenses/get": { + parameters: { + query?: never; + header?: never; + path: { + license: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["license"]; + "application/json": components["schemas"]["license"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "markdown/render": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "markdown/render": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The Markdown text to render in HTML. */ - readonly text: string; + text: string; /** * @description The rendering mode. * @default markdown * @example markdown * @enum {string} */ - readonly mode?: "markdown" | "gfm"; + mode?: "markdown" | "gfm"; /** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */ - readonly context?: string; + context?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly "Content-Type": components["headers"]["content-type"]; + "Content-Type": components["headers"]["content-type"]; /** @example 279 */ - readonly "Content-Length"?: string; - readonly "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; - readonly [name: string]: unknown; + "Content-Length"?: string; + "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { - readonly "text/html": string; + "text/html": string; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "markdown/render-raw": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "markdown/render-raw": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "text/plain": string; - readonly "text/x-markdown": string; + requestBody?: { + content: { + "text/plain": string; + "text/x-markdown": string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; - readonly [name: string]: unknown; + "X-CommonMarker-Version": components["headers"]["x-common-marker-version"]; + [name: string]: unknown; }; content: { - readonly "text/html": string; + "text/html": string; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "apps/get-subscription-plan-for-account": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-subscription-plan-for-account": { + parameters: { + query?: never; + header?: never; + path: { /** @description account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; + account_id: components["parameters"]["account-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["marketplace-purchase"]; + "application/json": components["schemas"]["marketplace-purchase"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "apps/list-plans": { - readonly parameters: { - readonly query?: { + "apps/list-plans": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][]; + "application/json": components["schemas"]["marketplace-listing-plan"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/list-accounts-for-plan": { - readonly parameters: { - readonly query?: { + "apps/list-accounts-for-plan": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the plan. */ - readonly plan_id: components["parameters"]["plan-id"]; + plan_id: components["parameters"]["plan-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-purchase"][]; + "application/json": components["schemas"]["marketplace-purchase"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-subscription-plan-for-account-stubbed": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-subscription-plan-for-account-stubbed": { + parameters: { + query?: never; + header?: never; + path: { /** @description account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; + account_id: components["parameters"]["account-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["marketplace-purchase"]; + "application/json": components["schemas"]["marketplace-purchase"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; /** @description Not Found when the account has not purchased the listing */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "apps/list-plans-stubbed": { - readonly parameters: { - readonly query?: { + "apps/list-plans-stubbed": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][]; + "application/json": components["schemas"]["marketplace-listing-plan"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "apps/list-accounts-for-plan-stubbed": { - readonly parameters: { - readonly query?: { + "apps/list-accounts-for-plan-stubbed": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the plan. */ - readonly plan_id: components["parameters"]["plan-id"]; + plan_id: components["parameters"]["plan-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["marketplace-purchase"][]; + "application/json": components["schemas"]["marketplace-purchase"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "meta/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-overview"]; + "application/json": components["schemas"]["api-overview"]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "activity/list-public-events-for-repo-network": { - readonly parameters: { - readonly query?: { + "activity/list-public-events-for-repo-network": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "activity/list-notifications-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-notifications-for-authenticated-user": { + parameters: { + query?: { /** @description If `true`, show notifications marked as read. */ - readonly all?: components["parameters"]["all"]; + all?: components["parameters"]["all"]; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating?: components["parameters"]["participating"]; + participating?: components["parameters"]["participating"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; + before?: components["parameters"]["before"]; /** @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"]; + page?: components["parameters"]["page"]; /** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; + per_page?: number; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["thread"][]; + "application/json": components["schemas"]["thread"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "activity/mark-notifications-as-read": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "activity/mark-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - readonly last_read_at?: string; + last_read_at?: string; /** @description Whether the notification has been read. */ - readonly read?: boolean; + read?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; + "application/json": { + message?: string; }; }; }; /** @description Reset Content */ - readonly 205: { + 205: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/get-thread": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/get-thread": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread"]; + "application/json": components["schemas"]["thread"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/mark-thread-as-done": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/mark-thread-as-done": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No content */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "activity/mark-thread-as-read": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/mark-thread-as-read": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Reset Content */ - readonly 205: { + 205: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/get-thread-subscription-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/get-thread-subscription-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread-subscription"]; + "application/json": components["schemas"]["thread-subscription"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/set-thread-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/set-thread-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to block all notifications from a thread. * @default false */ - readonly ignored?: boolean; + ignored?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread-subscription"]; + "application/json": components["schemas"]["thread-subscription"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/delete-thread-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/delete-thread-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ - readonly thread_id: components["parameters"]["thread-id"]; + thread_id: components["parameters"]["thread-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "meta/get-octocat": { - readonly parameters: { - readonly query?: { + "meta/get-octocat": { + parameters: { + query?: { /** @description The words to show in Octocat's speech bubble */ - readonly s?: string; + s?: string; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/octocat-stream": string; + "application/octocat-stream": string; }; }; }; }; - readonly "orgs/list": { - readonly parameters: { - readonly query?: { + "orgs/list": { + parameters: { + query?: { /** @description An organization ID. Only return organizations with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-org"]; + since?: components["parameters"]["since-org"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + "actions/get-actions-cache-retention-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-retention-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-organization": { + 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": components["schemas"]["actions-cache-retention-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "billing/get-github-billing-usage-report-org": { - readonly parameters: { - readonly query?: { - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ - readonly year?: components["parameters"]["billing-usage-report-year"]; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - readonly month?: components["parameters"]["billing-usage-report-month"]; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ - readonly day?: components["parameters"]["billing-usage-report-day"]; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - readonly hour?: components["parameters"]["billing-usage-report-hour"]; + "actions/get-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; - readonly header?: never; - readonly path: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["billing_usage_report_org"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/repository-access-for-org": { + parameters: { + query?: { + /** @description The page number of results to fetch. */ + page?: number; + /** @description Number of results per page. */ + per_page?: number; + }; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-full"]; + "application/json": components["schemas"]["dependabot-repository-access-details"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/update-repository-access-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 List of repository IDs to add. */ + repository_ids_to_add?: number[]; + /** @description List of repository IDs to remove. */ + repository_ids_to_remove?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/set-repository-access-default-level": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + requestBody: { + content: { + "application/json": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string} + */ + default_level: "public" | "internal"; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "billing/get-all-budgets-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: never; + responses: { + 200: components["responses"]["get_all_budgets"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "billing/get-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/delete-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete-budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/update-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert?: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients?: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** @description The name of the entity to apply the budget to */ + budget_entity_name?: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + responses: { + /** @description Budget updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Budget successfully updated. */ + message?: string; + budget?: { + /** @description ID of the budget. */ + id?: string; + /** + * Format: float + * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. + */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @default + */ + budget_entity_name: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Budget not found or feature not enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "billing/get-github-billing-premium-request-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The user name to query usage for. The name is not case sensitive. */ + user?: components["parameters"]["billing-usage-report-user"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "orgs/get": { + parameters: { + query?: never; + 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"]["organization-full"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/update": { + 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 Billing email address. This address is not publicized. */ - readonly billing_email?: string; + billing_email?: string; /** @description The company name. */ - readonly company?: string; + company?: string; /** @description The publicly visible email address. */ - readonly email?: string; + email?: string; /** @description The Twitter username of the company. */ - readonly twitter_username?: string; + twitter_username?: string; /** @description The location. */ - readonly location?: string; + location?: string; /** @description The shorthand name of the company. */ - readonly name?: string; + name?: string; /** @description The description of the company. The maximum size is 160 characters. */ - readonly description?: string; + description?: string; /** @description Whether an organization can use organization projects. */ - readonly has_organization_projects?: boolean; + has_organization_projects?: boolean; /** @description Whether repositories that belong to the organization can use repository projects. */ - readonly has_repository_projects?: boolean; + has_repository_projects?: boolean; /** * @description Default permission level members have for organization repositories. * @default read * @enum {string} */ - readonly default_repository_permission?: "read" | "write" | "admin" | "none"; + default_repository_permission?: "read" | "write" | "admin" | "none"; /** * @description Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - readonly members_can_create_repositories?: boolean; + members_can_create_repositories?: boolean; /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_internal_repositories?: boolean; + members_can_create_internal_repositories?: boolean; /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_private_repositories?: boolean; + members_can_create_private_repositories?: boolean; /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - readonly members_can_create_public_repositories?: boolean; + 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 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"; + members_allowed_repository_creation_type?: "all" | "private" | "none"; /** * @description Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_pages?: boolean; + members_can_create_pages?: boolean; /** * @description Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_public_pages?: boolean; + members_can_create_public_pages?: boolean; /** * @description Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - readonly members_can_create_private_pages?: boolean; + members_can_create_private_pages?: boolean; /** * @description Whether organization members can fork private organization repositories. * @default false */ - readonly members_can_fork_private_repositories?: boolean; + members_can_fork_private_repositories?: boolean; /** * @description Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface. * @default false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ - readonly blog?: string; + blog?: string; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91160,7 +97430,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly advanced_security_enabled_for_new_repositories?: boolean; + advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91171,7 +97441,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly dependabot_alerts_enabled_for_new_repositories?: boolean; + dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91182,7 +97452,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly dependabot_security_updates_enabled_for_new_repositories?: boolean; + dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91193,7 +97463,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly dependency_graph_enabled_for_new_repositories?: boolean; + dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91204,7 +97474,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly secret_scanning_enabled_for_new_repositories?: boolean; + secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91215,2340 +97485,3682 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean; + secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ - readonly secret_scanning_push_protection_custom_link_enabled?: boolean; + 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; + 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; + deploy_keys_enabled_for_repositories?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-full"]; + "application/json": components["schemas"]["organization-full"]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; /** @description Validation failed */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; }; }; }; }; - readonly "actions/get-actions-cache-usage-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-actions-cache-usage-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; + "application/json": components["schemas"]["actions-cache-usage-org-enterprise"]; }; }; }; }; - readonly "actions/get-actions-cache-usage-by-repo-for-org": { - readonly parameters: { - readonly query?: { + "actions/get-actions-cache-usage-by-repo-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repository_cache_usages: readonly components["schemas"]["actions-cache-usage-by-repository"][]; + "application/json": { + total_count: number; + repository_cache_usages: components["schemas"]["actions-cache-usage-by-repository"][]; }; }; }; }; }; - readonly "actions/list-hosted-runners-for-org": { - readonly parameters: { - readonly query?: { + "actions/list-hosted-runners-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; }; }; }; }; }; - readonly "actions/create-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name: string; + name: string; /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ - readonly image: { + image: { /** @description The unique identifier of the runner image. */ - readonly id?: string; + id?: string; /** * @description The source of the runner image. * @enum {string} */ - readonly source?: "github" | "partner" | "custom"; + source?: "github" | "partner" | "custom"; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ - readonly version?: string | null; + version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ - readonly size: string; + size: string; /** @description The existing runner group to add this runner to. */ - readonly runner_group_id: number; + runner_group_id: number; /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ - readonly maximum_runners?: number; + maximum_runners?: number; /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ - readonly enable_static_ip?: boolean; + enable_static_ip?: boolean; + /** + * @description Whether this runner should be used to generate custom images. + * @default false + */ + image_gen?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "actions/get-hosted-runners-github-owned-images-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-custom-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-custom-image"][]; }; }; }; }; }; - readonly "actions/get-hosted-runners-partner-images-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-custom-image-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image"]; + }; + }; + }; + }; + "actions/delete-custom-image-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-custom-image-versions-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly images: readonly components["schemas"]["actions-hosted-runner-image"][]; + "application/json": { + total_count: number; + image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][]; }; }; }; }; }; - readonly "actions/get-hosted-runners-limits-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-custom-image-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner-limits"]; + "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"]; }; }; }; }; - readonly "actions/get-hosted-runners-machine-specs-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-custom-image-version-from-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/get-hosted-runners-github-owned-images-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly machine_specs: readonly components["schemas"]["actions-hosted-runner-machine-spec"][]; + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; }; }; - readonly "actions/get-hosted-runners-platforms-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-hosted-runners-partner-images-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly platforms: readonly string[]; + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; }; }; - readonly "actions/get-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-hosted-runners-limits-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-limits"]; + }; + }; + }; + }; + "actions/get-hosted-runners-machine-specs-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][]; + }; + }; + }; + }; + }; + "actions/get-hosted-runners-platforms-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + platforms: string[]; + }; + }; + }; + }; + }; + "actions/get-hosted-runner-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 GitHub-hosted runner. */ - readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + hosted_runner_id: components["parameters"]["hosted-runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "actions/delete-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the GitHub-hosted runner. */ - readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + hosted_runner_id: components["parameters"]["hosted-runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "actions/update-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the GitHub-hosted runner. */ - readonly hosted_runner_id: components["parameters"]["hosted-runner-id"]; + hosted_runner_id: components["parameters"]["hosted-runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name?: string; + name?: string; /** @description The existing runner group to add this runner to. */ - readonly runner_group_id?: number; + runner_group_id?: number; /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ - readonly maximum_runners?: number; + maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ - readonly enable_static_ip?: boolean; + enable_static_ip?: boolean; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size?: string; + /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image_id?: string; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ - readonly image_version?: string | null; + image_version?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-hosted-runner"]; + "application/json": components["schemas"]["actions-hosted-runner"]; }; }; }; }; - readonly "oidc/get-oidc-custom-sub-template-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "oidc/get-oidc-custom-sub-template-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description A JSON serialized template for OIDC subject claim customization */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["oidc-custom-sub"]; + "application/json": components["schemas"]["oidc-custom-sub"]; }; }; }; }; - readonly "oidc/update-oidc-custom-sub-template-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "oidc/update-oidc-custom-sub-template-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["oidc-custom-sub"]; + requestBody: { + content: { + "application/json": components["schemas"]["oidc-custom-sub"]; }; }; - readonly responses: { + responses: { /** @description Empty response */ - readonly 201: { + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-github-actions-permissions-organization": { + parameters: { + query?: never; + 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: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["actions-organization-permissions"]; + }; + }; + }; + }; + "actions/set-github-actions-permissions-organization": { + 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": { + enabled_repositories: components["schemas"]["enabled-repositories"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "actions/get-github-actions-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-organization-permissions"]; + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-github-actions-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; }; - readonly cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly enabled_repositories: components["schemas"]["enabled-repositories"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; - readonly responses: { + }; + "actions/get-fork-pr-contributor-approval-permissions-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-organization": { + 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": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/list-selected-repositories-enabled-github-actions-organization": { - readonly parameters: { - readonly query?: { + "actions/set-private-repo-fork-pr-workflows-settings-organization": { + 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": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-enabled-github-actions-organization": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["repository"][]; }; }; }; }; }; - readonly "actions/set-selected-repositories-enabled-github-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-selected-repositories-enabled-github-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of repository IDs to enable for GitHub Actions. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/enable-selected-repository-github-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/enable-selected-repository-github-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/disable-selected-repository-github-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/disable-selected-repository-github-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-allowed-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-allowed-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["selected-actions"]; + "application/json": components["schemas"]["selected-actions"]; }; }; }; }; - readonly "actions/set-allowed-actions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-allowed-actions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; + requestBody?: { + content: { + "application/json": components["schemas"]["selected-actions"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-github-actions-default-workflow-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-self-hosted-runners-permissions-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; + "application/json": components["schemas"]["self-hosted-runners-settings"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-self-hosted-runners-permissions-organization": { + 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 The policy that controls whether self-hosted runners can be used in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-self-hosted-runners-organization": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-selected-repositories-self-hosted-runners-organization": { + 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 IDs of repositories that can use repository-level self-hosted runners */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/enable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/set-github-actions-default-workflow-permissions-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/disable-selected-repository-self-hosted-runners-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-github-actions-default-workflow-permissions-organization": { + parameters: { + query?: never; + 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"]["actions-get-default-workflow-permissions"]; + }; + }; + }; + }; + "actions/set-github-actions-default-workflow-permissions-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: { + content: { + "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; + }; + }; + responses: { /** @description Success response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runner-groups-for-org": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + 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"]; + visible_to_repository?: components["parameters"]["visible-to-repository"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runner_groups: readonly components["schemas"]["runner-groups-org"][]; + "application/json": { + total_count: number; + runner_groups: components["schemas"]["runner-groups-org"][]; }; }; }; }; }; - readonly "actions/create-self-hosted-runner-group-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner group. */ - readonly name: string; + 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"; + visibility?: "selected" | "all" | "private"; /** @description List of repository IDs that can access the runner group. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; /** @description List of runner IDs to add to the runner group. */ - readonly runners?: readonly number[]; + runners?: number[]; /** * @description Whether the runner group can be used by `public` repositories. * @default false */ - readonly allows_public_repositories?: boolean; + 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; + 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[]; + selected_workflows?: string[]; /** @description The identifier of a hosted compute network configuration. */ - readonly network_configuration_id?: string; + network_configuration_id?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; + "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: { + "actions/get-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; + "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: { + "actions/delete-self-hosted-runner-group-from-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-self-hosted-runner-group-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-self-hosted-runner-group-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Name of the runner group. */ - readonly name: string; + 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"; + visibility?: "selected" | "all" | "private"; /** * @description Whether the runner group can be used by `public` repositories. * @default false */ - readonly allows_public_repositories?: boolean; + 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; + 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[]; + selected_workflows?: string[]; /** @description The identifier of a hosted compute network configuration. */ - readonly network_configuration_id?: string | null; + network_configuration_id?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner-groups-org"]; + "application/json": components["schemas"]["runner-groups-org"]; }; }; }; }; - readonly "actions/list-github-hosted-runners-in-group-for-org": { - readonly parameters: { - readonly query?: { + "actions/list-github-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["actions-hosted-runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["actions-hosted-runner"][]; }; }; }; }; }; - readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: 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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of repository IDs that can access the runner group. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runners-in-group-for-org": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; }; }; }; }; }; - readonly "actions/set-self-hosted-runners-in-group-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of runner IDs to add to the runner group. */ - readonly runners: readonly number[]; + runners: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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: { + "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. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner group. */ - readonly runner_group_id: components["parameters"]["runner-group-id"]; + runner_group_id: components["parameters"]["runner-group-id"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runners-for-org": { - readonly parameters: { - readonly query?: { + "actions/list-self-hosted-runners-for-org": { + parameters: { + query?: { /** @description The name of a self-hosted runner. */ - readonly name?: string; + name?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; }; }; }; }; }; - readonly "actions/list-runner-applications-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-runner-applications-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; + "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - readonly "actions/generate-runner-jitconfig-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/generate-runner-jitconfig-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the new runner. */ - readonly name: string; + name: string; /** @description The ID of the runner group to register the runner to. */ - readonly runner_group_id: number; + runner_group_id: number; /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ - readonly labels: readonly string[]; + labels: string[]; /** * @description The working directory to be used for job execution, relative to the runner install directory. * @default _work */ - readonly work_folder?: string; + work_folder?: string; }; }; }; - readonly responses: { - readonly 201: components["responses"]["actions_runner_jitconfig"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/create-registration-token-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-registration-token-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/create-remove-token-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-remove-token-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/get-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner"]; + "application/json": components["schemas"]["runner"]; }; }; }; }; - readonly "actions/delete-self-hosted-runner-from-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-self-hosted-runner-from-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-labels-for-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-labels-for-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-custom-labels-for-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-custom-labels-for-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/add-custom-labels-to-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-custom-labels-to-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels_readonly"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/remove-custom-label-from-self-hosted-runner-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-custom-label-from-self-hosted-runner-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; /** @description The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; + name: components["parameters"]["runner-label-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-org-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-org-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["organization-actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-actions-secret"][]; }; }; }; }; }; - readonly "actions/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-public-key"]; + "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - readonly "actions/get-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-actions-secret"]; + "application/json": components["schemas"]["organization-actions-secret"]; }; }; }; }; - readonly "actions/create-or-update-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-or-update-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: { + "actions/list-selected-repos-for-org-secret": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; }; }; - readonly "actions/set-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-selected-repos-for-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/add-selected-repo-to-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-selected-repo-to-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type is not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/remove-selected-repo-from-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-selected-repo-from-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-org-variables": { - readonly parameters: { - readonly query?: { + "actions/list-org-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["organization-actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["organization-actions-variable"][]; }; }; }; }; }; - readonly "actions/create-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name: string; + name: string; /** @description The value of the variable. */ - readonly value: string; + value: string; /** * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a variable */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-actions-variable"]; + "application/json": components["schemas"]["organization-actions-variable"]; }; }; }; }; - readonly "actions/delete-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name?: string; + name?: string; /** @description The value of the variable. */ - readonly value?: string; + value?: string; /** * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. * @enum {string} */ - readonly visibility?: "all" | "private" | "selected"; + visibility?: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-selected-repos-for-org-variable": { - readonly parameters: { - readonly query?: { + "actions/list-selected-repos-for-org-variable": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/set-selected-repos-for-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-selected-repos-for-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The IDs of the repositories that can access the organization variable. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/add-selected-repo-to-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-selected-repo-to-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - readonly repository_id: number; + name: components["parameters"]["variable-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/remove-selected-repo-from-org-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-selected-repo-from-org-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - readonly repository_id: number; + name: components["parameters"]["variable-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response when the visibility of the variable is not set to `selected` */ - readonly 409: { + 409: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "orgs/create-artifact-deployment-record": { + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** @description The hex encoded digest of the artifact. */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * @description The status of the artifact. Can be either deployed or decommissioned. + * @enum {string} + */ + status: "deployed" | "decommissioned"; + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The deployment cluster. */ + cluster?: string; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a cluster, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + */ + deployment_name: string; + /** @description The tags associated with the deployment. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact deployment record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/set-cluster-deployment-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The cluster name. */ + cluster: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The list of deployments to record. */ + deployments: { + /** + * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name parameter must also be identical across all entries. + */ + name: string; + /** + * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name and version parameters must also be identical across all entries. + */ + digest: string; + /** + * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + * the version parameter must also be identical across all entries. + * @example 1.2.3 + */ + version?: string; + /** + * @description The deployment status of the artifact. + * @enum {string} + */ + status?: "deployed" | "decommissioned"; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a record set, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + * The deployment_name must be unique across all entries in the deployments array. + */ + deployment_name: string; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + /** @description Key-value pairs to tag the deployment record. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + }[]; + }; + }; + }; + responses: { + /** @description Deployment records created or updated successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/create-artifact-storage-record": { + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** + * @description The digest of the artifact (algorithm:hex-encoded-digest). + * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * Format: uri + * @description The URL where the artifact is stored. + * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3 + */ + artifact_url?: string; + /** + * Format: uri + * @description The path of the artifact. + * @example com/github/bar/libfoo-1.2.3 + */ + path?: string; + /** + * Format: uri + * @description The base URL of the artifact registry. + * @example https://reg.example.com/artifactory/ + */ + registry_url: string; + /** + * @description The repository name within the registry. + * @example bar + */ + repository?: string; + /** + * @description The status of the artifact (e.g., active, inactive). + * @default active + * @example active + * @enum {string} + */ + status?: "active" | "eol" | "deleted"; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact metadata storage record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example 1 */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string | null; + registry_url?: string; + repository?: string | null; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-artifact-deployment-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + subject_digest: components["parameters"]["subject-digest"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The number of deployment records for this digest and organization + * @example 3 + */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/list-artifact-storage-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** + * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The number of storage records for this digest and organization + * @example 3 + */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string; + registry_url?: string; + repository?: string; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "orgs/delete-attestations-bulk": { + 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 List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-attestations": { - readonly parameters: { - readonly query?: { + "orgs/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-attestation-repositories": { + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + 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": { + id?: number; + name?: string; + }[]; + }; + }; + }; + }; + "orgs/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-attestations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - readonly subject_digest: string; + subject_digest: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly attestations?: readonly { + "application/json": { + attestations?: { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - readonly bundle?: { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly [key: string]: unknown; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; }; - readonly dsseEnvelope?: { - readonly [key: string]: unknown; + dsseEnvelope?: { + [key: string]: unknown; }; - }; - readonly repository_id?: number; - readonly bundle_url?: string; + } | null; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; }; }; }; - readonly "orgs/list-blocked-users": { - readonly parameters: { - readonly query?: { + "orgs/list-blocked-users": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "orgs/check-blocked-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/check-blocked-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If the user is blocked */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description If the user is not blocked */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "orgs/block-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/block-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/unblock-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/unblock-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "code-scanning/list-alerts-for-org": { - readonly parameters: { - readonly query?: { + "campaigns/list-org-campaigns": { + 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"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description If specified, only campaigns with this state will be returned. */ + state?: components["schemas"]["campaign-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated" | "ends_at" | "published"; + }; + 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: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"][]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/create-campaign": { + 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 The name of the campaign */ + name: string; + /** @description A description for the campaign */ + description: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign. The date must be in the future. + */ + ends_at: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + /** @description The code scanning alerts to include in this campaign */ + code_scanning_alerts?: { + /** @description The repository id */ + repository_id: number; + /** @description The alert numbers */ + alert_numbers: number[]; + }[] | null; + /** + * @description If true, will automatically generate issues for the campaign. The default is false. + * @default false + */ + generate_issues?: boolean; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Too Many Requests */ + 429: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/get-campaign-summary": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/delete-campaign": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Deletion successful */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/update-campaign": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the campaign */ + name?: string; + /** @description A description for the campaign */ + description?: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at?: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + state?: components["schemas"]["campaign-state"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/list-alerts-for-org": { + parameters: { + query?: { /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + tool_name?: components["parameters"]["tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components["parameters"]["tool-guid"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description If specified, only code scanning alerts with this state will be returned. */ - readonly state?: components["schemas"]["code-scanning-alert-state-query"]; + state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description The property by which to sort the results. */ - readonly sort?: "created" | "updated"; + sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this severity will be returned. */ - readonly severity?: components["schemas"]["code-scanning-alert-severity"]; + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-organization-alert-items"][]; + "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-security/get-configurations-for-org": { - readonly parameters: { - readonly query?: { + "code-security/get-configurations-for-org": { + parameters: { + query?: { /** @description The target type of the code security configuration */ - readonly target_type?: "global" | "all"; + target_type?: "global" | "all"; /** @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?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration"][]; + "application/json": components["schemas"]["code-security-configuration"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/create-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/create-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name: string; + name: string; /** @description A description of the code security configuration */ - readonly description: string; + description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @default disabled * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. * @default false */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @default disabled * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @default disabled * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @default disabled + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default not_set + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @default disabled * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; + reviewer_id: number; /** * @description The type of the bypass reviewer * @enum {string} */ - readonly reviewer_type: "TEAM" | "ROLE"; + reviewer_type: "TEAM" | "ROLE"; }[]; }; /** @@ -93556,1168 +101168,1257 @@ export interface operations { * @default disabled * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non provider patterns * @default disabled * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @default enforced * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Successfully created code security configuration */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; }; }; - readonly "code-security/get-default-configurations": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/get-default-configurations": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-default-configurations"]; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/detach-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/detach-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description An array of repository IDs to detach from configurations. */ - readonly selected_repository_ids?: readonly number[]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */ + selected_repository_ids?: number[]; }; }; }; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/get-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/get-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/delete-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/delete-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "code-security/update-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/update-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the code security configuration. Must be unique within the organization. */ - readonly name?: string; + name?: string; /** @description A description of the code security configuration */ - readonly description?: string; + description?: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. * @enum {string} */ - readonly advanced_security?: "enabled" | "disabled"; + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - readonly dependency_graph?: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - readonly dependency_graph_autosubmit_action_options?: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - readonly labeled_runners?: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - readonly dependabot_alerts?: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of code scanning default setup * @enum {string} */ - readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - readonly secret_scanning?: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - readonly secret_scanning_delegated_bypass_options?: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - readonly reviewers?: readonly { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ - readonly reviewer_id: number; + reviewer_id: number; /** * @description The type of the bypass reviewer * @enum {string} */ - readonly reviewer_type: "TEAM" | "ROLE"; + reviewer_type: "TEAM" | "ROLE"; }[]; }; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - readonly enforcement?: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; - readonly responses: { + responses: { /** @description Response when a configuration is updated */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; /** @description Response when no new updates are made */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "code-security/attach-configuration": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/attach-configuration": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @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" | "all_without_configurations" | "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`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; + responses: { + 202: components["responses"]["accepted"]; }; }; - readonly "code-security/set-configuration-as-default": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/set-configuration-as-default": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Specify which types of repository this security configuration should be applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; }; }; - readonly responses: { + responses: { /** @description Default successfully changed. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description Specifies which types of repository this security configuration is applied to by default. * @enum {string} */ - readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - readonly configuration?: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "code-security/get-repositories-for-configuration": { - readonly parameters: { - readonly query?: { + "code-security/get-repositories-for-configuration": { + 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)." */ - readonly per_page?: number; + per_page?: number; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** * @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. * * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` */ - readonly status?: string; + status?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the code security configuration. */ - readonly configuration_id: components["parameters"]["configuration-id"]; + configuration_id: components["parameters"]["configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][]; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/list-in-organization": { - readonly parameters: { - readonly query?: { + "codespaces/list-in-organization": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/set-codespaces-access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-codespaces-access": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. * @enum {string} */ - readonly visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; + visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ - readonly selected_usernames?: readonly string[]; + selected_usernames?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response when successfully modifying permissions. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/set-codespaces-access-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-codespaces-access-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members whose codespaces be billed to the organization. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response when successfully modifying permissions. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/delete-codespaces-access-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-codespaces-access-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response when successfully modifying permissions. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Users are neither members nor collaborators of this organization. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/list-org-secrets": { - readonly parameters: { - readonly query?: { + "codespaces/list-org-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["codespaces-org-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["codespaces-org-secret"][]; }; }; }; }; }; - readonly "codespaces/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - readonly "codespaces/get-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-org-secret"]; + "application/json": components["schemas"]["codespaces-org-secret"]; }; }; }; }; - readonly "codespaces/create-or-update-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-or-update-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/delete-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/list-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: { + "codespaces/list-selected-repos-for-org-secret": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/set-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-selected-repos-for-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/add-selected-repo-to-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/add-selected-repo-to-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/remove-selected-repo-from-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/remove-selected-repo-from-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "copilot/get-copilot-organization-details": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/get-copilot-organization-details": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["copilot-organization-details"]; + "application/json": components["schemas"]["copilot-organization-details"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description There is a problem with your account's associated payment method. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/list-copilot-seats": { - readonly parameters: { - readonly query?: { + "copilot/list-copilot-seats": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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?: number; + per_page?: number; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description Total number of Copilot seats for the organization currently being billed. */ - readonly total_seats?: number; - readonly seats?: readonly components["schemas"]["copilot-seat-details"][]; + total_seats?: number; + seats?: components["schemas"]["copilot-seat-details"][]; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-seats-for-teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/add-copilot-seats-for-teams": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description List of team names within the organization to which to grant access to GitHub Copilot. */ - readonly selected_teams: readonly string[]; + selected_teams: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_created: number; + "application/json": { + seats_created: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/cancel-copilot-seat-assignment-for-teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/cancel-copilot-seat-assignment-for-teams": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of teams from which to revoke access to GitHub Copilot. */ - readonly selected_teams: readonly string[]; + selected_teams: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_cancelled: number; + "application/json": { + seats_cancelled: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-seats-for-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/add-copilot-seats-for-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_created: number; + "application/json": { + seats_created: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/cancel-copilot-seat-assignment-for-users": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/cancel-copilot-seat-assignment-for-users": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ - readonly selected_usernames: readonly string[]; + selected_usernames: string[]; }; }; }; - readonly responses: { + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly seats_cancelled: number; + "application/json": { + seats_cancelled: number; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 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; + "copilot/copilot-content-exclusion-for-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; - readonly header?: never; - readonly path: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description OK */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["copilot-organization-content-exclusion-details"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "copilot/set-copilot-content-exclusion-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + /** @description The content exclusion rules to set */ + requestBody: { + content: { + "application/json": { + [key: string]: (string | { + ifAnyMatch: string[]; + } | { + ifNoneMatch: string[]; + })[]; + }; + }; + }; + responses: { + /** @description Success */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": { + message?: string; + }; }; }; - 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"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 413: components["responses"]["too_large"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/usage-metrics-for-org": { - 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; + "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 100 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. */ - readonly until?: string; + 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; + page?: components["parameters"]["page"]; + /** @description The number of days of metrics to display per page (max 100). For 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; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "dependabot/list-alerts-for-org": { - readonly parameters: { - readonly query?: { + "dependabot/list-alerts-for-org": { + parameters: { + query?: { /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -94726,476 +102427,489 @@ export interface operations { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"]; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly scope?: components["parameters"]["dependabot-alert-scope"]; + scope?: components["parameters"]["dependabot-alert-scope"]; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly sort?: components["parameters"]["dependabot-alert-sort"]; + sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + 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"]; + 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly last?: components["parameters"]["pagination-last"]; + after?: components["parameters"]["pagination-after"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["dependabot-alert-with-repository"][]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "dependabot/list-org-secrets": { - readonly parameters: { - readonly query?: { + "dependabot/list-org-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["organization-dependabot-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-dependabot-secret"][]; }; }; }; }; }; - readonly "dependabot/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - readonly "dependabot/get-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-dependabot-secret"]; + "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - readonly "dependabot/create-or-update-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/create-or-update-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids?: readonly string[]; + selected_repository_ids?: (number | string)[]; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/delete-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/delete-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/list-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: { + "dependabot/list-selected-repos-for-org-secret": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; }; }; - readonly "dependabot/set-selected-repos-for-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/set-selected-repos-for-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/add-selected-repo-to-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/add-selected-repo-to-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type is not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/remove-selected-repo-from-org-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/remove-selected-repo-from-org-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when visibility type not set to selected */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "packages/list-docker-migration-conflicting-packages-for-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/list-docker-migration-conflicting-packages-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-public-org-events": { - readonly parameters: { - readonly query?: { + "activity/list-public-org-events": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "orgs/list-failed-invitations": { - readonly parameters: { - readonly query?: { + "orgs/list-failed-invitations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-webhooks": { - readonly parameters: { - readonly query?: { + "orgs/list-webhooks": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-hook"][]; + "application/json": components["schemas"]["org-hook"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/create-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Must be passed as "web". */ - readonly name: string; + name: string; /** @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"]; + 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"]; /** @example "kdaigle" */ - readonly username?: string; + username?: string; /** @example "password" */ - readonly password?: string; + password?: string; }; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. @@ -95203,102 +102917,102 @@ export interface operations { * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/orgs/octocat/hooks/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["org-hook"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["org-hook"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/delete-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/delete-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "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"]; + 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. @@ -95306,678 +103020,678 @@ export interface operations { * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; /** @example "web" */ - readonly name?: string; + name?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-hook"]; + "application/json": components["schemas"]["org-hook"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-config-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "orgs/update-webhook-config-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-webhook-config-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + 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"]; + 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"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "orgs/list-webhook-deliveries": { - readonly parameters: { - readonly query?: { + "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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + cursor?: components["parameters"]["cursor"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["hook-delivery"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/redeliver-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/ping-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + 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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "api-insights/get-route-stats-by-actor": { - readonly parameters: { - readonly query: { + "api-insights/get-route-stats-by-actor": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["api-insights-route-stats-sort"]; + sort?: components["parameters"]["api-insights-route-stats-sort"]; /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - readonly api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The type of the actor */ - readonly actor_type: components["parameters"]["api-insights-actor-type"]; + actor_type: components["parameters"]["api-insights-actor-type"]; /** @description The ID of the actor */ - readonly actor_id: components["parameters"]["api-insights-actor-id"]; + actor_id: components["parameters"]["api-insights-actor-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-route-stats"]; + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; }; }; - readonly "api-insights/get-subject-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-subject-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["api-insights-sort"]; + sort?: components["parameters"]["api-insights-sort"]; /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - readonly subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-subject-stats"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; }; }; - readonly "api-insights/get-summary-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-summary-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "api-insights/get-summary-stats-by-user": { - readonly parameters: { - readonly query: { + "api-insights/get-summary-stats-by-user": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the user to query for stats */ - readonly user_id: components["parameters"]["api-insights-user-id"]; + user_id: components["parameters"]["api-insights-user-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "api-insights/get-summary-stats-by-actor": { - readonly parameters: { - readonly query: { + "api-insights/get-summary-stats-by-actor": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The type of the actor */ - readonly actor_type: components["parameters"]["api-insights-actor-type"]; + actor_type: components["parameters"]["api-insights-actor-type"]; /** @description The ID of the actor */ - readonly actor_id: components["parameters"]["api-insights-actor-id"]; + actor_id: components["parameters"]["api-insights-actor-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - readonly "api-insights/get-time-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-time-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - readonly "api-insights/get-time-stats-by-user": { - readonly parameters: { - readonly query: { + "api-insights/get-time-stats-by-user": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the user to query for stats */ - readonly user_id: components["parameters"]["api-insights-user-id"]; + user_id: components["parameters"]["api-insights-user-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - readonly "api-insights/get-time-stats-by-actor": { - readonly parameters: { - readonly query: { + "api-insights/get-time-stats-by-actor": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + timestamp_increment: components["parameters"]["api-insights-timestamp-increment"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The type of the actor */ - readonly actor_type: components["parameters"]["api-insights-actor-type"]; + actor_type: components["parameters"]["api-insights-actor-type"]; /** @description The ID of the actor */ - readonly actor_id: components["parameters"]["api-insights-actor-id"]; + actor_id: components["parameters"]["api-insights-actor-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - readonly "api-insights/get-user-stats": { - readonly parameters: { - readonly query: { + "api-insights/get-user-stats": { + parameters: { + query: { /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["api-insights-sort"]; + sort?: components["parameters"]["api-insights-sort"]; /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - readonly actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the user to query for stats */ - readonly user_id: components["parameters"]["api-insights-user-id"]; + user_id: components["parameters"]["api-insights-user-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["api-insights-user-stats"]; + "application/json": components["schemas"]["api-insights-user-stats"]; }; }; }; }; - readonly "apps/get-org-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-org-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; }; }; - readonly "orgs/list-app-installations": { - readonly parameters: { - readonly query?: { + "orgs/list-app-installations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly installations: readonly components["schemas"]["installation"][]; + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; }; }; }; }; }; - readonly "interactions/get-restrictions-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/get-restrictions-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; }; }; - readonly "interactions/set-restrictions-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/set-restrictions-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "interactions/remove-restrictions-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/remove-restrictions-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/list-pending-invitations": { - readonly parameters: { - readonly query?: { + "orgs/list-pending-invitations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Filter invitations by their member role. */ - readonly role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; + role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; /** @description Filter invitations by their invitation source. */ - readonly invitation_source?: "all" | "member" | "scim"; + invitation_source?: "all" | "member" | "scim"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/create-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - readonly invitee_id?: number; + invitee_id?: number; /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - readonly email?: string; + email?: string; /** * @description The role for the new member. * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. @@ -95987,394 +103701,505 @@ export interface operations { * @default direct_member * @enum {string} */ - readonly role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; + role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; /** @description Specify IDs for the teams you want to invite new members to. */ - readonly team_ids?: readonly number[]; + team_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-invitation"]; + "application/json": components["schemas"]["organization-invitation"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/cancel-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/cancel-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/list-invitation-teams": { - readonly parameters: { - readonly query?: { + "orgs/list-invitation-teams": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-issue-types": { + parameters: { + query?: never; + 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"]["issue-type"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-issue-type": { + 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": components["schemas"]["organization-create-issue-type"]; }; - readonly cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["issue-type"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/update-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/delete-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "issues/list-for-org": { - readonly parameters: { - readonly query?: { + "issues/list-for-org": { + parameters: { + query?: { /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-members": { - readonly parameters: { - readonly query?: { - /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */ - readonly filter?: "2fa_disabled" | "all"; + "orgs/list-members": { + parameters: { + query?: { + /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; /** @description Filter members returned by their role. */ - readonly role?: "all" | "admin" | "member"; + role?: "all" | "admin" | "member"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/check-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/check-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if requester is an organization member and user is a member */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if requester is not an organization member */ - readonly 302: { + 302: { headers: { /** @example https://api.github.com/orgs/github/public_members/pezra */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if requester is an organization member and user is not a member */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/remove-member": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-member": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "codespaces/get-codespaces-for-user-in-org": { - readonly parameters: { - readonly query?: { + "codespaces/get-codespaces-for-user-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/delete-from-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-from-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/stop-in-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/stop-in-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/get-copilot-seat-details-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "copilot/get-copilot-seat-details-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The user's GitHub Copilot seat details, including usage. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["copilot-seat-details"]; + "application/json": components["schemas"]["copilot-seat-details"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 500: components["responses"]["internal_error"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/get-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/set-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The role to give the user in the organization. Can be one of: * * `admin` - The user will become an owner of the organization. @@ -96382,1997 +104207,2506 @@ export interface operations { * @default member * @enum {string} */ - readonly role?: "admin" | "member"; + role?: "admin" | "member"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/remove-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/list-for-org": { - readonly parameters: { - readonly query?: { + "migrations/list-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Exclude attributes from the API response to improve performance */ - readonly exclude?: readonly "repositories"[]; + exclude?: "repositories"[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["migration"][]; + "application/json": components["schemas"]["migration"][]; }; }; }; }; - readonly "migrations/start-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/start-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A list of arrays indicating which repositories should be migrated. */ - readonly repositories: readonly string[]; + repositories: string[]; /** * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. * @default false * @example true */ - readonly lock_repositories?: boolean; + lock_repositories?: boolean; /** * @description Indicates whether metadata should be excluded and only git source should be included for the migration. * @default false */ - readonly exclude_metadata?: boolean; + exclude_metadata?: boolean; /** * @description Indicates whether the repository git data should be excluded from the migration. * @default false */ - readonly exclude_git_data?: boolean; + exclude_git_data?: boolean; /** * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). * @default false * @example true */ - readonly exclude_attachments?: boolean; + exclude_attachments?: boolean; /** * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). * @default false * @example true */ - readonly exclude_releases?: boolean; + exclude_releases?: boolean; /** * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. * @default false * @example true */ - readonly exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean; /** * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). * @default false * @example true */ - readonly org_metadata_only?: boolean; + org_metadata_only?: boolean; /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ - readonly exclude?: readonly "repositories"[]; + exclude?: "repositories"[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "migrations/get-status-for-org": { - readonly parameters: { - readonly query?: { + "migrations/get-status-for-org": { + parameters: { + query?: { /** @description Exclude attributes from the API response to improve performance */ - readonly exclude?: readonly "repositories"[]; + exclude?: "repositories"[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** * @description * `pending`, which means the migration hasn't started yet. * * `exporting`, which means the migration is in progress. * * `exported`, which means the migration finished successfully. * * `failed`, which means the migration failed. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/download-archive-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/download-archive-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/delete-archive-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/delete-archive-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/unlock-repo-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/unlock-repo-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; /** @description repo_name parameter */ - readonly repo_name: components["parameters"]["repo-name"]; + repo_name: components["parameters"]["repo-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/list-repos-for-org": { - readonly parameters: { - readonly query?: { + "migrations/list-repos-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-org-roles": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/list-org-roles": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response - list of organization roles */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description The total number of organization roles available to the organization. */ - readonly total_count?: number; + total_count?: number; /** @description The list of organization roles available to the organization. */ - readonly roles?: readonly components["schemas"]["organization-role"][]; + roles?: components["schemas"]["organization-role"][]; }; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/revoke-all-org-roles-team": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-all-org-roles-team": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/assign-team-to-org-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/assign-team-to-org-role": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization, team or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/revoke-org-role-team": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-org-role-team": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/revoke-all-org-roles-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-all-org-roles-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/assign-user-to-org-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/assign-user-to-org-role": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization, user or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/revoke-org-role-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/revoke-org-role-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/get-org-role": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-org-role": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["organization-role"]; + "application/json": components["schemas"]["organization-role"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/list-org-role-teams": { - readonly parameters: { - readonly query?: { + "orgs/list-org-role-teams": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response - List of assigned teams */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-role-assignment"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/list-org-role-users": { - readonly parameters: { - readonly query?: { + "orgs/list-org-role-users": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the role. */ - readonly role_id: components["parameters"]["role-id"]; + role_id: components["parameters"]["role-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response - List of assigned users */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["user-role-assignment"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; /** @description Response if the organization or role does not exist. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if the organization roles feature is not enabled or validation failed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/list-outside-collaborators": { - readonly parameters: { - readonly query?: { - /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ - readonly filter?: "2fa_disabled" | "all"; + "orgs/list-outside-collaborators": { + parameters: { + query?: { + /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "orgs/convert-member-to-outside-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/convert-member-to-outside-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. * @default false */ - readonly async?: boolean; + async?: boolean; }; }; }; - readonly responses: { + responses: { /** @description User is getting converted asynchronously */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": Record; + "application/json": Record; }; }; /** @description User was converted */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/remove-outside-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-outside-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Unprocessable Entity if user is a member of the organization */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; }; }; - readonly "packages/list-packages-for-organization": { - readonly parameters: { - readonly query: { + "packages/list-packages-for-organization": { + parameters: { + query: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly visibility?: components["parameters"]["package-visibility"]; + visibility?: components["parameters"]["package-visibility"]; /** @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?: number; + page?: number; /** @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?: number; + per_page?: number; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 400: components["responses"]["package_es_list_error"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "packages/get-package-for-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package"]; + "application/json": components["schemas"]["package"]; }; }; }; }; - readonly "packages/delete-package-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-for-org": { - readonly parameters: { - readonly query?: { + "packages/restore-package-for-org": { + parameters: { + query?: { /** @description package token */ - readonly token?: string; + token?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-all-package-versions-for-package-owned-by-org": { - readonly parameters: { - readonly query?: { + "packages/get-all-package-versions-for-package-owned-by-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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ - readonly state?: "active" | "deleted"; + state?: "active" | "deleted"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; + "application/json": components["schemas"]["package-version"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-package-version-for-organization": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-version-for-organization": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["package-version"]; }; }; }; }; - readonly "packages/delete-package-version-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-version-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/restore-package-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-pat-grant-requests": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grant-requests": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The property by which to sort the results. */ - readonly sort?: components["parameters"]["personal-access-token-sort"]; + sort?: components["parameters"]["personal-access-token-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description A list of owner usernames to use to filter the results. */ - readonly owner?: components["parameters"]["personal-access-token-owner"]; + owner?: components["parameters"]["personal-access-token-owner"]; /** @description The name of the repository to use to filter the results. */ - readonly repository?: components["parameters"]["personal-access-token-repository"]; + repository?: components["parameters"]["personal-access-token-repository"]; /** @description The permission to use to filter the results. */ - readonly permission?: components["parameters"]["personal-access-token-permission"]; + permission?: components["parameters"]["personal-access-token-permission"]; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_before?: components["parameters"]["personal-access-token-before"]; + last_used_before?: components["parameters"]["personal-access-token-before"]; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_after?: components["parameters"]["personal-access-token-after"]; + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-programmatic-access-grant-request"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/review-pat-grant-requests-in-bulk": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/review-pat-grant-requests-in-bulk": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ - readonly pat_request_ids?: readonly number[]; + pat_request_ids?: number[]; /** * @description Action to apply to the requests. * @enum {string} */ - readonly action: "approve" | "deny"; + action: "approve" | "deny"; /** @description Reason for approving or denying the requests. Max 1024 characters. */ - readonly reason?: string | null; + reason?: string | null; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/review-pat-grant-request": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/review-pat-grant-request": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ - readonly pat_request_id: number; + pat_request_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Action to apply to the request. * @enum {string} */ - readonly action: "approve" | "deny"; + action: "approve" | "deny"; /** @description Reason for approving or denying the request. Max 1024 characters. */ - readonly reason?: string | null; + reason?: string | null; }; }; }; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/list-pat-grant-request-repositories": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grant-request-repositories": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the request for access via fine-grained personal access token. */ - readonly pat_request_id: number; + pat_request_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/list-pat-grants": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grants": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The property by which to sort the results. */ - readonly sort?: components["parameters"]["personal-access-token-sort"]; + sort?: components["parameters"]["personal-access-token-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description A list of owner usernames to use to filter the results. */ - readonly owner?: components["parameters"]["personal-access-token-owner"]; + owner?: components["parameters"]["personal-access-token-owner"]; /** @description The name of the repository to use to filter the results. */ - readonly repository?: components["parameters"]["personal-access-token-repository"]; + repository?: components["parameters"]["personal-access-token-repository"]; /** @description The permission to use to filter the results. */ - readonly permission?: components["parameters"]["personal-access-token-permission"]; + permission?: components["parameters"]["personal-access-token-permission"]; /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_before?: components["parameters"]["personal-access-token-before"]; + last_used_before?: components["parameters"]["personal-access-token-before"]; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly last_used_after?: components["parameters"]["personal-access-token-after"]; + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-programmatic-access-grant"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/update-pat-accesses": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-pat-accesses": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - readonly action: "revoke"; + action: "revoke"; /** @description The IDs of the fine-grained personal access tokens. */ - readonly pat_ids: readonly number[]; + pat_ids: number[]; }; }; }; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/update-pat-access": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-pat-access": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The unique identifier of the fine-grained personal access token. */ - readonly pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; + pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - readonly action: "revoke"; + action: "revoke"; }; }; }; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "orgs/list-pat-grant-repositories": { - readonly parameters: { - readonly query?: { + "orgs/list-pat-grant-repositories": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description Unique identifier of the fine-grained personal access token. */ - readonly pat_id: number; + pat_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "private-registries/list-org-private-registries": { - readonly parameters: { - readonly query?: { + "private-registries/list-org-private-registries": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly configurations: readonly components["schemas"]["org-private-registry-configuration"][]; + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; }; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/create-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/create-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The registry type. * @enum {string} */ - readonly registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url: string; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - readonly username?: string | null; + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - readonly encrypted_value: string; + encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ - readonly key_id: string; + key_id: string; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} */ - readonly visibility: "all" | "private" | "selected"; + visibility: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description The organization private registry configuration */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "private-registries/get-org-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/get-org-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The identifier for the key. * @example 012345678912345678 */ - readonly key_id: string; + key_id: string; /** * @description The Base64 encoded public key. * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 */ - readonly key: string; + key: string; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/get-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/get-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The specified private registry configuration for the organization */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-private-registry-configuration"]; + "application/json": components["schemas"]["org-private-registry-configuration"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/delete-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/delete-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "private-registries/update-org-private-registry": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "private-registries/update-org-private-registry": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The registry type. * @enum {string} */ - readonly registry_type?: "maven_repository"; + registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - readonly username?: string | null; + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} */ - readonly visibility?: "all" | "private" | "selected"; + visibility?: "all" | "private" | "selected"; /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ - readonly selected_repository_ids?: readonly number[]; + selected_repository_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "projects/list-for-org": { - readonly parameters: { - readonly query?: { - /** @description Indicates the state of the projects to return. */ - readonly state?: "open" | "closed" | "all"; + "projects/list-for-org": { + parameters: { + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "projects/create-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "projects/get-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the project. */ - readonly name: string; - /** @description The description of the project. */ - readonly body?: string; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/create-draft-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; }; - readonly responses: { + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "orgs/get-all-custom-properties": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "projects/list-fields-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 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"]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "orgs/create-or-update-custom-properties": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "projects/add-field-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The ID of the IssueField to create the field for. */ + issue_field_id: number; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response for adding a field to an organization-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; }; - readonly cookie?: never; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + }; + "projects/get-field-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-org": { + parameters: { + query?: { + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/add-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-org-item": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/create-view-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in an organization-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "projects/list-view-items-for-org": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/custom-properties-for-repos-get-organization-definitions": { + parameters: { + query?: never; + 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"]["custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/custom-properties-for-repos-create-or-update-organization-definitions": { + 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 The array of custom properties to create or update. */ - readonly properties: readonly components["schemas"]["custom-property"][]; + properties: components["schemas"]["custom-property"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["custom-property"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/get-custom-property": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-get-organization-definition": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The custom property name */ - readonly custom_property_name: components["parameters"]["custom-property-name"]; + custom_property_name: components["parameters"]["custom-property-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-or-update-custom-property": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-create-or-update-organization-definition": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The custom property name */ - readonly custom_property_name: components["parameters"]["custom-property-name"]; + custom_property_name: components["parameters"]["custom-property-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["custom-property-set-payload"]; + requestBody: { + content: { + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["custom-property"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/remove-custom-property": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-delete-organization-definition": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The custom property name */ - readonly custom_property_name: components["parameters"]["custom-property-name"]; + custom_property_name: components["parameters"]["custom-property-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-custom-properties-values-for-repos": { - readonly parameters: { - readonly query?: { + "orgs/custom-properties-for-repos-get-organization-values": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - readonly repository_query?: string; + repository_query?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-repo-custom-property-values"][]; + "application/json": components["schemas"]["org-repo-custom-property-values"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/create-or-update-custom-properties-values-for-repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/custom-properties-for-repos-create-or-update-organization-values": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of repositories that the custom property values will be applied to. */ - readonly repository_names: readonly string[]; + repository_names: string[]; /** @description List of custom property names and associated values to apply to the repositories. */ - readonly properties: readonly components["schemas"]["custom-property-value"][]; + properties: components["schemas"]["custom-property-value"][]; }; }; }; - readonly responses: { + responses: { /** @description No Content when custom property values are successfully created or updated */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/list-public-members": { - readonly parameters: { - readonly query?: { + "orgs/list-public-members": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "orgs/check-public-membership-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/check-public-membership-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if user is a public member */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if user is not a public member */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "orgs/set-public-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-public-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "orgs/remove-public-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-public-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-for-org": { - readonly parameters: { - readonly query?: { + "repos/list-for-org": { + parameters: { + query?: { /** @description Specifies the types of repositories you want returned. */ - readonly type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "repos/create-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the repository. */ - readonly name: string; + name: string; /** @description A short description of the repository. */ - readonly description?: string; + description?: string; /** @description A URL with more information about the repository. */ - readonly homepage?: string; + homepage?: string; /** * @description Whether the repository is private. * @default false */ - readonly private?: boolean; + private?: boolean; /** * @description The visibility of the repository. * @enum {string} */ - readonly visibility?: "public" | "private"; + visibility?: "public" | "private"; /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - readonly has_issues?: boolean; + has_issues?: boolean; /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - readonly has_projects?: boolean; + has_projects?: boolean; /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - readonly has_wiki?: boolean; + has_wiki?: boolean; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads?: boolean; + has_downloads?: boolean; /** * @description Either `true` to make this repo available as a template repository or `false` to prevent it. * @default false */ - readonly is_template?: boolean; + is_template?: boolean; /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - readonly team_id?: number; + team_id?: number; /** * @description Pass `true` to create an initial commit with empty README. * @default false */ - readonly auto_init?: boolean; + auto_init?: boolean; /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - readonly gitignore_template?: string; + gitignore_template?: string; /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - readonly license_template?: string; + license_template?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - readonly allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean; /** * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. * @default false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** * @default false */ - readonly delete_branch_on_merge?: boolean; + 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 is closing down. Please use `squash_merge_commit_title` instead. * @default false */ - readonly use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -98382,7 +106716,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -98391,7 +106725,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -98401,7 +106735,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -98410,2942 +106744,1713 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; + custom_properties?: { + [key: string]: unknown; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-org-rulesets": { - readonly parameters: { - readonly query?: { + "repos/get-org-rulesets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + 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"]; + targets?: components["parameters"]["ruleset-targets"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-ruleset"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/create-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name: string; + name: string; /** * @description The target of the ruleset * @default branch * @enum {string} */ - readonly target?: "branch" | "tag" | "push" | "repository"; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push" | "repository"; + enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["org-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["org-rules"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-org-rule-suites": { - readonly parameters: { - readonly query?: { + "repos/get-org-rule-suites": { + parameters: { + query?: { /** @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?: components["parameters"]["ref-in-query"]; + ref?: components["parameters"]["ref-in-query"]; /** @description The name of the repository to filter on. */ - readonly repository_name?: components["parameters"]["repository-name-in-query"]; + repository_name?: components["parameters"]["repository-name-in-query"]; /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ - readonly time_period?: components["parameters"]["time-period"]; + time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - readonly actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["rule-suites"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-org-rule-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-org-rule-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** * @description The unique identifier of the rule suite result. * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) * for organizations. */ - readonly rule_suite_id: components["parameters"]["rule-suite-id"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["rule-suite"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/update-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name?: string; + name?: string; /** * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push" | "repository"; - readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push" | "repository"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["org-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["org-rules"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/delete-org-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-org-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "secret-scanning/list-alerts-for-org": { - readonly parameters: { - readonly query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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"]; + "orgs/get-org-ruleset-history": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; - /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; - /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - 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"]; + 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 The ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; }; - readonly header?: never; - readonly path: { + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "orgs/get-org-ruleset-version": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["ruleset-version-with-state"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "security-advisories/list-org-repository-advisories": { - readonly parameters: { - readonly query?: { + "secret-scanning/list-alerts-for-org": { + parameters: { + query?: { + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "published"; - /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; - /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ - readonly state?: "triage" | "draft" | "published" | "closed"; + direction?: components["parameters"]["direction"]; + /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ + 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-advisory"][]; + "application/json": components["schemas"]["organization-secret-scanning-alert"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "orgs/list-security-manager-teams": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/list-org-pattern-configs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-simple"][]; + "application/json": components["schemas"]["secret-scanning-pattern-configuration"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/add-security-manager-team": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/update-org-pattern-configs": { + parameters: { + query?: never; + header?: never; + 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 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; + org: components["parameters"]["org"]; }; + cookie?: never; }; - }; - readonly "orgs/remove-security-manager-team": { - 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 slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + requestBody: { + content: { + "application/json": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Pattern settings for provider patterns. */ + provider_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "not-set" | "disabled" | "enabled"; + }[]; + /** @description Pattern settings for custom patterns. */ + custom_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + custom_pattern_version?: components["schemas"]["secret-scanning-row-version"]; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "disabled" | "enabled"; + }[]; }; - content?: never; }; }; - }; - readonly "billing/get-github-actions-billing-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?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": { + /** @description The updated pattern configuration version. */ + pattern_config_version?: string; + }; }; }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "billing/get-github-packages-billing-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/list-org-repository-advisories": { + parameters: { + query?: { + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["repository-advisory"][]; }; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "billing/get-shared-storage-billing-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/list-security-manager-teams": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - readonly "hosted-compute/list-network-configurations-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: { + "orgs/add-security-manager-team": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly total_count: number; - readonly network_configurations: readonly components["schemas"]["network-configuration"][]; - }; + [name: string]: unknown; }; + content?: never; }; }; }; - readonly "hosted-compute/create-network-configuration-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/remove-security-manager-team": { + parameters: { + query?: never; + header?: never; + 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 network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name: string; - /** - * @description The hosted compute service to use for the network configuration. - * @enum {string} - */ - readonly compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - readonly network_settings_ids: readonly string[]; - }; + org: components["parameters"]["org"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 204: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["network-configuration"]; + [name: string]: unknown; }; + content?: never; }; }; }; - readonly "hosted-compute/get-network-configuration-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + requestBody?: never; + responses: { + /** @description Immutable releases settings response */ + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["network-configuration"]; - }; - }; - }; - }; - readonly "hosted-compute/delete-network-configuration-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 hosted compute network configuration. */ - readonly network_configuration_id: components["parameters"]["network-configuration-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + "application/json": components["schemas"]["immutable-releases-organization-settings"]; }; - content?: never; }; }; }; - readonly "hosted-compute/update-network-configuration-for-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - readonly network_configuration_id: components["parameters"]["network-configuration-id"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - readonly name?: string; + requestBody: { + content: { + "application/json": { /** - * @description The hosted compute service to use for the network configuration. + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all * @enum {string} */ - readonly compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - readonly network_settings_ids?: readonly string[]; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["network-configuration"]; + enforced_repositories: "all" | "none" | "selected"; + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids?: number[]; }; }; }; - }; - readonly "hosted-compute/get-network-settings-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 hosted compute network settings. */ - readonly network_settings_id: components["parameters"]["network-settings-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["network-settings"]; - }; - }; - }; - }; - 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"][]; + [name: string]: unknown; }; + content?: never; }; - 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?: { - /** @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; + "orgs/get-immutable-releases-settings-repositories": { + 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)." */ - 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"][]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - }; - }; - readonly "teams/list": { - readonly parameters: { - readonly query?: { + 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 page number of the results to fetch. For 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; - readonly 403: components["responses"]["forbidden"]; }; }; - readonly "teams/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/set-immutable-releases-settings-repositories": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the team. */ - readonly name: string; - /** @description The description of the team. */ - readonly description?: string; - /** @description List GitHub IDs for organization members who will become team maintainers. */ - readonly maintainers?: readonly string[]; - /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - readonly repo_names?: readonly string[]; - /** - * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` - * @enum {string} - */ - readonly privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - readonly permission?: "pull" | "push"; - /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids: number[]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; }; - }; - readonly "teams/get-by-name": { - 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 slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "teams/delete-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/enable-selected-repository-immutable-releases-organization": { + parameters: { + query?: never; + header?: never; + 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"]; + org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/update-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/disable-selected-repository-immutable-releases-organization": { + parameters: { + query?: never; + header?: never; + 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?: { - readonly content: { - readonly "application/json": { - /** @description The name of the team. */ - readonly name?: string; - /** @description The description of the team. */ - readonly description?: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - readonly privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number | null; - }; + org: components["parameters"]["org"]; + /** @description The unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; + cookie?: never; }; - readonly responses: { - /** @description Response when the updated information already exists */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 204: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; + [name: string]: unknown; }; + content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/list-discussions-in-org": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + "hosted-compute/list-network-configurations-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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 Pinned discussions only filter */ - readonly pinned?: string; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + 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"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-discussion"][]; + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; }; }; }; }; - readonly "teams/create-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/create-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title: string; - /** @description The discussion post's body text. */ - readonly body: string; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false + * @description The hosted compute service to use for the network configuration. + * @enum {string} */ - readonly private?: boolean; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["network-configuration"]; }; }; }; }; - readonly "teams/get-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/get-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["network-configuration"]; }; }; }; }; - readonly "teams/delete-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/delete-network-configuration-from-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/update-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/update-network-configuration-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title?: string; - /** @description The discussion post's body text. */ - readonly body?: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/list-discussion-comments-in-org": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - 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 components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - readonly "teams/create-discussion-comment-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; + requestBody: { + content: { + "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; + /** + * @description The hosted compute service to use for the network configuration. + * @enum {string} + */ + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["network-configuration"]; }; }; }; }; - readonly "teams/get-discussion-comment-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "hosted-compute/get-network-settings-for-org": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["network-settings"]; }; }; }; }; - readonly "teams/delete-discussion-comment-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; + "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 100 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 100). For 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; }; - }; - }; - readonly "teams/update-discussion-comment-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; - }; + team_slug: components["parameters"]["team-slug"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "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"]; }; }; - readonly "reactions/list-for-team-discussion-comment-in-org": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + "teams/list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["team"][]; }; }; + 403: components["responses"]["forbidden"]; }; }; - readonly "reactions/create-for-team-discussion-comment-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/create": { + parameters: { + query?: never; + header?: never; + 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"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; + /** @description List GitHub usernames for organization members who will become team maintainers. */ + maintainers?: string[]; + /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ + repo_names?: string[]; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The level of privacy this team should have. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` + * @enum {string} + */ + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} + */ + permission?: "pull" | "push"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number; }; }; }; - readonly responses: { - /** @description Response when the reaction type has already been added to this team discussion comment */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["reaction"]; - }; - }; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-team-discussion-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-by-name": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-full"]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/list-for-team-discussion-in-org": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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: { + "teams/delete-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + [name: string]: unknown; }; + content?: never; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - readonly "reactions/create-for-team-discussion-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/update-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { + /** @description The name of the team. */ + name?: string; + /** @description The description of the team. */ + description?: string; + /** + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * @enum {string} + */ + privacy?: "secret" | "closed"; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; - readonly responses: { - /** @description Response */ - readonly 200: { + responses: { + /** @description Response when the updated information already exists */ + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-team-discussion": { - 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 slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-pending-invitations-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-pending-invitations-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - readonly "teams/list-members-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-members-in-org": { + parameters: { + query?: { /** @description Filters members returned by their role in the team. */ - readonly role?: "member" | "maintainer" | "all"; + role?: "member" | "maintainer" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "teams/get-membership-for-user-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-membership-for-user-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; /** @description if user has no team membership */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-membership-for-user-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-membership-for-user-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The role that this user should have in the team. * @default member * @enum {string} */ - readonly role?: "member" | "maintainer"; + role?: "member" | "maintainer"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-membership-for-user-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-membership-for-user-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Forbidden if team synchronization is set up */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-projects-in-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 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 Link: components["headers"]["link"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["team-project"][]; - }; - }; - }; - }; - readonly "teams/check-permissions-for-project-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + 403: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - readonly 404: { - headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-project-permissions-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - readonly permission?: "read" | "write" | "admin"; - } | null; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - }; - }; - readonly "teams/remove-project-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 The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-repos-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-repos-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "teams/check-permissions-for-repo-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/check-permissions-for-repo-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Alternative response with repository permissions */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-repository"]; + "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if team does not have permission for the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-repo-permissions-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-repo-permissions-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ - readonly permission?: string; + permission?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-repo-in-org": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-repo-in-org": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/list-child-in-org": { - readonly parameters: { - readonly query?: { + "teams/list-child-in-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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The slug of the team name. */ - readonly team_slug: components["parameters"]["team-slug"]; + team_slug: components["parameters"]["team-slug"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if child teams exist */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; }; }; - readonly "orgs/enable-or-disable-security-product-on-all-org-repos": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/enable-or-disable-security-product-on-all-org-repos": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; /** @description The security feature to enable or disable. */ - readonly security_product: components["parameters"]["security-product"]; + security_product: components["parameters"]["security-product"]; /** * @description The action to take. * * `enable_all` means to enable the specified security feature for all repositories in the organization. * `disable_all` means to disable the specified security feature for all repositories in the organization. */ - readonly enablement: components["parameters"]["org-security-product-enablement"]; + enablement: components["parameters"]["org-security-product-enablement"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. * @enum {string} */ - readonly query_suite?: "default" | "extended"; + query_suite?: "default" | "extended"; }; }; }; - readonly responses: { + responses: { /** @description Action started */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "projects/get-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/delete-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/update-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; + "rate-limit/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - readonly note?: string | null; - /** - * @description Whether or not the card is archived - * @example false - */ - readonly archived?: boolean; - }; - }; - }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; + "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; + "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["rate-limit-overview"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/move-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the card. */ - readonly card_id: components["parameters"]["card-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. - * @example bottom - */ - readonly position: string; - /** - * @description The unique identifier of the column the card should be moved to - * @example 42 - */ - readonly column_id?: number; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": Record; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - readonly resource?: string; - readonly field?: string; - }[]; - }; - }; - }; - readonly 422: components["responses"]["validation_failed"]; - /** @description Response */ - readonly 503: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - readonly "projects/get-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "projects/delete-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/update-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - readonly name: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/list-cards": { - readonly parameters: { - readonly query?: { - /** @description Filters the project cards that are returned by the card's state. */ - readonly archived_state?: "all" | "archived" | "not_archived"; - /** @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 unique identifier of the column. */ - readonly column_id: components["parameters"]["column-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 components["schemas"]["project-card"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/create-card": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - readonly note: string | null; - } | { - /** - * @description The unique identifier of the content associated with the card - * @example 42 - */ - readonly content_id: number; - /** - * @description The piece of content associated with the card - * @example PullRequest - */ - readonly content_type: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-card"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - /** @description Validation failed */ - readonly 422: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; - }; - }; - /** @description Response */ - readonly 503: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly code?: string; - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly { - readonly code?: string; - readonly message?: string; - }[]; - }; - }; - }; - }; - }; - readonly "projects/move-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the column. */ - readonly column_id: components["parameters"]["column-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. - * @example last - */ - readonly position: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": Record; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "projects/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Delete Success */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - }; - }; - readonly "projects/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - readonly name?: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - readonly body?: string | null; - /** - * @description State of the project; either 'open' or 'closed' - * @example open - */ - readonly state?: string; - /** - * @description The baseline permission that all organization members have on this project - * @enum {string} - */ - readonly organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. */ - readonly private?: boolean; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - readonly errors?: readonly string[]; - }; - }; - }; - /** @description Not Found if the authenticated user does not have access to the project */ - readonly 404: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "projects/list-collaborators": { - readonly parameters: { - readonly query?: { - /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - readonly affiliation?: "outside" | "direct" | "all"; - /** @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 unique identifier of the project. */ - readonly project_id: components["parameters"]["project-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 components["schemas"]["simple-user"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/add-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The permission to grant the collaborator. - * @default write - * @example write - * @enum {string} - */ - readonly permission?: "read" | "write" | "admin"; - } | null; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/remove-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/get-permission-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "projects/list-columns": { - 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 unique identifier of the project. */ - readonly project_id: components["parameters"]["project-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 components["schemas"]["project-column"][]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - }; - }; - readonly "projects/create-column": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - readonly name: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project-column"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "rate-limit/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"]; - readonly "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"]; - readonly "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"]; - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["rate-limit-overview"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 307: components["responses"]["temporary_redirect"]; + 307: components["responses"]["temporary_redirect"]; /** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "repos/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the repository. */ - readonly name?: string; + name?: string; /** @description A short description of the repository. */ - readonly description?: string; + description?: string; /** @description A URL with more information about the repository. */ - readonly homepage?: string; + homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ - readonly private?: boolean; + private?: boolean; /** * @description The visibility of the repository. * @enum {string} */ - readonly visibility?: "public" | "private"; + visibility?: "public" | "private"; /** * @description Specify which security and analysis features to enable or disable for the repository. * @@ -101356,91 +108461,132 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ - readonly security_and_analysis?: { - /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ - readonly advanced_security?: { + security_and_analysis?: { + /** + * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. + * For more information, see "[About GitHub Advanced + * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ + advanced_security?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */ + code_security?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + status?: string; }; /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ - readonly secret_scanning?: { + secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + status?: string; }; /** @description Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ - readonly secret_scanning_push_protection?: { + secret_scanning_push_protection?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + 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?: { + secret_scanning_ai_detection?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + 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?: { + secret_scanning_non_provider_patterns?: { /** @description Can be `enabled` or `disabled`. */ - readonly status?: string; + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */ + secret_scanning_delegated_alert_dismissal?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */ + secret_scanning_delegated_bypass?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** + * @description Feature options for secret scanning delegated bypass. + * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + */ + secret_scanning_delegated_bypass_options?: { + /** + * @description The bypass reviewers for secret scanning delegated bypass. + * If you omit this field, the existing set of reviewers is unchanged. + */ + 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"; + }[]; }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - readonly has_issues?: boolean; + has_issues?: boolean; /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - readonly has_projects?: boolean; + has_projects?: boolean; /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - readonly has_wiki?: boolean; + has_wiki?: boolean; /** * @description Either `true` to make this repo available as a template repository or `false` to prevent it. * @default false */ - readonly is_template?: boolean; + is_template?: boolean; /** @description Updates the default branch for this repository. */ - readonly default_branch?: string; + default_branch?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - readonly allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean; /** * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. * @default false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. * @default false */ - readonly delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean; /** * @description Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. * @default false */ - readonly allow_update_branch?: boolean; + 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 is closing down. Please use `squash_merge_commit_title` instead. * @default false */ - readonly use_squash_pr_title_as_default?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -101450,7 +108596,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -101459,7 +108605,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -101469,7 +108615,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -101478,1555 +108624,1838 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to archive this repository. `false` will unarchive a previously archived repository. * @default false */ - readonly archived?: boolean; + archived?: boolean; /** * @description Either `true` to allow private forks, or `false` to prevent private forks. * @default false */ - readonly allow_forking?: boolean; + allow_forking?: boolean; /** * @description Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits. * @default false */ - readonly web_commit_signoff_required?: boolean; + web_commit_signoff_required?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 307: components["responses"]["temporary_redirect"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 307: components["responses"]["temporary_redirect"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/list-artifacts-for-repo": { - readonly parameters: { - readonly query?: { + "actions/list-artifacts-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - readonly name?: components["parameters"]["artifact-name"]; + name?: components["parameters"]["artifact-name"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly artifacts: readonly components["schemas"]["artifact"][]; + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; }; }; }; }; }; - readonly "actions/get-artifact": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-artifact": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the artifact. */ - readonly artifact_id: components["parameters"]["artifact-id"]; + artifact_id: components["parameters"]["artifact-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["artifact"]; + "application/json": components["schemas"]["artifact"]; }; }; }; }; - readonly "actions/delete-artifact": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-artifact": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the artifact. */ - readonly artifact_id: components["parameters"]["artifact-id"]; + artifact_id: components["parameters"]["artifact-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/download-artifact": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-artifact": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the artifact. */ - readonly artifact_id: components["parameters"]["artifact-id"]; - readonly archive_format: string; + artifact_id: components["parameters"]["artifact-id"]; + archive_format: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { - readonly Location: components["headers"]["location"]; - readonly [name: string]: unknown; + Location: components["headers"]["location"]; + [name: string]: unknown; }; content?: never; }; - readonly 410: components["responses"]["gone"]; + 410: components["responses"]["gone"]; }; }; - readonly "actions/get-actions-cache-usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-actions-cache-retention-limit-for-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-usage-by-repository"]; + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/get-actions-cache-list": { - readonly parameters: { - readonly query?: { + "actions/get-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-usage": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-usage-by-repository"]; + }; + }; + }; + }; + "actions/get-actions-cache-list": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["parameters"]["actions-cache-git-ref-full"]; + ref?: components["parameters"]["actions-cache-git-ref-full"]; /** @description An explicit key or prefix for identifying the cache */ - readonly key?: components["parameters"]["actions-cache-key"]; + key?: components["parameters"]["actions-cache-key"]; /** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */ - readonly sort?: components["parameters"]["actions-cache-list-sort"]; + sort?: components["parameters"]["actions-cache-list-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-list"]; + "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - readonly "actions/delete-actions-cache-by-key": { - readonly parameters: { - readonly query: { + "actions/delete-actions-cache-by-key": { + parameters: { + query: { /** @description A key for identifying the cache. */ - readonly key: components["parameters"]["actions-cache-key-required"]; + key: components["parameters"]["actions-cache-key-required"]; /** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ - readonly ref?: components["parameters"]["actions-cache-git-ref-full"]; + ref?: components["parameters"]["actions-cache-git-ref-full"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-cache-list"]; + "application/json": components["schemas"]["actions-cache-list"]; }; }; }; }; - readonly "actions/delete-actions-cache-by-id": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-actions-cache-by-id": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the GitHub Actions cache. */ - readonly cache_id: components["parameters"]["cache-id"]; + cache_id: components["parameters"]["cache-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-job-for-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-job-for-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the job. */ - readonly job_id: components["parameters"]["job-id"]; + job_id: components["parameters"]["job-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["job"]; + "application/json": components["schemas"]["job"]; }; }; }; }; - readonly "actions/download-job-logs-for-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-job-logs-for-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the job. */ - readonly job_id: components["parameters"]["job-id"]; + job_id: components["parameters"]["job-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/re-run-job-for-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/re-run-job-for-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the job. */ - readonly job_id: components["parameters"]["job-id"]; + job_id: components["parameters"]["job-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to enable debug logging for the re-run. * @default false */ - readonly enable_debug_logging?: boolean; + enable_debug_logging?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "actions/get-custom-oidc-sub-claim-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-custom-oidc-sub-claim-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Status response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["oidc-custom-sub-repo"]; + "application/json": components["schemas"]["oidc-custom-sub-repo"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-custom-oidc-sub-claim-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-custom-oidc-sub-claim-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */ - readonly use_default: boolean; + use_default: boolean; /** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */ - readonly include_claim_keys?: readonly string[]; + include_claim_keys?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Empty response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-repo-organization-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-repo-organization-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; }; }; }; }; }; - readonly "actions/list-repo-organization-variables": { - readonly parameters: { - readonly query?: { + "actions/list-repo-organization-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; }; }; }; }; }; - readonly "actions/get-github-actions-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-github-actions-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-repository-permissions"]; + }; + }; + }; + }; + "actions/set-github-actions-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + enabled: components["schemas"]["actions-enabled"]; + allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/get-workflow-access-to-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-repository-permissions"]; + "application/json": components["schemas"]["actions-workflow-access-to-repository"]; }; }; }; }; - readonly "actions/set-github-actions-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-workflow-access-to-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly enabled: components["schemas"]["actions-enabled"]; - readonly allowed_actions?: components["schemas"]["allowed-actions"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-workflow-access-to-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + }; + }; + "actions/get-artifact-and-log-retention-settings-repository": { + 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"]; }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/get-workflow-access-to-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-fork-pr-contributor-approval-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-workflow-access-to-repository"]; + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; }; }; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-workflow-access-to-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-fork-pr-contributor-approval-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["actions-workflow-access-to-repository"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/get-allowed-actions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-private-repo-fork-pr-workflows-settings-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["selected-actions"]; + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-allowed-actions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-private-repo-fork-pr-workflows-settings-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["selected-actions"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; }; }; - readonly responses: { + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-allowed-actions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + }; + }; + "actions/set-allowed-actions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": components["schemas"]["selected-actions"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-github-actions-default-workflow-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-github-actions-default-workflow-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; + "application/json": components["schemas"]["actions-get-default-workflow-permissions"]; }; }; }; }; - readonly "actions/set-github-actions-default-workflow-permissions-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-github-actions-default-workflow-permissions-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; + requestBody: { + content: { + "application/json": components["schemas"]["actions-set-default-workflow-permissions"]; }; }; - readonly responses: { + responses: { /** @description Success response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict response when changing a setting is prevented by the owning organization */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-self-hosted-runners-for-repo": { - readonly parameters: { - readonly query?: { + "actions/list-self-hosted-runners-for-repo": { + parameters: { + query?: { /** @description The name of a self-hosted runner. */ - readonly name?: string; + name?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly runners: readonly components["schemas"]["runner"][]; + "application/json": { + total_count: number; + runners: components["schemas"]["runner"][]; }; }; }; }; }; - readonly "actions/list-runner-applications-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-runner-applications-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["runner-application"][]; + "application/json": components["schemas"]["runner-application"][]; }; }; }; }; - readonly "actions/generate-runner-jitconfig-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/generate-runner-jitconfig-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the new runner. */ - readonly name: string; + name: string; /** @description The ID of the runner group to register the runner to. */ - readonly runner_group_id: number; + runner_group_id: number; /** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */ - readonly labels: readonly string[]; + labels: string[]; /** * @description The working directory to be used for job execution, relative to the runner install directory. * @default _work */ - readonly work_folder?: string; + work_folder?: string; }; }; }; - readonly responses: { - readonly 201: components["responses"]["actions_runner_jitconfig"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 201: components["responses"]["actions_runner_jitconfig"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/create-registration-token-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-registration-token-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/create-remove-token-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-remove-token-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["authentication-token"]; + "application/json": components["schemas"]["authentication-token"]; }; }; }; }; - readonly "actions/get-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["runner"]; + "application/json": components["schemas"]["runner"]; }; }; }; }; - readonly "actions/delete-self-hosted-runner-from-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-self-hosted-runner-from-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-labels-for-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/list-labels-for-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/set-custom-labels-for-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/set-custom-labels-for-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/add-custom-labels-to-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/add-custom-labels-to-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The names of the custom labels to add to the runner. */ - readonly labels: readonly string[]; + labels: string[]; }; }; }; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels_readonly"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels_readonly"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/remove-custom-label-from-self-hosted-runner-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/remove-custom-label-from-self-hosted-runner-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description Unique identifier of the self-hosted runner. */ - readonly runner_id: components["parameters"]["runner-id"]; + runner_id: components["parameters"]["runner-id"]; /** @description The name of a self-hosted runner's custom label. */ - readonly name: components["parameters"]["runner-label-name"]; + name: components["parameters"]["runner-label-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 200: components["responses"]["actions_runner_labels"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + requestBody?: never; + responses: { + 200: components["responses"]["actions_runner_labels"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "actions/list-workflow-runs-for-repo": { - readonly parameters: { - readonly query?: { + "actions/list-workflow-runs-for-repo": { + parameters: { + query?: { /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor?: components["parameters"]["actor"]; + actor?: components["parameters"]["actor"]; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly branch?: components["parameters"]["workflow-run-branch"]; + branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event?: components["parameters"]["event"]; + event?: components["parameters"]["event"]; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ - readonly status?: components["parameters"]["workflow-run-status"]; + status?: components["parameters"]["workflow-run-status"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created?: components["parameters"]["created"]; + created?: components["parameters"]["created"]; /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - readonly head_sha?: components["parameters"]["workflow-run-head-sha"]; + head_sha?: components["parameters"]["workflow-run-head-sha"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly workflow_runs: readonly components["schemas"]["workflow-run"][]; + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; }; }; }; }; }; - readonly "actions/get-workflow-run": { - readonly parameters: { - readonly query?: { + "actions/get-workflow-run": { + parameters: { + query?: { /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-run"]; + "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - readonly "actions/delete-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/get-reviews-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-reviews-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["environment-approvals"][]; + "application/json": components["schemas"]["environment-approvals"][]; }; }; }; }; - readonly "actions/approve-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/approve-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/list-workflow-run-artifacts": { - readonly parameters: { - readonly query?: { + "actions/list-workflow-run-artifacts": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ - readonly name?: components["parameters"]["artifact-name"]; + name?: components["parameters"]["artifact-name"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly artifacts: readonly components["schemas"]["artifact"][]; + "application/json": { + total_count: number; + artifacts: components["schemas"]["artifact"][]; }; }; }; }; }; - readonly "actions/get-workflow-run-attempt": { - readonly parameters: { - readonly query?: { + "actions/get-workflow-run-attempt": { + parameters: { + query?: { /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; /** @description The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; + attempt_number: components["parameters"]["attempt-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-run"]; + "application/json": components["schemas"]["workflow-run"]; }; }; }; }; - readonly "actions/list-jobs-for-workflow-run-attempt": { - readonly parameters: { - readonly query?: { + "actions/list-jobs-for-workflow-run-attempt": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; /** @description The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; + attempt_number: components["parameters"]["attempt-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly jobs: readonly components["schemas"]["job"][]; + "application/json": { + total_count: number; + jobs: components["schemas"]["job"][]; }; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "actions/download-workflow-run-attempt-logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-workflow-run-attempt-logs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; /** @description The attempt number of the workflow run. */ - readonly attempt_number: components["parameters"]["attempt-number"]; + attempt_number: components["parameters"]["attempt-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/cancel-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/cancel-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "actions/review-custom-gates-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/review-custom-gates-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["review-custom-gates-comment-required"] | components["schemas"]["review-custom-gates-state-required"]; + requestBody: { + content: { + "application/json": components["schemas"]["review-custom-gates-comment-required"] | components["schemas"]["review-custom-gates-state-required"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/force-cancel-workflow-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/force-cancel-workflow-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "actions/list-jobs-for-workflow-run": { - readonly parameters: { - readonly query?: { + "actions/list-jobs-for-workflow-run": { + parameters: { + query?: { /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */ - readonly filter?: "latest" | "all"; + filter?: "latest" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly jobs: readonly components["schemas"]["job"][]; + "application/json": { + total_count: number; + jobs: components["schemas"]["job"][]; }; }; }; }; }; - readonly "actions/download-workflow-run-logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/download-workflow-run-logs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-workflow-run-logs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-workflow-run-logs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "actions/get-pending-deployments-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-pending-deployments-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pending-deployment"][]; + "application/json": components["schemas"]["pending-deployment"][]; }; }; }; }; - readonly "actions/review-pending-deployments-for-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/review-pending-deployments-for-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The list of environment ids to approve or reject * @example [ @@ -103034,4199 +110463,4227 @@ export interface operations { * 161171795 * ] */ - readonly environment_ids: readonly number[]; + environment_ids: number[]; /** * @description Whether to approve or reject deployment to the specified environments. * @example approved * @enum {string} */ - readonly state: "approved" | "rejected"; + state: "approved" | "rejected"; /** * @description A comment to accompany the deployment review * @example Ship it! */ - readonly comment: string; + comment: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deployment"][]; + "application/json": components["schemas"]["deployment"][]; }; }; }; }; - readonly "actions/re-run-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/re-run-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to enable debug logging for the re-run. * @default false */ - readonly enable_debug_logging?: boolean; + enable_debug_logging?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/re-run-workflow-failed-jobs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/re-run-workflow-failed-jobs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Whether to enable debug logging for the re-run. * @default false */ - readonly enable_debug_logging?: boolean; + enable_debug_logging?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-workflow-run-usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-workflow-run-usage": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the workflow run. */ - readonly run_id: components["parameters"]["run-id"]; + run_id: components["parameters"]["run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-run-usage"]; + "application/json": components["schemas"]["workflow-run-usage"]; }; }; }; }; - readonly "actions/list-repo-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-repo-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; }; }; }; }; }; - readonly "actions/get-repo-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-repo-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-public-key"]; + "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - readonly "actions/get-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-secret"]; + "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - readonly "actions/create-or-update-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-or-update-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-repo-variables": { - readonly parameters: { - readonly query?: { + "actions/list-repo-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; }; }; }; }; }; - readonly "actions/create-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name: string; + name: string; /** @description The value of the variable. */ - readonly value: string; + value: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-variable"]; + "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - readonly "actions/delete-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-repo-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-repo-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name?: string; + name?: string; /** @description The value of the variable. */ - readonly value?: string; + value?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-repo-workflows": { - readonly parameters: { - readonly query?: { + "actions/list-repo-workflows": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly workflows: readonly components["schemas"]["workflow"][]; + "application/json": { + total_count: number; + workflows: components["schemas"]["workflow"][]; }; }; }; }; }; - readonly "actions/get-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow"]; + "application/json": components["schemas"]["workflow"]; }; }; }; }; - readonly "actions/disable-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/disable-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/create-workflow-dispatch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-workflow-dispatch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ - readonly ref: string; - /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ - readonly inputs?: { - readonly [key: string]: unknown; + ref: string; + /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + inputs?: { + [key: string]: unknown; }; + /** @description Whether the response should include the workflow run ID and URLs. */ + return_run_details?: boolean; }; }; }; - readonly responses: { - /** @description Response */ - readonly 204: { + responses: { + /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["workflow-dispatch-response"]; + }; + }; + /** @description Empty response when `return_run_details` parameter is `false`. */ + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/enable-workflow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/enable-workflow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-workflow-runs": { - readonly parameters: { - readonly query?: { + "actions/list-workflow-runs": { + parameters: { + query?: { /** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */ - readonly actor?: components["parameters"]["actor"]; + actor?: components["parameters"]["actor"]; /** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */ - readonly branch?: components["parameters"]["workflow-run-branch"]; + branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ - readonly event?: components["parameters"]["event"]; + event?: components["parameters"]["event"]; /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ - readonly status?: components["parameters"]["workflow-run-status"]; + status?: components["parameters"]["workflow-run-status"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ - readonly created?: components["parameters"]["created"]; + created?: components["parameters"]["created"]; /** @description If `true` pull requests are omitted from the response (empty array). */ - readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; + exclude_pull_requests?: components["parameters"]["exclude-pull-requests"]; /** @description Returns workflow runs with the `check_suite_id` that you specify. */ - readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; + check_suite_id?: components["parameters"]["workflow-run-check-suite-id"]; /** @description Only returns workflow runs that are associated with the specified `head_sha`. */ - readonly head_sha?: components["parameters"]["workflow-run-head-sha"]; + head_sha?: components["parameters"]["workflow-run-head-sha"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly workflow_runs: readonly components["schemas"]["workflow-run"][]; + "application/json": { + total_count: number; + workflow_runs: components["schemas"]["workflow-run"][]; }; }; }; }; }; - readonly "actions/get-workflow-usage": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-workflow-usage": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the workflow. You can also pass the workflow file name as a string. */ - readonly workflow_id: components["parameters"]["workflow-id"]; + workflow_id: components["parameters"]["workflow-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["workflow-usage"]; + "application/json": components["schemas"]["workflow-usage"]; }; }; }; }; - readonly "repos/list-activities": { - readonly parameters: { - readonly query?: { + "repos/list-activities": { + parameters: { + query?: { /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** * @description The Git reference for the activities you want to list. * * The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch. */ - readonly ref?: string; + ref?: string; /** @description The GitHub username to use to filter by the actor who performed the activity. */ - readonly actor?: string; + actor?: string; /** * @description The time period to filter by. * * For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours). */ - readonly time_period?: "day" | "week" | "month" | "quarter" | "year"; + time_period?: "day" | "week" | "month" | "quarter" | "year"; /** * @description The activity type to filter by. * * For example, you can choose to filter by "force_push", to see all force pushes to the repository. */ - readonly activity_type?: "push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge"; + activity_type?: "push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["activity"][]; + "application/json": components["schemas"]["activity"][]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "issues/list-assignees": { - readonly parameters: { - readonly query?: { + "issues/list-assignees": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/check-user-can-be-assigned": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/check-user-can-be-assigned": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly assignee: string; + repo: components["parameters"]["repo"]; + assignee: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Otherwise a `404` status code is returned. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "repos/create-attestation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-attestation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - readonly bundle: { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly [key: string]: unknown; + bundle: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; }; - readonly dsseEnvelope?: { - readonly [key: string]: unknown; + dsseEnvelope?: { + [key: string]: unknown; }; }; }; }; }; - readonly responses: { + responses: { /** @description response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description The ID of the attestation. */ - readonly id?: number; + id?: number; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-attestations": { - readonly parameters: { - readonly query?: { + "repos/list-attestations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - readonly subject_digest: string; + subject_digest: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly attestations?: readonly { + "application/json": { + attestations?: { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - readonly bundle?: { - readonly mediaType?: string; - readonly verificationMaterial?: { - readonly [key: string]: unknown; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; }; - readonly dsseEnvelope?: { - readonly [key: string]: unknown; + dsseEnvelope?: { + [key: string]: unknown; }; }; - readonly repository_id?: number; - readonly bundle_url?: string; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; }; }; }; - readonly "repos/list-autolinks": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-autolinks": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["autolink"][]; + "application/json": components["schemas"]["autolink"][]; }; }; }; }; - readonly "repos/create-autolink": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-autolink": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. */ - readonly key_prefix: string; + key_prefix: string; /** @description The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. */ - readonly url_template: string; + url_template: string; /** * @description Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters. * @default true */ - readonly is_alphanumeric?: boolean; + is_alphanumeric?: boolean; }; }; }; - readonly responses: { + responses: { /** @description response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["autolink"]; + "application/json": components["schemas"]["autolink"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-autolink": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-autolink": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the autolink. */ - readonly autolink_id: components["parameters"]["autolink-id"]; + autolink_id: components["parameters"]["autolink-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["autolink"]; + "application/json": components["schemas"]["autolink"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-autolink": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-autolink": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the autolink. */ - readonly autolink_id: components["parameters"]["autolink-id"]; + autolink_id: components["parameters"]["autolink-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/check-automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if Dependabot is enabled */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-automated-security-fixes"]; + "application/json": components["schemas"]["check-automated-security-fixes"]; }; }; /** @description Not Found if Dependabot is not enabled for the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/enable-automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/enable-automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/disable-automated-security-fixes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-automated-security-fixes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-branches": { - readonly parameters: { - readonly query?: { + "repos/list-branches": { + parameters: { + query?: { /** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ - readonly protected?: boolean; + protected?: boolean; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["short-branch"][]; + "application/json": components["schemas"]["short-branch"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-with-protection"]; + "application/json": components["schemas"]["branch-with-protection"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-protection"]; + "application/json": components["schemas"]["branch-protection"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Require status checks to pass before merging. Set to `null` to disable. */ - readonly required_status_checks: { + required_status_checks: { /** @description Require branches to be up to date before merging. */ - readonly strict: boolean; + strict: boolean; /** * @deprecated * @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[]; + contexts: string[]; /** @description The list of status checks to require in order to merge into this branch. */ - readonly checks?: readonly { + checks?: { /** @description The name of the required check */ - readonly context: string; + context: string; /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - readonly app_id?: number; + app_id?: number; }[]; } | null; /** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */ - readonly enforce_admins: boolean | null; + enforce_admins: boolean | null; /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ - readonly required_pull_request_reviews: { + required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ - readonly dismissal_restrictions?: { + dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s with dismissal access */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s with dismissal access */ - readonly apps?: readonly string[]; + apps?: string[]; }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - readonly dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean; /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - readonly require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean; /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`. * @default false */ - readonly require_last_push_approval?: boolean; + require_last_push_approval?: boolean; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - readonly bypass_pull_request_allowances?: { + bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s allowed to bypass pull request requirements. */ - readonly apps?: readonly string[]; + apps?: string[]; }; } | null; /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ - readonly restrictions: { + restrictions: { /** @description The list of user `login`s with push access */ - readonly users: readonly string[]; + users: string[]; /** @description The list of team `slug`s with push access */ - readonly teams: readonly string[]; + teams: string[]; /** @description The list of app `slug`s with push access */ - readonly apps?: readonly string[]; + apps?: string[]; } | null; /** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */ - readonly required_linear_history?: boolean; + required_linear_history?: boolean; /** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */ - readonly allow_force_pushes?: boolean | null; + allow_force_pushes?: boolean | null; /** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */ - readonly allow_deletions?: boolean; + allow_deletions?: boolean; /** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */ - readonly block_creations?: boolean; + block_creations?: boolean; /** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */ - readonly required_conversation_resolution?: boolean; + required_conversation_resolution?: boolean; /** * @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`. * @default false */ - readonly lock_branch?: boolean; + lock_branch?: boolean; /** * @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`. * @default false */ - readonly allow_fork_syncing?: boolean; + allow_fork_syncing?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch"]; + "application/json": components["schemas"]["protected-branch"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "repos/delete-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-admin-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-admin-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - readonly "repos/set-admin-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-admin-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; }; }; - readonly "repos/delete-admin-branch-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-admin-branch-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-pull-request-review-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pull-request-review-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-pull-request-review"]; + "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; }; }; - readonly "repos/delete-pull-request-review-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-pull-request-review-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-pull-request-review-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-pull-request-review-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ - readonly dismissal_restrictions?: { + dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s with dismissal access */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s with dismissal access */ - readonly apps?: readonly string[]; + apps?: string[]; }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - readonly dismiss_stale_reviews?: boolean; + dismiss_stale_reviews?: boolean; /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - readonly require_code_owner_reviews?: boolean; + require_code_owner_reviews?: boolean; /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - readonly required_approving_review_count?: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false` * @default false */ - readonly require_last_push_approval?: boolean; + require_last_push_approval?: boolean; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - readonly bypass_pull_request_allowances?: { + bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - readonly users?: readonly string[]; + users?: string[]; /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - readonly teams?: readonly string[]; + teams?: string[]; /** @description The list of app `slug`s allowed to bypass pull request requirements. */ - readonly apps?: readonly string[]; + apps?: string[]; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-pull-request-review"]; + "application/json": components["schemas"]["protected-branch-pull-request-review"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-commit-signature-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-commit-signature-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-commit-signature-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-commit-signature-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["protected-branch-admin-enforced"]; + "application/json": components["schemas"]["protected-branch-admin-enforced"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-commit-signature-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-commit-signature-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-status-checks-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-status-checks-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["status-check-policy"]; + "application/json": components["schemas"]["status-check-policy"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/remove-status-check-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-status-check-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-status-check-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-status-check-protection": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Require branches to be up to date before merging. */ - readonly strict?: boolean; + strict?: boolean; /** * @deprecated * @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[]; + contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ - readonly checks?: readonly { + checks?: { /** @description The name of the required check */ - readonly context: string; + context: string; /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ - readonly app_id?: number; + app_id?: number; }[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["status-check-policy"]; + "application/json": components["schemas"]["status-check-policy"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-all-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-all-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the status checks */ - readonly contexts: readonly string[]; - } | readonly string[]; + contexts: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the status checks */ - readonly contexts: readonly string[]; - } | readonly string[]; + contexts: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-status-check-contexts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-status-check-contexts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the status checks */ - readonly contexts: readonly string[]; - } | readonly string[]; + contexts: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-restriction-policy"]; + "application/json": components["schemas"]["branch-restriction-policy"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-apps-with-access-to-protected-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-apps-with-access-to-protected-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-app-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-app-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + 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. */ - readonly apps: readonly string[]; + apps: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-app-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-app-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + 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. */ - readonly apps: readonly string[]; + apps: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-app-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-app-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + 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. */ - readonly apps: readonly string[]; + apps: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["integration"][]; + "application/json": components["schemas"]["integration"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-teams-with-access-to-protected-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-teams-with-access-to-protected-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-team-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-team-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The slug values for teams */ - readonly teams: readonly string[]; - } | readonly string[]; + teams: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-team-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-team-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The slug values for teams */ - readonly teams: readonly string[]; - } | readonly string[]; + teams: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-team-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-team-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The slug values for teams */ - readonly teams: readonly string[]; - } | readonly string[]; + teams: string[]; + } | string[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-users-with-access-to-protected-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-users-with-access-to-protected-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/set-user-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/set-user-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username for users */ - readonly users: readonly string[]; + users: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/add-user-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-user-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username for users */ - readonly users: readonly string[]; + users: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/remove-user-access-restrictions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-user-access-restrictions": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username for users */ - readonly users: readonly string[]; + users: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/rename-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/rename-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The new name of the branch. */ - readonly new_name: string; + new_name: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["branch-with-protection"]; + "application/json": components["schemas"]["branch-with-protection"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "checks/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/create": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the check. For example, "code-coverage". */ - readonly name: string; + name: string; /** @description The SHA of the commit. */ - readonly head_sha: string; + head_sha: string; /** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */ - readonly details_url?: string; + details_url?: string; /** @description A reference for the run on the integrator's system. */ - readonly external_id?: string; + external_id?: string; /** * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @default queued * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + started_at?: string; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at?: string; + completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ - readonly output?: { + output?: { /** @description The title of the check run. */ - readonly title: string; + title: string; /** @description The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */ - readonly summary: string; + summary: string; /** @description The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */ - readonly text?: string; + text?: string; /** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */ - readonly annotations?: readonly { + annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - readonly path: string; + path: string; /** @description The start line of the annotation. Line numbers start at 1. */ - readonly start_line: number; + start_line: number; /** @description The end line of the annotation. */ - readonly end_line: number; + end_line: number; /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */ - readonly start_column?: number; + start_column?: number; /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly end_column?: number; + end_column?: number; /** * @description The level of the annotation. * @enum {string} */ - readonly annotation_level: "notice" | "warning" | "failure"; + annotation_level: "notice" | "warning" | "failure"; /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - readonly message: string; + message: string; /** @description The title that represents the annotation. The maximum size is 255 characters. */ - readonly title?: string; + title?: string; /** @description Details about this annotation. The maximum size is 64 KB. */ - readonly raw_details?: string; + raw_details?: string; }[]; /** @description Adds images to the output displayed in the GitHub pull request UI. */ - readonly images?: readonly { + images?: { /** @description The alternative text for the image. */ - readonly alt: string; + alt: string; /** @description The full URL of the image. */ - readonly image_url: string; + image_url: string; /** @description A short image description. */ - readonly caption?: string; + caption?: string; }[]; }; /** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - readonly actions?: readonly { + actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - readonly label: string; + label: string; /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - readonly description: string; + description: string; /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - readonly identifier: string; + identifier: string; }[]; } & (({ /** @enum {unknown} */ - readonly status: "completed"; + status: "completed"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | ({ /** @enum {unknown} */ - readonly status?: "queued" | "in_progress"; + status?: "queued" | "in_progress"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; })); }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-run"]; + "application/json": components["schemas"]["check-run"]; }; }; }; }; - readonly "checks/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-run"]; + "application/json": components["schemas"]["check-run"]; }; }; }; }; - readonly "checks/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the check. For example, "code-coverage". */ - readonly name?: string; + name?: string; /** @description The URL of the integrator's site that has the full details of the check. */ - readonly details_url?: string; + details_url?: string; /** @description A reference for the run on the integrator's system. */ - readonly external_id?: string; + external_id?: string; /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + started_at?: string; /** * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly completed_at?: string; + completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ - readonly output?: { + output?: { /** @description **Required**. */ - readonly title?: string; + title?: string; /** @description Can contain Markdown. */ - readonly summary: string; + summary: string; /** @description Can contain Markdown. */ - readonly text?: string; + text?: string; /** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */ - readonly annotations?: readonly { + annotations?: { /** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */ - readonly path: string; + path: string; /** @description The start line of the annotation. Line numbers start at 1. */ - readonly start_line: number; + start_line: number; /** @description The end line of the annotation. */ - readonly end_line: number; + end_line: number; /** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */ - readonly start_column?: number; + start_column?: number; /** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */ - readonly end_column?: number; + end_column?: number; /** * @description The level of the annotation. * @enum {string} */ - readonly annotation_level: "notice" | "warning" | "failure"; + annotation_level: "notice" | "warning" | "failure"; /** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */ - readonly message: string; + message: string; /** @description The title that represents the annotation. The maximum size is 255 characters. */ - readonly title?: string; + title?: string; /** @description Details about this annotation. The maximum size is 64 KB. */ - readonly raw_details?: string; + raw_details?: string; }[]; /** @description Adds images to the output displayed in the GitHub pull request UI. */ - readonly images?: readonly { + images?: { /** @description The alternative text for the image. */ - readonly alt: string; + alt: string; /** @description The full URL of the image. */ - readonly image_url: string; + image_url: string; /** @description A short image description. */ - readonly caption?: string; + caption?: string; }[]; }; /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - readonly actions?: readonly { + actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ - readonly label: string; + label: string; /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ - readonly description: string; + description: string; /** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */ - readonly identifier: string; + identifier: string; }[]; } | ({ /** @enum {unknown} */ - readonly status?: "completed"; + status?: "completed"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }) | ({ /** @enum {unknown} */ - readonly status?: "queued" | "in_progress"; + status?: "queued" | "in_progress"; } & { - readonly [key: string]: unknown; + [key: string]: unknown; }); }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-run"]; + "application/json": components["schemas"]["check-run"]; }; }; }; }; - readonly "checks/list-annotations": { - readonly parameters: { - readonly query?: { + "checks/list-annotations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["check-annotation"][]; + "application/json": components["schemas"]["check-annotation"][]; }; }; }; }; - readonly "checks/rerequest-run": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/rerequest-run": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check run. */ - readonly check_run_id: components["parameters"]["check-run-id"]; + check_run_id: components["parameters"]["check-run-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Validation error if the check run is not rerequestable */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "checks/create-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/create-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The sha of the head commit. */ - readonly head_sha: string; + head_sha: string; }; }; }; - readonly responses: { + responses: { /** @description Response when the suite already exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite"]; + "application/json": components["schemas"]["check-suite"]; }; }; /** @description Response when the suite was created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite"]; + "application/json": components["schemas"]["check-suite"]; }; }; }; }; - readonly "checks/set-suites-preferences": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/set-suites-preferences": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. */ - readonly auto_trigger_checks?: readonly { + auto_trigger_checks?: { /** @description The `id` of the GitHub App. */ - readonly app_id: number; + app_id: number; /** * @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them. * @default true */ - readonly setting: boolean; + setting: boolean; }[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite-preference"]; + "application/json": components["schemas"]["check-suite-preference"]; }; }; }; }; - readonly "checks/get-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/get-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check suite. */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; + check_suite_id: components["parameters"]["check-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["check-suite"]; + "application/json": components["schemas"]["check-suite"]; }; }; }; }; - readonly "checks/list-for-suite": { - readonly parameters: { - readonly query?: { + "checks/list-for-suite": { + parameters: { + query?: { /** @description Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + check_name?: components["parameters"]["check-name"]; /** @description Returns check runs with the specified `status`. */ - readonly status?: components["parameters"]["status"]; + status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ - readonly filter?: "latest" | "all"; + filter?: "latest" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check suite. */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; + check_suite_id: components["parameters"]["check-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly check_runs: readonly components["schemas"]["check-run"][]; + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; }; }; }; }; }; - readonly "checks/rerequest-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "checks/rerequest-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the check suite. */ - readonly check_suite_id: components["parameters"]["check-suite-id"]; + check_suite_id: components["parameters"]["check-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "code-scanning/list-alerts-for-repo": { - readonly parameters: { - readonly query?: { + "code-scanning/list-alerts-for-repo": { + parameters: { + query?: { /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + tool_name?: components["parameters"]["tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components["parameters"]["tool-guid"]; /** @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"]; + 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"]; + 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"]; + 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"]; + pr?: components["parameters"]["pr-alias"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + 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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @description The property by which to sort the results. */ - readonly sort?: "created" | "updated"; + sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this state will be returned. */ - readonly state?: components["schemas"]["code-scanning-alert-state-query"]; + state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description If specified, only code scanning alerts with this severity will be returned. */ - readonly severity?: components["schemas"]["code-scanning-alert-severity"]; + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-alert-items"][]; + "application/json": components["schemas"]["code-scanning-alert-items"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-alert"]; + "application/json": components["schemas"]["code-scanning-alert"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/update-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/update-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly state: components["schemas"]["code-scanning-alert-set-state"]; - readonly dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - }; + requestBody: { + content: { + "application/json": { + state?: components["schemas"]["code-scanning-alert-set-state"]; + dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + create_request?: components["schemas"]["code-scanning-alert-create-request"]; + assignees?: components["schemas"]["code-scanning-alert-assignees"]; + } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-alert"]; + "application/json": components["schemas"]["code-scanning-alert"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-autofix": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix"]; + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; - readonly 400: components["responses"]["code_scanning_bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/create-autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/create-autofix": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description OK */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix"]; + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; /** @description Accepted */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix"]; + "application/json": components["schemas"]["code-scanning-autofix"]; }; }; - readonly 400: components["responses"]["code_scanning_bad_request"]; - readonly 403: components["responses"]["code_scanning_autofix_create_forbidden"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_autofix_create_forbidden"]; + 404: components["responses"]["not_found"]; /** @description Unprocessable Entity */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/commit-autofix": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/commit-autofix": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": components["schemas"]["code-scanning-autofix-commits"]; + requestBody?: { + content: { + "application/json": components["schemas"]["code-scanning-autofix-commits"]; }; }; - readonly responses: { + responses: { /** @description Created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; + "application/json": components["schemas"]["code-scanning-autofix-commits-response"]; }; }; - readonly 400: components["responses"]["code_scanning_bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["code_scanning_bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; /** @description Unprocessable Entity */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/list-alert-instances": { - readonly parameters: { - readonly query?: { + "code-scanning/list-alert-instances": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + 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"]; + 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"]; + pr?: components["parameters"]["pr-alias"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-alert-instance"][]; + "application/json": components["schemas"]["code-scanning-alert-instance-list"][]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/list-recent-analyses": { - readonly parameters: { - readonly query?: { + "code-scanning/list-recent-analyses": { + parameters: { + query?: { /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - readonly tool_name?: components["parameters"]["tool-name"]; + tool_name?: components["parameters"]["tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - readonly tool_guid?: components["parameters"]["tool-guid"]; + tool_guid?: components["parameters"]["tool-guid"]; /** @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"]; + 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"]; + 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"]; + 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"]; + ref?: components["schemas"]["code-scanning-ref"]; /** @description Filter analyses belonging to the same SARIF upload. */ - readonly sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; + sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property by which to sort the results. */ - readonly sort?: "created"; + sort?: "created"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-analysis"][]; + "application/json": components["schemas"]["code-scanning-analysis"][]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-analysis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-analysis": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - readonly analysis_id: number; + analysis_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-analysis"]; - readonly "application/json+sarif": { - readonly [key: string]: unknown; + "application/json": components["schemas"]["code-scanning-analysis"]; + "application/sarif+json": { + [key: string]: unknown; }; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_analysis"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/delete-analysis": { - readonly parameters: { - readonly query?: { + "code-scanning/delete-analysis": { + parameters: { + query?: { /** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */ - readonly confirm_delete?: string | null; + confirm_delete?: string | null; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ - readonly analysis_id: number; + analysis_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-analysis-deletion"]; + "application/json": components["schemas"]["code-scanning-analysis-deletion"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/list-codeql-databases": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/list-codeql-databases": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-scanning-codeql-database"][]; + "application/json": components["schemas"]["code-scanning-codeql-database"][]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-codeql-database": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The language of the CodeQL database. */ - readonly language: string; + language: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-codeql-database"]; + "application/json": components["schemas"]["code-scanning-codeql-database"]; }; }; - readonly 302: components["responses"]["found"]; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 302: components["responses"]["found"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/delete-codeql-database": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/delete-codeql-database": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The language of the CodeQL database. */ - readonly language: string; + language: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [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"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/create-variant-analysis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/create-variant-analysis": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly language: components["schemas"]["code-scanning-variant-analysis-language"]; + requestBody: { + content: { + "application/json": { + language: components["schemas"]["code-scanning-variant-analysis-language"]; /** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */ - readonly query_pack: string; + query_pack: string; /** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ - readonly repositories?: readonly string[]; + repositories?: string[]; /** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ - readonly repository_lists?: readonly string[]; + repository_lists?: string[]; /** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */ - readonly repository_owners?: readonly string[]; + repository_owners?: string[]; } & (unknown | unknown | unknown); }; }; - readonly responses: { + responses: { /** @description Variant analysis submitted for processing */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-variant-analysis"]; + "application/json": components["schemas"]["code-scanning-variant-analysis"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Unable to process variant analysis submission */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-variant-analysis": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-variant-analysis": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the variant analysis. */ - readonly codeql_variant_analysis_id: number; + codeql_variant_analysis_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-variant-analysis"]; + "application/json": components["schemas"]["code-scanning-variant-analysis"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-variant-analysis-repo-task": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-variant-analysis-repo-task": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; /** @description The name of the controller repository. */ - readonly repo: string; + repo: string; /** @description The ID of the variant analysis. */ - readonly codeql_variant_analysis_id: number; + codeql_variant_analysis_id: number; /** @description The account owner of the variant analysis repository. The name is not case sensitive. */ - readonly repo_owner: string; + repo_owner: string; /** @description The name of the variant analysis repository. */ - readonly repo_name: string; + repo_name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; + "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-default-setup": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-default-setup": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-default-setup"]; + "application/json": components["schemas"]["code-scanning-default-setup"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_read"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/update-default-setup": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/update-default-setup": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["code-scanning-default-setup-update"]; + requestBody: { + content: { + "application/json": components["schemas"]["code-scanning-default-setup-update"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; + "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["code_scanning_conflict"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["code_scanning_conflict"]; + 422: components["responses"]["code_scanning_invalid_state"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/upload-sarif": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/upload-sarif": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; - readonly ref: components["schemas"]["code-scanning-ref-full"]; - readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; + requestBody: { + content: { + "application/json": { + commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"]; + ref: components["schemas"]["code-scanning-ref-full"]; + sarif: components["schemas"]["code-scanning-analysis-sarif-file"]; /** * Format: uri * @description The base directory used in the analysis, as it appears in the SARIF file. * This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository. * @example file:///github/workspace/ */ - readonly checkout_uri?: string; + checkout_uri?: string; /** * Format: date-time * @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly started_at?: string; + started_at?: string; /** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */ - readonly tool_name?: string; + tool_name?: string; /** * @description Whether the SARIF file will be validated according to the code scanning specifications. * This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning. */ - readonly validate?: boolean; + validate?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; + "application/json": components["schemas"]["code-scanning-sarifs-receipt"]; }; }; /** @description Bad Request if the sarif field is invalid */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["code_scanning_forbidden_write"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["code_scanning_forbidden_write"]; + 404: components["responses"]["not_found"]; /** @description Payload Too Large if the sarif field is too large */ - readonly 413: { + 413: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-scanning/get-sarif": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-scanning/get-sarif": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SARIF ID obtained after uploading. */ - readonly sarif_id: string; + sarif_id: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-scanning-sarifs-status"]; + "application/json": components["schemas"]["code-scanning-sarifs-status"]; }; }; - readonly 403: components["responses"]["code_scanning_forbidden_read"]; + 403: components["responses"]["code_scanning_forbidden_read"]; /** @description Not Found if the sarif id does not match any upload */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "code-security/get-configuration-for-repository": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "code-security/get-configuration-for-repository": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["code-security-configuration-for-repository"]; + "application/json": components["schemas"]["code-security-configuration-for-repository"]; }; }; - readonly 204: components["responses"]["no_content"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 204: components["responses"]["no_content"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/codeowners-errors": { - readonly parameters: { - readonly query?: { + "repos/codeowners-errors": { + parameters: { + query?: { /** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codeowners-errors"]; + "application/json": components["schemas"]["codeowners-errors"]; }; }; /** @description Resource not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/list-in-repository-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-in-repository-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/create-with-repo-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-with-repo-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Git ref (typically a branch name) for this codespace */ - readonly ref?: string; + ref?: string; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - readonly multi_repo_permissions_opt_out?: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - readonly retention_period_minutes?: number; + retention_period_minutes?: number; } | null; }; }; - readonly responses: { + responses: { /** @description Response when the codespace was successfully created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "codespaces/list-devcontainers-in-repository-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-devcontainers-in-repository-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly devcontainers: readonly { - readonly path: string; - readonly name?: string; - readonly display_name?: string; + "application/json": { + total_count: number; + devcontainers: { + path: string; + name?: string; + display_name?: string; }[]; }; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/repo-machines-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/repo-machines-for-authenticated-user": { + parameters: { + query?: { /** @description The location to check for available machines. Assigned by IP if not provided. */ - readonly location?: string; + location?: string; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description The branch or commit to check for prebuild availability and devcontainer restrictions. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly machines: readonly components["schemas"]["codespace-machine"][]; + "application/json": { + total_count: number; + machines: components["schemas"]["codespace-machine"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/pre-flight-with-repo-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/pre-flight-with-repo-for-authenticated-user": { + parameters: { + query?: { /** @description The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. */ - readonly ref?: string; + ref?: string; /** @description An alternative IP for default location auto-detection, such as when proxying a request. */ - readonly client_ip?: string; + client_ip?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when a user is able to create codespaces from the repository. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly billable_owner?: components["schemas"]["simple-user"]; - readonly defaults?: { - readonly location: string; - readonly devcontainer_path: string | null; + "application/json": { + billable_owner?: components["schemas"]["simple-user"]; + defaults?: { + location: string; + devcontainer_path: string | null; }; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/check-permissions-for-devcontainer": { - readonly parameters: { - readonly query: { + "codespaces/check-permissions-for-devcontainer": { + parameters: { + query: { /** @description The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: string; + ref: string; /** @description Path to the devcontainer.json configuration to use for the permission check. */ - readonly devcontainer_path: string; + devcontainer_path: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response when the permission check is successful */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; + "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "codespaces/list-repo-secrets": { - readonly parameters: { - readonly query?: { + "codespaces/list-repo-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["repo-codespaces-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["repo-codespaces-secret"][]; }; }; }; }; }; - readonly "codespaces/get-repo-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-repo-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - readonly "codespaces/get-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repo-codespaces-secret"]; + "application/json": components["schemas"]["repo-codespaces-secret"]; }; }; }; }; - readonly "codespaces/create-or-update-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-or-update-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/delete-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-collaborators": { - readonly parameters: { - readonly query?: { + "repos/list-collaborators": { + parameters: { + query?: { /** @description Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - readonly affiliation?: "outside" | "direct" | "all"; + affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ - readonly permission?: "pull" | "triage" | "push" | "maintain" | "admin"; + permission?: "pull" | "triage" | "push" | "maintain" | "admin"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["collaborator"][]; + "application/json": components["schemas"]["collaborator"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/check-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if user is a collaborator */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if user is not a collaborator */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/add-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/add-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. * @default push */ - readonly permission?: string; + permission?: string; }; }; }; - readonly responses: { + responses: { /** @description Response when a new invitation is created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-invitation"]; + "application/json": components["schemas"]["repository-invitation"]; }; }; /** @@ -107235,974 +114692,990 @@ export interface operations { * - an organization member is added as an individual collaborator * - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + /** + * @description Response when: + * - validation failed, or the endpoint has been spammed + * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; }; }; - readonly "repos/remove-collaborator": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/remove-collaborator": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when collaborator was removed from the repository. */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-collaborator-permission-level": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-collaborator-permission-level": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if user has admin permissions */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-collaborator-permission"]; + "application/json": components["schemas"]["repository-collaborator-permission"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/list-commit-comments-for-repo": { - readonly parameters: { - readonly query?: { + "repos/list-commit-comments-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit-comment"][]; + "application/json": components["schemas"]["commit-comment"][]; }; }; }; }; - readonly "repos/get-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comment"]; + "application/json": components["schemas"]["commit-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comment"]; + "application/json": components["schemas"]["commit-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/list-for-commit-comment": { - readonly parameters: { - readonly query?: { + "reactions/list-for-commit-comment": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-commits": { - readonly parameters: { - readonly query?: { + "repos/list-commits": { + parameters: { + query?: { /** @description SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`). */ - readonly sha?: string; + sha?: string; /** @description Only commits containing this file path will be returned. */ - readonly path?: string; + path?: string; /** @description GitHub username or email address to use to filter by commit author. */ - readonly author?: string; + author?: string; /** @description GitHub username or email address to use to filter by commit committer. */ - readonly committer?: string; + committer?: string; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ - readonly since?: string; + since?: string; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */ - readonly until?: string; + until?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit"][]; + "application/json": components["schemas"]["commit"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/list-branches-for-head-commit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-branches-for-head-commit": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["branch-short"][]; + "application/json": components["schemas"]["branch-short"][]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-comments-for-commit": { - readonly parameters: { - readonly query?: { + "repos/list-comments-for-commit": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit-comment"][]; + "application/json": components["schemas"]["commit-comment"][]; }; }; }; }; - readonly "repos/create-commit-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-commit-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment. */ - readonly body: string; + body: string; /** @description Relative path of the file to comment on. */ - readonly path?: string; + path?: string; /** @description Line index in the diff to comment on. */ - readonly position?: number; + position?: number; /** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */ - readonly line?: number; + line?: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comment"]; + "application/json": components["schemas"]["commit-comment"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-pull-requests-associated-with-commit": { - readonly parameters: { - readonly query?: { + "repos/list-pull-requests-associated-with-commit": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-simple"][]; + "application/json": components["schemas"]["pull-request-simple"][]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "repos/get-commit": { - readonly parameters: { - readonly query?: { + "repos/get-commit": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit"]; + "application/json": components["schemas"]["commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "checks/list-for-ref": { - readonly parameters: { - readonly query?: { + "checks/list-for-ref": { + parameters: { + query?: { /** @description Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + check_name?: components["parameters"]["check-name"]; /** @description Returns check runs with the specified `status`. */ - readonly status?: components["parameters"]["status"]; + status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ - readonly filter?: "latest" | "all"; + filter?: "latest" | "all"; /** @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"]; + 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 app_id?: number; + page?: components["parameters"]["page"]; + app_id?: number; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly check_runs: readonly components["schemas"]["check-run"][]; + "application/json": { + total_count: number; + check_runs: components["schemas"]["check-run"][]; }; }; }; }; }; - readonly "checks/list-suites-for-ref": { - readonly parameters: { - readonly query?: { + "checks/list-suites-for-ref": { + parameters: { + query?: { /** * @description Filters check suites by GitHub App `id`. * @example 1 */ - readonly app_id?: number; + app_id?: number; /** @description Returns check runs with the specified `name`. */ - readonly check_name?: components["parameters"]["check-name"]; + check_name?: components["parameters"]["check-name"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly check_suites: readonly components["schemas"]["check-suite"][]; + "application/json": { + total_count: number; + check_suites: components["schemas"]["check-suite"][]; }; }; }; }; }; - readonly "repos/get-combined-status-for-ref": { - readonly parameters: { - readonly query?: { + "repos/get-combined-status-for-ref": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["combined-commit-status"]; + "application/json": components["schemas"]["combined-commit-status"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/list-commit-statuses-for-ref": { - readonly parameters: { - readonly query?: { + "repos/list-commit-statuses-for-ref": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + ref: components["parameters"]["commit-ref"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["status"][]; + "application/json": components["schemas"]["status"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; + 301: components["responses"]["moved_permanently"]; }; }; - readonly "repos/get-community-profile-metrics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-community-profile-metrics": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["community-profile"]; + "application/json": components["schemas"]["community-profile"]; }; }; }; }; - readonly "repos/compare-commits": { - readonly parameters: { - readonly query?: { + "repos/compare-commits": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. */ - readonly basehead: string; + basehead: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit-comparison"]; + "application/json": components["schemas"]["commit-comparison"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "repos/get-content": { - readonly parameters: { - readonly query?: { + "repos/get-content": { + parameters: { + query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description path parameter */ - readonly path: string; + path: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: { + content: { + "application/json": unknown; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/vnd.github.object": components["schemas"]["content-tree"]; - readonly "application/json": components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"]; + "application/vnd.github.object": components["schemas"]["content-tree"]; + "application/json": components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"]; }; }; - readonly 302: components["responses"]["found"]; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 302: components["responses"]["found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-or-update-file-contents": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-or-update-file-contents": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description path parameter */ - readonly path: string; + path: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The commit message. */ - readonly message: string; + message: string; /** @description The new file content, using Base64 encoding. */ - readonly content: string; + content: string; /** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */ - readonly sha?: string; + sha?: string; /** @description The branch name. Default: the repository’s default branch. */ - readonly branch?: string; + branch?: string; /** @description The person that committed the file. Default: the authenticated user. */ - readonly committer?: { + committer?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - readonly name: string; + name: string; /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - readonly email: string; + email: string; /** @example "2013-01-05T13:13:22+05:00" */ - readonly date?: string; + date?: string; }; /** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */ - readonly author?: { + author?: { /** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */ - readonly name: string; + name: string; /** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */ - readonly email: string; + email: string; /** @example "2013-01-15T17:13:22+05:00" */ - readonly date?: string; + date?: string; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["file-commit"]; + "application/json": components["schemas"]["file-commit"]; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["file-commit"]; + "application/json": components["schemas"]["file-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Conflict */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; + "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/delete-file": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-file": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description path parameter */ - readonly path: string; + path: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The commit message. */ - readonly message: string; + message: string; /** @description The blob SHA of the file being deleted. */ - readonly sha: string; + sha: string; /** @description The branch name. Default: the repository’s default branch */ - readonly branch?: string; + branch?: string; /** @description object containing information about the committer. */ - readonly committer?: { + committer?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + email?: string; }; /** @description object containing information about the author. */ - readonly author?: { + author?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + email?: string; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["file-commit"]; + "application/json": components["schemas"]["file-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "repos/list-contributors": { - readonly parameters: { - readonly query?: { + "repos/list-contributors": { + parameters: { + query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ - readonly anon?: string; + anon?: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If repository contains content */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["contributor"][]; + "application/json": components["schemas"]["contributor"][]; }; }; /** @description Response if repository is empty */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependabot/list-alerts-for-repo": { - readonly parameters: { - readonly query?: { + "dependabot/list-alerts-for-repo": { + parameters: { + query?: { /** * @description A comma-separated list of states. If specified, only alerts with these states will be returned. * * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` */ - readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; /** * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. * * Can be: `low`, `medium`, `high`, `critical` */ - readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; /** * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. * * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` */ - readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; /** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */ - readonly manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; + manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"]; /** * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: * - An exact number (`n`) @@ -108211,648 +115684,645 @@ export interface operations { * * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ - readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - readonly scope?: components["parameters"]["dependabot-alert-scope"]; + scope?: components["parameters"]["dependabot-alert-scope"]; /** * @description The property by which to sort the results. * `created` means when the alert was created. * `updated` means when the alert's state last changed. * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ - readonly sort?: components["parameters"]["dependabot-alert-sort"]; + sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** - * @deprecated - * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. - */ - readonly page?: number; - /** - * @deprecated - * @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?: number; + 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"]; + 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - readonly first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - readonly last?: components["parameters"]["pagination-last"]; + after?: components["parameters"]["pagination-after"]; + /** @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"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["dependabot-alert"][]; + "application/json": components["schemas"]["dependabot-alert"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "dependabot/get-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, * or in `number` fields in the response from the * `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */ - readonly alert_number: components["parameters"]["dependabot-alert-number"]; + alert_number: components["parameters"]["dependabot-alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-alert"]; + "application/json": components["schemas"]["dependabot-alert"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependabot/update-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/update-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The number that identifies a Dependabot alert in its repository. * You can find this at the end of the URL for a Dependabot alert within GitHub, * or in `number` fields in the response from the * `GET /repos/{owner}/{repo}/dependabot/alerts` operation. */ - readonly alert_number: components["parameters"]["dependabot-alert-number"]; + alert_number: components["parameters"]["dependabot-alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state of the Dependabot alert. * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ - readonly state: "dismissed" | "open"; + state?: "dismissed" | "open"; /** * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert. * @enum {string} */ - readonly dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; + dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; /** @description An optional comment associated with dismissing the alert. */ - readonly dismissed_comment?: string; - }; + dismissed_comment?: string; + /** + * @description Usernames to assign to this Dependabot Alert. + * Pass one or more user logins to _replace_ the set of assignees on this alert. + * Send an empty array (`[]`) to clear all assignees from the alert. + */ + assignees?: string[]; + } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-alert"]; + "application/json": components["schemas"]["dependabot-alert"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "dependabot/list-repo-secrets": { - readonly parameters: { - readonly query?: { + "dependabot/list-repo-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["dependabot-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["dependabot-secret"][]; }; }; }; }; }; - readonly "dependabot/get-repo-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-repo-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - readonly "dependabot/get-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/get-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependabot-secret"]; + "application/json": components["schemas"]["dependabot-secret"]; }; }; }; }; - readonly "dependabot/create-or-update-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/create-or-update-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id?: string; + key_id?: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependabot/delete-repo-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependabot/delete-repo-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "dependency-graph/diff-range": { - readonly parameters: { - readonly query?: { + "dependency-graph/diff-range": { + parameters: { + query?: { /** @description The full path, relative to the repository root, of the dependency manifest file. */ - readonly name?: components["parameters"]["manifest-path"]; + name?: components["parameters"]["manifest-path"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */ - readonly basehead: string; + basehead: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependency-graph-diff"]; + "application/json": components["schemas"]["dependency-graph-diff"]; }; }; - readonly 403: components["responses"]["dependency_review_forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["dependency_review_forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependency-graph/export-sbom": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependency-graph/export-sbom": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; + "application/json": components["schemas"]["dependency-graph-spdx-sbom"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "dependency-graph/create-repository-snapshot": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "dependency-graph/create-repository-snapshot": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["snapshot"]; + requestBody: { + content: { + "application/json": components["schemas"]["snapshot"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description ID of the created snapshot. */ - readonly id: number; + id: number; /** @description The time at which the snapshot was created. */ - readonly created_at: string; + created_at: string; /** @description Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. */ - readonly result: string; + result: string; /** @description A message providing further details about the result, such as why the dependencies were not updated. */ - readonly message: string; + message: string; }; }; }; }; }; - readonly "repos/list-deployments": { - readonly parameters: { - readonly query?: { + "repos/list-deployments": { + parameters: { + query?: { /** @description The SHA recorded at creation time. */ - readonly sha?: string; + sha?: string; /** @description The name of the ref. This can be a branch, tag, or SHA. */ - readonly ref?: string; + ref?: string; /** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */ - readonly task?: string; + task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ - readonly environment?: string | null; + environment?: string | null; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deployment"][]; + "application/json": components["schemas"]["deployment"][]; }; }; }; }; - readonly "repos/create-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The ref to deploy. This can be a branch, tag, or SHA. */ - readonly ref: string; + ref: string; /** * @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). * @default deploy */ - readonly task?: string; + task?: string; /** * @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch. * @default true */ - readonly auto_merge?: boolean; + auto_merge?: boolean; /** @description The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */ - readonly required_contexts?: readonly string[]; - readonly payload?: { - readonly [key: string]: unknown; + required_contexts?: string[]; + payload?: { + [key: string]: unknown; } | string; /** * @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`). * @default production */ - readonly environment?: string; + environment?: string; /** * @description Short description of the deployment. * @default */ - readonly description?: string | null; + description?: string | null; /** * @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` * @default false */ - readonly transient_environment?: boolean; + transient_environment?: boolean; /** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */ - readonly production_environment?: boolean; + production_environment?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment"]; + "application/json": components["schemas"]["deployment"]; }; }; /** @description Merged branch response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; + "application/json": { + message?: string; }; }; }; /** @description Conflict when there is a merge conflict or the commit's status checks failed */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment"]; + "application/json": components["schemas"]["deployment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "repos/list-deployment-statuses": { - readonly parameters: { - readonly query?: { + "repos/list-deployment-statuses": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deployment-status"][]; + "application/json": components["schemas"]["deployment-status"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-deployment-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment-status": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; + deployment_id: components["parameters"]["deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. * @enum {string} */ - readonly state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; + state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; /** * @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. * @@ -108860,1613 +116330,1619 @@ export interface operations { * > It's recommended to use the `log_url` parameter, which replaces `target_url`. * @default */ - readonly target_url?: string; + target_url?: string; /** * @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` * @default */ - readonly log_url?: string; + log_url?: string; /** * @description A short description of the status. The maximum description length is 140 characters. * @default */ - readonly description?: string; + description?: string; /** @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. */ - readonly environment?: string; + environment?: string; /** * @description Sets the URL for accessing your environment. Default: `""` * @default */ - readonly environment_url?: string; + environment_url?: string; /** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */ - readonly auto_inactive?: boolean; + auto_inactive?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-status"]; + "application/json": components["schemas"]["deployment-status"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-deployment-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deployment-status": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description deployment_id parameter */ - readonly deployment_id: components["parameters"]["deployment-id"]; - readonly status_id: number; + deployment_id: components["parameters"]["deployment-id"]; + status_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-status"]; + "application/json": components["schemas"]["deployment-status"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-dispatch-event": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-dispatch-event": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A custom webhook event name. Must be 100 characters or fewer. */ - readonly event_type: string; + 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. The total size of the JSON payload must be less than 64KB. */ - readonly client_payload?: { - readonly [key: string]: unknown; + client_payload?: { + [key: string]: unknown; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-all-environments": { - readonly parameters: { - readonly query?: { + "repos/get-all-environments": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The number of environments in this repository * @example 5 */ - readonly total_count?: number; - readonly environments?: readonly components["schemas"]["environment"][]; + total_count?: number; + environments?: components["schemas"]["environment"][]; }; }; }; }; }; - readonly "repos/get-environment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-environment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["environment"]; + "application/json": components["schemas"]["environment"]; }; }; }; }; - readonly "repos/create-or-update-environment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-or-update-environment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - readonly wait_timer?: components["schemas"]["wait-timer"]; - readonly prevent_self_review?: components["schemas"]["prevent-self-review"]; + requestBody?: { + content: { + "application/json": { + wait_timer?: components["schemas"]["wait-timer"]; + prevent_self_review?: components["schemas"]["prevent-self-review"]; /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - readonly reviewers?: readonly { - readonly type?: components["schemas"]["deployment-reviewer-type"]; + reviewers?: { + type?: components["schemas"]["deployment-reviewer-type"]; /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - readonly id?: number; + id?: number; }[] | null; - readonly deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; + deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["environment"]; + "application/json": components["schemas"]["environment"]; }; }; /** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "repos/delete-an-environment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-an-environment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Default response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-deployment-branch-policies": { - readonly parameters: { - readonly query?: { + "repos/list-deployment-branch-policies": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The number of deployment branch policies for the environment. * @example 2 */ - readonly total_count: number; - readonly branch_policies: readonly components["schemas"]["deployment-branch-policy"][]; + total_count: number; + branch_policies: components["schemas"]["deployment-branch-policy"][]; }; }; }; }; }; - readonly "repos/create-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; + requestBody: { + content: { + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-branch-policy"]; + "application/json": components["schemas"]["deployment-branch-policy"]; }; }; /** @description Response if the same branch name pattern already exists */ - readonly 303: { + 303: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ - readonly branch_policy_id: components["parameters"]["branch-policy-id"]; + branch_policy_id: components["parameters"]["branch-policy-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-branch-policy"]; + "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - readonly "repos/update-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ - readonly branch_policy_id: components["parameters"]["branch-policy-id"]; + branch_policy_id: components["parameters"]["branch-policy-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + requestBody: { + content: { + "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-branch-policy"]; + "application/json": components["schemas"]["deployment-branch-policy"]; }; }; }; }; - readonly "repos/delete-deployment-branch-policy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-deployment-branch-policy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ - readonly branch_policy_id: components["parameters"]["branch-policy-id"]; + branch_policy_id: components["parameters"]["branch-policy-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-all-deployment-protection-rules": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-all-deployment-protection-rules": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description List of deployment protection rules */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The number of enabled custom deployment protection rules for this environment * @example 10 */ - readonly total_count?: number; - readonly custom_deployment_protection_rules?: readonly components["schemas"]["deployment-protection-rule"][]; + total_count?: number; + custom_deployment_protection_rules?: components["schemas"]["deployment-protection-rule"][]; }; }; }; }; }; - readonly "repos/create-deployment-protection-rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deployment-protection-rule": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The ID of the custom app that will be enabled on the environment. */ - readonly integration_id?: number; + integration_id?: number; }; }; }; - readonly responses: { + responses: { /** @description The enabled custom deployment protection rule */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-protection-rule"]; + "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - readonly "repos/list-custom-deployment-rule-integrations": { - readonly parameters: { - readonly query?: { + "repos/list-custom-deployment-rule-integrations": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description A list of custom deployment rule integrations available for this environment. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** * @description The total number of custom deployment protection rule integrations available for this environment. * @example 35 */ - readonly total_count?: number; - readonly available_custom_deployment_protection_rule_integrations?: readonly components["schemas"]["custom-deployment-rule-app"][]; + total_count?: number; + available_custom_deployment_protection_rule_integrations?: components["schemas"]["custom-deployment-rule-app"][]; }; }; }; }; }; - readonly "repos/get-custom-deployment-protection-rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-custom-deployment-protection-rule": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the protection rule. */ - readonly protection_rule_id: components["parameters"]["protection-rule-id"]; + protection_rule_id: components["parameters"]["protection-rule-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deployment-protection-rule"]; + "application/json": components["schemas"]["deployment-protection-rule"]; }; }; }; }; - readonly "repos/disable-deployment-protection-rule": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-deployment-protection-rule": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ - readonly repo: components["parameters"]["repo"]; + repo: components["parameters"]["repo"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + owner: components["parameters"]["owner"]; /** @description The unique identifier of the protection rule. */ - readonly protection_rule_id: components["parameters"]["protection-rule-id"]; + protection_rule_id: components["parameters"]["protection-rule-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-environment-secrets": { - readonly parameters: { - readonly query?: { + "actions/list-environment-secrets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["actions-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; }; }; }; }; }; - readonly "actions/get-environment-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-environment-public-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-public-key"]; + "application/json": components["schemas"]["actions-public-key"]; }; }; }; }; - readonly "actions/get-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-environment-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-secret"]; + "application/json": components["schemas"]["actions-secret"]; }; }; }; }; - readonly "actions/create-or-update-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-or-update-environment-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - readonly encrypted_value: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; + key_id: string; }; }; }; - readonly responses: { + responses: { /** @description Response when creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response when updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/delete-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-environment-secret": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Default response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/list-environment-variables": { - readonly parameters: { - readonly query?: { + "actions/list-environment-variables": { + parameters: { + query?: { /** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: components["parameters"]["variables-per-page"]; + per_page?: components["parameters"]["variables-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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly variables: readonly components["schemas"]["actions-variable"][]; + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; }; }; }; }; }; - readonly "actions/create-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/create-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name: string; + name: string; /** @description The value of the variable. */ - readonly value: string; + value: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; }; }; - readonly "actions/get-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/get-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-variable"]; + "application/json": components["schemas"]["actions-variable"]; }; }; }; }; - readonly "actions/delete-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/delete-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "actions/update-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "actions/update-environment-variable": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; + name: components["parameters"]["variable-name"]; /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ - readonly environment_name: components["parameters"]["environment-name"]; + environment_name: components["parameters"]["environment-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the variable. */ - readonly name?: string; + name?: string; /** @description The value of the variable. */ - readonly value?: string; + value?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "activity/list-repo-events": { - readonly parameters: { - readonly query?: { + "activity/list-repo-events": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "repos/list-forks": { - readonly parameters: { - readonly query?: { + "repos/list-forks": { + parameters: { + query?: { /** @description The sort order. `stargazers` will sort by star count. */ - readonly sort?: "newest" | "oldest" | "stargazers" | "watchers"; + sort?: "newest" | "oldest" | "stargazers" | "watchers"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 400: components["responses"]["bad_request"]; + 400: components["responses"]["bad_request"]; }; }; - readonly "repos/create-fork": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-fork": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Optional parameter to specify the organization name if forking into an organization. */ - readonly organization?: string; + organization?: string; /** @description When forking from an existing repository, a new name for the fork. */ - readonly name?: string; + name?: string; /** @description When forking from an existing repository, fork with only the default branch. */ - readonly default_branch_only?: boolean; + default_branch_only?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/create-blob": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-blob": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The new blob's content. */ - readonly content: string; + content: string; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 */ - readonly encoding?: string; + encoding?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["short-blob"]; + "application/json": components["schemas"]["short-blob"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; /** @description Validation failed */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; + "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"]; }; }; }; }; - readonly "git/get-blob": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-blob": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly file_sha: string; + repo: components["parameters"]["repo"]; + file_sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["blob"]; + "application/json": components["schemas"]["blob"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/create-commit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-commit": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The commit message */ - readonly message: string; + message: string; /** @description The SHA of the tree object this commit points to */ - readonly tree: string; + tree: string; /** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */ - readonly parents?: readonly string[]; + parents?: string[]; /** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */ - readonly author?: { + author?: { /** @description The name of the author (or committer) of the commit */ - readonly name: string; + name: string; /** @description The email of the author (or committer) of the commit */ - readonly email: string; + email: string; /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; + date?: string; }; /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ - readonly committer?: { + committer?: { /** @description The name of the author (or committer) of the commit */ - readonly name?: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - readonly email?: string; + email?: string; /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; + date?: string; }; /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ - readonly signature?: string; + signature?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-commit"]; + "application/json": components["schemas"]["git-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/get-commit": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-commit": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA of the commit. */ - readonly commit_sha: components["parameters"]["commit-sha"]; + commit_sha: components["parameters"]["commit-sha"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-commit"]; + "application/json": components["schemas"]["git-commit"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/list-matching-refs": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/list-matching-refs": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["git-ref"][]; + "application/json": components["schemas"]["git-ref"][]; }; }; - readonly 409: components["responses"]["conflict"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/get-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-ref"]; + "application/json": components["schemas"]["git-ref"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/create-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */ - readonly ref: string; + ref: string; /** @description The SHA1 value for this reference. */ - readonly sha: string; + sha: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-ref"]; + "application/json": components["schemas"]["git-ref"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/delete-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/delete-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content?: never; + }; + 409: components["responses"]["conflict"]; + /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */ + 422: { + headers: { + [name: string]: unknown; }; content?: never; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "git/update-ref": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/update-ref": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. * @example heads/feature-a */ - readonly ref: components["parameters"]["git-ref-only"]; + ref: components["parameters"]["git-ref-only"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The SHA1 value to set this reference to */ - readonly sha: string; + sha: string; /** * @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. * @default false */ - readonly force?: boolean; + force?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-ref"]; + "application/json": components["schemas"]["git-ref"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/create-tag": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-tag": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */ - readonly tag: string; + tag: string; /** @description The tag message. */ - readonly message: string; + message: string; /** @description The SHA of the git object this is tagging. */ - readonly object: string; + object: string; /** * @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`. * @enum {string} */ - readonly type: "commit" | "tree" | "blob"; + type: "commit" | "tree" | "blob"; /** @description An object with information about the individual creating the tag. */ - readonly tagger?: { + tagger?: { /** @description The name of the author of the tag */ - readonly name: string; + name: string; /** @description The email of the author of the tag */ - readonly email: string; + email: string; /** * Format: date-time * @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly date?: string; + date?: string; }; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tag"]; + "application/json": components["schemas"]["git-tag"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/get-tag": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/get-tag": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly tag_sha: string; + repo: components["parameters"]["repo"]; + tag_sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tag"]; + "application/json": components["schemas"]["git-tag"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "git/create-tree": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "git/create-tree": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ - readonly tree: readonly { + tree: { /** @description The file referenced in the tree. */ - readonly path?: string; + path?: string; /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - readonly mode?: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - readonly type?: "blob" | "tree" | "commit"; + type?: "blob" | "tree" | "commit"; /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - readonly sha?: string | null; + sha?: string | null; /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - readonly content?: string; + content?: string; }[]; /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. * If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. */ - readonly base_tree?: string; + base_tree?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tree"]; + "application/json": components["schemas"]["git-tree"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "git/get-tree": { - readonly parameters: { - readonly query?: { + "git/get-tree": { + parameters: { + query?: { /** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */ - readonly recursive?: string; + recursive?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The SHA1 value or ref (branch or tag) name of the tree. */ - readonly tree_sha: string; + tree_sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["git-tree"]; + "application/json": components["schemas"]["git-tree"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-webhooks": { - readonly parameters: { - readonly query?: { + "repos/list-webhooks": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook"][]; + "application/json": components["schemas"]["hook"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - readonly name?: string; + name?: string; /** @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"]; + 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. @@ -110474,1739 +117950,2029 @@ export interface operations { * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook"]; + "application/json": components["schemas"]["hook"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook"]; + "application/json": components["schemas"]["hook"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly config?: components["schemas"]["webhook-config"]; + requestBody: { + content: { + "application/json": { + config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ * "push" * ] */ - readonly events?: readonly string[]; + events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - readonly add_events?: readonly string[]; + add_events?: string[]; /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - readonly remove_events?: readonly string[]; + remove_events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - readonly active?: boolean; + active?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook"]; + "application/json": components["schemas"]["hook"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-webhook-config-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-webhook-config-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "repos/update-webhook-config-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-webhook-config-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + 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"]; + 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"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["webhook-config"]; }; }; }; }; - readonly "repos/list-webhook-deliveries": { - readonly parameters: { - readonly query?: { + "repos/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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + cursor?: components["parameters"]["cursor"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["hook-delivery"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/redeliver-webhook-delivery": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/redeliver-webhook-delivery": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; + delivery_id: components["parameters"]["delivery-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/ping-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/ping-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/test-push-webhook": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/test-push-webhook": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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"]; + hook_id: components["parameters"]["hook-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/get-import-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-immutable-releases": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { + /** @description Response if immutable releases are enabled */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["check-immutable-releases"]; + }; + }; + /** @description Not Found if immutable releases are not enabled for the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "repos/enable-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; + }; + }; + "repos/disable-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; + }; + }; + "migrations/get-import-status": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/start-import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/start-import": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The URL of the originating repository. */ - readonly vcs_url: string; + vcs_url: string; /** * @description The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response. * @enum {string} */ - readonly vcs?: "subversion" | "git" | "mercurial" | "tfvc"; + vcs?: "subversion" | "git" | "mercurial" | "tfvc"; /** @description If authentication is required, the username to provide to `vcs_url`. */ - readonly vcs_username?: string; + vcs_username?: string; /** @description If authentication is required, the password to provide to `vcs_url`. */ - readonly vcs_password?: string; + vcs_password?: string; /** @description For a tfvc import, the name of the project that is being imported. */ - readonly tfvc_project?: string; + tfvc_project?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/spraints/socm/import */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/cancel-import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/cancel-import": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["porter_maintenance"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/update-import": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/update-import": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The username to provide to the originating repository. */ - readonly vcs_username?: string; + vcs_username?: string; /** @description The password to provide to the originating repository. */ - readonly vcs_password?: string; + vcs_password?: string; /** * @description The type of version control system you are migrating from. * @example "git" * @enum {string} */ - readonly vcs?: "subversion" | "tfvc" | "git" | "mercurial"; + vcs?: "subversion" | "tfvc" | "git" | "mercurial"; /** * @description For a tfvc import, the name of the project that is being imported. * @example "project1" */ - readonly tfvc_project?: string; + tfvc_project?: string; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 503: components["responses"]["porter_maintenance"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/get-commit-authors": { - readonly parameters: { - readonly query?: { + "migrations/get-commit-authors": { + parameters: { + query?: { /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-user"]; + since?: components["parameters"]["since-user"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["porter-author"][]; + "application/json": components["schemas"]["porter-author"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/map-commit-author": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/map-commit-author": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly author_id: number; + repo: components["parameters"]["repo"]; + author_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The new Git author email. */ - readonly email?: string; + email?: string; /** @description The new Git author name. */ - readonly name?: string; + name?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["porter-author"]; + "application/json": components["schemas"]["porter-author"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["porter_maintenance"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/get-large-files": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/get-large-files": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["porter-large-file"][]; + "application/json": components["schemas"]["porter-large-file"][]; }; }; - readonly 503: components["responses"]["porter_maintenance"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "migrations/set-lfs-preference": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/set-lfs-preference": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import. * @enum {string} */ - readonly use_lfs: "opt_in" | "opt_out"; + use_lfs: "opt_in" | "opt_out"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["import"]; + "application/json": components["schemas"]["import"]; }; }; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["porter_maintenance"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["porter_maintenance"]; }; }; - readonly "apps/get-repo-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-repo-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; }; }; - readonly "interactions/get-restrictions-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/get-restrictions-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; }; }; - readonly "interactions/set-restrictions-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/set-restrictions-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; /** @description Response */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "interactions/remove-restrictions-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "interactions/remove-restrictions-for-repo": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-invitations": { - readonly parameters: { - readonly query?: { + "repos/list-invitations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-invitation"][]; + "application/json": components["schemas"]["repository-invitation"][]; }; }; }; }; - readonly "repos/delete-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-invitation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-invitation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - readonly permissions?: "read" | "write" | "maintain" | "triage" | "admin"; + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-invitation"]; + "application/json": components["schemas"]["repository-invitation"]; }; }; }; }; - readonly "issues/list-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-for-repo": { + parameters: { + query?: { /** @description If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */ - readonly milestone?: string; + milestone?: string; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ - readonly assignee?: string; + assignee?: string; + /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */ + type?: string; /** @description The user that created the issue. */ - readonly creator?: string; + creator?: string; /** @description A user that's mentioned in the issue. */ - readonly mentioned?: string; + mentioned?: string; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The title of the issue. */ - readonly title: string | number; + title: string | number; /** @description The contents of the issue. */ - readonly body?: string; + 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 closing down.**_ */ - readonly assignee?: string | null; - readonly milestone?: (string | number) | null; + 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._ */ - readonly labels?: readonly (string | { - readonly id?: number; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; + labels?: (string | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ - readonly assignees?: readonly string[]; + assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ + * @example Epic + */ + type?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "issues/list-comments-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-comments-for-repo": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-comment"][]; + "application/json": components["schemas"]["issue-comment"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-comment"]; + "application/json": components["schemas"]["issue-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/delete-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/delete-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/update-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-comment"]; + "application/json": components["schemas"]["issue-comment"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/list-for-issue-comment": { - readonly parameters: { - readonly query?: { + "issues/pin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unpin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "reactions/list-for-issue-comment": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-issue-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-issue-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-issue-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-issue-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list-events-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-events-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-event"][]; + "application/json": components["schemas"]["issue-event"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-event": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-event": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly event_id: number; + repo: components["parameters"]["repo"]; + event_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-event"]; + "application/json": components["schemas"]["issue-event"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": unknown; }; - readonly cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The title of the issue. */ - readonly title?: (string | number) | null; + title?: (string | number) | null; /** @description The contents of the issue. */ - readonly body?: string | null; + body?: string | null; /** @description Username to assign to this issue. **This field is closing down.** */ - readonly assignee?: string | null; + assignee?: string | null; /** * @description The open or closed state of the issue. * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ - readonly state_reason?: "completed" | "not_planned" | "reopened" | null; - readonly milestone?: (string | number) | null; + state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - readonly labels?: readonly (string | { - readonly id?: number; - readonly name?: string; - readonly description?: string | null; - readonly color?: string | null; + labels?: (string | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ - readonly assignees?: readonly string[]; + assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + * @example Epic + */ + type?: string | null; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "issues/add-assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/add-assignees": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - readonly assignees?: readonly string[]; + assignees?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; }; }; - readonly "issues/remove-assignees": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-assignees": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - readonly assignees?: readonly string[]; + assignees?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; }; }; - readonly "issues/check-user-can-be-assigned-to-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/check-user-can-be-assigned-to-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; - readonly assignee: string; + issue_number: components["parameters"]["issue-number"]; + assignee: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if `assignee` can be assigned to `issue_number` */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Response if `assignee` can not be assigned to `issue_number` */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "issues/list-comments": { - readonly parameters: { - readonly query?: { + "issues/list-comments": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-comment"][]; + "application/json": components["schemas"]["issue-comment"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/create-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The contents of the comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue-comment"]; + "application/json": components["schemas"]["issue-comment"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/list-events": { - readonly parameters: { - readonly query?: { + "issues/list-dependencies-blocked-by": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue-event-for-issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/list-labels-on-issue": { - readonly parameters: { - readonly query?: { + "issues/add-blocked-by-dependency": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the issue that blocks the current issue */ + issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/remove-dependency-blocked-by": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + /** @description The id of the blocking issue to remove as a dependency */ + issue_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-dependencies-blocking": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/set-labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/list-events": { + 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 account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-event-for-issue"][]; + }; }; - readonly cookie?: never; + 410: components["responses"]["gone"]; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + }; + "issues/list-labels-on-issue": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/set-labels": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */ - readonly labels?: readonly string[]; - } | readonly string[] | { - readonly labels?: readonly { - readonly name: string; + labels?: string[]; + } | string[] | { + labels?: { + name: string; }[]; - } | readonly { - readonly name: string; + } | { + name: string; }[] | string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/add-labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/add-labels": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ - readonly labels?: readonly string[]; - } | readonly string[] | { - readonly labels?: readonly { - readonly name: string; - }[]; - } | readonly { - readonly name: string; - }[] | string; + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ + labels?: string[]; + } | string[] | { + name: string; + }[]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/remove-all-labels": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-all-labels": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/remove-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; - readonly name: string; + issue_number: components["parameters"]["issue-number"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 301: components["responses"]["moved_permanently"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/lock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/lock": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * * `off-topic` @@ -112215,9215 +119981,8547 @@ export interface operations { * * `spam` * @enum {string} */ - readonly lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/unlock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/unlock": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "issues/get-parent": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "reactions/list-for-issue": { - readonly parameters: { - readonly query?: { + "reactions/list-for-issue": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "reactions/create-for-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/remove-sub-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/remove-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The id of the sub-issue to remove */ - readonly sub_issue_id: number; + sub_issue_id: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/list-sub-issues": { - readonly parameters: { - readonly query?: { + "issues/list-sub-issues": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "issues/add-sub-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/add-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ - readonly sub_issue_id: number; + requestBody: { + content: { + "application/json": { + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */ + sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ - readonly replace_parent?: boolean; + replace_parent?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/reprioritize-sub-issue": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/reprioritize-sub-issue": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The id of the sub-issue to reprioritize */ - readonly sub_issue_id: number; + sub_issue_id: number; /** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */ - readonly after_id?: number; + after_id?: number; /** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */ - readonly before_id?: number; + before_id?: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["issue"]; + "application/json": components["schemas"]["issue"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; - readonly 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "issues/list-events-for-timeline": { - readonly parameters: { - readonly query?: { + "issues/list-events-for-timeline": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ - readonly issue_number: components["parameters"]["issue-number"]; + issue_number: components["parameters"]["issue-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["timeline-issue-events"][]; + "application/json": components["schemas"]["timeline-issue-events"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; }; }; - readonly "repos/list-deploy-keys": { - readonly parameters: { - readonly query?: { + "repos/list-deploy-keys": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["deploy-key"][]; + "application/json": components["schemas"]["deploy-key"][]; }; }; }; }; - readonly "repos/create-deploy-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-deploy-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A name for the key. */ - readonly title?: string; + title?: string; /** @description The contents of the key. */ - readonly key: string; + key: string; /** * @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. * * Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)." */ - readonly read_only?: boolean; + read_only?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deploy-key"]; + "application/json": components["schemas"]["deploy-key"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-deploy-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-deploy-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["deploy-key"]; + "application/json": components["schemas"]["deploy-key"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-deploy-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-deploy-key": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list-labels-for-repo": { - readonly parameters: { - readonly query?: { + "issues/list-labels-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/create-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - readonly name: string; + name: string; /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - readonly color?: string; + color?: string; /** @description A short description of the label. Must be 100 characters or fewer. */ - readonly description?: string; + description?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["label"]; + "application/json": components["schemas"]["label"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly name: string; + repo: components["parameters"]["repo"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["label"]; + "application/json": components["schemas"]["label"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/delete-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/delete-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly name: string; + repo: components["parameters"]["repo"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/update-label": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update-label": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly name: string; + repo: components["parameters"]["repo"]; + name: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - readonly new_name?: string; + new_name?: string; /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - readonly color?: string; + color?: string; /** @description A short description of the label. Must be 100 characters or fewer. */ - readonly description?: string; + description?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["label"]; + "application/json": components["schemas"]["label"]; }; }; }; }; - readonly "repos/list-languages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-languages": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["language"]; + "application/json": components["schemas"]["language"]; }; }; }; }; - readonly "licenses/get-for-repo": { - readonly parameters: { - readonly query?: { + "licenses/get-for-repo": { + parameters: { + query?: { /** @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"]; + ref?: components["parameters"]["git-ref"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["license-content"]; + "application/json": components["schemas"]["license-content"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/merge-upstream": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/merge-upstream": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the branch which should be updated to match upstream. */ - readonly branch: string; + branch: string; }; }; }; - readonly responses: { + responses: { /** @description The branch has been successfully synced with the upstream repository */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["merged-upstream"]; + "application/json": components["schemas"]["merged-upstream"]; }; }; /** @description The branch could not be synced because of a merge conflict */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description The branch could not be synced for some other reason */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/merge": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/merge": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the base branch that the head will be merged into. */ - readonly base: string; + base: string; /** @description The head to merge. This can be a branch name or a commit SHA1. */ - readonly head: string; + head: string; /** @description Commit message to use for the merge commit. If omitted, a default message will be used. */ - readonly commit_message?: string; + commit_message?: string; }; }; }; - readonly responses: { + responses: { /** @description Successful Response (The resulting merge commit) */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["commit"]; + "application/json": components["schemas"]["commit"]; }; }; /** @description Response when already merged */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Not Found when the base or head does not exist */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Conflict when there is a merge conflict */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/list-milestones": { - readonly parameters: { - readonly query?: { + "issues/list-milestones": { + parameters: { + query?: { /** @description The state of the milestone. Either `open`, `closed`, or `all`. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description What to sort results by. Either `due_on` or `completeness`. */ - readonly sort?: "due_on" | "completeness"; + sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["milestone"][]; + "application/json": components["schemas"]["milestone"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/create-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/create-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The title of the milestone. */ - readonly title: string; + title: string; /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** @description A description of the milestone. */ - readonly description?: string; + description?: string; /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly due_on?: string; + due_on?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/milestones/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["milestone"]; + "application/json": components["schemas"]["milestone"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "issues/get-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/get-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["milestone"]; + "application/json": components["schemas"]["milestone"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/delete-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/delete-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "issues/update-milestone": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "issues/update-milestone": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The title of the milestone. */ - readonly title?: string; + title?: string; /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** @description A description of the milestone. */ - readonly description?: string; + description?: string; /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly due_on?: string; + due_on?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["milestone"]; + "application/json": components["schemas"]["milestone"]; }; }; }; }; - readonly "issues/list-labels-for-milestone": { - readonly parameters: { - readonly query?: { + "issues/list-labels-for-milestone": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the milestone. */ - readonly milestone_number: components["parameters"]["milestone-number"]; + milestone_number: components["parameters"]["milestone-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["label"][]; + "application/json": components["schemas"]["label"][]; }; }; }; }; - readonly "activity/list-repo-notifications-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-repo-notifications-for-authenticated-user": { + parameters: { + query?: { /** @description If `true`, show notifications marked as read. */ - readonly all?: components["parameters"]["all"]; + all?: components["parameters"]["all"]; /** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */ - readonly participating?: components["parameters"]["participating"]; + participating?: components["parameters"]["participating"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before"]; + before?: components["parameters"]["before"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["thread"][]; + "application/json": components["schemas"]["thread"][]; }; }; }; }; - readonly "activity/mark-repo-notifications-as-read": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/mark-repo-notifications-as-read": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - readonly last_read_at?: string; + last_read_at?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; + "application/json": { + message?: string; + url?: string; }; }; }; /** @description Reset Content */ - readonly 205: { + 205: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-pages": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; + "application/json": components["schemas"]["page"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-information-about-pages-site": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-information-about-pages-site": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ - readonly cname?: string | null; + cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ - readonly https_enforced?: boolean; + https_enforced?: boolean; /** * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. * @enum {string} */ - readonly build_type?: "legacy" | "workflow"; - readonly source?: ("gh-pages" | "master" | "master /docs") | { + build_type?: "legacy" | "workflow"; + source?: ("gh-pages" | "master" | "master /docs") | { /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; + branch: string; /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. * @enum {string} */ - readonly path: "/" | "/docs"; + path: "/" | "/docs"; }; } | unknown | unknown | unknown | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 400: components["responses"]["bad_request"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/create-pages-site": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-pages-site": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": ({ + requestBody: { + content: { + "application/json": ({ /** * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. * @enum {string} */ - readonly build_type?: "legacy" | "workflow"; + build_type?: "legacy" | "workflow"; /** @description The source branch and directory used to publish your Pages site. */ - readonly source?: { + source?: { /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; + branch: string; /** * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` * @default / * @enum {string} */ - readonly path?: "/" | "/docs"; + path?: "/" | "/docs"; }; } | unknown | unknown) | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; + "application/json": components["schemas"]["page"]; }; }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/delete-pages-site": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-pages-site": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-pages-builds": { - readonly parameters: { - readonly query?: { + "repos/list-pages-builds": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["page-build"][]; + "application/json": components["schemas"]["page-build"][]; }; }; }; }; - readonly "repos/request-pages-build": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/request-pages-build": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build-status"]; + "application/json": components["schemas"]["page-build-status"]; }; }; }; }; - readonly "repos/get-latest-pages-build": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-latest-pages-build": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["page-build"]; }; }; }; }; - readonly "repos/get-pages-build": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages-build": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly build_id: number; + repo: components["parameters"]["repo"]; + build_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["page-build"]; }; }; }; }; - readonly "repos/create-pages-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-pages-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ - readonly artifact_id?: number; + artifact_id?: number; /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ - readonly artifact_url?: string; + artifact_url?: string; /** * @description The target environment for this GitHub Pages deployment. * @default github-pages */ - readonly environment?: string; + environment?: string; /** * @description A unique string that represents the version of the build for this deployment. * @default GITHUB_SHA */ - readonly pages_build_version: string; + pages_build_version: string; /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ - readonly oidc_token: string; + oidc_token: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-deployment"]; + "application/json": components["schemas"]["page-deployment"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-pages-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ - readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pages-deployment-status"]; + "application/json": components["schemas"]["pages-deployment-status"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/cancel-pages-deployment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/cancel-pages-deployment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ - readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 404: components["responses"]["not_found"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-pages-health-check": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-pages-health-check": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pages-health-check"]; + "application/json": components["schemas"]["pages-health-check"]; }; }; /** @description Empty response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Custom domains are not available for GitHub Pages */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description There isn't a CNAME for this page */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/check-private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Private vulnerability reporting status */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { + "application/json": { /** @description Whether or not private vulnerability reporting is enabled for the repository. */ - readonly enabled: boolean; + enabled: boolean; }; }; }; - readonly 422: components["responses"]["bad_request"]; + 422: components["responses"]["bad_request"]; }; }; - readonly "repos/enable-private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/enable-private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 422: components["responses"]["bad_request"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; }; }; - readonly "repos/disable-private-vulnerability-reporting": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-private-vulnerability-reporting": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 204: components["responses"]["no_content"]; - readonly 422: components["responses"]["bad_request"]; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 422: components["responses"]["bad_request"]; }; }; - readonly "projects/list-for-repo": { - readonly parameters: { - readonly query?: { - /** @description Indicates the state of the projects to return. */ - readonly state?: "open" | "closed" | "all"; - /** @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: { + "repos/custom-properties-for-repos-get-repository-values": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["project"][]; + "application/json": components["schemas"]["custom-property-value"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/create-for-repo": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/custom-properties-for-repos-create-or-update-repository-values": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the project. */ - readonly name: string; - /** @description The description of the project. */ - readonly body?: string; - }; + repo: components["parameters"]["repo"]; }; + cookie?: never; }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 410: components["responses"]["gone"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "repos/get-custom-properties-values": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["custom-property-value"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/create-or-update-custom-properties-values": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A list of custom property names and associated values to apply to the repositories. */ - readonly properties: readonly components["schemas"]["custom-property-value"][]; + properties: components["schemas"]["custom-property-value"][]; }; }; }; - readonly responses: { + responses: { /** @description No Content when custom property values are successfully created or updated */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list": { - readonly parameters: { - readonly query?: { + "pulls/list": { + parameters: { + query?: { /** @description Either `open`, `closed`, or `all` to filter by state. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`. */ - readonly head?: string; + head?: string; /** @description Filter pulls by base branch name. Example: `gh-pages`. */ - readonly base?: string; + base?: string; /** @description What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month. */ - readonly sort?: "created" | "updated" | "popularity" | "long-running"; + sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-simple"][]; + "application/json": components["schemas"]["pull-request-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/create": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The title of the new pull request. Required unless `issue` is specified. */ - readonly title?: string; + title?: string; /** @description The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - readonly head: string; + head: string; /** * Format: repo.nwo * @description The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization. * @example octo-org/octo-repo */ - readonly head_repo?: string; + head_repo?: string; /** @description The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - readonly base: string; + base: string; /** @description The contents of the pull request. */ - readonly body?: string; + body?: string; /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - readonly maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean; /** @description Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - readonly draft?: boolean; + draft?: boolean; /** * Format: int64 * @description An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified. * @example 1 */ - readonly issue?: number; + issue?: number; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request"]; + "application/json": components["schemas"]["pull-request"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list-review-comments-for-repo": { - readonly parameters: { - readonly query?: { - readonly sort?: "created" | "updated" | "created_at"; + "pulls/list-review-comments-for-repo": { + parameters: { + query?: { + sort?: "created" | "updated" | "created_at"; /** @description The direction to sort results. Ignored without `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-review-comment"][]; + "application/json": components["schemas"]["pull-request-review-comment"][]; }; }; }; }; - readonly "pulls/get-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/get-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/delete-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/delete-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/update-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The text of the reply to the review comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; }; }; - readonly "reactions/list-for-pull-request-review-comment": { - readonly parameters: { - readonly query?: { + "reactions/list-for-pull-request-review-comment": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-pull-request-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-pull-request-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-pull-request-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-pull-request-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "pulls/get": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/get": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Pass the appropriate [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) to fetch diff and patch formats. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request"]; + "application/json": components["schemas"]["pull-request"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 406: components["responses"]["unacceptable"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 406: components["responses"]["unacceptable"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "pulls/update": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The title of the pull request. */ - readonly title?: string; + title?: string; /** @description The contents of the pull request. */ - readonly body?: string; + body?: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - readonly state?: "open" | "closed"; + state?: "open" | "closed"; /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - readonly base?: string; + base?: string; /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - readonly maintainer_can_modify?: boolean; + maintainer_can_modify?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request"]; + "application/json": components["schemas"]["pull-request"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/create-with-pr-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-with-pr-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - readonly multi_repo_permissions_opt_out?: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - readonly retention_period_minutes?: number; + retention_period_minutes?: number; } | null; }; }; - readonly responses: { + responses: { /** @description Response when the codespace was successfully created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "pulls/list-review-comments": { - readonly parameters: { - readonly query?: { + "pulls/list-review-comments": { + parameters: { + query?: { /** @description The property to sort the results by. */ - readonly sort?: components["parameters"]["sort"]; + sort?: components["parameters"]["sort"]; /** @description The direction to sort results. Ignored without `sort` parameter. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-review-comment"][]; + "application/json": components["schemas"]["pull-request-review-comment"][]; }; }; }; }; - readonly "pulls/create-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The text of the review comment. */ - readonly body: string; + body: string; /** @description The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. */ - readonly commit_id: string; + commit_id: string; /** @description The relative path to the file that necessitates a comment. */ - readonly path: string; + path: string; /** * @deprecated * @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; + position?: number; /** * @description In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. * @enum {string} */ - readonly side?: "LEFT" | "RIGHT"; + side?: "LEFT" | "RIGHT"; /** @description **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. */ - readonly line?: number; + line?: number; /** @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. */ - readonly start_line?: number; + start_line?: number; /** * @description **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. * @enum {string} */ - readonly start_side?: "LEFT" | "RIGHT" | "side"; + start_side?: "LEFT" | "RIGHT" | "side"; /** * @description The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored. * @example 2 */ - readonly in_reply_to?: number; + in_reply_to?: number; /** * @description The level at which the comment is targeted. * @enum {string} */ - readonly subject_type?: "line" | "file"; + subject_type?: "line" | "file"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/create-reply-for-review-comment": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create-reply-for-review-comment": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the comment. */ - readonly comment_id: components["parameters"]["comment-id"]; + comment_id: components["parameters"]["comment-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The text of the review comment. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-comment"]; + "application/json": components["schemas"]["pull-request-review-comment"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/list-commits": { - readonly parameters: { - readonly query?: { + "pulls/list-commits": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit"][]; + "application/json": components["schemas"]["commit"][]; }; }; }; }; - readonly "pulls/list-files": { - readonly parameters: { - readonly query?: { + "pulls/list-files": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["diff-entry"][]; + "application/json": components["schemas"]["diff-entry"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; - readonly 503: components["responses"]["service_unavailable"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "pulls/check-if-merged": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/check-if-merged": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if pull request has been merged */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if pull request has not been merged */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "pulls/merge": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/merge": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Title for the automatic commit message. */ - readonly commit_title?: string; + commit_title?: string; /** @description Extra detail to append to automatic commit message. */ - readonly commit_message?: string; + commit_message?: string; /** @description SHA that pull request head must match to allow merge. */ - readonly sha?: string; + sha?: string; /** * @description The merge method to use. * @enum {string} */ - readonly merge_method?: "merge" | "squash" | "rebase"; + merge_method?: "merge" | "squash" | "rebase"; } | null; }; }; - readonly responses: { + responses: { /** @description if merge was successful */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-merge-result"]; + "application/json": components["schemas"]["pull-request-merge-result"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Method Not Allowed if merge cannot be performed */ - readonly 405: { + 405: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; /** @description Conflict if sha was provided and pull request head did not match */ - readonly 409: { + 409: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; + "application/json": { + message?: string; + documentation_url?: string; }; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list-requested-reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/list-requested-reviewers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review-request"]; + "application/json": components["schemas"]["pull-request-review-request"]; }; }; }; }; - readonly "pulls/request-reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/request-reviewers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description An array of user `login`s that will be requested. */ - readonly reviewers?: readonly string[]; + reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ - readonly team_reviewers?: readonly string[]; + team_reviewers?: string[]; } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-simple"]; + "application/json": components["schemas"]["pull-request-simple"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Unprocessable Entity if user is not a collaborator */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "pulls/remove-requested-reviewers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/remove-requested-reviewers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of user `login`s that will be removed. */ - readonly reviewers: readonly string[]; + reviewers: string[]; /** @description An array of team `slug`s that will be removed. */ - readonly team_reviewers?: readonly string[]; + team_reviewers?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-simple"]; + "application/json": components["schemas"]["pull-request-simple"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "pulls/list-reviews": { - readonly parameters: { - readonly query?: { + "pulls/list-reviews": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The list of reviews returns in chronological order. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["pull-request-review"][]; + "application/json": components["schemas"]["pull-request-review"][]; }; }; }; }; - readonly "pulls/create-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/create-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - readonly commit_id?: string; + commit_id?: string; /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - readonly body?: string; + body?: string; /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - readonly event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ - readonly comments?: readonly { + comments?: { /** @description The relative path to the file that necessitates a review comment. */ - readonly path: string; + path: string; /** @description 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; + position?: number; /** @description Text of the review comment. */ - readonly body: string; + body: string; /** @example 28 */ - readonly line?: number; + line?: number; /** @example RIGHT */ - readonly side?: string; + side?: string; /** @example 26 */ - readonly start_line?: number; + start_line?: number; /** @example LEFT */ - readonly start_side?: string; + start_side?: string; }[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/get-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/get-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/update-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The body text of the pull request review. */ - readonly body: string; + body: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/delete-pending-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/delete-pending-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/list-comments-for-review": { - readonly parameters: { - readonly query?: { + "pulls/list-comments-for-review": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["review-comment"][]; + "application/json": components["schemas"]["review-comment"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "pulls/dismiss-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/dismiss-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The message for the pull request review dismissal */ - readonly message: string; + message: string; /** * @example "DISMISS" * @enum {string} */ - readonly event?: "DISMISS"; + event?: "DISMISS"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/submit-review": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/submit-review": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; /** @description The unique identifier of the review. */ - readonly review_id: components["parameters"]["review-id"]; + review_id: components["parameters"]["review-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The body text of the pull request review */ - readonly body?: string; + body?: string; /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. * @enum {string} */ - readonly event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pull-request-review"]; + "application/json": components["schemas"]["pull-request-review"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "pulls/update-branch": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "pulls/update-branch": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The number that identifies the pull request. */ - readonly pull_number: components["parameters"]["pull-number"]; + pull_number: components["parameters"]["pull-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - readonly expected_head_sha?: string; + expected_head_sha?: string; } | null; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; + "application/json": { + message?: string; + url?: string; }; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-readme": { - readonly parameters: { - readonly query?: { + "repos/get-readme": { + parameters: { + query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["content-file"]; + "application/json": components["schemas"]["content-file"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-readme-in-directory": { - readonly parameters: { - readonly query?: { + "repos/get-readme-in-directory": { + parameters: { + query?: { /** @description The name of the commit/branch/tag. Default: the repository’s default branch. */ - readonly ref?: string; + ref?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The alternate path to look for a README file */ - readonly dir: string; + dir: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["content-file"]; + "application/json": components["schemas"]["content-file"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-releases": { - readonly parameters: { - readonly query?: { + "repos/list-releases": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["release"][]; + "application/json": components["schemas"]["release"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/create-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the tag. */ - readonly tag_name: string; + tag_name: string; /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */ - readonly target_commitish?: string; + target_commitish?: string; /** @description The name of the release. */ - readonly name?: string; + name?: string; /** @description Text describing the contents of the tag. */ - readonly body?: string; + body?: string; /** * @description `true` to create a draft (unpublished) release, `false` to create a published one. * @default false */ - readonly draft?: boolean; + draft?: boolean; /** * @description `true` to identify the release as a prerelease. `false` to identify the release as a full release. * @default false */ - readonly prerelease?: boolean; + prerelease?: boolean; /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - readonly discussion_category_name?: string; + discussion_category_name?: string; /** * @description Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes. * @default false */ - readonly generate_release_notes?: boolean; + generate_release_notes?: boolean; /** * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. * @default true * @enum {string} */ - readonly make_latest?: "true" | "false" | "legacy"; + make_latest?: "true" | "false" | "legacy"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/releases/1 */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; /** @description Not Found if the discussion category name is invalid */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-release-asset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-release-asset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the asset. */ - readonly asset_id: components["parameters"]["asset-id"]; + asset_id: components["parameters"]["asset-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-asset"]; + "application/json": components["schemas"]["release-asset"]; }; }; - readonly 302: components["responses"]["found"]; - readonly 404: components["responses"]["not_found"]; + 302: components["responses"]["found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/delete-release-asset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-release-asset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the asset. */ - readonly asset_id: components["parameters"]["asset-id"]; + asset_id: components["parameters"]["asset-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-release-asset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-release-asset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the asset. */ - readonly asset_id: components["parameters"]["asset-id"]; + asset_id: components["parameters"]["asset-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The file name of the asset. */ - readonly name?: string; + name?: string; /** @description An alternate short description of the asset. Used in place of the filename. */ - readonly label?: string; + label?: string; /** @example "uploaded" */ - readonly state?: string; + state?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-asset"]; + "application/json": components["schemas"]["release-asset"]; }; }; }; }; - readonly "repos/generate-release-notes": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/generate-release-notes": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The tag name for the release. This can be an existing tag or a new one. */ - readonly tag_name: string; + tag_name: string; /** @description Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists. */ - readonly target_commitish?: string; + target_commitish?: string; /** @description The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release. */ - readonly previous_tag_name?: string; + previous_tag_name?: string; /** @description Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used. */ - readonly configuration_file_path?: string; + configuration_file_path?: string; }; }; }; - readonly responses: { + responses: { /** @description Name and body of generated release notes */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-notes-content"]; + "application/json": components["schemas"]["release-notes-content"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-latest-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-latest-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; }; }; - readonly "repos/get-release-by-tag": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-release-by-tag": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description tag parameter */ - readonly tag: string; + tag: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; /** @description Unauthorized */ - readonly 401: { + 401: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/delete-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/update-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the tag. */ - readonly tag_name?: string; + tag_name?: string; /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */ - readonly target_commitish?: string; + target_commitish?: string; /** @description The name of the release. */ - readonly name?: string; + name?: string; /** @description Text describing the contents of the tag. */ - readonly body?: string; + body?: string; /** @description `true` makes the release a draft, and `false` publishes the release. */ - readonly draft?: boolean; + draft?: boolean; /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - readonly prerelease?: boolean; + prerelease?: boolean; /** * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. * @default true * @enum {string} */ - readonly make_latest?: "true" | "false" | "legacy"; + make_latest?: "true" | "false" | "legacy"; /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - readonly discussion_category_name?: string; + discussion_category_name?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release"]; + "application/json": components["schemas"]["release"]; }; }; /** @description Not Found if the discussion category name is invalid */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "repos/list-release-assets": { - readonly parameters: { - readonly query?: { + "repos/list-release-assets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["release-asset"][]; + "application/json": components["schemas"]["release-asset"][]; }; }; }; }; - readonly "repos/upload-release-asset": { - readonly parameters: { - readonly query: { - readonly name: string; - readonly label?: string; + "repos/upload-release-asset": { + parameters: { + query: { + name: string; + label?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/octet-stream": string; + requestBody?: { + content: { + "application/octet-stream": string; }; }; - readonly responses: { + responses: { /** @description Response for successful upload */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["release-asset"]; + "application/json": components["schemas"]["release-asset"]; }; }; /** @description Response if you upload an asset with the same filename as another uploaded asset */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "reactions/list-for-release": { - readonly parameters: { - readonly query?: { + "reactions/list-for-release": { + parameters: { + query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ - readonly content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; + "application/json": components["schemas"]["reaction"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "reactions/create-for-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/create-for-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release. * @enum {string} */ - readonly content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; + content: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; }; }; }; - readonly responses: { + responses: { /** @description Reaction exists */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; /** @description Reaction created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["reaction"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "reactions/delete-for-release": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "reactions/delete-for-release": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The unique identifier of the release. */ - readonly release_id: components["parameters"]["release-id"]; + release_id: components["parameters"]["release-id"]; /** @description The unique identifier of the reaction. */ - readonly reaction_id: components["parameters"]["reaction-id"]; + reaction_id: components["parameters"]["reaction-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-branch-rules": { - readonly parameters: { - readonly query?: { + "repos/get-branch-rules": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */ - readonly branch: components["parameters"]["branch"]; + branch: components["parameters"]["branch"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-rule-detailed"][]; + "application/json": components["schemas"]["repository-rule-detailed"][]; }; }; }; }; - readonly "repos/get-repo-rulesets": { - readonly parameters: { - readonly query?: { + "repos/get-repo-rulesets": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Include rulesets configured at higher levels that apply to this repository */ - readonly includes_parents?: boolean; + 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"]; + targets?: components["parameters"]["ruleset-targets"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-ruleset"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/create-repo-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-repo-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name: string; + name: string; /** * @description The target of the ruleset * @default branch * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push"; + enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["repository-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["repository-rule"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-repo-rule-suites": { - readonly parameters: { - readonly query?: { + "repos/get-repo-rule-suites": { + parameters: { + query?: { /** @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?: components["parameters"]["ref-in-query"]; + ref?: components["parameters"]["ref-in-query"]; /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ - readonly time_period?: components["parameters"]["time-period"]; + time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - readonly actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["rule-suites"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-repo-rule-suite": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-repo-rule-suite": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** * @description The unique identifier of the rule suite result. * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) * for organizations. */ - readonly rule_suite_id: components["parameters"]["rule-suite-id"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["rule-suite"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/get-repo-ruleset": { - readonly parameters: { - readonly query?: { + "repos/get-repo-ruleset": { + parameters: { + query?: { /** @description Include rulesets configured at higher levels that apply to this repository */ - readonly includes_parents?: boolean; + includes_parents?: boolean; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/update-repo-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/update-repo-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; /** @description Request body */ - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description The name of the ruleset. */ - readonly name?: string; + name?: string; /** * @description The target of the ruleset * @enum {string} */ - readonly target?: "branch" | "tag" | "push"; - readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][]; - readonly conditions?: components["schemas"]["repository-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - readonly rules?: readonly components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["repository-rule"][]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-ruleset"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "repos/delete-repo-ruleset": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/delete-repo-ruleset": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The ID of the ruleset. */ - readonly ruleset_id: number; + ruleset_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "secret-scanning/list-alerts-for-repo": { - readonly parameters: { - readonly query?: { + "repos/get-repo-ruleset-history": { + 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 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 ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-repo-ruleset-version": { + 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 ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "secret-scanning/list-alerts-for-repo": { + parameters: { + query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - readonly state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; + sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"]; + 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"]; + 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"]; + 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"]; + is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["secret-scanning-alert"][]; + "application/json": components["schemas"]["secret-scanning-alert"][]; }; }; /** @description Repository is public or secret scanning is disabled for the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/get-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/get-alert": { + parameters: { + query?: { + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; + }; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-alert"]; + "application/json": components["schemas"]["secret-scanning-alert"]; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/update-alert": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/update-alert": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly state: components["schemas"]["secret-scanning-alert-state"]; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"]; - readonly resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; - }; + requestBody: { + content: { + "application/json": { + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; + assignee?: components["schemas"]["secret-scanning-alert-assignee"]; + } | unknown | unknown; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-alert"]; + "application/json": components["schemas"]["secret-scanning-alert"]; }; }; /** @description Bad request, resolution comment is invalid or the resolution was not changed. */ - readonly 400: { + 400: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - /** @description State does not match the resolution or resolution comment */ - readonly 422: { + /** @description State does not match the resolution or resolution comment, or assignee does not have write access to the repository */ + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/list-locations-for-alert": { - readonly parameters: { - readonly query?: { + "secret-scanning/list-locations-for-alert": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @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["parameters"]["alert-number"]; + alert_number: components["parameters"]["alert-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["secret-scanning-location"][]; + "application/json": components["schemas"]["secret-scanning-location"][]; }; }; /** @description Repository is public, or secret scanning is disabled for the repository, or the resource is not found */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/create-push-protection-bypass": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/create-push-protection-bypass": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - readonly reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; - readonly placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + requestBody: { + content: { + "application/json": { + reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; + "application/json": components["schemas"]["secret-scanning-push-protection-bypass"]; }; }; /** @description User does not have enough permissions to perform this action. */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Placeholder ID not found, or push protection is disabled on this repository. */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Bad request, input data missing or incorrect. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "secret-scanning/get-scan-history": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "secret-scanning/get-scan-history": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["secret-scanning-scan-history"]; + "application/json": components["schemas"]["secret-scanning-scan-history"]; }; }; /** @description Repository does not have GitHub Advanced Security or secret scanning enabled */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 503: components["responses"]["service_unavailable"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "security-advisories/list-repository-advisories": { - readonly parameters: { - readonly query?: { + "security-advisories/list-repository-advisories": { + parameters: { + query?: { /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "published"; + sort?: "created" | "updated" | "published"; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - readonly per_page?: number; + per_page?: number; /** @description Filter by state of the repository advisories. Only advisories of this state will be returned. */ - readonly state?: "triage" | "draft" | "published" | "closed"; + state?: "triage" | "draft" | "published" | "closed"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-advisory"][]; + "application/json": components["schemas"]["repository-advisory"][]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - readonly "security-advisories/create-repository-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-repository-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["repository-advisory-create"]; + requestBody: { + content: { + "application/json": components["schemas"]["repository-advisory-create"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "security-advisories/create-private-vulnerability-report": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-private-vulnerability-report": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["private-vulnerability-report-create"]; + requestBody: { + content: { + "application/json": components["schemas"]["private-vulnerability-report-create"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "security-advisories/get-repository-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/get-repository-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "security-advisories/update-repository-advisory": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/update-repository-advisory": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["repository-advisory-update"]; + requestBody: { + content: { + "application/json": components["schemas"]["repository-advisory-update"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-advisory"]; + "application/json": components["schemas"]["repository-advisory"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Validation failed, or the endpoint has been spammed. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["validation-error"]; + "application/json": components["schemas"]["validation-error"]; }; }; }; }; - readonly "security-advisories/create-repository-advisory-cve-request": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-repository-advisory-cve-request": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "security-advisories/create-fork": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "security-advisories/create-fork": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ - readonly ghsa_id: components["parameters"]["ghsa_id"]; + ghsa_id: components["parameters"]["ghsa_id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "activity/list-stargazers-for-repo": { - readonly parameters: { - readonly query?: { + "activity/list-stargazers-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][] | readonly components["schemas"]["stargazer"][]; + "application/json": components["schemas"]["simple-user"][] | components["schemas"]["stargazer"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-code-frequency-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-code-frequency-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-frequency-stat"][]; + "application/json": components["schemas"]["code-frequency-stat"][]; }; }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; /** @description Repository contains more than 10,000 commits */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/get-commit-activity-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-commit-activity-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["commit-activity"][]; + "application/json": components["schemas"]["commit-activity"][]; }; }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; }; }; - readonly "repos/get-contributors-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-contributors-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["contributor-activity"][]; + "application/json": components["schemas"]["contributor-activity"][]; }; }; - readonly 202: components["responses"]["accepted"]; - readonly 204: components["responses"]["no_content"]; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; }; }; - readonly "repos/get-participation-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-participation-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The array order is oldest week (index 0) to most recent week. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["participation-stats"]; + "application/json": components["schemas"]["participation-stats"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-punch-card-stats": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-punch-card-stats": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["code-frequency-stat"][]; + "application/json": components["schemas"]["code-frequency-stat"][]; }; }; - readonly 204: components["responses"]["no_content"]; + 204: components["responses"]["no_content"]; }; }; - readonly "repos/create-commit-status": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-commit-status": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly sha: string; + repo: components["parameters"]["repo"]; + sha: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state of the status. * @enum {string} */ - readonly state: "error" | "failure" | "pending" | "success"; + state: "error" | "failure" | "pending" | "success"; /** * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: * `http://ci.example.com/user/repo/build/sha` */ - readonly target_url?: string | null; + target_url?: string | null; /** @description A short description of the status. */ - readonly description?: string | null; + description?: string | null; /** * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. * @default default */ - readonly context?: string; + context?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["status"]; + "application/json": components["schemas"]["status"]; }; }; }; }; - readonly "activity/list-watchers-for-repo": { - readonly parameters: { - readonly query?: { + "activity/list-watchers-for-repo": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "activity/get-repo-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/get-repo-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if you subscribe to the repository */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-subscription"]; + "application/json": components["schemas"]["repository-subscription"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Not Found if you don't subscribe to the repository */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "activity/set-repo-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/set-repo-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Determines if notifications should be received from this repository. */ - readonly subscribed?: boolean; + subscribed?: boolean; /** @description Determines if all notifications should be blocked from this repository. */ - readonly ignored?: boolean; + ignored?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository-subscription"]; + "application/json": components["schemas"]["repository-subscription"]; }; }; }; }; - readonly "activity/delete-repo-subscription": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/delete-repo-subscription": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-tags": { - readonly parameters: { - readonly query?: { + "repos/list-tags": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["tag"][]; + "application/json": components["schemas"]["tag"][]; }; }; }; }; - readonly "repos/list-tag-protection": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/download-tarball-archive": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; + ref: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": readonly components["schemas"]["tag-protection"][]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/create-tag-protection": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description An optional glob pattern to match against when enforcing tag protection. */ - readonly pattern: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["tag-protection"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/delete-tag-protection": { - 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 unique identifier of the tag protection. */ - readonly tag_protection_id: components["parameters"]["tag-protection-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "repos/download-tarball-archive": { - 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"]; - readonly ref: string; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/list-teams": { - readonly parameters: { - readonly query?: { + "repos/list-teams": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-all-topics": { - readonly parameters: { - readonly query?: { + "repos/get-all-topics": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["topic"]; + "application/json": components["schemas"]["topic"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/replace-all-topics": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/replace-all-topics": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` will be saved as lowercase. */ - readonly names: readonly string[]; + names: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["topic"]; + "application/json": components["schemas"]["topic"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - readonly "repos/get-clones": { - readonly parameters: { - readonly query?: { + "repos/get-clones": { + parameters: { + query?: { /** @description The time frame to display results for. */ - readonly per?: components["parameters"]["per"]; + per?: components["parameters"]["per"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["clone-traffic"]; + "application/json": components["schemas"]["clone-traffic"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-top-paths": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-top-paths": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["content-traffic"][]; + "application/json": components["schemas"]["content-traffic"][]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-top-referrers": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/get-top-referrers": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["referrer-traffic"][]; + "application/json": components["schemas"]["referrer-traffic"][]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/get-views": { - readonly parameters: { - readonly query?: { + "repos/get-views": { + parameters: { + query?: { /** @description The time frame to display results for. */ - readonly per?: components["parameters"]["per"]; + per?: components["parameters"]["per"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["view-traffic"]; + "application/json": components["schemas"]["view-traffic"]; }; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/transfer": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/transfer": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The username or organization name the repository will be transferred to. */ - readonly new_owner: string; + new_owner: string; /** @description The new name to be given to the repository. */ - readonly new_name?: string; + new_name?: string; /** @description ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories. */ - readonly team_ids?: readonly number[]; + team_ids?: number[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["minimal-repository"]; + "application/json": components["schemas"]["minimal-repository"]; }; }; }; }; - readonly "repos/check-vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/check-vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response if repository is enabled with vulnerability alerts */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if repository is not enabled with vulnerability alerts */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/enable-vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/enable-vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/disable-vulnerability-alerts": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/disable-vulnerability-alerts": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/download-zipball-archive": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/download-zipball-archive": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; - readonly ref: string; + repo: components["parameters"]["repo"]; + ref: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { /** @example https://codeload.github.com/me/myprivate/legacy.zip/master?login=me&token=thistokenexpires */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "repos/create-using-template": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/create-using-template": { + parameters: { + query?: never; + header?: never; + path: { /** @description The account owner of the template repository. The name is not case sensitive. */ - readonly template_owner: string; + template_owner: string; /** @description The name of the template repository without the `.git` extension. The name is not case sensitive. */ - readonly template_repo: string; + template_repo: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization. */ - readonly owner?: string; + owner?: string; /** @description The name of the new repository. */ - readonly name: string; + name: string; /** @description A short description of the new repository. */ - readonly description?: string; + description?: string; /** * @description Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`. * @default false */ - readonly include_all_branches?: boolean; + include_all_branches?: boolean; /** * @description Either `true` to create a new private repository or `false` to create a new public one. * @default false */ - readonly private?: boolean; + private?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; }; }; - readonly "repos/list-public": { - readonly parameters: { - readonly query?: { + "repos/list-public": { + parameters: { + query?: { /** @description A repository ID. Only return repositories with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-repo"]; + since?: components["parameters"]["since-repo"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "search/code": { - readonly parameters: { - readonly query: { + "search/code": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching code](https://docs.github.com/search-github/searching-on-github/searching-code)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** * @deprecated * @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"; + sort?: "indexed"; /** * @deprecated * @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"; + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["code-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["code-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "search/commits": { - readonly parameters: { - readonly query: { + "search/commits": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching commits](https://docs.github.com/search-github/searching-on-github/searching-commits)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "author-date" | "committer-date"; + sort?: "author-date" | "committer-date"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["commit-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["commit-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "search/issues-and-pull-requests": { - readonly parameters: { - readonly query: { + "search/issues-and-pull-requests": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching issues and pull requests](https://docs.github.com/search-github/searching-on-github/searching-issues-and-pull-requests)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; + sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; + /** + * @description Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + advanced_search?: components["parameters"]["issues-advanced-search"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["issue-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["issue-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "search/labels": { - readonly parameters: { - readonly query: { + "search/labels": { + parameters: { + query: { /** @description The id of the repository. */ - readonly repository_id: number; + repository_id: number; /** @description The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ - readonly q: string; + q: string; /** @description Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "created" | "updated"; + sort?: "created" | "updated"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["label-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["label-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "search/repos": { - readonly parameters: { - readonly query: { + "search/repos": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; + sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["repo-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["repo-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "search/topics": { - readonly parameters: { - readonly query: { + "search/topics": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ - readonly q: string; + q: string; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["topic-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["topic-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "search/users": { - readonly parameters: { - readonly query: { + "search/users": { + parameters: { + query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching users](https://docs.github.com/search-github/searching-on-github/searching-users)" for a detailed list of qualifiers. */ - readonly q: string; + q: string; /** @description Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://docs.github.com/rest/search/search#ranking-search-results) */ - readonly sort?: "followers" | "repositories" | "joined"; + sort?: "followers" | "repositories" | "joined"; /** @description 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?: components["parameters"]["order"]; + order?: components["parameters"]["order"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly incomplete_results: boolean; - readonly items: readonly components["schemas"]["user-search-result-item"][]; + "application/json": { + total_count: number; + incomplete_results: boolean; + items: components["schemas"]["user-search-result-item"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 503: components["responses"]["service_unavailable"]; - }; - }; - readonly "teams/get-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "teams/delete-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-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 422: components["responses"]["validation_failed"]; - }; - }; - readonly "teams/update-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the team. */ - readonly name: string; - /** @description The description of the team. */ - readonly description?: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - readonly privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - readonly permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - readonly parent_team_id?: number | null; - }; - }; - }; - readonly responses: { - /** @description Response when the updated information already exists */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-full"]; - }; - }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "teams/list-discussions-legacy": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-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 components["schemas"]["team-discussion"][]; - }; - }; - }; - }; - readonly "teams/create-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title: string; - /** @description The discussion post's body text. */ - readonly body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - readonly private?: boolean; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/get-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/delete-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/update-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** @description The discussion post's title. */ - readonly title?: string; - /** @description The discussion post's body text. */ - readonly body?: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - readonly "teams/list-discussion-comments-legacy": { - readonly parameters: { - readonly query?: { - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - 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 components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - readonly "teams/create-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; + 304: components["responses"]["not_modified"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "teams/get-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["team-full"]; }; }; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/delete-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/delete-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/update-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/update-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The discussion comment's body text. */ - readonly body: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - readonly "reactions/list-for-team-discussion-comment-legacy": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - 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 components["schemas"]["reaction"][]; - }; - }; - }; - }; - readonly "reactions/create-for-team-discussion-comment-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - readonly comment_number: components["parameters"]["comment-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. * @enum {string} */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["reaction"]; + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} + */ + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; - }; - readonly "reactions/list-for-team-discussion-legacy": { - readonly parameters: { - readonly query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + responses: { + /** @description Response when the updated information already exists */ + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["reaction"][]; - }; - }; - }; - }; - readonly "reactions/create-for-team-discussion-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - readonly discussion_number: components["parameters"]["discussion-number"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + "application/json": components["schemas"]["team-full"]; }; }; - }; - readonly responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/list-pending-invitations-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-pending-invitations-legacy": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; }; }; - readonly "teams/list-members-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-members-legacy": { + parameters: { + query?: { /** @description Filters members returned by their role in the team. */ - readonly role?: "member" | "maintainer" | "all"; + role?: "member" | "maintainer" | "all"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/get-member-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-member-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if user is a member */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description if user is not a member */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-member-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-member-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; + 403: components["responses"]["forbidden"]; /** @description Not Found if team synchronization is set up */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-member-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-member-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if team synchronization is setup */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/get-membership-for-user-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/get-membership-for-user-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/add-or-update-membership-for-user-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-membership-for-user-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The role that this user should have in the team. * @default member * @enum {string} */ - readonly role?: "member" | "maintainer"; + role?: "member" | "maintainer"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-membership"]; + "application/json": components["schemas"]["team-membership"]; }; }; /** @description Forbidden if team synchronization is set up */ - readonly 403: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; /** @description Unprocessable Entity if you attempt to add an organization to a team */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/remove-membership-for-user-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-membership-for-user-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description if team synchronization is set up */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/list-projects-legacy": { - 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 unique identifier of the team. */ - readonly team_id: components["parameters"]["team-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 components["schemas"]["team-project"][]; - }; - }; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "teams/check-permissions-for-project-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - readonly 404: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "teams/add-or-update-project-permissions-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - readonly permission?: "read" | "write" | "admin"; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - readonly 403: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": { - readonly message?: string; - readonly documentation_url?: string; - }; - }; - }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "teams/remove-project-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - readonly project_id: components["parameters"]["project-id"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { + 403: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/list-repos-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-repos-legacy": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/check-permissions-for-repo-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/check-permissions-for-repo-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Alternative response with extra repository information */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["team-repository"]; + "application/json": components["schemas"]["team-repository"]; }; }; /** @description Response if repository is managed by this team */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description Not Found if repository is not managed by this team */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/add-or-update-repo-permissions-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/add-or-update-repo-permissions-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - readonly permission?: "pull" | "push" | "admin"; + permission?: "pull" | "push" | "admin"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "teams/remove-repo-legacy": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "teams/remove-repo-legacy": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; /** @description The account owner of the repository. The name is not case sensitive. */ - readonly owner: components["parameters"]["owner"]; + 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"]; + repo: components["parameters"]["repo"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "teams/list-child-legacy": { - readonly parameters: { - readonly query?: { + "teams/list-child-legacy": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the team. */ - readonly team_id: components["parameters"]["team-id"]; + team_id: components["parameters"]["team-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if child teams exist */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team"][]; + "application/json": components["schemas"]["team"][]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/get-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/get-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/update-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/update-authenticated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description The new name of the user. * @example Omar Jahandar */ - readonly name?: string; + name?: string; /** * @description The publicly visible email address of the user. * @example omar@example.com */ - readonly email?: string; + email?: string; /** * @description The new blog URL of the user. * @example blog.example.com */ - readonly blog?: string; + blog?: string; /** * @description The new Twitter username of the user. * @example therealomarj */ - readonly twitter_username?: string | null; + twitter_username?: string | null; /** * @description The new company of the user. * @example Acme corporation */ - readonly company?: string; + company?: string; /** * @description The new location of the user. * @example Berlin, Germany */ - readonly location?: string; + location?: string; /** @description The new hiring availability of the user. */ - readonly hireable?: boolean; + hireable?: boolean; /** @description The new short biography of the user. */ - readonly bio?: string; + bio?: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["private-user"]; + "application/json": components["schemas"]["private-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-blocked-by-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-blocked-by-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/check-blocked": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/check-blocked": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description If the user is blocked */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; /** @description If the user is not blocked */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "users/block": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/block": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/unblock": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/unblock": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; /** @description ID of the Repository to filter on */ - readonly repository_id?: components["parameters"]["repository-id-in-query"]; + repository_id?: components["parameters"]["repository-id-in-query"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly codespaces: readonly components["schemas"]["codespace"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/create-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "codespaces/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Repository id for this codespace */ - readonly repository_id: number; + repository_id: number; /** @description Git ref (typically a branch name) for this codespace */ - readonly ref?: string; + ref?: string; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - readonly client_ip?: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - readonly multi_repo_permissions_opt_out?: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - readonly retention_period_minutes?: number; + retention_period_minutes?: number; } | { /** @description Pull request number for this codespace */ - readonly pull_request: { + pull_request: { /** @description Pull request number */ - readonly pull_request_number: number; + pull_request_number: number; /** @description Repository id for this codespace */ - readonly repository_id: number; + repository_id: number; }; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description Machine type to use for this codespace */ - readonly machine?: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - readonly devcontainer_path?: string; + devcontainer_path?: string; /** @description Working directory for this codespace */ - readonly working_directory?: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - readonly idle_timeout_minutes?: number; + idle_timeout_minutes?: number; }; }; }; - readonly responses: { + responses: { /** @description Response when the codespace was successfully created */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; /** @description Response when the codespace creation partially failed but is being retried in the background */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 503: components["responses"]["service_unavailable"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - readonly "codespaces/list-secrets-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "codespaces/list-secrets-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly secrets: readonly components["schemas"]["codespaces-secret"][]; + "application/json": { + total_count: number; + secrets: components["schemas"]["codespaces-secret"][]; }; }; }; }; }; - readonly "codespaces/get-public-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "codespaces/get-public-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-user-public-key"]; + "application/json": components["schemas"]["codespaces-user-public-key"]; }; }; }; }; - readonly "codespaces/get-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespaces-secret"]; + "application/json": components["schemas"]["codespaces-secret"]; }; }; }; }; - readonly "codespaces/create-or-update-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/create-or-update-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint. */ - readonly encrypted_value?: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; + key_id: string; /** @description An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */ - readonly selected_repository_ids?: readonly (number | string)[]; + selected_repository_ids?: (number | string)[]; }; }; }; - readonly responses: { + responses: { /** @description Response after successfully creating a secret */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response after successfully updating a secret */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/delete-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "codespaces/list-repositories-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/list-repositories-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repositories: readonly components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; }; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/set-repositories-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/set-repositories-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; + secret_name: components["parameters"]["secret-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints. */ - readonly selected_repository_ids: readonly number[]; + selected_repository_ids: number[]; }; }; }; - readonly responses: { + responses: { /** @description No Content when repositories were added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/add-repository-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/add-repository-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was added to the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/remove-repository-for-secret-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/remove-repository-for-secret-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - readonly repository_id: number; + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description No Content when repository was removed from the selected list */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/get-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/delete-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/delete-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - readonly 202: components["responses"]["accepted"]; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + requestBody?: never; + responses: { + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/update-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/update-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description A valid machine to transition this codespace to. */ - readonly machine?: string; + machine?: string; /** @description Display name for this codespace */ - readonly display_name?: string; + display_name?: string; /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - readonly recent_folders?: readonly string[]; + recent_folders?: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/export-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/export-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 202: { + 202: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace-export-details"]; + "application/json": components["schemas"]["codespace-export-details"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/get-export-details-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/get-export-details-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; /** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */ - readonly export_id: components["parameters"]["export-id"]; + export_id: components["parameters"]["export-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace-export-details"]; + "application/json": components["schemas"]["codespace-export-details"]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "codespaces/codespace-machines-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/codespace-machines-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly machines: readonly components["schemas"]["codespace-machine"][]; + "application/json": { + total_count: number; + machines: components["schemas"]["codespace-machine"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/publish-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/publish-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A name for the new repository. */ - readonly name?: string; + name?: string; /** * @description Whether the new repository should be private. * @default false */ - readonly private?: boolean; + private?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace-with-full-repository"]; + "application/json": components["schemas"]["codespace-with-full-repository"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "codespaces/start-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; /** @description Payment required */ - readonly 402: { + 402: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; - readonly 500: components["responses"]["internal_error"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "codespaces/stop-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "codespaces/stop-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The name of the codespace. */ - readonly codespace_name: components["parameters"]["codespace-name"]; + codespace_name: components["parameters"]["codespace-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["codespace"]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 500: components["responses"]["internal_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - readonly "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "packages/list-docker-migration-conflicting-packages-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; }; }; - readonly "users/set-primary-email-visibility-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/set-primary-email-visibility-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Denotes whether an email is publicly visible. * @enum {string} */ - readonly visibility: "public" | "private"; + visibility: "public" | "private"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-emails-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-emails-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/add-email-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/add-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** * @description Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. * @example [] */ - readonly emails: readonly string[]; - } | readonly string[] | string; + emails: string[]; + } | string[] | string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/delete-email-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/delete-email-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { + requestBody?: { + content: { + "application/json": { /** @description Email addresses associated with the GitHub user account. */ - readonly emails: readonly string[]; - } | readonly string[] | string; + emails: string[]; + } | string[] | string; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-followers-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-followers-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/list-followed-by-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-followed-by-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/check-person-is-followed-by-authenticated": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/check-person-is-followed-by-authenticated": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if the person is followed by the authenticated user */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; /** @description if the person is not followed by the authenticated user */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["basic-error"]; }; }; }; }; - readonly "users/follow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/follow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/unfollow": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/unfollow": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-gpg-keys-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-gpg-keys-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gpg-key"][]; + "application/json": components["schemas"]["gpg-key"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/create-gpg-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/create-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** @description A descriptive name for the new key. */ - readonly name?: string; + name?: string; /** @description A GPG key in ASCII-armored format. */ - readonly armored_public_key: string; + armored_public_key: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gpg-key"]; + "application/json": components["schemas"]["gpg-key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/get-gpg-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/get-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the GPG key. */ - readonly gpg_key_id: components["parameters"]["gpg-key-id"]; + gpg_key_id: components["parameters"]["gpg-key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["gpg-key"]; + "application/json": components["schemas"]["gpg-key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/delete-gpg-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/delete-gpg-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the GPG key. */ - readonly gpg_key_id: components["parameters"]["gpg-key-id"]; + gpg_key_id: components["parameters"]["gpg-key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/list-installations-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "apps/list-installations-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description You can find the permissions for the installation under the `permissions` key. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly installations: readonly components["schemas"]["installation"][]; + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "apps/list-installation-repos-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "apps/list-installation-repos-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description The access the user has to each repository is included in the hash under the `permissions` key. */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly total_count: number; - readonly repository_selection?: string; - readonly repositories: readonly components["schemas"]["repository"][]; + "application/json": { + total_count: number; + repository_selection?: string; + repositories: components["schemas"]["repository"][]; }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/add-repo-to-installation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/add-repo-to-installation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/remove-repo-from-installation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/remove-repo-from-installation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the installation. */ - readonly installation_id: components["parameters"]["installation-id"]; + installation_id: components["parameters"]["installation-id"]; /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; + repository_id: components["parameters"]["repository-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; /** @description Returned when the application is installed on `all` repositories in the organization, or if this request would remove the last repository that the application has access to in the organization. */ - readonly 422: { + 422: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "interactions/get-restrictions-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "interactions/get-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Default response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; /** @description Response when there are no restrictions */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "interactions/set-restrictions-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "interactions/set-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": components["schemas"]["interaction-limit"]; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "interactions/remove-restrictions-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "interactions/remove-restrictions-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "issues/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "issues/list-for-authenticated-user": { + parameters: { + query?: { /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; /** @description Indicates the state of the issues to return. */ - readonly state?: "open" | "closed" | "all"; + state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - readonly labels?: components["parameters"]["labels"]; + labels?: components["parameters"]["labels"]; /** @description What to sort results by. */ - readonly sort?: "created" | "updated" | "comments"; + sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["issue"][]; + "application/json": components["schemas"]["issue"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-public-ssh-keys-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-public-ssh-keys-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["key"][]; + "application/json": components["schemas"]["key"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/create-public-ssh-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/create-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description A descriptive name for the new key. * @example Personal MacBook Air */ - readonly title?: string; + title?: string; /** @description The public SSH key to add to your GitHub account. */ - readonly key: string; + key: string; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["key"]; + "application/json": components["schemas"]["key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/get-public-ssh-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/get-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["key"]; + "application/json": components["schemas"]["key"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/delete-public-ssh-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/delete-public-ssh-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the key. */ - readonly key_id: components["parameters"]["key-id"]; + key_id: components["parameters"]["key-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/list-subscriptions-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "apps/list-subscriptions-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["user-marketplace-purchase"][]; + "application/json": components["schemas"]["user-marketplace-purchase"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 404: components["responses"]["not_found"]; }; }; - readonly "apps/list-subscriptions-for-authenticated-user-stubbed": { - readonly parameters: { - readonly query?: { + "apps/list-subscriptions-for-authenticated-user-stubbed": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["user-marketplace-purchase"][]; + "application/json": components["schemas"]["user-marketplace-purchase"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; }; }; - readonly "orgs/list-memberships-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "orgs/list-memberships-for-authenticated-user": { + parameters: { + query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ - readonly state?: "active" | "pending"; + state?: "active" | "pending"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["org-membership"][]; + "application/json": components["schemas"]["org-membership"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "orgs/get-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/get-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/update-membership-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "orgs/update-membership-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The state that the membership should be in. Only `"active"` will be accepted. * @enum {string} */ - readonly state: "active"; + state: "active"; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["org-membership"]; }; }; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "migrations/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "migrations/list-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["migration"][]; + "application/json": components["schemas"]["migration"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "migrations/start-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "migrations/start-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Lock the repositories being migrated at the start of the migration * @example true */ - readonly lock_repositories?: boolean; + lock_repositories?: boolean; /** * @description Indicates whether metadata should be excluded and only git source should be included for the migration. * @example true */ - readonly exclude_metadata?: boolean; + exclude_metadata?: boolean; /** * @description Indicates whether the repository git data should be excluded from the migration. * @example true */ - readonly exclude_git_data?: boolean; + exclude_git_data?: boolean; /** * @description Do not include attachments in the migration * @example true */ - readonly exclude_attachments?: boolean; + exclude_attachments?: boolean; /** * @description Do not include releases in the migration * @example true */ - readonly exclude_releases?: boolean; + exclude_releases?: boolean; /** * @description Indicates whether projects owned by the organization or users should be excluded. * @example true */ - readonly exclude_owner_projects?: boolean; + exclude_owner_projects?: boolean; /** * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). * @default false * @example true */ - readonly org_metadata_only?: boolean; + org_metadata_only?: boolean; /** * @description Exclude attributes from the API response to improve performance * @example [ * "repositories" * ] */ - readonly exclude?: readonly "repositories"[]; - readonly repositories: readonly string[]; + exclude?: "repositories"[]; + repositories: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "migrations/get-status-for-authenticated-user": { - readonly parameters: { - readonly query?: { - readonly exclude?: readonly string[]; + "migrations/get-status-for-authenticated-user": { + parameters: { + query?: { + exclude?: string[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["migration"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/get-archive-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/get-archive-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 302: { + 302: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "migrations/delete-archive-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/delete-archive-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/unlock-repo-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "migrations/unlock-repo-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; /** @description repo_name parameter */ - readonly repo_name: components["parameters"]["repo-name"]; + repo_name: components["parameters"]["repo-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "migrations/list-repos-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "migrations/list-repos-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The unique identifier of the migration. */ - readonly migration_id: components["parameters"]["migration-id"]; + migration_id: components["parameters"]["migration-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "orgs/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "orgs/list-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; + "application/json": components["schemas"]["organization-simple"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "packages/list-packages-for-authenticated-user": { - readonly parameters: { - readonly query: { + "packages/list-packages-for-authenticated-user": { + parameters: { + query: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly visibility?: components["parameters"]["package-visibility"]; + visibility?: components["parameters"]["package-visibility"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 400: components["responses"]["package_es_list_error"]; + 400: components["responses"]["package_es_list_error"]; }; }; - readonly "packages/get-package-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package"]; + "application/json": components["schemas"]["package"]; }; }; }; }; - readonly "packages/delete-package-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "packages/restore-package-for-authenticated-user": { + parameters: { + query?: { /** @description package token */ - readonly token?: string; + token?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { - readonly parameters: { - readonly query?: { + "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { + 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)." */ - readonly page?: components["parameters"]["page"]; + 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"]; + per_page?: components["parameters"]["per-page"]; /** @description The state of the package, either active or deleted. */ - readonly state?: "active" | "deleted"; + state?: "active" | "deleted"; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; + "application/json": components["schemas"]["package-version"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-package-version-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-version-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["package-version"]; }; }; }; }; - readonly "packages/delete-package-version-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-version-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-version-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/restore-package-version-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/create-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - readonly name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - readonly body?: string | null; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["project"]; - }; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed_simple"]; - }; - }; - readonly "users/list-public-emails-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-public-emails-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["email"][]; + "application/json": components["schemas"]["email"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "repos/list-for-authenticated-user": { + parameters: { + query?: { /** @description Limit results to repositories with the specified visibility. */ - readonly visibility?: "all" | "public" | "private"; + visibility?: "all" | "public" | "private"; /** * @description Comma-separated list of values. Can include: * * `owner`: Repositories that are owned by the authenticated user. * * `collaborator`: Repositories that the user has been added to as a collaborator. * * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on. */ - readonly affiliation?: string; + affiliation?: string; /** @description Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. */ - readonly type?: "all" | "owner" | "public" | "private" | "member"; + type?: "all" | "owner" | "public" | "private" | "member"; /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; + sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - readonly direction?: "asc" | "desc"; + direction?: "asc" | "desc"; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; /** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since-repo-date"]; + since?: components["parameters"]["since-repo-date"]; /** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly before?: components["parameters"]["before-repo-date"]; + before?: components["parameters"]["before-repo-date"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository"][]; + "application/json": components["schemas"]["repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/create-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "repos/create-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description The name of the repository. * @example Team Environment */ - readonly name: string; + name: string; /** @description A short description of the repository. */ - readonly description?: string; + description?: string; /** @description A URL with more information about the repository. */ - readonly homepage?: string; + homepage?: string; /** * @description Whether the repository is private. * @default false */ - readonly private?: boolean; + private?: boolean; /** * @description Whether issues are enabled. * @default true * @example true */ - readonly has_issues?: boolean; + has_issues?: boolean; /** * @description Whether projects are enabled. * @default true * @example true */ - readonly has_projects?: boolean; + has_projects?: boolean; /** * @description Whether the wiki is enabled. * @default true * @example true */ - readonly has_wiki?: boolean; + has_wiki?: boolean; /** * @description Whether discussions are enabled. * @default false * @example true */ - readonly has_discussions?: boolean; + has_discussions?: boolean; /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - readonly team_id?: number; + team_id?: number; /** * @description Whether the repository is initialized with a minimal README. * @default false */ - readonly auto_init?: boolean; + auto_init?: boolean; /** * @description The desired language or platform to apply to the .gitignore. * @example Haskell */ - readonly gitignore_template?: string; + gitignore_template?: string; /** * @description The license keyword of the open source license for this repository. * @example mit */ - readonly license_template?: string; + license_template?: string; /** * @description Whether to allow squash merges for pull requests. * @default true * @example true */ - readonly allow_squash_merge?: boolean; + allow_squash_merge?: boolean; /** * @description Whether to allow merge commits for pull requests. * @default true * @example true */ - readonly allow_merge_commit?: boolean; + allow_merge_commit?: boolean; /** * @description Whether to allow rebase merges for pull requests. * @default true * @example true */ - readonly allow_rebase_merge?: boolean; + allow_rebase_merge?: boolean; /** * @description Whether to allow Auto-merge to be used on pull requests. * @default false * @example false */ - readonly allow_auto_merge?: boolean; + allow_auto_merge?: boolean; /** * @description Whether to delete head branches when pull requests are merged * @default false * @example false */ - readonly delete_branch_on_merge?: boolean; + delete_branch_on_merge?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -121433,7 +128531,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -121442,7 +128540,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -121452,7 +128550,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -121461,1615 +128559,2341 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether downloads are enabled. * @default true * @example true */ - readonly has_downloads?: boolean; + has_downloads?: boolean; /** * @description Whether this repository acts as a template that can be used to generate new repositories. * @default false * @example true */ - readonly is_template?: boolean; + is_template?: boolean; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { /** @example https://api.github.com/repos/octocat/Hello-World */ - readonly Location?: string; - readonly [name: string]: unknown; + Location?: string; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["full-repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 400: components["responses"]["bad_request"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-invitations-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "repos/list-invitations-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository-invitation"][]; + "application/json": components["schemas"]["repository-invitation"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "repos/decline-invitation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/decline-invitation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "repos/accept-invitation-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/accept-invitation-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The unique identifier of the invitation. */ - readonly invitation_id: components["parameters"]["invitation-id"]; + invitation_id: components["parameters"]["invitation-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - readonly "users/list-social-accounts-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-social-accounts-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["social-account"][]; + "application/json": components["schemas"]["social-account"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/add-social-account-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/add-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Full URLs for the social media profiles to add. * @example [] */ - readonly account_urls: readonly string[]; + account_urls: string[]; }; }; }; - readonly responses: { + responses: { /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["social-account"][]; + "application/json": components["schemas"]["social-account"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/delete-social-account-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "users/delete-social-account-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { + requestBody: { + content: { + "application/json": { /** * @description Full URLs for the social media profiles to delete. * @example [] */ - readonly account_urls: readonly string[]; + account_urls: string[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "users/list-ssh-signing-keys-for-authenticated-user": { + 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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ssh-signing-key"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "users/create-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description A descriptive name for the new key. + * @example Personal MacBook Air + */ + title?: string; + /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ + key: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ssh-signing-key"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "users/get-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the SSH signing key. */ + ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ssh-signing-key"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-ssh-signing-key-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the SSH signing key. */ + ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "activity/list-repos-starred-by-authenticated-user": { + parameters: { + query?: { + /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ + sort?: components["parameters"]["sort-starred"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @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?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["repository"][]; + "application/vnd.github.v3.star+json": components["schemas"]["starred-repository"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/check-repo-is-starred-by-authenticated-user": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response if this repository is starred by you */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Not Found if this repository is not starred by you */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "activity/star-repo-for-authenticated-user": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "activity/unstar-repo-for-authenticated-user": { + 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"]; + }; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-ssh-signing-keys-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-watched-repos-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["ssh-signing-key"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "users/create-ssh-signing-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** - * @description A descriptive name for the new key. - * @example Personal MacBook Air - */ - readonly title?: string; - /** @description The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." */ - readonly key: string; - }; + "teams/list-for-authenticated-user": { + 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?: never; + cookie?: never; }; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 201: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["ssh-signing-key"]; + "application/json": components["schemas"]["team-full"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/get-ssh-signing-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the SSH signing key. */ - readonly ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + "users/get-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description account_id parameter */ + account_id: components["parameters"]["account-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["ssh-signing-key"]; + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/delete-ssh-signing-key-for-authenticated-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the SSH signing key. */ - readonly ssh_signing_key_id: components["parameters"]["ssh-signing-key-id"]; + "projects/create-draft-item-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; }; - readonly cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + responses: { /** @description Response */ - readonly 204: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; }; - content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-repos-starred-by-authenticated-user": { - readonly parameters: { - readonly query?: { - /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - readonly sort?: components["parameters"]["sort-starred"]; - /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + "users/list": { + parameters: { + query?: { + /** @description A user ID. Only return users with an ID greater than this ID. */ + since?: components["parameters"]["since-user"]; /** @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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + /** @example ; rel="next" */ + Link?: string; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["repository"][]; - readonly "application/vnd.github.v3.star+json": readonly components["schemas"]["starred-repository"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 304: components["responses"]["not_modified"]; }; }; - readonly "activity/check-repo-is-starred-by-authenticated-user": { - 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"]; + "projects/create-view-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { - /** @description Response if this repository is starred by you */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; }; - content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - /** @description Not Found if this repository is not starred by you */ - readonly 404: { + }; + responses: { + /** @description Response for creating a view in a user-owned project. */ + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["projects-v2-view"]; }; }; - }; - }; - readonly "activity/star-repo-for-authenticated-user": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; - content?: never; - }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; - }; - }; - readonly "activity/unstar-repo-for-authenticated-user": { - 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"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; + content: { + "application/json": components["schemas"]["basic-error"]; }; - content?: never; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "activity/list-watched-repos-for-authenticated-user": { - 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"]; + "users/get-by-username": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "teams/list-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "users/list-attestations-bulk": { + 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)." */ - 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"]; + per_page?: components["parameters"]["per-page"]; + /** @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"]; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["team-full"][]; + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; }; }; - readonly 304: components["responses"]["not_modified"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "users/get-by-id": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description account_id parameter */ - readonly account_id: components["parameters"]["account-id"]; + "users/delete-attestations-bulk": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list": { - readonly parameters: { - readonly query?: { - /** @description A user ID. Only return users with an ID greater than this ID. */ - readonly since?: components["parameters"]["since-user"]; - /** @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"]; + "users/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; }; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - /** @example ; rel="next" */ - readonly Link?: string; - readonly [name: string]: unknown; + [name: string]: unknown; }; - content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/get-by-username": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; + /** @description Attestation ID */ + attestation_id: number; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; - content: { - readonly "application/json": components["schemas"]["private-user"] | components["schemas"]["public-user"]; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - readonly 404: components["responses"]["not_found"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "users/list-attestations": { - readonly parameters: { - readonly query?: { + "users/list-attestations": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + per_page?: components["parameters"]["per-page"]; /** @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"]; + 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"]; + after?: components["parameters"]["pagination-after"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description Subject Digest */ - readonly subject_digest: string; + subject_digest: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": { - readonly attestations?: readonly { - readonly bundle?: components["schemas"]["sigstore-bundle-0"]; - readonly repository_id?: number; - readonly bundle_url?: string; + "application/json": { + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; }; /** @description Response */ - readonly 201: { + 201: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["empty-object"]; + "application/json": components["schemas"]["empty-object"]; }; }; /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/list-docker-migration-conflicting-packages-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/list-docker-migration-conflicting-packages-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-events-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-events-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "activity/list-org-events-for-authenticated-user": { - readonly parameters: { - readonly query?: { + "activity/list-org-events-for-authenticated-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description The organization name. The name is not case sensitive. */ - readonly org: components["parameters"]["org"]; + org: components["parameters"]["org"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "activity/list-public-events-for-user": { - readonly parameters: { - readonly query?: { + "activity/list-public-events-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "users/list-followers-for-user": { - readonly parameters: { - readonly query?: { + "users/list-followers-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "users/list-following-for-user": { - readonly parameters: { - readonly query?: { + "users/list-following-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - readonly "users/check-following-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "users/check-following-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; - readonly target_user: string; + username: components["parameters"]["username"]; + target_user: string; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description if the user follows the target user */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; /** @description if the user does not follow the target user */ - readonly 404: { + 404: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; }; }; - readonly "gists/list-for-user": { - readonly parameters: { - readonly query?: { + "gists/list-for-user": { + parameters: { + query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly since?: components["parameters"]["since"]; + since?: components["parameters"]["since"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["base-gist"][]; + "application/json": components["schemas"]["base-gist"][]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "users/list-gpg-keys-for-user": { - readonly parameters: { - readonly query?: { + "users/list-gpg-keys-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["gpg-key"][]; + "application/json": components["schemas"]["gpg-key"][]; }; }; }; }; - readonly "users/get-context-for-user": { - readonly parameters: { - readonly query?: { + "users/get-context-for-user": { + parameters: { + query?: { /** @description Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`. */ - readonly subject_type?: "organization" | "repository" | "issue" | "pull_request"; + subject_type?: "organization" | "repository" | "issue" | "pull_request"; /** @description Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`. */ - readonly subject_id?: string; + subject_id?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["hovercard"]; + "application/json": components["schemas"]["hovercard"]; }; }; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - readonly "apps/get-user-installation": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "apps/get-user-installation": { + parameters: { + query?: never; + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["installation"]; }; }; }; }; - readonly "users/list-public-keys-for-user": { - readonly parameters: { - readonly query?: { + "users/list-public-keys-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["key-simple"][]; + "application/json": components["schemas"]["key-simple"][]; }; }; }; }; - readonly "orgs/list-for-user": { - readonly parameters: { - readonly query?: { + "orgs/list-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["organization-simple"][]; + "application/json": components["schemas"]["organization-simple"][]; }; }; }; }; - readonly "packages/list-packages-for-user": { - readonly parameters: { - readonly query: { + "packages/list-packages-for-user": { + parameters: { + query: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; /** * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. * * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ - readonly visibility?: components["parameters"]["package-visibility"]; + visibility?: components["parameters"]["package-visibility"]; /** @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"]; + 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package"][]; + "application/json": components["schemas"]["package"][]; }; }; - readonly 400: components["responses"]["package_es_list_error"]; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "packages/get-package-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package"]; + "application/json": components["schemas"]["package"]; }; }; }; }; - readonly "packages/delete-package-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-for-user": { - readonly parameters: { - readonly query?: { + "packages/restore-package-for-user": { + parameters: { + query?: { /** @description package token */ - readonly token?: string; + token?: string; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-all-package-versions-for-package-owned-by-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-all-package-versions-for-package-owned-by-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["package-version"][]; + "application/json": components["schemas"]["package-version"][]; }; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/get-package-version-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/get-package-version-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["package-version"]; }; }; }; }; - readonly "packages/delete-package-version-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/delete-package-version-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "packages/restore-package-version-for-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "packages/restore-package-version-for-user": { + parameters: { + query?: never; + header?: never; + path: { /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - readonly package_type: components["parameters"]["package-type"]; + package_type: components["parameters"]["package-type"]; /** @description The name of the package. */ - readonly package_name: components["parameters"]["package-name"]; + package_name: components["parameters"]["package-name"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; /** @description Unique identifier of the package version. */ - readonly package_version_id: components["parameters"]["package-version-id"]; + package_version_id: components["parameters"]["package-version-id"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 204: { + 204: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content?: never; }; - readonly 401: components["responses"]["requires_authentication"]; - readonly 403: components["responses"]["forbidden"]; - readonly 404: components["responses"]["not_found"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "projects/list-for-user": { - readonly parameters: { - readonly query?: { - /** @description Indicates the state of the projects to return. */ - readonly state?: "open" | "closed" | "all"; + "projects/list-for-user": { + parameters: { + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"][]; + }; }; - readonly header?: never; - readonly path: { + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"]; }; }; - readonly 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-received-events-for-user": { - readonly parameters: { - readonly query?: { + "projects/list-fields-for-user": { + 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)." */ - 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"]; + per_page?: components["parameters"]["per-page"]; + /** @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"]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/add-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; }; - readonly header?: never; - readonly path: { + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "activity/list-received-public-events-for-user": { - readonly parameters: { - readonly query?: { + "projects/list-items-for-user": { + parameters: { + query?: { + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - readonly "repos/list-for-user": { - readonly parameters: { - readonly query?: { - /** @description Limit results to repositories of the specified type. */ - readonly type?: "all" | "owner" | "member"; - /** @description The property to sort the results by. */ - readonly sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - readonly direction?: "asc" | "desc"; + "projects/add-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-user-item": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-view-items-for-user": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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"]; + per_page?: components["parameters"]["per-page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - readonly "billing/get-github-actions-billing-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/list-received-events-for-user": { + 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 handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "billing/get-github-packages-billing-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "activity/list-received-public-events-for-user": { + 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 handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - readonly "billing/get-shared-storage-billing-user": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { + "repos/list-for-user": { + parameters: { + query?: { + /** @description Limit results to repositories of the specified type. */ + type?: "all" | "owner" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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 handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "users/list-social-accounts-for-user": { - readonly parameters: { - readonly query?: { + "billing/get-github-billing-premium-request-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "users/list-social-accounts-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["social-account"][]; + "application/json": components["schemas"]["social-account"][]; }; }; }; }; - readonly "users/list-ssh-signing-keys-for-user": { - readonly parameters: { - readonly query?: { + "users/list-ssh-signing-keys-for-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["ssh-signing-key"][]; + "application/json": components["schemas"]["ssh-signing-key"][]; }; }; }; }; - readonly "activity/list-repos-starred-by-user": { - readonly parameters: { - readonly query?: { + "activity/list-repos-starred-by-user": { + parameters: { + query?: { /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ - readonly sort?: components["parameters"]["sort-starred"]; + sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ - readonly direction?: components["parameters"]["direction"]; + direction?: components["parameters"]["direction"]; /** @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"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["starred-repository"][] | readonly components["schemas"]["repository"][]; + "application/json": components["schemas"]["starred-repository"][] | components["schemas"]["repository"][]; }; }; }; }; - readonly "activity/list-repos-watched-by-user": { - readonly parameters: { - readonly query?: { + "activity/list-repos-watched-by-user": { + 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)." */ - readonly per_page?: components["parameters"]["per-page"]; + 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"]; + page?: components["parameters"]["page"]; }; - readonly header?: never; - readonly path: { + header?: never; + path: { /** @description The handle for the GitHub user account. */ - readonly username: components["parameters"]["username"]; + username: components["parameters"]["username"]; }; - readonly cookie?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly Link: components["headers"]["link"]; - readonly [name: string]: unknown; + Link: components["headers"]["link"]; + [name: string]: unknown; }; content: { - readonly "application/json": readonly components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; - readonly "meta/get-all-versions": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/get-all-versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": readonly string[]; + "application/json": string[]; }; }; - readonly 404: components["responses"]["not_found"]; + 404: components["responses"]["not_found"]; }; }; - readonly "meta/get-zen": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; + "meta/get-zen": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; }; - readonly requestBody?: never; - readonly responses: { + requestBody?: never; + responses: { /** @description Response */ - readonly 200: { + 200: { headers: { - readonly [name: string]: unknown; + [name: string]: unknown; }; content: { - readonly "application/json": string; + "text/plain": string; }; }; }; diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index 2d47a1d10..d7d5f7f91 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -262,7 +262,7 @@ export interface paths { post?: never; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -308,7 +308,7 @@ export interface paths { get?: never; /** * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * @description Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -580,6 +580,38 @@ export interface paths { patch?: never; trace?: never; }; + "/credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Revoke a list of credentials + * @description Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + * + * This endpoint currently accepts the following credential types: + * - Personal access tokens (classic) + * - Fine-grained personal access tokens + * + * Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + * GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + * + * To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + * + * > [!NOTE] + * > Any authenticated requests will return a 403. + */ + post: operations["credentials/revoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/emojis": { parameters: { query?: never; @@ -600,6 +632,66 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an enterprise + * @description Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-enterprise"]; + /** + * Set GitHub Actions cache retention limit for an enterprise + * @description Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an enterprise + * @description Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-enterprise"]; + /** + * Set GitHub Actions cache storage limit for an enterprise + * @description Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; @@ -800,7 +892,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/teams": { parameters: { query?: never; header?: never; @@ -808,16 +900,34 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * List enterprise teams + * @description List all teams in the enterprise for the authenticated user */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["enterprise-teams/list"]; + put?: never; + /** + * Create an enterprise team + * @description To create an enterprise team, the authenticated user must be an owner of the enterprise. + */ + post: operations["enterprise-teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members in an enterprise team + * @description Lists all team members in an enterprise team. + */ + get: operations["enterprise-team-memberships/list"]; put?: never; post?: never; delete?: never; @@ -826,6 +936,192 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk add team members + * @description Add multiple team members to an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk remove team members + * @description Remove multiple team members from an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get enterprise team membership + * @description Returns whether the user is a member of the enterprise team. + */ + get: operations["enterprise-team-memberships/get"]; + /** + * Add team member + * @description Add a team member to an enterprise team. + */ + put: operations["enterprise-team-memberships/add"]; + post?: never; + /** + * Remove team membership + * @description Remove membership of a specific user from a particular team in an enterprise. + */ + delete: operations["enterprise-team-memberships/remove"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignments + * @description Get all organizations assigned to an enterprise team + */ + get: operations["enterprise-team-organizations/get-assignments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add organization assignments + * @description Assign an enterprise team to multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Remove organization assignments + * @description Unassign an enterprise team from multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignment + * @description Check if an enterprise team is assigned to an organization + */ + get: operations["enterprise-team-organizations/get-assignment"]; + /** + * Add an organization assignment + * @description Assign an enterprise team to an organization. + */ + put: operations["enterprise-team-organizations/add"]; + post?: never; + /** + * Delete an organization assignment + * @description Unassign an enterprise team from an organization. + */ + delete: operations["enterprise-team-organizations/delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an enterprise team + * @description Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. + */ + get: operations["enterprise-teams/get"]; + put?: never; + post?: never; + /** + * Delete an enterprise team + * @description To delete an enterprise team, the authenticated user must be an enterprise owner. + * + * If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + */ + delete: operations["enterprise-teams/delete"]; + options?: never; + head?: never; + /** + * Update an enterprise team + * @description To edit a team, the authenticated user must be an enterprise owner. + */ + patch: operations["enterprise-teams/update"]; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -1306,7 +1602,10 @@ export interface paths { }; get?: never; put?: never; - /** Render a Markdown document */ + /** + * Render a Markdown document + * @description Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + */ post: operations["markdown/render"]; delete?: never; options?: never; @@ -1643,6 +1942,213 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an organization + * @description Gets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-organization"]; + /** + * Set GitHub Actions cache retention limit for an organization + * @description Sets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an organization + * @description Gets GitHub Actions cache storage limit for an organization. All repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-organization"]; + /** + * Set GitHub Actions cache storage limit for an organization + * @description Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists the repositories Dependabot can access in an organization + * @description Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + */ + get: operations["dependabot/repository-access-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Updates Dependabot's repository access list for an organization + * @description Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + * + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + * + * **Example request body:** + * ```json + * { + * "repository_ids_to_add": [123, 456], + * "repository_ids_to_remove": [789] + * } + * ``` + */ + patch: operations["dependabot/update-repository-access-for-org"]; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access/default-level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set the default repository access level for Dependabot + * @description Sets the default level of repository access Dependabot will have while performing an update. Available values are: + * - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + * - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + * + * Unauthorized users will not see the existence of this endpoint. + * + * This operation supports both server-to-server and user-to-server access. + */ + put: operations["dependabot/set-repository-access-default-level"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all budgets for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-all-budgets-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a budget by ID for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-budget-org"]; + put?: never; + post?: never; + /** + * Delete a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + */ + delete: operations["billing/delete-budget-org"]; + options?: never; + head?: never; + /** + * Update a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + */ + patch: operations["billing/update-budget-org"]; + trace?: never; + }; + "/organizations/{org}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for an organization + * @description Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/organizations/{org}/settings/billing/usage": { parameters: { query?: never; @@ -1665,6 +2171,31 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-usage-summary-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -1676,7 +2207,7 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * @@ -1790,6 +2321,106 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners/images/custom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List custom images for an organization + * @description List custom images for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a custom image definition for GitHub Actions Hosted Runners + * @description Get a custom image definition for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-for-org"]; + put?: never; + post?: never; + /** + * Delete a custom image from the organization + * @description Delete a custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List image versions of a custom image for an organization + * @description List image versions of a custom image for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-image-versions-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an image version of a custom image for GitHub Actions Hosted Runners + * @description Get an image version of a custom image for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-version-for-org"]; + put?: never; + post?: never; + /** + * Delete an image version of custom image from the organization + * @description Delete an image version of custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-version-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/hosted-runners/images/github-owned": { parameters: { query?: never; @@ -1977,6 +2608,86 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for an organization + * @description Gets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-organization"]; + /** + * Set artifact and log retention settings for an organization + * @description Sets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for an organization + * @description Gets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-organization"]; + /** + * Set fork PR contributor approval permissions for an organization + * @description Sets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for an organization + * @description Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-organization"]; + /** + * Set private repo fork PR workflow settings for an organization + * @description Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/repositories": { parameters: { query?: never; @@ -2062,6 +2773,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/self-hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get self-hosted runners settings for an organization + * @description Gets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-self-hosted-runners-permissions-organization"]; + /** + * Set self-hosted runners settings for an organization + * @description Sets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repositories allowed to use self-hosted runners in an organization + * @description Lists repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/list-selected-repositories-self-hosted-runners-organization"]; + /** + * Set repositories allowed to use self-hosted runners in an organization + * @description Sets repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-selected-repositories-self-hosted-runners-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a repository to the list of repositories allowed to use self-hosted runners in an organization + * @description Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/enable-selected-repository-self-hosted-runners-organization"]; + post?: never; + /** + * Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + * @description Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + delete: operations["actions/disable-selected-repository-self-hosted-runners-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/workflow": { parameters: { query?: never; @@ -2836,6 +3631,230 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/artifacts/metadata/deployment-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an artifact deployment record + * @description Create or update deployment records for an artifact associated + * with an organization. + * This endpoint allows you to record information about a specific + * artifact, such as its name, digest, environments, cluster, and + * deployment. + * The deployment name has to be uniqe within a cluster (i.e a + * combination of logical, physical environment and cluster) as it + * identifies unique deployment. + * Multiple requests for the same combination of logical, physical + * environment, cluster and deployment name will only create one + * record, successive request will update the existing record. + * This allows for a stable tracking of a deployment where the actual + * deployed artifact can change over time. + */ + post: operations["orgs/create-artifact-deployment-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Set cluster deployment records + * @description Set deployment records for a given cluster. + * If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + * 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + * If no existing records match, new records will be created. + */ + post: operations["orgs/set-cluster-deployment-records"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/storage-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create artifact metadata storage record + * @description Create metadata storage records for artifacts associated with an organization. + * This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + * associated with a repository owned by the organization. + */ + post: operations["orgs/create-artifact-storage-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact deployment records + * @description List deployment records for an artifact metadata associated with an organization. + */ + get: operations["orgs/list-artifact-deployment-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact storage records + * @description List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + */ + get: operations["orgs/list-artifact-storage-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["orgs/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["orgs/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["orgs/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestation repositories + * @description List repositories owned by the provided organization that have created at least one attested artifact + * Results will be sorted in ascending order by repository ID + */ + get: operations["orgs/list-attestation-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + */ + delete: operations["orgs/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/attestations/{subject_digest}": { parameters: { query?: never; @@ -2908,6 +3927,81 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/campaigns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List campaigns for an organization + * @description Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/list-org-campaigns"]; + put?: never; + /** + * Create a campaign for an organization + * @description Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + post: operations["campaigns/create-campaign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns/{campaign_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a campaign for an organization + * @description Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/get-campaign-summary"]; + put?: never; + post?: never; + /** + * Delete a campaign for an organization + * @description Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + delete: operations["campaigns/delete-campaign"]; + options?: never; + head?: never; + /** + * Update a campaign + * @description Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + patch: operations["campaigns/update-campaign"]; + trace?: never; + }; "/orgs/{org}/code-scanning/alerts": { parameters: { query?: never; @@ -2945,7 +4039,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-configurations-for-org"]; put?: never; @@ -2977,7 +4071,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-default-configurations"]; put?: never; @@ -3120,7 +4214,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-repositories-for-configuration"]; put?: never; @@ -3395,7 +4489,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ @@ -3502,7 +4596,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot/content_exclusion": { parameters: { query?: never; header?: never; @@ -3510,23 +4604,41 @@ export interface paths { 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. + * Get Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * > [!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. + * Gets information about an organization's Copilot content exclusion path rules. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." * - * 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. + * Organization owners can view details about Copilot content exclusion rules for the organization. * - * 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 `copilot` or `read:org` scopes to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + * > [!CAUTION] + * > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + * > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. */ - get: operations["copilot/copilot-metrics-for-organization"]; - put?: never; + get: operations["copilot/copilot-content-exclusion-for-organization"]; + /** + * Set Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Sets Copilot content exclusion path rules for an organization. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + * + * Organization owners can set Copilot content exclusion rules for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + * + * > [!CAUTION] + * > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + * > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + */ + put: operations["copilot/set-copilot-content-exclusion-for-organization"]; post?: never; delete?: never; options?: never; @@ -3534,7 +4646,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/usage": { + "/orgs/{org}/copilot/metrics": { parameters: { query?: never; header?: never; @@ -3542,23 +4654,22 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for organization members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * 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. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * > [!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. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 100 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. * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + * 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/usage-metrics-for-org"]; + get: operations["copilot/copilot-metrics-for-organization"]; put?: never; post?: never; delete?: never; @@ -4342,6 +5453,69 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/issue-types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + */ + get: operations["orgs/list-issue-types"]; + put?: never; + /** + * Create issue type for an organization + * @description Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-issue-type"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update issue type for an organization + * @description Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/update-issue-type"]; + post?: never; + /** + * Delete issue type for an organization + * @description Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-issue-type"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/issues": { parameters: { query?: never; @@ -4409,6 +5583,9 @@ export interface paths { /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-member"]; options?: never; @@ -4497,7 +5674,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4543,6 +5720,9 @@ export interface paths { * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-membership-for-user"]; options?: never; @@ -5238,10 +6418,7 @@ export interface paths { }; /** * List private registries for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Lists all private registry configurations available at the organization-level without revealing their encrypted + * @description Lists all private registry configurations available at the organization-level without revealing their encrypted * values. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -5250,10 +6427,7 @@ export interface paths { put?: never; /** * Create a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5273,10 +6447,7 @@ export interface paths { }; /** * Get private registries public key for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * @description Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5298,10 +6469,7 @@ export interface paths { }; /** * Get a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * @description Get the configuration of a single private registry defined for an organization, omitting its encrypted value. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5310,10 +6478,7 @@ export interface paths { post?: never; /** * Delete a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Delete a private registry configuration at the organization-level. + * @description Delete a private registry configuration at the organization-level. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5322,17 +6487,14 @@ export interface paths { head?: never; /** * Update a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["private-registries/update-org-private-registry"]; trace?: never; }; - "/orgs/{org}/projects": { + "/orgs/{org}/projectsV2": { parameters: { query?: never; header?: never; @@ -5340,16 +6502,188 @@ export interface paths { cookie?: never; }; /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * List projects for organization + * @description List all projects owned by a specific organization accessible by the authenticated user. */ get: operations["projects/list-for-org"]; put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * Get project for organization + * @description Get a specific organization-owned project. */ - post: operations["projects/create-for-org"]; + get: operations["projects/get-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for organization owned project + * @description Create draft issue item for the specified organization owned project. + */ + post: operations["projects/create-draft-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for organization + * @description List all fields for a specific organization-owned project. + */ + get: operations["projects/list-fields-for-org"]; + put?: never; + /** + * Add a field to an organization-owned project. + * @description Add a field to an organization-owned project. + */ + post: operations["projects/add-field-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for organization + * @description Get a specific field for an organization-owned project. + */ + get: operations["projects/get-field-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization owned project + * @description List all items for a specific organization-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-org"]; + put?: never; + /** + * Add item to organization owned project + * @description Add an issue or pull request item to the specified organization owned project. + */ + post: operations["projects/add-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for an organization owned project + * @description Get a specific item from an organization-owned project. + */ + get: operations["projects/get-org-item"]; + put?: never; + post?: never; + /** + * Delete project item for organization + * @description Delete a specific item from an organization-owned project. + */ + delete: operations["projects/delete-item-for-org"]; + options?: never; + head?: never; + /** + * Update project item for organization + * @description Update a specific item in an organization-owned project. + */ + patch: operations["projects/update-item-for-org"]; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for an organization-owned project + * @description Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization project view + * @description List items in an organization project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-org"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; @@ -5368,7 +6702,7 @@ export interface paths { * @description Gets all custom properties defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-all-custom-properties"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definitions"]; put?: never; post?: never; delete?: never; @@ -5378,11 +6712,15 @@ export interface paths { * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-definitions"]; trace?: never; }; "/orgs/{org}/properties/schema/{custom_property_name}": { @@ -5397,7 +6735,7 @@ export interface paths { * @description Gets a custom property that is defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-custom-property"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definition"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. @@ -5406,7 +6744,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - put: operations["orgs/create-or-update-custom-property"]; + put: operations["orgs/custom-properties-for-repos-create-or-update-organization-definition"]; post?: never; /** * Remove a custom property for an organization @@ -5416,7 +6754,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - delete: operations["orgs/remove-custom-property"]; + delete: operations["orgs/custom-properties-for-repos-delete-organization-definition"]; options?: never; head?: never; patch?: never; @@ -5434,7 +6772,7 @@ export interface paths { * @description Lists organization repositories with all of their custom property values. * Organization members can read these properties. */ - get: operations["orgs/list-custom-properties-values-for-repos"]; + get: operations["orgs/custom-properties-for-repos-get-organization-values"]; put?: never; post?: never; delete?: never; @@ -5453,7 +6791,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-values"]; trace?: never; }; "/orgs/{org}/public_members": { @@ -5632,6 +6970,46 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset history + * @description Get the history of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset version + * @description Get a version of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/secret-scanning/alerts": { parameters: { query?: never; @@ -5656,6 +7034,34 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/secret-scanning/pattern-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization pattern configurations + * @description Lists the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `read:org` scope to use this endpoint. + */ + get: operations["secret-scanning/list-org-pattern-configs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update organization pattern configurations + * @description Updates the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["secret-scanning/update-org-pattern-configs"]; + trace?: never; + }; "/orgs/{org}/security-advisories": { parameters: { query?: never; @@ -5730,7 +7136,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/actions": { + "/orgs/{org}/settings/immutable-releases": { parameters: { query?: never; header?: never; @@ -5738,15 +7144,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get immutable releases settings for an organization + * @description Gets the immutable releases policy for repositories in an organization. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings"]; + /** + * Set immutable releases settings for an organization + * @description Sets the immutable releases policy for repositories in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-actions-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings"]; post?: never; delete?: never; options?: never; @@ -5754,7 +7164,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/packages": { + "/orgs/{org}/settings/immutable-releases/repositories": { parameters: { query?: never; header?: never; @@ -5762,15 +7172,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * List selected repositories for immutable releases enforcement + * @description List all of the repositories that have been selected for immutable releases enforcement in an organization. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings-repositories"]; + /** + * Set selected repositories for immutable releases enforcement + * @description Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-packages-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings-repositories"]; post?: never; delete?: never; options?: never; @@ -5778,25 +7192,29 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/shared-storage": { + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Enable a selected repository for immutable releases in an organization + * @description Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-shared-storage-billing-org"]; - put?: never; + put: operations["orgs/enable-selected-repository-immutable-releases-organization"]; post?: never; - delete?: never; + /** + * Disable a selected repository for immutable releases in an organization + * @description Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/disable-selected-repository-immutable-releases-organization"]; options?: never; head?: never; patch?: never; @@ -5900,7 +7318,7 @@ export interface paths { * > [!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, + * The response contains metrics for up to 100 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. * @@ -5918,42 +7336,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/team/{team_slug}/copilot/usage": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a summary of Copilot usage for a team - * @description > [!NOTE] - * > 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. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - get: operations["copilot/usage-metrics-for-team"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -6019,286 +7401,6 @@ export interface paths { patch: operations["teams/update-in-org"]; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-in-org"]; - put?: never; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-in-org"]; - put?: never; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; - put?: never; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion comment reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-in-org"]; - put?: never; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/invitations": { parameters: { query?: never; @@ -6402,66 +7504,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ - get: operations["teams/list-projects-in-org"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - get: operations["teams/check-permissions-for-project-in-org"]; - /** - * Add or update team project permissions - * @description 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. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - put: operations["teams/add-or-update-project-permissions-in-org"]; - post?: never; - /** - * Remove a project from a team - * @description 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. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - delete: operations["teams/remove-project-in-org"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/repos": { parameters: { query?: never; @@ -6581,227 +7623,6 @@ export interface paths { patch?: never; trace?: never; }; - "/projects/columns/cards/{card_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project card - * @description Gets information about a project card. - */ - get: operations["projects/get-card"]; - put?: never; - post?: never; - /** - * Delete a project card - * @description Deletes a project card - */ - delete: operations["projects/delete-card"]; - options?: never; - head?: never; - /** Update an existing project card */ - patch: operations["projects/update-card"]; - trace?: never; - }; - "/projects/columns/cards/{card_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project card */ - post: operations["projects/move-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project column - * @description Gets information about a project column. - */ - get: operations["projects/get-column"]; - put?: never; - post?: never; - /** - * Delete a project column - * @description Deletes a project column. - */ - delete: operations["projects/delete-column"]; - options?: never; - head?: never; - /** Update an existing project column */ - patch: operations["projects/update-column"]; - trace?: never; - }; - "/projects/columns/{column_id}/cards": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project cards - * @description Lists the project cards in a project. - */ - get: operations["projects/list-cards"]; - put?: never; - /** Create a project card */ - post: operations["projects/create-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project column */ - post: operations["projects/move-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/get"]; - put?: never; - post?: never; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - delete: operations["projects/delete"]; - options?: never; - head?: never; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - patch: operations["projects/update"]; - trace?: never; - }; - "/projects/{project_id}/collaborators": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - get: operations["projects/list-collaborators"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - put: operations["projects/add-collaborator"]; - post?: never; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - delete: operations["projects/remove-collaborator"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}/permission": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - get: operations["projects/get-permission-for-user"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/columns": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project columns - * @description Lists the project columns in a project. - */ - get: operations["projects/list-columns"]; - put?: never; - /** - * Create a project column - * @description Creates a new project column. - */ - post: operations["projects/create-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/rate_limit": { parameters: { query?: never; @@ -6821,6 +7642,7 @@ export interface paths { * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -6849,7 +7671,8 @@ export interface paths { * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * * > [!NOTE] - * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. */ get: operations["repos/get"]; put?: never; @@ -6949,6 +7772,66 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for a repository + * @description Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-repository"]; + /** + * Set GitHub Actions cache retention limit for a repository + * @description Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for a repository + * @description Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-repository"]; + /** + * Set GitHub Actions cache storage limit for a repository + * @description Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/cache/usage": { parameters: { query?: never; @@ -7232,6 +8115,90 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for a repository + * @description Gets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-repository"]; + /** + * Set artifact and log retention settings for a repository + * @description Sets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for a repository + * @description Gets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-repository"]; + /** + * Set fork PR contributor approval permissions for a repository + * @description Sets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for a repository + * @description Gets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-repository"]; + /** + * Set private repo fork PR workflow settings for a repository + * @description Sets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { parameters: { query?: never; @@ -7945,7 +8912,10 @@ export interface paths { }; /** * Get workflow run usage - * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. * @@ -8275,7 +9245,10 @@ export interface paths { }; /** * Get workflow usage - * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -9007,11 +9980,9 @@ export interface paths { put?: never; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; delete?: never; @@ -9128,8 +10099,6 @@ export interface paths { /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; delete?: never; @@ -9236,7 +10205,7 @@ export interface paths { * Commit an autofix for a code scanning alert * @description Commits an autofix for a code scanning alert. * - * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -9865,7 +10834,7 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ put: operations["codespaces/create-or-update-repo-secret"]; post?: never; @@ -9873,7 +10842,7 @@ export interface paths { * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -9891,12 +10860,12 @@ export interface paths { /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. * * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. - * + * The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; @@ -9928,11 +10897,13 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} @@ -9942,6 +10913,8 @@ export interface paths { * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * + * For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + * * **Updating an existing collaborator's permission level** * * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -9959,8 +10932,8 @@ export interface paths { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -9992,13 +10965,15 @@ export interface paths { }; /** * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * @description Checks the repository permission and role of a collaborator. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + * The `role_name` attribute provides the name of the assigned role, including custom roles. The + * `permission` can also be used to determine which base level of access the collaborator has to the repository. + * + * The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. */ get: operations["repos/get-collaborator-permission-level"]; put?: never; @@ -10241,7 +11216,7 @@ export interface paths { }; /** * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ @@ -11121,7 +12096,7 @@ export interface paths { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -11976,6 +12951,35 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Check if immutable releases are enabled for a repository + * @description Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + * enforced by the repository owner. The authenticated user must have admin read access to the repository. + */ + get: operations["repos/check-immutable-releases"]; + /** + * Enable immutable releases + * @description Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + put: operations["repos/enable-immutable-releases"]; + post?: never; + /** + * Disable immutable releases + * @description Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + delete: operations["repos/disable-immutable-releases"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/import": { parameters: { query?: never; @@ -12370,6 +13374,37 @@ export interface paths { patch: operations["issues/update-comment"]; trace?: never; }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Pin an issue comment + * @description You can use the REST API to pin comments on issues. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + put: operations["issues/pin-comment"]; + post?: never; + /** + * Unpin an issue comment + * @description You can use the REST API to unpin comments on issues. + */ + delete: operations["issues/unpin-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { parameters: { query?: never; @@ -12596,6 +13631,105 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocked by + * @description You can use the REST API to list the dependencies an issue is blocked by. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocked-by"]; + put?: never; + /** + * Add a dependency an issue is blocked by + * @description You can use the REST API to add a 'blocked by' relationship to an issue. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-blocked-by-dependency"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove dependency an issue is blocked by + * @description You can use the REST API to remove a dependency that an issue is blocked by. + * + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-dependency-blocked-by"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocking + * @description You can use the REST API to list the dependencies an issue is blocking. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocking"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { parameters: { query?: never; @@ -12635,7 +13769,7 @@ export interface paths { put: operations["issues/set-labels"]; /** * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. + * @description Adds labels to an issue. */ post: operations["issues/add-labels"]; /** @@ -12694,6 +13828,33 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get parent issue + * @description You can use the REST API to get the parent issue of a sub-issue. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/get-parent"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { parameters: { query?: never; @@ -12780,11 +13941,11 @@ export interface paths { * List sub-issues * @description You can use the REST API to list the sub-issues on an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-sub-issues"]; @@ -13358,30 +14519,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/list-for-repo"]; - put?: never; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-repo"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/properties/values": { parameters: { query?: never; @@ -13394,7 +14531,7 @@ export interface paths { * @description Gets all custom property values that are set for a repository. * Users with read access to the repository can use this endpoint. */ - get: operations["repos/get-custom-properties-values"]; + get: operations["repos/custom-properties-for-repos-get-repository-values"]; put?: never; post?: never; delete?: never; @@ -13407,7 +14544,7 @@ export interface paths { * * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ - patch: operations["repos/create-or-update-custom-properties-values"]; + patch: operations["repos/custom-properties-for-repos-create-or-update-repository-values"]; trace?: never; }; "/repos/{owner}/{repo}/pulls": { @@ -14450,6 +15587,46 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset history + * @description Get the history of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset version + * @description Get a version of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/secret-scanning/alerts": { parameters: { query?: never; @@ -14499,6 +15676,8 @@ export interface paths { * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * + * You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + * * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -14565,6 +15744,9 @@ export interface paths { * Get secret scanning scan history for a repository * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * + * > [!NOTE] + * > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-scan-history"]; @@ -14946,66 +16128,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/tags/protection": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Closing down - List tag protection states for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - * - * This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ - get: operations["repos/list-tag-protection"]; - put?: never; - /** - * Closing down - Create a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - * - * This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - post: operations["repos/create-tag-protection"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Closing down - Delete a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - * - * This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - delete: operations["repos/delete-tag-protection"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/tarball/{ref}": { parameters: { query?: never; @@ -15529,250 +16651,6 @@ export interface paths { patch: operations["teams/update-legacy"]; trace?: never; }; - "/teams/{team_id}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-legacy"]; - put?: never; - /** - * Create a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-legacy"]; - put?: never; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; - put?: never; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-legacy"]; - put?: never; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/invitations": { parameters: { query?: never; @@ -15937,70 +16815,6 @@ export interface paths { patch?: never; trace?: never; }; - "/teams/{team_id}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ - get: operations["teams/list-projects-legacy"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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. - */ - get: operations["teams/check-permissions-for-project-legacy"]; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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. - */ - put: operations["teams/add-or-update-project-permissions-legacy"]; - post?: never; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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. - */ - delete: operations["teams/remove-project-legacy"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/repos": { parameters: { query?: never; @@ -16869,7 +17683,7 @@ export interface paths { * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; delete?: never; @@ -17304,26 +18118,6 @@ export interface paths { patch?: never; trace?: never; }; - "/user/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-authenticated-user"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/user/public_emails": { parameters: { query?: never; @@ -17625,6 +18419,26 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{user_id}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for user owned project + * @description Create draft issue item for the specified user owned project. + */ + post: operations["projects/create-draft-item-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -17647,6 +18461,26 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{user_id}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for a user-owned project + * @description Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}": { parameters: { query?: never; @@ -17673,6 +18507,90 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["users/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["users/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["users/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + */ + delete: operations["users/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/attestations/{subject_digest}": { parameters: { query?: never; @@ -18131,7 +19049,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/projects": { + "/users/{username}/projectsV2": { parameters: { query?: never; header?: never; @@ -18139,8 +19057,8 @@ export interface paths { cookie?: never; }; /** - * List user projects - * @description Lists projects for a user. + * List projects for user + * @description List all projects owned by a specific user accessible by the authenticated user. */ get: operations["projects/list-for-user"]; put?: never; @@ -18151,6 +19069,142 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for user + * @description Get a specific user-owned project. + */ + get: operations["projects/get-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for user + * @description List all fields for a specific user-owned project. + */ + get: operations["projects/list-fields-for-user"]; + put?: never; + /** + * Add field to user owned project + * @description Add a field to a specified user owned project. + */ + post: operations["projects/add-field-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for user + * @description Get a specific field for a user-owned project. + */ + get: operations["projects/get-field-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user owned project + * @description List all items for a specific user-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-user"]; + put?: never; + /** + * Add item to user owned project + * @description Add an issue or pull request item to the specified user owned project. + */ + post: operations["projects/add-item-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for a user owned project + * @description Get a specific item from a user-owned project. + */ + get: operations["projects/get-user-item"]; + put?: never; + post?: never; + /** + * Delete project item for user + * @description Delete a specific item from a user-owned project. + */ + delete: operations["projects/delete-item-for-user"]; + options?: never; + head?: never; + /** + * Update project item for user + * @description Update a specific item in a user-owned project. + */ + patch: operations["projects/update-item-for-user"]; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user project view + * @description List items in a user project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/received_events": { parameters: { query?: never; @@ -18216,7 +19270,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/actions": { + "/users/{username}/settings/billing/premium_request/usage": { parameters: { query?: never; header?: never; @@ -18224,14 +19278,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get billing premium request usage report for a user + * @description Gets a report of premium request usage for a user. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-github-actions-billing-user"]; + get: operations["billing/get-github-billing-premium-request-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18240,7 +19292,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/packages": { + "/users/{username}/settings/billing/usage": { parameters: { query?: never; header?: never; @@ -18248,14 +19300,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. - * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Get billing usage report for a user + * @description Gets a report of the total usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** This endpoint is only available to users with access to the enhanced billing platform. */ - get: operations["billing/get-github-packages-billing-user"]; + get: operations["billing/get-github-billing-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18264,7 +19314,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/shared-storage": { + "/users/{username}/settings/billing/usage/summary": { parameters: { query?: never; header?: never; @@ -18272,14 +19322,15 @@ export interface paths { cookie?: never; }; /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Get billing usage summary for a user + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Gets a summary report of usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-shared-storage-billing-user"]; + get: operations["billing/get-github-billing-usage-summary-report-user"]; put?: never; post?: never; delete?: never; @@ -18863,6 +19914,28 @@ export interface webhooks { patch?: never; trace?: never; }; + "code-scanning-alert-updated-assignment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + * @description The assignees list of a code scanning alert has been updated. + */ + post: operations["code-scanning-alert/updated-assignment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "commit-comment-created": { parameters: { query?: never; @@ -18960,6 +20033,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "custom-property-promoted-to-enterprise": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a custom property. + * + * For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + * @description A custom property was promoted to an enterprise. + */ + post: operations["custom-property/promote-to-enterprise"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "custom-property-updated": { parameters: { query?: never; @@ -19033,7 +20130,7 @@ export interface webhooks { patch?: never; trace?: never; }; - "dependabot-alert-auto-dismissed": { + "dependabot-alert-assignees-changed": { parameters: { query?: never; header?: never; @@ -19048,9 +20145,30 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + * @description The assignees for a Dependabot alert were updated. + */ + post: operations["dependabot-alert/assignees-changed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "dependabot-alert-auto-dismissed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to Dependabot alerts. * - * > [!NOTE] - * > Webhook events for Dependabot alerts are currently in public preview and subject to change. + * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * @description A Dependabot alert was automatically closed by a Dependabot auto-triage rule. */ post: operations["dependabot-alert/auto-dismissed"]; @@ -19075,9 +20193,6 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * 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 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"]; @@ -19102,9 +20217,6 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * 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 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"]; @@ -19129,9 +20241,6 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * 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 public preview and subject to change. * @description A Dependabot alert was manually closed. */ post: operations["dependabot-alert/dismissed"]; @@ -19156,9 +20265,6 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * 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 public preview and subject to change. * @description A manifest file change removed a vulnerability. */ post: operations["dependabot-alert/fixed"]; @@ -19183,9 +20289,6 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * 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 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"]; @@ -19210,9 +20313,6 @@ export interface webhooks { * For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. * * 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 public preview and subject to change. * @description A Dependabot alert was manually reopened. */ post: operations["dependabot-alert/reopened"]; @@ -20209,6 +21309,150 @@ export interface webhooks { patch?: never; trace?: never; }; + "issue-comment-pinned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + * + * For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + * @description A comment on an issue was pinned. + */ + post: operations["issue-comment/pinned"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "issue-comment-unpinned": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. + * + * For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + * @description A comment on an issue was unpinned. + */ + post: operations["issue-comment/unpinned"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "issue-dependencies-blocked-by-added": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + * + * 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 An issue was marked as blocked by another issue. + */ + post: operations["issue-dependencies/blocked-by-added"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "issue-dependencies-blocked-by-removed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + * + * 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 The blocked by relationship between an issue and another issue was removed. + */ + post: operations["issue-dependencies/blocked-by-removed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "issue-dependencies-blocking-added": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + * + * 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 An issue was marked as blocking another issue. + */ + post: operations["issue-dependencies/blocking-added"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "issue-dependencies-blocking-removed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. + * + * 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 The blocking relationship between an issue and another issue was removed. + */ + post: operations["issue-dependencies/blocking-removed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "issues-assigned": { parameters: { query?: never; @@ -20497,6 +21741,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "issues-typed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + * + * For activity relating to a comment on an issue, use the `issue_comment` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + * @description An issue type was added to an issue. + */ + post: operations["issues/typed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "issues-unassigned": { parameters: { query?: never; @@ -20593,6 +21861,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "issues-untyped": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + * + * For activity relating to a comment on an issue, use the `issue_comment` event. + * + * To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + * @description An issue type was removed from an issue. + */ + post: operations["issues/untyped"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "label-created": { parameters: { query?: never; @@ -21244,8 +22536,6 @@ export interface webhooks { put?: never; /** * This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - * - * To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. * @description A package was published to a registry. */ post: operations["package/published"]; @@ -21266,8 +22556,6 @@ export interface webhooks { put?: never; /** * This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. - * - * To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. * @description A previously published package was updated. */ post: operations["package/updated"]; @@ -21311,9 +22599,6 @@ export interface webhooks { * This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." * * 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 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"]; @@ -21336,9 +22621,6 @@ export interface webhooks { * This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." * * 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 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"]; @@ -21361,9 +22643,6 @@ export interface webhooks { * This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." * * 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 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"]; @@ -21386,9 +22665,6 @@ export interface webhooks { * This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." * * 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 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"]; @@ -23575,6 +24851,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "secret-scanning-alert-assigned": { + 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 assigned. + */ + post: operations["secret-scanning-alert/assigned"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "secret-scanning-alert-created": { parameters: { query?: never; @@ -23697,6 +24997,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "secret-scanning-alert-unassigned": { + 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 unassigned. + */ + post: operations["secret-scanning-alert/unassigned"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "secret-scanning-alert-validated": { parameters: { query?: never; @@ -24899,22 +26223,16 @@ export interface components { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example label * @example deployment */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * Format: uri @@ -24949,6 +26267,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -24995,11 +26314,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -25171,6 +26492,16 @@ export interface components { * @enum {string} */ administration?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create and retrieve build artifact metadata records. + * @enum {string} + */ + artifact_metadata?: "read" | "write"; + /** + * @description The level of permission to create and retrieve the access token for repository attestations. + * @enum {string} + */ + attestations?: "read" | "write"; /** * @description The level of permission to grant the access token for checks on code. * @enum {string} @@ -25187,7 +26518,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @description The level of permission to grant the access token to manage Dependabot secrets. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -25196,6 +26527,11 @@ export interface components { * @enum {string} */ deployments?: "read" | "write"; + /** + * @description The level of permission to grant the access token for discussions and related comments and labels. + * @enum {string} + */ + discussions?: "read" | "write"; /** * @description The level of permission to grant the access token for managing repository environments. * @enum {string} @@ -25206,6 +26542,11 @@ export interface components { * @enum {string} */ issues?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the merge queues for a repository. + * @enum {string} + */ + merge_queues?: "read" | "write"; /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. * @enum {string} @@ -25276,6 +26617,11 @@ export interface components { * @enum {string} */ workflows?: "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + * @enum {string} + */ + custom_properties_for_organizations?: "read" | "write"; /** * @description The level of permission to grant the access token for organization teams and members. * @enum {string} @@ -25297,7 +26643,7 @@ export interface components { */ organization_custom_org_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom property management. + * @description The level of permission to grant the access token for repository custom properties management at the organization level. * @enum {string} */ organization_custom_properties?: "read" | "write" | "admin"; @@ -25361,11 +26707,6 @@ export interface components { * @enum {string} */ organization_user_blocking?: "read" | "write"; - /** - * @description The level of permission to grant the access token to manage team discussions and related comments. - * @enum {string} - */ - team_discussions?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the email addresses belonging to a user. * @enum {string} @@ -25401,6 +26742,11 @@ export interface components { * @enum {string} */ starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token for organization custom properties management at the enterprise level. + * @enum {string} + */ + enterprise_custom_properties_for_organizations?: "read" | "write" | "admin"; }; /** * Installation @@ -25435,6 +26781,8 @@ export interface components { html_url: string; /** @example 1 */ app_id: number; + /** @example Iv1.ab1112223334445c */ + client_id?: string; /** @description The ID of the user or organization this token is being scoped to. */ target_id: number; /** @example Organization */ @@ -25721,6 +27069,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -25839,6 +27199,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; }; /** * Installation Token @@ -26362,6 +27727,28 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Actions cache retention limit for an enterprise + * @description GitHub Actions cache retention policy for an enterprise. + */ + "actions-cache-retention-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an enterprise + * @description GitHub Actions cache storage policy for an enterprise. + */ + "actions-cache-storage-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** @description A code security configuration */ "code-security-configuration": { /** @description The ID of the code security configuration */ @@ -26379,7 +27766,7 @@ export interface components { * @description The enablement status of GitHub Advanced Security * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -26405,6 +27792,16 @@ export interface components { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal + * @enum {string|null} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set" | null; + /** @description Feature options for code scanning */ + code_scanning_options?: { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** * @description The enablement status of code scanning default setup * @enum {string} @@ -26420,6 +27817,11 @@ export interface components { /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ runner_label?: string | null; } | null; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -26446,6 +27848,8 @@ export interface components { * @enum {string} */ reviewer_type: "TEAM" | "ROLE"; + /** @description The ID of the security configuration associated with this bypass reviewer */ + security_configuration_id?: number; }[]; }; /** @@ -26458,6 +27862,21 @@ export interface components { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -26483,6 +27902,11 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** @description Security Configuration feature options for code scanning */ + "code-scanning-options": { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** @description Feature options for code scanning default setup */ "code-scanning-default-setup-options": { /** @@ -26880,6 +28304,36 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ "alert-auto-dismissed-at": string | null; + /** + * Dependabot alert dismissal request + * @description Information about an active dismissal request for this Dependabot alert. + */ + "dependabot-alert-dismissal-request-simple": { + /** @description The unique identifier of the dismissal request. */ + id?: number; + /** + * @description The current status of the dismissal request. + * @enum {string} + */ + status?: "pending" | "approved" | "rejected" | "cancelled"; + /** @description The user who requested the dismissal. */ + requester?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The login name of the user. */ + login?: string; + }; + /** + * Format: date-time + * @description The date and time when the dismissal request was created. + */ + created_at?: string; + /** + * Format: uri + * @description The API URL to get more information about this dismissal request. + */ + url?: string; + } | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -26898,6 +28352,14 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -26916,76 +28378,86 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; repository: components["schemas"]["simple-repository"]; }; /** - * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. - * @enum {string} - */ - "secret-scanning-alert-state": "open" | "resolved"; - /** - * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. - * @enum {string|null} + * Enterprise Team + * @description Group of enterprise owners and/or members */ - "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - updated_at?: null | components["schemas"]["alert-updated-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + description?: string; + slug: string; + /** Format: uri */ + url: string; /** - * Format: uri - * @description The REST API URL of the code locations for this alert. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example disabled | all */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + sync_to_organizations?: string; + /** @example disabled | selected | all */ + organization_selection_type?: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id: string | null; /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example Justice League */ - resolved_at?: string | null; - resolved_by?: null | components["schemas"]["simple-user"]; - /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + group_name?: string | null; /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league */ - secret_type_display_name?: string; - /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed?: boolean | null; - push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * Format: uri + * @example https://api.github.com/orgs/github */ - push_protection_bypassed_at?: string | null; - push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ - push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ - push_protection_bypass_request_comment?: string | null; + url: string; /** * Format: uri - * @description The URL to a push protection bypass request. + * @example https://api.github.com/orgs/github/repos */ - push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ - resolution_comment?: string | null; + repos_url: string; /** - * @description The token status as of the latest validity check. - * @enum {string} + * Format: uri + * @example https://api.github.com/orgs/github/events */ - 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; + 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; }; /** * Actor @@ -27001,6 +28473,193 @@ export interface components { /** Format: uri */ avatar_url: string; }; + /** + * Label + * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + /** + * Format: int64 + * @description Unique identifier for the label. + * @example 208045946 + */ + id: number; + /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ + node_id: string; + /** + * Format: uri + * @description URL for the label + * @example https://api.github.com/repositories/42/labels/bug + */ + url: string; + /** + * @description The name of the label. + * @example bug + */ + name: string; + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ + description: string | null; + /** + * @description 6-character hex code, without the leading #, identifying the color + * @example FFFFFF + */ + color: string; + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ + default: boolean; + }; + /** + * Discussion + * @description A Discussion in a repository. + */ + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** Reactions */ + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + /** + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} + */ + state: "open" | "closed" | "locked" | "converting" | "transferring"; + /** + * @description The reason for the current state + * @example resolved + * @enum {string|null} + */ + state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + labels?: components["schemas"]["label"][]; + }; /** * Milestone * @description A collection of related issues and pull requests. @@ -27070,6 +28729,37 @@ export interface components { */ due_on: string | null; }; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * author_association * @description How the author is associated with the repository. @@ -27097,6 +28787,111 @@ export interface components { completed: number; percent_completed: number; }; + /** + * Pinned Issue Comment + * @description Context around who pinned an issue comment and when it was pinned. + */ + "pinned-issue-comment": { + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + pinned_at: string; + pinned_by: null | components["schemas"]["simple-user"]; + }; + /** + * Issue Comment + * @description Comments provide a way for people to collaborate on an issue. + */ + "issue-comment": { + /** + * Format: int64 + * @description Unique identifier of the issue comment + * @example 42 + */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the issue comment + * @example https://api.github.com/repositories/42/issues/comments/1 + */ + url: string; + /** + * @description Contents of the issue comment + * @example What version of Safari were you using when you observed this bug? + */ + body?: string; + body_text?: string; + body_html?: string; + /** Format: uri */ + html_url: string; + user: null | components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + updated_at: string; + /** Format: uri */ + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: null | components["schemas"]["integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: null | components["schemas"]["pinned-issue-comment"]; + }; + /** Issue Dependencies Summary */ + "issue-dependencies-summary": { + blocked_by: number; + blocking: number; + total_blocked_by: number; + total_blocking: number; + }; + /** + * Issue Field Value + * @description A value assigned to an issue field + */ + "issue-field-value": { + /** + * Format: int64 + * @description Unique identifier for the issue field. + * @example 1 + */ + issue_field_id: number; + /** @example IFT_GDKND */ + node_id: string; + /** + * @description The data type of the issue field + * @example text + * @enum {string} + */ + data_type: "text" | "single_select" | "number" | "date"; + /** @description The value of the issue field */ + value: (null | (string | number) | (number | string) | (number | string)) | string | number; + /** @description Details about the selected option (only present for single_select fields) */ + single_select_option?: { + /** + * Format: int64 + * @description Unique identifier for the option. + * @example 1 + */ + id: number; + /** + * @description The name of the option + * @example High + */ + name: string; + /** + * @description The color of the option + * @example red + */ + color: string; + } | null; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -27135,7 +28930,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -27193,54 +28988,141 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: null | components["schemas"]["integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: null | components["schemas"]["issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + }; + /** Pull Request Minimal */ + "pull-request-minimal": { + /** Format: int64 */ + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; }; /** - * Issue Comment - * @description Comments provide a way for people to collaborate on an issue. + * Release Asset + * @description Data related to a release. */ - "issue-comment": { - /** - * Format: int64 - * @description Unique identifier of the issue comment - * @example 42 - */ + "release-asset": { + /** Format: uri */ + url: string; + /** Format: uri */ + browser_download_url: string; id: number; node_id: string; /** - * Format: uri - * @description URL for the issue comment - * @example https://api.github.com/repositories/42/issues/comments/1 + * @description The file name of the asset. + * @example Team Environment */ - url: string; + name: string; + label: string | null; /** - * @description Contents of the issue comment - * @example What version of Safari were you using when you observed this bug? + * @description State of the release asset. + * @enum {string} */ - body?: string; - body_text?: string; - body_html?: string; + state: "uploaded" | "open"; + content_type: string; + size: number; + digest: string | null; + download_count: number; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + uploader: null | components["schemas"]["simple-user"]; + }; + /** + * Release + * @description A release. + */ + release: { + /** Format: uri */ + url: string; /** Format: uri */ html_url: string; - user: null | components["schemas"]["simple-user"]; + /** Format: uri */ + assets_url: string; + upload_url: string; + /** Format: uri */ + tarball_url: string | null; + /** Format: uri */ + zipball_url: string | null; + id: number; + node_id: string; /** - * Format: date-time - * @example 2011-04-14T16:00:49Z + * @description The name of the tag. + * @example v1.0.0 + */ + tag_name: string; + /** + * @description Specifies the commitish value that determines where the Git tag is created from. + * @example master */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ + draft: boolean; + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ + prerelease: boolean; + /** + * @description Whether or not the release is immutable. + * @example false + */ + immutable?: boolean; + /** Format: date-time */ created_at: string; + /** Format: date-time */ + published_at: string | null; + /** Format: date-time */ + updated_at?: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + mentions_count?: number; /** - * Format: date-time - * @example 2011-04-14T16:00:49Z + * Format: uri + * @description The URL of the release discussion. */ - updated_at: string; - /** Format: uri */ - issue_url: string; - author_association: components["schemas"]["author-association"]; - performed_via_github_app?: null | components["schemas"]["integration"]; + discussion_url?: string; reactions?: components["schemas"]["reaction-rollup"]; }; /** @@ -27258,19 +29140,7 @@ export interface components { url: string; }; org?: components["schemas"]["actor"]; - payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; - pages?: { - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - }[]; - }; + payload: components["schemas"]["create-event"] | components["schemas"]["delete-event"] | components["schemas"]["discussion-event"] | components["schemas"]["issues-event"] | components["schemas"]["issue-comment-event"] | components["schemas"]["fork-event"] | components["schemas"]["gollum-event"] | components["schemas"]["member-event"] | components["schemas"]["public-event"] | components["schemas"]["push-event"] | components["schemas"]["pull-request-event"] | components["schemas"]["pull-request-review-comment-event"] | components["schemas"]["pull-request-review-event"] | components["schemas"]["commit-comment-event"] | components["schemas"]["release-event"] | components["schemas"]["watch-event"]; public: boolean; /** Format: date-time */ created_at: string | null; @@ -27844,10 +29714,19 @@ export interface components { }; }; "security-and-analysis": { + /** + * @description Enable or disable GitHub Advanced Security for the repository. + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ advanced_security?: { /** @enum {string} */ status?: "enabled" | "disabled"; }; + code_security?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; /** @description Enable or disable Dependabot security updates for the repository. */ dependabot_security_updates?: { /** @@ -27872,6 +29751,26 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_delegated_alert_dismissal?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_delegated_bypass?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + 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"; + }[]; + }; } | null; /** * Minimal Repository @@ -28037,6 +29936,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -28073,7 +29978,7 @@ export interface components { key?: string; name?: string; spdx_id?: string; - url?: string; + url?: string | null; node_id?: string; } | null; /** @example 0 */ @@ -28086,6 +29991,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Thread @@ -28139,43 +30048,186 @@ export interface components { repository_url?: string; }; /** - * Organization Simple - * @description A GitHub organization. + * Actions cache retention limit for an organization + * @description GitHub Actions cache retention policy for an organization. */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + "actions-cache-retention-limit-for-organization": { /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 */ - url: string; + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an organization + * @description GitHub Actions cache storage policy for an organization. + */ + "actions-cache-storage-limit-for-organization": { /** - * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 */ - repos_url: string; + max_cache_size_gb?: number; + }; + /** + * Dependabot Repository Access Details + * @description Information about repositories that Dependabot is able to access in an organization + */ + "dependabot-repository-access-details": { /** - * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string|null} */ - 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; + default_level?: "public" | "internal" | null; + accessible_repositories?: (null | components["schemas"]["simple-repository"])[]; + }; + budget: { + /** + * @description The unique identifier for the budget + * @example 2066deda-923f-43f9-88d2-62395a28c0cdd + */ + id: string; + /** + * @description The type of pricing for the budget + * @example SkuPricing + * @enum {string} + */ + budget_type: "SkuPricing" | "ProductPricing"; + /** @description The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description The type of limit enforcement for the budget + * @example true + */ + prevent_further_usage: boolean; + /** + * @description The scope of the budget (enterprise, organization, repository, cost center) + * @example enterprise + */ + budget_scope: string; + /** + * @description The name of the entity for the budget (enterprise does not require a name). + * @example octocat/hello-world + */ + budget_entity_name?: string; + /** @description A single product or sku to apply the budget to. */ + budget_product_sku: string; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert: boolean; + /** + * @description Array of user login names who will receive alerts + * @example mona + * @example lisa + */ + alert_recipients: string[]; + }; + }; + get_all_budgets: { + /** @description Array of budget objects for the enterprise */ + budgets: components["schemas"]["budget"][]; + /** @description Indicates if there are more pages of results available (maps to hasNextPage from billing platform) */ + has_next_page?: boolean; + /** @description Total number of budgets matching the query */ + total_count?: number; + }; + "get-budget": { + /** @description ID of the budget. */ + id: string; + /** + * @description The type of scope for the budget + * @example enterprise + * @enum {string} + */ + budget_scope: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @example octocat/hello-world + */ + budget_entity_name: string; + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description Whether to prevent additional spending once the budget is exceeded + * @example true + */ + prevent_further_usage: boolean; + /** + * @description A single product or sku to apply the budget to. + * @example actions_linux + */ + budget_product_sku: string; + /** + * @description The type of pricing for the budget + * @example ProductPricing + * @enum {string} + */ + budget_type: "ProductPricing" | "SkuPricing"; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert?: boolean; + /** + * @description Array of user login names who will receive alerts + * @example mona + * @example lisa + */ + alert_recipients?: string[]; + }; + }; + "delete-budget": { + /** @description A message indicating the result of the deletion operation */ + message: string; + /** @description The ID of the deleted budget */ + id: string; + }; + "billing-premium-request-usage-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the user for the usage report. */ + user?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; "billing-usage-report": { usageItems?: { @@ -28203,6 +30255,46 @@ export interface components { repositoryName?: string; }[]; }; + "billing-usage-summary-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; /** * Organization Full * @description Organization Full @@ -28308,6 +30400,11 @@ export interface components { seats?: number; }; default_repository_permission?: string | null; + /** + * @description The default branch for repositories created in this organization. + * @example main + */ + default_repository_branch?: string | null; /** @example true */ members_can_create_repositories?: boolean | null; /** @example true */ @@ -28326,6 +30423,22 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; + /** @example true */ + members_can_delete_repositories?: boolean; + /** @example true */ + members_can_change_repo_visibility?: boolean; + /** @example true */ + members_can_invite_outside_collaborators?: boolean; + /** @example true */ + members_can_delete_issues?: boolean; + /** @example true */ + display_commenter_full_name_setting_enabled?: boolean; + /** @example true */ + readers_can_create_discussions?: boolean; + /** @example true */ + members_can_create_teams?: boolean; + /** @example true */ + members_can_view_dependency_insights?: boolean; /** @example false */ members_can_fork_private_repositories?: boolean | null; /** @example false */ @@ -28471,7 +30584,7 @@ export interface components { * @description The image version of the hosted runner pool. * @example latest */ - version: string; + version?: string; }; /** * Github-owned VM details. @@ -28572,12 +30685,91 @@ export interface components { * @example 2022-10-09T23:39:01Z */ last_active_on?: string | null; + /** @description Whether custom image generation is enabled for the hosted runners. */ + image_gen?: boolean; + }; + /** + * GitHub-hosted runner custom image details + * @description Provides details of a custom runner image + */ + "actions-hosted-runner-custom-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example 1 + */ + id: number; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Total size of all the image versions in GB. + * @example 200 + */ + total_versions_size: number; + /** + * @description Display name for this image. + * @example CustomImage + */ + name: string; + /** + * @description The image provider. + * @example custom + */ + source: string; + /** + * @description The number of image versions associated with the image. + * @example 4 + */ + versions_count: number; + /** + * @description The latest image version associated with the image. + * @example 1.3.0 + */ + latest_version: string; + /** + * @description The number of image versions associated with the image. + * @example Ready + */ + state: string; + }; + /** + * GitHub-hosted runner custom image version details. + * @description Provides details of a hosted runner custom image version + */ + "actions-hosted-runner-custom-image-version": { + /** + * @description The version of image. + * @example 1.0.0 + */ + version: string; + /** + * @description The state of image version. + * @example Ready + */ + state: string; + /** + * @description Image version size in GB. + * @example 30 + */ + size_gb: number; + /** + * @description The creation date time of the image version. + * @example 2024-11-09T23:39:01Z + */ + created_on: string; + /** + * @description The image version status details. + * @example None + */ + state_details: string; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - "actions-hosted-runner-image": { + "actions-hosted-runner-curated-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 @@ -28647,12 +30839,52 @@ export interface components { "allowed-actions": "all" | "local_only" | "selected"; /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */ "selected-actions-url": string; + /** @description Whether actions must be pinned to a full-length commit SHA. */ + "sha-pinning-required": boolean; "actions-organization-permissions": { enabled_repositories: components["schemas"]["enabled-repositories"]; /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ selected_repositories_url?: string; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + "actions-artifact-and-log-retention-response": { + /** @description The number of days artifacts and logs are retained */ + days: number; + /** @description The maximum number of days that can be configured */ + maximum_allowed_days: number; + }; + "actions-artifact-and-log-retention": { + /** @description The number of days to retain artifacts and logs */ + days: number; + }; + "actions-fork-pr-contributor-approval": { + /** + * @description The policy that controls when fork PR workflows require approval from a maintainer. + * @enum {string} + */ + approval_policy: "first_time_contributors_new_to_github" | "first_time_contributors" | "all_external_contributors"; + }; + "actions-fork-pr-workflows-private-repos": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows: boolean; + }; + "actions-fork-pr-workflows-private-repos-request": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows?: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables?: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows?: boolean; }; "selected-actions": { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ @@ -28667,6 +30899,15 @@ export interface components { */ patterns_allowed?: string[]; }; + "self-hosted-runners-settings": { + /** + * @description The policy that controls whether self-hosted runners can be used by repositories in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + /** @description The URL to the endpoint for managing selected repositories for self-hosted runners in the organization */ + selected_repositories_url?: string; + }; /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows. * @enum {string} @@ -28730,12 +30971,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -28756,6 +30997,7 @@ export interface components { status: string; busy: boolean; labels: components["schemas"]["runner-label"][]; + ephemeral?: boolean; }; /** * Runner Application @@ -28890,6 +31132,219 @@ export interface components { */ selected_repositories_url?: string; }; + /** + * Artifact Deployment Record + * @description Artifact Metadata Deployment Record + */ + "artifact-deployment-record": { + id?: number; + digest?: string; + logical_environment?: string; + physical_environment?: string; + cluster?: string; + deployment_name?: string; + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + created_at?: string; + updated_at?: string; + /** @description The ID of the provenance attestation associated with the deployment record. */ + attestation_id?: number | null; + }; + /** + * Campaign state + * @description Indicates whether a campaign is open or closed + * @enum {string} + */ + "campaign-state": "open" | "closed"; + /** + * Campaign alert type + * @description Indicates the alert type of a campaign + * @enum {string} + */ + "campaign-alert-type": "code_scanning" | "secret_scanning"; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + parent: null | components["schemas"]["team-simple"]; + }; + /** + * Campaign summary + * @description The campaign metadata and alert stats. + */ + "campaign-summary": { + /** @description The number of the newly created campaign */ + number: number; + /** + * Format: date-time + * @description The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** @description The campaign name */ + name?: string; + /** @description The campaign description */ + description: string; + /** @description The campaign managers */ + managers: components["schemas"]["simple-user"][]; + /** @description The campaign team managers */ + team_managers?: components["schemas"]["team"][]; + /** + * Format: date-time + * @description The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + published_at?: string; + /** + * Format: date-time + * @description The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at: string; + /** + * Format: date-time + * @description The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + */ + closed_at?: string | null; + state: components["schemas"]["campaign-state"]; + /** + * Format: uri + * @description The contact link of the campaign. + */ + contact_link: string | null; + alert_stats?: { + /** @description The number of open alerts */ + open_count: number; + /** @description The number of closed alerts */ + closed_count: number; + /** @description The number of in-progress alerts */ + in_progress_count: number; + }; + }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ @@ -29013,6 +31468,8 @@ export interface components { tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; + dismissal_approved_by?: null | components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * Codespace machine @@ -29270,17 +31727,17 @@ export interface components { created_at?: string; }; /** - * Copilot Business Seat Breakdown + * Copilot Seat Breakdown * @description The breakdown of Copilot Business seats for the organization. */ - "copilot-seat-breakdown": { + "copilot-organization-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ total?: number; /** @description Seats added during the current billing cycle. */ added_this_cycle?: number; /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ pending_cancellation?: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ + /** @description The number of users who have been invited to receive a Copilot seat through this organization. */ pending_invitation?: number; /** @description The number of seats that have used Copilot during the current billing cycle. */ active_this_cycle?: number; @@ -29292,24 +31749,24 @@ export interface components { * @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"]; + seat_breakdown: components["schemas"]["copilot-organization-seat-breakdown"]; /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @description The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). * @enum {string} */ - public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + public_code_suggestions: "allow" | "block" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @description The organization policy for allowing or disallowing Copilot Chat in the IDE. * @enum {string} */ ide_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @description The organization policy for allowing or disallowing Copilot features on GitHub.com. * @enum {string} */ platform_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @description The organization policy for allowing or disallowing Copilot CLI. * @enum {string} */ cli?: "enabled" | "disabled" | "unconfigured"; @@ -29322,139 +31779,16 @@ export interface components { * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ - plan_type?: "business" | "enterprise" | "unknown"; + plan_type?: "business" | "enterprise"; } & { [key: string]: unknown; }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: null | components["schemas"]["team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; - /** @example Justice League */ - group_name?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league - */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; + assignee?: null | 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"]); @@ -29470,6 +31804,11 @@ export interface components { last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + */ + last_authenticated_at?: string | null; /** * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. @@ -29487,6 +31826,13 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; + /** + * Copilot Organization Content Exclusion Details + * @description List all Copilot Content Exclusion rules for an organization. + */ + "copilot-organization-content-exclusion-details": { + [key: string]: string[]; + }; /** @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. */ @@ -29546,7 +31892,7 @@ export interface components { total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ models?: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -29565,13 +31911,13 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** @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 model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -29597,7 +31943,7 @@ export interface components { total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ models?: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -29633,52 +31979,6 @@ export interface components { } & { [key: string]: unknown; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { - /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; - }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -29951,6 +32251,32 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; /** * Org Membership * @description Org Membership @@ -29973,6 +32299,18 @@ export interface components { * @enum {string} */ role: "admin" | "member" | "billing_manager"; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example ent:team-one + * @example ent:team-two + */ + enterprise_teams_providing_indirect_membership?: string[]; /** * Format: uri * @example https://api.github.com/orgs/octocat @@ -30105,6 +32443,21 @@ export interface components { /** Format: uri */ repositories_url: string; parent: null | components["schemas"]["team-simple"]; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * A Role Assignment for a User @@ -30337,12 +32690,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string | null; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. * @enum {string} @@ -30367,12 +32730,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} @@ -30386,69 +32759,568 @@ export interface components { updated_at: string; }; /** - * Project - * @description Projects are a way to organize columns and cards of work. + * Projects v2 Status Update + * @description An status update belonging to a project */ - project: { + "projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test + * Format: date-time + * @description The time when the status update was created. + * @example 2022-04-28T12:00:00Z */ - owner_url: string; + created_at: string; + /** + * Format: date-time + * @description The time when the status update was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @description The start date of the period covered by the update. + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @description The target date associated with the update. + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + }; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + /** @description The unique identifier of the project. */ + id: number; + /** @description The node ID of the project. */ + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + /** @description The project title. */ + title: string; + /** @description A short description of the project. */ + description: string | null; + /** @description Whether the project is visible to anyone with access to the owner. */ + public: boolean; + /** + * Format: date-time + * @description The time when the project was closed. + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @description The time when the project was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the project was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @description The project number. */ + number: number; + /** @description A concise summary of the project. */ + short_description: string | null; + /** + * Format: date-time + * @description The time when the project was deleted. + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: null | components["schemas"]["simple-user"]; + /** + * @description The current state of the project. + * @enum {string} + */ + state?: "open" | "closed"; + latest_status_update?: null | components["schemas"]["projects-v2-status-update"]; + /** @description Whether this project is a template */ + is_template?: boolean; + }; + /** + * Link + * @description Hypermedia Link + */ + link: { + href: string; + }; + /** + * Auto merge + * @description The status of auto merging a pull request. + */ + "auto-merge": { + enabled_by: components["schemas"]["simple-user"]; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + /** @description Title for the merge commit message. */ + commit_title: string; + /** @description Commit message for the merge commit. */ + commit_message: string; + } | null; + /** + * Pull Request Simple + * @description Pull Request Simple + */ + "pull-request-simple": { /** * Format: uri - * @example https://api.github.com/projects/1002604 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + node_id: string; /** * Format: uri - * @example https://github.com/api-playground/projects-test/projects/12 + * @example https://github.com/octocat/Hello-World/pull/1347 */ html_url: string; /** * Format: uri - * @example https://api.github.com/projects/1002604/columns + * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - columns_url: string; - /** @example 1002604 */ + diff_url: string; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World/pull/1347.patch + */ + patch_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + */ + commits_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + */ + review_comments_url: string; + /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ + review_comment_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + */ + comments_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + statuses_url: string; + /** @example 1347 */ + number: number; + /** @example open */ + state: string; + /** @example true */ + locked: boolean; + /** @example new-feature */ + title: string; + user: null | components["schemas"]["simple-user"]; + /** @example Please pull these awesome changes */ + body: string | null; + labels: { + /** Format: int64 */ + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: null | components["schemas"]["milestone"]; + /** @example too heated */ + active_lock_reason?: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + updated_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + merged_at: string | null; + /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + merge_commit_sha: string | null; + assignee: null | components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: null | components["schemas"]["simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: null | components["schemas"]["simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ + draft?: boolean; + }; + /** + * Draft Issue + * @description A draft issue in a project + */ + "projects-v2-draft-issue": { + /** @description The ID of the draft issue */ id: number; - /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ + /** @description The node ID of the draft issue */ node_id: string; + /** @description The title of the draft issue */ + title: string; + /** @description The body content of the draft issue */ + body?: string | null; + user: null | components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time the draft issue was created + */ + created_at: string; + /** + * Format: date-time + * @description The time the draft issue was last updated + */ + updated_at: string; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-simple": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The content represented by the item. */ + content?: components["schemas"]["issue"] | components["schemas"]["pull-request-simple"] | components["schemas"]["projects-v2-draft-issue"]; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; /** - * @description Name of the project - * @example Week One Sprint + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The URL of the project this item belongs to. */ + project_url?: string; + /** + * Format: uri + * @description The URL of the item in the project. + */ + item_url?: string; + }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-options": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option, in raw text and HTML formats. */ + name: { + raw: string; + html: string; + }; + /** @description The description of the option, in raw text and HTML formats. */ + description: { + raw: string; + html: string; + }; + /** @description The color associated with the option. */ + color: string; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-settings": { + /** @description The unique identifier of the iteration setting. */ + id: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date: string; + /** @description The duration of the iteration in days. */ + duration: number; + /** @description The iteration title, in raw text and HTML formats. */ + title: { + raw: string; + html: string; + }; + /** @description Whether the iteration has been completed. */ + completed: boolean; + }; + /** + * Projects v2 Field + * @description A field inside a projects v2 project + */ + "projects-v2-field": { + /** @description The unique identifier of the field. */ + id: number; + /** @description The node ID of the field. */ + node_id?: string; + /** + * @description The API URL of the project that contains the field. + * @example https://api.github.com/projects/1 + */ + project_url: string; + /** @description The name of the field. */ name: string; /** - * @description Body of the project - * @example This project represents the sprint of the first week in January + * @description The field's data type. + * @enum {string} */ - body: string | null; - /** @example 1 */ - number: number; + data_type: "assignees" | "linked_pull_requests" | "reviewers" | "labels" | "milestone" | "repository" | "title" | "text" | "single_select" | "number" | "date" | "iteration" | "issue_type" | "parent_issue" | "sub_issues_progress"; + /** @description The options available for single select fields. */ + options?: components["schemas"]["projects-v2-single-select-options"][]; + /** @description Configuration for iteration fields. */ + configuration?: { + /** @description The day of the week when the iteration starts. */ + start_day?: number; + /** @description The duration of the iteration in days. */ + duration?: number; + iterations?: components["schemas"]["projects-v2-iteration-settings"][]; + }; /** - * @description State of the project; either 'open' or 'closed' - * @example open + * Format: date-time + * @description The time when the field was created. + * @example 2022-04-28T12:00:00Z */ - state: string; - creator: null | components["schemas"]["simple-user"]; + created_at: string; /** * Format: date-time - * @example 2011-04-10T20:09:31Z + * @description The time when the field was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + }; + "projects-v2-field-single-select-option": { + /** @description The display name of the option. */ + name?: string; + /** + * @description The color associated with the option. + * @enum {string} + */ + color?: "BLUE" | "GRAY" | "GREEN" | "ORANGE" | "PINK" | "PURPLE" | "RED" | "YELLOW"; + /** @description The description of the option. */ + description?: string; + }; + /** @description The configuration for iteration fields. */ + "projects-v2-field-iteration-configuration": { + /** + * Format: date + * @description The start date of the first iteration. + */ + start_date?: string; + /** @description The default duration for iterations in days. Individual iterations can override this value. */ + duration?: number; + /** @description Zero or more iterations for the field. */ + iterations?: { + /** @description The title of the iteration. */ + title?: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date?: string; + /** @description The duration of the iteration in days. */ + duration?: number; + }[]; + }; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-with-content": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** + * Format: uri + * @description The API URL of the project that contains this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/3 + */ + project_url?: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + /** @description The content of the item, which varies by content type. */ + content?: { + [key: string]: unknown; + } | null; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time - * @example 2014-03-03T18:58:10Z + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z */ updated_at: string; /** - * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The API URL of this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/items/3 + */ + item_url?: string | null; + /** @description The fields and values associated with this item. */ + fields?: { + [key: string]: unknown; + }[]; + }; + /** + * Projects v2 View + * @description A view inside a projects v2 project + */ + "projects-v2-view": { + /** @description The unique identifier of the view. */ + id: number; + /** @description The number of the view within the project. */ + number: number; + /** @description The name of the view. */ + name: string; + /** + * @description The layout of the view. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; + layout: "table" | "board" | "roadmap"; + /** @description The node ID of the view. */ + node_id: string; + /** + * @description The API URL of the project that contains the view. + * @example https://api.github.com/orgs/octocat/projectsV2/1 + */ + project_url: string; + /** + * Format: uri + * @description The web URL of the view. + * @example https://github.com/orgs/octocat/projects/1/views/1 + */ + html_url: string; + creator: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the view was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the view was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The filter query for the view. + * @example is:issue is:open + */ + filter?: string | null; + /** @description The list of field IDs that are visible in the view. */ + visible_fields: number[]; + /** @description The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". */ + sort_by: (number | string)[][]; + /** @description The list of field IDs used for horizontal grouping. */ + group_by: number[]; + /** @description The list of field IDs used for vertical grouping (board layout). */ + vertical_group_by: number[]; }; /** * Organization Custom Property @@ -30473,7 +33345,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -30491,6 +33363,8 @@ export interface components { * @enum {string|null} */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Set Payload @@ -30502,7 +33376,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -30514,6 +33388,14 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Value @@ -30758,6 +33640,14 @@ export interface components { has_downloads?: boolean; /** @example true */ has_discussions: boolean; + /** @example true */ + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -30880,7 +33770,7 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** @description The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -30888,11 +33778,11 @@ 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. Also, `pull_request` is only applicable to branch rulesets. + * @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. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode: "always" | "pull_request" | "exempt"; }; /** * Repository ruleset conditions for ref names @@ -31051,17 +33941,29 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * Reviewer + * @description A required reviewing team + */ + "repository-rule-params-reviewer": { + /** @description ID of the reviewer which must review changes to matching files. */ + id: number; + /** + * @description The type of the reviewer + * @enum {string} + */ + type: "Team"; + }; /** * 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. */ + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. */ 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; + reviewer: components["schemas"]["repository-rule-params-reviewer"]; }; /** * pull_request @@ -31071,8 +33973,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { - /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ - allowed_merge_methods?: string[]; + /** @description Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. */ + allowed_merge_methods?: ("merge" | "squash" | "rebase")[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -31083,6 +33985,13 @@ export interface components { required_approving_review_count: number; /** @description All conversations on code must be resolved before a pull request can be merged. */ required_review_thread_resolution: boolean; + /** + * @description > [!NOTE] + * > `required_reviewers` is in beta and subject to change. + * + * A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + */ + required_reviewers?: components["schemas"]["repository-rule-params-required-reviewer-configuration"][]; }; }; /** @@ -31127,7 +34036,7 @@ export interface components { /** @enum {string} */ type: "commit_message_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -31148,7 +34057,7 @@ export interface components { /** @enum {string} */ type: "commit_author_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -31169,7 +34078,7 @@ export interface components { /** @enum {string} */ type: "committer_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -31190,7 +34099,7 @@ export interface components { /** @enum {string} */ type: "branch_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -31211,7 +34120,7 @@ export interface components { /** @enum {string} */ type: "tag_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -31224,6 +34133,54 @@ export interface components { pattern: string; }; }; + /** + * file_path_restriction + * @description Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + */ + "repository-rule-file-path-restriction": { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + }; + /** + * max_file_path_length + * @description Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + */ + "repository-rule-max-file-path-length": { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths. */ + max_file_path_length: number; + }; + }; + /** + * file_extension_restriction + * @description Prevent commits that include files with specified file extensions from being pushed to the commit graph. + */ + "repository-rule-file-extension-restriction": { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + }; + /** + * max_file_size + * @description Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + */ + "repository-rule-max-file-size": { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + }; /** * RestrictedCommits * @description Restricted commit @@ -31293,38 +34250,35 @@ export interface components { }; }; /** - * Repository Rule - * @description A repository rule. + * copilot_code_review + * @description Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { - /** @enum {string} */ - type: "file_path_restriction"; - parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - restricted_file_paths: string[]; - }; - } | { - /** @enum {string} */ - type: "max_file_path_length"; - parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - max_file_path_length: number; - }; - } | { - /** @enum {string} */ - type: "file_extension_restriction"; - parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - restricted_file_extensions: string[]; - }; - } | { + "repository-rule-copilot-code-review": { /** @enum {string} */ - type: "max_file_size"; + type: "copilot_code_review"; parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - max_file_size: number; + /** @description Copilot automatically reviews draft pull requests before they are marked as ready for review. */ + review_draft_pull_requests?: boolean; + /** @description Copilot automatically reviews each new push to the pull request. */ + review_on_push?: boolean; }; - } | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"]; + }; + /** + * CopilotCodeReviewAnalysisTool + * @description A tool that must provide code review results for this rule to pass. + */ + "repository-rule-params-copilot-code-review-analysis-tool": { + /** + * @description The name of a code review analysis tool + * @enum {string} + */ + name: "CodeQL" | "ESLint" | "PMD"; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -31354,7 +34308,7 @@ export interface components { * querying the repository-level endpoint. * @enum {string} */ - current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + current_user_can_bypass?: "always" | "pull_requests_only" | "never" | "exempt"; node_id?: string; _links?: { self?: { @@ -31373,6 +34327,11 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** + * Repository Rule + * @description A repository rule. + */ + "org-rules": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Rule Suites * @description Response @@ -31410,6 +34369,44 @@ export interface components { */ evaluation_result?: "pass" | "fail" | "bypass"; }[]; + /** + * Pull request rule suite metadata + * @description Metadata for a pull request rule evaluation result. + */ + "rule-suite-pull-request": { + /** @description The pull request associated with the rule evaluation. */ + pull_request?: { + /** @description The unique identifier of the pull request. */ + id?: number; + /** @description The number of the pull request. */ + number?: number; + /** @description The user who created the pull request. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The reviews associated with the pull request. */ + reviews?: { + /** @description The unique identifier of the review. */ + id?: number; + /** @description The user who submitted the review. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The state of the review. */ + state?: string; + }[]; + }; + }; /** * Rule Suite * @description Response @@ -31421,9 +34418,9 @@ export interface components { actor_id?: number | null; /** @description The handle for the GitHub user account. */ actor_name?: string | null; - /** @description The first commit sha before the push evaluation. */ + /** @description The previous commit SHA of the ref. */ before_sha?: string; - /** @description The last commit sha in the push evaluation. */ + /** @description The new commit SHA of the ref. */ after_sha?: string; /** @description The ref name that the evaluation ran on. */ ref?: string; @@ -31472,6 +34469,315 @@ export interface components { details?: string | null; }[]; }; + /** + * Ruleset version + * @description The historical version of a ruleset + */ + "ruleset-version": { + /** @description The ID of the previous version of the ruleset */ + version_id: number; + /** @description The actor who updated the ruleset */ + actor: { + id?: number; + type?: string; + }; + /** Format: date-time */ + updated_at: string; + }; + "ruleset-version-with-state": components["schemas"]["ruleset-version"] & { + /** @description The state of the ruleset version */ + state: Record; + }; + /** + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + * @enum {string} + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; + /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ + "secret-scanning-location-commit": { + /** + * @description The file path in the repository + * @example /example/secrets.txt + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** @description The API URL to get the associated blob resource */ + blob_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + commit_sha: string; + /** @description The API URL to get the associated commit resource */ + commit_url: string; + }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; + /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ + "secret-scanning-location-issue-title": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_title_url: string; + }; + /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ + "secret-scanning-location-issue-body": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_body_url: string; + }; + /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ + "secret-scanning-location-issue-comment": { + /** + * Format: uri + * @description The API URL to get the issue comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + issue_comment_url: string; + }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; + /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */ + "secret-scanning-first-detected-location": components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; + "organization-secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: null | components["schemas"]["alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: null | components["schemas"]["simple-user"]; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; + /** @description The secret that was detected. */ + secret?: string; + repository?: components["schemas"]["simple-repository"]; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: null | components["schemas"]["simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description The comment that was optionally added when this alert was closed */ + resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @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; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: null | components["schemas"]["secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: null | components["schemas"]["simple-user"]; + }; + /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */ + "secret-scanning-row-version": string | null; + "secret-scanning-pattern-override": { + /** @description The ID of the pattern. */ + token_type?: string; + /** @description The version of this pattern if it's a custom pattern. */ + custom_pattern_version?: string | null; + /** @description The slug of the pattern. */ + slug?: string; + /** @description The user-friendly name for the pattern. */ + display_name?: string; + /** @description The total number of alerts generated by this pattern. */ + alert_total?: number; + /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */ + alert_total_percentage?: number; + /** @description The number of false positive alerts generated by this pattern. */ + false_positives?: number; + /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */ + false_positive_rate?: number; + /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */ + bypass_rate?: number; + /** + * @description The default push protection setting for this pattern. + * @enum {string} + */ + default_setting?: "disabled" | "enabled"; + /** + * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + * @enum {string|null} + */ + enterprise_setting?: "not-set" | "disabled" | "enabled" | null; + /** + * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + * @enum {string} + */ + setting?: "not-set" | "disabled" | "enabled"; + }; + /** + * Secret scanning pattern configuration + * @description A collection of secret scanning patterns and their settings related to push protection. + */ + "secret-scanning-pattern-configuration": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Overrides for partner patterns. */ + provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + /** @description Overrides for custom patterns defined by the organization. */ + custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ @@ -31598,61 +34904,19 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ readonly private_fork: null & components["schemas"]["simple-repository"]; }; - "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; - minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - total?: number; - }; - }; - "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; + /** + * Check immutable releases organization settings + * @description Check immutable releases settings for an organization. + */ + "immutable-releases-organization-settings": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */ + selected_repositories_url?: string; }; /** * Hosted compute network configuration @@ -31679,6 +34943,16 @@ export interface components { * @example 123ABC456DEF789 */ network_settings_ids?: string[]; + /** + * @description The unique identifier of each failover network settings in the configuration. + * @example 123ABC456DEF789 + */ + failover_network_settings_ids?: string[]; + /** + * @description Indicates whether the failover network resource is enabled. + * @example true + */ + failover_network_enabled?: boolean; /** * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. @@ -31849,6 +35123,11 @@ export interface components { /** Format: date-time */ archived_at: string | null; }; + /** + * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com + */ + "ldap-dn": string; /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. @@ -31921,163 +35200,22 @@ export interface components { */ updated_at: string; organization: components["schemas"]["team-organization"]; + ldap_dn?: components["schemas"]["ldap-dn"]; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - "team-discussion": { - author: null | components["schemas"]["simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** @example 0 */ - comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; - /** - * @description The unique sequence number of a team discussion. - * @example 42 - */ - number: number; - /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true - */ - pinned: boolean; - /** - * @description Whether or not this discussion should be restricted to team members and organization owners. - * @example true - */ - private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Team Discussion Comment - * @description A reply to a discussion within a team. - */ - "team-discussion-comment": { - author: null | components["schemas"]["simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - body: string; - /** @example

Do you like apples?

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @description The ownership type of the team + * @enum {string} */ - discussion_url: string; + type: "enterprise" | "organization"; /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @description Unique identifier of the organization to which this team belongs + * @example 37 */ - html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + organization_id?: number; /** - * @description The unique sequence number of a team discussion comment. + * @description Unique identifier of the enterprise to which this team belongs * @example 42 */ - number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - reaction: { - /** @example 1 */ - id: number; - /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: null | components["schemas"]["simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z - */ - created_at: string; + enterprise_id?: number; }; /** * Team Membership @@ -32099,34 +35237,6 @@ export interface components { */ state: "active" | "pending"; }; - /** - * Team Project - * @description A team's access to a project. - */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; - permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; /** * Team Repository * @description A team's access to a repository. @@ -32432,111 +35542,6 @@ export interface components { watchers: number; master_branch?: string; }; - /** - * Project Card - * @description Project cards represent a scope of work. - */ - "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - url: string; - /** - * Format: int64 - * @description The project card's ID - * @example 42 - */ - id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; - /** @example Add payload for delete Project column */ - note: string | null; - creator: null | components["schemas"]["simple-user"]; - /** - * Format: date-time - * @example 2016-09-05T14:21:06Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:20:22Z - */ - updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - column_name?: string; - project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - }; - /** - * Project Column - * @description Project columns contain cards of work. - */ - "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - updated_at: string; - }; - /** - * Project Collaborator Permission - * @description Project Collaborator Permission - */ - "project-collaborator-permission": { - permission: string; - user: null | components["schemas"]["simple-user"]; - }; /** Rate Limit */ "rate-limit": { limit: number; @@ -32560,6 +35565,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + dependency_sbom?: components["schemas"]["rate-limit"]; code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; @@ -32595,6 +35601,11 @@ export interface components { expires_at: string | null; /** Format: date-time */ updated_at: string | null; + /** + * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + */ + digest?: string | null; workflow_run?: { /** @example 10 */ id?: number; @@ -32608,6 +35619,28 @@ export interface components { head_sha?: string; } | null; }; + /** + * Actions cache retention limit for a repository + * @description GitHub Actions cache retention policy for a repository. + */ + "actions-cache-retention-limit-for-repository": { + /** + * @description The maximum number of days to keep caches in this repository. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for a repository + * @description GitHub Actions cache storage policy for a repository. + */ + "actions-cache-storage-limit-for-repository": { + /** + * @description The maximum total cache size for this repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** * Repository actions caches * @description Repository actions caches @@ -32839,6 +35872,7 @@ export interface components { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; "actions-workflow-access-to-repository": { /** @@ -32859,33 +35893,6 @@ export interface components { sha: string; ref?: string; }; - /** Pull Request Minimal */ - "pull-request-minimal": { - /** Format: int64 */ - id: number; - number: number; - url: string; - head: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - base: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - }; /** * Simple Commit * @description A commit. @@ -33336,6 +36343,26 @@ export interface components { */ deleted_at?: string; }; + /** + * Workflow Run ID + * Format: int64 + * @description The ID of the workflow run. + */ + "workflow-run-id": number; + /** + * Workflow Dispatch Response + * @description Response containing the workflow run ID and URLs. + */ + "workflow-dispatch-response": { + workflow_run_id: components["schemas"]["workflow-run-id"]; + /** + * Format: uri + * @description The URL to the workflow run. + */ + run_url: string; + /** Format: uri */ + html_url: string; + }; /** * Workflow Usage * @description Workflow Usage @@ -33413,6 +36440,8 @@ export interface components { * @example true */ is_alphanumeric: boolean; + /** Format: date-time */ + updated_at?: string | null; }; /** * Check Dependabot security updates @@ -33539,21 +36568,7 @@ export interface components { site_admin?: boolean; user_view_type?: string; }[]; - teams: { - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - notification_setting?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - }[]; + teams: components["schemas"]["team"][]; apps: { id?: number; slug?: string; @@ -33687,7 +36702,10 @@ export interface components { name?: string; /** @example "chris@ozmm.org" */ email?: string; - /** @example "2007-10-29T02:42:39.000-07:00" */ + /** + * Format: date-time + * @example "2007-10-29T02:42:39.000-07:00" + */ date?: string; }; /** Verification */ @@ -33696,7 +36714,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** * Diff Entry @@ -33704,7 +36722,7 @@ export interface components { */ "diff-entry": { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string | null; /** @example file1.txt */ filename: string; /** @@ -34165,6 +37183,8 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule-summary"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: null | components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; "code-scanning-alert-rule": { /** @description A unique identifier for the rule used to detect the alert. */ @@ -34208,12 +37228,18 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: null | components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** @description If `true`, attempt to create an alert dismissal request. */ + "code-scanning-alert-create-request": boolean; + /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */ + "code-scanning-alert-assignees": string[]; /** * @description The status of an autofix. * @enum {string} @@ -34244,6 +37270,29 @@ export interface components { /** @description SHA of commit with autofix. */ sha?: string; }; + /** + * @description State of a code scanning alert instance. + * @enum {string|null} + */ + "code-scanning-alert-instance-state": "open" | "fixed" | null; + "code-scanning-alert-instance-list": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-instance-state"]; + commit_sha?: string; + message?: { + text?: string; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -34342,7 +37391,7 @@ export interface components { * @description The language targeted by the CodeQL query * @enum {string} */ - "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift"; + "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift"; /** * Repository Identifier * @description Repository Identifier @@ -34489,6 +37538,11 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** * Format: date-time * @description Timestamp of latest configuration update. @@ -34523,6 +37577,11 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** @description CodeQL languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; @@ -34799,180 +37858,38 @@ export interface components { reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Branch Short - * @description Branch Short - */ - "branch-short": { - name: string; - commit: { - sha: string; - url: string; - }; - protected: boolean; - }; - /** - * Link - * @description Hypermedia Link - */ - link: { - href: string; - }; - /** - * Auto merge - * @description The status of auto merging a pull request. - */ - "auto-merge": { - enabled_by: components["schemas"]["simple-user"]; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - /** @description Title for the merge commit message. */ - commit_title: string; - /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; - /** - * Pull Request Simple - * @description Pull Request Simple + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - "pull-request-simple": { - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 - */ - url: string; - /** - * Format: int64 - * @example 1 - */ + reaction: { + /** @example 1 */ id: number; - /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + /** @example MDg6UmVhY3Rpb24x */ node_id: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347 - */ - html_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.diff - */ - diff_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.patch - */ - patch_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - */ - commits_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - */ - review_comments_url: string; - /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - */ - comments_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - */ - statuses_url: string; - /** @example 1347 */ - number: number; - /** @example open */ - state: string; - /** @example true */ - locked: boolean; - /** @example new-feature */ - title: string; user: null | components["schemas"]["simple-user"]; - /** @example Please pull these awesome changes */ - body: string | null; - labels: { - /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: null | components["schemas"]["milestone"]; - /** @example too heated */ - active_lock_reason?: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - created_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - updated_at: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * @description The reaction to use + * @example heart + * @enum {string} */ - closed_at: string | null; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** * Format: date-time - * @example 2011-01-26T19:01:12Z + * @example 2016-05-20T20:09:31Z */ - merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: null | components["schemas"]["simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; - head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: null | components["schemas"]["simple-user"]; - }; - base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; + created_at: string; + }; + /** + * Branch Short + * @description Branch Short + */ + "branch-short": { + name: string; + commit: { sha: string; - user: null | components["schemas"]["simple-user"]; - }; - _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; + url: string; }; - author_association: components["schemas"]["author-association"]; - auto_merge: components["schemas"]["auto-merge"]; - /** - * @description Indicates whether or not the pull request is a draft. - * @example false - */ - draft?: boolean; + protected: boolean; }; /** Simple Commit Status */ "simple-commit-status": { @@ -35148,6 +38065,7 @@ export interface components { self: string; }; }[]; + encoding?: string; _links: { /** Format: uri */ git: string | null; @@ -35413,6 +38331,14 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -35431,6 +38357,9 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; }; /** * Dependabot Secret @@ -36094,7 +39023,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -36164,7 +39093,7 @@ export interface components { "git-tree": { sha: string; /** Format: uri */ - url: string; + url?: string; truncated: boolean; /** * @description Objects specifying a tree structure @@ -36174,46 +39103,18 @@ export interface components { * "type": "blob", * "size": 30, * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" - * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" - * ] + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" * } */ tree: { /** @example test/file.rb */ - path?: string; + path: string; /** @example 040000 */ - mode?: string; + mode: string; /** @example tree */ - type?: string; + type: string; /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha: string; /** @example 12 */ size?: number; /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ @@ -36286,6 +39187,22 @@ export interface components { deliveries_url?: string; last_response: components["schemas"]["hook-response"]; }; + /** + * Check immutable releases + * @description Check immutable releases + */ + "check-immutable-releases": { + /** + * @description Whether immutable releases are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether immutable releases are enforced by the repository owner. + * @example false + */ + enforced_by_owner: boolean; + }; /** * Import * @description A repository import from an external source. @@ -36744,46 +39661,6 @@ export interface components { * @description Issue Event for Issue */ "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; - /** - * Label - * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). - */ - label: { - /** - * Format: int64 - * @description Unique identifier for the label. - * @example 208045946 - */ - id: number; - /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; - /** - * Format: uri - * @description URL for the label - * @example https://api.github.com/repositories/42/labels/bug - */ - url: string; - /** - * @description The name of the label. - * @example bug - */ - name: string; - /** - * @description Optional description of the label, such as its purpose. - * @example Something isn't working - */ - description: string | null; - /** - * @description 6-character hex code, without the leading #, identifying the color - * @example FFFFFF - */ - color: string; - /** - * @description Whether this label comes by default in a new repository. - * @example true - */ - default: boolean; - }; /** * Timeline Comment Event * @description Timeline Comment Event @@ -36828,6 +39705,7 @@ export interface components { author_association: components["schemas"]["author-association"]; performed_via_github_app?: null | components["schemas"]["integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: null | components["schemas"]["pinned-issue-comment"]; }; /** * Timeline Cross Referenced Event @@ -36927,7 +39805,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -36973,6 +39851,8 @@ export interface components { }; /** Format: date-time */ submitted_at?: string; + /** Format: date-time */ + updated_at?: string | null; /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 @@ -37044,7 +39924,7 @@ export interface components { * @example 8 */ in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + user: null | components["schemas"]["simple-user"]; /** * @description The text of the comment. * @example We should probably include a check for null values here. @@ -37224,6 +40104,7 @@ export interface components { created_at: string; read_only: boolean; added_by?: string | null; + /** Format: date-time */ last_used?: string | null; enabled?: boolean; }; @@ -37836,93 +40717,11 @@ export interface components { * @example 2 */ original_start_line?: number | null; - }; - /** - * Release Asset - * @description Data related to a release. - */ - "release-asset": { - /** Format: uri */ - url: string; - /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; /** - * @description The file name of the asset. - * @example Team Environment - */ - name: string; - label: string | null; - /** - * @description State of the release asset. + * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - uploader: null | components["schemas"]["simple-user"]; - }; - /** - * Release - * @description A release. - */ - release: { - /** Format: uri */ - url: string; - /** Format: uri */ - html_url: string; - /** Format: uri */ - assets_url: string; - upload_url: string; - /** Format: uri */ - tarball_url: string | null; - /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; - /** - * @description The name of the tag. - * @example v1.0.0 - */ - tag_name: string; - /** - * @description Specifies the commitish value that determines where the Git tag is created from. - * @example master - */ - target_commitish: string; - name: string | null; - body?: string | null; - /** - * @description true to create a draft (unpublished) release, false to create a published one. - * @example false - */ - draft: boolean; - /** - * @description Whether to identify the release as a prerelease or a full release. - * @example false - */ - prerelease: boolean; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; - /** - * Format: uri - * @description The URL of the release discussion. - */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; }; /** * Generated Release Notes Content @@ -37956,7 +40755,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -38014,174 +40813,17 @@ export interface components { 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`. */ + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: null | components["schemas"]["secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: null | components["schemas"]["simple-user"]; + }; + /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */ "secret-scanning-alert-resolution-comment": string | null; - /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { - /** - * @description The file path in the repository - * @example /example/secrets.txt - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** @description The API URL to get the associated blob resource */ - blob_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - commit_sha: string; - /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ - "secret-scanning-location-wiki-commit": { - /** - * @description The file path of the wiki page - * @example /example/Home.md - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** - * @description The GitHub URL to get the associated wiki page - * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - page_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_sha: string; - /** - * @description The GitHub URL to get the associated wiki commit - * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_url: string; - }; - /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ - "secret-scanning-location-issue-title": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_title_url: string; - }; - /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ - "secret-scanning-location-issue-body": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_body_url: string; - }; - /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ - "secret-scanning-location-issue-comment": { - /** - * Format: uri - * @description The API URL to get the issue comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - issue_comment_url: string; - }; - /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ - "secret-scanning-location-discussion-title": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082 - */ - discussion_title_url: string; - }; - /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ - "secret-scanning-location-discussion-body": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussion-4566270 - */ - discussion_body_url: string; - }; - /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ - "secret-scanning-location-discussion-comment": { - /** - * Format: uri - * @description The API URL to get the discussion comment where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 - */ - discussion_comment_url: string; - }; - /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ - "secret-scanning-location-pull-request-title": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_title_url: string; - }; - /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ - "secret-scanning-location-pull-request-body": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_body_url: string; - }; - /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ - "secret-scanning-location-pull-request-comment": { - /** - * Format: uri - * @description The API URL to get the pull request comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - pull_request_comment_url: string; - }; - /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ - "secret-scanning-location-pull-request-review": { - /** - * Format: uri - * @description The API URL to get the pull request review where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - */ - pull_request_review_url: string; - }; - /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ - "secret-scanning-location-pull-request-review-comment": { - /** - * Format: uri - * @description The API URL to get the pull request review comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - */ - pull_request_review_comment_url: string; - }; + /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */ + "secret-scanning-alert-assignee": string | null; "secret-scanning-location": { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. @@ -38474,22 +41116,6 @@ export interface components { tarball_url: string; node_id: string; }; - /** - * Tag protection - * @description Tag protection - */ - "tag-protection": { - /** @example 2 */ - id?: number; - /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - /** @example 2011-01-26T19:01:12Z */ - updated_at?: string; - /** @example true */ - enabled?: boolean; - /** @example v1.* */ - pattern: string; - }; /** * Topic * @description A topic aggregates entities that are related to a subject. @@ -38668,12 +41294,9 @@ export interface components { default?: boolean; description?: string | null; }[]; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; state: string; state_reason?: string | null; assignee: null | components["schemas"]["simple-user"]; @@ -38707,7 +41330,9 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: null | components["schemas"]["integration"]; + pinned_comment?: null | components["schemas"]["issue-comment"]; reactions?: components["schemas"]["reaction-rollup"]; }; /** @@ -38826,6 +41451,12 @@ export interface components { has_wiki: boolean; has_downloads: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -39431,6 +42062,8 @@ export interface components { created_at: string; verified: boolean; read_only: boolean; + /** Format: date-time */ + last_used?: string | null; }; /** Marketplace Account */ "marketplace-account": { @@ -39503,45 +42136,6 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; - /** - * Sigstore Bundle v0.1 - * @description Sigstore Bundle v0.1 - */ - "sigstore-bundle-0": { - mediaType?: string; - verificationMaterial?: { - x509CertificateChain?: { - certificates?: { - rawBytes?: string; - }[]; - }; - tlogEntries?: { - logIndex?: string; - logId?: { - keyId?: string; - }; - kindVersion?: { - kind?: string; - version?: string; - }; - integratedTime?: string; - inclusionPromise?: { - signedEntryTimestamp?: string; - }; - inclusionProof?: string | null; - canonicalizedBody?: string; - }[]; - timestampVerificationData?: string | null; - }; - dsseEnvelope?: { - payload?: string; - payloadType?: string; - signatures?: { - sig?: string; - keyid?: string; - }[]; - }; - }; /** * Hovercard * @description Hovercard @@ -39559,6 +42153,114 @@ export interface components { "key-simple": { id: number; key: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + last_used?: string | null; + }; + "billing-premium-request-usage-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report-user": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; /** * Enterprise @@ -39910,6 +42612,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -40268,7 +42981,7 @@ export interface components { * @description A check performed on the code of a given code change */ "check-run-with-simple-check-suite": { - app: null | components["schemas"]["integration"]; + app: components["schemas"]["integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** * Format: date-time @@ -40551,153 +43264,6 @@ export interface components { user_view_type?: string; } | null; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; - /** User */ - answer_chosen_by: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - answer_html_url: string | null; - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - category: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; - /** Format: date-time */ - created_at: string; - html_url: string; - id: number; - locked: boolean; - node_id: string; - number: number; - /** Reactions */ - reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; - timeline_url?: string; - title: string; - /** Format: date-time */ - updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - labels?: components["schemas"]["label"][]; - }; webhooks_comment: { /** * AuthorAssociation @@ -40898,6 +43464,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + pin?: null | components["schemas"]["pinned-issue-comment"]; }; /** @description The changes to the comment. */ webhooks_changes: { @@ -41226,8 +43793,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -41265,12 +43830,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41281,6 +43844,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -41720,8 +44284,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -41759,12 +44321,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -41775,6 +44335,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -41960,6 +44521,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -41975,6 +44551,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Merge Group @@ -42071,6 +44662,18 @@ export interface components { /** Format: uri */ organization_url: string; role: string; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example ent:team-one + * @example ent:team-two + */ + enterprise_teams_providing_indirect_membership?: string[]; state: string; /** Format: uri */ url: string; @@ -42334,42 +44937,6 @@ export interface components { /** Format: uri */ url: string; }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - "projects-v2": { - id: number; - node_id: string; - owner: components["schemas"]["simple-user"]; - creator: components["schemas"]["simple-user"]; - title: string; - description: string | null; - public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - updated_at: string; - number: number; - short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - deleted_at: string | null; - deleted_by: null | components["schemas"]["simple-user"]; - }; webhooks_project_changes: { archived_at?: { /** Format: date-time */ @@ -42378,35 +44945,36 @@ export interface components { to?: string | null; }; }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; /** * Projects v2 Item * @description An item belonging to a project */ "projects-v2-item": { + /** @description The unique identifier of the project item. */ id: number; + /** @description The node ID of the project item. */ node_id?: string; + /** @description The node ID of the project that contains this item. */ project_node_id?: string; + /** @description The node ID of the content represented by this item. */ content_node_id: string; content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the item was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the item was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; /** * Format: date-time + * @description The time when the item was archived. * @example 2022-04-28T12:00:00Z */ archived_at: string | null; @@ -42416,9 +44984,13 @@ export interface components { * @description An option for a single select field */ "projects-v2-single-select-option": { + /** @description The unique identifier of the option. */ id: string; + /** @description The display name of the option. */ name: string; + /** @description The color associated with the option. */ color?: string | null; + /** @description A short description of the option. */ description?: string | null; }; /** @@ -42426,47 +44998,18 @@ export interface components { * @description An iteration setting for an iteration field */ "projects-v2-iteration-setting": { + /** @description The unique identifier of the iteration setting. */ id: string; + /** @description The iteration title. */ title: string; + /** @description The iteration title, rendered as HTML. */ + title_html?: string; + /** @description The duration of the iteration in days. */ duration?: number | null; + /** @description The start date of the iteration. */ start_date?: string | null; - }; - /** - * Projects v2 Status Update - * @description An status update belonging to a project - */ - "projects-v2-status-update": { - id: number; - node_id: string; - project_node_id?: string; - creator?: components["schemas"]["simple-user"]; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - updated_at: string; - /** @enum {string|null} */ - status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; - /** - * Format: date - * @example 2022-04-28 - */ - start_date?: string; - /** - * Format: date - * @example 2022-04-28 - */ - target_date?: string; - /** - * @description Body of the status update - * @example The project is off to a great start! - */ - body?: string | null; + /** @description Whether the iteration has been completed. */ + completed?: boolean; }; /** @description The pull request number. */ webhooks_number: number; @@ -42814,6 +45357,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -43160,6 +45713,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -43895,6 +46458,8 @@ export interface components { state: string; /** Format: date-time */ submitted_at: string | null; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -43954,6 +46519,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -44044,6 +46610,8 @@ export interface components { body: string | null; /** Format: date-time */ created_at: string | null; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ @@ -44051,6 +46619,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -44102,6 +46672,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -44199,6 +46770,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -44225,6 +46798,8 @@ export interface components { tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri-template */ upload_url: string; /** Format: uri */ @@ -44292,7 +46867,7 @@ export interface components { number: number; severity: string; /** @enum {string} */ - state: "open"; + state: "auto_dismissed" | "open"; }; /** * @description The reason for resolving the alert. @@ -44353,6 +46928,7 @@ export interface components { publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ multi_repo?: boolean | null; + assigned_to?: null | components["schemas"]["simple-user"]; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -44576,6 +47152,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -44594,6 +47185,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** branch protection configuration disabled event */ "webhook-branch-protection-configuration-disabled": { @@ -44694,6 +47300,7 @@ export interface components { action?: "completed"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -44712,6 +47319,7 @@ export interface components { action?: "created"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -44730,6 +47338,7 @@ export interface components { action: "requested_action"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; /** @description The action requested by the user. */ @@ -44753,6 +47362,7 @@ export interface components { action?: "rerequested"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -44898,8 +47508,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45082,12 +47690,18 @@ export interface components { /** @enum {string} */ administration?: "read" | "write"; /** @enum {string} */ + artifact_metadata?: "read" | "write"; + /** @enum {string} */ + attestations?: "read" | "write"; + /** @enum {string} */ checks?: "read" | "write"; /** @enum {string} */ content_references?: "read" | "write"; /** @enum {string} */ contents?: "read" | "write"; /** @enum {string} */ + copilot_requests?: "write"; + /** @enum {string} */ deployments?: "read" | "write"; /** @enum {string} */ discussions?: "read" | "write"; @@ -45102,8 +47716,12 @@ export interface components { /** @enum {string} */ members?: "read" | "write"; /** @enum {string} */ + merge_queues?: "read" | "write"; + /** @enum {string} */ metadata?: "read" | "write"; /** @enum {string} */ + models?: "read" | "write"; + /** @enum {string} */ organization_administration?: "read" | "write"; /** @enum {string} */ organization_hooks?: "read" | "write"; @@ -45142,8 +47760,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45326,12 +47942,18 @@ export interface components { /** @enum {string} */ administration?: "read" | "write"; /** @enum {string} */ + artifact_metadata?: "read" | "write"; + /** @enum {string} */ + attestations?: "read" | "write"; + /** @enum {string} */ checks?: "read" | "write"; /** @enum {string} */ content_references?: "read" | "write"; /** @enum {string} */ contents?: "read" | "write"; /** @enum {string} */ + copilot_requests?: "write"; + /** @enum {string} */ deployments?: "read" | "write"; /** @enum {string} */ discussions?: "read" | "write"; @@ -45346,8 +47968,12 @@ export interface components { /** @enum {string} */ members?: "read" | "write"; /** @enum {string} */ + merge_queues?: "read" | "write"; + /** @enum {string} */ metadata?: "read" | "write"; /** @enum {string} */ + models?: "read" | "write"; + /** @enum {string} */ organization_administration?: "read" | "write"; /** @enum {string} */ organization_hooks?: "read" | "write"; @@ -45386,8 +48012,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45503,6 +48127,7 @@ export interface components { action: "appeared_in_branch"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -45633,6 +48258,7 @@ export interface components { action: "closed_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -45755,129 +48381,170 @@ export interface components { }; /** Format: uri */ url: string; - }; - commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - ref: components["schemas"]["webhooks_code_scanning_ref"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** code_scanning_alert created event */ - "webhook-code-scanning-alert-created": { - /** @enum {string} */ - action: "created"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: null; - dismissed_by: null; - dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: null; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - fixed_at?: null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - instances_url?: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. - * @enum {string|null} - */ - state: "open" | "dismissed" | null; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - } | null; - updated_at?: string | null; - /** Format: uri */ - url: string; - }; - commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - ref: components["schemas"]["webhooks_code_scanning_ref"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** code_scanning_alert fixed event */ - "webhook-code-scanning-alert-fixed": { - /** @enum {string} */ - action: "fixed"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; /** User */ - dismissed_by: { + dismissal_approved_by?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** code_scanning_alert created event */ + "webhook-code-scanning-alert-created": { + /** @enum {string} */ + action: "created"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string | null; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: null; + dismissed_by: null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + instances_url?: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | null; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + } | null; + updated_at?: string | null; + /** Format: uri */ + url: string; + dismissal_approved_by?: null; + assignees?: components["schemas"]["simple-user"][]; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** code_scanning_alert fixed event */ + "webhook-code-scanning-alert-fixed": { + /** @enum {string} */ + action: "fixed"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46005,6 +48672,7 @@ export interface components { action: "reopened"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -46023,6 +48691,7 @@ export interface components { * @description The GitHub URL of the alert resource. */ html_url: string; + instances_url?: string; /** Alert Instance */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ @@ -46082,9 +48751,11 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; + updated_at?: string | null; /** Format: uri */ url: string; - } | null; + dismissal_approved_by?: null; + }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -46101,6 +48772,7 @@ export interface components { action: "reopened_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -46182,6 +48854,135 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** code_scanning_alert updated_assignment event */ + "webhook-code-scanning-alert-updated-assignment": { + /** @enum {string} */ + action: "updated_assignment"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | "fixed" | null; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + 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"]; + }; /** commit_comment created event */ "webhook-commit-comment-created": { /** @@ -46319,6 +49120,16 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** custom property promoted to business event */ + "webhook-custom-property-promoted-to-enterprise": { + /** @enum {string} */ + action: "promote_to_enterprise"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ @@ -46358,6 +49169,17 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** Dependabot alert assignees changed event */ + "webhook-dependabot-alert-assignees-changed": { + /** @enum {string} */ + action: "assignees_changed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { /** @enum {string} */ @@ -46635,8 +49457,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -46956,12 +49776,16 @@ export interface components { environment?: string; /** @description The event that triggered the deployment protection rule. */ event?: string; + /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + sha?: string; + /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + ref?: string; /** * Format: uri * @description The URL to review the deployment protection rule. */ deployment_callback_url?: string; - deployment?: components["schemas"]["deployment"]; + deployment?: null | components["schemas"]["deployment"]; pull_requests?: components["schemas"]["pull-request"][]; repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -48140,8 +50964,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -48340,8 +51162,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49485,6 +52305,7 @@ export interface components { * @description URL for the issue comment */ url: string; + pin?: null | components["schemas"]["pinned-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -49844,8 +52665,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49883,12 +52702,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49899,6 +52714,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -50388,8 +53204,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -50427,12 +53241,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50443,6 +53253,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -50934,8 +53745,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -50973,12 +53782,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50989,6 +53794,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -51154,31 +53960,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "closed"; + /** issue_comment pinned event */ + "webhook-issue-comment-pinned": { + /** @enum {string} */ + action: "pinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -51380,7 +54169,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -51465,7 +54254,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -51534,12 +54323,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51550,6 +54335,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -51598,20 +54384,71 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; assignees?: (Record | null)[]; author_association?: string; body?: string | null; - closed_at: string | null; + closed_at?: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; labels_url?: string; - locked?: boolean; + locked: boolean; milestone?: Record | null; node_id?: string; number?: number; @@ -51629,8 +54466,11 @@ export interface components { url?: string; }; repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; timeline_url?: string; title?: string; updated_at?: string; @@ -51662,16 +54502,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issue_comment unpinned event */ + "webhook-issue-comment-unpinned": { /** @enum {string} */ - action: "deleted"; + action: "unpinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -51708,7 +54546,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -51745,9 +54583,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -51832,7 +54671,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -51872,7 +54711,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -52026,12 +54865,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -52042,6 +54877,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52083,31 +54919,15 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; - }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { - /** @enum {string} */ - action: "demilestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } & { + active_lock_reason?: string | null; /** User */ - assignee?: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52142,8 +54962,182 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - assignees: ({ + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** blocked by issue added event */ + "webhook-issue-dependencies-blocked-by-added": { + /** @enum {string} */ + action: "blocked_by_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocked by issue removed event */ + "webhook-issue-dependencies-blocked-by-removed": { + /** @enum {string} */ + action: "blocked_by_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue added event */ + "webhook-issue-dependencies-blocking-added": { + /** @enum {string} */ + action: "blocking_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue removed event */ + "webhook-issue-dependencies-blocking-removed": { + /** @enum {string} */ + action: "blocking_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52178,6 +55172,44 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52201,7 +55233,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -52215,7 +55247,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -52302,7 +55334,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -52417,8 +55449,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -52456,12 +55486,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -52472,6 +55500,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52518,27 +55547,76 @@ export interface components { url?: string; user_view_type?: string; } | null; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels?: (Record | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** @enum {string} */ + state: "closed" | "open"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; }; - milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - title?: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -52581,7 +55659,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -52618,9 +55696,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -52705,7 +55784,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -52745,7 +55824,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -52830,7 +55909,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -52860,8 +55939,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -52899,12 +55976,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -52915,6 +55990,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52956,21 +56032,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** 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"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "labeled"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -53016,7 +56091,6 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53076,7 +56150,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -53090,7 +56164,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -53177,7 +56251,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -53292,8 +56366,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -53331,12 +56403,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -53347,6 +56417,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -53394,15 +56465,26 @@ export interface components { user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "locked"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -53445,7 +56527,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -53482,10 +56564,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -53509,7 +56590,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -53523,11 +56604,10 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -53571,7 +56651,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -53611,7 +56691,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -53696,7 +56776,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -53726,8 +56806,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -53765,12 +56843,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -53779,6 +56855,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -53822,20 +56899,21 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; }; - /** issues milestoned event */ - "webhook-issues-milestoned": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "milestoned"; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -53878,9 +56956,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -53914,7 +56993,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -53940,7 +57019,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -53954,7 +57033,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -54041,7 +57120,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -54156,8 +57235,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -54195,12 +57272,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -54209,6 +57284,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -54252,31 +57328,158 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - milestone: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues opened event */ - "webhook-issues-opened": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "opened"; - changes?: { + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - old_issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + /** @enum {boolean} */ + locked: true; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; /** User */ - assignee?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54313,7 +57516,738 @@ export interface components { url?: string; user_view_type?: string; } | null; - assignees: ({ + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + /** @description Title of the issue */ + title: string; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues milestoned event */ + "webhook-issues-milestoned": { + /** @enum {string} */ + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; + type?: components["schemas"]["issue-type"]; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues opened event */ + "webhook-issues-opened": { + /** @enum {string} */ + action: "opened"; + changes?: { + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + old_issue: { + /** @enum {string|null} */ + active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54355,21 +58289,21 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - body: string | null; + body?: string | null; /** Format: date-time */ - closed_at: string | null; - comments: number; + closed_at?: string | null; + comments?: number; /** Format: uri */ - comments_url: string; + comments_url?: string; /** Format: date-time */ - created_at: string; + created_at?: string; draft?: boolean; /** Format: uri */ - events_url: string; + events_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: int64 */ id: number; labels?: { @@ -54388,13 +58322,13 @@ export interface components { url: string; }[]; /** Format: uri-template */ - labels_url: string; + labels_url?: string; locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - milestone: { + milestone?: { /** Format: date-time */ closed_at: string | null; closed_issues: number; @@ -54462,7 +58396,7 @@ export interface components { /** Format: uri */ url: string; } | null; - node_id: string; + node_id?: string; number: number; /** * App @@ -54588,8 +58522,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -54612,7 +58544,7 @@ export interface components { url?: string; }; /** Reactions */ - reactions: { + reactions?: { "+1": number; "-1": number; confused: number; @@ -54626,13 +58558,10 @@ export interface components { url: string; }; /** Format: uri */ - repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + repository_url?: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -54642,16 +58571,17 @@ export interface components { /** Format: uri */ timeline_url?: string; /** @description Title of the issue */ - title: string; + title?: string; /** Format: date-time */ - updated_at: string; + updated_at?: string; /** * Format: uri * @description URL for the issue */ - url: string; + url?: string; + pinned_comment?: null | components["schemas"]["issue-comment"]; /** User */ - user: { + user?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54689,6 +58619,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; } | null; /** * Repository @@ -54782,6 +58713,16 @@ export interface components { git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether downloads are enabled. * @default true @@ -55260,8 +59201,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -55299,12 +59238,9 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -55315,6 +59251,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -55322,6 +59259,7 @@ export interface components { * @description URL for the issue */ url: string; + pinned_comment?: null | components["schemas"]["issue-comment"]; /** User */ user: { /** Format: uri */ @@ -55701,8 +59639,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -55740,12 +59676,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -55802,6 +59736,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -56132,8 +60067,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -56171,12 +60104,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -56187,6 +60118,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -56350,6 +60282,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -56492,6 +60434,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues typed event */ + "webhook-issues-typed": { + /** @enum {string} */ + action: "typed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** issues unassigned event */ "webhook-issues-unassigned": { /** @@ -56846,8 +60800,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -56885,12 +60837,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: null | components["schemas"]["issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -56901,6 +60851,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -56963,6 +60914,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues untyped event */ + "webhook-issues-untyped": { + /** @enum {string} */ + action: "untyped"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** label created event */ "webhook-label-created": { /** @enum {string} */ @@ -57350,7 +61313,7 @@ export interface components { /** @enum {string} */ action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ hook: { active: boolean; config: { @@ -59077,6 +63040,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -59423,6 +63396,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60273,6 +64256,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; has_pages: boolean; /** * @description Whether projects are enabled. @@ -60630,6 +64623,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -61492,6 +65495,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -61838,6 +65851,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62733,6 +66756,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63079,6 +67112,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63973,6 +68016,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -64319,6 +68372,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65181,6 +69244,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65527,6 +69600,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -66388,6 +70471,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -66734,6 +70827,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67787,6 +71890,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -68126,6 +72239,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -68933,6 +73056,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69272,6 +73405,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70081,6 +74224,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70420,6 +74573,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71227,6 +75390,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71566,6 +75739,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -72105,6 +76288,8 @@ export interface components { state: "dismissed" | "approved" | "changes_requested"; /** Format: date-time */ submitted_at: string; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -73513,6 +77698,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73852,6 +78047,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74751,6 +78956,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75097,6 +79312,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76015,6 +80240,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76361,6 +80596,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -77260,6 +81505,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -77606,6 +81861,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -78520,6 +82785,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -78859,6 +83134,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79667,6 +83952,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79967,6 +84262,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80579,6 +84884,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request_review_thread unresolved event */ "webhook-pull-request-review-thread-unresolved": { @@ -80881,6 +85188,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81181,6 +85498,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81793,6 +86120,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request synchronize event */ "webhook-pull-request-synchronize": { @@ -82099,6 +86428,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -82445,6 +86784,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -83300,6 +87649,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -83646,6 +88005,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -84508,6 +88877,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -84854,6 +89233,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -85708,6 +90097,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -86054,6 +90453,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -86863,6 +91272,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -87369,6 +91788,10 @@ export interface components { /** @description The previous version of the name if the action was `edited`. */ from: string; }; + tag_name?: { + /** @description The previous version of the tag_name if the action was `edited`. */ + from: string; + }; make_latest?: { /** @description Whether this release was explicitly `edited` to be the latest. */ to: boolean; @@ -87406,6 +91829,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -87503,6 +91927,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @@ -87534,6 +91960,8 @@ export interface components { target_commitish: string; /** Format: uri-template */ upload_url: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ url: string; /** Format: uri */ @@ -88051,6 +92479,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert assigned event */ + "webhook-secret-scanning-alert-assigned": { + /** @enum {string} */ + action: "assigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 created event */ "webhook-secret-scanning-alert-created": { /** @enum {string} */ @@ -88111,6 +92551,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert unassigned event */ + "webhook-secret-scanning-alert-unassigned": { + /** @enum {string} */ + action: "unassigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 validated event */ "webhook-secret-scanning-alert-validated": { /** @enum {string} */ @@ -88440,7 +92892,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; - verified_at?: string | null; + verified_at: string | null; }; }; /** User */ @@ -91563,6 +96015,334 @@ export interface components { display_title: string; }; }; + /** CreateEvent */ + "create-event": { + ref: string; + ref_type: string; + full_ref: string; + master_branch: string; + description?: string | null; + pusher_type: string; + }; + /** DeleteEvent */ + "delete-event": { + ref: string; + ref_type: string; + full_ref: string; + pusher_type: string; + }; + /** DiscussionEvent */ + "discussion-event": { + action: string; + discussion: components["schemas"]["discussion"]; + }; + /** IssuesEvent */ + "issues-event": { + action: string; + issue: components["schemas"]["issue"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** IssueCommentEvent */ + "issue-comment-event": { + action: string; + issue: components["schemas"]["issue"]; + comment: components["schemas"]["issue-comment"]; + }; + /** ForkEvent */ + "fork-event": { + action: string; + forkee: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + private?: boolean; + owner?: components["schemas"]["simple-user"]; + html_url?: string; + description?: string | null; + fork?: boolean; + url?: string; + forks_url?: string; + keys_url?: string; + collaborators_url?: string; + teams_url?: string; + hooks_url?: string; + issue_events_url?: string; + events_url?: string; + assignees_url?: string; + branches_url?: string; + tags_url?: string; + blobs_url?: string; + git_tags_url?: string; + git_refs_url?: string; + trees_url?: string; + statuses_url?: string; + languages_url?: string; + stargazers_url?: string; + contributors_url?: string; + subscribers_url?: string; + subscription_url?: string; + commits_url?: string; + git_commits_url?: string; + comments_url?: string; + issue_comment_url?: string; + contents_url?: string; + compare_url?: string; + merges_url?: string; + archive_url?: string; + downloads_url?: string; + issues_url?: string; + pulls_url?: string; + milestones_url?: string; + notifications_url?: string; + labels_url?: string; + releases_url?: string; + deployments_url?: string; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + /** Format: date-time */ + pushed_at?: string | null; + git_url?: string; + ssh_url?: string; + clone_url?: string; + svn_url?: string; + homepage?: string | null; + size?: number; + stargazers_count?: number; + watchers_count?: number; + language?: string | null; + has_issues?: boolean; + has_projects?: boolean; + has_downloads?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + forks_count?: number; + mirror_url?: string | null; + archived?: boolean; + disabled?: boolean; + open_issues_count?: number; + license?: null | components["schemas"]["license-simple"]; + allow_forking?: boolean; + is_template?: boolean; + web_commit_signoff_required?: boolean; + topics?: string[]; + visibility?: string; + forks?: number; + open_issues?: number; + watchers?: number; + default_branch?: string; + public?: boolean; + }; + }; + /** GollumEvent */ + "gollum-event": { + pages: { + page_name?: string | null; + title?: string | null; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + /** MemberEvent */ + "member-event": { + action: string; + member: components["schemas"]["simple-user"]; + }; + /** PublicEvent */ + "public-event": Record; + /** PushEvent */ + "push-event": { + repository_id: number; + push_id: number; + ref: string; + head: string; + before: string; + }; + /** PullRequestEvent */ + "pull-request-event": { + action: string; + number: number; + pull_request: components["schemas"]["pull-request-minimal"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** PullRequestReviewCommentEvent */ + "pull-request-review-comment-event": { + action: string; + pull_request: components["schemas"]["pull-request-minimal"]; + comment: { + id: number; + node_id: string; + /** Format: uri */ + url: string; + pull_request_review_id: number | null; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + subject_type?: string | null; + commit_id: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + body: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + pull_request_url: string; + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + original_commit_id: string; + /** Reactions */ + reactions: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + /** Format: uri */ + url?: string; + }; + in_reply_to_id?: number; + }; + }; + /** PullRequestReviewEvent */ + "pull-request-review-event": { + action: string; + review: { + id?: number; + node_id?: string; + user?: null | components["schemas"]["simple-user"]; + body?: string; + commit_id?: string; + submitted_at?: string | null; + state?: string; + /** Format: uri */ + html_url?: string; + /** Format: uri */ + pull_request_url?: string; + _links?: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + updated_at?: string; + }; + pull_request: components["schemas"]["pull-request-minimal"]; + }; + /** CommitCommentEvent */ + "commit-comment-event": { + action: string; + comment: { + /** Format: uri */ + html_url?: string; + /** Format: uri */ + url?: string; + id?: number; + node_id?: string; + body?: string; + path?: string | null; + position?: number | null; + line?: number | null; + commit_id?: string; + user?: null | components["schemas"]["simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + }; + /** ReleaseEvent */ + "release-event": { + action: string; + release: components["schemas"]["release"] & { + is_short_description_html_truncated?: boolean; + short_description_html?: string; + }; + }; + /** WatchEvent */ + "watch-event": { + action: string; + }; }; responses: { /** @description Validation failed, or the endpoint has been spammed. */ @@ -91636,6 +96416,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + internal_error: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Conflict */ conflict: { headers: { @@ -91691,6 +96480,42 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting all budgets */ + get_all_budgets: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get_all_budgets"]; + }; + }; + /** @description Response when updating a budget */ + budget: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get-budget"]; + }; + }; + /** @description Response when deleting a budget */ + "delete-budget": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["delete-budget"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-org"]; + }; + }; /** @description Billing usage report response for an organization */ billing_usage_report_org: { headers: { @@ -91700,13 +96525,13 @@ export interface components { "application/json": components["schemas"]["billing-usage-report"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_org: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-summary-report-org"]; }; }; /** @description Response */ @@ -91746,6 +96571,15 @@ export interface components { }; }; }; + /** @description Payload Too Large */ + too_large: { + headers: { + [name: string]: unknown; + }; + content: { + "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: { @@ -91762,8 +96596,15 @@ export interface components { }; content?: never; }; - /** @description Gone */ - gone: { + /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */ + enterprise_team_unsupported: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Temporary Redirect */ + temporary_redirect: { headers: { [name: string]: unknown; }; @@ -91771,8 +96612,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Temporary Redirect */ - temporary_redirect: { + /** @description Gone */ + gone: { headers: { [name: string]: unknown; }; @@ -91816,6 +96657,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if analysis could not be processed */ + unprocessable_analysis: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -91832,7 +96682,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ + /** @description Response if the configuration change cannot be made because the repository is not in the required state */ + code_scanning_invalid_state: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */ dependency_review_forbidden: { headers: { [name: string]: unknown; @@ -91859,6 +96718,33 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-summary-report-user"]; + }; + }; }; parameters: { /** @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)." */ @@ -91887,7 +96773,7 @@ export interface components { "assignment-id": number; /** @description The unique identifier of the classroom. */ "classroom-id": number; - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: string; /** @description The unique identifier of the code security configuration. */ "configuration-id": number; @@ -91920,6 +96806,17 @@ export interface components { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ "dependabot-alert-comma-separated-epss": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + "dependabot-alert-comma-separated-has": string | "patch"[]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + "dependabot-alert-comma-separated-assignees": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @@ -91929,32 +96826,16 @@ export interface components { * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first": number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last": number; - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "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 version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": string; + /** @description The handle for the GitHub user account. */ + username: string; + /** @description The organization name. The name is not case sensitive. */ + org: string; + /** @description The slug of the team name. */ + "team-slug": string; + /** @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)." */ + "public-events-per-page": number; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -91981,16 +96862,30 @@ export interface components { "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org": number; - /** @description The organization name. The name is not case sensitive. */ - org: string; - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description The ID corresponding to the budget. */ + budget: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ "billing-usage-report-year": number; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - "billing-usage-report-month": number; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + "billing-usage-report-month-default": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ "billing-usage-report-day": number; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - "billing-usage-report-hour": number; + /** @description The user name to query usage for. The name is not case sensitive. */ + "billing-usage-report-user": string; + /** @description The model name to query usage for. The name is not case sensitive. */ + "billing-usage-report-model": string; + /** @description The product name to query usage for. The name is not case sensitive. */ + "billing-usage-report-product": string; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + "billing-usage-report-month": number; + /** @description The repository name to query for usage in the format owner/repository. */ + "billing-usage-report-repository": string; + /** @description The SKU to query for usage. */ + "billing-usage-report-sku": string; + /** @description Image definition ID of custom image */ + "actions-custom-image-definition-id": number; + /** @description Version of a custom image */ + "actions-custom-image-version": string; /** @description Unique identifier of the GitHub-hosted runner. */ "hosted-runner-id": number; /** @description The unique identifier of the repository. */ @@ -92009,12 +96904,31 @@ export interface components { "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; - /** @description The handle for the GitHub user account. */ - username: string; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + "subject-digest": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + "dependabot-alert-comma-separated-artifact-registry-urls": string; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + "dependabot-alert-comma-separated-artifact-registry": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + "dependabot-alert-comma-separated-runtime-risk": string; /** @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 */ @@ -92041,14 +96955,14 @@ export interface components { "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ "codespace-name": string; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @@ -92076,8 +96990,18 @@ export interface components { "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "personal-access-token-after": string; + /** @description The ID of the token */ + "personal-access-token-token-id": string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The project's number. */ + "project-number": number; + /** @description The unique identifier of the field. */ + "field-id": number; + /** @description The unique identifier of the project item. */ + "item-id": number; + /** @description The number that identifies the project view. */ + "view-number": number; /** @description The custom property name */ "custom-property-name": string; /** @@ -92093,12 +97017,12 @@ export interface components { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ "actor-name-in-query": string; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ "rule-suite-result": "pass" | "fail" | "bypass" | "all"; /** * @description The unique identifier of the rule suite result. @@ -92107,22 +97031,32 @@ export interface components { * for organizations. */ "rule-suite-id": number; + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + "secret-scanning-alert-resolution": string; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + "secret-scanning-alert-assignee": string; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + "secret-scanning-alert-sort": "created" | "updated"; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ "secret-scanning-pagination-before-org-repo": string; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @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 A boolean value representing whether or not to hide literal secrets in the results. */ + "secret-scanning-alert-hide-secret": boolean; /** @description Unique identifier of the hosted compute network configuration. */ "network-configuration-id": string; /** @description Unique identifier of the hosted compute network settings. */ "network-settings-id": string; - /** @description The number that identifies the discussion. */ - "discussion-number": number; - /** @description The number that identifies the comment. */ - "comment-number": number; - /** @description The unique identifier of the reaction. */ - "reaction-id": number; - /** @description The unique identifier of the project. */ - "project-id": number; /** @description The security feature to enable or disable. */ "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; /** @@ -92132,10 +97066,6 @@ export interface components { * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; - /** @description The unique identifier of the card. */ - "card-id": number; - /** @description The unique identifier of the column. */ - "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ "artifact-name": string; /** @description The unique identifier of the artifact. */ @@ -92192,6 +97122,8 @@ export interface components { "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 unique identifier of the reaction. */ + "reaction-id": number; /** @description The SHA of the commit. */ "commit-sha": string; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ @@ -92238,14 +97170,17 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The unique identifier of the tag protection. */ - "tag-protection-id": number; /** @description The time frame to display results for. */ per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ "since-repo": number; /** @description 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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + "issues-advanced-search": string; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ @@ -92262,6 +97197,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred": "created" | "updated"; + /** @description The unique identifier of the user. */ + "user-id": string; }; requestBodies: never; headers: { @@ -92329,7 +97266,7 @@ export interface operations { * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; /** @@ -93173,6 +98110,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of credentials to be revoked, up to 1000 per request. */ + credentials: string[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; + }; + }; "emojis/get": { parameters: { query?: never; @@ -93196,6 +98154,112 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "actions/get-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "code-security/get-configurations-for-enterprise": { parameters: { query?: { @@ -93208,7 +98272,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -93233,7 +98297,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -93246,11 +98310,19 @@ export interface operations { /** @description A description of the code security configuration */ description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled @@ -93283,6 +98355,7 @@ export interface operations { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled @@ -93290,6 +98363,17 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled @@ -93314,6 +98398,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -93349,7 +98451,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -93372,7 +98474,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -93400,7 +98502,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -93421,7 +98523,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -93436,10 +98538,18 @@ export interface operations { /** @description A description of the code security configuration */ description?: string; /** - * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -93471,6 +98581,18 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -93491,6 +98613,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -93525,7 +98665,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -93536,7 +98676,7 @@ export interface operations { content: { "application/json": { /** - * @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` + * @description The type of repositories to attach the configuration to. * @enum {string} */ scope: "all" | "all_without_configurations"; @@ -93555,7 +98695,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -93612,7 +98752,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -93666,6 +98806,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -93681,24 +98832,12 @@ export interface operations { 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -93720,35 +98859,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - "secret-scanning/list-alerts-for-enterprise": { + "enterprise-teams/list": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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 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 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"]; + /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -93762,14 +98883,239 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["enterprise-team"][]; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-public-events": { + "enterprise-teams/create": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description A description of the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be set. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + }; + }; + "enterprise-team-memberships/list": { + 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 slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to add to the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully added team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to be removed from the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully removed team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User is a member of the enterprise team. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully added team member */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-team-organizations/get-assignments": { 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)." */ @@ -93778,6 +99124,290 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description An array of organizations the team is assigned to */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to assign the team to. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully assigned the enterprise team to organizations. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to unassign the team from. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully unassigned the enterprise team from organizations. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/get-assignment": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The team is assigned to the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + /** @description The team is not assigned to the organization */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully assigned the enterprise team to the organization. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + }; + }; + "enterprise-team-organizations/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully unassigned the enterprise team from the organization. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-teams/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A new name for the team. */ + name?: string | null; + /** @description A new description for the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be changed. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/list-public-events": { + 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"]["public-events-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?: never; cookie?: never; }; @@ -95221,17 +100851,425 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "actions/get-actions-cache-retention-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-retention-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-organization": { + 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": components["schemas"]["actions-cache-retention-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-storage-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-organization": { + 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": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/repository-access-for-org": { + parameters: { + query?: { + /** @description The page number of results to fetch. */ + page?: number; + /** @description Number of results per page. */ + 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"]["dependabot-repository-access-details"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/update-repository-access-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 List of repository IDs to add. */ + repository_ids_to_add?: number[]; + /** @description List of repository IDs to remove. */ + repository_ids_to_remove?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/set-repository-access-default-level": { + 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 The default repository access level for Dependabot updates. + * @example internal + * @enum {string} + */ + default_level: "public" | "internal"; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "billing/get-all-budgets-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_all_budgets"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "billing/get-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/delete-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete-budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/update-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert?: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients?: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** @description The name of the entity to apply the budget to */ + budget_entity_name?: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + responses: { + /** @description Budget updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Budget successfully updated. */ + message?: string; + budget?: { + /** @description ID of the budget. */ + id?: string; + /** + * Format: float + * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. + */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @default + */ + budget_entity_name: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Budget not found or feature not enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "billing/get-github-billing-premium-request-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The user name to query usage for. The name is not case sensitive. */ + user?: components["parameters"]["billing-usage-report-user"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "billing/get-github-billing-usage-report-org": { parameters: { query?: { - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ year?: components["parameters"]["billing-usage-report-year"]; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ month?: components["parameters"]["billing-usage-report-month"]; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ day?: components["parameters"]["billing-usage-report-day"]; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - hour?: components["parameters"]["billing-usage-report-hour"]; }; header?: never; path: { @@ -95249,6 +101287,38 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "billing/get-github-billing-usage-summary-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -95591,6 +101661,11 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** + * @description Whether this runner should be used to generate custom images. + * @default false + */ + image_gen?: boolean; }; }; }; @@ -95606,6 +101681,160 @@ export interface operations { }; }; }; + "actions/list-custom-images-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-custom-image"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image"]; + }; + }; + }; + }; + "actions/delete-custom-image-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-custom-image-versions-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @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; + image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"]; + }; + }; + }; + }; + "actions/delete-custom-image-version-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/get-hosted-runners-github-owned-images-for-org": { parameters: { query?: never; @@ -95626,7 +101855,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -95652,7 +101881,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -95807,6 +102036,10 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size?: string; + /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image_id?: string; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ image_version?: string | null; }; @@ -95914,6 +102147,7 @@ export interface operations { "application/json": { enabled_repositories: components["schemas"]["enabled-repositories"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -95927,6 +102161,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + 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"]["actions-artifact-and-log-retention-response"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-organization": { + 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": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-organization": { + 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": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-organization": { + 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": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { @@ -96080,6 +102480,184 @@ export interface operations { }; }; }; + "actions/get-self-hosted-runners-permissions-organization": { + parameters: { + query?: never; + 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"]["self-hosted-runners-settings"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-self-hosted-runners-permissions-organization": { + 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 The policy that controls whether self-hosted runners can be used in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-self-hosted-runners-organization": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-selected-repositories-self-hosted-runners-organization": { + 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 IDs of repositories that can use repository-level self-hosted runners */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/enable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/disable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { query?: never; @@ -96662,6 +103240,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -96757,6 +103336,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-org": { @@ -96964,9 +103544,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} @@ -97441,6 +104021,548 @@ export interface operations { }; }; }; + "orgs/create-artifact-deployment-record": { + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** @description The hex encoded digest of the artifact. */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * @description The status of the artifact. Can be either deployed or decommissioned. + * @enum {string} + */ + status: "deployed" | "decommissioned"; + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The deployment cluster. */ + cluster?: string; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a cluster, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + */ + deployment_name: string; + /** @description The tags associated with the deployment. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact deployment record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/set-cluster-deployment-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The cluster name. */ + cluster: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The list of deployments to record. */ + deployments: { + /** + * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name parameter must also be identical across all entries. + */ + name: string; + /** + * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name and version parameters must also be identical across all entries. + */ + digest: string; + /** + * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + * the version parameter must also be identical across all entries. + * @example 1.2.3 + */ + version?: string; + /** + * @description The deployment status of the artifact. + * @enum {string} + */ + status?: "deployed" | "decommissioned"; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a record set, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + * The deployment_name must be unique across all entries in the deployments array. + */ + deployment_name: string; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + /** @description Key-value pairs to tag the deployment record. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + }[]; + }; + }; + }; + responses: { + /** @description Deployment records created or updated successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/create-artifact-storage-record": { + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** + * @description The digest of the artifact (algorithm:hex-encoded-digest). + * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * Format: uri + * @description The URL where the artifact is stored. + * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3 + */ + artifact_url?: string; + /** + * Format: uri + * @description The path of the artifact. + * @example com/github/bar/libfoo-1.2.3 + */ + path?: string; + /** + * Format: uri + * @description The base URL of the artifact registry. + * @example https://reg.example.com/artifactory/ + */ + registry_url: string; + /** + * @description The repository name within the registry. + * @example bar + */ + repository?: string; + /** + * @description The status of the artifact (e.g., active, inactive). + * @default active + * @example active + * @enum {string} + */ + status?: "active" | "eol" | "deleted"; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact metadata storage record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example 1 */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string | null; + registry_url?: string; + repository?: string | null; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-artifact-deployment-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + subject_digest: components["parameters"]["subject-digest"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successful response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The number of deployment records for this digest and organization + * @example 3 + */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/list-artifact-storage-records": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** + * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** + * @description The number of storage records for this digest and organization + * @example 3 + */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string; + registry_url?: string; + repository?: string; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "orgs/delete-attestations-bulk": { + 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 List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/list-attestation-repositories": { + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + 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": { + id?: number; + name?: string; + }[]; + }; + }; + }; + }; + "orgs/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "orgs/list-attestations": { parameters: { query?: { @@ -97450,6 +104572,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -97482,9 +104610,10 @@ export interface operations { dsseEnvelope?: { [key: string]: unknown; }; - }; + } | null; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -97598,6 +104727,258 @@ export interface operations { }; }; }; + "campaigns/list-org-campaigns": { + 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"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description If specified, only campaigns with this state will be returned. */ + state?: components["schemas"]["campaign-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated" | "ends_at" | "published"; + }; + 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: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"][]; + }; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/create-campaign": { + 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 The name of the campaign */ + name: string; + /** @description A description for the campaign */ + description: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign. The date must be in the future. + */ + ends_at: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + /** @description The code scanning alerts to include in this campaign */ + code_scanning_alerts?: { + /** @description The repository id */ + repository_id: number; + /** @description The alert numbers */ + alert_numbers: number[]; + }[] | null; + /** + * @description If true, will automatically generate issues for the campaign. The default is false. + * @default false + */ + generate_issues?: boolean; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Too Many Requests */ + 429: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/get-campaign-summary": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/delete-campaign": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Deletion successful */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "campaigns/update-campaign": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the campaign */ + name?: string; + /** @description A description for the campaign */ + description?: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at?: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + state?: components["schemas"]["campaign-state"]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; + }; + }; "code-scanning/list-alerts-for-org": { parameters: { query?: { @@ -97621,6 +105002,11 @@ export interface operations { sort?: "created" | "updated"; /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; header?: never; path: { @@ -97697,11 +105083,19 @@ export interface operations { /** @description A description of the code security configuration */ description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled @@ -97734,6 +105128,13 @@ export interface operations { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @default disabled + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled @@ -97741,6 +105142,17 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default not_set + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled @@ -97784,6 +105196,22 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -97850,7 +105278,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository IDs to detach from configurations. */ + /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */ selected_repository_ids?: number[]; }; }; @@ -97932,10 +105360,18 @@ export interface operations { /** @description A description of the code security configuration */ description?: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -97961,12 +105397,29 @@ export interface operations { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of code scanning default setup * @enum {string} */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -98005,6 +105458,21 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -98844,18 +106312,9 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-organization": { + "copilot/copilot-content-exclusion-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; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -98865,31 +106324,73 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["copilot-organization-content-exclusion-details"]; }; }; + 401: components["responses"]["requires_authentication"]; 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": { + "copilot/set-copilot-content-exclusion-for-organization": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + /** @description The content exclusion rules to set */ + requestBody: { + content: { + "application/json": { + [key: string]: (string | { + ifAnyMatch: string[]; + } | { + ifNoneMatch: string[]; + })[]; + }; + }; + }; + responses: { + /** @description Success */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message?: string; + }; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 413: components["responses"]["too_large"]; + 422: components["responses"]["validation_failed_simple"]; + 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. */ + /** @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 100 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)." */ + /** @description The number of days of metrics to display per page (max 100). For 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; @@ -98907,12 +106408,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; 500: components["responses"]["internal_error"]; }; }; @@ -98948,6 +106449,31 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"]; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -98963,18 +106489,6 @@ export interface operations { 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; /** @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"]; }; @@ -99108,7 +106622,7 @@ export interface operations { */ visibility: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; + selected_repository_ids?: (number | string)[]; }; }; }; @@ -100285,6 +107799,115 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "orgs/list-issue-types": { + parameters: { + query?: never; + 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"]["issue-type"][]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "orgs/create-issue-type": { + 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": components["schemas"]["organization-create-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/update-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-type"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/delete-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; "issues/list-for-org": { parameters: { query?: { @@ -100294,6 +107917,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description A list of comma separated label names. Example: `bug,ui,@high` */ labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; /** @description What to sort results by. */ sort?: "created" | "updated" | "comments"; /** @description The direction to sort the results by. */ @@ -100330,8 +107955,8 @@ export interface operations { "orgs/list-members": { parameters: { query?: { - /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */ - filter?: "2fa_disabled" | "all"; + /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; /** @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)." */ @@ -101215,8 +108840,8 @@ export interface operations { "orgs/list-outside-collaborators": { parameters: { query?: { - /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ - filter?: "2fa_disabled" | "all"; + /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; /** @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)." */ @@ -101601,6 +109226,8 @@ export interface operations { last_used_before?: components["parameters"]["personal-access-token-before"]; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; header?: never; path: { @@ -101748,6 +109375,8 @@ export interface operations { last_used_before?: components["parameters"]["personal-access-token-before"]; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; header?: never; path: { @@ -101921,9 +109550,19 @@ export interface operations { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url: string; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ encrypted_value: string; /** @description The ID of the key you used to encrypt the secret. */ @@ -102058,9 +109697,19 @@ export interface operations { * @description The registry type. * @enum {string} */ - registry_type?: "maven_repository"; + registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ encrypted_value?: string; /** @description The ID of the key you used to encrypt the secret. */ @@ -102090,12 +109739,14 @@ export interface operations { "projects/list-for-org": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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: { @@ -102113,28 +109764,62 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - 422: components["responses"]["validation_failed_simple"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "projects/create-for-org": { + "projects/get-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; cookie?: never; }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/create-draft-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ requestBody: { content: { "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ body?: string; }; }; @@ -102146,17 +109831,464 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-fields-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 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"]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/add-field-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The ID of the IssueField to create the field for. */ + issue_field_id: number; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response for adding a field to an organization-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-org": { + parameters: { + query?: { + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/add-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-org-item": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: null | string | number; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/create-view-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example 123 + * @example 456 + * @example 789 + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in an organization-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "projects/list-view-items-for-org": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/get-all-custom-properties": { + "orgs/custom-properties-for-repos-get-organization-definitions": { parameters: { query?: never; header?: never; @@ -102181,7 +110313,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties": { + "orgs/custom-properties-for-repos-create-or-update-organization-definitions": { parameters: { query?: never; header?: never; @@ -102213,7 +110345,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/get-custom-property": { + "orgs/custom-properties-for-repos-get-organization-definition": { parameters: { query?: never; header?: never; @@ -102240,7 +110372,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-property": { + "orgs/custom-properties-for-repos-create-or-update-organization-definition": { parameters: { query?: never; header?: never; @@ -102271,7 +110403,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/remove-custom-property": { + "orgs/custom-properties-for-repos-delete-organization-definition": { parameters: { query?: never; header?: never; @@ -102290,7 +110422,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/list-custom-properties-values-for-repos": { + "orgs/custom-properties-for-repos-get-organization-values": { 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)." */ @@ -102323,7 +110455,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties-values-for-repos": { + "orgs/custom-properties-for-repos-create-or-update-organization-values": { parameters: { query?: never; header?: never; @@ -102718,7 +110850,7 @@ export interface operations { bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["org-rules"][]; }; }; }; @@ -102733,6 +110865,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -102746,12 +110879,12 @@ export interface operations { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; @@ -102867,7 +111000,7 @@ export interface operations { bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; conditions?: components["schemas"]["org-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["org-rules"][]; }; }; }; @@ -102882,6 +111015,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -102910,15 +111044,78 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "orgs/get-org-ruleset-history": { + 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 The ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "orgs/get-org-ruleset-version": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "secret-scanning/list-alerts-for-org": { parameters: { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ @@ -102937,6 +111134,8 @@ export interface operations { 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; header?: never; path: { @@ -102961,6 +111160,89 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "secret-scanning/list-org-pattern-configs": { + parameters: { + query?: never; + 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"]["secret-scanning-pattern-configuration"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "secret-scanning/update-org-pattern-configs": { + 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": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Pattern settings for provider patterns. */ + provider_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "not-set" | "disabled" | "enabled"; + }[]; + /** @description Pattern settings for custom patterns. */ + custom_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + custom_pattern_version?: components["schemas"]["secret-scanning-row-version"]; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "disabled" | "enabled"; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The updated pattern configuration version. */ + pattern_config_version?: string; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; "security-advisories/list-org-repository-advisories": { parameters: { query?: { @@ -103068,7 +111350,7 @@ export interface operations { }; }; }; - "billing/get-github-actions-billing-org": { + "orgs/get-immutable-releases-settings": { parameters: { query?: never; header?: never; @@ -103080,18 +111362,18 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description Immutable releases settings response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["immutable-releases-organization-settings"]; }; }; }; }; - "billing/get-github-packages-billing-org": { + "orgs/set-immutable-releases-settings": { parameters: { query?: never; header?: never; @@ -103101,6 +111383,45 @@ export interface operations { }; cookie?: never; }; + requestBody: { + content: { + "application/json": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "orgs/get-immutable-releases-settings-repositories": { + 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"]; + }; + cookie?: never; + }; requestBody?: never; responses: { /** @description Response */ @@ -103109,31 +111430,85 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + }; + "orgs/set-immutable-releases-settings-repositories": { + 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 An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "billing/get-shared-storage-billing-org": { + "orgs/enable-selected-repository-immutable-releases-organization": { 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 repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["combined-billing-usage"]; + content?: never; + }; + }; + }; + "orgs/disable-selected-repository-immutable-releases-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; @@ -103189,7 +111564,7 @@ export interface operations { * @enum {string} */ compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ network_settings_ids: string[]; }; }; @@ -103277,7 +111652,7 @@ export interface operations { * @enum {string} */ compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ network_settings_ids?: string[]; }; }; @@ -103323,13 +111698,13 @@ 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. */ + /** @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 100 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)." */ + /** @description The number of days of metrics to display per page (max 100). For 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; @@ -103358,44 +111733,6 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/usage-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"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; "teams/list": { parameters: { query?: { @@ -103443,7 +111780,7 @@ export interface operations { name: string; /** @description The description of the team. */ description?: string; - /** @description List GitHub IDs for organization members who will become team maintainers. */ + /** @description List GitHub usernames for organization members who will become team maintainers. */ maintainers?: string[]; /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ repo_names?: string[]; @@ -103539,6 +111876,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; "teams/update-in-org": { @@ -103612,17 +111950,13 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-in-org": { + "teams/list-pending-invitations-in-org": { parameters: { query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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 Pinned discussions only filter */ - pinned?: string; }; header?: never; path: { @@ -103642,14 +111976,22 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"][]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - "teams/create-discussion-in-org": { + "teams/list-members-in-org": { parameters: { - query?: never; + query?: { + /** @description Filters members returned by their role in the team. */ + role?: "member" | "maintainer" | "all"; + /** @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. */ @@ -103659,34 +112001,21 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 201: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - "teams/get-discussion-in-org": { + "teams/get-membership-for-user-in-org": { parameters: { query?: never; header?: never; @@ -103695,8 +112024,8 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -103708,12 +112037,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["team-membership"]; }; }; + /** @description if user has no team membership */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "teams/delete-discussion-in-org": { + "teams/add-or-update-membership-for-user-in-org": { parameters: { query?: never; header?: never; @@ -103722,15 +112058,42 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description The role that this user should have in the team. + * @default member + * @enum {string} + */ + role?: "member" | "maintainer"; + }; + }; + }; responses: { /** @description Response */ - 204: { + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-membership"]; + }; + }; + /** @description Forbidden if team synchronization is set up */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unprocessable Entity if you attempt to add an organization to a team */ + 422: { headers: { [name: string]: unknown; }; @@ -103738,7 +112101,7 @@ export interface operations { }; }; }; - "teams/update-discussion-in-org": { + "teams/remove-membership-for-user-in-org": { parameters: { query?: never; header?: never; @@ -103747,736 +112110,30 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title?: string; - /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion"]; + content?: never; + }; + /** @description Forbidden if team synchronization is set up */ + 403: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "teams/list-discussion-comments-in-org": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - "teams/create-discussion-comment-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/get-discussion-comment-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/delete-discussion-comment-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-comment-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-comment-in-org": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-comment-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response when the reaction type has already been added to this team discussion comment */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; - "reactions/delete-for-team-discussion-comment": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "reactions/list-for-team-discussion-in-org": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; - "reactions/delete-for-team-discussion": { - parameters: { - query?: never; - 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/list-pending-invitations-in-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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - }; - }; - "teams/list-members-in-org": { - parameters: { - query?: { - /** @description Filters members returned by their role in the team. */ - role?: "member" | "maintainer" | "all"; - /** @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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "teams/get-membership-for-user-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description if user has no team membership */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/add-or-update-membership-for-user-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The role that this user should have in the team. - * @default member - * @enum {string} - */ - role?: "member" | "maintainer"; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Unprocessable Entity if you attempt to add an organization to a team */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/remove-membership-for-user-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/list-projects-in-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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - }; - }; - "teams/check-permissions-for-project-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/add-or-update-project-permissions-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - }; - }; - "teams/remove-project-in-org": { - parameters: { - query?: never; - 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"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/list-repos-in-org": { + "teams/list-repos-in-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)." */ @@ -104690,761 +112347,6 @@ export interface operations { }; }; }; - "projects/get-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - note?: string | null; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/move-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. - * @example bottom - */ - position: string; - /** - * @description The unique identifier of the column the card should be moved to - * @example 42 - */ - column_id?: number; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": Record; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - resource?: string; - field?: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - /** @description Response */ - 503: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; - }; - "projects/get-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "projects/delete-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/update-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/list-cards": { - parameters: { - query?: { - /** @description Filters the project cards that are returned by the card's state. */ - archived_state?: "all" | "archived" | "not_archived"; - /** @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 unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - note: string | null; - } | { - /** - * @description The unique identifier of the content associated with the card - * @example 42 - */ - content_id: number; - /** - * @description The piece of content associated with the card - * @example PullRequest - */ - content_type: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - /** @description Validation failed */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; - }; - }; - /** @description Response */ - 503: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - }[]; - }; - }; - }; - }; - }; - "projects/move-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. - * @example last - */ - position: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": Record; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/get": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/delete": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Delete Success */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - }; - }; - "projects/update": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - name?: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - /** - * @description State of the project; either 'open' or 'closed' - * @example open - */ - state?: string; - /** - * @description The baseline permission that all organization members have on this project - * @enum {string} - */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - /** @description Not Found if the authenticated user does not have access to the project */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/list-collaborators": { - parameters: { - query?: { - /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; - /** @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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/add-collaborator": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant the collaborator. - * @default write - * @example write - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/remove-collaborator": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/get-permission-for-user": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "projects/list-columns": { - 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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-column"][]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - }; - }; - "projects/create-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-column"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; "rate-limit/get": { parameters: { query?: never; @@ -105533,6 +112435,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "repos/update": { @@ -105578,11 +112481,22 @@ export interface operations { * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { - /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ + /** + * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. + * For more information, see "[About GitHub Advanced + * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */ + code_security?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ @@ -105603,6 +112517,36 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */ + secret_scanning_delegated_alert_dismissal?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */ + secret_scanning_delegated_bypass?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** + * @description Feature options for secret scanning delegated bypass. + * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + */ + secret_scanning_delegated_bypass_options?: { + /** + * @description The bypass reviewers for secret scanning delegated bypass. + * If you omit this field, the existing set of reviewers is unchanged. + */ + 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"; + }[]; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -105850,6 +112794,120 @@ export interface operations { 410: components["responses"]["gone"]; }; }; + "actions/get-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "actions/get-actions-cache-usage": { parameters: { query?: never; @@ -106235,6 +113293,7 @@ export interface operations { "application/json": { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -106300,6 +113359,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-allowed-actions-repository": { parameters: { query?: never; @@ -106504,6 +113729,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -106607,6 +113833,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-repo": { @@ -107485,9 +114712,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; }; }; }; @@ -107794,15 +115021,26 @@ export interface operations { "application/json": { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ ref: string; - /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { [key: string]: unknown; }; + /** @description Whether the response should include the workflow run ID and URLs. */ + return_run_details?: boolean; }; }; }; responses: { - /** @description Response */ + /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["workflow-dispatch-response"]; + }; + }; + /** @description Empty response when `return_run_details` parameter is `false`. */ 204: { headers: { [name: string]: unknown; @@ -108093,6 +115331,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -108130,6 +115374,7 @@ export interface operations { }; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -110122,6 +117367,11 @@ export interface operations { state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; header?: never; path: { @@ -110197,10 +117447,12 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; + state?: components["schemas"]["code-scanning-alert-set-state"]; dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - }; + create_request?: components["schemas"]["code-scanning-alert-create-request"]; + assignees?: components["schemas"]["code-scanning-alert-assignees"]; + } | unknown | unknown; }; }; responses: { @@ -110213,6 +117465,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-alert"]; }; }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 503: components["responses"]["service_unavailable"]; @@ -110369,7 +117622,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; + "application/json": components["schemas"]["code-scanning-alert-instance-list"][]; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; @@ -110447,13 +117700,14 @@ export interface operations { }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; - "application/json+sarif": { + "application/sarif+json": { [key: string]: unknown; }; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_analysis"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -110757,6 +118011,7 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; + 422: components["responses"]["code_scanning_invalid_state"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -111461,7 +118716,19 @@ export interface operations { content?: never; }; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; + /** + * @description Response when: + * - validation failed, or the endpoint has been spammed + * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; }; }; "repos/remove-collaborator": { @@ -112203,7 +119470,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -112431,6 +119702,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -112442,32 +119724,12 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** - * @deprecated - * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. - */ - page?: number; - /** - * @deprecated - * @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?: number; /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; + /** @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: { @@ -112558,7 +119820,7 @@ export interface operations { * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ - state: "dismissed" | "open"; + state?: "dismissed" | "open"; /** * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert. * @enum {string} @@ -112566,7 +119828,13 @@ export interface operations { dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; /** @description An optional comment associated with dismissing the alert. */ dismissed_comment?: string; - }; + /** + * @description Usernames to assign to this Dependabot Alert. + * Pass one or more user logins to _replace_ the set of assignees on this alert. + * Send an empty array (`[]`) to clear all assignees from the alert. + */ + assignees?: string[]; + } | unknown | unknown; }; }; responses: { @@ -114398,7 +121666,13 @@ export interface operations { content?: never; }; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; "git/update-ref": { @@ -114773,7 +122047,233 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/update-webhook": { + "repos/update-webhook": { + 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 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": { + config?: components["schemas"]["webhook-config"]; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + * @default [ + * "push" + * ] + */ + events?: string[]; + /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ + add_events?: string[]; + /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ + remove_events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/get-webhook-config-for-repo": { + 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 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"]; + }; + }; + }; + }; + "repos/update-webhook-config-for-repo": { + 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 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"]; + }; + }; + }; + }; + "repos/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 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 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"]; + }; + }; + "repos/get-webhook-delivery": { + 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 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"]; + }; + }; + "repos/redeliver-webhook-delivery": { + 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 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"]; + }; + }; + "repos/ping-webhook": { + 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 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"]; + }; + }; + "repos/test-push-webhook": { parameters: { query?: never; header?: never; @@ -114787,44 +122287,19 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - config?: components["schemas"]["webhook-config"]; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. - * @default [ - * "push" - * ] - */ - events?: string[]; - /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; - /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active?: boolean; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["hook"]; - }; + content?: never; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/get-webhook-config-for-repo": { + "repos/check-immutable-releases": { parameters: { query?: never; header?: never; @@ -114833,147 +122308,30 @@ export interface operations { 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 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 */ + /** @description Response if immutable releases are enabled */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["check-immutable-releases"]; }; }; - }; - }; - "repos/update-webhook-config-for-repo": { - 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 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"]; - }; - }; - }; - }; - "repos/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 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 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"]; - }; - }; - "repos/get-webhook-delivery": { - 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 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: { + /** @description Not Found if immutable releases are not enabled for the repository */ + 404: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/redeliver-webhook-delivery": { - 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 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"]; + content?: never; }; - cookie?: never; - }; - requestBody?: never; - responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/ping-webhook": { + "repos/enable-immutable-releases": { parameters: { query?: never; header?: never; @@ -114982,24 +122340,16 @@ export interface operations { 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 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"]; + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; }; }; - "repos/test-push-webhook": { + "repos/disable-immutable-releases": { parameters: { query?: never; header?: never; @@ -115008,21 +122358,13 @@ export interface operations { 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 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"]; + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; }; }; "migrations/get-import-status": { @@ -115521,6 +122863,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -115595,6 +122939,11 @@ export interface operations { })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ + * @example Epic + */ + type?: string | null; }; }; }; @@ -115708,41 +123057,103 @@ export interface operations { }; content?: never; }; - }; - }; - "issues/update-comment": { - 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 unique identifier of the comment. */ - comment_id: components["parameters"]["comment-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The contents of the comment. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; + }; + }; + "issues/update-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The contents of the comment. */ + body: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/pin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unpin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 503: components["responses"]["service_unavailable"]; }; }; "reactions/list-for-issue-comment": { @@ -115930,7 +123341,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -115980,7 +123395,7 @@ export interface operations { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "not_planned" | "reopened" | null; + state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null; milestone?: null | string | number; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels?: (string | { @@ -115991,6 +123406,11 @@ export interface operations { })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + * @example Epic + */ + type?: string | null; }; }; }; @@ -116192,6 +123612,154 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + "issues/list-dependencies-blocked-by": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-blocked-by-dependency": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the issue that blocks the current issue */ + issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/remove-dependency-blocked-by": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + /** @description The id of the blocking issue to remove as a dependency */ + issue_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-dependencies-blocking": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; "issues/list-events": { parameters: { query?: { @@ -116323,15 +123891,11 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ + /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; } | string[] | { - labels?: { - name: string; - }[]; - } | { name: string; - }[] | string; + }[]; }; }; responses: { @@ -116479,6 +124043,36 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "issues/get-parent": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; "reactions/list-for-issue": { parameters: { query?: { @@ -116680,7 +124274,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -118000,84 +125594,7 @@ export interface operations { 422: components["responses"]["bad_request"]; }; }; - "projects/list-for-repo": { - parameters: { - query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; - /** @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 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/create-for-repo": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "repos/get-custom-properties-values": { + "repos/custom-properties-for-repos-get-repository-values": { parameters: { query?: never; header?: never; @@ -118104,7 +125621,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/create-or-update-custom-properties-values": { + "repos/custom-properties-for-repos-create-or-update-repository-values": { parameters: { query?: never; header?: never; @@ -120173,6 +127690,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -120184,12 +127702,12 @@ export interface operations { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; @@ -120331,6 +127849,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -120361,15 +127880,82 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "repos/get-repo-ruleset-history": { + 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 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 ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-repo-ruleset-version": { + 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 ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "secret-scanning/list-alerts-for-repo": { parameters: { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ @@ -120388,6 +127974,8 @@ export interface operations { 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; header?: never; path: { @@ -120421,7 +128009,10 @@ export interface operations { }; "secret-scanning/get-alert": { parameters: { - query?: never; + query?: { + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; + }; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -120472,10 +128063,11 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; + state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; - }; + assignee?: components["schemas"]["secret-scanning-alert-assignee"]; + } | unknown | unknown; }; }; responses: { @@ -120502,7 +128094,7 @@ export interface operations { }; content?: never; }; - /** @description State does not match the resolution or resolution comment */ + /** @description State does not match the resolution or resolution comment, or assignee does not have write access to the repository */ 422: { headers: { [name: string]: unknown; @@ -120895,356 +128487,47 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][] | components["schemas"]["stargazer"][]; - }; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/get-code-frequency-stats": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - /** @description Repository contains more than 10,000 commits */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "repos/get-commit-activity-stats": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["commit-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; - "repos/get-contributors-stats": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["contributor-activity"][]; - }; - }; - 202: components["responses"]["accepted"]; - 204: components["responses"]["no_content"]; - }; - }; - "repos/get-participation-stats": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description The array order is oldest week (index 0) to most recent week. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["participation-stats"]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "repos/get-punch-card-stats": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["code-frequency-stat"][]; - }; - }; - 204: components["responses"]["no_content"]; - }; - }; - "repos/create-commit-status": { - 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"]; - sha: string; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The state of the status. - * @enum {string} - */ - state: "error" | "failure" | "pending" | "success"; - /** - * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. - * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: - * `http://ci.example.com/user/repo/build/sha` - */ - target_url?: string | null; - /** @description A short description of the status. */ - description?: string | null; - /** - * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. - * @default default - */ - context?: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ - Location?: string; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["status"]; - }; - }; - }; - }; - "activity/list-watchers-for-repo": { - 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 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["simple-user"][]; - }; - }; - }; - }; - "activity/get-repo-subscription": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description if you subscribe to the repository */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - 403: components["responses"]["forbidden"]; - /** @description Not Found if you don't subscribe to the repository */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "activity/set-repo-subscription": { - 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"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description Determines if notifications should be received from this repository. */ - subscribed?: boolean; - /** @description Determines if all notifications should be blocked from this repository. */ - ignored?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-subscription"]; - }; - }; - }; - }; - "activity/delete-repo-subscription": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "repos/list-tags": { - 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 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag"][]; + "application/json": components["schemas"]["simple-user"][] | components["schemas"]["stargazer"][]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/get-code-frequency-stats": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; + /** @description Repository contains more than 10,000 commits */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "repos/list-tag-protection": { + "repos/get-commit-activity-stats": { parameters: { query?: never; header?: never; @@ -121264,14 +128547,67 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["tag-protection"][]; + "application/json": components["schemas"]["commit-activity"][]; + }; + }; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; + }; + }; + "repos/get-contributors-stats": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["contributor-activity"][]; + }; + }; + 202: components["responses"]["accepted"]; + 204: components["responses"]["no_content"]; + }; + }; + "repos/get-participation-stats": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The array order is oldest week (index 0) to most recent week. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["participation-stats"]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "repos/create-tag-protection": { + "repos/get-punch-card-stats": { parameters: { query?: never; header?: never; @@ -121283,11 +128619,54 @@ export interface operations { }; cookie?: never; }; + requestBody?: never; + responses: { + /** @description For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-frequency-stat"][]; + }; + }; + 204: components["responses"]["no_content"]; + }; + }; + "repos/create-commit-status": { + 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"]; + sha: string; + }; + cookie?: never; + }; requestBody: { content: { "application/json": { - /** @description An optional glob pattern to match against when enforcing tag protection. */ - pattern: string; + /** + * @description The state of the status. + * @enum {string} + */ + state: "error" | "failure" | "pending" | "success"; + /** + * @description The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. + * For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: + * `http://ci.example.com/user/repo/build/sha` + */ + target_url?: string | null; + /** @description A short description of the status. */ + description?: string | null; + /** + * @description A string label to differentiate this status from the status of other systems. This field is case-insensitive. + * @default default + */ + context?: string; }; }; }; @@ -121295,17 +128674,115 @@ export interface operations { /** @description Response */ 201: { headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["tag-protection"]; + "application/json": components["schemas"]["status"]; + }; + }; + }; + }; + "activity/list-watchers-for-repo": { + 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 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "activity/get-repo-subscription": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description if you subscribe to the repository */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["repository-subscription"]; }; }; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + /** @description Not Found if you don't subscribe to the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "activity/set-repo-subscription": { + 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"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** @description Determines if notifications should be received from this repository. */ + subscribed?: boolean; + /** @description Determines if all notifications should be blocked from this repository. */ + ignored?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["repository-subscription"]; + }; + }; }; }; - "repos/delete-tag-protection": { + "activity/delete-repo-subscription": { parameters: { query?: never; header?: never; @@ -121314,8 +128791,6 @@ export interface operations { 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 unique identifier of the tag protection. */ - tag_protection_id: components["parameters"]["tag-protection-id"]; }; cookie?: never; }; @@ -121328,8 +128803,37 @@ export interface operations { }; content?: never; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + }; + }; + "repos/list-tags": { + 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 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tag"][]; + }; + }; }; }; "repos/download-tarball-archive": { @@ -121872,6 +129376,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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + advanced_search?: components["parameters"]["issues-advanced-search"]; }; header?: never; path?: never; @@ -122163,447 +129672,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; - "teams/create-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/get-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/delete-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title?: string; - /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/list-discussion-comments-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - "teams/create-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/get-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/delete-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-comment-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; "teams/list-pending-invitations-legacy": { parameters: { query?: { @@ -122870,140 +129938,6 @@ export interface operations { }; }; }; - "teams/list-projects-legacy": { - 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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "teams/check-permissions-for-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/add-or-update-project-permissions-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "teams/remove-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "teams/list-repos-legacy": { parameters: { query?: { @@ -125426,45 +132360,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "projects/create-for-authenticated-user": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; "users/list-public-emails-for-authenticated-user": { parameters: { query?: { @@ -125531,6 +132426,7 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { @@ -126207,6 +133103,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "projects/create-draft-item-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; "users/list": { parameters: { query?: { @@ -126235,6 +133169,74 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "projects/create-view-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example 123 + * @example 456 + * @example 789 + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in a user-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; "users/get-by-username": { parameters: { query?: never; @@ -126259,6 +133261,173 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "users/delete-attestations-bulk": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "users/list-attestations": { parameters: { query?: { @@ -126268,6 +133437,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -126288,9 +133463,22 @@ export interface operations { content: { "application/json": { attestations?: { - bundle?: components["schemas"]["sigstore-bundle-0"]; + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -126932,12 +134120,14 @@ export interface operations { "projects/list-for-user": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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: { @@ -126955,22 +134145,57 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-events-for-user": { + "projects/get-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-fields-for-user": { 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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -126981,24 +134206,131 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-public-events-for-user": { + "projects/add-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-user": { parameters: { query?: { + /** @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 number of results per page (max 100). For 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 Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -127009,32 +134341,204 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "repos/list-for-user": { + "projects/add-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-user-item": { parameters: { query?: { - /** @description Limit results to repositories of the specified type. */ - type?: "all" | "owner" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: null | string | number; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-view-items-for-user": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -127047,14 +134551,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "billing/get-github-actions-billing-user": { + "activity/list-received-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -127070,14 +134583,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-github-packages-billing-user": { + "activity/list-received-public-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -127093,14 +134611,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-shared-storage-billing-user": { + "repos/list-for-user": { parameters: { - query?: never; + query?: { + /** @description Limit results to repositories of the specified type. */ + type?: "all" | "owner" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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 handle for the GitHub user account. */ @@ -127113,14 +134642,105 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; + "billing/get-github-billing-premium-request-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "users/list-social-accounts-for-user": { parameters: { query?: { @@ -127277,7 +134897,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": string; + "text/plain": string; }; }; }; @@ -127567,8 +135187,268 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-run-requested-action"]; - "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-requested-action-form-encoded"]; + "application/json": components["schemas"]["webhook-check-run-requested-action"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-requested-action-form-encoded"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "check-run/rerequested": { + 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-check-run-rerequested"]; + "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-rerequested-form-encoded"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "check-suite/completed": { + 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-check-suite-completed"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "check-suite/requested": { + 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-check-suite-requested"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "check-suite/rerequested": { + 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-check-suite-rerequested"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-scanning-alert/appeared-in-branch": { + 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-code-scanning-alert-appeared-in-branch"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-scanning-alert/closed-by-user": { + 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-code-scanning-alert-closed-by-user"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "code-scanning-alert/created": { + 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-code-scanning-alert-created"]; }; }; responses: { @@ -127581,7 +135461,7 @@ export interface operations { }; }; }; - "check-run/rerequested": { + "code-scanning-alert/fixed": { parameters: { query?: never; header?: { @@ -127605,8 +135485,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-run-rerequested"]; - "application/x-www-form-urlencoded": components["schemas"]["webhook-check-run-rerequested-form-encoded"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-fixed"]; }; }; responses: { @@ -127619,7 +135498,7 @@ export interface operations { }; }; }; - "check-suite/completed": { + "code-scanning-alert/reopened": { parameters: { query?: never; header?: { @@ -127643,7 +135522,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-suite-completed"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-reopened"]; }; }; responses: { @@ -127656,7 +135535,7 @@ export interface operations { }; }; }; - "check-suite/requested": { + "code-scanning-alert/reopened-by-user": { parameters: { query?: never; header?: { @@ -127680,7 +135559,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-suite-requested"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-reopened-by-user"]; }; }; responses: { @@ -127693,7 +135572,7 @@ export interface operations { }; }; }; - "check-suite/rerequested": { + "code-scanning-alert/updated-assignment": { parameters: { query?: never; header?: { @@ -127717,7 +135596,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-check-suite-rerequested"]; + "application/json": components["schemas"]["webhook-code-scanning-alert-updated-assignment"]; }; }; responses: { @@ -127730,7 +135609,7 @@ export interface operations { }; }; }; - "code-scanning-alert/appeared-in-branch": { + "commit-comment/created": { parameters: { query?: never; header?: { @@ -127754,7 +135633,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-appeared-in-branch"]; + "application/json": components["schemas"]["webhook-commit-comment-created"]; }; }; responses: { @@ -127767,7 +135646,7 @@ export interface operations { }; }; }; - "code-scanning-alert/closed-by-user": { + create: { parameters: { query?: never; header?: { @@ -127791,7 +135670,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-closed-by-user"]; + "application/json": components["schemas"]["webhook-create"]; }; }; responses: { @@ -127804,7 +135683,7 @@ export interface operations { }; }; }; - "code-scanning-alert/created": { + "custom-property/created": { parameters: { query?: never; header?: { @@ -127828,7 +135707,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-created"]; + "application/json": components["schemas"]["webhook-custom-property-created"]; }; }; responses: { @@ -127841,7 +135720,7 @@ export interface operations { }; }; }; - "code-scanning-alert/fixed": { + "custom-property/deleted": { parameters: { query?: never; header?: { @@ -127865,7 +135744,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-fixed"]; + "application/json": components["schemas"]["webhook-custom-property-deleted"]; }; }; responses: { @@ -127878,7 +135757,7 @@ export interface operations { }; }; }; - "code-scanning-alert/reopened": { + "custom-property/promote-to-enterprise": { parameters: { query?: never; header?: { @@ -127902,7 +135781,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-reopened"]; + "application/json": components["schemas"]["webhook-custom-property-promoted-to-enterprise"]; }; }; responses: { @@ -127915,7 +135794,7 @@ export interface operations { }; }; }; - "code-scanning-alert/reopened-by-user": { + "custom-property/updated": { parameters: { query?: never; header?: { @@ -127939,7 +135818,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-code-scanning-alert-reopened-by-user"]; + "application/json": components["schemas"]["webhook-custom-property-updated"]; }; }; responses: { @@ -127952,7 +135831,7 @@ export interface operations { }; }; }; - "commit-comment/created": { + "custom-property-values/updated": { parameters: { query?: never; header?: { @@ -127976,7 +135855,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-commit-comment-created"]; + "application/json": components["schemas"]["webhook-custom-property-values-updated"]; }; }; responses: { @@ -127989,7 +135868,7 @@ export interface operations { }; }; }; - create: { + delete: { parameters: { query?: never; header?: { @@ -128013,7 +135892,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-create"]; + "application/json": components["schemas"]["webhook-delete"]; }; }; responses: { @@ -128026,7 +135905,7 @@ export interface operations { }; }; }; - "custom-property/created": { + "dependabot-alert/assignees-changed": { parameters: { query?: never; header?: { @@ -128034,7 +135913,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example dependabot_alert */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128050,7 +135929,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-custom-property-created"]; + "application/json": components["schemas"]["webhook-dependabot-alert-assignees-changed"]; }; }; responses: { @@ -128063,7 +135942,7 @@ export interface operations { }; }; }; - "custom-property/deleted": { + "dependabot-alert/auto-dismissed": { parameters: { query?: never; header?: { @@ -128071,7 +135950,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example dependabot_alert */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128087,7 +135966,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-custom-property-deleted"]; + "application/json": components["schemas"]["webhook-dependabot-alert-auto-dismissed"]; }; }; responses: { @@ -128100,7 +135979,7 @@ export interface operations { }; }; }; - "custom-property/updated": { + "dependabot-alert/auto-reopened": { parameters: { query?: never; header?: { @@ -128108,7 +135987,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example dependabot_alert */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128124,7 +136003,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-custom-property-updated"]; + "application/json": components["schemas"]["webhook-dependabot-alert-auto-reopened"]; }; }; responses: { @@ -128137,7 +136016,7 @@ export interface operations { }; }; }; - "custom-property-values/updated": { + "dependabot-alert/created": { parameters: { query?: never; header?: { @@ -128145,7 +136024,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example dependabot_alert */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128161,7 +136040,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-custom-property-values-updated"]; + "application/json": components["schemas"]["webhook-dependabot-alert-created"]; }; }; responses: { @@ -128174,7 +136053,7 @@ export interface operations { }; }; }; - delete: { + "dependabot-alert/dismissed": { parameters: { query?: never; header?: { @@ -128182,7 +136061,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example dependabot_alert */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128198,7 +136077,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-delete"]; + "application/json": components["schemas"]["webhook-dependabot-alert-dismissed"]; }; }; responses: { @@ -128211,7 +136090,7 @@ export interface operations { }; }; }; - "dependabot-alert/auto-dismissed": { + "dependabot-alert/fixed": { parameters: { query?: never; header?: { @@ -128219,7 +136098,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example dependabot_alert */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128235,7 +136114,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-auto-dismissed"]; + "application/json": components["schemas"]["webhook-dependabot-alert-fixed"]; }; }; responses: { @@ -128248,7 +136127,81 @@ export interface operations { }; }; }; - "dependabot-alert/auto-reopened": { + "dependabot-alert/reintroduced": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example dependabot_alert */ + "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-dependabot-alert-reintroduced"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "dependabot-alert/reopened": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example dependabot_alert */ + "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-dependabot-alert-reopened"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "deploy-key/created": { parameters: { query?: never; header?: { @@ -128272,7 +136225,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-auto-reopened"]; + "application/json": components["schemas"]["webhook-deploy-key-created"]; }; }; responses: { @@ -128285,7 +136238,7 @@ export interface operations { }; }; }; - "dependabot-alert/created": { + "deploy-key/deleted": { parameters: { query?: never; header?: { @@ -128309,7 +136262,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-created"]; + "application/json": components["schemas"]["webhook-deploy-key-deleted"]; }; }; responses: { @@ -128322,7 +136275,7 @@ export interface operations { }; }; }; - "dependabot-alert/dismissed": { + "deployment/created": { parameters: { query?: never; header?: { @@ -128346,7 +136299,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-dismissed"]; + "application/json": components["schemas"]["webhook-deployment-created"]; }; }; responses: { @@ -128359,7 +136312,7 @@ export interface operations { }; }; }; - "dependabot-alert/fixed": { + "deployment-protection-rule/requested": { parameters: { query?: never; header?: { @@ -128383,7 +136336,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-fixed"]; + "application/json": components["schemas"]["webhook-deployment-protection-rule-requested"]; }; }; responses: { @@ -128396,7 +136349,7 @@ export interface operations { }; }; }; - "dependabot-alert/reintroduced": { + "deployment-review/approved": { parameters: { query?: never; header?: { @@ -128420,7 +136373,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-reintroduced"]; + "application/json": components["schemas"]["webhook-deployment-review-approved"]; }; }; responses: { @@ -128433,7 +136386,7 @@ export interface operations { }; }; }; - "dependabot-alert/reopened": { + "deployment-review/rejected": { parameters: { query?: never; header?: { @@ -128457,7 +136410,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-dependabot-alert-reopened"]; + "application/json": components["schemas"]["webhook-deployment-review-rejected"]; }; }; responses: { @@ -128470,7 +136423,7 @@ export interface operations { }; }; }; - "deploy-key/created": { + "deployment-review/requested": { parameters: { query?: never; header?: { @@ -128494,7 +136447,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deploy-key-created"]; + "application/json": components["schemas"]["webhook-deployment-review-requested"]; }; }; responses: { @@ -128507,7 +136460,7 @@ export interface operations { }; }; }; - "deploy-key/deleted": { + "deployment-status/created": { parameters: { query?: never; header?: { @@ -128531,7 +136484,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deploy-key-deleted"]; + "application/json": components["schemas"]["webhook-deployment-status-created"]; }; }; responses: { @@ -128544,7 +136497,7 @@ export interface operations { }; }; }; - "deployment/created": { + "discussion/answered": { parameters: { query?: never; header?: { @@ -128568,7 +136521,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deployment-created"]; + "application/json": components["schemas"]["webhook-discussion-answered"]; }; }; responses: { @@ -128581,7 +136534,7 @@ export interface operations { }; }; }; - "deployment-protection-rule/requested": { + "discussion/category-changed": { parameters: { query?: never; header?: { @@ -128605,7 +136558,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deployment-protection-rule-requested"]; + "application/json": components["schemas"]["webhook-discussion-category-changed"]; }; }; responses: { @@ -128618,7 +136571,44 @@ export interface operations { }; }; }; - "deployment-review/approved": { + "discussion/closed": { + parameters: { + query?: never; + header?: { + /** @example GitHub-Hookshot/123abc */ + "User-Agent"?: string; + /** @example 12312312 */ + "X-Github-Hook-Id"?: string; + /** @example discussions */ + "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-discussion-closed"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "discussion-comment/created": { parameters: { query?: never; header?: { @@ -128642,7 +136632,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deployment-review-approved"]; + "application/json": components["schemas"]["webhook-discussion-comment-created"]; }; }; responses: { @@ -128655,7 +136645,7 @@ export interface operations { }; }; }; - "deployment-review/rejected": { + "discussion-comment/deleted": { parameters: { query?: never; header?: { @@ -128679,7 +136669,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deployment-review-rejected"]; + "application/json": components["schemas"]["webhook-discussion-comment-deleted"]; }; }; responses: { @@ -128692,7 +136682,7 @@ export interface operations { }; }; }; - "deployment-review/requested": { + "discussion-comment/edited": { parameters: { query?: never; header?: { @@ -128716,7 +136706,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deployment-review-requested"]; + "application/json": components["schemas"]["webhook-discussion-comment-edited"]; }; }; responses: { @@ -128729,7 +136719,7 @@ export interface operations { }; }; }; - "deployment-status/created": { + "discussion/created": { parameters: { query?: never; header?: { @@ -128753,7 +136743,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-deployment-status-created"]; + "application/json": components["schemas"]["webhook-discussion-created"]; }; }; responses: { @@ -128766,7 +136756,7 @@ export interface operations { }; }; }; - "discussion/answered": { + "discussion/deleted": { parameters: { query?: never; header?: { @@ -128790,7 +136780,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-answered"]; + "application/json": components["schemas"]["webhook-discussion-deleted"]; }; }; responses: { @@ -128803,7 +136793,7 @@ export interface operations { }; }; }; - "discussion/category-changed": { + "discussion/edited": { parameters: { query?: never; header?: { @@ -128827,7 +136817,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-category-changed"]; + "application/json": components["schemas"]["webhook-discussion-edited"]; }; }; responses: { @@ -128840,7 +136830,7 @@ export interface operations { }; }; }; - "discussion/closed": { + "discussion/labeled": { parameters: { query?: never; header?: { @@ -128848,7 +136838,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example discussions */ + /** @example issues */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128864,7 +136854,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-closed"]; + "application/json": components["schemas"]["webhook-discussion-labeled"]; }; }; responses: { @@ -128877,7 +136867,7 @@ export interface operations { }; }; }; - "discussion-comment/created": { + "discussion/locked": { parameters: { query?: never; header?: { @@ -128901,7 +136891,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-comment-created"]; + "application/json": components["schemas"]["webhook-discussion-locked"]; }; }; responses: { @@ -128914,7 +136904,7 @@ export interface operations { }; }; }; - "discussion-comment/deleted": { + "discussion/pinned": { parameters: { query?: never; header?: { @@ -128938,7 +136928,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-comment-deleted"]; + "application/json": components["schemas"]["webhook-discussion-pinned"]; }; }; responses: { @@ -128951,7 +136941,7 @@ export interface operations { }; }; }; - "discussion-comment/edited": { + "discussion/reopened": { parameters: { query?: never; header?: { @@ -128959,7 +136949,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example issues */ + /** @example discussions */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -128975,7 +136965,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-comment-edited"]; + "application/json": components["schemas"]["webhook-discussion-reopened"]; }; }; responses: { @@ -128988,7 +136978,7 @@ export interface operations { }; }; }; - "discussion/created": { + "discussion/transferred": { parameters: { query?: never; header?: { @@ -129012,7 +137002,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-created"]; + "application/json": components["schemas"]["webhook-discussion-transferred"]; }; }; responses: { @@ -129025,7 +137015,7 @@ export interface operations { }; }; }; - "discussion/deleted": { + "discussion/unanswered": { parameters: { query?: never; header?: { @@ -129049,7 +137039,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-deleted"]; + "application/json": components["schemas"]["webhook-discussion-unanswered"]; }; }; responses: { @@ -129062,7 +137052,7 @@ export interface operations { }; }; }; - "discussion/edited": { + "discussion/unlabeled": { parameters: { query?: never; header?: { @@ -129086,7 +137076,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-edited"]; + "application/json": components["schemas"]["webhook-discussion-unlabeled"]; }; }; responses: { @@ -129099,7 +137089,7 @@ export interface operations { }; }; }; - "discussion/labeled": { + "discussion/unlocked": { parameters: { query?: never; header?: { @@ -129123,7 +137113,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-labeled"]; + "application/json": components["schemas"]["webhook-discussion-unlocked"]; }; }; responses: { @@ -129136,7 +137126,7 @@ export interface operations { }; }; }; - "discussion/locked": { + "discussion/unpinned": { parameters: { query?: never; header?: { @@ -129160,7 +137150,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-locked"]; + "application/json": components["schemas"]["webhook-discussion-unpinned"]; }; }; responses: { @@ -129173,7 +137163,7 @@ export interface operations { }; }; }; - "discussion/pinned": { + fork: { parameters: { query?: never; header?: { @@ -129197,7 +137187,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-pinned"]; + "application/json": components["schemas"]["webhook-fork"]; }; }; responses: { @@ -129210,7 +137200,7 @@ export interface operations { }; }; }; - "discussion/reopened": { + "github-app-authorization/revoked": { parameters: { query?: never; header?: { @@ -129218,7 +137208,7 @@ export interface operations { "User-Agent"?: string; /** @example 12312312 */ "X-Github-Hook-Id"?: string; - /** @example discussions */ + /** @example issues */ "X-Github-Event"?: string; /** @example 123123 */ "X-Github-Hook-Installation-Target-Id"?: string; @@ -129234,7 +137224,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-reopened"]; + "application/json": components["schemas"]["webhook-github-app-authorization-revoked"]; }; }; responses: { @@ -129247,7 +137237,7 @@ export interface operations { }; }; }; - "discussion/transferred": { + gollum: { parameters: { query?: never; header?: { @@ -129271,7 +137261,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-transferred"]; + "application/json": components["schemas"]["webhook-gollum"]; }; }; responses: { @@ -129284,7 +137274,7 @@ export interface operations { }; }; }; - "discussion/unanswered": { + "installation/created": { parameters: { query?: never; header?: { @@ -129308,7 +137298,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-unanswered"]; + "application/json": components["schemas"]["webhook-installation-created"]; }; }; responses: { @@ -129321,7 +137311,7 @@ export interface operations { }; }; }; - "discussion/unlabeled": { + "installation/deleted": { parameters: { query?: never; header?: { @@ -129345,7 +137335,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-unlabeled"]; + "application/json": components["schemas"]["webhook-installation-deleted"]; }; }; responses: { @@ -129358,7 +137348,7 @@ export interface operations { }; }; }; - "discussion/unlocked": { + "installation/new-permissions-accepted": { parameters: { query?: never; header?: { @@ -129382,7 +137372,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-unlocked"]; + "application/json": components["schemas"]["webhook-installation-new-permissions-accepted"]; }; }; responses: { @@ -129395,7 +137385,7 @@ export interface operations { }; }; }; - "discussion/unpinned": { + "installation-repositories/added": { parameters: { query?: never; header?: { @@ -129419,7 +137409,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-discussion-unpinned"]; + "application/json": components["schemas"]["webhook-installation-repositories-added"]; }; }; responses: { @@ -129432,7 +137422,7 @@ export interface operations { }; }; }; - fork: { + "installation-repositories/removed": { parameters: { query?: never; header?: { @@ -129456,7 +137446,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-fork"]; + "application/json": components["schemas"]["webhook-installation-repositories-removed"]; }; }; responses: { @@ -129469,7 +137459,7 @@ export interface operations { }; }; }; - "github-app-authorization/revoked": { + "installation/suspend": { parameters: { query?: never; header?: { @@ -129493,7 +137483,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-github-app-authorization-revoked"]; + "application/json": components["schemas"]["webhook-installation-suspend"]; }; }; responses: { @@ -129506,7 +137496,7 @@ export interface operations { }; }; }; - gollum: { + "installation-target/renamed": { parameters: { query?: never; header?: { @@ -129530,7 +137520,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-gollum"]; + "application/json": components["schemas"]["webhook-installation-target-renamed"]; }; }; responses: { @@ -129543,7 +137533,7 @@ export interface operations { }; }; }; - "installation/created": { + "installation/unsuspend": { parameters: { query?: never; header?: { @@ -129567,7 +137557,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-created"]; + "application/json": components["schemas"]["webhook-installation-unsuspend"]; }; }; responses: { @@ -129580,7 +137570,7 @@ export interface operations { }; }; }; - "installation/deleted": { + "issue-comment/created": { parameters: { query?: never; header?: { @@ -129604,7 +137594,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-deleted"]; + "application/json": components["schemas"]["webhook-issue-comment-created"]; }; }; responses: { @@ -129617,7 +137607,7 @@ export interface operations { }; }; }; - "installation/new-permissions-accepted": { + "issue-comment/deleted": { parameters: { query?: never; header?: { @@ -129641,7 +137631,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-new-permissions-accepted"]; + "application/json": components["schemas"]["webhook-issue-comment-deleted"]; }; }; responses: { @@ -129654,7 +137644,7 @@ export interface operations { }; }; }; - "installation-repositories/added": { + "issue-comment/edited": { parameters: { query?: never; header?: { @@ -129678,7 +137668,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-repositories-added"]; + "application/json": components["schemas"]["webhook-issue-comment-edited"]; }; }; responses: { @@ -129691,7 +137681,7 @@ export interface operations { }; }; }; - "installation-repositories/removed": { + "issue-comment/pinned": { parameters: { query?: never; header?: { @@ -129715,7 +137705,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-repositories-removed"]; + "application/json": components["schemas"]["webhook-issue-comment-pinned"]; }; }; responses: { @@ -129728,7 +137718,7 @@ export interface operations { }; }; }; - "installation/suspend": { + "issue-comment/unpinned": { parameters: { query?: never; header?: { @@ -129752,7 +137742,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-suspend"]; + "application/json": components["schemas"]["webhook-issue-comment-unpinned"]; }; }; responses: { @@ -129765,7 +137755,7 @@ export interface operations { }; }; }; - "installation-target/renamed": { + "issue-dependencies/blocked-by-added": { parameters: { query?: never; header?: { @@ -129789,7 +137779,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-target-renamed"]; + "application/json": components["schemas"]["webhook-issue-dependencies-blocked-by-added"]; }; }; responses: { @@ -129802,7 +137792,7 @@ export interface operations { }; }; }; - "installation/unsuspend": { + "issue-dependencies/blocked-by-removed": { parameters: { query?: never; header?: { @@ -129826,7 +137816,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-installation-unsuspend"]; + "application/json": components["schemas"]["webhook-issue-dependencies-blocked-by-removed"]; }; }; responses: { @@ -129839,7 +137829,7 @@ export interface operations { }; }; }; - "issue-comment/created": { + "issue-dependencies/blocking-added": { parameters: { query?: never; header?: { @@ -129863,7 +137853,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issue-comment-created"]; + "application/json": components["schemas"]["webhook-issue-dependencies-blocking-added"]; }; }; responses: { @@ -129876,7 +137866,7 @@ export interface operations { }; }; }; - "issue-comment/deleted": { + "issue-dependencies/blocking-removed": { parameters: { query?: never; header?: { @@ -129900,7 +137890,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issue-comment-deleted"]; + "application/json": components["schemas"]["webhook-issue-dependencies-blocking-removed"]; }; }; responses: { @@ -129913,7 +137903,7 @@ export interface operations { }; }; }; - "issue-comment/edited": { + "issues/assigned": { parameters: { query?: never; header?: { @@ -129937,7 +137927,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issue-comment-edited"]; + "application/json": components["schemas"]["webhook-issues-assigned"]; }; }; responses: { @@ -129950,7 +137940,7 @@ export interface operations { }; }; }; - "issues/assigned": { + "issues/closed": { parameters: { query?: never; header?: { @@ -129974,7 +137964,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-assigned"]; + "application/json": components["schemas"]["webhook-issues-closed"]; }; }; responses: { @@ -129987,7 +137977,7 @@ export interface operations { }; }; }; - "issues/closed": { + "issues/deleted": { parameters: { query?: never; header?: { @@ -130011,7 +138001,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-closed"]; + "application/json": components["schemas"]["webhook-issues-deleted"]; }; }; responses: { @@ -130024,7 +138014,7 @@ export interface operations { }; }; }; - "issues/deleted": { + "issues/demilestoned": { parameters: { query?: never; header?: { @@ -130048,7 +138038,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-deleted"]; + "application/json": components["schemas"]["webhook-issues-demilestoned"]; }; }; responses: { @@ -130061,7 +138051,7 @@ export interface operations { }; }; }; - "issues/demilestoned": { + "issues/edited": { parameters: { query?: never; header?: { @@ -130085,7 +138075,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-demilestoned"]; + "application/json": components["schemas"]["webhook-issues-edited"]; }; }; responses: { @@ -130098,7 +138088,7 @@ export interface operations { }; }; }; - "issues/edited": { + "issues/labeled": { parameters: { query?: never; header?: { @@ -130122,7 +138112,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-edited"]; + "application/json": components["schemas"]["webhook-issues-labeled"]; }; }; responses: { @@ -130135,7 +138125,7 @@ export interface operations { }; }; }; - "issues/labeled": { + "issues/locked": { parameters: { query?: never; header?: { @@ -130159,7 +138149,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-labeled"]; + "application/json": components["schemas"]["webhook-issues-locked"]; }; }; responses: { @@ -130172,7 +138162,7 @@ export interface operations { }; }; }; - "issues/locked": { + "issues/milestoned": { parameters: { query?: never; header?: { @@ -130196,7 +138186,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-locked"]; + "application/json": components["schemas"]["webhook-issues-milestoned"]; }; }; responses: { @@ -130209,7 +138199,7 @@ export interface operations { }; }; }; - "issues/milestoned": { + "issues/opened": { parameters: { query?: never; header?: { @@ -130233,7 +138223,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-milestoned"]; + "application/json": components["schemas"]["webhook-issues-opened"]; }; }; responses: { @@ -130246,7 +138236,7 @@ export interface operations { }; }; }; - "issues/opened": { + "issues/pinned": { parameters: { query?: never; header?: { @@ -130270,7 +138260,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-opened"]; + "application/json": components["schemas"]["webhook-issues-pinned"]; }; }; responses: { @@ -130283,7 +138273,7 @@ export interface operations { }; }; }; - "issues/pinned": { + "issues/reopened": { parameters: { query?: never; header?: { @@ -130307,7 +138297,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-pinned"]; + "application/json": components["schemas"]["webhook-issues-reopened"]; }; }; responses: { @@ -130320,7 +138310,7 @@ export interface operations { }; }; }; - "issues/reopened": { + "issues/transferred": { parameters: { query?: never; header?: { @@ -130344,7 +138334,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-reopened"]; + "application/json": components["schemas"]["webhook-issues-transferred"]; }; }; responses: { @@ -130357,7 +138347,7 @@ export interface operations { }; }; }; - "issues/transferred": { + "issues/typed": { parameters: { query?: never; header?: { @@ -130381,7 +138371,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["webhook-issues-transferred"]; + "application/json": components["schemas"]["webhook-issues-typed"]; }; }; responses: { @@ -130542,6 +138532,43 @@ export interface operations { }; }; }; + "issues/untyped": { + 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-issues-untyped"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "label/created": { parameters: { query?: never; @@ -135168,6 +143195,43 @@ export interface operations { }; }; }; + "secret-scanning-alert/assigned": { + 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-assigned"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "secret-scanning-alert/created": { parameters: { query?: never; @@ -135354,6 +143418,43 @@ export interface operations { }; }; }; + "secret-scanning-alert/unassigned": { + 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-unassigned"]; + }; + }; + responses: { + /** @description Return a 200 status to indicate that the data was received successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "secret-scanning-alert/validated": { parameters: { query?: never; diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml index 98675b253..b84ac8969 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -44,7 +44,7 @@ tags: - name: licenses description: View various OSS licenses. - name: markdown - description: Render GitHub flavored markdown + description: Render GitHub flavored Markdown - name: merge-queue description: Interact with GitHub Merge Queues. - name: meta @@ -54,21 +54,19 @@ tags: - name: oidc description: Endpoints to manage GitHub OIDC configuration using the REST API. - name: orgs - description: Interact with GitHub Orgs. + description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects - description: Interact with GitHub Projects. - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit - description: Check your current rate limit status + description: Check your current rate limit status. - name: reactions description: Interact with reactions to various GitHub entities. - name: repos description: Interact with GitHub Repos. - name: search - description: Look for stuff on GitHub. + description: Search for specific items on GitHub. - name: secret-scanning description: Retrieve secret scanning alerts from a repository. - name: teams @@ -89,12 +87,22 @@ tags: description: Desktop specific endpoints. - name: enterprise-teams description: Endpoints to manage GitHub Enterprise Teams. +- name: enterprise-team-memberships + description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries description: Manage private registry configurations. - name: hosted-compute description: Manage hosted compute networking resources. +- name: credentials + description: Revoke compromised or leaked GitHub credentials. +- name: campaigns + description: Endpoints to manage campaigns via the REST API. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -203,7 +211,7 @@ paths: If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. - Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` schema: oneOf: - type: string @@ -702,7 +710,7 @@ paths: delete: summary: Delete an installation for the authenticated app description: |- - Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: @@ -802,7 +810,7 @@ paths: put: summary: Suspend an app installation description: |- - Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: @@ -1405,6 +1413,64 @@ paths: enabledForGitHubApps: true category: codes-of-conduct subcategory: codes-of-conduct + "/credentials/revoke": + post: + summary: Revoke a list of credentials + description: |- + Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + + This endpoint currently accepts the following credential types: + - Personal access tokens (classic) + - Fine-grained personal access tokens + + Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + + To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + + > [!NOTE] + > Any authenticated requests will return a 403. + tags: + - credentials + operationId: credentials/revoke + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + description: A list of credentials to be revoked, up to 1000 per + request. + items: + type: string + minItems: 1 + maxItems: 1000 + required: + - credentials + examples: + default: + value: + credentials: + - ghp_1234567890abcdef1234567890abcdef12345678 + - ghp_abcdef1234567890abcdef1234567890abcdef12 + responses: + '202': + "$ref": "#/components/responses/accepted" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: credentials + subcategory: revoke "/emojis": get: summary: Get emojis @@ -1435,6 +1501,152 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise @@ -1517,11 +1729,24 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled + - code_security + - secret_protection default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -1563,6 +1788,8 @@ paths: - disabled - not_set default: disabled + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -1573,6 +1800,22 @@ paths: default: disabled code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -1606,6 +1849,31 @@ paths: - disabled - not_set default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -1761,11 +2029,23 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security. - Must be set to enabled if you want to enable any GHAS settings. + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. enum: - enabled - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -1811,6 +2091,24 @@ paths: - not_set code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -1840,6 +2138,31 @@ paths: - enabled - disabled - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -1949,8 +2272,7 @@ paths: scope: type: string 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` + to. enum: - all - all_without_configurations @@ -2138,13 +2460,13 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -2172,36 +2494,20 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": + "/enterprises/{enterprise}/teams": get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + summary: List enterprise teams + description: List all teams in the enterprise for the authenticated user tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise + - enterprise-teams + operationId: enterprise-teams/list externalDocs: description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/secret-scanning-alert-state" - - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - - "$ref": "#/components/parameters/secret-scanning-alert-sort" - - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - - "$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" + - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -2210,22 +2516,664 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/organization-secret-scanning-alert" + "$ref": "#/components/schemas/enterprise-team" examples: default: - "$ref": "#/components/examples/organization-secret-scanning-alert-list" + "$ref": "#/components/examples/enterprise-teams-items" headers: Link: "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + post: + summary: Create an enterprise team + description: To create an enterprise team, the authenticated user must be an + owner of the enterprise. + tags: + - enterprise-teams + operationId: enterprise-teams/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + type: + - string + - 'null' + description: A description of the team. + sync_to_organizations: + type: string + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be set. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + type: + - string + - 'null' + description: The ID of the IdP group to assign team membership with. + You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). + required: + - name + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-team" + examples: + default: + "$ref": "#/components/examples/enterprise-teams-item" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": + get: + summary: List members in an enterprise team + description: Lists all team members in an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": + post: + summary: Bulk add team members + description: Add multiple team members to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to add to the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully added team members. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": + post: + summary: Bulk remove team members + description: Remove multiple team members from an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to be removed from the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully removed team members. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": + get: + summary: Get enterprise team membership + description: Returns whether the user is a member of the enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: User is a member of the enterprise team. + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + exampleKey1: + "$ref": "#/components/examples/simple-user" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + put: + summary: Add team member + description: Add a team member to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Successfully added team member + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + exampleKey1: + "$ref": "#/components/examples/simple-user" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + delete: + summary: Remove team membership + description: Remove membership of a specific user from a particular team in + an enterprise. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" '404': - "$ref": "#/components/responses/not_found" - '503': - "$ref": "#/components/responses/service_unavailable" + description: The team is not assigned to the organization x-github: githubCloudOnly: false enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{team_slug}": + get: + summary: Get an enterprise team + description: Gets a team using the team's slug. To create the slug, GitHub replaces + special characters in the name string, changes all words to lowercase, and + replaces spaces with a `-` separator and adds the "ent:" prefix. For example, + "My TEam Näme" would become `ent:my-team-name`. + tags: + - enterprise-teams + operationId: enterprise-teams/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/team-slug" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-team" + examples: + default: + "$ref": "#/components/examples/enterprise-teams-item" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + patch: + summary: Update an enterprise team + description: To edit a team, the authenticated user must be an enterprise owner. + tags: + - enterprise-teams + operationId: enterprise-teams/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: + - string + - 'null' + description: A new name for the team. + description: + type: + - string + - 'null' + description: A new description for the team. + sync_to_organizations: + type: string + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be changed. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + type: + - string + - 'null' + description: The ID of the IdP group to assign team membership with. + The new IdP group will replace the existing one, or replace existing + direct members if the team isn't currently linked to an IdP group. + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-team" + examples: + default: + "$ref": "#/components/examples/enterprise-teams-item" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + delete: + summary: Delete an enterprise team + description: |- + To delete an enterprise team, the authenticated user must be an enterprise owner. + + If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + tags: + - enterprise-teams + operationId: enterprise-teams/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams "/events": get: summary: List public events @@ -2239,7 +3187,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events parameters: - - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/public-events-per-page" - "$ref": "#/components/parameters/page" responses: '200': @@ -3269,7 +4217,8 @@ paths: repositories: type: array items: - "$ref": "#/components/schemas/repository" + allOf: + - "$ref": "#/components/schemas/repository" repository_selection: type: string examples: @@ -3507,7 +4456,8 @@ paths: "/markdown": post: summary: Render a Markdown document - description: '' + description: Depending on what is rendered in the Markdown, you may need to + provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. operationId: markdown/render tags: - markdown @@ -4343,6 +5293,648 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an organization + description: |- + Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + > [!NOTE] + > This operation supports both server-to-server and user-to-server access. + Unauthorized users will not see the existence of this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/dependabot-repository-access-details" + examples: + default: + "$ref": "#/components/examples/dependabot-repository-access-details" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an organization + description: |- + Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + + > [!NOTE] + > This operation supports both server-to-server and user-to-server access. + Unauthorized users will not see the existence of this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + "/organizations/{org}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot + description: |- + Sets the default level of repository access Dependabot will have while performing an update. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + Unauthorized users will not see the existence of this endpoint. + + This operation supports both server-to-server and user-to-server access. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + examples: + - internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + "$ref": "#/components/responses/get_all_budgets" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + examples: + - Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + "$ref": "#/components/examples/update-budget" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: budgets + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/delete-budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + "/organizations/{org}/settings/billing/premium_request/usage": + get: + summary: Get billing premium request usage report for an organization + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-premium-request-usage-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-user" + - "$ref": "#/components/parameters/billing-usage-report-model" + - "$ref": "#/components/parameters/billing-usage-report-product" + responses: + '200': + "$ref": "#/components/responses/billing_premium_request_usage_report_org" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage "/organizations/{org}/settings/billing/usage": get: summary: Get billing usage report for an organization @@ -4355,13 +5947,12 @@ paths: operationId: billing/get-github-billing-usage-report-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization + url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month" - "$ref": "#/components/parameters/billing-usage-report-day" - - "$ref": "#/components/parameters/billing-usage-report-hour" responses: '200': "$ref": "#/components/responses/billing_usage_report_org" @@ -4377,14 +5968,54 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: billing - subcategory: enhanced-billing + subcategory: usage + "/organizations/{org}/settings/billing/usage/summary": + get: + summary: Get billing usage summary for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-usage-summary-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-repository" + - "$ref": "#/components/parameters/billing-usage-report-product" + - "$ref": "#/components/parameters/billing-usage-report-sku" + responses: + '200': + "$ref": "#/components/responses/billing_usage_summary_report_org" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage "/orgs/{org}": get: summary: Get an organization description: |- Gets information about an organization. - When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). To see the full details about an organization, the authenticated user must be an organization owner. @@ -4893,6 +6524,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -4905,7 +6541,6 @@ paths: image: id: ubuntu-latest source: github - version: latest runner_group_id: 1 size: 4-core maximum_runners: 50 @@ -4925,6 +6560,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -4954,10 +6780,10 @@ paths: images: type: array items: - "$ref": "#/components/schemas/actions-hosted-runner-image" + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: - "$ref": "#/components/examples/actions-hosted-runner-image" + "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -4992,10 +6818,10 @@ paths: images: type: array items: - "$ref": "#/components/schemas/actions-hosted-runner-image" + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: - "$ref": "#/components/examples/actions-hosted-runner-image" + "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5181,6 +7007,15 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + size: + description: The machine size of the runner. To list available sizes, + use `GET actions/hosted-runners/machine-sizes` + type: string + image_id: + description: The unique identifier of the runner image. To list + all available images, use `GET /actions/hosted-runners/images/github-owned` + or `GET /actions/hosted-runners/images/partner`. + type: string image_version: description: The version of the runner image to deploy. This is relevant only for runners using custom images. @@ -5194,7 +7029,6 @@ paths: runner_group_id: 1 maximum_runners: 50 enable_static_ip: false - image_version: 1.0.0 responses: '200': description: Response @@ -5366,6 +7200,8 @@ paths: "$ref": "#/components/schemas/enabled-repositories" allowed_actions: "$ref": "#/components/schemas/allowed-actions" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_repositories examples: @@ -5373,11 +7209,224 @@ paths: value: enabled_repositories: all allowed_actions: selected + sha_pinning_required: true x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -5572,6 +7621,246 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/self-hosted-runners-settings" + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/repository" + examples: + default: + "$ref": "#/components/examples/repository-paginated" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -6382,6 +8671,8 @@ paths: "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6516,6 +8807,8 @@ paths: responses: '204': description: Response + '422': + "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6887,6 +9180,8 @@ paths: items: type: integer required: + - encrypted_value + - key_id - visibility examples: default: @@ -7516,6 +9811,896 @@ paths: enabledForGitHubApps: true category: actions subcategory: variables + "/orgs/{org}/artifacts/metadata/deployment-record": + post: + summary: Create an artifact deployment record + description: |- + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. + tags: + - orgs + operationId: orgs/create-artifact-deployment-record + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + minLength: 1 + maxLength: 256 + examples: + - libfoo + digest: + type: string + description: The hex encoded digest of the artifact. + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + examples: + - 1.2.3 + status: + type: string + description: The status of the artifact. Can be either deployed + or decommissioned. + enum: + - deployed + - decommissioned + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + cluster: + type: string + description: The deployment cluster. + maxLength: 128 + deployment_name: + type: string + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + maxLength: 256 + tags: + type: object + description: The tags associated with the deployment. + additionalProperties: + type: string + maxProperties: 5 + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: "^[A-Za-z0-9.\\-_]+$" + examples: + - my-github-repo + required: + - name + - digest + - status + - logical_environment + - deployment_name + examples: + default: + value: + name: awesome-image + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + status: deployed + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: deployment-pod + tags: + data-access: sensitive + responses: + '200': + description: Artifact deployment record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + "$ref": "#/components/schemas/artifact-deployment-record" + examples: + default: + "$ref": "#/components/examples/artifact-deployment-record-list" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": + post: + summary: Set cluster deployment records + description: |- + Set deployment records for a given cluster. + If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + If no existing records match, new records will be created. + tags: + - orgs + operationId: orgs/set-cluster-deployment-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records + parameters: + - "$ref": "#/components/parameters/org" + - name: cluster + in: path + description: The cluster name. + required: true + schema: + type: string + minLength: 1 + maxLength: 128 + pattern: "^[a-zA-Z0-9._-]+$" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + deployments: + type: array + description: The list of deployments to record. + maxItems: 100 + items: + type: object + properties: + name: + type: string + description: | + The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + the name parameter must also be identical across all entries. + minLength: 1 + maxLength: 256 + digest: + type: string + description: | + The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + the name and version parameters must also be identical across all entries. + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + version: + type: string + description: | + The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + the version parameter must also be identical across all entries. + minLength: 1 + maxLength: 100 + x-multi-segment: true + examples: + - 1.2.3 + status: + type: string + description: The deployment status of the artifact. + enum: + - deployed + - decommissioned + deployment_name: + type: string + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a record set, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. + minLength: 1 + maxLength: 256 + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: "^[A-Za-z0-9.\\-_]+$" + examples: + - my-github-repo + tags: + type: object + description: Key-value pairs to tag the deployment record. + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + required: + - name + - deployment_name + - digest + required: + - logical_environment + - deployments + examples: + default: + value: + logical_environment: prod + physical_environment: pacific-east + deployments: + - name: awesome-image + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + version: 2.1.0 + status: deployed + deployment_name: deployment-pod + tags: + runtime-risk: sensitive-data + responses: + '200': + description: 'Deployment records created or updated successfully. + + ' + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + "$ref": "#/components/schemas/artifact-deployment-record" + examples: + default: + "$ref": "#/components/examples/artifact-deployment-record-list" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/metadata/storage-record": + post: + summary: Create artifact metadata storage record + description: |- + Create metadata storage records for artifacts associated with an organization. + This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + associated with a repository owned by the organization. + tags: + - orgs + operationId: orgs/create-artifact-storage-record + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + minLength: 1 + maxLength: 256 + examples: + - libfoo + digest: + type: string + description: The digest of the artifact (algorithm:hex-encoded-digest). + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + examples: + - sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + examples: + - 1.2.3 + artifact_url: + type: string + format: uri + pattern: "^https://" + description: The URL where the artifact is stored. + examples: + - https://reg.example.com/artifactory/bar/libfoo-1.2.3 + path: + type: string + format: uri + description: The path of the artifact. + examples: + - com/github/bar/libfoo-1.2.3 + registry_url: + type: string + format: uri + pattern: "^https://" + description: The base URL of the artifact registry. + minLength: 1 + examples: + - https://reg.example.com/artifactory/ + repository: + type: string + description: The repository name within the registry. + examples: + - bar + status: + type: string + description: The status of the artifact (e.g., active, inactive). + enum: + - active + - eol + - deleted + default: active + examples: + - active + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: "^[A-Za-z0-9.\\-_]+$" + examples: + - my-github-repo + required: + - name + - digest + - registry_url + examples: + default: + value: + name: libfoo + version: 1.2.3 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + responses: + '200': + description: Artifact metadata storage record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + examples: + - 1 + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: + - string + - 'null' + registry_url: + type: string + repository: + type: + - string + - 'null' + status: + type: string + created_at: + type: string + updated_at: + type: string + examples: + default: + value: + total_count: 1 + storage_records: + - name: libfoo + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": + get: + summary: List artifact deployment records + description: List deployment records for an artifact metadata associated with + an organization. + tags: + - orgs + operationId: orgs/list-artifact-deployment-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/subject-digest" + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records for this digest + and organization + type: integer + examples: + - 3 + deployment_records: + type: array + items: + "$ref": "#/components/schemas/artifact-deployment-record" + examples: + default: + "$ref": "#/components/examples/artifact-deployment-record-list" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": + get: + summary: List artifact storage records + description: |- + List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + + The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + tags: + - orgs + operationId: orgs/list-artifact-storage-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records + parameters: + - "$ref": "#/components/parameters/org" + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + example: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + schema: + type: string + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of storage records for this digest and + organization + type: integer + examples: + - 3 + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + registry_url: + type: string + repository: + type: string + status: + type: string + created_at: + type: string + updated_at: + type: string + examples: + default: + value: + storage_records: + - name: libfoo-1.2.3 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/attestations/bulk-list": + post: + summary: List attestations by bulk subject digests + description: |- + List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + required: + - subject_digests + examples: + default: + "$ref": "#/components/examples/bulk-subject-digest-body" + withPredicateType: + "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + type: + - array + - 'null' + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + "$ref": "#/components/examples/list-attestations-bulk" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/delete-request": + post: + summary: Delete attestations in bulk + description: Delete artifact attestations in bulk by either subject digests + or unique ID. + tags: + - orgs + operationId: orgs/delete-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + oneOf: + - properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests associated with the artifact + attestations to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - properties: + attestation_ids: + type: array + items: + type: integer + description: List of unique IDs associated with the artifact attestations + to delete. + minItems: 1 + maxItems: 1024 + required: + - attestation_ids + description: The request body must include either `subject_digests` + or `attestation_ids`, but not both. + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/digest/{subject_digest}": + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - orgs + operationId: orgs/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest + parameters: + - "$ref": "#/components/parameters/org" + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/{attestation_id}": + delete: + summary: Delete attestations by ID + description: Delete an artifact attestation by unique ID that is associated + with a repository owned by an org. + tags: + - orgs + operationId: orgs/delete-attestations-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id + parameters: + - "$ref": "#/components/parameters/org" + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations @@ -7530,7 +10715,7 @@ paths: operationId: orgs/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-attestations + url: https://docs.github.com/rest/orgs/attestations#list-attestations parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" @@ -7544,6 +10729,15 @@ paths: schema: type: string x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -7558,7 +10752,9 @@ paths: type: object properties: bundle: - type: object + type: + - object + - 'null' properties: mediaType: type: string @@ -7577,6 +10773,8 @@ paths: type: integer bundle_url: type: string + initiator: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -7584,7 +10782,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: orgs - subcategory: orgs + subcategory: attestations "/orgs/{org}/blocks": get: summary: List users blocked by an organization @@ -7688,6 +10886,399 @@ paths: enabledForGitHubApps: true category: orgs subcategory: blocking + "/orgs/{org}/campaigns": + get: + summary: List campaigns for an organization + description: |- + Lists campaigns in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/list-org-campaigns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - name: state + description: If specified, only campaigns with this state will be returned. + in: query + required: false + schema: + "$ref": "#/components/schemas/campaign-state" + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - ends_at + - published + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-org-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + post: + summary: Create a campaign for an organization + description: |- + Create a campaign for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + + Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + in the campaign. + tags: + - campaigns + operationId: campaigns/create-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: The logins of the users to set as the campaign managers. + At this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + description: The login of each manager + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: The end date and time of the campaign. The date must + be in the future. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: + - string + - 'null' + format: uri + code_scanning_alerts: + description: The code scanning alerts to include in this campaign + type: + - array + - 'null' + minItems: 1 + items: + type: object + additionalProperties: false + properties: + repository_id: + type: integer + description: The repository id + alert_numbers: + type: array + description: The alert numbers + minItems: 1 + items: + type: integer + required: + - repository_id + - alert_numbers + generate_issues: + description: If true, will automatically generate issues for the + campaign. The default is false. + type: boolean + default: false + required: + - name + - description + - ends_at + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts + examples: + default: + value: + name: Critical CodeQL alerts + description: Address critical alerts before they are exploited to + prevent breaches, protect sensitive data, and mitigate financial + and reputational damage. + managers: + - octocat + ends_at: '2024-03-14T00:00:00Z' + code_scanning_alerts: + - repository_id: 1296269 + alert_numbers: + - 1 + - 2 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-summary" + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '429': + description: Too Many Requests + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + "/orgs/{org}/campaigns/{campaign_number}": + get: + summary: Get a campaign for an organization + description: |- + Gets a campaign for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/get-campaign-summary + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-summary" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + patch: + summary: Update a campaign + description: |- + Updates a campaign in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/update-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign + parameters: + - "$ref": "#/components/parameters/org" + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: The logins of the users to set as the campaign managers. + At this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: The end date and time of the campaign, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: + - string + - 'null' + format: uri + state: + "$ref": "#/components/schemas/campaign-state" + examples: + default: + value: + name: Critical CodeQL alerts + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-summary" + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + delete: + summary: Delete a campaign for an organization + description: |- + Deletes a campaign in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/delete-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Deletion successful + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns "/orgs/{org}/code-scanning/alerts": get: summary: List code scanning alerts for an organization @@ -7736,6 +11327,14 @@ paths: required: false schema: "$ref": "#/components/schemas/code-scanning-alert-severity" + - name: assignees + description: | + Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -7768,7 +11367,7 @@ paths: The authenticated user must be an administrator or security manager for the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-configurations-for-org @@ -7852,11 +11451,24 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled + - code_security + - secret_protection default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -7898,6 +11510,17 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -7908,6 +11531,22 @@ paths: default: disabled code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: not_set + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -7974,6 +11613,29 @@ paths: - disabled - not_set default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -8025,7 +11687,7 @@ paths: The authenticated user must be an administrator or security manager for the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-default-configurations @@ -8084,6 +11746,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. + Up to 250 IDs can be provided. + minItems: 1 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -8184,10 +11849,23 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. enum: - enabled - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -8224,6 +11902,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -8233,6 +11919,24 @@ paths: - not_set code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -8294,6 +11998,28 @@ paths: - enabled - disabled - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -8515,7 +12241,7 @@ paths: The authenticated user must be an administrator or security manager for the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-repositories-for-configuration @@ -9254,7 +12980,7 @@ paths: 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)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -9640,110 +13366,177 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management - "/orgs/{org}/copilot/metrics": + "/orgs/{org}/copilot/content_exclusion": get: - summary: Get Copilot metrics for an organization + summary: Get Copilot content exclusion rules 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. + > This endpoint is in public preview and is subject to change. - 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. + Gets information about an organization's Copilot content exclusion path rules. + To configure these settings, go to the organization's settings on GitHub. + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." - 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. + Organization owners can view details about Copilot content exclusion rules for the organization. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint. + + > [!CAUTION] + > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. tags: - copilot - operationId: copilot/copilot-metrics-for-organization + operationId: copilot/copilot-content-exclusion-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-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 + description: OK content: application/json: schema: + "$ref": "#/components/schemas/copilot-organization-content-exclusion-details" + examples: + default: + "$ref": "#/components/examples/copilot-organization-content-exclusion-details" + '500': + "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-content-exclusion-management + put: + summary: Set Copilot content exclusion rules for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Sets Copilot content exclusion path rules for an organization. + To configure these settings, go to the organization's settings on GitHub. + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + + Organization owners can set Copilot content exclusion rules for the organization. + + OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + + > [!CAUTION] + > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + tags: + - copilot + operationId: copilot/set-copilot-content-exclusion-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + description: The content exclusion rules to set + required: true + content: + application/json: + schema: + type: object + additionalProperties: type: array items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" + anyOf: + - type: string + description: The path to the file that will be excluded. + - type: object + properties: + ifAnyMatch: + type: array + items: + type: string + required: + - ifAnyMatch + additionalProperties: false + - type: object + properties: + ifNoneMatch: + type: array + items: + type: string + required: + - ifNoneMatch + additionalProperties: false + examples: + default: + summary: Example of content exclusion paths + value: + octo-repo: + - "/src/some-dir/kernel.rs" + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + properties: + message: + type: string examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" + value: + message: Content exclusion rules updated successfully. '500': "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + '413': + "$ref": "#/components/responses/too_large" '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" + "$ref": "#/components/responses/validation_failed_simple" x-github: - githubCloudOnly: false + githubCloudOnly: enabledForGitHubApps: true category: copilot - subcategory: copilot-metrics - "/orgs/{org}/copilot/usage": + subcategory: copilot-content-exclusion-management + "/orgs/{org}/copilot/metrics": get: - summary: Get a summary of Copilot usage for organization members + summary: Get Copilot metrics for an organization description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - See the response schema tab for detailed metrics definitions. + > [!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. Usage metrics are processed once per day for the previous day, + The response contains metrics for up to 100 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. - Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + 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/usage-metrics-for-org + operationId: copilot/copilot-metrics-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members + 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. + Maximum value is 100 days ago. in: query required: false schema: @@ -9758,12 +13551,12 @@ paths: 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)." + description: The number of days of metrics to display per page (max 100). + For 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 + default: 100 responses: '200': description: Response @@ -9772,23 +13565,23 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/copilot-usage-metrics" + "$ref": "#/components/schemas/copilot-usage-metrics-day" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-org" + "$ref": "#/components/examples/copilot-usage-metrics-for-day" '500': "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" '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-usage + subcategory: copilot-metrics "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization @@ -9811,13 +13604,16 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry" + - "$ref": "#/components/parameters/dependabot-alert-org-scope-comma-separated-has" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-runtime-risk" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -10007,7 +13803,9 @@ paths: and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: - type: string + anyOf: + - type: integer + - type: string required: - visibility examples: @@ -10017,8 +13815,8 @@ paths: key_id: '012345678912345678' visibility: selected selected_repository_ids: - - '1296269' - - '1296280' + - 1296269 + - 1296280 responses: '201': description: Response when creating a secret @@ -11528,6 +15326,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: members + "/orgs/{org}/issue-types": + get: + summary: List issue types for an organization + description: Lists all issue types for an organization. OAuth app tokens and + personal access tokens (classic) need the read:org scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-issue-types + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue-type" + examples: + default: + "$ref": "#/components/examples/issue-type-items" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + post: + summary: Create issue type for an organization + description: |- + Create a new issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/create-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-create-issue-type" + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue-type" + examples: + default: + "$ref": "#/components/examples/issue-type" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + "/orgs/{org}/issue-types/{issue_type_id}": + put: + summary: Update issue type for an organization + description: |- + Updates an issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/update-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/issue-type-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-update-issue-type" + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue-type" + examples: + default: + "$ref": "#/components/examples/issue-type" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + delete: + summary: Delete issue type for an organization + description: |- + Deletes an issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/delete-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/issue-type-id" + responses: + '204': + description: Response + '422': + "$ref": "#/components/responses/validation_failed_simple" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types "/orgs/{org}/issues": get: summary: List organization issues assigned to the authenticated user @@ -11581,6 +15541,12 @@ paths: - all default: open - "$ref": "#/components/parameters/labels" + - name: type + description: Can be the name of an issue type. + in: query + required: false + schema: + type: string - name: sort description: What to sort results by. in: query @@ -11635,14 +15601,16 @@ paths: - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) - enabled will be returned. This options is only available for organization - owners. + enabled will be returned. `2fa_insecure` means that only members with [insecure + 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + will be returned. These options are only available for organization owners. in: query required: false schema: type: string enum: - 2fa_disabled + - 2fa_insecure - all default: all - name: role @@ -11714,8 +15682,11 @@ paths: subcategory: members delete: summary: Remove an organization member - description: Removing a user from this list will remove them from all teams - and they will no longer have any access to the organization's repositories. + description: |- + Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + + > [!NOTE] + > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. tags: - orgs operationId: orgs/remove-member @@ -11875,7 +15846,7 @@ paths: 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)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -12020,6 +15991,9 @@ paths: In order to remove a user's membership with an organization, the authenticated user must be an organization owner. If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + + > [!NOTE] + > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. tags: - orgs operationId: orgs/remove-membership-for-user @@ -12723,13 +16697,16 @@ paths: - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) - enabled will be returned. + enabled will be returned. `2fa_insecure` means that only outside collaborators + with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + will be returned. in: query required: false schema: type: string enum: - 2fa_disabled + - 2fa_insecure - all default: all - "$ref": "#/components/parameters/per-page" @@ -13215,6 +17192,7 @@ paths: - "$ref": "#/components/parameters/personal-access-token-permission" - "$ref": "#/components/parameters/personal-access-token-before" - "$ref": "#/components/parameters/personal-access-token-after" + - "$ref": "#/components/parameters/personal-access-token-token-id" responses: '500': "$ref": "#/components/responses/internal_error" @@ -13457,6 +17435,7 @@ paths: - "$ref": "#/components/parameters/personal-access-token-permission" - "$ref": "#/components/parameters/personal-access-token-before" - "$ref": "#/components/parameters/personal-access-token-after" + - "$ref": "#/components/parameters/personal-access-token-token-id" responses: '500': "$ref": "#/components/responses/internal_error" @@ -13654,9 +17633,7 @@ paths: "/orgs/{org}/private-registries": get: summary: List private registries for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. @@ -13706,9 +17683,7 @@ paths: subcategory: organization-configurations post: summary: Create a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." @@ -13733,6 +17708,24 @@ paths: type: string enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri username: description: The username to use when authenticating with the private registry. This field should be omitted if the private registry @@ -13740,6 +17733,15 @@ paths: type: - string - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries @@ -13773,6 +17775,7 @@ paths: type: integer required: - registry_type + - url - encrypted_value - key_id - visibility @@ -13782,7 +17785,9 @@ paths: visibility value: registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ username: monalisa + replaces_base: true encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: private @@ -13791,6 +17796,7 @@ paths: visibility value: registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ username: monalisa encrypted_value: c2VjcmV0 key_id: '012345678912345678' @@ -13822,9 +17828,7 @@ paths: "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. @@ -13874,9 +17878,7 @@ paths: "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. @@ -13909,9 +17911,7 @@ paths: subcategory: organization-configurations patch: summary: Update a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." @@ -13937,6 +17937,24 @@ paths: type: string enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri username: description: The username to use when authenticating with the private registry. This field should be omitted if the private registry @@ -13944,6 +17962,15 @@ paths: type: - string - 'null' + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries @@ -13992,9 +18019,7 @@ paths: subcategory: organization-configurations delete: summary: Delete a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Delete a private registry configuration at the organization-level. @@ -14020,34 +18045,28 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": + "/orgs/{org}/projectsV2": get: - summary: List organization projects - description: Lists the projects in an organization. Returns a `404 Not Found` - status if projects are disabled in the organization. If you do not have sufficient - privileges to perform this action, a `401 Unauthorized` or `410 Gone` status - is returned. + summary: List projects for organization + description: List all projects owned by a specific organization accessible by + the authenticated user. tags: - projects operationId: projects/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-organization-projects + url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - "$ref": "#/components/parameters/org" - - name: state - description: Indicates the state of the projects to return. + - name: q + description: Limit results to projects of the specified type. in: query required: false schema: type: string - enum: - - open - - closed - - all - default: open + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -14056,79 +18075,885 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2" examples: default: - "$ref": "#/components/examples/project-items" + "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed_simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: projects + "/orgs/{org}/projectsV2/{project_number}": + get: + summary: Get project for organization + description: Get a specific organization-owned project. + tags: + - projects + operationId: projects/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2" + examples: + default: + "$ref": "#/components/examples/projects-v2" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/orgs/{org}/projectsV2/{project_number}/drafts": post: - summary: Create an organization project - description: Creates an organization project board. Returns a `410 Gone` status - if projects are disabled in the organization or if the organization does not - have existing classic projects. If you do not have sufficient privileges to - perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + summary: Create draft item for organization owned project + description: Create draft issue item for the specified organization owned project. tags: - projects - operationId: projects/create-for-org + operationId: projects/create-draft-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/projects#create-an-organization-project + url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/project-number" requestBody: required: true + description: Details of the draft item to create in the project. content: application/json: schema: type: object properties: - name: + title: type: string - description: The name of the project. + description: The title of the draft issue item to create in the + project. body: type: string - description: The description of the project. + description: The body content of the draft issue item to create + in the project. required: - - name + - title examples: - default: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + draft_issue: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts + "/orgs/{org}/projectsV2/{project_number}/fields": + get: + summary: List project fields for organization + description: List all fields for a specific organization-owned project. + tags: + - projects + operationId: projects/list-fields-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field-items" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + required: + - issue_field_id + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": + get: + summary: Get project field for organization + description: Get a specific field for an organization-owned project. + tags: + - projects + operationId: projects/get-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/field-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/orgs/{org}/projectsV2/{project_number}/items": + get: + summary: List items for an organization owned project + description: List all items for a specific organization-owned project accessible + by the authenticated user. + tags: + - projects + operationId: projects/list-items-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - name: q + description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + in: query + required: false + schema: + type: string + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + post: + summary: Add item to organization owned project + description: Add an issue or pull request item to the specified organization + owned project. + tags: + - projects + operationId: projects/add-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + description: Details of the item to add to the project. You can specify either + the unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + oneOf: + - required: + - id + - required: + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 responses: '201': description: Response content: application/json: schema: - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": + get: + summary: Get an item for an organization owned project + description: Get a specific item from an organization-owned project. + tags: + - projects + operationId: projects/get-org-item + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/item-id" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" examples: default: - "$ref": "#/components/examples/project-2" + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + patch: + summary: Update project item for organization + description: Update a specific item in an organization-owned project. + tags: + - projects + operationId: projects/update-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#update-project-item-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/item-id" + requestBody: + required: true + description: Field updates to apply to the project item. Only text, number, + date, single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: |- + The new value for the field: + - For text, number, and date fields, provide the new value directly. + - For single select and iteration fields, provide the ID of the option or iteration. + - To clear the field, set this to null. + oneOf: + - type: string + - type: number + type: + - 'null' + - string + - number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + number_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + date_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + single_select_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + iteration_field: + "$ref": "#/components/examples/projects-v2-item-with-content" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" '422': - "$ref": "#/components/responses/validation_failed_simple" + "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects - subcategory: projects + subcategory: items + delete: + summary: Delete project item for organization + description: Delete a specific item from an organization-owned project. + tags: + - projects + operationId: projects/delete-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/item-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/orgs/{org}/projectsV2/{project_number}/views": + post: + summary: Create a view for an organization-owned project + description: Create a new view in an organization-owned project. Views allow + you to customize how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + examples: + - Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + examples: + - board + filter: + type: string + description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + examples: + - is:issue is:open + visible_fields: + type: array + description: |- + `visible_fields` is not applicable to `roadmap` layout views. + For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + items: + type: integer + examples: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in an organization-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-view" + examples: + table_view: + summary: Response for creating a table view + value: + "$ref": "#/components/examples/projects-v2-view" + board_view: + summary: Response for creating a board view with filter + value: + "$ref": "#/components/examples/projects-v2-view" + roadmap_view: + summary: Response for creating a roadmap view + value: + "$ref": "#/components/examples/projects-v2-view" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + description: Service unavailable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: views + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": + get: + summary: List items for an organization project view + description: List items in an organization project with the saved view's filter + applied. + tags: + - projects + operationId: projects/list-view-items-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/view-number" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the + title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items "/orgs/{org}/properties/schema": get: summary: Get all custom properties for an organization @@ -14137,7 +18962,7 @@ paths: Organization members can read these properties. tags: - orgs - operationId: orgs/get-all-custom-properties + operationId: orgs/custom-properties-for-repos-get-organization-definitions externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization @@ -14169,12 +18994,16 @@ paths: description: |- Creates new or updates existing custom properties defined for an organization in a batch. + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs - operationId: orgs/create-or-update-custom-properties + operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization @@ -14243,7 +19072,7 @@ paths: Organization members can read these properties. tags: - orgs - operationId: orgs/get-custom-property + operationId: orgs/custom-properties-for-repos-get-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization @@ -14279,7 +19108,7 @@ paths: - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs - operationId: orgs/create-or-update-custom-property + operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization @@ -14331,7 +19160,7 @@ paths: - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs - operationId: orgs/remove-custom-property + operationId: orgs/custom-properties-for-repos-delete-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization @@ -14358,7 +19187,7 @@ paths: Organization members can read these properties. tags: - orgs - operationId: orgs/list-custom-properties-values-for-repos + operationId: orgs/custom-properties-for-repos-get-organization-values externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories @@ -14417,7 +19246,7 @@ paths: - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. tags: - orgs - operationId: orgs/create-or-update-custom-properties-values-for-repos + operationId: orgs/custom-properties-for-repos-create-or-update-organization-values externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories @@ -14942,7 +19771,7 @@ paths: type: array description: An array of rules within the ruleset. items: - "$ref": "#/components/schemas/repository-rule" + "$ref": "#/components/schemas/org-rules" required: - name - enforcement @@ -14987,6 +19816,8 @@ paths: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/rulesets/rule-suites": @@ -15158,7 +19989,7 @@ paths: description: An array of rules within the ruleset. type: array items: - "$ref": "#/components/schemas/repository-rule" + "$ref": "#/components/schemas/org-rules" examples: default: value: @@ -15200,6 +20031,8 @@ paths: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" delete: @@ -15231,6 +20064,90 @@ paths: "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" + "/orgs/{org}/rulesets/{ruleset_id}/history": + get: + summary: Get organization ruleset history + description: Get the history of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ruleset-version" + examples: + default: + "$ref": "#/components/examples/ruleset-history" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": + get: + summary: Get organization ruleset version + description: Get a version of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-version + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version + parameters: + - "$ref": "#/components/parameters/org" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ruleset-version-with-state" + examples: + default: + "$ref": "#/components/examples/org-ruleset-version-with-state" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization @@ -15251,6 +20168,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -15260,6 +20178,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response @@ -15284,6 +20203,137 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + examples: + default: + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -15383,7 +20433,7 @@ paths: "$ref": "#/components/schemas/team-simple" examples: default: - "$ref": "#/components/examples/team-items" + "$ref": "#/components/examples/team-simple-items" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15446,102 +20496,231 @@ paths: deprecationDate: '2024-12-01' removalDate: '2026-01-01' deprecated: true - "/orgs/{org}/settings/billing/actions": + "/orgs/{org}/settings/immutable-releases": get: - summary: Get GitHub Actions billing for an organization + summary: Get immutable releases settings for an organization description: |- - Gets the summary of the free and paid GitHub Actions minutes used. - - Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + Gets the immutable releases policy for repositories in an organization. - OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - operationId: billing/get-github-actions-billing-org + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - - billing + - orgs + operationId: orgs/get-immutable-releases-settings externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization + url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': - description: Response + description: Immutable releases settings response content: application/json: schema: - "$ref": "#/components/schemas/actions-billing-usage" + "$ref": "#/components/schemas/immutable-releases-organization-settings" examples: default: - "$ref": "#/components/examples/actions-billing-usage" + value: + enforced_repositories: all x-github: githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: billing - "/orgs/{org}/settings/billing/packages": - get: - summary: Get GitHub Packages billing for an organization + enabledForGitHubApps: true + category: orgs + subcategory: orgs + put: + summary: Set immutable releases settings for an organization description: |- - Gets the free and paid storage used for GitHub Packages in gigabytes. + Sets the immutable releases policy for repositories in an organization. - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enforced_repositories: + type: string + description: The policy that controls how immutable releases are + enforced in the organization. + enum: + - all + - none + - selected + examples: + - all + selected_repository_ids: + type: array + description: An array of repository ids for which immutable releases + enforcement should be applied. You can only provide a list of + repository ids when the `enforced_repositories` is set to `selected`. + You can add and remove individual repositories using the [Enable + a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + and [Disable a selected repository for immutable releases in an + organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + endpoints. + items: + type: integer + required: + - enforced_repositories + examples: + default: + value: + enforced_repositories: all + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/settings/immutable-releases/repositories": + get: + summary: List selected repositories for immutable releases enforcement + description: |- + List all of the repositories that have been selected for immutable releases enforcement in an organization. - OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - operationId: billing/get-github-packages-billing-org + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - - billing + - orgs + operationId: orgs/get-immutable-releases-settings-repositories externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization + url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: - "$ref": "#/components/schemas/packages-billing-usage" + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/minimal-repository" examples: default: - "$ref": "#/components/examples/packages-billing-usage" + "$ref": "#/components/examples/public-repository-paginated" x-github: githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: billing - "/orgs/{org}/settings/billing/shared-storage": - get: - summary: Get shared storage billing for an organization + enabledForGitHubApps: true + category: orgs + subcategory: orgs + put: + summary: Set selected repositories for immutable releases enforcement description: |- - Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids for which immutable releases + enforcement should be applied. You can only provide a list of + repository ids when the `enforced_repositories` is set to `selected`. + You can add and remove individual repositories using the [Enable + a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + and [Disable a selected repository for immutable releases in an + organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": + put: + summary: Enable a selected repository for immutable releases in an organization + description: |- + Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - operationId: billing/get-shared-storage-billing-org + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: orgs/enable-selected-repository-immutable-releases-organization tags: - - billing + - orgs externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization + url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" responses: - '200': + '204': description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/combined-billing-usage" - examples: - default: - "$ref": "#/components/examples/combined-billing-usage" x-github: githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: billing + enabledForGitHubApps: true + category: orgs + subcategory: orgs + delete: + summary: Disable a selected repository for immutable releases in an organization + description: |- + Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: orgs/disable-selected-repository-immutable-releases-organization + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/settings/network-configurations": get: summary: List hosted compute network configurations for an organization @@ -15623,8 +20802,9 @@ paths: type: array minItems: 1 maxItems: 1 - description: The identifier of the network settings to use for the - network configuration. Exactly one network settings must be specified. + description: A list of identifiers of the network settings resources + to use for the network configuration. Exactly one resource identifier + must be specified in the list. items: type: string required: @@ -15723,8 +20903,9 @@ paths: type: array minItems: 0 maxItems: 1 - description: The identifier of the network settings to use for the - network configuration. Exactly one network settings must be specified. + description: A list of identifiers of the network settings resources + to use for the network configuration. Exactly one resource identifier + must be specified in the list. items: type: string examples: @@ -15815,7 +20996,7 @@ paths: > [!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, + The response contains metrics for up to 100 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. @@ -15835,7 +21016,7 @@ paths: - 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. + Maximum value is 100 days ago. in: query required: false schema: @@ -15850,12 +21031,12 @@ paths: 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)." + description: The number of days of metrics to display per page (max 100). + For 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 + default: 100 responses: '200': description: Response @@ -15881,85 +21062,6 @@ paths: 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 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. - See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/usage-metrics-for-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-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" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-org" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/orgs/{org}/teams": get: summary: List teams @@ -16026,8 +21128,8 @@ paths: description: The description of the team. maintainers: type: array - description: List GitHub IDs for organization members who will become - team maintainers. + description: List GitHub usernames for organization members who + will become team maintainers. items: type: string repo_names: @@ -16254,767 +21356,13 @@ paths: responses: '204': description: Response + '422': + "$ref": "#/components/responses/enterprise_team_unsupported" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams - "/orgs/{org}/teams/{team_slug}/discussions": - get: - summary: List discussions - description: |- - List all discussions on a team's page. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#list-discussions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - - name: pinned - in: query - required: false - description: Pinned discussions only filter - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - post: - summary: Create a discussion - description: |- - Creates a new discussion post on a team's page. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#create-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - private: - type: boolean - description: Private posts are only visible to team members, organization - owners, and team maintainers. Public posts are visible to all - members of the organization. Set to `true` to create a private - post. - default: false - required: - - title - - body - examples: - default: - value: - title: Our first team post - body: Hi! This is an area for us to collaborate as a team. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": - get: - summary: Get a discussion - description: |- - Get a specific discussion on a team's page. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#get-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - patch: - summary: Update a discussion - description: |- - Edits the title and body text of a discussion post. Only the parameters you provide are updated. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#update-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - examples: - default: - value: - title: Welcome to our first team post - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - delete: - summary: Delete a discussion - description: |- - Delete a discussion from a team's page. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#delete-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": - get: - summary: List discussion comments - description: |- - List all comments on a team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussion-comments-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - post: - summary: Create a discussion comment - description: |- - Creates a new comment on a team discussion. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like apples? - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": - get: - summary: Get a discussion comment - description: |- - Get a specific comment on a team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - patch: - summary: Update a discussion comment - description: |- - Edits the body text of a discussion comment. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like pineapples? - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - delete: - summary: Delete a discussion comment - description: |- - Deletes a comment on a team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations @@ -17049,6 +21397,8 @@ paths: headers: Link: "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/enterprise_team_unsupported" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17242,172 +21592,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - Lists the organization projects for a team. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - put: - summary: Add or update team project permissions - description: |- - 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. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - delete: - summary: Remove a project from a team - description: |- - 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. This endpoint removes the project from the team, but does not delete the project. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -17662,1235 +21846,259 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": + "/rate_limit": get: - summary: Get a project card - description: Gets information about a project card. + summary: Get rate limit status for the authenticated user + description: |- + > [!NOTE] + > Accessing this endpoint does not count against your REST API rate limit. + + Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." + + > [!NOTE] + > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - - projects - operationId: projects/get-card + - rate-limit + operationId: rate-limit/get externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/cards#get-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" + url: https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user + parameters: [] responses: '200': description: Response content: application/json: schema: - "$ref": "#/components/schemas/project-card" + "$ref": "#/components/schemas/rate-limit-overview" examples: default: - "$ref": "#/components/examples/project-card" + "$ref": "#/components/examples/rate-limit-overview" + headers: + X-RateLimit-Limit: + "$ref": "#/components/headers/x-rate-limit-limit" + X-RateLimit-Remaining: + "$ref": "#/components/headers/x-rate-limit-remaining" + X-RateLimit-Reset: + "$ref": "#/components/headers/x-rate-limit-reset" '304': "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: projects - subcategory: cards - patch: - summary: Update an existing project card - description: '' + category: rate-limit + subcategory: rate-limit + "/repos/{owner}/{repo}": + get: + summary: Get a repository + description: |- + The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. + + > [!NOTE] + > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. tags: - - projects - operationId: projects/update-card + - repos + operationId: repos/get externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card + url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - "$ref": "#/components/parameters/card-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - type: - - string - - 'null' - examples: - - Update all gems - archived: - description: Whether or not the card is archived - type: boolean - examples: - - false - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: - "$ref": "#/components/schemas/project-card" + "$ref": "#/components/schemas/full-repository" examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" + default-response: + "$ref": "#/components/examples/full-repository-default-response" '403': "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - delete: - summary: Delete a project card - description: Deletes a project card - tags: - - projects - operationId: projects/delete-card - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/cards#delete-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" + '301': + "$ref": "#/components/responses/moved_permanently" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: projects - subcategory: cards - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - description: '' + category: repos + subcategory: repos + patch: + summary: Update a repository + description: "**Note**: To edit a repository's topics, use the [Replace all + repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) + endpoint." tags: - - projects - operationId: projects/move-card + - repos + operationId: repos/update externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/cards#move-a-project-card + url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - "$ref": "#/components/parameters/card-id" + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" requestBody: - required: true + required: false content: application/json: schema: + type: object properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' + name: type: string - pattern: "^(?:top|bottom|after:\\d+)$" - examples: - - bottom - column_id: - description: The unique identifier of the column the card should - be moved to - type: integer - examples: - - 42 - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: + description: The name of the repository. + description: + type: string + description: A short description of the repository. + homepage: + type: string + description: A URL with more information about the repository. + private: + type: boolean + description: "Either `true` to make the repository private or `false` + to make it public. Default: `false`. \n**Note**: You will get + a `422` error if the organization restricts [changing repository + visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) + to organization owners and a non-owner tries to change the value + of private." + default: false + visibility: + type: string + description: The visibility of the repository. + enum: + - public + - private + security_and_analysis: + type: + - object + - 'null' + description: |- + Specify which security and analysis features to enable or disable for the repository. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + + You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. + properties: + advanced_security: type: object + description: |- + Use the `status` property to enable or disable GitHub Advanced Security for this repository. + For more information, see "[About GitHub Advanced + Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. properties: - code: - type: string - message: - type: string - resource: + status: type: string - field: + description: Can be `enabled` or `disabled`. + code_security: + type: object + description: Use the `status` property to enable or disable + GitHub Code Security for this repository. + properties: + status: type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: + description: Can be `enabled` or `disabled`. + secret_scanning: type: object + description: Use the `status` property to enable or disable + secret scanning for this repository. For more information, + see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." properties: - code: + status: type: string - message: + description: Can be `enabled` or `disabled`. + secret_scanning_push_protection: + type: object + description: Use the `status` property to enable or disable + secret scanning push protection for this repository. For more + information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + properties: + status: type: string - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: Gets information about a project column. - tags: - - projects - operationId: projects/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#get-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - patch: - summary: Update an existing project column - description: '' - tags: - - projects - operationId: projects/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - delete: - summary: Delete a project column - description: Deletes a project column. - tags: - - projects - operationId: projects/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#delete-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - "/projects/columns/{column_id}/cards": - get: - summary: List project cards - description: Lists the project cards in a project. - tags: - - projects - operationId: projects/list-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/cards#list-project-cards - parameters: - - "$ref": "#/components/parameters/column-id" - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card-items" - headers: - Link: - "$ref": "#/components/headers/link" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - post: - summary: Create a project card - description: '' - tags: - - projects - operationId: projects/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/cards#create-a-project-card - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - type: - - string - - 'null' - examples: - - Update all gems - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - type: integer - examples: - - 42 - content_type: - description: The piece of content associated with the card - type: string - examples: - - PullRequest - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - "$ref": "#/components/schemas/validation-error" - - "$ref": "#/components/schemas/validation-error-simple" - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: '' - tags: - - projects - operationId: projects/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#move-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - type: string - pattern: "^(?:first|last|after:\\d+)$" - examples: - - last - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - "/projects/{project_id}": - get: - summary: Get a project - description: Gets a project by its `id`. Returns a `404 Not Found` status if - projects are disabled. If you do not have sufficient privileges to perform - this action, a `401 Unauthorized` or `410 Gone` status is returned. - tags: - - projects - operationId: projects/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#get-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - patch: - summary: Update a project - description: Updates a project board's information. Returns a `404 Not Found` - status if projects are disabled. If you do not have sufficient privileges - to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - operationId: projects/update - tags: - - projects - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#update-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - state: - description: State of the project; either 'open' or 'closed' - type: string - examples: - - open - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - delete: - summary: Delete a project - description: Deletes a project board. Returns a `404 Not Found` status if projects - are disabled. - operationId: projects/delete - tags: - - projects - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#delete-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Delete Success - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '410': - "$ref": "#/components/responses/gone" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: Lists the collaborators for an organization project. For a project, - the list of collaborators includes outside collaborators, organization members - that are direct collaborators, organization members with access through team - memberships, organization members with access through default organization - permissions, and organization owners. You must be an organization owner or - a project `admin` to list collaborators. - tags: - - projects - operationId: projects/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators - parameters: - - "$ref": "#/components/parameters/project-id" - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/simple-user" - examples: - default: - "$ref": "#/components/examples/simple-user-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: Adds a collaborator to an organization project and sets their permission - level. You must be an organization owner or a project `admin` to add a collaborator. - tags: - - projects - operationId: projects/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - requestBody: - required: false - content: - application/json: - schema: - type: - - object - - 'null' - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - type: string - examples: - - write - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - delete: - summary: Remove user as a collaborator - description: Removes a collaborator from an organization project. You must be - an organization owner or a project `admin` to remove a collaborator. - tags: - - projects - operationId: projects/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: 'Returns the collaborator''s permission level for an organization - project. Possible values for the `permission` key: `admin`, `write`, `read`, - `none`. You must be an organization owner or a project `admin` to review a - user''s permission level.' - tags: - - projects - operationId: projects/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-collaborator-permission" - examples: - default: - "$ref": "#/components/examples/project-collaborator-permission" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - "/projects/{project_id}/columns": - get: - summary: List project columns - description: Lists the project columns in a project. - tags: - - projects - operationId: projects/list-columns - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#list-project-columns - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column-items" - headers: - Link: - "$ref": "#/components/headers/link" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - post: - summary: Create a project column - description: Creates a new project column. - tags: - - projects - operationId: projects/create-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#create-a-project-column - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - required: - - name - type: object - examples: - default: - value: - name: Remaining tasks - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - "/rate_limit": - get: - summary: Get rate limit status for the authenticated user - description: |- - > [!NOTE] - > Accessing this endpoint does not count against your REST API rate limit. - - Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." - * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." - * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." - * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." - * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." - - > [!NOTE] - > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - tags: - - rate-limit - operationId: rate-limit/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/rate-limit-overview" - examples: - default: - "$ref": "#/components/examples/rate-limit-overview" - headers: - X-RateLimit-Limit: - "$ref": "#/components/headers/x-rate-limit-limit" - X-RateLimit-Remaining: - "$ref": "#/components/headers/x-rate-limit-remaining" - X-RateLimit-Reset: - "$ref": "#/components/headers/x-rate-limit-reset" - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: rate-limit - subcategory: rate-limit - "/repos/{owner}/{repo}": - get: - summary: Get a repository - description: |- - The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. - - > [!NOTE] - > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - tags: - - repos - operationId: repos/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#get-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/full-repository" - examples: - default-response: - "$ref": "#/components/examples/full-repository-default-response" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '301': - "$ref": "#/components/responses/moved_permanently" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - patch: - summary: Update a repository - description: "**Note**: To edit a repository's topics, use the [Replace all - repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) - endpoint." - tags: - - repos - operationId: repos/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#update-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the repository. - description: - type: string - description: A short description of the repository. - homepage: - type: string - description: A URL with more information about the repository. - private: - type: boolean - description: "Either `true` to make the repository private or `false` - to make it public. Default: `false`. \n**Note**: You will get - a `422` error if the organization restricts [changing repository - visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) - to organization owners and a non-owner tries to change the value - of private." - default: false - visibility: - type: string - description: The visibility of the repository. - enum: - - public - - private - security_and_analysis: - type: - - object - - 'null' - description: |- - Specify which security and analysis features to enable or disable for the repository. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. - - You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - properties: - advanced_security: + description: Can be `enabled` or `disabled`. + secret_scanning_ai_detection: type: object description: Use the `status` property to enable or disable - GitHub Advanced Security for this repository. For more information, - see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + 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: + secret_scanning_non_provider_patterns: type: object description: Use the `status` property to enable or disable - secret scanning for this repository. For more information, - see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." + 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)." properties: status: type: string description: Can be `enabled` or `disabled`. - secret_scanning_push_protection: + secret_scanning_delegated_alert_dismissal: type: object description: Use the `status` property to enable or disable - secret scanning push protection for this repository. For more - information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + secret scanning delegated alert dismissal for this repository. properties: status: type: string description: Can be `enabled` or `disabled`. - secret_scanning_ai_detection: + secret_scanning_delegated_bypass: 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)." + secret scanning delegated bypass for this repository. properties: status: type: string description: Can be `enabled` or `disabled`. - secret_scanning_non_provider_patterns: + secret_scanning_delegated_bypass_options: type: object - 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)." + description: |- + Feature options for secret scanning delegated bypass. + This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. properties: - status: - type: string - description: Can be `enabled` or `disabled`. + reviewers: + type: array + description: |- + The bypass reviewers for secret scanning delegated bypass. + If you omit this field, the existing set of reviewers is unchanged. + 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 has_issues: type: boolean description: Either `true` to enable issues for this repository @@ -19097,6 +22305,8 @@ paths: "$ref": "#/components/responses/temporary_redirect" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19244,6 +22454,156 @@ paths: enabledForGitHubApps: true category: actions subcategory: artifacts + "/repos/{owner}/{repo}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/repos/{owner}/{repo}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository @@ -19749,6 +23109,8 @@ paths: "$ref": "#/components/schemas/actions-enabled" allowed_actions: "$ref": "#/components/schemas/allowed-actions" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled examples: @@ -19756,6 +23118,7 @@ paths: value: enabled: true allowed_actions: selected + sha_pinning_required: true x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19830,19 +23193,19 @@ paths: previews: [] category: actions subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/selected-actions": + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": get: - summary: Get allowed actions and reusable workflows for a repository + summary: Get artifact and log retention settings for a repository description: |- - Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + Gets artifact and log retention settings for a repository. - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-allowed-actions-repository + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository tags: - actions externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -19852,62 +23215,68 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/selected-actions" + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" examples: default: - "$ref": "#/components/examples/selected-actions" + value: + days: 90 + maximum_allowed_days: 365 + '404': + "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true - githubCloudOnly: false category: actions subcategory: permissions put: - summary: Set allowed actions and reusable workflows for a repository + summary: Set artifact and log retention settings for a repository description: |- - Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + Sets artifact and log retention settings for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-allowed-actions-repository + operationId: actions/set-artifact-and-log-retention-settings-repository tags: - actions externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': - description: Response + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" requestBody: - required: false + required: true content: application/json: schema: - "$ref": "#/components/schemas/selected-actions" + "$ref": "#/components/schemas/actions-artifact-and-log-retention" examples: - selected_actions: - "$ref": "#/components/examples/selected-actions" + default: + summary: Set retention days + value: + days: 90 x-github: enabledForGitHubApps: true - githubCloudOnly: false category: actions subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/workflow": + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": get: - summary: Get default workflow permissions for a repository + summary: Get fork PR contributor approval permissions for a repository description: |- - Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - as well as if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + Gets the fork PR contributor approval policy for a repository. - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository tags: - actions - operationId: actions/get-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -19917,132 +23286,335 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/actions-get-default-workflow-permissions" + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: - "$ref": "#/components/examples/actions-default-workflow-permissions" + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions put: - summary: Set default workflow permissions for a repository + summary: Set fork PR contributor approval permissions for a repository description: |- - Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + Sets the fork PR contributor approval policy for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository tags: - actions - operationId: actions/set-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': - description: Success response - '409': - description: Conflict response when changing a setting is prevented by the - owning organization + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: - "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: - "$ref": "#/components/examples/actions-default-workflow-permissions" + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions - "/repos/{owner}/{repo}/actions/runners": + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": get: - summary: List self-hosted runners for a repository + summary: Get private repo fork PR workflow settings for a repository description: |- - Lists all self-hosted runners configured in a repository. - - Authenticated users must have admin access to the repository to use this endpoint. + Gets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository tags: - actions - operationId: actions/list-self-hosted-runners-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - name: name - description: The name of a self-hosted runner. - in: query - schema: - type: string - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$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: integer - runners: - type: array - items: - "$ref": "#/components/schemas/runner" + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" examples: default: - "$ref": "#/components/examples/runner-paginated" - headers: - Link: - "$ref": "#/components/headers/link" + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/downloads": - get: - summary: List runner applications for a repository + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for a repository description: |- - Lists binaries for the runner application that you can download and run. - - Authenticated users must have admin access to the repository to use this endpoint. + Sets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository tags: - actions - operationId: actions/list-runner-applications-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/runner-application" + '204': + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/selected-actions": + get: + summary: Get allowed actions and reusable workflows for a repository + description: |- + Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + put: + summary: Set allowed actions and reusable workflows for a repository + description: |- + Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/workflow": + get: + summary: Get default workflow permissions for a repository + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, + as well as if GitHub Actions can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-get-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set default workflow permissions for a repository + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions + can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Success response + '409': + description: Conflict response when changing a setting is prevented by the + owning organization + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/runners": + get: + summary: List self-hosted runners for a repository + description: |- + Lists all self-hosted runners configured in a repository. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$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: integer + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + "/repos/{owner}/{repo}/actions/runners/downloads": + get: + summary: List runner applications for a repository + description: |- + Lists binaries for the runner application that you can download and run. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-runner-applications-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/runner-application" examples: default: "$ref": "#/components/examples/runner-application-items" @@ -20117,6 +23689,8 @@ paths: "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20255,6 +23829,8 @@ paths: responses: '204': description: Response + '422': + "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21215,7 +24791,7 @@ paths: value: x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": @@ -21269,12 +24845,19 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": get: summary: Get workflow run usage - description: |- - Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + description: "> [!WARNING] \n> This endpoint is in the process of closing down. + Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints + closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" + for more information.\n\nGets the number of billable minutes and total run + time for a specific workflow run. Billable minutes only apply to workflows + in private repositories that use GitHub-hosted runners. Usage is listed for + each GitHub-hosted runner operating system in milliseconds. Any job re-runs + are also included in the usage. The usage does not include the multiplier + for macOS and Windows runners and is not rounded up to the nearest whole minute. + For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone + with read access to the repository can use this endpoint.\n\nOAuth app tokens + and personal access tokens (classic) need the `repo` scope to use this endpoint + with a private repository." tags: - actions operationId: actions/get-workflow-run-usage @@ -21453,6 +25036,9 @@ paths: key_id: type: string description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id examples: default: value: @@ -21835,7 +25421,17 @@ paths: - "$ref": "#/components/parameters/workflow-id" responses: '204': - description: Response + description: Empty response when `return_run_details` parameter is `false`. + '200': + description: Response including the workflow run ID and URLs when `return_run_details` + parameter is `true`. + content: + application/json: + schema: + "$ref": "#/components/schemas/workflow-dispatch-response" + examples: + default: + "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -21850,11 +25446,15 @@ paths: inputs: type: object description: Input keys and values configured in the workflow file. - The maximum number of properties is 10. Any default properties + The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. additionalProperties: true - maxProperties: 10 + maxProperties: 25 + return_run_details: + type: boolean + description: Whether the response should include the workflow run + ID and URLs. required: - ref examples: @@ -21956,14 +25556,20 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": get: summary: Get workflow usage - description: |- - Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - - You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + description: "> [!WARNING] \n> This endpoint is in the process of closing down. + Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints + closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" + for more information.\n\nGets the number of billable minutes used by a specific + workflow during the current billing cycle. Billable minutes only apply to + workflows in private repositories that use GitHub-hosted runners. Usage is + listed for each GitHub-hosted runner operating system in milliseconds. Any + job re-runs are also included in the usage. The usage does not include the + multiplier for macOS and Windows runners and is not rounded up to the nearest + whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou + can replace `workflow_id` with the workflow file name. For example, you could + use `main.yaml`.\n\nAnyone with read access to the repository can use this + endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the + `repo` scope to use this endpoint with a private repository." tags: - actions operationId: actions/get-workflow-usage @@ -22169,7 +25775,7 @@ paths: operationId: repos/create-attestation externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#create-an-attestation + url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -22226,7 +25832,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: repos - subcategory: repos + subcategory: attestations "/repos/{owner}/{repo}/attestations/{subject_digest}": get: summary: List attestations @@ -22241,7 +25847,7 @@ paths: operationId: repos/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-attestations + url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -22256,6 +25862,15 @@ paths: schema: type: string x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -22289,6 +25904,8 @@ paths: type: integer bundle_url: type: string + initiator: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -22296,7 +25913,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: repos - subcategory: repos + subcategory: attestations "/repos/{owner}/{repo}/autolinks": get: summary: Get all autolinks of a repository @@ -25170,11 +28787,9 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - - OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/rerequest-run @@ -25437,10 +29052,10 @@ paths: "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": post: summary: Rerequest a check suite - description: |- - Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - - OAuth apps and personal access tokens (classic) cannot use this endpoint. + description: Triggers GitHub to rerequest an existing check suite, without pushing + new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) + event with the action `rerequested`. When a check suite is `rerequested`, + its `status` is reset to `queued` and the `conclusion` is cleared. tags: - checks operationId: checks/rerequest-suite @@ -25519,6 +29134,14 @@ paths: required: false schema: "$ref": "#/components/schemas/code-scanning-alert-severity" + - name: assignees + description: | + Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -25612,8 +29235,15 @@ paths: "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - required: - - state + create_request: + "$ref": "#/components/schemas/code-scanning-alert-create-request" + assignees: + "$ref": "#/components/schemas/code-scanning-alert-assignees" + anyOf: + - required: + - state + - required: + - assignees examples: default: value: @@ -25621,6 +29251,7 @@ paths: dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + create_request: true responses: '200': description: Response @@ -25631,6 +29262,8 @@ paths: examples: default: "$ref": "#/components/examples/code-scanning-alert-dismissed" + '400': + "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': @@ -25742,7 +29375,7 @@ paths: description: |- Commits an autofix for a code scanning alert. - If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: @@ -25818,7 +29451,7 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/code-scanning-alert-instance" + "$ref": "#/components/schemas/code-scanning-alert-instance-list" examples: default: "$ref": "#/components/examples/code-scanning-alert-instances" @@ -25960,7 +29593,7 @@ paths: examples: response: "$ref": "#/components/examples/code-scanning-analysis-default" - application/json+sarif: + application/sarif+json: schema: type: object additionalProperties: true @@ -25971,6 +29604,8 @@ paths: "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/unprocessable_analysis" '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -26540,6 +30175,8 @@ paths: "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/code_scanning_conflict" + '422': + "$ref": "#/components/responses/code_scanning_invalid_state" '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -27346,7 +30983,7 @@ paths: Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: - codespaces operationId: codespaces/create-or-update-repo-secret @@ -27401,7 +31038,7 @@ paths: description: |- Deletes a development environment secret in a repository using the secret name. - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: - codespaces operationId: codespaces/delete-repo-secret @@ -27425,12 +31062,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -27527,11 +31164,13 @@ paths: put: summary: Add a repository collaborator description: |- - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). - Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. - For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: ``` Cannot assign {member} permission of {role name} @@ -27541,6 +31180,8 @@ paths: The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). + For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + **Updating an existing collaborator's permission level** The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -27595,7 +31236,14 @@ paths: - an organization member is added as an individual collaborator - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator '422': - "$ref": "#/components/responses/validation_failed" + description: |- + Response when: + - validation failed, or the endpoint has been spammed + - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + content: + application/json: + schema: + "$ref": "#/components/schemas/validation-error" '403': "$ref": "#/components/responses/forbidden" x-github: @@ -27612,8 +31260,8 @@ paths: To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. This endpoint also: - - Cancels any outstanding invitations - - Unasigns the user from any issues + - Cancels any outstanding invitations sent by the collaborator + - Unassigns the user from any issues - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - Unstars the repository - Updates access permissions to packages @@ -27655,13 +31303,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level @@ -28277,7 +31927,7 @@ paths: get: summary: List pull requests associated with a commit description: |- - Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. tags: @@ -28793,6 +32443,23 @@ paths: required: false schema: type: string + requestBody: + required: false + content: + application/json: + examples: + response-if-content-is-a-file-github-object: + summary: Content is a file using the object media type + response-if-content-is-a-directory-github-object: + summary: Content is a directory using the object media type + response-if-content-is-a-file: + summary: Content is a file + response-if-content-is-a-directory: + summary: Content is a directory + response-if-content-is-a-symlink: + summary: Content is a symlink + response-if-content-is-a-submodule: + summary: Content is a submodule responses: '200': description: Response @@ -28801,9 +32468,9 @@ paths: schema: "$ref": "#/components/schemas/content-tree" examples: - response-if-content-is-a-file: + response-if-content-is-a-file-github-object: "$ref": "#/components/examples/content-file-response-if-content-is-a-file" - response-if-content-is-a-directory: + response-if-content-is-a-directory-github-object: "$ref": "#/components/examples/content-file-response-if-content-is-a-directory-object" application/json: schema: @@ -29155,29 +32822,14 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - 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: - type: integer - default: 1 - - name: per_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)." - deprecated: true - in: query - schema: - type: integer - default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" + - "$ref": "#/components/parameters/per-page" responses: '200': description: Response @@ -29290,8 +32942,19 @@ paths: description: An optional comment associated with dismissing the alert. maxLength: 280 - required: - - state + assignees: + type: array + description: |- + Usernames to assign to this Dependabot Alert. + Pass one or more user logins to _replace_ the set of assignees on this alert. + Send an empty array (`[]`) to clear all assignees from the alert. + items: + type: string + anyOf: + - required: + - state + - required: + - assignees additionalProperties: false examples: default: @@ -30689,7 +34352,7 @@ paths: The authenticated user must have admin or owner permissions to the repository to use this endpoint. - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -31992,7 +35655,8 @@ paths: '204': description: Response '422': - "$ref": "#/components/responses/validation_failed" + description: Validation failed, an attempt was made to delete the default + branch, or the endpoint has been spammed. '409': "$ref": "#/components/responses/conflict" x-github: @@ -32867,6 +36531,86 @@ paths: enabledForGitHubApps: true category: repos subcategory: webhooks + "/repos/{owner}/{repo}/immutable-releases": + get: + summary: Check if immutable releases are enabled for a repository + description: |- + Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + enforced by the repository owner. The authenticated user must have admin read access to the repository. + tags: + - repos + operationId: repos/check-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response if immutable releases are enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/check-immutable-releases" + examples: + default: + value: + enabled: true + enforced_by_owner: false + '404': + description: Not Found if immutable releases are not enabled for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + put: + summary: Enable immutable releases + description: Enables immutable releases for a repository. The authenticated + user must have admin access to the repository. + tags: + - repos + operationId: repos/enable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-immutable-releases + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + delete: + summary: Disable immutable releases + description: Disables immutable releases for a repository. The authenticated + user must have admin access to the repository. + tags: + - repos + operationId: repos/disable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-immutable-releases + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos "/repos/{owner}/{repo}/import": get: summary: Get an import status @@ -33662,6 +37406,14 @@ paths: required: false schema: type: string + - name: type + description: Can be the name of an issue type. If the string `*` is passed, + issues with any type are accepted. If the string `none` is passed, issues + without type are returned. + in: query + required: false + schema: + type: string - name: creator description: The user that created the issue. in: query @@ -33802,6 +37554,15 @@ paths: are silently dropped otherwise._' items: type: string + type: + type: + - string + - 'null' + description: 'The name of the issue type to associate with this + issue. _NOTE: Only users with push access can set the type for + new issues. The type is silently dropped otherwise._' + examples: + - Epic required: - title examples: @@ -34022,6 +37783,84 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": + put: + summary: Pin an issue comment + description: |- + You can use the REST API to pin comments on issues. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/pin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/comment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue-comment" + examples: + default: + "$ref": "#/components/examples/issue-comment-pinned" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + delete: + summary: Unpin an issue comment + description: You can use the REST API to unpin comments on issues. + tags: + - issues + operationId: issues/unpin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/comment-id" + responses: + '204': + description: Response + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment @@ -34276,6 +38115,15 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" + requestBody: + required: false + content: + application/json: + examples: + default: + summary: Get an issue + pinned_comment: + summary: Get an issue with a pinned comment responses: '200': description: Response @@ -34285,7 +38133,13 @@ paths: "$ref": "#/components/schemas/issue" examples: default: - "$ref": "#/components/examples/issue" + summary: Issue + value: + "$ref": "#/components/examples/issue" + pinned_comment: + summary: Issue with pinned comment + value: + "$ref": "#/components/examples/issue-with-pinned-comment" '301': "$ref": "#/components/responses/moved_permanently" '404': @@ -34360,6 +38214,7 @@ paths: enum: - completed - not_planned + - duplicate - reopened - description: The reason for the state change. Ignored unless `state` @@ -34411,6 +38266,16 @@ paths: push access to the repository, assignee changes are silently dropped. items: type: string + type: + type: + - string + - 'null' + description: The name of the issue type to associate with this issue + or use `null` to remove the current issue type. Only users with + push access can set the type for issues. Without push access to + the repository, type changes are silently dropped. + examples: + - Epic examples: default: value: @@ -34706,6 +38571,237 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + "$ref": "#/components/responses/moved_permanently" + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -34788,8 +38884,7 @@ paths: subcategory: labels post: summary: Add labels to an issue - description: 'Adds labels to an issue. If you provide an empty array of labels, - all labels are removed from the issue. ' + description: Adds labels to an issue. tags: - issues operationId: issues/add-labels @@ -34812,31 +38907,16 @@ paths: type: array minItems: 1 description: The names of the labels to add to the issue's existing - labels. You can pass an empty array to remove all labels. Alternatively, - you can pass a single label as a `string` or an `array` of labels - directly, but GitHub recommends passing an object with the `labels` - key. You can also replace all of the labels for an issue. For - more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." + labels. You can also pass an `array` of labels directly, but + GitHub recommends passing an object with the `labels` key. To + replace all of the labels for an issue, use "[Set labels for + an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." items: type: string - type: array - minItems: 1 items: type: string - - type: object - properties: - labels: - type: array - minItems: 1 - items: - type: object - properties: - name: - type: string - required: - - name - type: array - minItems: 1 items: type: object properties: @@ -34844,7 +38924,6 @@ paths: type: string required: - name - - type: string examples: default: value: @@ -35119,6 +39198,49 @@ paths: enabledForGitHubApps: true category: issues subcategory: issues + "/repos/{owner}/{repo}/issues/{issue_number}/parent": + get: + summary: Get parent issue + description: |- + You can use the REST API to get the parent issue of a sub-issue. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/get-parent + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue @@ -35239,7 +39361,7 @@ paths: "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": @@ -35339,11 +39461,11 @@ paths: description: |- You can use the REST API to list the sub-issues on an issue. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues @@ -35416,7 +39538,7 @@ paths: sub_issue_id: type: integer description: The id of the sub-issue to add. The sub-issue must - belong to the same repository as the parent issue + belong to the same repository owner as the parent issue replace_parent: type: boolean description: Option that, when true, instructs the operation to @@ -36951,7 +41073,6 @@ paths: environment: github-pages pages_build_version: 4fd754f7e594640989b406850d0bc8f06a121251 oidc_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA - preview: false responses: '200': description: Response @@ -37172,125 +41293,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository projects - description: Lists the projects in a repository. Returns a `404 Not Found` status - if projects are disabled in the repository. If you do not have sufficient - privileges to perform this action, a `401 Unauthorized` or `410 Gone` status - is returned. - tags: - - projects - operationId: projects/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-repository-projects - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-2" - headers: - Link: - "$ref": "#/components/headers/link" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - post: - summary: Create a repository project - description: Creates a repository project board. Returns a `410 Gone` status - if projects are disabled in the repository or if the repository does not have - existing classic projects. If you do not have sufficient privileges to perform - this action, a `401 Unauthorized` or `410 Gone` status is returned. - tags: - - projects - operationId: projects/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#create-a-repository-project - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -37299,7 +41301,7 @@ paths: Users with read access to the repository can use this endpoint. tags: - repos - operationId: repos/get-custom-properties-values + operationId: repos/custom-properties-for-repos-get-repository-values externalDocs: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository @@ -37336,7 +41338,7 @@ paths: Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. tags: - repos - operationId: repos/create-or-update-custom-properties-values + operationId: repos/custom-properties-for-repos-create-or-update-repository-values externalDocs: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository @@ -40466,6 +44468,8 @@ paths: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/rulesets/rule-suites": @@ -40682,6 +44686,8 @@ paths: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" delete: @@ -40714,6 +44720,92 @@ paths: "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": + get: + summary: Get repository ruleset history + description: Get the history of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ruleset-version" + examples: + default: + "$ref": "#/components/examples/ruleset-history" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": + get: + summary: Get repository ruleset version + description: Get a version of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-version + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ruleset-version-with-state" + examples: + default: + "$ref": "#/components/examples/repository-ruleset-version-with-state" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository @@ -40735,6 +44827,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -40744,6 +44837,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response @@ -40785,6 +44879,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" + - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response @@ -40812,6 +44907,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -40838,13 +44935,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" - required: - - state + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" + anyOf: + - required: + - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -40862,7 +44972,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -40984,6 +45095,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -41966,139 +46080,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/tags/protection": - get: - summary: Closing down - List tag protection states for a repository - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - - This returns the tag protection states of a repository. - - This information is only available to repository administrators. - tags: - - repos - operationId: repos/list-tag-protection - externalDocs: - description: API method documentation - 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" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/tag-protection" - examples: - default: - "$ref": "#/components/examples/tag-protection-items" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: tags - deprecationDate: '2024-05-29' - removalDate: '2024-08-30' - deprecated: true - post: - summary: Closing down - Create a tag protection state for a repository - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - - This creates a tag protection state for a repository. - This endpoint is only available to repository administrators. - tags: - - repos - operationId: repos/create-tag-protection - externalDocs: - description: API method documentation - 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" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - pattern: - type: string - description: An optional glob pattern to match against when enforcing - tag protection. - required: - - pattern - examples: - default: - value: - pattern: v1.* - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/tag-protection" - examples: - default: - "$ref": "#/components/examples/tag-protection" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: tags - deprecationDate: '2024-05-29' - removalDate: '2024-08-30' - deprecated: true - "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": - delete: - summary: Closing down - Delete a tag protection state for a repository - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - - This deletes a tag protection state for a repository. - This endpoint is only available to repository administrators. - tags: - - repos - operationId: repos/delete-tag-protection - externalDocs: - description: API method documentation - 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" - - "$ref": "#/components/parameters/tag-protection-id" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: tags - deprecationDate: '2024-05-29' - removalDate: '2024-08-30' - deprecated: true "/repos/{owner}/{repo}/tarball/{ref}": get: summary: Download a repository archive (tar) @@ -42481,7 +46462,7 @@ paths: description: Not Found if repository is not enabled with vulnerability alerts x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: repos subcategory: repos put: @@ -42935,6 +46916,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -43452,706 +47434,6 @@ paths: category: teams subcategory: teams deprecated: true - "/teams/{team_id}/discussions": - get: - summary: List discussions (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - - List all discussions on a team's page. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - post: - summary: Create a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - - Creates a new discussion post on a team's page. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - private: - type: boolean - description: Private posts are only visible to team members, organization - owners, and team maintainers. Public posts are visible to all - members of the organization. Set to `true` to create a private - post. - default: false - required: - - title - - body - examples: - default: - value: - title: Our first team post - body: Hi! This is an area for us to collaborate as a team. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}": - get: - summary: Get a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - - Get a specific discussion on a team's page. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - patch: - summary: Update a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - - Edits the title and body text of a discussion post. Only the parameters you provide are updated. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - examples: - default: - value: - title: Welcome to our first team post - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - delete: - summary: Delete a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - - Delete a discussion from a team's page. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments": - get: - summary: List discussion comments (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - - List all comments on a team discussion. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussion-comments-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - post: - summary: Create a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - - Creates a new comment on a team discussion. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like apples? - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": - get: - summary: Get a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - - Get a specific comment on a team discussion. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - patch: - summary: Update a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - - Edits the body text of a discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like pineapples? - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - delete: - summary: Delete a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - - Deletes a comment on a team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -44503,188 +47785,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - - Lists the organization projects for a team. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -46884,7 +49984,8 @@ paths: repositories: type: array items: - "$ref": "#/components/schemas/repository" + allOf: + - "$ref": "#/components/schemas/repository" examples: default: "$ref": "#/components/examples/repository-paginated" @@ -47193,7 +50294,7 @@ paths: description: |- Adds a public SSH key to the authenticated user's GitHub account. - OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. operationId: users/create-public-ssh-key-for-authenticated-user tags: - users @@ -48234,70 +51335,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user project - description: Creates a user project board. Returns a `410 Gone` status if the - user does not have existing classic projects. If you do not have sufficient - privileges to perform this action, a `401 Unauthorized` or `410 Gone` status - is returned. - tags: - - projects - operationId: projects/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - type: string - examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' - examples: - - This project represents the sprint of the first week in January - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -48432,6 +51469,9 @@ paths: examples: default: "$ref": "#/components/examples/repository-items-default-response" + headers: + Link: + "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '304': @@ -49374,6 +52414,68 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/user/{user_id}/projectsV2/{project_number}/drafts": + post: + summary: Create draft item for user owned project + description: Create draft issue item for the specified user owned project. + tags: + - projects + operationId: projects/create-draft-item-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project + parameters: + - "$ref": "#/components/parameters/user-id" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + description: Details of the draft item to create in the project. + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the draft issue item to create in the + project. + body: + type: string + description: The body content of the draft issue item to create + in the project. + required: + - title + examples: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + draft_issue: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts "/users": get: summary: List users @@ -49414,6 +52516,129 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/users/{user_id}/projectsV2/{project_number}/views": + post: + summary: Create a view for a user-owned project + description: Create a new view in a user-owned project. Views allow you to customize + how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project + parameters: + - "$ref": "#/components/parameters/user-id" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + examples: + - Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + examples: + - board + filter: + type: string + description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + examples: + - is:issue is:open + visible_fields: + type: array + description: |- + `visible_fields` is not applicable to `roadmap` layout views. + For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + items: + type: integer + examples: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in a user-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-view" + examples: + table_view: + summary: Response for creating a table view + value: + "$ref": "#/components/examples/projects-v2-view" + board_view: + summary: Response for creating a board view with filter + value: + "$ref": "#/components/examples/projects-v2-view" + roadmap_view: + summary: Response for creating a roadmap view + value: + "$ref": "#/components/examples/projects-v2-view" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + description: Service unavailable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: views "/users/{username}": get: summary: Get a user @@ -49459,6 +52684,244 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/users/{username}/attestations/bulk-list": + post: + summary: List attestations by bulk subject digests + description: |- + List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + required: + - subject_digests + examples: + default: + "$ref": "#/components/examples/bulk-subject-digest-body" + withPredicateType: + "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + type: + - array + - 'null' + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + "$ref": "#/components/examples/list-attestations-bulk" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + "/users/{username}/attestations/delete-request": + post: + summary: Delete attestations in bulk + description: Delete artifact attestations in bulk by either subject digests + or unique ID. + tags: + - users + operationId: users/delete-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk + parameters: + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + oneOf: + - properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests associated with the artifact + attestations to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - properties: + attestation_ids: + type: array + items: + type: integer + description: List of unique IDs associated with the artifact attestations + to delete. + minItems: 1 + maxItems: 1024 + required: + - attestation_ids + description: The request body must include either `subject_digests` + or `attestation_ids`, but not both. + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + "/users/{username}/attestations/digest/{subject_digest}": + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - users + operationId: users/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest + parameters: + - "$ref": "#/components/parameters/username" + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + "/users/{username}/attestations/{attestation_id}": + delete: + summary: Delete attestations by ID + description: Delete an artifact attestation by unique ID that is associated + with a repository owned by a user. + tags: + - users + operationId: users/delete-attestations-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id + parameters: + - "$ref": "#/components/parameters/username" + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations "/users/{username}/attestations/{subject_digest}": get: summary: List attestations @@ -49486,6 +52949,15 @@ paths: schema: type: string x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -49500,14 +52972,30 @@ paths: type: object properties: bundle: - "$ref": "#/components/schemas/sigstore-bundle-0" + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer bundle_url: type: string + initiator: + type: string examples: default: - value: + "$ref": "#/components/examples/list-attestations" '201': description: Response content: @@ -50300,31 +53788,28 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": + "/users/{username}/projectsV2": get: - summary: List user projects - description: Lists projects for a user. + summary: List projects for user + description: List all projects owned by a specific user accessible by the authenticated + user. tags: - projects operationId: projects/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-user-projects + url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - "$ref": "#/components/parameters/username" - - name: state - description: Indicates the state of the projects to return. + - name: q + description: Limit results to projects of the specified type. in: query required: false schema: type: string - enum: - - open - - closed - - all - default: open + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -50333,20 +53818,690 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2" + examples: + default: + "$ref": "#/components/examples/projects-v2" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/users/{username}/projectsV2/{project_number}": + get: + summary: Get project for user + description: Get a specific user-owned project. + tags: + - projects + operationId: projects/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2" + examples: + default: + "$ref": "#/components/examples/projects-v2" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/users/{username}/projectsV2/{project_number}/fields": + get: + summary: List project fields for user + description: List all fields for a specific user-owned project. + tags: + - projects + operationId: projects/list-fields-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-field" examples: default: - "$ref": "#/components/examples/project-items-3" + "$ref": "#/components/examples/projects-v2-field-items" headers: Link: "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": + get: + summary: Get project field for user + description: Get a specific field for a user-owned project. + tags: + - projects + operationId: projects/get-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#get-project-field-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/field-id" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/users/{username}/projectsV2/{project_number}/items": + get: + summary: List items for a user owned project + description: List all items for a specific user-owned project accessible by + the authenticated user. + tags: + - projects + operationId: projects/list-items-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + - name: q + description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + in: query + required: false + schema: + type: string + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + post: + summary: Add item to user owned project + description: Add an issue or pull request item to the specified user owned project. + tags: + - projects + operationId: projects/add-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + description: Details of the item to add to the project. You can specify either + the unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + oneOf: + - required: + - id + - required: + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/users/{username}/projectsV2/{project_number}/items/{item_id}": + get: + summary: Get an item for a user owned project + description: Get a specific item from a user-owned project. + tags: + - projects + operationId: projects/get-user-item + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/item-id" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + patch: + summary: Update project item for user + description: Update a specific item in a user-owned project. + tags: + - projects + operationId: projects/update-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#update-project-item-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/item-id" + requestBody: + required: true + description: Field updates to apply to the project item. Only text, number, + date, single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: |- + The new value for the field: + - For text, number, and date fields, provide the new value directly. + - For single select and iteration fields, provide the ID of the option or iteration. + - To clear the field, set this to null. + oneOf: + - type: string + - type: number + type: + - 'null' + - string + - number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + number_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + date_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + single_select_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + iteration_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + delete: + summary: Delete project item for user + description: Delete a specific item from a user-owned project. + tags: + - projects + operationId: projects/delete-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#delete-project-item-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/item-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": + get: + summary: List items for a user project view + description: List items in a user project with the saved view's filter applied. + tags: + - projects + operationId: projects/list-view-items-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/view-number" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the + title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: projects - subcategory: projects + subcategory: items "/users/{username}/received_events": get: summary: List events received by the authenticated user @@ -50483,102 +54638,120 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/users/{username}/settings/billing/actions": + "/users/{username}/settings/billing/premium_request/usage": get: - summary: Get GitHub Actions billing for a user + summary: Get billing premium request usage report for a user description: |- - Gets the summary of the free and paid GitHub Actions minutes used. - - Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + Gets a report of premium request usage for a user. - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - operationId: billing/get-github-actions-billing-user + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing + operationId: billing/get-github-billing-premium-request-usage-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user + url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-model" + - "$ref": "#/components/parameters/billing-usage-report-product" responses: '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-billing-usage" - examples: - default: - "$ref": "#/components/examples/actions-billing-usage" + "$ref": "#/components/responses/billing_premium_request_usage_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing - subcategory: billing - "/users/{username}/settings/billing/packages": + subcategory: usage + "/users/{username}/settings/billing/usage": get: - summary: Get GitHub Packages billing for a user + summary: Get billing usage report for a user description: |- - Gets the free and paid storage used for GitHub Packages in gigabytes. - - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + Gets a report of the total usage for a user. - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - operationId: billing/get-github-packages-billing-user + **Note:** This endpoint is only available to users with access to the enhanced billing platform. tags: - billing + operationId: billing/get-github-billing-usage-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user + url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month" + - "$ref": "#/components/parameters/billing-usage-report-day" responses: '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/packages-billing-usage" - examples: - default: - "$ref": "#/components/examples/packages-billing-usage" + "$ref": "#/components/responses/billing_usage_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing - subcategory: billing - "/users/{username}/settings/billing/shared-storage": + subcategory: usage + "/users/{username}/settings/billing/usage/summary": get: - summary: Get shared storage billing for a user + summary: Get billing usage summary for a user description: |- - Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + > [!NOTE] + > This endpoint is in public preview and is subject to change. - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + Gets a summary report of usage for a user. - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - operationId: billing/get-shared-storage-billing-user + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing + operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user + url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-repository" + - "$ref": "#/components/parameters/billing-usage-report-product" + - "$ref": "#/components/parameters/billing-usage-report-sku" responses: '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/combined-billing-usage" - examples: - default: - "$ref": "#/components/examples/combined-billing-usage" + "$ref": "#/components/responses/billing_usage_summary_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing - subcategory: billing + subcategory: usage "/users/{username}/social_accounts": get: summary: List social accounts for a user @@ -50777,7 +54950,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -52050,6 +56223,70 @@ webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + 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-code-scanning-alert-updated-assignment" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- @@ -52315,7 +56552,7 @@ webhooks: - business - organization - app - custom-property-updated: + custom-property-promoted-to-enterprise: post: summary: |- This event occurs when there is activity relating to a custom property. @@ -52323,8 +56560,8 @@ webhooks: For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was updated. - operationId: custom-property/updated + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: @@ -52368,7 +56605,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52381,18 +56618,18 @@ webhooks: - business - organization - app - custom-property-values-updated: + custom-property-updated: post: summary: |- - This event occurs when there is activity relating to custom property values for a repository. + This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/rest/repos/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: The custom property values of a repository were updated. - operationId: custom-property-values/updated + description: A custom property was updated. + operationId: custom-property/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -52434,7 +56671,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52442,24 +56679,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom-property-values + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - delete: + custom-property-values-updated: post: summary: |- - This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including - branch and tag deletions, use the [`push`](#push) webhook event. + This event occurs when there is activity relating to custom property values for a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/rest/repos/custom-properties)" in the REST API documentation. - > [!NOTE] - > This event will not occur when more than three tags are deleted at once. - operationId: delete + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: The custom property values of a repository were updated. + operationId: custom-property-values/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -52501,7 +56737,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52509,27 +56745,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: delete + subcategory: custom-property-values supported-webhook-types: - repository - organization - app - dependabot-alert-auto-dismissed: + delete: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including + branch and tag deletions, use the [`push`](#push) webhook event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. > [!NOTE] - > 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 + > This event will not occur when more than three tags are deleted at once. + operationId: delete externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header @@ -52571,7 +56804,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-delete" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52579,12 +56812,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: delete supported-webhook-types: - repository - organization - app - dependabot-alert-auto-reopened: + dependabot-alert-assignees-changed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52592,13 +56825,8 @@ webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 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. - operationId: dependabot-alert/auto-reopened + description: The assignees for a Dependabot alert were updated. + operationId: dependabot-alert/assignees-changed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52614,7 +56842,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52642,7 +56870,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-assignees-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52655,7 +56883,7 @@ webhooks: - repository - organization - app - dependabot-alert-created: + dependabot-alert-auto-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52663,13 +56891,9 @@ webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 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. - operationId: dependabot-alert/created + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52685,7 +56909,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52713,7 +56937,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52726,7 +56950,7 @@ webhooks: - repository - organization - app - dependabot-alert-dismissed: + dependabot-alert-auto-reopened: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52734,11 +56958,10 @@ webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A Dependabot alert was manually closed. - operationId: dependabot-alert/dismissed + 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. + operationId: dependabot-alert/auto-reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52754,7 +56977,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52782,7 +57005,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52795,7 +57018,7 @@ webhooks: - repository - organization - app - dependabot-alert-fixed: + dependabot-alert-created: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52803,11 +57026,10 @@ webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A manifest file change removed a vulnerability. - operationId: dependabot-alert/fixed + 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. + operationId: dependabot-alert/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52823,7 +57045,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52851,7 +57073,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52864,7 +57086,7 @@ webhooks: - repository - organization - app - dependabot-alert-reintroduced: + dependabot-alert-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52872,12 +57094,8 @@ webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A manifest file change introduced a vulnerable dependency that - had previously been fixed. - operationId: dependabot-alert/reintroduced + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52893,7 +57111,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52921,7 +57139,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52934,7 +57152,7 @@ webhooks: - repository - organization - app - dependabot-alert-reopened: + dependabot-alert-fixed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52942,11 +57160,8 @@ webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A Dependabot alert was manually reopened. - operationId: dependabot-alert/reopened + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52962,7 +57177,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52990,7 +57205,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -53003,16 +57218,19 @@ webhooks: - repository - organization - app - deploy-key-created: + dependabot-alert-reintroduced: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to Dependabot alerts. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was created. - operationId: deploy-key/created + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -53026,7 +57244,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -53054,7 +57272,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" responses: '200': description: Return a 200 status to indicate that the data was received @@ -53062,21 +57280,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - deploy-key-deleted: + dependabot-alert-reopened: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to Dependabot alerts. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was deleted. - operationId: deploy-key/deleted + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -53090,7 +57310,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -53118,7 +57338,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -53126,23 +57346,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - deployment-created: + deploy-key-created: post: summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment status, use the `deployment_status` event. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment was created. - operationId: deployment/created + description: A deploy key was created. + operationId: deploy-key/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -53184,7 +57402,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -53192,21 +57410,151 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment + subcategory: deploy_key supported-webhook-types: - repository - organization - app - deployment-protection-rule-requested: + deploy-key-deleted: post: summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments). + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment protection rule was requested for an environment. - operationId: deployment-protection-rule/requested + description: A deploy key was deleted. + operationId: deploy-key/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key + 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-deploy-key-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: deploy_key + supported-webhook-types: + - repository + - organization + - app + deployment-created: + post: + summary: |- + This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + + For activity relating to deployment status, use the `deployment_status` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment was created. + operationId: deployment/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment + 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-deployment-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: deployment + supported-webhook-types: + - repository + - organization + - app + deployment-protection-rule-requested: + post: + summary: |- + This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments). + + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment protection rule was requested for an environment. + operationId: deployment-protection-rule/requested + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header @@ -55655,18 +60003,18 @@ webhooks: - repository - organization - app - issues-assigned: + issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -55708,7 +60056,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55716,23 +60064,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-closed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -55774,7 +60122,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55782,23 +60130,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55840,7 +60188,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55848,23 +60196,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-demilestoned: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55906,7 +60255,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55914,23 +60263,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-edited: + issue-dependencies-blocking-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55972,7 +60321,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55980,23 +60329,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-labeled: + issue-dependencies-blocking-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -56038,7 +60388,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56046,12 +60396,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-locked: + issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56059,9 +60409,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56105,7 +60454,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56118,7 +60467,7 @@ webhooks: - repository - organization - app - issues-milestoned: + issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56126,8 +60475,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56171,7 +60520,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56184,7 +60533,7 @@ webhooks: - repository - organization - app - issues-opened: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56192,9 +60541,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56238,7 +60586,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56251,7 +60599,7 @@ webhooks: - repository - organization - app - issues-pinned: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56259,9 +60607,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56305,7 +60652,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56318,7 +60665,7 @@ webhooks: - repository - organization - app - issues-reopened: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56326,8 +60673,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56371,7 +60718,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56384,7 +60731,7 @@ webhooks: - repository - organization - app - issues-transferred: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56392,9 +60739,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56438,7 +60784,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56451,7 +60797,7 @@ webhooks: - repository - organization - app - issues-unassigned: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56459,8 +60805,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56504,7 +60851,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56517,7 +60864,7 @@ webhooks: - repository - organization - app - issues-unlabeled: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56525,8 +60872,8 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56570,7 +60917,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56583,7 +60930,7 @@ webhooks: - repository - organization - app - issues-unlocked: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56591,9 +60938,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56637,7 +60984,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56650,7 +60997,7 @@ webhooks: - repository - organization - app - issues-unpinned: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56658,9 +61005,9 @@ webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56704,7 +61051,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56717,18 +61064,18 @@ webhooks: - repository - organization - app - label-created: + issues-reopened: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56770,7 +61117,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56778,23 +61125,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-deleted: + issues-transferred: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56836,7 +61184,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56844,23 +61192,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-edited: + issues-typed: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56902,7 +61250,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56910,24 +61258,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - marketplace-purchase-cancelled: + issues-unassigned: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56969,7 +61316,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56977,22 +61324,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-changed: + - repository + - organization + - app + issues-unlabeled: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -57034,7 +61382,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57042,24 +61390,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-pending-change: + - repository + - organization + - app + issues-unlocked: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -57101,7 +61449,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57109,23 +61457,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-pending-change-cancelled: + - repository + - organization + - app + issues-unpinned: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -57167,7 +61516,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57175,22 +61524,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-purchased: + - repository + - organization + - app + issues-untyped: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -57232,7 +61582,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57240,19 +61590,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - member-added: + - repository + - organization + - app + label-created: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was created. + operationId: label/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -57294,7 +61648,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57302,22 +61656,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: label supported-webhook-types: - - business - repository - organization - app - member-edited: + label-deleted: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -57359,7 +61714,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57367,22 +61722,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: label supported-webhook-types: - - business - repository - organization - app - member-removed: + label-edited: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -57424,7 +61780,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57432,22 +61788,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: label supported-webhook-types: - - business - repository - organization - app - membership-added: + marketplace-purchase-cancelled: post: - summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57489,7 +61847,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57497,21 +61855,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: marketplace_purchase supported-webhook-types: - - organization - - business - - app - membership-removed: + - marketplace + marketplace-purchase-changed: post: - summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57553,7 +61912,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57561,26 +61920,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: marketplace_purchase supported-webhook-types: - - organization - - business - - app - merge-group-checks-requested: + - marketplace + marketplace-purchase-pending-change: post: - summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. - - When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. - operationId: merge-group/checks-requested - tags: - - merge-queue + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57622,7 +61979,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57630,24 +61987,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: marketplace_purchase supported-webhook-types: - - app - merge-group-destroyed: + - marketplace + marketplace-purchase-pending-change-cancelled: post: - summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. - - When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. - operationId: merge-group/destroyed - tags: - - merge-queue + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57689,7 +62045,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57697,19 +62053,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: marketplace_purchase supported-webhook-types: - - app - meta-deleted: + - marketplace + marketplace-purchase-purchased: post: - summary: |- - This event occurs when there is activity relating to a webhook itself. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. - description: The webhook was deleted. - operationId: meta/deleted + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57751,7 +62110,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57759,25 +62118,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: meta + subcategory: marketplace_purchase supported-webhook-types: - marketplace - - business - - repository - - organization - - app - milestone-closed: + member-added: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was closed. - operationId: milestone/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -57819,7 +62172,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57827,23 +62180,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: member supported-webhook-types: + - business - repository - organization - app - milestone-created: + member-edited: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was created. - operationId: milestone/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -57885,7 +62237,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57893,23 +62245,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: member supported-webhook-types: + - business - repository - organization - app - milestone-deleted: + member-removed: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was deleted. - operationId: milestone/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -57951,7 +62302,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57959,23 +62310,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: member supported-webhook-types: + - business - repository - organization - app - milestone-edited: + membership-added: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was edited. - operationId: milestone/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was added to a team. + operationId: membership/added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -58017,7 +62367,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-membership-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58025,23 +62375,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: membership supported-webhook-types: - - repository - organization + - business - app - milestone-opened: + membership-removed: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was opened. - operationId: milestone/opened + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -58083,7 +62431,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-membership-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58091,23 +62439,26 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: membership supported-webhook-types: - - repository - organization + - business - app - org-block-blocked: + merge-group-checks-requested: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A user was blocked from the organization. - operationId: org-block/blocked + When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. + operationId: merge-group/checks-requested + tags: + - merge-queue externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -58149,7 +62500,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58157,23 +62508,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: org_block + subcategory: merge_group supported-webhook-types: - - organization - - business - app - org-block-unblocked: + merge-group-destroyed: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A previously blocked user was unblocked from the organization. - operationId: org-block/unblocked + When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. + operationId: merge-group/destroyed + tags: + - merge-queue externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -58215,7 +62567,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58223,23 +62575,87 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: org_block + subcategory: merge_group supported-webhook-types: - - organization + - app + meta-deleted: + post: + summary: |- + This event occurs when there is activity relating to a webhook itself. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. + description: The webhook was deleted. + operationId: meta/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta + 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-meta-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: meta + supported-webhook-types: + - marketplace - business + - repository + - organization - app - organization-deleted: + milestone-closed: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization was deleted. - operationId: organization/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was closed. + operationId: milestone/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58281,7 +62697,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-milestone-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58289,23 +62705,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-member-added: + milestone-created: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member accepted an invitation to join an organization. - operationId: organization/member-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was created. + operationId: milestone/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58347,7 +62763,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-milestone-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58355,23 +62771,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-member-invited: + milestone-deleted: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member was invited to join the organization. - operationId: organization/member-invited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was deleted. + operationId: milestone/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58413,7 +62829,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-milestone-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58421,23 +62837,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-member-removed: + milestone-edited: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member was removed from the organization. - operationId: organization/member-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was edited. + operationId: milestone/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58479,7 +62895,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-milestone-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58487,23 +62903,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-renamed: + milestone-opened: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name of an organization was changed. - operationId: organization/renamed + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was opened. + operationId: milestone/opened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58545,7 +62961,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-milestone-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58553,21 +62969,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - package-published: + org-block-blocked: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - description: A package was published to a registry. - operationId: package/published + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A user was blocked from the organization. + operationId: org-block/blocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -58609,7 +63027,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-org-block-blocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58617,21 +63035,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: package + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - package-updated: + org-block-unblocked: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - description: A previously published package was updated. - operationId: package/updated + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A previously blocked user was unblocked from the organization. + operationId: org-block/unblocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -58673,7 +63093,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-org-block-unblocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58681,20 +63101,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: package + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - page-build: + organization-deleted: post: summary: |- - This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/rest/pages)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. - operationId: page-build + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization was deleted. + operationId: organization/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -58736,7 +63159,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-organization-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58744,43 +63167,37 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: page_build + subcategory: organization supported-webhook-types: - - repository - organization + - business - app - personal-access-token-request-approved: + organization-member-added: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A member accepted an invitation to join an organization. + operationId: organization/member-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58790,7 +63207,12 @@ webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58803,7 +63225,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-organization-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58811,42 +63233,37 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - personal-access-token-request-cancelled: + organization-member-invited: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A member was invited to join the organization. + operationId: organization/member-invited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58856,7 +63273,12 @@ webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58869,7 +63291,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-organization-member-invited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58877,41 +63299,37 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - personal-access-token-request-created: + organization-member-removed: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A member was removed from the organization. + operationId: organization/member-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58921,7 +63339,12 @@ webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58934,7 +63357,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-organization-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58942,41 +63365,37 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - personal-access-token-request-denied: + organization-renamed: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: The name of an organization was changed. + operationId: organization/renamed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58986,7 +63405,12 @@ webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58999,7 +63423,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-organization-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59007,16 +63431,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - ping: + package-published: post: - summary: This event occurs when you create a new webhook. The ping event is - a confirmation from GitHub that you configured the webhook correctly. - operationId: ping + summary: This event occurs when there is activity relating to GitHub Packages. + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." + For information about the APIs to manage GitHub Packages, see [the GraphQL + API documentation](https://docs.github.com/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + description: A package was published to a registry. + operationId: package/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping + url: https://docs.github.com/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -59058,45 +63488,29 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-ping" - examples: - default: - "$ref": "#/components/examples/ping" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-ping-form-encoded" - examples: - default: - "$ref": "#/components/examples/ping-form-encoded" + "$ref": "#/components/schemas/webhook-package-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: ping + subcategory: package supported-webhook-types: - repository - organization - - app - - business - - marketplace - project-card-converted: + package-updated: post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note in a project (classic) was converted to an issue. - operationId: project-card/converted + summary: This event occurs when there is activity relating to GitHub Packages. + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." + For information about the APIs to manage GitHub Packages, see [the GraphQL + API documentation](https://docs.github.com/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + description: A previously published package was updated. + operationId: package/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -59138,7 +63552,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59146,25 +63560,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: package supported-webhook-types: - repository - organization - - app - project-card-created: + page-build: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/rest/pages)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card was added to a project (classic). - operationId: project-card/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. + operationId: page-build externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build parameters: - name: User-Agent in: header @@ -59206,7 +63614,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-page-build" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59214,54 +63622,50 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: page_build supported-webhook-types: - repository - organization - app - project-card-deleted: + personal-access-token-request-approved: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a project (classic) was deleted. - operationId: project-card/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was approved. + operationId: personal-access-token-request/approved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59274,7 +63678,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59282,54 +63686,50 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-card-edited: + - organization + personal-access-token-request-cancelled: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note on a project (classic) was edited. - operationId: project-card/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was cancelled by the + requester. + operationId: personal-access-token-request/cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59342,7 +63742,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59350,55 +63750,49 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-card-moved: + - organization + personal-access-token-request-created: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a project (classic) was moved to another column or to - another position in its column. - operationId: project-card/moved + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was created. + operationId: personal-access-token-request/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59411,7 +63805,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59419,54 +63813,49 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-closed: + - organization + personal-access-token-request-denied: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was denied. + operationId: personal-access-token-request/denied externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59479,7 +63868,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59487,25 +63876,17 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-column-created: + - organization + ping: post: - summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a project (classic). - operationId: project-column/created + summary: This event occurs when you create a new webhook. The ping event is + a confirmation from GitHub that you configured the webhook correctly. + operationId: ping externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping parameters: - name: User-Agent in: header @@ -59547,33 +63928,45 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-ping" + examples: + default: + "$ref": "#/components/examples/ping" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-ping-form-encoded" + examples: + default: + "$ref": "#/components/examples/ping-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project_column + subcategory: ping supported-webhook-types: - repository - organization - app - project-column-deleted: + - business + - marketplace + project-card-converted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a project (classic). - operationId: project-column/deleted + description: A note in a project (classic) was converted to an issue. + operationId: project-card/converted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59615,7 +64008,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-card-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59623,25 +64016,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project_card supported-webhook-types: - repository - organization - app - project-column-edited: + project-card-created: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a project (classic) was changed. - operationId: project-column/edited + description: A card was added to a project (classic). + operationId: project-card/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59683,7 +64076,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-card-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59691,25 +64084,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project_card supported-webhook-types: - repository - organization - app - project-column-moved: + project-card-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a project (classic). - operationId: project-column/moved + description: A card on a project (classic) was deleted. + operationId: project-card/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59751,7 +64144,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-card-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59759,25 +64152,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project_card supported-webhook-types: - repository - organization - app - project-created: + project-card-edited: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was created. - operationId: project/created + description: A note on a project (classic) was edited. + operationId: project-card/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59819,7 +64212,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-card-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59827,25 +64220,26 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_card supported-webhook-types: - repository - organization - app - project-deleted: + project-card-moved: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was deleted. - operationId: project/deleted + description: A card on a project (classic) was moved to another column or to + another position in its column. + operationId: project-card/moved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59887,7 +64281,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-card-moved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59895,12 +64289,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_card supported-webhook-types: - repository - organization - app - project-edited: + project-closed: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. @@ -59910,8 +64304,8 @@ webhooks: This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a project (classic) was changed. - operationId: project/edited + description: A project (classic) was closed. + operationId: project/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: @@ -59955,7 +64349,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59968,20 +64362,20 @@ webhooks: - repository - organization - app - project-reopened: + project-column-created: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/reopened + description: A column was added to a project (classic). + operationId: project-column/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -60023,7 +64417,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-column-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60031,26 +64425,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_column supported-webhook-types: - repository - organization - app - projects-v2-closed: + project-column-deleted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was deleted from a project (classic). + operationId: project-column/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -60064,7 +64457,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60092,33 +64485,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-project-column-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project_column supported-webhook-types: + - repository - organization - projects-v2-created: + - app + project-column-edited: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: The name of a column on a project (classic) was changed. + operationId: project-column/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -60132,7 +64525,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60160,33 +64553,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-project-column-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project_column supported-webhook-types: + - repository - organization - projects-v2-deleted: + - app + project-column-moved: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was moved to a new position on a project (classic). + operationId: project-column/moved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -60200,7 +64593,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60228,34 +64621,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-project-column-moved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project_column supported-webhook-types: + - repository - organization - projects-v2-edited: + - app + project-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was created. + operationId: project/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60269,7 +64661,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60297,34 +64689,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-project-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-archived: + - app + project-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was deleted. + operationId: project/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60338,7 +64729,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60366,33 +64757,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-converted: + - app + project-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: The name or description of a project (classic) was changed. + operationId: project/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60406,7 +64797,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60434,33 +64825,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-created: + - app + project-reopened: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was closed. + operationId: project/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60474,7 +64865,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60502,33 +64893,34 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-deleted: + - app + projects-v2-closed: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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 + description: A project in the organization was closed. + operationId: projects-v2/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60542,7 +64934,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60570,7 +64962,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60579,26 +64971,24 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-edited: + projects-v2-created: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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. - operationId: projects-v2-item/edited + description: A project in the organization was created. + operationId: projects-v2/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60612,7 +65002,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60640,7 +65030,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60649,26 +65039,24 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-reordered: + projects-v2-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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. - operationId: projects-v2-item/reordered + description: A project in the organization was deleted. + operationId: projects-v2/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60682,7 +65070,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60710,7 +65098,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60719,25 +65107,25 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-restored: + projects-v2-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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 + description: The title, description, or README of a project in the organization + was changed. + operationId: projects-v2/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60751,7 +65139,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60779,7 +65167,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60788,24 +65176,25 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-reopened: + projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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 + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60819,7 +65208,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60847,7 +65236,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60856,24 +65245,24 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-status-update-created: + projects-v2-item-converted: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a project, use the `projects_v2` event. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was added to a project in the organization. - operationId: projects-v2-status-update/created + > 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60887,7 +65276,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60915,7 +65304,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60924,24 +65313,24 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-status-update-deleted: + projects-v2-item-created: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a project, use the `projects_v2` event. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was removed from a project in the organization. - operationId: projects-v2-status-update/deleted + > 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60955,7 +65344,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60983,7 +65372,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60992,24 +65381,24 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-status-update-edited: + projects-v2-item-deleted: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a project, use the `projects_v2` event. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was edited on a project in the organization. - operationId: projects-v2-status-update/edited + > 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -61023,7 +65412,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61051,7 +65440,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61060,18 +65449,26 @@ webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: projects_v2_item supported-webhook-types: - organization - public: + projects-v2-item-edited: post: summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - operationId: public + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + + 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 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. + operationId: projects-v2-item/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#public + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -61085,7 +65482,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61113,31 +65510,35 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: public + subcategory: projects_v2_item supported-webhook-types: - - repository - organization - - app - pull-request-assigned: + projects-v2-item-reordered: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was assigned to a user. - operationId: pull-request/assigned + 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 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. + operationId: projects-v2-item/reordered externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -61151,7 +65552,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61179,32 +65580,34 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_item supported-webhook-types: - - repository - organization - - app - pull-request-auto-merge-disabled: + projects-v2-item-restored: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-disabled + 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 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -61218,7 +65621,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61246,32 +65649,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_item supported-webhook-types: - - repository - organization - - app - pull-request-auto-merge-enabled: + projects-v2-reopened: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-enabled + 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 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -61285,7 +65689,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61313,33 +65717,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - pull-request-closed: + projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a project, use the `projects_v2` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was closed. If `merged` is false in the webhook - payload, the pull request was closed with unmerged commits. If `merged` is - true in the webhook payload, the pull request was merged. - operationId: pull-request/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was added to a project in the organization. + operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -61353,7 +65757,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61381,98 +65785,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_status_update supported-webhook-types: - - repository - organization - - app - pull-request-converted-to-draft: + projects-v2-status-update-deleted: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/converted-to-draft - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - 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-pull-request-converted-to-draft" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-demilestoned: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + For activity relating to a project, use the `projects_v2` event. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from a milestone. - operationId: pull-request/demilestoned + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was removed from a project in the organization. + operationId: projects-v2-status-update/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -61486,7 +65825,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61514,98 +65853,33 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_status_update supported-webhook-types: - - repository - organization - - app - pull-request-dequeued: + projects-v2-status-update-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from the merge queue. - operationId: pull-request/dequeued - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - 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-pull-request-dequeued" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-edited: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + For activity relating to a project, use the `projects_v2` event. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The title or body of a pull request was edited, or the base branch - of a pull request was changed. - operationId: pull-request/edited + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was edited on a project in the organization. + operationId: projects-v2-status-update/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -61619,7 +65893,7 @@ webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61647,31 +65921,27 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_status_update supported-webhook-types: - - repository - organization - - app - pull-request-enqueued: + public: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to the merge queue. - operationId: pull-request/enqueued + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + operationId: public externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header @@ -61713,7 +65983,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-public" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61721,12 +65991,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: public supported-webhook-types: - repository - organization - app - pull-request-labeled: + pull-request-assigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61734,8 +66004,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was added to a pull request. - operationId: pull-request/labeled + description: A pull request was assigned to a user. + operationId: pull-request/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61779,7 +66049,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61792,7 +66062,7 @@ webhooks: - repository - organization - app - pull-request-locked: + pull-request-auto-merge-disabled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61800,9 +66070,9 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/locked + description: Auto merge was disabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-disabled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61846,7 +66116,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61859,7 +66129,7 @@ webhooks: - repository - organization - app - pull-request-milestoned: + pull-request-auto-merge-enabled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61867,8 +66137,9 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to a milestone. - operationId: pull-request/milestoned + description: Auto merge was enabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-enabled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61912,7 +66183,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61925,7 +66196,7 @@ webhooks: - repository - organization - app - pull-request-opened: + pull-request-closed: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61933,8 +66204,10 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was created - operationId: pull-request/opened + description: A pull request was closed. If `merged` is false in the webhook + payload, the pull request was closed with unmerged commits. If `merged` is + true in the webhook payload, the pull request was merged. + operationId: pull-request/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61978,7 +66251,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61991,7 +66264,7 @@ webhooks: - repository - organization - app - pull-request-ready-for-review: + pull-request-converted-to-draft: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61999,9 +66272,9 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A draft pull request was marked as ready for review. For more information, + description: A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/ready-for-review + operationId: pull-request/converted-to-draft externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62045,7 +66318,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62058,7 +66331,7 @@ webhooks: - repository - organization - app - pull-request-reopened: + pull-request-demilestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62066,8 +66339,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously closed pull request was reopened. - operationId: pull-request/reopened + description: A pull request was removed from a milestone. + operationId: pull-request/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62111,7 +66384,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62124,150 +66397,18 @@ webhooks: - repository - organization - app - pull-request-review-comment-created: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was created. - operationId: pull-request-review-comment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - 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-pull-request-review-comment-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-deleted: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was deleted. - operationId: pull-request-review-comment/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - 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-pull-request-review-comment-deleted" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-edited: + pull-request-dequeued: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The content of a comment on a pull request diff was changed. - operationId: pull-request-review-comment/edited + description: A pull request was removed from the merge queue. + operationId: pull-request/dequeued externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62309,7 +66450,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62317,23 +66458,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-dismissed: + pull-request-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was dismissed. - operationId: pull-request-review/dismissed + description: The title or body of a pull request was edited, or the base branch + of a pull request was changed. + operationId: pull-request/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62375,7 +66517,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62383,23 +66525,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-edited: + pull-request-enqueued: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The body comment on a pull request review was edited. - operationId: pull-request-review/edited + description: A pull request was added to the merge queue. + operationId: pull-request/enqueued externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62441,7 +66583,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62449,12 +66591,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-request-removed: + pull-request-labeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62462,9 +66604,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A request for review by a person or team was removed from a pull - request. - operationId: pull-request/review-request-removed + description: A label was added to a pull request. + operationId: pull-request/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62508,7 +66649,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62521,7 +66662,7 @@ webhooks: - repository - organization - app - pull-request-review-requested: + pull-request-locked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62529,9 +66670,9 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - operationId: pull-request/review-requested + description: Conversation on a pull request was locked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62575,7 +66716,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62588,18 +66729,18 @@ webhooks: - repository - organization - app - pull-request-review-submitted: + pull-request-milestoned: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A pull request was added to a milestone. + operationId: pull-request/milestoned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62641,7 +66782,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62649,23 +66790,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-opened: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A pull request was created + operationId: pull-request/opened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62707,7 +66848,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62715,24 +66856,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-ready-for-review: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A draft pull request was marked as ready for review. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/ready-for-review externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62774,7 +66915,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62782,12 +66923,12 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-synchronize: + pull-request-reopened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62795,10 +66936,8 @@ webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A previously closed pull request was reopened. + operationId: pull-request/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62842,7 +66981,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62855,18 +66994,18 @@ webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-review-comment-created: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A comment on a pull request diff was created. + operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -62908,7 +67047,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62916,23 +67055,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-unlabeled: + pull-request-review-comment-deleted: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: A comment on a pull request diff was deleted. + operationId: pull-request-review-comment/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -62974,7 +67113,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62982,24 +67121,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-unlocked: + pull-request-review-comment-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + description: The content of a comment on a pull request diff was changed. + operationId: pull-request-review-comment/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -63041,7 +67179,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63049,25 +67187,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - push: + pull-request-review-dismissed: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was dismissed. + operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -63109,7 +67245,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63117,24 +67253,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: push + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - registry-package-published: + pull-request-review-edited: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package was published to a registry. - operationId: registry-package/published + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: The body comment on a pull request review was edited. + operationId: pull-request-review/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -63176,7 +67311,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63184,24 +67319,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - registry-package-updated: + pull-request-review-request-removed: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package that was previously published to a registry was updated. - operationId: registry-package/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A request for review by a person or team was removed from a pull + request. + operationId: pull-request/review-request-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63243,7 +67378,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63251,22 +67386,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-created: + pull-request-review-requested: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A draft was saved, or a release or pre-release was published without - previously being saved as a draft. - operationId: release/created + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Review by a person or team was requested for a pull request. For + more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + operationId: pull-request/review-requested externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63308,7 +67445,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63316,21 +67453,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-deleted: + pull-request-review-submitted: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft release was deleted. - operationId: release/deleted + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -63372,7 +67511,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63380,22 +67519,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - release-edited: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." - operationId: release/edited + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -63437,7 +67577,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63445,22 +67585,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - release-prereleased: + pull-request-review-thread-unresolved: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was created and identified as a pre-release. A pre-release - is a release that is not ready for production and may be unstable. - operationId: release/prereleased + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -63502,7 +67644,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63510,21 +67652,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - release-published: + pull-request-synchronize: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft of a release was published. - operationId: release/published + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63566,7 +67712,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63574,21 +67720,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-released: + pull-request-unassigned: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was published, or a pre-release was changed to a release. - operationId: release/released + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63630,7 +67778,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63638,21 +67786,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-unpublished: + pull-request-unlabeled: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release or pre-release was unpublished. - operationId: release/unpublished + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63694,7 +67844,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63702,21 +67852,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - repository-advisory-published: + pull-request-unlocked: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A repository security advisory was published. - operationId: repository-advisory/published + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63758,7 +67911,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63766,21 +67919,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: pull_request supported-webhook-types: - repository - organization - app - repository-advisory-reported: + push: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A private vulnerability report was submitted. - operationId: repository-advisory/reported + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -63822,7 +67979,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-push" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63830,21 +67987,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: push supported-webhook-types: - repository - organization - app - repository-archived: + registry-package-published: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" 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: A repository was archived. - operationId: repository/archived + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. + description: A package was published to a registry. + operationId: registry-package/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -63886,7 +68046,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-registry-package-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63894,22 +68054,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: registry_package supported-webhook-types: - - business - repository - organization - app - repository-created: + registry-package-updated: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" 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: A repository was created. - operationId: repository/created + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. + description: A package that was previously published to a registry was updated. + operationId: registry-package/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -63951,7 +68113,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-registry-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63959,23 +68121,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: registry_package supported-webhook-types: - - business - repository - organization - app - repository-deleted: + release-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: A repository was deleted. GitHub Apps and repository webhooks will - not receive this event. - operationId: repository/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A draft was saved, or a release or pre-release was published without + previously being saved as a draft. + operationId: release/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64017,7 +68178,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-release-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64025,21 +68186,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-dispatch-sample.collected: + release-deleted: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: repository-dispatch/sample.collected + description: A release, pre-release, or draft release was deleted. + operationId: release/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64081,7 +68242,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-release-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64089,20 +68250,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_dispatch + subcategory: release supported-webhook-types: + - repository + - organization - app - repository-edited: + release-edited: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The topics, default branch, description, or homepage of a repository - was changed. - operationId: repository/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: The details of a release, pre-release, or draft release were edited. + For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64144,7 +68307,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-release-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64152,20 +68315,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-import: + release-prereleased: post: - summary: This event occurs when a repository is imported to GitHub. For more - information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). - operationId: repository-import + summary: |- + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release was created and identified as a pre-release. A pre-release + is a release that is not ready for production and may be unstable. + operationId: release/prereleased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64207,7 +68372,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-release-prereleased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64215,20 +68380,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_import + subcategory: release supported-webhook-types: - repository - organization - repository-privatized: + - app + release-published: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The visibility of a repository was changed to `private`. - operationId: repository/privatized + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release, pre-release, or draft of a release was published. + operationId: release/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64270,7 +68436,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-release-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64278,22 +68444,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-publicized: + release-released: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The visibility of a repository was changed to `public`. - operationId: repository/publicized + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release was published, or a pre-release was changed to a release. + operationId: release/released externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64335,7 +68500,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-release-released" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64343,22 +68508,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-renamed: + release-unpublished: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The name of a repository was changed. - operationId: repository/renamed + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release or pre-release was unpublished. + operationId: release/unpublished externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64400,7 +68564,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-release-unpublished" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64408,24 +68572,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-ruleset-created: + repository-advisory-published: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was created. - operationId: repository-ruleset/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A repository security advisory was published. + operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -64467,7 +68628,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64475,23 +68636,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - repository-ruleset-deleted: + repository-advisory-reported: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was deleted. - operationId: repository-ruleset/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A private vulnerability report was submitted. + operationId: repository-advisory/reported externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -64533,7 +68692,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64541,23 +68700,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - repository-ruleset-edited: + repository-archived: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was edited. - operationId: repository-ruleset/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A repository was archived. + operationId: repository/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64599,7 +68756,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64607,23 +68764,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-transferred: + repository-created: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" 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: Ownership of the repository was transferred to a user or organization - account. This event is only sent to the account where the ownership is transferred. - To receive the `repository.transferred` event, the new owner account must - have the GitHub App installed, and the App must be subscribed to "Repository" - events. - operationId: repository/transferred + description: A repository was created. + operationId: repository/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -64667,7 +68821,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64681,14 +68835,15 @@ webhooks: - repository - organization - app - repository-unarchived: + repository-deleted: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" 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: A previously archived repository was unarchived. - operationId: repository/unarchived + description: A repository was deleted. GitHub Apps and repository webhooks will + not receive this event. + operationId: repository/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -64732,7 +68887,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64746,17 +68901,15 @@ webhooks: - repository - organization - app - repository-vulnerability-alert-create: + repository-dispatch-sample.collected: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - > [!WARNING] - > **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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: repository-dispatch/sample.collected externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header @@ -64798,7 +68951,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64806,21 +68959,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository_dispatch supported-webhook-types: - - repository - - organization - repository-vulnerability-alert-dismiss: + - app + repository-edited: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - > [!WARNING] - > **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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The topics, default branch, description, or homepage of a repository + was changed. + operationId: repository/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64862,7 +69014,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64870,22 +69022,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - repository-vulnerability-alert-reopen: + - app + repository-import: post: - summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. - - > [!WARNING] - > **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 + summary: This event occurs when a repository is imported to GitHub. For more + information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). + operationId: repository-import externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -64927,7 +69077,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-import" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64935,21 +69085,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository_import supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + repository-privatized: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - > [!WARNING] - > **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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `private`. + operationId: repository/privatized externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64991,7 +69140,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-privatized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64999,22 +69148,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - secret-scanning-alert-created: + - app + repository-publicized: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - 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 created. - operationId: secret-scanning-alert/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `public`. + operationId: repository/publicized externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -65056,7 +69205,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-publicized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65064,26 +69213,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - app - secret-scanning-alert-location-created: + repository-renamed: post: summary: |- - This event occurs when there is activity relating to the locations of a secret in 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 alerts, use the `secret_scanning_alert` event. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A new instance of a previously detected secret was detected in - a repository, and the location of the secret was added to the existing alert. - operationId: secret-scanning-alert-location/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The name of a repository was changed. + operationId: repository/renamed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -65125,41 +69270,32 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-repository-renamed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: repository supported-webhook-types: + - business - repository - organization - app - secret-scanning-alert-publicly-leaked: + repository-ruleset-created: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - 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. - operationId: secret-scanning-alert/publicly-leaked + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was created. + operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -65201,7 +69337,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65209,23 +69345,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository_ruleset supported-webhook-types: - repository - organization - app - secret-scanning-alert-reopened: + repository-ruleset-deleted: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -65267,7 +69403,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65275,23 +69411,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository_ruleset supported-webhook-types: - repository - organization - app - secret-scanning-alert-resolved: + repository-ruleset-edited: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was edited. + operationId: repository-ruleset/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -65333,7 +69469,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65341,23 +69477,25 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository_ruleset supported-webhook-types: - repository - organization - app - secret-scanning-alert-validated: + repository-transferred: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Ownership of the repository was transferred to a user or organization + account. This event is only sent to the account where the ownership is transferred. + To receive the `repository.transferred` event, the new owner account must + have the GitHub App installed, and the App must be subscribed to "Repository" + events. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -65399,7 +69537,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65407,24 +69545,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - app - secret-scanning-scan-completed: + repository-unarchived: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - - Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - 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 scan was completed. - operationId: secret-scanning-scan/completed + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -65466,7 +69602,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-repository-unarchived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65474,21 +69610,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_scan + subcategory: repository supported-webhook-types: + - business - repository - organization - app - security-advisory-published: + repository-vulnerability-alert-create: 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 security vulnerability alert in a repository. - 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 + > [!WARNING] + > **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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65530,7 +69668,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65538,19 +69676,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: repository_vulnerability_alert supported-webhook-types: - - app - security-advisory-updated: + - repository + - organization + repository-vulnerability-alert-dismiss: 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 security vulnerability alert in a repository. - 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 + > [!WARNING] + > **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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65592,7 +69732,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65600,19 +69740,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: repository_vulnerability_alert supported-webhook-types: - - app - security-advisory-withdrawn: + - repository + - organization + repository-vulnerability-alert-reopen: 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 security vulnerability alert in a repository. - 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 + > [!WARNING] + > **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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65654,7 +69797,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65662,18 +69805,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: repository_vulnerability_alert supported-webhook-types: - - app - security-and-analysis: + - repository + - organization + repository-vulnerability-alert-resolve: 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 security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + > [!WARNING] + > **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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65715,7 +69861,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65723,24 +69869,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization - - app - sponsorship-cancelled: + secret-scanning-alert-assigned: 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 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. - 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. + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + 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 assigned. + operationId: secret-scanning-alert/assigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65782,7 +69926,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65790,20 +69934,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-created: + - repository + - organization + - app + secret-scanning-alert-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). + 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. - 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 + 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 created. + operationId: secret-scanning-alert/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65845,7 +69992,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65853,21 +70000,26 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - repository + - organization + - app + secret-scanning-alert-location-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). + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - 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 + 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 alerts, use the `secret_scanning_alert` 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 new instance of a previously detected secret was detected in + a repository, and the location of the secret was added to the existing alert. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -65909,30 +70061,41 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert_location supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: + - repository + - organization + - app + secret-scanning-alert-publicly-leaked: 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 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. - 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. + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + 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. + operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65974,7 +70137,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65982,20 +70145,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-pending-tier-change: + - repository + - organization + - app + secret-scanning-alert-reopened: 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 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. - 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 + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -66037,7 +70203,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66045,22 +70211,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-tier-changed: + - repository + - organization + - app + secret-scanning-alert-resolved: 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 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. - 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 + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -66102,7 +70269,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66110,19 +70277,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - star-created: + - repository + - organization + - app + secret-scanning-alert-unassigned: 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 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. - 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 + 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 unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -66164,7 +70335,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66172,21 +70343,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - star-deleted: + secret-scanning-alert-validated: 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 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. - 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 + 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#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -66228,7 +70401,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66236,20 +70409,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - status: + secret-scanning-scan-completed: 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 secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + 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 scan was completed. + operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -66291,7 +70468,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66299,23 +70476,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: secret_scanning_scan supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-added: + security-advisory-published: 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 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 "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -66357,7 +70532,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66365,23 +70540,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sub-issues-parent-issue-removed: + security-advisory-updated: 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 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 "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -66423,7 +70594,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66431,23 +70602,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sub-issues-sub-issue-added: + security-advisory-withdrawn: 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 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 "Issues" repository permissions. - description: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + 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#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -66489,7 +70656,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66497,23 +70664,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sub-issues-sub-issue-removed: + security-and-analysis: 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 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)." - 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 + 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#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -66555,7 +70717,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66563,23 +70725,24 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_and_analysis supported-webhook-types: - repository - organization - app - team-add: + sponsorship-cancelled: 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 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). - For activity relating to teams, see the `teams` event. + 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. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add + 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#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66621,7 +70784,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66629,22 +70792,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - team-added-to-repository: + - sponsors_listing + sponsorship-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)." + 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 "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository + 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66686,7 +70847,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66694,22 +70855,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-created: + - sponsors_listing + sponsorship-edited: 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 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 "Members" organization permission. - description: A team was created. - operationId: team/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 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66751,7 +70911,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66759,22 +70919,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-deleted: + - sponsors_listing + sponsorship-pending-cancellation: 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 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 "Members" organization permission. - description: A team was deleted. - operationId: team/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 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66816,7 +70976,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66824,22 +70984,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-edited: + - sponsors_listing + sponsorship-pending-tier-change: 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 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 "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited + 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66881,7 +71039,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66889,22 +71047,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-removed-from-repository: + - sponsors_listing + sponsorship-tier-changed: 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 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 "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository + 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66946,7 +71104,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66954,21 +71112,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - watch-started: + - sponsors_listing + star-created: 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 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 "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -67010,7 +71166,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67018,22 +71174,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: watch + subcategory: star supported-webhook-types: - repository - organization - app - workflow-dispatch: + star-deleted: 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 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 "Contents" repository permission. - operationId: workflow-dispatch + 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#workflow_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -67075,7 +71230,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67083,23 +71238,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_dispatch + subcategory: star supported-webhook-types: + - repository + - organization - app - workflow-job-completed: + status: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + 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 "Actions" repository permission. - description: A job in a workflow run finished. This event occurs when a job - in a workflow is completed, regardless of whether the job was successful or - unsuccessful. - operationId: workflow-job/completed + 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#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -67141,7 +71293,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -67149,24 +71301,874 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: status supported-webhook-types: - - business - repository - organization - app - workflow-job-in-progress: + sub-issues-parent-issue-added: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to sub-issues. - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` 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 "Actions" repository permission. - description: A job in a workflow run started processing on a runner. - operationId: workflow-job/in-progress + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + 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-sub-issues-parent-issue-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + sub-issues-parent-issue-removed: + 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. + + 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#sub-issues + 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-sub-issues-parent-issue-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + sub-issues-sub-issue-added: + 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. + + 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#sub-issues + 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-sub-issues-sub-issue-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + sub-issues-sub-issue-removed: + 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. + + 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#sub-issues + 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-sub-issues-sub-issue-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + team-add: + 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)." + + 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. + operationId: team-add + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + 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-add" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team_add + supported-webhook-types: + - repository + - organization + - app + 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: 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: + - 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-added-to-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 + 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 was created. + operationId: team/created + 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-created" + 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-deleted: + 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 was deleted. + operationId: team/deleted + 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-deleted" + 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-edited: + 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 + 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-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 + 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-workflow-dispatch" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_dispatch + supported-webhook-types: + - app + workflow-job-completed: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run finished. This event occurs when a job + in a workflow is completed, regardless of whether the job was successful or + unsuccessful. + operationId: workflow-job/completed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + 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-workflow-job-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-job-in-progress: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run started processing on a runner. + operationId: workflow-job/in-progress + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -68348,7 +73350,9 @@ components: issues: read deployments: write events: - description: The list of events for the GitHub app + description: The list of events for the GitHub app. Note that the `installation_target`, + `security_advisory`, and `meta` events are not included because they are + global events and not specific to an installation. type: array items: type: string @@ -68356,25 +73360,11 @@ components: - label - deployment installations_count: - description: The number of installations associated with the GitHub app + description: The number of installations associated with the GitHub app. + Only returned when the integration is requesting details about itself. type: integer examples: - 5 - client_secret: - type: string - examples: - - '"1d4b2097ac622ba702d19de498f005747a8b21d3"' - webhook_secret: - type: - - string - - 'null' - examples: - - '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' - pem: - type: string - examples: - - '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END - RSA PRIVATE KEY-----\n"' required: - id - node_id @@ -68437,6 +73427,7 @@ components: id: description: Unique identifier of the webhook delivery. type: integer + format: int64 examples: - 42 guid: @@ -68489,6 +73480,7 @@ components: type: - integer - 'null' + format: int64 examples: - 123 repository_id: @@ -68496,6 +73488,7 @@ components: type: - integer - 'null' + format: int64 examples: - 123 throttled_at: @@ -68768,6 +73761,20 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write + attestations: + type: string + description: The level of permission to create and retrieve the access token + for repository attestations. + enum: + - read + - write checks: type: string description: The level of permission to grant the access token for checks @@ -68791,7 +73798,7 @@ components: - write dependabot_secrets: type: string - description: The leve of permission to grant the access token to manage + description: The level of permission to grant the access token to manage Dependabot secrets. enum: - read @@ -68803,6 +73810,13 @@ components: enum: - read - write + discussions: + type: string + description: The level of permission to grant the access token for discussions + and related comments and labels. + enum: + - read + - write environments: type: string description: The level of permission to grant the access token for managing @@ -68817,6 +73831,13 @@ components: enum: - read - write + merge_queues: + type: string + description: The level of permission to grant the access token to manage + the merge queues for a repository. + enum: + - read + - write metadata: type: string description: The level of permission to grant the access token to search @@ -68915,6 +73936,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -68945,8 +73973,8 @@ components: - write organization_custom_properties: type: string - description: The level of permission to grant the access token for custom - property management. + description: The level of permission to grant the access token for repository + custom properties management at the organization level. enum: - read - write @@ -69036,13 +74064,6 @@ components: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access token to manage - team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access token to manage @@ -69091,6 +74112,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -69139,6 +74168,10 @@ components: type: integer examples: - 1 + client_id: + type: string + examples: + - Iv1.ab1112223334445c target_id: description: The ID of the user or organization this token is being scoped to. @@ -69586,6 +74619,21 @@ components: type: boolean examples: - true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + examples: + - true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only + examples: + - all archived: description: Whether the repository is archived. default: false @@ -69729,6 +74777,14 @@ components: anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string required: - archive_url - assignees_url @@ -70566,6 +75622,28 @@ components: - html_url - key - name + actions-cache-retention-limit-for-enterprise: + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-enterprise: + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, the maximum + size limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 code-security-configuration: type: object description: A code security configuration @@ -70593,6 +75671,8 @@ components: enum: - enabled - disabled + - code_security + - secret_protection dependency_graph: type: string description: The enablement status of Dependency Graph @@ -70629,6 +75709,27 @@ components: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: + - string + - 'null' + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set + - + code_scanning_options: + type: + - object + - 'null' + description: Feature options for code scanning + properties: + allow_advanced: + type: + - boolean + - 'null' + description: Whether to allow repos which use advanced setup code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -70658,6 +75759,13 @@ components: - 'null' description: The label of the runner to use for code scanning when runner_type is 'labeled'. + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -70701,6 +75809,10 @@ components: enum: - TEAM - ROLE + security_configuration_id: + type: integer + description: The ID of the security configuration associated with + this bypass reviewer secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -70715,6 +75827,27 @@ components: - enabled - disabled - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -70742,6 +75875,17 @@ components: updated_at: type: string format: date-time + code-scanning-options: + type: + - object + - 'null' + description: Security Configuration feature options for code scanning + properties: + allow_advanced: + type: + - boolean + - 'null' + description: Whether to allow repos which use advanced setup code-scanning-default-setup-options: type: - object @@ -71381,6 +76525,43 @@ components: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true + dependabot-alert-dismissal-request-simple: + title: Dependabot alert dismissal request + description: Information about an active dismissal request for this Dependabot + alert. + type: + - object + - 'null' + properties: + id: + type: integer + description: The unique identifier of the dismissal request. + status: + type: string + description: The current status of the dismissal request. + enum: + - pending + - approved + - rejected + - cancelled + requester: + type: object + description: The user who requested the dismissal. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The login name of the user. + created_at: + type: string + format: date-time + description: The date and time when the dismissal request was created. + url: + type: string + format: uri + description: The API URL to get more information about this dismissal request. dependabot-alert-with-repository: type: object description: A Dependabot alert. @@ -71418,6 +76599,21 @@ components: - development - runtime - + relationship: + type: + - string + - 'null' + description: | + The vulnerable dependency's relationship to your project. + + > [!NOTE] + > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + readOnly: true + enum: + - unknown + - direct + - transitive + - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -71458,6 +76654,14 @@ components: "$ref": "#/components/schemas/alert-fixed-at" auto_dismissed_at: "$ref": "#/components/schemas/alert-auto-dismissed-at" + dismissal_request: + "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + "$ref": "#/components/schemas/simple-user" repository: "$ref": "#/components/schemas/simple-repository" required: @@ -71477,130 +76681,141 @@ components: - fixed_at - repository additionalProperties: false - secret-scanning-alert-state: - description: Sets the state of the secret scanning alert. You must provide `resolution` - when you set the state to `resolved`. - type: string - enum: - - open - - resolved - secret-scanning-alert-resolution: - type: - - string - - 'null' - description: "**Required when the `state` is `resolved`.** The reason for resolving - the alert." - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - - - organization-secret-scanning-alert: + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members type: object properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/alert-updated-at" + id: + type: integer + format: int64 + name: + type: string + description: + type: string + slug: + type: string url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: type: string format: uri - description: The REST API URL of the code locations for this alert. - state: - "$ref": "#/components/schemas/secret-scanning-alert-state" - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - resolved_at: - type: - - string - - 'null' - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - resolved_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - secret_type: - type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: + sync_to_organizations: type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - secret: + description: 'Retired: this field will not be returned with GHEC enterprise + teams.' + examples: + - disabled | all + organization_selection_type: type: string - description: The secret that was detected. - repository: - "$ref": "#/components/schemas/simple-repository" - push_protection_bypassed: - type: - - boolean - - 'null' - description: Whether push protection was bypassed for the detected secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypassed_at: - type: - - string - - 'null' - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - push_protection_bypass_request_reviewer: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypass_request_reviewer_comment: - type: - - string - - 'null' - description: An optional comment when reviewing a push protection bypass. - push_protection_bypass_request_comment: + examples: + - disabled | selected | all + group_id: type: - string - 'null' - description: An optional comment when requesting a push protection bypass. - push_protection_bypass_request_html_url: + examples: + - 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: type: - string - 'null' + description: 'Retired: this field will not be returned with GHEC enterprise + teams.' + examples: + - Justice League + html_url: + type: string format: uri - description: The URL to a push protection bypass request. - resolution_comment: - type: - - string - - 'null' - description: The comment that was optionally added when this alert was closed - validity: + examples: + - https://github.com/enterprises/dc/teams/justice-league + members_url: type: string - description: The token status as of the latest validity check. - enum: - - active - - inactive - - unknown - publicly_leaked: - type: - - boolean - - 'null' - description: Whether the secret was publicly leaked. - multi_repo: + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - name + - html_url + - slug + - created_at + - updated_at + - group_id + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: type: - - boolean + - string - 'null' - description: Whether the detected secret was found in multiple repositories - in the same organization or enterprise. + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description actor: title: Actor description: Actor @@ -71628,6 +76843,377 @@ components: - gravatar_id - url - avatar_url + label: + title: Label + description: Color-coded labels help you categorize and filter your issues (just + like labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + examples: + - 208045946 + node_id: + type: string + examples: + - MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + type: string + format: uri + examples: + - https://api.github.com/repositories/42/labels/bug + name: + description: The name of the label. + type: string + examples: + - bug + description: + description: Optional description of the label, such as its purpose. + type: + - string + - 'null' + examples: + - Something isn't working + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + examples: + - FFFFFF + default: + description: Whether this label comes by default in a new repository. + type: boolean + examples: + - true + required: + - id + - node_id + - url + - name + - description + - color + - default + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + answer_chosen_at: + type: + - string + - 'null' + answer_chosen_by: + 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 + required: + - login + - id + answer_html_url: + type: + - string + - 'null' + 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 + category: + type: object + properties: + created_at: + type: string + format: date-time + description: + type: string + emoji: + type: string + id: + type: integer + is_answerable: + type: boolean + name: + type: string + node_id: + type: string + repository_id: + type: integer + slug: + type: string + updated_at: + type: string + required: + - id + - repository_id + - emoji + - name + - description + - created_at + - updated_at + - slug + - is_answerable + comments: + type: integer + created_at: + type: string + format: date-time + html_url: + type: string + id: + type: integer + locked: + type: boolean + node_id: + type: string + number: + type: integer + 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 + state: + type: string + description: |- + The current state of the discussion. + `converting` means that the discussion is being converted from an issue. + `transferring` means that the discussion is being transferred from another repository. + enum: + - open + - closed + - locked + - converting + - transferring + state_reason: + description: The reason for the current state + type: + - string + - 'null' + enum: + - resolved + - outdated + - duplicate + - reopened + - + examples: + - resolved + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + 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 + 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 + 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 + - active_lock_reason + - body milestone: title: Milestone description: A collection of related issues and pull requests. @@ -71734,6 +77320,58 @@ components: - url - created_at - updated_at + issue-type: + title: Issue Type + description: The type of issue. + type: + - object + - 'null' + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: + - string + - 'null' + description: The description of the issue type. + color: + type: + - string + - 'null' + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + - + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description author-association: title: author_association type: string @@ -71799,6 +77437,183 @@ components: - total - completed - percent_completed + pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + pinned_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - pinned_at + - pinned_by + issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + examples: + - text + value: + description: The value of the issue field + anyOf: + - type: string + examples: + - Sample text + - type: number + examples: + - 42.5 + - type: integer + examples: + - 1 + type: + - 'null' + - string + - number + - integer + single_select_option: + description: Details about the selected option (only present for single_select + fields) + type: + - object + - 'null' + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + examples: + - 1 + name: + description: The name of the option + type: string + examples: + - High + color: + description: The color of the option + type: string + examples: + - red + required: + - id + - name + - color + required: + - issue_field_id + - node_id + - data_type + - value issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -71849,6 +77664,7 @@ components: - completed - reopened - not_planned + - duplicate - examples: - not_planned @@ -71983,6 +77799,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" repository: "$ref": "#/components/schemas/repository" performed_via_github_app: @@ -71995,6 +77813,22 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: + - string + - 'null' + format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" required: - assignee - closed_at @@ -72014,75 +77848,254 @@ components: - title - url - user - - author_association - created_at - updated_at - issue-comment: - title: Issue Comment - description: Comments provide a way for people to collaborate on an issue. + pull-request-minimal: + title: Pull Request Minimal type: object properties: id: - description: Unique identifier of the issue comment type: integer format: int64 - examples: - - 42 - node_id: + number: + type: integer + url: type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: url: - description: URL for the issue comment type: string format: uri - examples: - - https://api.github.com/repositories/42/issues/comments/1 - body: - description: Contents of the issue comment + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. type: string examples: - - What version of Safari were you using when you observed this bug? - body_text: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. type: string - body_html: + enum: + - uploaded + - open + content_type: type: string - html_url: + size: + type: integer + digest: + type: + - string + - 'null' + download_count: + type: integer + created_at: type: string - format: uri - user: + format: date-time + updated_at: + type: string + format: date-time + uploader: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: + - string + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + immutable: + description: Whether or not the release is immutable. + type: boolean + examples: + - false created_at: type: string format: date-time - examples: - - '2011-04-14T16:00:49Z' + published_at: + type: + - string + - 'null' + format: date-time updated_at: - type: string + type: + - string + - 'null' format: date-time - examples: - - '2011-04-14T16:00:49Z' - issue_url: + author: + "$ref": "#/components/schemas/simple-user" + assets: + type: array + items: + "$ref": "#/components/schemas/release-asset" + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. type: string format: uri - author_association: - "$ref": "#/components/schemas/author-association" - performed_via_github_app: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft - id - node_id + - author - html_url - - issue_url - - author_association - - user + - name + - prerelease + - tag_name + - target_commitish + - assets - url - - created_at - - updated_at event: title: Event description: Event @@ -72113,33 +78126,23 @@ components: org: "$ref": "#/components/schemas/actor" payload: - type: object - properties: - action: - type: string - issue: - "$ref": "#/components/schemas/issue" - comment: - "$ref": "#/components/schemas/issue-comment" - pages: - type: array - items: - type: object - properties: - page_name: - type: string - title: - type: string - summary: - type: - - string - - 'null' - action: - type: string - sha: - type: string - html_url: - type: string + oneOf: + - "$ref": "#/components/schemas/create-event" + - "$ref": "#/components/schemas/delete-event" + - "$ref": "#/components/schemas/discussion-event" + - "$ref": "#/components/schemas/issues-event" + - "$ref": "#/components/schemas/issue-comment-event" + - "$ref": "#/components/schemas/fork-event" + - "$ref": "#/components/schemas/gollum-event" + - "$ref": "#/components/schemas/member-event" + - "$ref": "#/components/schemas/public-event" + - "$ref": "#/components/schemas/push-event" + - "$ref": "#/components/schemas/pull-request-event" + - "$ref": "#/components/schemas/pull-request-review-comment-event" + - "$ref": "#/components/schemas/pull-request-review-event" + - "$ref": "#/components/schemas/commit-comment-event" + - "$ref": "#/components/schemas/release-event" + - "$ref": "#/components/schemas/watch-event" public: type: boolean created_at: @@ -73296,6 +79299,18 @@ components: - 'null' properties: advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: type: object properties: status: @@ -73346,6 +79361,43 @@ components: enum: - enabled - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + 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 minimal-repository: title: Minimal Repository description: Minimal Repository @@ -73599,6 +79651,15 @@ components: type: boolean has_discussions: type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: type: boolean disabled: @@ -73665,7 +79726,9 @@ components: spdx_id: type: string url: - type: string + type: + - string + - 'null' node_id: type: string forks: @@ -73688,6 +79751,12 @@ components: - false security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true required: - archive_url - assignees_url @@ -73829,77 +79898,299 @@ components: - reason - url - subscribed - organization-simple: - title: Organization Simple - description: A GitHub organization. + actions-cache-retention-limit-for-organization: + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. type: object properties: - login: - type: string + max_cache_retention_days: + description: For repositories in this organization, the maximum duration, + in days, for which caches in a repository may be retained. + type: integer examples: - - github - id: + - 14 + actions-cache-storage-limit-for-organization: + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum size limit + for the sum of all caches in a repository, in gigabytes. type: integer examples: - - 1 - node_id: - type: string + - 10 + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: + - string + - 'null' + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: + - internal + accessible_repositories: + type: array + items: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-repository" + additionalProperties: false + budget: + type: object + properties: + id: type: string - format: uri + description: The unique identifier for the budget examples: - - https://api.github.com/orgs/github - repos_url: + - 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: type: string - format: uri + description: The type of pricing for the budget + enum: + - SkuPricing + - ProductPricing examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri + - SkuPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget examples: - - https://api.github.com/orgs/github/events - hooks_url: + - true + budget_scope: type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) examples: - - https://api.github.com/orgs/github/hooks - issues_url: + - enterprise + budget_entity_name: type: string + description: The name of the entity for the budget (enterprise does not + require a name). examples: - - https://api.github.com/orgs/github/issues - members_url: + - octocat/hello-world + budget_product_sku: type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + "$ref": "#/components/schemas/budget" + description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available (maps + to hasNextPage from billing platform) + total_count: + type: integer + description: Total number of budgets matching the query + required: + - budgets + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + enum: + - enterprise + - organization + - repository + - cost_center examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: + - enterprise + budget_entity_name: type: string + description: The name of the entity to apply the budget to examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: + - octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + examples: + - true + budget_product_sku: type: string + description: A single product or sku to apply the budget to. examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' + - actions_linux + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing examples: - - A great organization + - ProductPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + examples: + - true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + examples: + - mona + - lisa required: - - login - - url - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + delete-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the deletion operation + id: + type: string + description: The ID of the deleted budget + required: + - message + - id + billing-premium-request-usage-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + user: + type: string + description: The name of the user for the usage report. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems billing-usage-report: type: object properties: @@ -73952,6 +80243,85 @@ components: - discountAmount - netAmount - organizationName + billing-usage-summary-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems organization-full: title: Organization Full description: Organization Full @@ -74133,6 +80503,13 @@ components: type: - string - 'null' + default_repository_branch: + type: + - string + - 'null' + description: The default branch for repositories created in this organization. + examples: + - main members_can_create_repositories: type: - boolean @@ -74173,6 +80550,38 @@ components: type: boolean examples: - true + members_can_delete_repositories: + type: boolean + examples: + - true + members_can_change_repo_visibility: + type: boolean + examples: + - true + members_can_invite_outside_collaborators: + type: boolean + examples: + - true + members_can_delete_issues: + type: boolean + examples: + - true + display_commenter_full_name_setting_enabled: + type: boolean + examples: + - true + readers_can_create_discussions: + type: boolean + examples: + - true + members_can_create_teams: + type: boolean + examples: + - true + members_can_view_dependency_insights: + type: boolean + examples: + - true members_can_fork_private_repositories: type: - boolean @@ -74383,7 +80792,6 @@ components: - size_gb - display_name - source - - version actions-hosted-runner-machine-spec: title: Github-owned VM details. description: Provides details of a particular machine spec. @@ -74503,6 +80911,9 @@ components: format: date-time examples: - '2022-10-09T23:39:01Z' + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -74511,7 +80922,98 @@ components: - status - public_ip_enabled - platform - actions-hosted-runner-image: + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: integer + examples: + - 1 + platform: + description: The operating system of the image. + type: string + examples: + - linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + examples: + - 200 + name: + description: Display name for this image. + type: string + examples: + - CustomImage + source: + description: The image provider. + type: string + examples: + - custom + versions_count: + description: The number of image versions associated with the image. + type: integer + examples: + - 4 + latest_version: + description: The latest image version associated with the image. + type: string + examples: + - 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + examples: + - Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + examples: + - 1.0.0 + state: + description: The state of image version. + type: string + examples: + - Ready + size_gb: + description: Image version size in GB. + type: integer + examples: + - 30 + created_on: + description: The creation date time of the image version. + type: string + examples: + - '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + examples: + - None + required: + - version + - state + - size_gb + - created_on + - state_details + actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -74615,6 +81117,9 @@ components: type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. + sha-pinning-required: + type: boolean + description: Whether actions must be pinned to a full-length commit SHA. actions-organization-permissions: type: object properties: @@ -74629,8 +81134,88 @@ components: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_repositories + actions-artifact-and-log-retention-response: + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + actions-artifact-and-log-retention: + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + actions-fork-pr-contributor-approval: + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require approval + from a maintainer. + required: + - approval_policy + actions-fork-pr-workflows-private-repos: + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. + actions-fork-pr-workflows-private-repos-request: + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. selected-actions: type: object properties: @@ -74652,6 +81237,23 @@ components: > The `patterns_allowed` setting only applies to public repositories. items: type: string + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be + used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization actions-default-workflow-permissions: type: string description: The default workflow permissions granted to the GITHUB_TOKEN when @@ -74763,12 +81365,12 @@ components: type: object properties: id: - description: The id of the runner. + description: The ID of the runner. type: integer examples: - 5 runner_group_id: - description: The id of the runner group. + description: The ID of the runner group. type: integer examples: - 1 @@ -74793,6 +81395,8 @@ components: type: array items: "$ref": "#/components/schemas/runner-label" + ephemeral: + type: boolean required: - id - name @@ -74980,6 +81584,336 @@ components: - created_at - updated_at - visibility + artifact-deployment-record: + title: Artifact Deployment Record + description: Artifact Metadata Deployment Record + type: object + properties: + id: + type: integer + digest: + type: string + logical_environment: + type: string + physical_environment: + type: string + cluster: + type: string + deployment_name: + type: string + tags: + type: object + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + created_at: + type: string + updated_at: + type: string + attestation_id: + type: + - integer + - 'null' + description: The ID of the provenance attestation associated with the deployment + record. + campaign-state: + title: Campaign state + description: Indicates whether a campaign is open or closed + type: string + enum: + - open + - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + examples: + - 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + examples: + - 42 + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + campaign-summary: + title: Campaign summary + description: The campaign metadata and alert stats. + type: object + properties: + number: + type: integer + description: The number of the newly created campaign + created_at: + type: string + format: date-time + description: The date and time the campaign was created, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: The date and time the campaign was last updated, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + name: + type: string + description: The campaign name + description: + type: string + description: The campaign description + managers: + description: The campaign managers + type: array + items: + "$ref": "#/components/schemas/simple-user" + team_managers: + description: The campaign team managers + type: array + items: + "$ref": "#/components/schemas/team" + published_at: + description: The date and time the campaign was published, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + ends_at: + description: The date and time the campaign has ended, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + closed_at: + description: The date and time the campaign was closed, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + type: + - string + - 'null' + format: date-time + state: + "$ref": "#/components/schemas/campaign-state" + contact_link: + description: The contact link of the campaign. + type: + - string + - 'null' + format: uri + alert_stats: + type: object + additionalProperties: false + properties: + open_count: + type: integer + description: The number of open alerts + closed_count: + type: integer + description: The number of closed alerts + in_progress_count: + type: integer + description: The number of in-progress alerts + required: + - open_count + - closed_count + - in_progress_count + required: + - number + - created_at + - updated_at + - description + - managers + - ends_at + - state + - contact_link code-scanning-analysis-tool-name: type: string description: The name of the tool used to generate the code scanning analysis. @@ -75224,6 +82158,14 @@ components: "$ref": "#/components/schemas/code-scanning-alert-instance" repository: "$ref": "#/components/schemas/simple-repository" + dismissal_approved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -75626,8 +82568,8 @@ components: required: - key_id - key - copilot-seat-breakdown: - title: Copilot Business Seat Breakdown + copilot-organization-seat-breakdown: + title: Copilot Seat Breakdown description: The breakdown of Copilot Business seats for the organization. type: object properties: @@ -75644,8 +82586,8 @@ components: of the current billing cycle. pending_invitation: type: integer - description: The number of seats that have been assigned to users that have - not yet accepted an invitation to this organization. + description: The number of users who have been invited to receive a Copilot + seat through this organization. active_this_cycle: type: integer description: The number of seats that have used Copilot during the current @@ -75661,36 +82603,35 @@ components: type: object properties: seat_breakdown: - "$ref": "#/components/schemas/copilot-seat-breakdown" + "$ref": "#/components/schemas/copilot-organization-seat-breakdown" public_code_suggestions: type: string - description: The organization policy for allowing or disallowing Copilot - to make suggestions that match public code. + description: The organization policy for allowing or blocking suggestions + matching public code (duplication detection filter). enum: - allow - block - unconfigured - - unknown ide_chat: type: string - description: The organization policy for allowing or disallowing organization - members to use Copilot Chat within their editor. + description: The organization policy for allowing or disallowing Copilot + Chat in the IDE. enum: - enabled - disabled - unconfigured platform_chat: type: string - description: The organization policy for allowing or disallowing organization - members to use Copilot features within github.com. + description: The organization policy for allowing or disallowing Copilot + features on GitHub.com. enum: - enabled - disabled - unconfigured cli: type: string - description: The organization policy for allowing or disallowing organization - members to use Copilot within their CLI. + description: The organization policy for allowing or disallowing Copilot + CLI. enum: - enabled - disabled @@ -75710,220 +82651,11 @@ components: enum: - business - enterprise - - unknown required: - seat_breakdown - public_code_suggestions - seat_management_setting additionalProperties: true - team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team should have - type: string - examples: - - closed - notification_setting: - description: The notification setting the team has set - type: string - examples: - - notifications_enabled - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: - type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - enterprise-team: - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - examples: - - disabled | all - group_id: - type: - - string - - 'null' - examples: - - 62ab9291-fae2-468e-974b-7e45096d5021 - group_name: - type: - - string - - 'null' - examples: - - Justice League - html_url: - type: string - format: uri - examples: - - https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, @@ -75931,7 +82663,9 @@ components: type: object properties: assignee: - "$ref": "#/components/schemas/simple-user" + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" organization: anyOf: - type: 'null' @@ -75967,6 +82701,13 @@ components: - 'null' description: Last editor that was used by the user for a GitHub Copilot completion. + last_authenticated_at: + type: + - string + - 'null' + format: date-time + description: Timestamp of the last time the user authenticated with GitHub + Copilot, in ISO 8601 format. created_at: type: string format: date-time @@ -75989,9 +82730,17 @@ components: - enterprise - unknown required: - - assignee - created_at additionalProperties: false + copilot-organization-content-exclusion-details: + title: Copilot Organization Content Exclusion Details + description: List all Copilot Content Exclusion rules for an organization. + type: object + additionalProperties: + type: array + items: + type: string + description: The path to the file that will be excluded. copilot-ide-code-completions: type: - object @@ -76129,8 +82878,8 @@ components: properties: name: type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. + description: Name of the model used for Copilot Chat. If the + default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. @@ -76161,7 +82910,7 @@ components: type: - object - 'null' - description: Usage metrics for Copilot Chat in github.com + description: Usage metrics for Copilot Chat in GitHub.com additionalProperties: true properties: total_engaged_users: @@ -76176,8 +82925,8 @@ components: properties: name: type: string - description: Name of the model used for Copilot code completion suggestions. - If the default model is used will appear as 'default'. + description: Name of the model used for Copilot Chat. If the default + model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. @@ -76227,8 +82976,8 @@ components: properties: name: type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. + description: Name of the model used for Copilot pull request + summaries. If the default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. @@ -76281,90 +83030,6 @@ components: required: - date additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, in `YYYY-MM-DD` - format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions shown - to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions accepted - by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested by - Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot code completion - suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code suggested by - Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response pairs) - sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot Chat - in the IDE during the day specified. - breakdown: - type: - - array - - 'null' - description: Breakdown of Copilot code completions usage by language and - editor - items: - type: object - description: Breakdown of Copilot usage by editor for this language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions were shown - to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were shown to - users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to users in the - editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted by users in - the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by Copilot in the - editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users in the - editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot completion - suggestions in the editor specified during the day specified. - required: - - day - - breakdown - additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -76788,6 +83453,72 @@ components: "$ref": "#/components/schemas/interaction-expiry" required: - limit + organization-create-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization + level. + type: boolean + description: + description: Description of the issue type. + type: + - string + - 'null' + color: + description: Color for the issue type. + type: + - string + - 'null' + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + - + required: + - name + - is_enabled + organization-update-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization + level. + type: boolean + description: + description: Description of the issue type. + type: + - string + - 'null' + color: + description: Color for the issue type. + type: + - string + - 'null' + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + - + required: + - name + - is_enabled org-membership: title: Org Membership description: Org Membership @@ -76816,6 +83547,22 @@ components: - billing_manager examples: - admin + direct_membership: + type: boolean + description: Whether the user has direct membership in the organization. + examples: + - true + enterprise_teams_providing_indirect_membership: + type: array + description: |- + The slugs of the enterprise teams providing the user with indirect membership in the organization. + A limit of 100 enterprise team slugs is returned. + maxItems: 100 + items: + type: string + examples: + - ent:team-one + - ent:team-two organization_url: type: string format: uri @@ -77064,6 +83811,22 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/team-simple" + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + examples: + - 42 required: - id - node_id @@ -77075,6 +83838,7 @@ components: - html_url - repositories_url - slug + - type - parent user-role-assignment: title: A Role Assignment for a User @@ -77484,7 +84248,25 @@ components: description: The registry type. enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry type: string + url: + description: The URL of the private registry. + type: string + format: uri username: description: The username to use when authenticating with the private registry. type: @@ -77492,6 +84274,14 @@ components: - 'null' examples: - monalisa + replaces_base: + description: Whether this private registry replaces the base registry (e.g., + npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot + will only use this registry and will not fall back to the public registry. + When `false` (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false visibility: description: Which type of organization repositories have access to the private registry. @@ -77526,12 +84316,38 @@ components: description: The registry type. enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + url: + description: The URL of the private registry. type: string + format: uri username: description: The username to use when authenticating with the private registry. type: string examples: - monalisa + replaces_base: + description: Whether this private registry replaces the base registry (e.g., + npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot + will only use this registry and will not fall back to the public registry. + When `false` (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false visibility: description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by @@ -77559,101 +84375,959 @@ components: - visibility - created_at - updated_at - project: - title: Project - description: Projects are a way to organize columns and cards of work. + projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project type: object properties: - owner_url: + id: + type: number + description: The unique identifier of the status update. + node_id: type: string - format: uri + description: The node ID of the status update. + project_node_id: + type: string + description: The node ID of the project that this status update belongs + to. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The time when the status update was created. + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + description: The time when the status update was last updated. + examples: + - '2022-04-28T12:00:00Z' + status: + type: + - string + - 'null' + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + - + description: The current status. + start_date: + type: string + format: date + description: The start date of the period covered by the update. + examples: + - '2022-04-28' + target_date: + type: string + format: date + description: The target date associated with the update. examples: - - https://api.github.com/repos/api-playground/projects-test + - '2022-04-28' + body: + description: Body of the status update + type: + - string + - 'null' + examples: + - The project is off to a great start! + required: + - id + - node_id + - created_at + - updated_at + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + description: The unique identifier of the project. + node_id: + type: string + description: The node ID of the project. + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: The project title. + description: + type: + - string + - 'null' + description: A short description of the project. + public: + type: boolean + description: Whether the project is visible to anyone with access to the + owner. + closed_at: + type: + - string + - 'null' + format: date-time + description: The time when the project was closed. + examples: + - '2022-04-28T12:00:00Z' + created_at: + type: string + format: date-time + description: The time when the project was created. + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + description: The time when the project was last updated. + examples: + - '2022-04-28T12:00:00Z' + number: + type: integer + description: The project number. + short_description: + type: + - string + - 'null' + description: A concise summary of the project. + deleted_at: + type: + - string + - 'null' + format: date-time + description: The time when the project was deleted. + examples: + - '2022-04-28T12:00:00Z' + deleted_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + state: + type: string + enum: + - open + - closed + description: The current state of the project. + latest_status_update: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + enabled_by: + "$ref": "#/components/schemas/simple-user" + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: url: type: string format: uri examples: - - https://api.github.com/projects/1002604 + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== html_url: type: string format: uri examples: - - https://github.com/api-playground/projects-test/projects/12 - columns_url: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: type: string format: uri examples: - - https://api.github.com/projects/1002604/columns - id: - type: integer + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri examples: - - 1002604 - node_id: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: type: string + format: uri examples: - - MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: type: string + format: uri examples: - - Week One Sprint - body: - description: Body of the project - type: - - string - - 'null' + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string examples: - - This project represents the sprint of the first week in January + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e number: type: integer examples: - - 1 + - 1347 state: - description: State of the project; either 'open' or 'closed' type: string examples: - open - creator: + locked: + type: boolean + examples: + - true + title: + type: string + examples: + - new-feature + user: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated created_at: type: string format: date-time examples: - - '2011-04-10T20:09:31Z' + - '2011-01-26T19:01:12Z' updated_at: type: string format: date-time examples: - - '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members have - on this project. Only present if owner is an organization. - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. Only present - if owner is an organization. + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/team" + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + "$ref": "#/components/schemas/link" + commits: + "$ref": "#/components/schemas/link" + statuses: + "$ref": "#/components/schemas/link" + html: + "$ref": "#/components/schemas/link" + issue: + "$ref": "#/components/schemas/link" + review_comments: + "$ref": "#/components/schemas/link" + review_comment: + "$ref": "#/components/schemas/link" + self: + "$ref": "#/components/schemas/link" + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + "$ref": "#/components/schemas/author-association" + auto_merge: + "$ref": "#/components/schemas/auto-merge" + draft: + description: Indicates whether or not the pull request is a draft. type: boolean + examples: + - false required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url - id - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone - number - - name - - body + - patch_url + - review_comment_url + - review_comments_url + - statuses_url - state + - locked + - title + - updated_at - url + - user + - author_association + - auto_merge + projects-v2-draft-issue: + title: Draft Issue + description: A draft issue in a project + type: object + properties: + id: + type: number + description: The ID of the draft issue + node_id: + type: string + description: The node ID of the draft issue + title: + type: string + description: The title of the draft issue + body: + type: + - string + - 'null' + description: The body content of the draft issue + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The time the draft issue was created + updated_at: + type: string + format: date-time + description: The time the draft issue was last updated + required: + - id + - node_id + - title + - user + - created_at + - updated_at + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-item-simple: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + content: + oneOf: + - "$ref": "#/components/schemas/issue" + - "$ref": "#/components/schemas/pull-request-simple" + - "$ref": "#/components/schemas/projects-v2-draft-issue" + description: The content represented by the item. + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The time when the item was created. + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + description: The time when the item was last updated. + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + description: The time when the item was archived. + examples: + - '2022-04-28T12:00:00Z' + project_url: + type: string + format: uri + description: The URL of the project this item belongs to. + item_url: + type: string + format: uri + description: The URL of the item in the project. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-single-select-options: + title: Projects v2 Single Select Option + description: An option for a single select field + type: object + properties: + id: + type: string + description: The unique identifier of the option. + name: + type: object + description: The display name of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: + type: object + description: The description of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + color: + type: string + description: The color associated with the option. + required: + - id + - name + - description + - color + projects-v2-iteration-settings: + title: Projects v2 Iteration Setting + description: An iteration setting for an iteration field + type: object + properties: + id: + type: string + description: The unique identifier of the iteration setting. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + title: + type: object + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: The iteration title, in raw text and HTML formats. + completed: + type: boolean + description: Whether the iteration has been completed. + required: + - id + - start_date + - duration + - title + - completed + projects-v2-field: + title: Projects v2 Field + description: A field inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the field. + node_id: + type: string + description: The node ID of the field. + project_url: + type: string + description: The API URL of the project that contains the field. + examples: + - https://api.github.com/projects/1 + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - assignees + - linked_pull_requests + - reviewers + - labels + - milestone + - repository + - title + - text + - single_select + - number + - date + - iteration + - issue_type + - parent_issue + - sub_issues_progress + options: + type: array + description: The options available for single select fields. + items: + "$ref": "#/components/schemas/projects-v2-single-select-options" + configuration: + type: object + description: Configuration for iteration fields. + properties: + start_day: + type: integer + description: The day of the week when the iteration starts. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + items: + "$ref": "#/components/schemas/projects-v2-iteration-settings" + created_at: + type: string + format: date-time + description: The time when the field was created. + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + description: The time when the field was last updated. + examples: + - '2022-04-28T12:00:00Z' + required: + - id + - name + - data_type + - created_at + - updated_at + - project_url + projects-v2-field-single-select-option: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + additionalProperties: false + projects-v2-field-iteration-configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. Individual iterations + can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + additionalProperties: false + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + projects-v2-item-with-content: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + project_url: + type: string + format: uri + description: The API URL of the project that contains this item. + examples: + - https://api.github.com/users/monalisa/2/projectsV2/3 + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + content: + type: + - object + - 'null' + additionalProperties: true + description: The content of the item, which varies by content type. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The time when the item was created. + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + description: The time when the item was last updated. + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + description: The time when the item was archived. + examples: + - '2022-04-28T12:00:00Z' + item_url: + type: + - string + - 'null' + format: uri + description: The API URL of this item. + examples: + - https://api.github.com/users/monalisa/2/projectsV2/items/3 + fields: + type: array + items: + type: object + additionalProperties: true + description: The fields and values associated with this item. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-view: + title: Projects v2 View + description: A view inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the view. + number: + type: integer + description: The number of the view within the project. + name: + type: string + description: The name of the view. + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + node_id: + type: string + description: The node ID of the view. + project_url: + type: string + description: The API URL of the project that contains the view. + examples: + - https://api.github.com/orgs/octocat/projectsV2/1 + html_url: + type: string + format: uri + description: The web URL of the view. + examples: + - https://github.com/orgs/octocat/projects/1/views/1 + creator: + allOf: + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + description: The time when the view was created. + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + description: The time when the view was last updated. + examples: + - '2022-04-28T12:00:00Z' + filter: + type: + - string + - 'null' + description: The filter query for the view. + examples: + - is:issue is:open + visible_fields: + type: array + description: The list of field IDs that are visible in the view. + items: + type: integer + sort_by: + type: array + description: The sorting configuration for the view. Each element is a tuple + of [field_id, direction] where direction is "asc" or "desc". + items: + type: array + minItems: 2 + maxItems: 2 + items: + oneOf: + - type: integer + - type: string + group_by: + type: array + description: The list of field IDs used for horizontal grouping. + items: + type: integer + vertical_group_by: + type: array + description: The list of field IDs used for vertical grouping (board layout). + items: + type: integer + required: + - id + - number + - name + - layout + - node_id + - project_url - html_url - - owner_url - creator - - columns_url - created_at - updated_at + - visible_fields + - sort_by + - group_by + - vertical_group_by custom-property: title: Organization Custom Property description: Custom property defined on an organization @@ -77682,6 +85356,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -77710,8 +85385,6 @@ components: - 'null' items: type: string - maxLength: 75 - maxItems: 200 description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. @@ -77726,6 +85399,9 @@ components: description: Who can edit the values of the property examples: - org_actors + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory required: - property_name - value_type @@ -77741,6 +85417,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property examples: - single_select @@ -77769,11 +85446,23 @@ components: - 'null' items: type: string - maxLength: 75 - maxItems: 200 description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. + values_editable_by: + type: + - string + - 'null' + enum: + - org_actors + - org_and_repo_actors + - + description: Who can edit the values of the property + examples: + - org_actors + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory required: - value_type custom-property-value: @@ -78152,6 +85841,19 @@ components: type: boolean examples: - true + has_pull_requests: + type: boolean + examples: + - true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only + examples: + - all archived: type: boolean disabled: @@ -78428,8 +86130,9 @@ components: type: - integer - 'null' - description: The ID of the actor that can bypass a ruleset. If `actor_type` - is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, + description: The ID of the actor that can bypass a ruleset. Required for + `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` + is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. actor_type: @@ -78446,10 +86149,13 @@ components: 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. + is only applicable to branch rulesets. When `bypass_mode` is `exempt`, + rules will not be run for that actor and a bypass audit entry will not + be created. enum: - always - pull_request + - exempt default: always repository-ruleset-conditions: title: Repository ruleset conditions for ref names @@ -78744,6 +86450,22 @@ components: type: string enum: - required_signatures + repository-rule-params-reviewer: + title: Reviewer + description: A required reviewing team + type: object + properties: + id: + type: integer + description: ID of the reviewer which must review changes to matching files. + type: + type: string + description: The type of the reviewer + enum: + - Team + required: + - id + - type repository-rule-params-required-reviewer-configuration: title: RequiredReviewerConfiguration description: A reviewing team, and file patterns describing which files they @@ -78753,8 +86475,8 @@ components: 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. + files must be approved by the specified team. File patterns use fnmatch + syntax. items: type: string minimum_approvals: @@ -78762,13 +86484,12 @@ components: 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. + reviewer: + "$ref": "#/components/schemas/repository-rule-params-reviewer" required: - file_patterns - minimum_approvals - - reviewer_id + - reviewer repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -78786,11 +86507,14 @@ components: properties: allowed_merge_methods: type: array - description: When merging pull requests, you can allow any combination - of merge commits, squashing, or rebasing. At least one option must - be enabled. + description: Array of allowed merge methods. Allowed values include + `merge`, `squash`, and `rebase`. At least one option must be enabled. items: type: string + enum: + - merge + - squash + - rebase dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -78813,6 +86537,15 @@ components: type: boolean description: All conversations on code must be resolved before a pull request can be merged. + required_reviewers: + type: array + description: |- + > [!NOTE] + > `required_reviewers` is in beta and subject to change. + + A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + items: + "$ref": "#/components/schemas/repository-rule-params-required-reviewer-configuration" required: - dismiss_stale_reviews_on_push - require_code_owner_review @@ -78893,7 +86626,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78927,7 +86660,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78961,7 +86694,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78995,7 +86728,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -79029,7 +86762,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -79047,6 +86780,98 @@ components: required: - operator - pattern + repository-rule-file-path-restriction: + title: file_path_restriction + description: Prevent commits that include changes in specified file and folder + paths from being pushed to the commit graph. This includes absolute paths + that contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed to + the commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: Prevent commits that include file paths that exceed the specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: Prevent commits with individual files that exceed the specified + limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size repository-rule-params-restricted-commits: title: RestrictedCommits description: Restricted commit @@ -79164,6 +86989,44 @@ components: "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" required: - code_scanning_tools + repository-rule-copilot-code-review: + title: copilot_code_review + description: Request Copilot code review for new pull requests automatically + if the author has access to Copilot code review and their premium requests + quota has not reached the limit. + type: object + required: + - type + properties: + type: + type: string + enum: + - copilot_code_review + parameters: + type: object + properties: + review_draft_pull_requests: + type: boolean + description: Copilot automatically reviews draft pull requests before + they are marked as ready for review. + review_on_push: + type: boolean + description: Copilot automatically reviews each new push to the pull + request. + repository-rule-params-copilot-code-review-analysis-tool: + title: CopilotCodeReviewAnalysisTool + description: A tool that must provide code review results for this rule to pass. + type: object + properties: + name: + type: string + description: The name of a code review analysis tool + enum: + - CodeQL + - ESLint + - PMD + required: + - name repository-rule: title: Repository Rule type: object @@ -79184,95 +87047,13 @@ components: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - - title: file_path_restriction - description: Prevent commits that include changes in specified file paths - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_paths - - title: max_file_path_length - description: Prevent commits that include file paths that exceed a specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths - minimum: 1 - maximum: 256 - required: - - max_file_path_length - - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - title: max_file_size - description: Prevent commits that exceed a specified file size limit from - being pushed to the commit. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" repository-ruleset: title: Repository ruleset type: object @@ -79323,6 +87104,7 @@ components: - always - pull_requests_only - never + - exempt node_id: type: string _links: @@ -79359,6 +87141,32 @@ components: updated_at: type: string format: date-time + org-rules: + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - "$ref": "#/components/schemas/repository-rule-creation" + - "$ref": "#/components/schemas/repository-rule-update" + - "$ref": "#/components/schemas/repository-rule-deletion" + - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-required-deployments" + - "$ref": "#/components/schemas/repository-rule-required-signatures" + - "$ref": "#/components/schemas/repository-rule-pull-request" + - "$ref": "#/components/schemas/repository-rule-required-status-checks" + - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" rule-suites: title: Rule Suites description: Response @@ -79412,6 +87220,59 @@ components: description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + rule-suite-pull-request: + title: Pull request rule suite metadata + description: Metadata for a pull request rule evaluation result. + type: object + properties: + pull_request: + type: object + description: The pull request associated with the rule evaluation. + properties: + id: + type: integer + description: The unique identifier of the pull request. + number: + type: integer + description: The number of the pull request. + user: + type: object + description: The user who created the pull request. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The handle for the GitHub user account. + type: + type: string + description: The type of the user. + reviews: + type: array + description: The reviews associated with the pull request. + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the review. + user: + type: object + description: The user who submitted the review. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The handle for the GitHub user account. + type: + type: string + description: The type of the user. + state: + type: string + description: The state of the review. rule-suite: title: Rule Suite description: Response @@ -79432,10 +87293,10 @@ components: description: The handle for the GitHub user account. before_sha: type: string - description: The first commit sha before the push evaluation. + description: The previous commit SHA of the ref. after_sha: type: string - description: The last commit sha in the push evaluation. + description: The new commit SHA of the ref. ref: type: string description: The ref name that the evaluation ran on. @@ -79515,6 +87376,544 @@ components: - 'null' description: The detailed failure message for the rule. Null if the rule passed. + ruleset-version: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + ruleset-version-with-state: + allOf: + - "$ref": "#/components/schemas/ruleset-version" + - type: object + required: + - state + properties: + state: + type: object + description: The state of the ruleset version + secret-scanning-alert-state: + description: Sets the state of the secret scanning alert. You must provide `resolution` + when you set the state to `resolved`. + type: string + enum: + - open + - resolved + secret-scanning-alert-resolution: + type: + - string + - 'null' + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + examples: + - "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + examples: + - "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + examples: + - https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + examples: + - https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + examples: + - https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + examples: + - https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + push_protection_bypass_request_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. + push_protection_bypass_request_comment: + type: + - string + - 'null' + description: An optional comment when requesting a push protection bypass. + push_protection_bypass_request_html_url: + type: + - string + - 'null' + format: uri + description: The URL to a push protection bypass request. + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - 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. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + secret-scanning-row-version: + type: + - string + - 'null' + description: The version of the entity. This is used to confirm you're updating + the current version of the entity and mitigate unintentionally overriding + someone else's update. + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: + - string + - 'null' + description: The version of this pattern if it's a custom pattern. + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern represents, + rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern that are false positives, + rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that were bypassed, + rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: + - string + - 'null' + description: The push protection setting for this pattern set at the enterprise + level. Only present for partner patterns when the organization has a parent + enterprise. + enum: + - not-set + - disabled + - enabled + - + setting: + type: string + description: The current push protection setting for this pattern. If this + is `not-set`, then it inherits either the enterprise setting if it exists + or the default setting. + enum: + - not-set + - disabled + - enabled + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings related + to push protection. + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. @@ -79840,104 +88239,28 @@ components: - collaborating_teams - private_fork additionalProperties: false - actions-billing-usage: - type: object - properties: - total_minutes_used: - type: integer - description: The sum of the free and paid GitHub Actions minutes used. - total_paid_minutes_used: - type: integer - description: The total paid GitHub Actions minutes used. - included_minutes: - type: integer - description: The amount of free GitHub Actions minutes available. - minutes_used_breakdown: - type: object - properties: - UBUNTU: - type: integer - description: Total minutes used on Ubuntu runner machines. - MACOS: - type: integer - description: Total minutes used on macOS runner machines. - WINDOWS: - type: integer - description: Total minutes used on Windows runner machines. - ubuntu_4_core: - type: integer - description: Total minutes used on Ubuntu 4 core runner machines. - ubuntu_8_core: - type: integer - description: Total minutes used on Ubuntu 8 core runner machines. - ubuntu_16_core: - type: integer - description: Total minutes used on Ubuntu 16 core runner machines. - ubuntu_32_core: - type: integer - description: Total minutes used on Ubuntu 32 core runner machines. - ubuntu_64_core: - type: integer - description: Total minutes used on Ubuntu 64 core runner machines. - windows_4_core: - type: integer - description: Total minutes used on Windows 4 core runner machines. - windows_8_core: - type: integer - description: Total minutes used on Windows 8 core runner machines. - windows_16_core: - type: integer - description: Total minutes used on Windows 16 core runner machines. - windows_32_core: - type: integer - description: Total minutes used on Windows 32 core runner machines. - windows_64_core: - type: integer - description: Total minutes used on Windows 64 core runner machines. - macos_12_core: - type: integer - description: Total minutes used on macOS 12 core runner machines. - total: - type: integer - description: Total minutes used on all runner machines. - required: - - total_minutes_used - - total_paid_minutes_used - - included_minutes - - minutes_used_breakdown - packages-billing-usage: - type: object - properties: - total_gigabytes_bandwidth_used: - type: integer - description: Sum of the free and paid storage space (GB) for GitHuub Packages. - total_paid_gigabytes_bandwidth_used: - type: integer - description: Total paid storage space (GB) for GitHuub Packages. - included_gigabytes_bandwidth: - type: integer - description: Free storage space (GB) for GitHub Packages. - required: - - total_gigabytes_bandwidth_used - - total_paid_gigabytes_bandwidth_used - - included_gigabytes_bandwidth - combined-billing-usage: + immutable-releases-organization-settings: + title: Check immutable releases organization settings + description: Check immutable releases settings for an organization. type: object properties: - days_left_in_billing_cycle: - type: integer - description: Numbers of days left in billing cycle. - estimated_paid_storage_for_month: - type: integer - description: Estimated storage space (GB) used in billing cycle. - estimated_storage_for_month: - type: integer - description: Estimated sum of free and paid storage space (GB) used in billing - cycle. + enforced_repositories: + type: string + description: The policy that controls how immutable releases are enforced + in the organization. + enum: + - all + - none + - selected + examples: + - all + selected_repositories_url: + type: string + description: The API URL to use to get or set the selected repositories + for immutable releases enforcement, when `enforced_repositories` is set + to `selected`. required: - - days_left_in_billing_cycle - - estimated_paid_storage_for_month - - estimated_storage_for_month + - enforced_repositories network-configuration: title: Hosted compute network configuration description: A hosted compute network configuration. @@ -79967,6 +88290,19 @@ components: type: string examples: - 123ABC456DEF789 + failover_network_settings_ids: + description: The unique identifier of each failover network settings in + the configuration. + type: array + items: + type: string + examples: + - 123ABC456DEF789 + failover_network_enabled: + description: Indicates whether the failover network resource is enabled. + type: boolean + examples: + - true created_on: description: The time at which the network configuration was created, in ISO 8601 format. @@ -80281,6 +88617,12 @@ components: - created_at - updated_at - archived_at + ldap-dn: + type: string + description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) + (DN) of the LDAP entry to map to a team. + examples: + - cn=Enterprise Ops,ou=teams,dc=github,dc=com team-full: title: Full Team description: Groups of organization members that gives permissions on specified @@ -80377,10 +88719,23 @@ components: organization: "$ref": "#/components/schemas/team-organization" ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment + "$ref": "#/components/schemas/ldap-dn" + type: + description: The ownership type of the team type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs examples: - - uid=example,ou=users,dc=github,dc=com + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + examples: + - 42 required: - id - node_id @@ -80392,243 +88747,12 @@ components: - html_url - repositories_url - slug + - type - created_at - updated_at - members_count - repos_count - organization - team-discussion: - title: Team Discussion - description: A team discussion is a persistent record of a free-form conversation - within a team. - type: object - properties: - author: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - description: The main text of the discussion. - type: string - examples: - - Please suggest improvements to our workflow in comments. - body_html: - type: string - examples: - - "

Hi! This is an area for us to collaborate as a team

" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - comments_count: - type: integer - examples: - - 0 - comments_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1/comments - created_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - examples: - - MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - type: integer - examples: - - 42 - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - type: boolean - examples: - - true - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - type: boolean - examples: - - true - team_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - type: string - examples: - - How can we improve our workflow? - updated_at: - type: string - format: date-time - examples: - - '2018-01-25T18:56:31Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - author - - body - - body_html - - body_version - - comments_count - - comments_url - - created_at - - last_edited_at - - html_url - - pinned - - private - - node_id - - number - - team_url - - title - - updated_at - - url - team-discussion-comment: - title: Team Discussion Comment - description: A reply to a discussion within a team. - type: object - properties: - author: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - body: - description: The main text of the comment. - type: string - examples: - - I agree with this suggestion. - body_html: - type: string - examples: - - "

Do you like apples?

" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - type: string - examples: - - 0307116bbf7ced493b8d8a346c650b71 - created_at: - type: string - format: date-time - examples: - - '2018-01-15T23:53:58Z' - last_edited_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2403582/discussions/1 - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: - type: string - examples: - - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: - description: The unique sequence number of a team discussion comment. - type: integer - examples: - - 42 - updated_at: - type: string - format: date-time - examples: - - '2018-01-15T23:53:58Z' - url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - author - - body - - body_html - - body_version - - created_at - - last_edited_at - - discussion_url - - html_url - - node_id - - number - - updated_at - - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDg6UmVhY3Rpb24x - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - content: - description: The reaction to use - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - examples: - - heart - created_at: - type: string - format: date-time - examples: - - '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -80656,75 +88780,6 @@ components: - role - state - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: - - string - - 'null' - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions team-repository: title: Team Repository description: A team's access to a repository. @@ -81215,147 +89270,6 @@ components: - watchers_count - created_at - updated_at - project-card: - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - type: integer - format: int64 - examples: - - 42 - node_id: - type: string - examples: - - MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: - - string - - 'null' - examples: - - Add payload for delete Project column - creator: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - examples: - - '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - examples: - - '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - type: boolean - examples: - - false - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - examples: - - https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - examples: - - https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - examples: - - https://api.github.com/projects/120 - cards_url: - type: string - format: uri - examples: - - https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - type: integer - examples: - - 42 - node_id: - type: string - examples: - - MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - type: string - examples: - - Remaining tasks - created_at: - type: string - format: date-time - examples: - - '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - examples: - - '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -81401,6 +89315,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -81460,6 +89376,15 @@ components: - string - 'null' format: date-time + digest: + type: + - string + - 'null' + description: The SHA256 digest of the artifact. This field will only be + populated on artifacts uploaded with upload-artifact v4 or newer. For + older versions, this field will be null. + examples: + - sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: type: - object @@ -81496,6 +89421,26 @@ components: - created_at - expires_at - updated_at + actions-cache-retention-limit-for-repository: + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this repository. + type: integer + examples: + - 14 + actions-cache-storage-limit-for-repository: + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, in gigabytes. + type: integer + examples: + - 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -81859,6 +89804,8 @@ components: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled actions-workflow-access-to-repository: @@ -81891,73 +89838,6 @@ components: required: - path - sha - pull-request-minimal: - title: Pull Request Minimal - type: object - properties: - id: - type: integer - format: int64 - number: - type: integer - url: - type: string - head: - type: object - properties: - ref: - type: string - sha: - type: string - repo: - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - name: - type: string - required: - - id - - url - - name - required: - - ref - - sha - - repo - base: - type: object - properties: - ref: - type: string - sha: - type: string - repo: - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - name: - type: string - required: - - id - - url - - name - required: - - ref - - sha - - repo - required: - - id - - number - - url - - head - - base simple-commit: title: Simple Commit description: A commit. @@ -82670,6 +90550,29 @@ components: - badge_url - created_at - updated_at + workflow-run-id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + workflow-dispatch-response: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + "$ref": "#/components/schemas/workflow-run-id" + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url workflow-usage: title: Workflow Usage description: Workflow Usage @@ -82780,6 +90683,11 @@ components: type: boolean examples: - true + updated_at: + type: + - string + - 'null' + format: date-time required: - id - key_prefix @@ -83002,38 +90910,7 @@ components: teams: type: array items: - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - html_url: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - members_url: - type: string - repositories_url: - type: string - parent: - type: - - string - - 'null' + "$ref": "#/components/schemas/team" apps: type: array items: @@ -83283,6 +91160,7 @@ components: - '"chris@ozmm.org"' date: type: string + format: date-time examples: - '"2007-10-29T02:42:39.000-07:00"' verification: @@ -83310,13 +91188,16 @@ components: - reason - payload - signature + - verified_at diff-entry: title: Diff Entry description: Diff Entry type: object properties: sha: - type: string + type: + - string + - 'null' examples: - bbcd538c8e72b8c175046e27cc8f907076331401 filename: @@ -84264,6 +92145,14 @@ components: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" + dismissal_approved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -84369,6 +92258,14 @@ components: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" + dismissal_approved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -84389,6 +92286,15 @@ components: enum: - open - dismissed + code-scanning-alert-create-request: + type: boolean + description: If `true`, attempt to create an alert dismissal request. + code-scanning-alert-assignees: + description: The list of users to assign to the code scanning alert. An empty + array unassigns all previous assignees from the alert. + type: array + items: + type: string code-scanning-autofix-status: type: string description: The status of an autofix. @@ -84445,6 +92351,46 @@ components: sha: type: string description: SHA of commit with autofix. + code-scanning-alert-instance-state: + type: + - string + - 'null' + description: State of a code scanning alert instance. + enum: + - open + - fixed + - + code-scanning-alert-instance-list: + type: object + properties: + ref: + "$ref": "#/components/schemas/code-scanning-ref" + analysis_key: + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + environment: + "$ref": "#/components/schemas/code-scanning-alert-environment" + category: + "$ref": "#/components/schemas/code-scanning-analysis-category" + state: + "$ref": "#/components/schemas/code-scanning-alert-instance-state" + commit_sha: + type: string + message: + type: object + properties: + text: + type: string + location: + "$ref": "#/components/schemas/code-scanning-alert-location" + html_url: + type: string + classifications: + type: array + description: |- + Classifications that have been applied to the file that triggered the alert. + For example identifying it as documentation, or a generated file. + items: + "$ref": "#/components/schemas/code-scanning-alert-classification" code-scanning-analysis-sarif-id: type: string description: An identifier for the upload. @@ -84607,6 +92553,7 @@ components: type: string description: The language targeted by the CodeQL query enum: + - actions - cpp - csharp - go @@ -84614,6 +92561,7 @@ components: - javascript - python - ruby + - rust - swift code-scanning-variant-analysis-repository: title: Repository Identifier @@ -84888,6 +92836,15 @@ components: enum: - default - extended + threat_model: + description: Threat model to be used for code scanning analysis. Use `remote` + to analyze only network sources and `remote_and_local` to include local + sources like filesystem access, command-line arguments, database reads, + environment variable and standard input. + type: string + enum: + - remote + - remote_and_local updated_at: description: Timestamp of latest configuration update. type: @@ -84933,6 +92890,15 @@ components: enum: - default - extended + threat_model: + description: Threat model to be used for code scanning analysis. Use `remote` + to analyze only network sources and `remote_and_local` to include local + sources like filesystem access, command-line arguments, database reads, + environment variable and standard input. + type: string + enum: + - remote + - remote_and_local languages: description: CodeQL languages to be analyzed. type: array @@ -85406,355 +93372,72 @@ components: - author_association - created_at - updated_at - branch-short: - title: Branch Short - description: Branch Short - type: object - properties: - name: - type: string - commit: - type: object - properties: - sha: - type: string - url: - type: string - required: - - sha - - url - protected: - type: boolean - required: - - name - - commit - - protected - link: - title: Link - description: Hypermedia Link - type: object - properties: - href: - type: string - required: - - href - auto-merge: - title: Auto merge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - enabled_by: - "$ref": "#/components/schemas/simple-user" - merge_method: - type: string - description: The merge method to use. - enum: - - merge - - squash - - rebase - commit_title: - type: string - description: Title for the merge commit message. - commit_message: - type: string - description: Commit message for the merge commit. - required: - - enabled_by - - merge_method - - commit_title - - commit_message - pull-request-simple: - title: Pull Request Simple - description: Pull Request Simple + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. type: object properties: - url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer - format: int64 examples: - 1 node_id: type: string examples: - - MDExOlB1bGxSZXF1ZXN0MQ== - html_url: - type: string - format: uri - examples: - - https://github.com/octocat/Hello-World/pull/1347 - diff_url: - type: string - format: uri - examples: - - https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: - type: string - format: uri - examples: - - https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: - type: string - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: - type: integer - examples: - - 1347 - state: - type: string - examples: - - open - locked: - type: boolean - examples: - - true - title: - type: string - examples: - - new-feature + - MDg6UmVhY3Rpb24x user: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" - body: - type: - - string - - 'null' - examples: - - Please pull these awesome changes - labels: - type: array - items: - type: object - properties: - id: - type: integer - format: int64 - node_id: - type: string - url: - type: string - name: - type: string - description: - type: string - color: - type: string - default: - type: boolean - required: - - id - - node_id - - url - - name - - description - - color - - default - milestone: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/milestone" - active_lock_reason: - type: - - string - - 'null' + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes examples: - - too heated + - heart created_at: type: string format: date-time examples: - - '2011-01-26T19:01:12Z' - updated_at: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + branch-short: + title: Branch Short + description: Branch Short + type: object + properties: + name: type: string - format: date-time - examples: - - '2011-01-26T19:01:12Z' - closed_at: - type: - - string - - 'null' - format: date-time - examples: - - '2011-01-26T19:01:12Z' - merged_at: - type: - - string - - 'null' - format: date-time - examples: - - '2011-01-26T19:01:12Z' - merge_commit_sha: - type: - - string - - 'null' - examples: - - e5bd3914e2e596debea16f433f57875b5b90bcd6 - assignee: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - assignees: - type: - - array - - 'null' - items: - "$ref": "#/components/schemas/simple-user" - requested_reviewers: - type: - - array - - 'null' - items: - "$ref": "#/components/schemas/simple-user" - requested_teams: - type: - - array - - 'null' - items: - "$ref": "#/components/schemas/team" - head: + commit: type: object properties: - label: - type: string - ref: - type: string - repo: - "$ref": "#/components/schemas/repository" sha: type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - label - - ref - - repo - - sha - - user - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - "$ref": "#/components/schemas/repository" - sha: + url: type: string - user: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" required: - - label - - ref - - repo - sha - - user - _links: - type: object - properties: - comments: - "$ref": "#/components/schemas/link" - commits: - "$ref": "#/components/schemas/link" - statuses: - "$ref": "#/components/schemas/link" - html: - "$ref": "#/components/schemas/link" - issue: - "$ref": "#/components/schemas/link" - review_comments: - "$ref": "#/components/schemas/link" - review_comment: - "$ref": "#/components/schemas/link" - self: - "$ref": "#/components/schemas/link" - required: - - comments - - commits - - statuses - - html - - issue - - review_comments - - review_comment - - self - author_association: - "$ref": "#/components/schemas/author-association" - auto_merge: - "$ref": "#/components/schemas/auto-merge" - draft: - description: Indicates whether or not the pull request is a draft. + - url + protected: type: boolean - examples: - - false required: - - _links - - assignee - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merge_commit_sha - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge + - name + - commit + - protected simple-commit-status: title: Simple Commit Status type: object @@ -86148,6 +93831,8 @@ components: - size - type - url + encoding: + type: string _links: type: object properties: @@ -86707,6 +94392,21 @@ components: - development - runtime - + relationship: + type: + - string + - 'null' + description: | + The vulnerable dependency's relationship to your project. + + > [!NOTE] + > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + readOnly: true + enum: + - unknown + - direct + - transitive + - security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -86747,6 +94447,14 @@ components: "$ref": "#/components/schemas/alert-fixed-at" auto_dismissed_at: "$ref": "#/components/schemas/alert-auto-dismissed-at" + dismissal_request: + "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + "$ref": "#/components/schemas/simple-user" required: - number - state @@ -87807,6 +95515,7 @@ components: - reason - signature - payload + - verified_at html_url: type: string format: uri @@ -87940,6 +95649,11 @@ components: type: array items: type: object + required: + - path + - mode + - type + - sha properties: path: type: string @@ -87972,29 +95686,8 @@ components: size: 30 sha: 44b4fc6d56897b048c772eb4087f854f46256132 url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 - properties: - path: - type: string - mode: - type: string - type: - type: string - size: - type: integer - sha: - type: string - url: - type: string - required: - - path - - mode - - type - - sha - - url - - size required: - sha - - url - tree - truncated hook-response: @@ -88095,6 +95788,24 @@ components: - updated_at - last_response - test_url + check-immutable-releases: + title: Check immutable releases + description: Check immutable releases + type: object + properties: + enabled: + type: boolean + description: Whether immutable releases are enabled for the repository. + examples: + - true + enforced_by_owner: + type: boolean + description: Whether immutable releases are enforced by the repository owner. + examples: + - false + required: + - enabled + - enforced_by_owner import: title: Import description: A repository import from an external source. @@ -89217,59 +96928,6 @@ components: - "$ref": "#/components/schemas/moved-column-in-project-issue-event" - "$ref": "#/components/schemas/removed-from-project-issue-event" - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" - label: - title: Label - description: Color-coded labels help you categorize and filter your issues (just - like labels in Gmail). - type: object - properties: - id: - description: Unique identifier for the label. - type: integer - format: int64 - examples: - - 208045946 - node_id: - type: string - examples: - - MDU6TGFiZWwyMDgwNDU5NDY= - url: - description: URL for the label - type: string - format: uri - examples: - - https://api.github.com/repositories/42/labels/bug - name: - description: The name of the label. - type: string - examples: - - bug - description: - description: Optional description of the label, such as its purpose. - type: - - string - - 'null' - examples: - - Something isn't working - color: - description: '6-character hex code, without the leading #, identifying the - color' - type: string - examples: - - FFFFFF - default: - description: Whether this label comes by default in a new repository. - type: boolean - examples: - - true - required: - - id - - node_id - - url - - name - - description - - color - - default timeline-comment-event: title: Timeline Comment Event description: Timeline Comment Event @@ -89327,6 +96985,10 @@ components: - "$ref": "#/components/schemas/integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - event - actor @@ -89494,6 +97156,7 @@ components: - reason - signature - payload + - verified_at html_url: type: string format: uri @@ -89570,6 +97233,11 @@ components: submitted_at: type: string format: date-time + updated_at: + type: + - string + - 'null' + format: date-time commit_id: description: A commit SHA for the review. type: string @@ -89661,7 +97329,9 @@ components: examples: - 8 user: - "$ref": "#/components/schemas/simple-user" + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" body: description: The text of the comment. type: string @@ -90015,6 +97685,7 @@ components: type: - string - 'null' + format: date-time enabled: type: boolean required: @@ -91197,6 +98868,13 @@ components: - 'null' examples: - 2 + subject_type: + description: The level at which the comment is targeted, can be a diff line + or a file. + type: string + enum: + - line + - file required: - id - node_id @@ -91216,170 +98894,6 @@ components: - author_association - created_at - updated_at - release-asset: - title: Release Asset - description: Data related to a release. - type: object - properties: - url: - type: string - format: uri - browser_download_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - name: - description: The file name of the asset. - type: string - examples: - - Team Environment - label: - type: - - string - - 'null' - state: - description: State of the release asset. - type: string - enum: - - uploaded - - open - content_type: - type: string - size: - type: integer - download_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - uploader: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - id - - name - - content_type - - size - - state - - url - - node_id - - download_count - - label - - uploader - - browser_download_url - - created_at - - updated_at - release: - title: Release - description: A release. - type: object - properties: - url: - type: string - format: uri - html_url: - type: string - format: uri - assets_url: - type: string - format: uri - upload_url: - type: string - tarball_url: - type: - - string - - 'null' - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - id: - type: integer - node_id: - type: string - tag_name: - description: The name of the tag. - type: string - examples: - - v1.0.0 - target_commitish: - description: Specifies the commitish value that determines where the Git - tag is created from. - type: string - examples: - - master - name: - type: - - string - - 'null' - body: - type: - - string - - 'null' - draft: - description: true to create a draft (unpublished) release, false to create - a published one. - type: boolean - examples: - - false - prerelease: - description: Whether to identify the release as a prerelease or a full release. - type: boolean - examples: - - false - created_at: - type: string - format: date-time - published_at: - type: - - string - - 'null' - format: date-time - author: - "$ref": "#/components/schemas/simple-user" - assets: - type: array - items: - "$ref": "#/components/schemas/release-asset" - body_html: - type: string - body_text: - type: string - mentions_count: - type: integer - discussion_url: - description: The URL of the release discussion. - type: string - format: uri - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - assets_url - - upload_url - - tarball_url - - zipball_url - - created_at - - published_at - - draft - - id - - node_id - - author - - html_url - - name - - prerelease - - tag_name - - target_commitish - - assets - - url release-notes-content: title: Generated Release Notes Content description: Generated name and body describing a release @@ -91464,12 +98978,27 @@ components: - allOf: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object properties: @@ -91573,269 +99102,36 @@ components: - 'null' description: Whether the detected secret was found in multiple repositories under the same organization or enterprise. + is_base64_encoded: + type: + - boolean + - 'null' + description: A boolean value representing whether or not alert is base64 + encoded + first_location_detected: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" 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`. + description: An optional comment when closing or reopening an alert. Cannot + be updated or deleted. + type: + - string + - 'null' + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. type: - string - 'null' - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - examples: - - "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - examples: - - "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - examples: - - af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - examples: - - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - examples: - - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - examples: - - https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - examples: - - https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - examples: - - https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - examples: - - https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - examples: - - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url secret-scanning-location: type: object properties: @@ -92446,33 +99742,6 @@ components: - commit - zipball_url - tarball_url - tag-protection: - title: Tag protection - description: Tag protection - type: object - properties: - id: - type: integer - examples: - - 2 - created_at: - type: string - examples: - - '2011-01-26T19:01:12Z' - updated_at: - type: string - examples: - - '2011-01-26T19:01:12Z' - enabled: - type: boolean - examples: - - true - pattern: - type: string - examples: - - v1.* - required: - - pattern topic: title: Topic description: A topic aggregates entities that are related to a subject. @@ -92839,19 +100108,13 @@ components: - string - 'null' sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: type: string state_reason: @@ -92931,10 +100194,16 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" performed_via_github_app: anyOf: - type: 'null' - "$ref": "#/components/schemas/integration" + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" reactions: "$ref": "#/components/schemas/reaction-rollup" required: @@ -93181,6 +100450,15 @@ components: type: boolean has_discussions: type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: type: boolean disabled: @@ -94331,6 +101609,11 @@ components: type: boolean read_only: type: boolean + last_used: + type: + - string + - 'null' + format: date-time required: - key - id @@ -94468,78 +101751,6 @@ components: required: - starred_at - repo - sigstore-bundle-0: - title: Sigstore Bundle v0.1 - description: Sigstore Bundle v0.1 - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: - x509CertificateChain: - type: object - properties: - certificates: - type: array - items: - type: object - properties: - rawBytes: - type: string - tlogEntries: - type: array - items: - type: object - properties: - logIndex: - type: string - logId: - type: object - properties: - keyId: - type: string - kindVersion: - type: object - properties: - kind: - type: string - version: - type: string - integratedTime: - type: string - inclusionPromise: - type: object - properties: - signedEntryTimestamp: - type: string - inclusionProof: - type: - - string - - 'null' - canonicalizedBody: - type: string - timestampVerificationData: - type: - - string - - 'null' - dsseEnvelope: - type: object - properties: - payload: - type: string - payloadType: - type: string - signatures: - type: array - items: - type: object - properties: - sig: - type: string - keyid: - type: string hovercard: title: Hovercard description: Hovercard @@ -94568,9 +101779,224 @@ components: type: integer key: type: string + created_at: + type: string + format: date-time + last_used: + type: + - string + - 'null' + format: date-time required: - key - id + billing-premium-request-usage-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems + billing-usage-report-user: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + billing-usage-summary-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems enterprise-webhooks: title: Enterprise description: |- @@ -95079,6 +102505,19 @@ components: type: boolean examples: - true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + examples: + - true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: description: Whether the repository is archived. default: false @@ -95796,9 +103235,7 @@ components: type: object properties: app: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: @@ -96405,20 +103842,81 @@ components: - created_at - updated_at - body - discussion: - title: Discussion - description: A Discussion in a repository. + webhooks_comment: type: object properties: - active_lock_reason: - type: - - string - - 'null' - answer_chosen_at: + 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: - - string + - integer - 'null' - answer_chosen_by: + 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 @@ -96452,6 +103950,7 @@ components: format: uri id: type: integer + format: int64 login: type: string name: @@ -96489,10 +103988,116 @@ components: required: - login - id - answer_html_url: + required: + - id + - node_id + - html_url + - parent_id + - child_comment_count + - repository_url + - discussion_id + - author_association + - user + - created_at + - updated_at + - body + - reactions + webhooks_label: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + default: + type: boolean + description: type: - string - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + webhooks_repositories: + description: An array of repository objects that the installation can access. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + webhooks_repositories_added: + description: An array of repository objects, which were added to the installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + webhooks_repository_selection: + description: Describe whether all repositories have been selected or there's + a selection involved + type: string + enum: + - all + - selected + webhooks_issue_comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -96507,56 +104112,25 @@ components: - NONE - OWNER body: + description: Contents of the issue comment type: string - category: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer created_at: type: string format: date-time html_url: type: string + format: uri id: + description: Unique identifier of the issue comment type: integer - locked: - type: boolean + format: int64 + issue_url: + type: string + format: uri node_id: type: string - number: - type: integer + performed_via_github_app: + "$ref": "#/components/schemas/integration" reactions: title: Reactions type: object @@ -96593,469 +104167,13 @@ components: - hooray - eyes - rocket - repository_url: - type: string - state: - type: string - description: |- - The current state of the discussion. - `converting` means that the discussion is being converted from an issue. - `transferring` means that the discussion is being transferred from another repository. - enum: - - open - - closed - - locked - - converting - - transferring - state_reason: - description: The reason for the current state - type: - - string - - 'null' - enum: - - resolved - - outdated - - duplicate - - reopened - - - examples: - - resolved - timeline_url: - type: string - title: - type: string updated_at: type: string format: date-time - user: - 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 - 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 - 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 - - 'null' - 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 - - '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 - 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 - required: - - login - - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - - reactions - webhooks_label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying the - color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - webhooks_repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - webhooks_repositories_added: - description: An array of repository objects, which were added to the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - webhooks_repository_selection: - description: Describe whether all repositories have been selected or there's - a selection involved - type: string - enum: - - all - - selected - webhooks_issue_comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - 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: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - "$ref": "#/components/schemas/integration" - 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 - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri + url: + description: URL for the issue comment + type: string + format: uri user: title: User type: @@ -97129,6 +104247,10 @@ components: required: - login - id + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" required: - url - html_url @@ -97873,11 +104995,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -97965,20 +105082,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -97995,6 +105110,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -98953,11 +106070,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -99045,20 +106157,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -99075,6 +106185,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -99496,6 +106608,24 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team + belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team + belongs + examples: + - 42 required: - name - id @@ -99509,6 +106639,7 @@ components: - members_url - repositories_url - permission + - type permission: description: Permission that the team will have for its repositories type: string @@ -99532,6 +106663,22 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + examples: + - 42 required: - name - id @@ -99714,6 +106861,22 @@ components: format: uri role: type: string + direct_membership: + type: boolean + description: Whether the user has direct membership in the organization. + examples: + - true + enterprise_teams_providing_indirect_membership: + type: array + description: |- + The slugs of the enterprise teams providing the user with indirect membership in the organization. + A limit of 100 enterprise team slugs is returned. + maxItems: 100 + items: + type: string + examples: + - ent:team-one + - ent:team-two state: type: string url: @@ -100233,76 +107396,6 @@ components: - name - created_at - updated_at - projects-v2: - title: Projects v2 Project - description: A projects v2 project - type: object - properties: - id: - type: number - node_id: - type: string - owner: - "$ref": "#/components/schemas/simple-user" - creator: - "$ref": "#/components/schemas/simple-user" - title: - type: string - description: - type: - - string - - 'null' - public: - type: boolean - closed_at: - type: - - string - - 'null' - format: date-time - examples: - - '2022-04-28T12:00:00Z' - created_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - number: - type: integer - short_description: - type: - - string - - 'null' - deleted_at: - type: - - string - - 'null' - format: date-time - examples: - - '2022-04-28T12:00:00Z' - deleted_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - required: - - id - - node_id - - owner - - creator - - title - - description - - public - - closed_at - - created_at - - updated_at - - number - - short_description - - deleted_at - - deleted_by webhooks_project_changes: type: object properties: @@ -100319,14 +107412,6 @@ components: - string - 'null' format: date-time - projects-v2-item-content-type: - title: Projects v2 Item Content Type - description: The type of content tracked in a project item - type: string - enum: - - Issue - - PullRequest - - DraftIssue projects-v2-item: title: Projects v2 Item description: An item belonging to a project @@ -100334,12 +107419,16 @@ components: properties: id: type: number + description: The unique identifier of the project item. node_id: type: string + description: The node ID of the project item. project_node_id: type: string + description: The node ID of the project that contains this item. content_node_id: type: string + description: The node ID of the content represented by this item. content_type: "$ref": "#/components/schemas/projects-v2-item-content-type" creator: @@ -100347,11 +107436,13 @@ components: created_at: type: string format: date-time + description: The time when the item was created. examples: - '2022-04-28T12:00:00Z' updated_at: type: string format: date-time + description: The time when the item was last updated. examples: - '2022-04-28T12:00:00Z' archived_at: @@ -100359,6 +107450,7 @@ components: - string - 'null' format: date-time + description: The time when the item was archived. examples: - '2022-04-28T12:00:00Z' required: @@ -100375,16 +107467,20 @@ components: properties: id: type: string + description: The unique identifier of the option. name: type: string + description: The display name of the option. color: type: - string - 'null' + description: The color associated with the option. description: type: - string - 'null' + description: A short description of the option. required: - id - name @@ -100395,75 +107491,29 @@ components: properties: id: type: string + description: The unique identifier of the iteration setting. title: type: string + description: The iteration title. + title_html: + type: string + description: The iteration title, rendered as HTML. duration: type: - number - 'null' + description: The duration of the iteration in days. start_date: type: - string - 'null' + description: The start date of the iteration. + completed: + type: boolean + description: Whether the iteration has been completed. required: - id - title - projects-v2-status-update: - title: Projects v2 Status Update - description: An status update belonging to a project - type: object - properties: - id: - type: number - node_id: - type: string - project_node_id: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - status: - type: - - string - - 'null' - enum: - - INACTIVE - - ON_TRACK - - AT_RISK - - OFF_TRACK - - COMPLETE - - - start_date: - type: string - format: date - examples: - - '2022-04-28' - target_date: - type: string - format: date - examples: - - '2022-04-28' - body: - description: Body of the status update - type: - - string - - 'null' - examples: - - The project is off to a great start! - required: - - id - - node_id - - created_at - - updated_at webhooks_number: description: The pull request number. type: integer @@ -101030,6 +108080,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -101669,6 +108730,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -103194,6 +110266,11 @@ components: - string - 'null' format: date-time + updated_at: + type: + - string + - 'null' + format: date-time user: title: User type: @@ -103318,6 +110395,10 @@ components: type: string size: type: integer + digest: + type: + - string + - 'null' state: description: State of the release asset. type: string @@ -103406,6 +110487,7 @@ components: - name - label - state + - digest - content_type - size - download_count @@ -103494,6 +110576,11 @@ components: - string - 'null' format: date-time + updated_at: + type: + - string + - 'null' + format: date-time discussion_url: type: string format: uri @@ -103505,6 +110592,9 @@ components: format: uri id: type: integer + immutable: + description: Whether or not the release is immutable. + type: boolean name: type: - string @@ -103592,10 +110682,12 @@ components: - draft - author - prerelease + - immutable - created_at - published_at - assets - tarball_url + - updated_at - zipball_url - body webhooks_release_1: @@ -103615,10 +110707,12 @@ components: - name - node_id - prerelease + - immutable - published_at - tag_name - tarball_url - target_commitish + - updated_at - upload_url - url - zipball_url @@ -103641,6 +110735,7 @@ components: - state - content_type - size + - digest - download_count - created_at - updated_at @@ -103668,6 +110763,10 @@ components: type: string size: type: integer + digest: + type: + - string + - 'null' state: description: State of the release asset. type: string @@ -103842,6 +110941,9 @@ components: format: uri id: type: integer + immutable: + description: Whether or not the release is immutable. + type: boolean name: type: - string @@ -103905,6 +111007,11 @@ components: description: Specifies the commitish value that determines where the Git tag is created from. type: string + updated_at: + type: + - string + - 'null' + format: date-time upload_url: type: string format: uri-template @@ -104039,6 +111146,7 @@ components: state: type: string enum: + - auto_dismissed - open secret-scanning-alert-resolution-webhook: type: @@ -104151,6 +111259,10 @@ components: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. + assigned_to: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -104621,6 +111733,24 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team + belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team + belongs + examples: + - 42 required: - name - id @@ -104634,6 +111764,7 @@ components: - members_url - repositories_url - permission + - type permission: description: Permission that the team will have for its repositories type: string @@ -104659,6 +111790,22 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + examples: + - 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + examples: + - 42 required: - name - id @@ -104904,6 +112051,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104937,6 +112086,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104970,6 +112121,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -105012,6 +112165,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -105384,11 +112539,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -105852,6 +113002,16 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write + attestations: + type: string + enum: + - read + - write checks: type: string enum: @@ -105867,6 +113027,10 @@ components: enum: - read - write + copilot_requests: + type: string + enum: + - write deployments: type: string enum: @@ -105902,11 +113066,21 @@ components: enum: - read - write + merge_queues: + type: string + enum: + - read + - write metadata: type: string enum: - read - write + models: + type: string + enum: + - read + - write organization_administration: type: string enum: @@ -106004,11 +113178,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -106465,6 +113634,16 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write + attestations: + type: string + enum: + - read + - write checks: type: string enum: @@ -106480,6 +113659,10 @@ components: enum: - read - write + copilot_requests: + type: string + enum: + - write deployments: type: string enum: @@ -106515,11 +113698,21 @@ components: enum: - read - write + merge_queues: + type: string + enum: + - read + - write metadata: type: string enum: - read - write + models: + type: string + enum: + - read + - write organization_administration: type: string enum: @@ -106617,11 +113810,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -106894,6 +114082,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107161,6 +114353,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107400,231 +114596,309 @@ components: url: type: string format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - "$ref": "#/components/schemas/webhooks_code_scanning_ref" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-created: - title: code_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: - - string - - 'null' - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: - - 'null' - dismissed_by: - type: - - 'null' - dismissed_comment: - "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - type: - - 'null' - fixed_at: - description: 'The time that the alert was fixed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: - - 'null' - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - instances_url: - type: string - most_recent_instance: - title: Alert Instance + dismissal_approved_by: + title: User type: - object - 'null' properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the analysis - was executed. + avatar_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + followers_url: type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + format: uri + following_url: type: string - state: - description: State of a code scanning alert. + format: uri-template + gists_url: type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + format: uri-template + gravatar_id: type: string - full_description: + html_url: type: string - help: - type: - - string - - 'null' - help_uri: - description: A link to the documentation for the rule used to detect - the alert. - type: - - string - - 'null' + format: uri id: - description: A unique identifier for the rule used to detect the - alert. + type: integer + login: type: string name: type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' + 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: - - none - - note - - warning - - error - - - tags: - type: - - array - - 'null' - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. Events for alerts found - outside the default branch will return a `null` value until they are - dismissed or fixed. - type: - - string - - 'null' - enum: - - open - - dismissed - - - tool: - type: - - object - - 'null' - properties: - guid: - type: - - string - - 'null' - name: - description: The name of the tool used to generate the code scanning - analysis alert. + - Bot + - User + - Organization + url: + type: string + format: uri + user_view_type: type: string - version: - description: The version of the tool used to detect the alert. - type: - - string - - 'null' required: - - name - - version - updated_at: - type: - - string - - 'null' - url: - type: string - format: uri + - login + - id + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-code-scanning-alert-created: + title: code_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: + - string + - 'null' + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: + - 'null' + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + instances_url: + type: string + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: + type: + - string + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + type: + - string + - 'null' + enum: + - open + - dismissed + - + tool: + type: + - object + - 'null' + properties: + guid: + type: + - string + - 'null' + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version + updated_at: + type: + - string + - 'null' + url: + type: string + format: uri + dismissal_approved_by: + type: + - 'null' + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -107669,6 +114943,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107959,10 +115237,12 @@ components: - reopened alert: description: The code scanning alert involved in the event. - type: - - object - - 'null' + type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107995,6 +115275,8 @@ components: description: The GitHub URL of the alert resource. type: string format: uri + instances_url: + type: string most_recent_instance: title: Alert Instance type: @@ -108135,9 +115417,16 @@ components: required: - name - version + updated_at: + type: + - string + - 'null' url: type: string format: uri + dismissal_approved_by: + type: + - 'null' required: - number - created_at @@ -108192,6 +115481,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -108371,108 +115664,373 @@ components: - commit_oid - repository - sender - webhook-commit-comment-created: - title: commit_comment created event + webhook-code-scanning-alert-updated-assignment: + title: code_scanning_alert updated_assignment event type: object properties: action: - description: The action performed. Can be `created`. type: string enum: - - created - comment: - description: The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) - resource. + - updated_assignment + alert: + description: The code scanning alert involved in the event. 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: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - html_url: - type: string - format: uri - id: - description: The ID of the commit comment. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the commit comment. - type: string - path: - description: The relative path of the file to which the comment applies. + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: - string - 'null' - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - 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 - updated_at: - type: string - url: - type: string - format: uri - user: + format: date-time + dismissed_by: + 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 + required: + - login + - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + type: + - string + - 'null' + enum: + - open + - dismissed + - fixed + - + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + 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 + - sender + webhook-commit-comment-created: + title: commit_comment created event + type: object + properties: + action: + description: The action performed. Can be `created`. + type: string + enum: + - created + 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: + 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: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + html_url: + type: string + format: uri + id: + description: The ID of the commit comment. + type: integer + line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the commit comment. + type: string + path: + description: The relative path of the file to which the comment applies. + type: + - string + - 'null' + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + 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 + updated_at: + type: string + url: + type: string + format: uri + user: title: User type: - object @@ -108661,6 +116219,27 @@ components: required: - action - definition + webhook-custom-property-promoted-to-enterprise: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: + "$ref": "#/components/schemas/custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition webhook-custom-property-updated: title: custom property updated event type: object @@ -108746,6 +116325,31 @@ components: - pusher_type - repository - sender + webhook-dependabot-alert-assignees-changed: + title: Dependabot alert assignees changed event + type: object + properties: + action: + type: string + enum: + - assignees_changed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + - sender webhook-dependabot-alert-auto-dismissed: title: Dependabot alert auto-dismissed event type: object @@ -109401,11 +117005,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -110112,12 +117711,23 @@ components: event: description: The event that triggered the deployment protection rule. type: string + sha: + description: The commit SHA that triggered the workflow. Always populated + from the check suite, regardless of whether a deployment is created. + type: string + ref: + description: The ref (branch or tag) that triggered the workflow. Always + populated from the check suite, regardless of whether a deployment is + created. + type: string deployment_callback_url: description: The URL to review the deployment protection rule. type: string format: uri deployment: - "$ref": "#/components/schemas/deployment" + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/deployment" pull_requests: type: array items: @@ -112747,500 +120357,490 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - 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 - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They can be - installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within GitHub. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - 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 - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + 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 + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + 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 + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -115018,781 +122618,3189 @@ components: type: string git_tags_url: type: string - git_url: + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_pages: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + homepage: + type: + - string + - 'null' + hooks_url: + type: string + html_url: + type: string + id: + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + language: + type: + - 'null' + languages_url: + type: string + license: + type: + - object + - 'null' + merges_url: + type: string + milestones_url: + type: string + mirror_url: + type: + - 'null' + name: + type: string + node_id: + type: string + notifications_url: + type: string + open_issues: + type: integer + open_issues_count: + type: integer + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + public: + type: boolean + pulls_url: + type: string + pushed_at: + type: string + releases_url: + type: string + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + svn_url: + type: string + tags_url: + type: string + teams_url: + type: string + topics: + type: array + items: + type: + - 'null' + trees_url: + type: string + updated_at: + type: string + url: + type: string + visibility: + type: string + watchers: + type: integer + watchers_count: + type: integer + 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: + - forkee + - repository + - sender + webhook-github-app-authorization-revoked: + title: github_app_authorization revoked event + type: object + properties: + action: + type: string + enum: + - revoked + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - sender + webhook-gollum: + title: gollum event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pages: + description: The pages that were updated. + type: array + items: + type: object + properties: + action: + description: The action that was performed on the page. Can be `created` + or `edited`. + type: string + enum: + - created + - edited + html_url: + description: Points to the HTML wiki page. + type: string + format: uri + page_name: + description: The name of the page. + type: string + sha: + description: The latest commit SHA of the page. + type: string + summary: + type: + - string + - 'null' + title: + description: The current page title. + type: string + required: + - page_name + - title + - summary + - action + - sha + - html_url + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - pages + - repository + - sender + webhook-installation-created: + title: installation created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-deleted: + title: installation deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-new-permissions-accepted: + title: installation new_permissions_accepted event + type: object + properties: + action: + type: string + enum: + - new_permissions_accepted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-repositories-added: + title: installation_repositories added event + type: object + properties: + action: + type: string + enum: + - added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-repositories-removed: + title: installation_repositories removed event + type: object + properties: + action: + type: string + enum: + - removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-suspend: + title: installation suspend event + type: object + properties: + action: + type: string + enum: + - suspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-target-renamed: + type: object + properties: + account: + type: object + properties: + archived_at: + type: + - string + - 'null' + avatar_url: + type: string + created_at: + type: string + description: + type: + - 'null' + events_url: + type: string + followers: + type: integer + followers_url: + type: string + following: + type: integer + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + has_organization_projects: + type: boolean + has_repository_projects: + type: boolean + hooks_url: + type: string + html_url: + type: string + id: + type: integer + is_verified: + type: boolean + issues_url: + type: string + login: + type: string + members_url: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + public_gists: + type: integer + public_members_url: + type: string + public_repos: + type: integer + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + slug: + type: string + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + updated_at: + type: string + url: + type: string + website_url: + type: + - 'null' + user_view_type: + type: string + required: + - id + - node_id + - avatar_url + - html_url + action: + type: string + enum: + - renamed + changes: + type: object + properties: + login: + type: object + properties: + from: + type: string + required: + - from + slug: + type: object + properties: + from: + type: string + required: + - from + 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" + target_type: + type: string + required: + - action + - target_type + - account + - changes + - installation + webhook-installation-unsuspend: + title: installation unsuspend event + type: object + properties: + action: + type: string + enum: + - unsuspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-issue-comment-created: + title: issue_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + 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: + description: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + 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 + updated_at: + type: string + format: date-time + url: + description: URL for the issue comment + type: string + format: uri + pin: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/pinned-issue-comment" + user: + 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 + 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 + required: + - login + - id + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + 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 + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + 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 + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + 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 + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-deleted: + title: issue_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + 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 + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + 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 + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_pages: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - homepage: + enum: + - open + - closed + state_reason: type: - string - 'null' - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - issue_events_url: + timeline_url: type: string - issues_url: + format: uri + title: + description: Title of the issue type: string - keys_url: + type: + "$ref": "#/components/schemas/issue-type" + updated_at: type: string - labels_url: + format: date-time + url: + description: URL for the issue type: string - language: + format: uri + user: + title: User type: + - object - 'null' - languages_url: - type: string - license: + 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 + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: type: - - object + - string - 'null' - merges_url: - type: string - milestones_url: - type: string - mirror_url: + assignee: + title: User type: + - object - 'null' - name: - type: string - node_id: - type: string - notifications_url: - type: string - open_issues: - type: integer - open_issues_count: - type: integer - owner: - type: object 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 + - Mannequin url: type: string - private: - type: boolean - public: - type: boolean - pulls_url: - type: string - pushed_at: - type: string - releases_url: - type: string - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - svn_url: - type: string - tags_url: - type: string - teams_url: - type: string - topics: + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: type: array items: type: + - object - 'null' - trees_url: - type: string - updated_at: + author_association: type: string - url: + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: type: string - visibility: + created_at: type: string - watchers: - type: integer - watchers_count: - type: integer - 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: - - forkee - - repository - - sender - webhook-github-app-authorization-revoked: - title: github_app_authorization revoked event - type: object - properties: - action: - type: string - enum: - - revoked - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - sender - webhook-gollum: - title: gollum event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pages: - description: The pages that were updated. - type: array - items: - type: object - properties: - action: - description: The action that was performed on the page. Can be `created` - or `edited`. + events_url: type: string - enum: - - created - - edited html_url: - description: Points to the HTML wiki page. type: string - format: uri - page_name: - description: The name of the page. - type: string - sha: - description: The latest commit SHA of the page. + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: type: string - summary: + locked: + type: boolean + milestone: type: - - string + - object - 'null' - title: - description: The current page title. - type: string - required: - - page_name - - title - - summary - - action - - sha - - html_url - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - pages - - repository - - sender - webhook-installation-created: - title: installation created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - "$ref": "#/components/schemas/webhooks_user" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-installation-deleted: - title: installation deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-installation-new-permissions-accepted: - title: installation new_permissions_accepted event - type: object - properties: - action: - type: string - enum: - - new_permissions_accepted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-installation-repositories-added: - title: installation_repositories added event - type: object - properties: - action: - type: string - enum: - - added - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - "$ref": "#/components/schemas/webhooks_repositories_added" - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: + node_id: type: string - id: - description: Unique identifier of the repository + number: type: integer - name: - description: The name of the repository. + performed_via_github_app: + type: + - object + - 'null' + 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 + repository_url: type: string - node_id: + state: + description: State of the issue; either 'open' or 'closed' type: string - private: - description: Whether the repository is private or public. - type: boolean - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - "$ref": "#/components/schemas/webhooks_repository_selection" - requester: - "$ref": "#/components/schemas/webhooks_user" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-repositories-removed: - title: installation_repositories removed event - type: object - properties: - action: - type: string - enum: - - removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - "$ref": "#/components/schemas/webhooks_repositories_added" - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: + enum: + - open + - closed + timeline_url: type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. + title: type: string - node_id: + updated_at: type: string - private: - description: Whether the repository is private or public. - type: boolean + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - "$ref": "#/components/schemas/webhooks_repository_selection" - requester: - "$ref": "#/components/schemas/webhooks_user" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-suspend: - title: installation suspend event - type: object - properties: - action: - type: string - enum: - - suspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" + - labels + - state + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' sender: "$ref": "#/components/schemas/simple-user" required: - action - - installation + - issue + - comment + - repository - sender - webhook-installation-target-renamed: + webhook-issue-comment-edited: + title: issue_comment edited event type: object properties: - account: - type: object - properties: - archived_at: - type: - - string - - 'null' - avatar_url: - type: string - created_at: - type: string - description: - type: - - 'null' - events_url: - type: string - followers: - type: integer - followers_url: - type: string - following: - type: integer - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - has_organization_projects: - type: boolean - has_repository_projects: - type: boolean - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_verified: - type: boolean - issues_url: - type: string - login: - type: string - members_url: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - public_gists: - type: integer - public_members_url: - type: string - public_repos: - type: integer - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - slug: - type: string - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - updated_at: - type: string - url: - type: string - website_url: - type: - - 'null' - user_view_type: - type: string - required: - - id - - node_id - - avatar_url - - html_url action: type: string enum: - - renamed + - edited changes: - type: object - properties: - login: - type: object - properties: - from: - type: string - required: - - from - slug: - type: object - properties: - from: - type: string - required: - - from - 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" - target_type: - type: string - required: - - action - - target_type - - account - - changes - - installation - webhook-installation-unsuspend: - title: installation unsuspend event - type: object - properties: - action: - type: string - enum: - - unsuspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-issue-comment-created: - title: issue_comment created event - type: object - properties: - action: - type: string - enum: - - created + "$ref": "#/components/schemas/webhooks_changes" comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - 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: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/integration" - 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 - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - user: - 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 - 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 - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -116490,7 +126498,6 @@ components: enum: - read - write - - admin secret_scanning_alerts: type: string enum: @@ -116521,11 +126528,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -116614,19 +126616,9 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -116643,6 +126635,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -116994,18 +126988,19 @@ components: "$ref": "#/components/schemas/simple-user" required: - action + - changes - issue - comment - repository - sender - webhook-issue-comment-deleted: - title: issue_comment deleted event + webhook-issue-comment-pinned: + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted + - pinned comment: "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: @@ -117825,19 +127820,9 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -117854,6 +127839,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -118211,16 +128198,14 @@ components: - comment - repository - sender - webhook-issue-comment-edited: - title: issue_comment edited event + webhook-issue-comment-unpinned: + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: - "$ref": "#/components/schemas/webhooks_changes" + - unpinned comment: "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: @@ -118694,8 +128679,6 @@ components: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -118879,7 +128862,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -119027,389 +129009,383 @@ components: type: integer url: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + 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 + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: + - string + - 'null' + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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 repository_url: type: string - format: uri - sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed - state_reason: - type: - - string - - 'null' timeline_url: type: string - format: uri title: - description: Title of the issue type: string updated_at: type: string - format: date-time url: - description: URL for the issue type: string - format: uri user: - title: User - type: - - object - - 'null' + type: object 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 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 - - Mannequin url: type: string - format: uri user_view_type: type: string - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - assignee: - 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 - - Mannequin - url: - type: string - format: uri - user_view_type: - type: string - required: - - login - - id - assignees: - type: array - items: - type: - - object - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: - - object - - 'null' - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: - - object - - 'null' - 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 - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - format: int64 - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string required: - labels - state @@ -119423,11 +129399,142 @@ components: "$ref": "#/components/schemas/simple-user" required: - action - - changes - issue - comment - repository - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + 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 + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + 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 + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + 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 + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + 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 + - organization + - repository + - sender webhook-issues-assigned: title: issues assigned event type: object @@ -120193,11 +130300,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120285,20 +130387,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -120315,6 +130415,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -120738,6 +130840,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -121295,11 +131399,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -121387,20 +131486,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -121417,6 +131514,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -122288,11 +132387,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122370,20 +132464,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -122400,6 +132492,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -123243,11 +133337,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -123335,20 +133424,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -123362,6 +133449,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string @@ -124210,11 +134299,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124302,20 +134386,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -124329,6 +134411,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string @@ -125211,11 +135295,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125293,20 +135372,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -125320,6 +135397,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string @@ -126171,11 +136250,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -126253,20 +136327,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -126283,6 +136355,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -127103,11 +137177,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -127196,19 +137265,13 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -127232,6 +137295,10 @@ components: description: URL for the issue type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" user: title: User type: @@ -127304,28 +137371,11 @@ components: required: - login - id + type: + "$ref": "#/components/schemas/issue-type" required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - id - - node_id - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions old_repository: title: Repository description: A git repository @@ -127450,6 +137500,17 @@ components: has_discussions: description: Whether the repository has discussions enabled. type: boolean + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only has_downloads: description: Whether downloads are enabled. type: boolean @@ -128525,11 +138586,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128618,19 +138674,13 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128647,6 +138697,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -128654,6 +138706,10 @@ components: description: URL for the issue type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" user: title: User type: @@ -129546,11 +139602,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129628,20 +139679,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -129738,6 +139787,8 @@ components: format: uri user_view_type: type: string + type: + "$ref": "#/components/schemas/issue-type" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -130474,11 +140525,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130566,20 +140612,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -130596,6 +140640,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -130840,6 +140886,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -131195,6 +141252,34 @@ components: - issue - repository - sender + webhook-issues-typed: + title: issues typed event + type: object + properties: + action: + type: string + enum: + - typed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + type: + "$ref": "#/components/schemas/issue-type" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - type + - repository + - sender webhook-issues-unassigned: title: issues unassigned event type: object @@ -132012,11 +142097,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -132094,20 +142174,18 @@ components: repository_url: type: string format: uri + pinned_comment: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -132124,6 +142202,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -132239,6 +142319,34 @@ components: - issue - repository - sender + webhook-issues-untyped: + title: issues untyped event + type: object + properties: + action: + type: string + enum: + - untyped + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + type: + "$ref": "#/components/schemas/issue-type" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - type + - repository + - sender webhook-label-created: title: label created event type: object @@ -133134,7 +143242,7 @@ components: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" hook: - description: 'The modified webhook. This will contain different keys based + description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.' type: object @@ -133163,6 +143271,7 @@ components: created_at: type: string events: + description: '' type: array items: type: string @@ -136908,6 +147017,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -137552,6 +147672,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -139254,6 +149385,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only has_pages: type: boolean has_projects: @@ -139904,6 +150046,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -141617,6 +151770,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -142257,6 +152421,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -144052,6 +154227,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -144692,6 +154878,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -146479,6 +156676,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -147119,6 +157327,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -148824,6 +159043,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -149468,6 +159698,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -151181,6 +161422,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -151825,6 +162077,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -153936,6 +164199,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -154567,6 +164841,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -156176,6 +166461,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -156807,6 +167103,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -158410,6 +168717,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -159041,6 +169359,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -160643,6 +170972,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -161274,6 +171614,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -162434,6 +172785,11 @@ components: submitted_at: type: string format: date-time + updated_at: + type: + - string + - 'null' + format: date-time user: title: User type: @@ -165187,6 +175543,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -165818,6 +176185,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -167609,6 +177987,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -168249,6 +178638,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -170085,6 +180485,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -170725,6 +181136,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -172512,6 +182934,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -173152,6 +183585,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -174955,6 +185399,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -175588,6 +186043,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -177201,6 +187667,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -177784,6 +188261,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -179132,6 +189620,11 @@ components: required: - node_id - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - thread @@ -179646,6 +190139,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -180225,6 +190729,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -181559,6 +192074,11 @@ components: required: - node_id - comments + updated_at: + type: + - string + - 'null' + format: date-time required: - action - thread @@ -182085,6 +192605,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -182725,6 +193256,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -184435,6 +194977,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -185079,6 +195632,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -186794,6 +197358,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -187438,6 +198013,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -189138,6 +199724,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -189780,6 +200377,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -191355,6 +201963,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all + or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: - string @@ -192720,6 +203339,15 @@ components: type: string required: - from + tag_name: + type: object + properties: + from: + description: The previous version of the tag_name if the action + was `edited`. + type: string + required: + - from make_latest: type: object properties: @@ -192774,6 +203402,7 @@ components: - draft - html_url - id + - immutable - name - node_id - prerelease @@ -192781,6 +203410,7 @@ components: - tag_name - tarball_url - target_commitish + - updated_at - upload_url - url - zipball_url @@ -192801,6 +203431,7 @@ components: - name - label - state + - digest - content_type - size - download_count @@ -192830,6 +203461,10 @@ components: type: string size: type: integer + digest: + type: + - string + - 'null' state: description: State of the release asset. type: string @@ -193004,6 +203639,9 @@ components: format: uri id: type: integer + immutable: + description: Whether or not the release is immutable. + type: boolean name: type: - string @@ -193072,6 +203710,11 @@ components: upload_url: type: string format: uri-template + updated_at: + type: + - string + - 'null' + format: date-time url: type: string format: uri @@ -194180,6 +204823,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + 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-created: title: secret_scanning_alert created event type: object @@ -194311,6 +204980,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + 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-validated: title: secret_scanning_alert validated event type: object @@ -195076,6 +205771,7 @@ components: - reason - signature - payload + - verified_at required: - author - committer @@ -201704,63 +212400,787 @@ components: format: uri user_view_type: type: string - required: - - login - - id + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + format: uri + display_title: + type: string + required: + - artifacts_url + - cancel_url + - check_suite_url + - check_suite_id + - check_suite_node_id + - conclusion + - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha + - html_url + - id + - jobs_url + - logs_url + - node_id + - name + - path + - pull_requests + - repository + - rerun_url + - run_number + - status + - updated_at + - url + - workflow_id + - workflow_url + - run_attempt + - run_started_at + - previous_attempt_url + - actor + - triggering_actor + - display_title + required: + - action + - repository + - sender + - workflow + - workflow_run + create-event: + title: CreateEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + master_branch: + type: string + description: + type: + - string + - 'null' + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - master_branch + - pusher_type + delete-event: + title: DeleteEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - pusher_type + discussion-event: + title: DiscussionEvent + type: object + properties: + action: + type: string + discussion: + "$ref": "#/components/schemas/discussion" + required: + - action + - discussion + issues-event: + title: IssuesEvent + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + assignee: + "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + label: + "$ref": "#/components/schemas/label" + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - action + - issue + issue-comment-event: + title: IssueCommentEvent + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + required: + - action + - issue + - comment + fork-event: + title: ForkEvent + type: object + properties: + action: + type: string + forkee: + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + private: + type: boolean + owner: + "$ref": "#/components/schemas/simple-user" + html_url: + type: string + description: + type: + - string + - 'null' + fork: + type: boolean + url: + type: string + forks_url: + type: string + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + hooks_url: + type: string + issue_events_url: + type: string + events_url: + type: string + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + stargazers_url: + type: string + contributors_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + archive_url: + type: string + downloads_url: + type: string + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + created_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + pushed_at: + type: + - string + - 'null' + format: date-time + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + homepage: + type: + - string + - 'null' + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: + - string + - 'null' + has_issues: + type: boolean + has_projects: + type: boolean + has_downloads: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all + or collaborators_only.' + type: string + enum: + - all + - collaborators_only + forks_count: + type: integer + mirror_url: + type: + - string + - 'null' + archived: + type: boolean + disabled: + type: boolean + open_issues_count: + type: integer + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + topics: + type: array + items: + type: string + visibility: + type: string + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + default_branch: + type: string + public: + type: boolean + required: + - action + - forkee + gollum-event: + title: GollumEvent + type: object + properties: + pages: + type: array + items: + type: object + properties: + page_name: + type: + - string + - 'null' + title: + type: + - string + - 'null' + summary: + type: + - string + - 'null' + action: + type: string + sha: + type: string + html_url: + type: string + required: + - pages + member-event: + title: MemberEvent + type: object + properties: + action: + type: string + member: + "$ref": "#/components/schemas/simple-user" + required: + - action + - member + public-event: + title: PublicEvent + type: object + push-event: + title: PushEvent + type: object + properties: + repository_id: + type: integer + push_id: + type: integer + ref: + type: string + head: + type: string + before: + type: string + required: + - repository_id + - push_id + - ref + - head + - before + pull-request-event: + title: PullRequestEvent + type: object + properties: + action: + type: string + number: + type: integer + pull_request: + "$ref": "#/components/schemas/pull-request-minimal" + assignee: + "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + label: + "$ref": "#/components/schemas/label" + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - action + - number + - pull_request + pull-request-review-comment-event: + title: PullRequestReviewCommentEvent + type: object + properties: + action: + type: string + pull_request: + "$ref": "#/components/schemas/pull-request-minimal" + comment: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + pull_request_review_id: + type: + - integer + - 'null' + diff_hunk: + type: string + path: + type: string + position: + type: + - integer + - 'null' + original_position: + type: integer + subject_type: + type: + - string + - 'null' + commit_id: + type: string + user: + 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 + 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 + body: + type: string + created_at: + type: string + format: date-time updated_at: type: string format: date-time - url: + html_url: type: string format: uri - workflow_id: - type: integer - workflow_url: + pull_request_url: type: string format: uri - display_title: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + original_commit_id: type: string + 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 + in_reply_to_id: + type: integer required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url + - url + - pull_request_review_id - id - - jobs_url - - logs_url - node_id - - name + - diff_hunk - path - - pull_requests - - repository - - rerun_url - - run_number - - status + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - display_title + - html_url + - pull_request_url + - _links + - reactions + required: + - action + - comment + - pull_request + pull-request-review-event: + title: PullRequestReviewEvent + type: object + properties: + action: + type: string + review: + type: object + properties: + id: + type: integer + node_id: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: string + commit_id: + type: string + submitted_at: + type: + - string + - 'null' + state: + type: string + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + updated_at: + type: string + pull_request: + "$ref": "#/components/schemas/pull-request-minimal" + required: + - action + - review + - pull_request + commit-comment-event: + title: CommitCommentEvent + type: object + properties: + action: + type: string + comment: + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: + - string + - 'null' + position: + type: + - integer + - 'null' + line: + type: + - integer + - 'null' + commit_id: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - action + - comment + release-event: + title: ReleaseEvent + type: object + properties: + action: + type: string + release: + allOf: + - "$ref": "#/components/schemas/release" + - type: object + properties: + is_short_description_html_truncated: + type: boolean + short_description_html: + type: string + required: + - action + - release + watch-event: + title: WatchEvent + type: object + properties: + action: + type: string required: - action - - repository - - sender - - workflow - - workflow_run examples: root: value: @@ -203067,6 +214487,7 @@ components: cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 @@ -204554,6 +215975,12 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 enterprise-code-security-configuration-list: value: - id: 17 @@ -204622,11 +216049,14 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 @@ -204652,6 +216082,8 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_delegated_bypass: enabled @@ -204686,6 +216118,8 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_delegated_bypass: disabled @@ -204713,11 +216147,16 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -204894,6 +216333,25 @@ components: dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: + assignees: + - 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 repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= @@ -205041,6 +216499,7 @@ components: dismissed_reason: dismissed_comment: fixed_at: + assignees: [] repository: id: 664700648 node_id: MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg= @@ -205106,238 +216565,98 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} - organization-secret-scanning-alert-list: + enterprise-teams-items: value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - 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} - 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} - 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} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - 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: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - 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 - html_url: https://github.com/owner/repo/security/secret-scanning/1 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations - state: open - resolution: - resolved_at: - resolved_by: - secret_type: mailchimp_api_key - secret_type_display_name: Mailchimp API Key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - 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} - 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} - 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} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - push_protection_bypassed: false - push_protection_bypassed_at: - push_protection_bypass_request_reviewer: - push_protection_bypass_request_reviewer_comment: - push_protection_bypass_request_comment: - push_protection_bypass_request_html_url: - resolution_comment: - validity: unknown - publicly_leaked: false - multi_repo: false + - id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + enterprise-teams-item: + value: + id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + simple-user-items: + value: + - 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 + simple-user: + value: + 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 + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -205371,20 +216690,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-07T07:50:26Z' feed: @@ -206025,6 +217335,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -206217,7 +217528,6 @@ components: push: false pull: true allow_rebase_merge: true - template_repository: temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false @@ -206501,20 +217811,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22237752260' @@ -206524,7 +217825,7 @@ components: login: octocat display_login: octocat gravatar_id: '' - url: https://api.github.com/users/rrubenich + url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 @@ -206731,20 +218032,165 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: + dependabot-repository-access-details: value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + delete-budget: + value: + message: Budget successfully deleted. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + billing-premium-request-usage-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 100 + netAmount: 4.0 billing-usage-report: value: usageItems: @@ -206759,6 +218205,22 @@ components: netAmount: 0.8 organizationName: GitHub repositoryName: github/example + billing-usage-summary-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 1000 + netAmount: 8.0 organization-full: value: login: github @@ -206802,6 +218264,7 @@ components: filled_seats: 4 seats: 5 default_repository_permission: read + default_repository_branch: main members_can_create_repositories: true two_factor_requirement_enabled: true members_allowed_repository_creation_type: all @@ -206811,6 +218274,14 @@ components: members_can_create_pages: true members_can_create_public_pages: true members_can_create_private_pages: true + members_can_delete_repositories: true + members_can_change_repo_visibility: true + members_can_invite_outside_collaborators: true + members_can_delete_issues: false + display_commenter_full_name_setting_enabled: false + readers_can_create_discussions: true + members_can_create_teams: true + members_can_view_dependency_insights: true members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' @@ -206900,7 +218371,35 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' - actions-hosted-runner-image: + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-curated-image: value: id: ubuntu-20.04 platform: linux-x64 @@ -206928,6 +218427,16 @@ components: enabled_repositories: all allowed_actions: selected selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions + sha_pinning_required: true + actions-fork-pr-contributor-approval: + value: + approval_policy: first_time_contributors + actions-fork-pr-workflows-private-repos: + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true repository-paginated: value: total_count: 1 @@ -207373,6 +218882,7 @@ components: os: linux status: online busy: true + ephemeral: false labels: - id: 5 name: self-hosted @@ -207388,6 +218898,7 @@ components: os: macos status: offline busy: false + ephemeral: false labels: - id: 5 name: self-hosted @@ -207460,6 +218971,7 @@ components: os: macos status: online busy: true + ephemeral: false labels: - id: 5 name: self-hosted @@ -207628,6 +219140,130 @@ components: updated_at: '2020-01-10T14:59:22Z' visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories + artifact-deployment-record-list: + value: + total_count: 1 + deployment_records: + - id: 123 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: prod-deployment + tags: + data: sensitive + created: '2011-01-26T19:14:43Z' + updated_at: '2011-01-26T19:14:43Z' + attestation_id: 456 + bulk-subject-digest-body: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + bulk-subject-digest-body-with-predicate-type: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + predicateType: provenance + list-attestations-bulk: + value: + attestations_subject_digests: + - sha256:abc: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -207719,26 +219355,103 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 - simple-user-items: + campaign-org-items: value: - - 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 + - number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: Address critical alerts before they are exploited to prevent + breaches, protect sensitive data, and mitigate financial and reputational + damage. + managers: + - 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 + ends_at: '2024-03-14T12:29:18Z' + closed_at: + state: open + - number: 4 + created_at: '2024-03-30T12:29:18Z' + updated_at: '2024-03-30T12:29:18Z' + name: Mitre top 10 KEV + description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) + to enhance security by addressing vulnerabilities actively exploited by + attackers. This reduces risk, prevents breaches and can help protect sensitive + data. + managers: + - 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 + ends_at: '2024-04-30T12:29:18Z' + closed_at: + state: open + campaign-summary: + value: + number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: Address critical alerts before they are exploited to prevent + breaches, protect sensitive data, and mitigate financial and reputational + damage. + managers: + - 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 + published_at: '2024-02-14T12:29:18Z' + ends_at: '2024-03-14T12:29:18Z' + closed_at: + state: open + alert_stats: + open_count: 10 + closed_count: 3 + in_progress_count: 3 code-scanning-organization-alert-items: value: - number: 4 @@ -207982,6 +219695,7 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_delegated_bypass: enabled @@ -207992,6 +219706,7 @@ components: reviewer_type: TEAM secret_scanning_validity_checks: enabled secret_scanning_non_provider_patterns: enabled + secret_scanning_delegated_alert_dismissal: not_set private_vulnerability_reporting: enabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/17 @@ -208011,11 +219726,13 @@ components: dependabot_alerts: enabled dependabot_security_updates: enabled code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: enabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 @@ -208039,11 +219756,16 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: disabled secret_scanning: disabled secret_scanning_push_protection: disabled secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -208505,6 +220227,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 + last_authenticated_at: '2021-10-14T00:53:32-06:00' plan_type: business assignee: login: octocat @@ -208544,6 +220267,7 @@ components: pending_cancellation_date: '2021-11-01' last_activity_at: '2021-10-13T00:53:32-06:00' last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' assignee: login: octokitten id: 1 @@ -208563,6 +220287,10 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-organization-content-exclusion-details: + value: + octo-repo: + - "/src/some-dir/kernel.rs" copilot-usage-metrics-for-day: value: - date: '2024-06-24' @@ -208662,70 +220390,6 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -208831,6 +220495,12 @@ components: action: started public: true created_at: '2022-06-08T23:29:25Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? - id: '22249084964' type: PushEvent actor: @@ -208843,24 +220513,21 @@ components: repo: id: 1296269 name: octo-org/octo-repo - url: https://api.github.com/repos/octo-org/oct-repo + url: https://api.github.com/repos/octo-org/octo-repo payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? organization-invitation-items: value: - id: 1 @@ -208956,7 +220623,6 @@ components: - 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' @@ -209141,6 +220807,28 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: + issue-type-items: + value: + - id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + - id: 411 + node_id: IT_kwDNAd3NAZs + name: Bug + description: An unexpected problem or behavior + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + issue-type: + value: + id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' codespace: value: id: 1 @@ -209289,6 +220977,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 + last_authenticated_at: '2021-10-14T00:53:32-06:00' plan_type: business assignee: login: octocat @@ -209330,6 +221019,10 @@ components: state: active role: admin organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -209922,6 +221615,8 @@ components: status: disabled secret_scanning_non_provider_patterns: status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled organization-role-list: value: total_count: 2 @@ -210174,18 +221869,119 @@ components: value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - project-items: + projects-v2: value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 + id: 2 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + 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 + creator: + 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 + title: My Projects + description: A board to manage my personal projects. + public: true + closed_at: + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + number: 2 + short_description: + deleted_at: + deleted_by: state: open + latest_status_update: + id: 3 + node_id: PVTSU_lAECAQM + creator: + login: hubot + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: false + body: DONE + start_date: '2025-07-23' + target_date: '2025-07-26' + status: COMPLETE + created_at: '2025-07-11T16:19:28Z' + updated_at: '2025-07-11T16:19:28Z' + is_template: true + projects-v2-item-simple: + value: + id: 17 + node_id: PVTI_lADOANN5s84ACbL0zgBueEI + content: + id: 38 + node_id: I_kwDOANN5s85FtLts + title: Example Draft Issue + body: This is a draft issue in the project. + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + user: + 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 + content_type: DraftIssue creator: login: octocat id: 1 @@ -210205,22 +222001,972 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: true - project-2: + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + archived_at: + project_url: https://api.github.com/users/octocat/projectsV2/1 + item_url: https://api.github.com/users/octocat/projectsV2/items/17 + projects-v2-field-items: value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. + - id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + - id: 67891 + node_id: PVTF_lADOABCD9876543210 + name: Status + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_4 + name: + html: Todo + raw: Todo + color: GRAY + description: + html: Items to be worked on + raw: Items to be worked on + - id: option_5 + name: + html: In Progress + raw: In Progress + color: BLUE + description: + html: Items currently being worked on + raw: Items currently being worked on + - id: option_6 + name: + html: Done + raw: Done + color: GREEN + description: + html: Completed items + raw: Completed items + created_at: '2022-04-29T10:30:00Z' + updated_at: '2022-04-29T10:30:00Z' + - id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + - id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + - id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + - id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-item-with-content: + value: + id: 13 + node_id: PVTI_lAAFAQ0 + project_url: https://api.github.com/orgs/github/projectsV2/1 + content: + url: https://api.github.com/repos/github/Hello-World/pulls/6 + id: 10 + node_id: PR_kwABCg + html_url: https://github.com/github/Hello-World/pull/6 + diff_url: https://github.com/github/Hello-World/pull/6.diff + patch_url: https://github.com/github/Hello-World/pull/6.patch + issue_url: https://api.github.com/repos/github/Hello-World/issues/6 + number: 6 + state: open + locked: false + title: Issue title + user: + login: monalisa + id: 161 + node_id: U_kgDMoQ + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + pinned_comment: + body: Issue body + created_at: '2025-08-01T18:44:50Z' + updated_at: '2025-08-06T19:25:18Z' + closed_at: + merged_at: + merge_commit_sha: 98e25bad5878e54d22e5338cbc905dd2deedfa34 + assignee: + login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + assignees: + - login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + requested_reviewers: + - login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + requested_teams: [] + labels: + - id: 19 + node_id: LA_kwABEw + url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: "fun size \U0001F36B" + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: "\U0001F692 wontfix" + color: 5891ce + default: false + description: This will not be worked on + milestone: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: + closed_at: + draft: false + commits_url: https://api.github.com/repos/github/Hello-World/pulls/6/commits + review_comments_url: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment_url: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/github/Hello-World/issues/6/comments + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + head: + label: github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f + ref: branch-2ee3da8fde8a1adfe6d0809a1a414e4f + sha: a3258d3434ecb2058b2784c8eb8610c2e9937a0d + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: + archived: false + disabled: false + open_issues_count: 3 + license: + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + base: + label: github:branch-0f4ceb14cbe39e4786ffbabb776da599 + ref: branch-0f4ceb14cbe39e4786ffbabb776da599 + sha: 9a9f5a8d77bdc2540412900d3c930fe36a82b5ed + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: + archived: false + disabled: false + open_issues_count: 3 + license: + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + _links: + self: + href: https://api.github.com/repos/github/Hello-World/pulls/6 + html: + href: https://github.com/github/Hello-World/pull/6 + issue: + href: https://api.github.com/repos/github/Hello-World/issues/6 + comments: + href: https://api.github.com/repos/github/Hello-World/issues/6/comments + review_comments: + href: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment: + href: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/github/Hello-World/pulls/6/commits + statuses: + href: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + author_association: MEMBER + auto_merge: + active_lock_reason: + content_type: PullRequest + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + created_at: '2025-08-01T18:44:51Z' + updated_at: '2025-08-06T19:25:18Z' + archived_at: + item_url: https://api.github.com/orgs/github/projectsV2/1/items/13 + fields: + - id: 1 + name: Title + type: title + value: + raw: It seemed to me that any civilization that had so far lost its head + as to need to include a set of detailed instructions for use in a packet + of toothpicks, was no longer a civilization in which I could live and + stay sane. + html: It seemed to me that any civilization that had so far lost its head + as to need to include a set of detailed instructions for use in a packet + of toothpicks, was no longer a civilization in which I could live and + stay sane. + number: 6 + url: https://github.com/5/1/pull/6 + issue_id: 12 + state: open + state_reason: + is_draft: false + - id: 2 + name: Assignees + type: assignees + value: + - login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + - id: 3 + name: Status + type: single_select + value: + id: '98236657' + name: + raw: Done + html: Done + color: PURPLE + description: + raw: This has been completed + html: This has been completed + - id: 4 + name: Labels + type: labels + value: + - id: 19 + node_id: LA_kwABEw + url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: "fun size \U0001F36B" + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: "\U0001F692 wontfix" + color: 5891ce + default: false + description: This will not be worked on + - id: 5 + name: Linked pull requests + type: linked_pull_requests + value: [] + - id: 6 + name: Milestone + type: milestone + value: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: + creator: + login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: + closed_at: + - id: 7 + name: Repository + type: repository + value: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + - id: 8 + name: Type + type: issue_type + value: + - id: 9 + name: Reviewers + type: reviewers + value: + - type: ReviewRequest + status: pending + reviewer: + avatarUrl: https://github.com/images/error/octocat_happy.gif + id: 2 + login: monalisa + url: https://github.com/monalisa + name: monalisa + type: User + - id: 10 + name: Parent issue + type: parent_issue + value: + - id: 11 + name: Sub-issues progress + type: sub_issues_progress + value: + projects-v2-view: + value: + id: 1 number: 1 - state: open + name: Sprint Board + layout: board + node_id: PVTV_lADOANN5s84ACbL0zgBueEI + project_url: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: https://github.com/orgs/octocat/projects/1/views/1 creator: login: octocat id: 1 @@ -210240,8 +222986,22 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + filter: is:issue is:open + visible_fields: + - 123 + - 456 + - 789 + sort_by: + - - 123 + - asc + - - 456 + - desc + group_by: + - 123 + vertical_group_by: + - 456 custom-properties: value: - property_name: environment @@ -210255,6 +223015,7 @@ components: - production - development values_editable_by: org_actors + require_explicit_values: true - property_name: service url: https://api.github.com/orgs/github/properties/schema/service source_type: organization @@ -210914,6 +223675,262 @@ components: enforcement: evaluate result: fail rule_type: commit_message_pattern + ruleset-history: + value: + - version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + - version_id: 2 + actor: + id: 2 + type: User + updated_at: '2024-09-23T16:29:47Z' + - version_id: 1 + actor: + id: 1 + type: User + updated_at: '2024-08-23T16:29:47Z' + org-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 21 + name: super cool ruleset + target: branch + source_type: Organization + source: my-org + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + organization-secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + 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} + 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} + 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} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + 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: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + 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 + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled list-repository-advisories: value: - ghsa_id: GHSA-abcd-1234-efgh @@ -211273,25 +224290,22 @@ components: tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha} - actions-billing-usage: - value: - total_minutes_used: 305 - total_paid_minutes_used: 0 - included_minutes: 3000 - minutes_used_breakdown: - UBUNTU: 205 - MACOS: 10 - WINDOWS: 90 - packages-billing-usage: + team-simple-items: value: - total_gigabytes_bandwidth_used: 50 - total_paid_gigabytes_bandwidth_used: 40 - included_gigabytes_bandwidth: 10 - combined-billing-usage: - value: - days_left_in_billing_cycle: 20 - estimated_paid_storage_for_month: 15 - estimated_storage_for_month: 40 + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/organizations/1/team/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: https://api.github.com/organizations/1/team/1/repos + type: organization + organization_id: 1 network-configurations-paginated: value: total_count: 2 @@ -211374,329 +224388,6 @@ components: created_at: '2008-01-14T04:33:35Z' updated_at: '2017-08-17T12:37:15Z' type: Organization - team-discussion-items: - value: - - author: - 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 - body: Hi! This is an area for us to collaborate as a team. - body_html: "

Hi! This is an area for us to collaborate as a team

" - body_version: 0d495416a700fb06133c612575d92bfb - comments_count: 0 - comments_url: https://api.github.com/teams/2343027/discussions/1/comments - created_at: '2018-01-25T18:56:31Z' - last_edited_at: - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: 1 - pinned: false - private: false - team_url: https://api.github.com/teams/2343027 - title: Our first team post - updated_at: '2018-01-25T18:56:31Z' - url: https://api.github.com/teams/2343027/discussions/1 - reactions: - url: https://api.github.com/teams/2343027/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion: - value: - author: - 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 - body: Hi! This is an area for us to collaborate as a team. - body_html: "

Hi! This is an area for us to collaborate as a team

" - body_version: 0d495416a700fb06133c612575d92bfb - comments_count: 0 - comments_url: https://api.github.com/teams/2343027/discussions/1/comments - created_at: '2018-01-25T18:56:31Z' - last_edited_at: - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: 1 - pinned: false - private: false - team_url: https://api.github.com/teams/2343027 - title: Our first team post - updated_at: '2018-01-25T18:56:31Z' - url: https://api.github.com/teams/2343027/discussions/1 - reactions: - url: https://api.github.com/teams/2343027/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-2: - value: - author: - 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 - body: Hi! This is an area for us to collaborate as a team. - body_html: "

Hi! This is an area for us to collaborate as a team

" - body_version: 0d495416a700fb06133c612575d92bfb - comments_count: 1 - comments_url: https://api.github.com/teams/2343027/discussions/1/comments - created_at: '2018-01-25T18:56:31Z' - last_edited_at: '2018-01-26T18:22:20Z' - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: 1 - pinned: false - private: false - team_url: https://api.github.com/teams/2343027 - title: Welcome to our first team post - updated_at: '2018-01-26T18:22:20Z' - url: https://api.github.com/teams/2343027/discussions/1 - reactions: - url: https://api.github.com/teams/2343027/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-comment-items: - value: - - author: - 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 - body: Do you like apples? - body_html: "

Do you like apples?

" - body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 - created_at: '2018-01-15T23:53:58Z' - last_edited_at: - discussion_url: https://api.github.com/teams/2403582/discussions/1 - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: 1 - updated_at: '2018-01-15T23:53:58Z' - url: https://api.github.com/teams/2403582/discussions/1/comments/1 - reactions: - url: https://api.github.com/teams/2403582/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-comment: - value: - author: - 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 - body: Do you like apples? - body_html: "

Do you like apples?

" - body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 - created_at: '2018-01-15T23:53:58Z' - last_edited_at: - discussion_url: https://api.github.com/teams/2403582/discussions/1 - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: 1 - updated_at: '2018-01-15T23:53:58Z' - url: https://api.github.com/teams/2403582/discussions/1/comments/1 - reactions: - url: https://api.github.com/teams/2403582/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-comment-2: - value: - author: - 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 - body: Do you like pineapples? - body_html: "

Do you like pineapples?

" - body_version: e6907b24d9c93cc0c5024a7af5888116 - created_at: '2018-01-15T23:53:58Z' - last_edited_at: '2018-01-26T18:22:20Z' - discussion_url: https://api.github.com/teams/2403582/discussions/1 - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: 1 - updated_at: '2018-01-26T18:22:20Z' - url: https://api.github.com/teams/2403582/discussions/1/comments/1 - reactions: - url: https://api.github.com/teams/2403582/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - reaction-items: - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - reaction: - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' team-membership-response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer value: @@ -211709,84 +224400,6 @@ components: url: https://api.github.com/teams/1/memberships/octocat role: member state: pending - team-project-items: - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - team-project: - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false team-repository-alternative-response-with-repository-permissions: value: id: 1296269 @@ -211935,143 +224548,6 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core - project-card: - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - 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 - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - project-column: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - project-card-items: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - 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 - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - project-3: - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - project-collaborator-permission: - value: - permission: admin - user: - 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 - project-column-items: - value: - - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' rate-limit-overview: value: resources: @@ -212632,6 +225108,10 @@ components: status: disabled secret_scanning_non_provider_patterns: status: disabled + secret_scanning_delegated_bypass: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled artifact-paginated: value: total_count: 2 @@ -212646,6 +225126,7 @@ components: created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: id: 2332938 repository_id: 1296269 @@ -212662,6 +225143,7 @@ components: created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: id: 2332942 repository_id: 1296269 @@ -212680,6 +225162,7 @@ components: created_at: '2020-01-10T14:59:22Z' expires_at: '2020-01-21T14:59:22Z' updated_at: '2020-01-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: id: 2332938 repository_id: 1296269 @@ -212821,6 +225304,7 @@ components: enabled: true allowed_actions: selected selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions + sha_pinning_required: true actions-workflow-access-to-repository: value: access_level: organization @@ -213538,6 +226022,11 @@ components: url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + workflow-dispatch-response: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 workflow-usage: value: billable: @@ -215349,7 +227838,6 @@ components: environment: '' category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" state: open - fixed_at: commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. @@ -215366,7 +227854,6 @@ components: environment: '' category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" state: fixed - fixed_at: '2020-02-14T12:29:18Z' commit_sha: b09da05606e27f463a2b49287684b4ae777092f2 message: text: This suffix check is missing a length comparison to correctly handle @@ -215439,7 +227926,7 @@ components: deletable: true warning: '' code-scanning-analysis-sarif: - summary: application/json+sarif response + summary: application/sarif+json response value: runs: - tool: @@ -215650,7 +228137,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' completed_at: '2022-09-12T13:15:33Z' - status: completed + status: succeeded actions_workflow_run_id: 3453588 scanned_repositories: - repository: @@ -215666,12 +228153,10 @@ components: repository_count: 2 repositories: - id: 1 - node_id: MDQ6VXNlcjE= name: octo-repo1 full_name: octo-org/octo-repo1 private: false - id: 2 - node_id: MDQ6VXNlcjE= name: octo-repo2 full_name: octo-org/octo-repo2 private: false @@ -215685,12 +228170,10 @@ components: repository_count: 2 repositories: - id: 7 - node_id: MDQ6VXNlcjE= name: octo-repo7 full_name: octo-org/octo-repo7 private: false - id: 8 - node_id: MDQ6VXNlcjE= name: octo-repo8 full_name: octo-org/octo-repo8 private: false @@ -215698,12 +228181,10 @@ components: repository_count: 2 repositories: - id: 9 - node_id: MDQ6VXNlcjE= name: octo-repo9 full_name: octo-org/octo-repo9 private: false - id: 10 - node_id: MDQ6VXNlcjE= name: octo-repo10 full_name: octo-org/octo-repo10 private: false @@ -215788,11 +228269,13 @@ components: - ruby - python query_suite: default + threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly code-scanning-default-setup-update: value: state: configured + threat_model: remote_and_local code-scanning-default-setup-update-response: value: run_id: 42 @@ -215823,11 +228306,14 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -216450,6 +228936,56 @@ components: site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' commit-items: value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -218014,6 +230550,25 @@ components: dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: + assignees: + - 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 - number: 1 state: open dependency: @@ -218096,6 +230651,7 @@ components: dismissed_reason: dismissed_comment: fixed_at: + assignees: [] dependabot-alert-open: value: number: 1 @@ -218183,6 +230739,25 @@ components: dismissed_reason: dismissed_comment: fixed_at: + assignees: + - 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 dependabot-alert-dismissed: value: number: 2 @@ -218282,6 +230857,7 @@ components: dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: + assignees: [] dependabot-secret-paginated: value: total_count: 2 @@ -218755,20 +231331,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22237752260' @@ -219495,6 +232062,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -219641,6 +232209,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -219814,6 +232383,58 @@ components: updated_at: '2011-04-14T16:00:49Z' issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR + pin: + issue-comment-pinned: + value: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + 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 + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + 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 issue-event-items: value: - id: 1 @@ -219874,6 +232495,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -220028,6 +232650,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -220143,7 +232766,6 @@ components: metadata: read contents: read issues: write - single_file: write events: - push - pull_request @@ -220158,6 +232780,202 @@ components: updated_at: '2011-04-22T13:33:48Z' author_association: COLLABORATOR state_reason: completed + issue-with-pinned-comment: + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + 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 + pinned_comment: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + 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 + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + 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 + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + 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 + assignees: + - 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 + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + 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 + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 1 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + 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 + author_association: COLLABORATOR + state_reason: completed issue-event-for-issue-items: value: - id: 1 @@ -220685,39 +233503,6 @@ components: https_error: is_https_eligible: true caa_error: - project-items-2: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' custom-property-values: value: - property_name: environment @@ -222731,6 +235516,7 @@ components: body: Description of the release draft: false prerelease: false + immutable: false created_at: '2013-02-27T19:35:32Z' published_at: '2013-02-27T19:35:32Z' author: @@ -222762,6 +235548,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -222801,6 +235588,7 @@ components: body: Description of the release draft: false prerelease: false + immutable: false created_at: '2013-02-27T19:35:32Z' published_at: '2013-02-27T19:35:32Z' author: @@ -222832,6 +235620,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -222865,6 +235654,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -222902,6 +235692,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -222935,6 +235726,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -223033,6 +235825,36 @@ components: href: https://github.com/monalisa/my-repo/rules/42 created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' + repository-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 42 + name: super cool ruleset + target: branch + source_type: Repository + source: monalisa/my-repo + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github secret-scanning-alert-list: value: - number: 2 @@ -223112,29 +235934,37 @@ components: 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 - html_url: https://github.com/owner/repo/security/secret-scanning/1 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations - state: open - resolution: - resolved_at: - resolved_by: - secret_type: mailchimp_api_key - secret_type_display_name: Mailchimp API Key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - push_protection_bypassed_by: - push_protection_bypassed: false - push_protection_bypassed_at: - push_protection_bypass_request_reviewer: - push_protection_bypass_request_reviewer_comment: - push_protection_bypass_request_comment: - push_protection_bypass_request_html_url: - resolution_comment: - validity: unknown - publicly_leaked: false - multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + 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 secret-scanning-alert-open: value: number: 42 @@ -223203,6 +236033,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + 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 secret-scanning-location-list: value: - type: commit @@ -223895,13 +236744,6 @@ components: zipball_url: https://github.com/octocat/Hello-World/zipball/v0.1 tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= - tag-protection-items: - value: - - id: 2 - pattern: v1.* - tag-protection: - value: - enabled: true topic: value: names: @@ -226007,6 +238849,8 @@ components: state: active role: admin organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: [] organization: login: github id: 1 @@ -226043,6 +238887,10 @@ components: state: pending role: admin organization_url: https://api.github.com/orgs/invitocat + direct_membership: false + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -226081,6 +238929,10 @@ components: state: pending role: admin organization_url: https://api.github.com/orgs/invitocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -226119,6 +238971,10 @@ components: state: active role: admin organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -226736,39 +239592,6 @@ components: container: tags: - 1.13.6 - project: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' repository-items-default-response: summary: Default response value: @@ -226895,21 +239718,18 @@ components: url: https://twitter.com/github ssh-signing-key-items: value: - - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - id: 2 - url: https://api.github.com/user/keys/2 + - id: 2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' - - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 - id: 3 - url: https://api.github.com/user/keys/3 + - id: 3 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' ssh-signing-key: value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 - url: https://api.github.com/user/keys/2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' starred-repository-items-alternative-response-with-star-creation-timestamps: @@ -227190,20 +240010,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: false created_at: '2022-06-07T07:50:26Z' user-org-events-items: @@ -227219,25 +240030,22 @@ components: avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: false created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? - id: '22196946742' type: CreateEvent actor: @@ -227249,11 +240057,12 @@ components: avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo payload: - ref: + ref: master ref_type: repository + full_ref: refs/heads/master master_branch: master description: pusher_type: user @@ -227261,9 +240070,9 @@ components: created_at: '2022-06-07T07:50:26Z' org: id: 9919 - login: github + login: octo-org gravatar_id: '' - url: https://api.github.com/orgs/github + url: https://api.github.com/orgs/octo-org avatar_url: https://avatars.githubusercontent.com/u/9919? user-public-events-items: value: @@ -227298,20 +240107,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-08T23:29:25Z' hovercard: @@ -227370,39 +240170,6 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems - project-items-3: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' user-received-events-items: value: - id: '22249084964' @@ -227419,20 +240186,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22196946742' @@ -227449,19 +240207,14 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: - ref: + ref: master ref_type: repository + full_ref: refs/heads/master master_branch: master description: pusher_type: user public: false created_at: '2022-06-07T07:50:26Z' - org: - id: 9919 - login: github - gravatar_id: '' - url: https://api.github.com/orgs/github - avatar_url: https://avatars.githubusercontent.com/u/9919? user-received-public-events-items: value: - id: '22249084964' @@ -227478,20 +240231,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22196946742' @@ -227508,19 +240252,60 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: - ref: + ref: master ref_type: repository + full_ref: refs/heads/master master_branch: master description: pusher_type: user public: false created_at: '2022-06-07T07:50:26Z' - org: - id: 9919 - login: github - gravatar_id: '' - url: https://api.github.com/orgs/github - avatar_url: https://avatars.githubusercontent.com/u/9919? + billing-premium-request-usage-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 100 + netAmount: 4.0 + billing-usage-report-user: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + repositoryName: user/example + billing-usage-summary-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 1000 + netAmount: 8.0 check-run-completed: value: action: completed @@ -227629,7 +240414,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -227680,7 +240464,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -227924,7 +240707,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -227975,7 +240757,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -228207,7 +240988,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -228258,7 +241038,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -228515,7 +241294,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -228566,7 +241344,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -229105,8 +241882,7 @@ components: type: integer enterprise: name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -229164,6 +241940,29 @@ components: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string + dependabot-alert-comma-separated-has: + name: has + in: query + description: |- + Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + dependabot-alert-comma-separated-assignees: + name: assignee + in: query + description: |- + Filter alerts by assignees. + Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + schema: + type: string dependabot-alert-scope: name: scope in: query @@ -229189,100 +241988,43 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - secret-scanning-alert-state: - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - secret-scanning-alert-secret-type: - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default secret - patterns are returned. To return experimental patterns, pass the token name(s) - in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false + enterprise-team: + name: enterprise-team + description: The slug version of the enterprise team name. You can also substitute + this value with the enterprise team id. + in: path + required: true schema: type: string - secret-scanning-alert-resolution: - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true schema: type: string - secret-scanning-alert-sort: - name: sort - description: The property to sort the results by. `created` means when the alert - was created. `updated` means when the alert was updated or resolved. - in: query - required: false + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true schema: type: string - enum: - - created - - updated - default: created - secret-scanning-alert-validity: - name: validity - in: query - 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`. - required: false + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true 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 + public-events-per-page: + name: per_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)." 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 + type: integer + default: 15 gist-id: name: gist_id description: The unique identifier of the gist. @@ -229389,9 +242131,9 @@ components: required: false schema: type: integer - org: - name: org - description: The organization name. The name is not case sensitive. + budget: + name: budget_id + description: The ID corresponding to the budget. in: path required: true schema: @@ -229400,15 +242142,16 @@ components: name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, - `2024`. Default value is the current year. + `2025`. Default value is the current year. in: query required: false schema: type: integer - billing-usage-report-month: + billing-usage-report-month-default: name: month description: If specified, only return results for a single month. The value - of `month` is an integer between `1` and `12`. + of `month` is an integer between `1` and `12`. Default value is the current + month. If no year is specified the default `year` is used. in: query required: false schema: @@ -229416,19 +242159,71 @@ components: billing-usage-report-day: name: day description: If specified, only return results for a single day. The value of - `day` is an integer between `1` and `31`. + `day` is an integer between `1` and `31`. If no `year` or `month` is specified, + the default `year` and `month` are used. + in: query + required: false + schema: + type: integer + billing-usage-report-user: + name: user + description: The user name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-model: + name: model + description: The model name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-product: + name: product + description: The product name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-month: + name: month + description: If specified, only return results for a single month. The value + of `month` is an integer between `1` and `12`. If no year is specified the + default `year` is used. in: query required: false schema: type: integer - billing-usage-report-hour: - name: hour - description: If specified, only return results for a single hour. The value - of `hour` is an integer between `0` and `23`. + billing-usage-report-repository: + name: repository + description: The repository name to query for usage in the format owner/repository. + in: query + required: false + schema: + type: string + billing-usage-report-sku: + name: sku + description: The SKU to query for usage. in: query required: false + schema: + type: string + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true schema: type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -229493,13 +242288,16 @@ components: required: true schema: type: string - username: - name: username - description: The handle for the GitHub user account. + subject-digest: + name: subject_digest + description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path required: true schema: type: string + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" tool-name: name: tool_name description: The name of a code scanning tool. Only results by this tool will @@ -229519,6 +242317,47 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of artifact registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string + dependabot-alert-comma-separated-artifact-registry: + name: artifact_registry + in: query + description: |- + A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + + Can be: `jfrog-artifactory` + schema: + type: string + dependabot-alert-org-scope-comma-separated-has: + name: has + in: query + description: |- + Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + Multiple `has` filters can be passed to filter for alerts that have all of the values. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + - deployment + dependabot-alert-comma-separated-runtime-risk: + name: runtime_risk + in: query + description: |- + A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + + Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + schema: + type: string hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the @@ -229643,6 +242482,13 @@ components: required: true schema: type: integer + issue-type-id: + name: issue_type_id + description: The unique identifier of the issue type. + in: path + required: true + schema: + type: integer codespace-name: name: codespace_name in: path @@ -229664,13 +242510,6 @@ components: required: true schema: type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string role-id: name: role_id description: The unique identifier of the role. @@ -229785,6 +242624,18 @@ components: schema: type: string format: date-time + personal-access-token-token-id: + name: token_id + description: The ID of the token + in: query + required: false + schema: + type: array + maxItems: 50 + items: + type: string + examples: + - token_id[]=1,token_id[]=2 fine-grained-personal-access-token-id: name: pat_id description: The unique identifier of the fine-grained personal access token. @@ -229792,6 +242643,34 @@ components: required: true schema: type: integer + project-number: + name: project_number + description: The project's number. + in: path + required: true + schema: + type: integer + field-id: + name: field_id + description: The unique identifier of the field. + in: path + required: true + schema: + type: integer + item-id: + name: item_id + description: The unique identifier of the project item. + in: path + required: true + schema: + type: integer + view-number: + name: view_number + description: The number that identifies the project view. + in: path + required: true + schema: + type: integer custom-property-name: name: custom_property_name description: The custom property name @@ -229832,7 +242711,7 @@ components: description: |- The time period to filter by. - For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). in: query required: false schema: @@ -229852,8 +242731,8 @@ components: type: string rule-suite-result: name: rule_suite_result - description: The rule results to filter on. When specified, only suites with - this result will be returned. + description: The rule suite results to filter on. When specified, only suites + with this result will be returned. in: query schema: type: string @@ -229874,6 +242753,67 @@ components: required: true schema: type: integer + secret-scanning-alert-state: + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts + in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + secret-scanning-alert-secret-type: + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default secret + patterns are returned. To return generic patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-resolution: + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts + with one of these resolutions are listed. Valid resolutions are `false_positive`, + `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + secret-scanning-alert-sort: + name: sort + description: The property to sort the results by. `created` means when the alert + was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created secret-scanning-pagination-before-org-repo: name: 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). @@ -229892,6 +242832,42 @@ components: required: false schema: type: string + secret-scanning-alert-validity: + name: validity + in: query + 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`. + 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 + secret-scanning-alert-hide-secret: + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets + in the results. + required: false + schema: + type: boolean + default: false network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -229906,34 +242882,6 @@ components: required: true schema: type: string - discussion-number: - name: discussion_number - description: The number that identifies the discussion. - in: path - required: true - schema: - type: integer - comment-number: - name: comment_number - description: The number that identifies the comment. - in: path - required: true - schema: - type: integer - reaction-id: - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -229963,20 +242911,6 @@ components: enum: - enable_all - disable_all - card-id: - name: card_id - description: The unique identifier of the card. - in: path - required: true - schema: - type: integer - column-id: - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with @@ -230222,6 +243156,13 @@ components: required: true schema: "$ref": "#/components/schemas/alert-number" + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer commit-sha: name: commit_sha description: The SHA of the commit. @@ -230371,13 +243312,6 @@ components: required: true schema: type: integer - tag-protection-id: - name: tag_protection_id - description: The unique identifier of the tag protection. - in: path - required: true - schema: - type: integer per: name: per description: The time frame to display results for. @@ -230410,6 +243344,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string team-id: name: team_id description: The unique identifier of the team. @@ -230476,6 +243419,13 @@ components: - created - updated default: created + user-id: + name: user_id + description: The unique identifier of the user. + in: path + required: true + schema: + type: string responses: validation_failed_simple: description: Validation failed, or the endpoint has been spammed. @@ -230527,6 +243477,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" conflict: description: Conflict content: @@ -230576,6 +243532,42 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + "$ref": "#/components/schemas/get_all_budgets" + examples: + default: + "$ref": "#/components/examples/get_all_budgets" + budget: + description: Response when updating a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/get-budget" + examples: + default: + "$ref": "#/components/examples/get-budget" + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/delete-budget" + examples: + default: + "$ref": "#/components/examples/delete-budget" + billing_premium_request_usage_report_org: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-premium-request-usage-report-org" + examples: + default: + "$ref": "#/components/examples/billing-premium-request-usage-report-org" billing_usage_report_org: description: Billing usage report response for an organization content: @@ -230585,12 +243577,15 @@ components: examples: default: "$ref": "#/components/examples/billing-usage-report" - internal_error: - description: Internal Error + billing_usage_summary_report_org: + description: Response when getting a billing usage summary content: application/json: schema: - "$ref": "#/components/schemas/basic-error" + "$ref": "#/components/schemas/billing-usage-summary-report-org" + examples: + default: + "$ref": "#/components/examples/billing-usage-summary-report-org" actions_runner_jitconfig: description: Response content: @@ -230647,6 +243642,12 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" + too_large: + description: Payload Too Large + content: + 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. @@ -230657,14 +243658,17 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - gone: - description: Gone + enterprise_team_unsupported: + description: Unprocessable entity if you attempt to modify an enterprise team + at the organization level. + temporary_redirect: + description: Temporary Redirect content: application/json: schema: "$ref": "#/components/schemas/basic-error" - temporary_redirect: - description: Temporary Redirect + gone: + description: Gone content: application/json: schema: @@ -230698,6 +243702,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + unprocessable_analysis: + description: Response if analysis could not be processed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" found: description: Found code_scanning_conflict: @@ -230707,8 +243717,16 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + code_scanning_invalid_state: + description: Response if the configuration change cannot be made because the + repository is not in the required state + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: @@ -230725,6 +243743,33 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + billing_premium_request_usage_report_user: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-premium-request-usage-report-user" + examples: + default: + "$ref": "#/components/examples/billing-premium-request-usage-report-user" + billing_usage_report_user: + description: Response when getting a billing usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-report-user" + examples: + default: + "$ref": "#/components/examples/billing-usage-report-user" + billing_usage_summary_report_user: + description: Response when getting a billing usage summary + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-summary-report-user" + examples: + default: + "$ref": "#/components/examples/billing-usage-summary-report-user" headers: link: example: ; rel="next", ; diff --git a/packages/openapi-typescript/examples/github-api-required.ts b/packages/openapi-typescript/examples/github-api-required.ts index 3bb28b0c1..07ce6c0b6 100644 --- a/packages/openapi-typescript/examples/github-api-required.ts +++ b/packages/openapi-typescript/examples/github-api-required.ts @@ -262,7 +262,7 @@ export interface paths { post?: never; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -308,7 +308,7 @@ export interface paths { get?: never; /** * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * @description Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -580,6 +580,38 @@ export interface paths { patch?: never; trace?: never; }; + "/credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Revoke a list of credentials + * @description Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + * + * This endpoint currently accepts the following credential types: + * - Personal access tokens (classic) + * - Fine-grained personal access tokens + * + * Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + * GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + * + * To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + * + * > [!NOTE] + * > Any authenticated requests will return a 403. + */ + post: operations["credentials/revoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/emojis": { parameters: { query?: never; @@ -600,6 +632,66 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an enterprise + * @description Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-enterprise"]; + /** + * Set GitHub Actions cache retention limit for an enterprise + * @description Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an enterprise + * @description Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-enterprise"]; + /** + * Set GitHub Actions cache storage limit for an enterprise + * @description Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; @@ -800,7 +892,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/teams": { parameters: { query?: never; header?: never; @@ -808,16 +900,34 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * List enterprise teams + * @description List all teams in the enterprise for the authenticated user */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["enterprise-teams/list"]; + put?: never; + /** + * Create an enterprise team + * @description To create an enterprise team, the authenticated user must be an owner of the enterprise. + */ + post: operations["enterprise-teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members in an enterprise team + * @description Lists all team members in an enterprise team. + */ + get: operations["enterprise-team-memberships/list"]; put?: never; post?: never; delete?: never; @@ -826,6 +936,192 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk add team members + * @description Add multiple team members to an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk remove team members + * @description Remove multiple team members from an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get enterprise team membership + * @description Returns whether the user is a member of the enterprise team. + */ + get: operations["enterprise-team-memberships/get"]; + /** + * Add team member + * @description Add a team member to an enterprise team. + */ + put: operations["enterprise-team-memberships/add"]; + post?: never; + /** + * Remove team membership + * @description Remove membership of a specific user from a particular team in an enterprise. + */ + delete: operations["enterprise-team-memberships/remove"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignments + * @description Get all organizations assigned to an enterprise team + */ + get: operations["enterprise-team-organizations/get-assignments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add organization assignments + * @description Assign an enterprise team to multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Remove organization assignments + * @description Unassign an enterprise team from multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignment + * @description Check if an enterprise team is assigned to an organization + */ + get: operations["enterprise-team-organizations/get-assignment"]; + /** + * Add an organization assignment + * @description Assign an enterprise team to an organization. + */ + put: operations["enterprise-team-organizations/add"]; + post?: never; + /** + * Delete an organization assignment + * @description Unassign an enterprise team from an organization. + */ + delete: operations["enterprise-team-organizations/delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an enterprise team + * @description Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. + */ + get: operations["enterprise-teams/get"]; + put?: never; + post?: never; + /** + * Delete an enterprise team + * @description To delete an enterprise team, the authenticated user must be an enterprise owner. + * + * If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + */ + delete: operations["enterprise-teams/delete"]; + options?: never; + head?: never; + /** + * Update an enterprise team + * @description To edit a team, the authenticated user must be an enterprise owner. + */ + patch: operations["enterprise-teams/update"]; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -1306,7 +1602,10 @@ export interface paths { }; get?: never; put?: never; - /** Render a Markdown document */ + /** + * Render a Markdown document + * @description Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + */ post: operations["markdown/render"]; delete?: never; options?: never; @@ -1643,6 +1942,213 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an organization + * @description Gets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-organization"]; + /** + * Set GitHub Actions cache retention limit for an organization + * @description Sets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an organization + * @description Gets GitHub Actions cache storage limit for an organization. All repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-organization"]; + /** + * Set GitHub Actions cache storage limit for an organization + * @description Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists the repositories Dependabot can access in an organization + * @description Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + */ + get: operations["dependabot/repository-access-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Updates Dependabot's repository access list for an organization + * @description Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + * + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + * + * **Example request body:** + * ```json + * { + * "repository_ids_to_add": [123, 456], + * "repository_ids_to_remove": [789] + * } + * ``` + */ + patch: operations["dependabot/update-repository-access-for-org"]; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access/default-level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set the default repository access level for Dependabot + * @description Sets the default level of repository access Dependabot will have while performing an update. Available values are: + * - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + * - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + * + * Unauthorized users will not see the existence of this endpoint. + * + * This operation supports both server-to-server and user-to-server access. + */ + put: operations["dependabot/set-repository-access-default-level"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all budgets for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-all-budgets-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a budget by ID for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-budget-org"]; + put?: never; + post?: never; + /** + * Delete a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + */ + delete: operations["billing/delete-budget-org"]; + options?: never; + head?: never; + /** + * Update a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + */ + patch: operations["billing/update-budget-org"]; + trace?: never; + }; + "/organizations/{org}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for an organization + * @description Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/organizations/{org}/settings/billing/usage": { parameters: { query?: never; @@ -1665,6 +2171,31 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-usage-summary-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -1676,7 +2207,7 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * @@ -1790,6 +2321,106 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners/images/custom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List custom images for an organization + * @description List custom images for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a custom image definition for GitHub Actions Hosted Runners + * @description Get a custom image definition for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-for-org"]; + put?: never; + post?: never; + /** + * Delete a custom image from the organization + * @description Delete a custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List image versions of a custom image for an organization + * @description List image versions of a custom image for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-image-versions-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an image version of a custom image for GitHub Actions Hosted Runners + * @description Get an image version of a custom image for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-version-for-org"]; + put?: never; + post?: never; + /** + * Delete an image version of custom image from the organization + * @description Delete an image version of custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-version-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/hosted-runners/images/github-owned": { parameters: { query?: never; @@ -1977,6 +2608,86 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for an organization + * @description Gets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-organization"]; + /** + * Set artifact and log retention settings for an organization + * @description Sets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for an organization + * @description Gets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-organization"]; + /** + * Set fork PR contributor approval permissions for an organization + * @description Sets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for an organization + * @description Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-organization"]; + /** + * Set private repo fork PR workflow settings for an organization + * @description Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/repositories": { parameters: { query?: never; @@ -2062,6 +2773,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/self-hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get self-hosted runners settings for an organization + * @description Gets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-self-hosted-runners-permissions-organization"]; + /** + * Set self-hosted runners settings for an organization + * @description Sets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repositories allowed to use self-hosted runners in an organization + * @description Lists repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/list-selected-repositories-self-hosted-runners-organization"]; + /** + * Set repositories allowed to use self-hosted runners in an organization + * @description Sets repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-selected-repositories-self-hosted-runners-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a repository to the list of repositories allowed to use self-hosted runners in an organization + * @description Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/enable-selected-repository-self-hosted-runners-organization"]; + post?: never; + /** + * Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + * @description Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + delete: operations["actions/disable-selected-repository-self-hosted-runners-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/workflow": { parameters: { query?: never; @@ -2836,6 +3631,230 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/artifacts/metadata/deployment-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an artifact deployment record + * @description Create or update deployment records for an artifact associated + * with an organization. + * This endpoint allows you to record information about a specific + * artifact, such as its name, digest, environments, cluster, and + * deployment. + * The deployment name has to be uniqe within a cluster (i.e a + * combination of logical, physical environment and cluster) as it + * identifies unique deployment. + * Multiple requests for the same combination of logical, physical + * environment, cluster and deployment name will only create one + * record, successive request will update the existing record. + * This allows for a stable tracking of a deployment where the actual + * deployed artifact can change over time. + */ + post: operations["orgs/create-artifact-deployment-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Set cluster deployment records + * @description Set deployment records for a given cluster. + * If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + * 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + * If no existing records match, new records will be created. + */ + post: operations["orgs/set-cluster-deployment-records"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/storage-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create artifact metadata storage record + * @description Create metadata storage records for artifacts associated with an organization. + * This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + * associated with a repository owned by the organization. + */ + post: operations["orgs/create-artifact-storage-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact deployment records + * @description List deployment records for an artifact metadata associated with an organization. + */ + get: operations["orgs/list-artifact-deployment-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact storage records + * @description List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + */ + get: operations["orgs/list-artifact-storage-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["orgs/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["orgs/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["orgs/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestation repositories + * @description List repositories owned by the provided organization that have created at least one attested artifact + * Results will be sorted in ascending order by repository ID + */ + get: operations["orgs/list-attestation-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + */ + delete: operations["orgs/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/attestations/{subject_digest}": { parameters: { query?: never; @@ -2908,6 +3927,81 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/campaigns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List campaigns for an organization + * @description Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/list-org-campaigns"]; + put?: never; + /** + * Create a campaign for an organization + * @description Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + post: operations["campaigns/create-campaign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns/{campaign_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a campaign for an organization + * @description Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/get-campaign-summary"]; + put?: never; + post?: never; + /** + * Delete a campaign for an organization + * @description Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + delete: operations["campaigns/delete-campaign"]; + options?: never; + head?: never; + /** + * Update a campaign + * @description Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + patch: operations["campaigns/update-campaign"]; + trace?: never; + }; "/orgs/{org}/code-scanning/alerts": { parameters: { query?: never; @@ -2945,7 +4039,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-configurations-for-org"]; put?: never; @@ -2977,7 +4071,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-default-configurations"]; put?: never; @@ -3120,7 +4214,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-repositories-for-configuration"]; put?: never; @@ -3395,7 +4489,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ @@ -3502,7 +4596,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot/content_exclusion": { parameters: { query?: never; header?: never; @@ -3510,23 +4604,41 @@ export interface paths { 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. + * Get Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * > [!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. + * Gets information about an organization's Copilot content exclusion path rules. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." * - * 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. + * Organization owners can view details about Copilot content exclusion rules for the organization. * - * 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 `copilot` or `read:org` scopes to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + * > [!CAUTION] + * > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + * > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. */ - get: operations["copilot/copilot-metrics-for-organization"]; - put?: never; + get: operations["copilot/copilot-content-exclusion-for-organization"]; + /** + * Set Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Sets Copilot content exclusion path rules for an organization. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + * + * Organization owners can set Copilot content exclusion rules for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + * + * > [!CAUTION] + * > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + * > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + */ + put: operations["copilot/set-copilot-content-exclusion-for-organization"]; post?: never; delete?: never; options?: never; @@ -3534,7 +4646,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/usage": { + "/orgs/{org}/copilot/metrics": { parameters: { query?: never; header?: never; @@ -3542,23 +4654,22 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for organization members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * 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. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * > [!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. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 100 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. * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + * 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/usage-metrics-for-org"]; + get: operations["copilot/copilot-metrics-for-organization"]; put?: never; post?: never; delete?: never; @@ -4342,6 +5453,69 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/issue-types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + */ + get: operations["orgs/list-issue-types"]; + put?: never; + /** + * Create issue type for an organization + * @description Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-issue-type"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update issue type for an organization + * @description Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/update-issue-type"]; + post?: never; + /** + * Delete issue type for an organization + * @description Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-issue-type"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/issues": { parameters: { query?: never; @@ -4409,6 +5583,9 @@ export interface paths { /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-member"]; options?: never; @@ -4497,7 +5674,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4543,6 +5720,9 @@ export interface paths { * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-membership-for-user"]; options?: never; @@ -5238,10 +6418,7 @@ export interface paths { }; /** * List private registries for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Lists all private registry configurations available at the organization-level without revealing their encrypted + * @description Lists all private registry configurations available at the organization-level without revealing their encrypted * values. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -5250,10 +6427,7 @@ export interface paths { put?: never; /** * Create a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5273,10 +6447,7 @@ export interface paths { }; /** * Get private registries public key for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * @description Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5298,10 +6469,7 @@ export interface paths { }; /** * Get a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * @description Get the configuration of a single private registry defined for an organization, omitting its encrypted value. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5310,10 +6478,7 @@ export interface paths { post?: never; /** * Delete a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Delete a private registry configuration at the organization-level. + * @description Delete a private registry configuration at the organization-level. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5322,17 +6487,14 @@ export interface paths { head?: never; /** * Update a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["private-registries/update-org-private-registry"]; trace?: never; }; - "/orgs/{org}/projects": { + "/orgs/{org}/projectsV2": { parameters: { query?: never; header?: never; @@ -5340,16 +6502,188 @@ export interface paths { cookie?: never; }; /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * List projects for organization + * @description List all projects owned by a specific organization accessible by the authenticated user. */ get: operations["projects/list-for-org"]; put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * Get project for organization + * @description Get a specific organization-owned project. */ - post: operations["projects/create-for-org"]; + get: operations["projects/get-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for organization owned project + * @description Create draft issue item for the specified organization owned project. + */ + post: operations["projects/create-draft-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for organization + * @description List all fields for a specific organization-owned project. + */ + get: operations["projects/list-fields-for-org"]; + put?: never; + /** + * Add a field to an organization-owned project. + * @description Add a field to an organization-owned project. + */ + post: operations["projects/add-field-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for organization + * @description Get a specific field for an organization-owned project. + */ + get: operations["projects/get-field-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization owned project + * @description List all items for a specific organization-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-org"]; + put?: never; + /** + * Add item to organization owned project + * @description Add an issue or pull request item to the specified organization owned project. + */ + post: operations["projects/add-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for an organization owned project + * @description Get a specific item from an organization-owned project. + */ + get: operations["projects/get-org-item"]; + put?: never; + post?: never; + /** + * Delete project item for organization + * @description Delete a specific item from an organization-owned project. + */ + delete: operations["projects/delete-item-for-org"]; + options?: never; + head?: never; + /** + * Update project item for organization + * @description Update a specific item in an organization-owned project. + */ + patch: operations["projects/update-item-for-org"]; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for an organization-owned project + * @description Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization project view + * @description List items in an organization project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-org"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; @@ -5368,7 +6702,7 @@ export interface paths { * @description Gets all custom properties defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-all-custom-properties"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definitions"]; put?: never; post?: never; delete?: never; @@ -5378,11 +6712,15 @@ export interface paths { * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-definitions"]; trace?: never; }; "/orgs/{org}/properties/schema/{custom_property_name}": { @@ -5397,7 +6735,7 @@ export interface paths { * @description Gets a custom property that is defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-custom-property"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definition"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. @@ -5406,7 +6744,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - put: operations["orgs/create-or-update-custom-property"]; + put: operations["orgs/custom-properties-for-repos-create-or-update-organization-definition"]; post?: never; /** * Remove a custom property for an organization @@ -5416,7 +6754,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - delete: operations["orgs/remove-custom-property"]; + delete: operations["orgs/custom-properties-for-repos-delete-organization-definition"]; options?: never; head?: never; patch?: never; @@ -5434,7 +6772,7 @@ export interface paths { * @description Lists organization repositories with all of their custom property values. * Organization members can read these properties. */ - get: operations["orgs/list-custom-properties-values-for-repos"]; + get: operations["orgs/custom-properties-for-repos-get-organization-values"]; put?: never; post?: never; delete?: never; @@ -5453,7 +6791,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-values"]; trace?: never; }; "/orgs/{org}/public_members": { @@ -5632,6 +6970,46 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset history + * @description Get the history of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset version + * @description Get a version of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/secret-scanning/alerts": { parameters: { query?: never; @@ -5656,6 +7034,34 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/secret-scanning/pattern-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization pattern configurations + * @description Lists the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `read:org` scope to use this endpoint. + */ + get: operations["secret-scanning/list-org-pattern-configs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update organization pattern configurations + * @description Updates the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["secret-scanning/update-org-pattern-configs"]; + trace?: never; + }; "/orgs/{org}/security-advisories": { parameters: { query?: never; @@ -5730,7 +7136,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/actions": { + "/orgs/{org}/settings/immutable-releases": { parameters: { query?: never; header?: never; @@ -5738,15 +7144,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get immutable releases settings for an organization + * @description Gets the immutable releases policy for repositories in an organization. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings"]; + /** + * Set immutable releases settings for an organization + * @description Sets the immutable releases policy for repositories in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-actions-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings"]; post?: never; delete?: never; options?: never; @@ -5754,7 +7164,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/packages": { + "/orgs/{org}/settings/immutable-releases/repositories": { parameters: { query?: never; header?: never; @@ -5762,15 +7172,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * List selected repositories for immutable releases enforcement + * @description List all of the repositories that have been selected for immutable releases enforcement in an organization. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings-repositories"]; + /** + * Set selected repositories for immutable releases enforcement + * @description Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-packages-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings-repositories"]; post?: never; delete?: never; options?: never; @@ -5778,25 +7192,29 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/shared-storage": { + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Enable a selected repository for immutable releases in an organization + * @description Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-shared-storage-billing-org"]; - put?: never; + put: operations["orgs/enable-selected-repository-immutable-releases-organization"]; post?: never; - delete?: never; + /** + * Disable a selected repository for immutable releases in an organization + * @description Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/disable-selected-repository-immutable-releases-organization"]; options?: never; head?: never; patch?: never; @@ -5900,7 +7318,7 @@ export interface paths { * > [!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, + * The response contains metrics for up to 100 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. * @@ -5918,42 +7336,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/team/{team_slug}/copilot/usage": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a summary of Copilot usage for a team - * @description > [!NOTE] - * > 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. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - get: operations["copilot/usage-metrics-for-team"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -6019,286 +7401,6 @@ export interface paths { patch: operations["teams/update-in-org"]; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-in-org"]; - put?: never; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-in-org"]; - put?: never; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; - put?: never; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion comment reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-in-org"]; - put?: never; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/invitations": { parameters: { query?: never; @@ -6402,66 +7504,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ - get: operations["teams/list-projects-in-org"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - get: operations["teams/check-permissions-for-project-in-org"]; - /** - * Add or update team project permissions - * @description 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. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - put: operations["teams/add-or-update-project-permissions-in-org"]; - post?: never; - /** - * Remove a project from a team - * @description 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. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - delete: operations["teams/remove-project-in-org"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/repos": { parameters: { query?: never; @@ -6581,227 +7623,6 @@ export interface paths { patch?: never; trace?: never; }; - "/projects/columns/cards/{card_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project card - * @description Gets information about a project card. - */ - get: operations["projects/get-card"]; - put?: never; - post?: never; - /** - * Delete a project card - * @description Deletes a project card - */ - delete: operations["projects/delete-card"]; - options?: never; - head?: never; - /** Update an existing project card */ - patch: operations["projects/update-card"]; - trace?: never; - }; - "/projects/columns/cards/{card_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project card */ - post: operations["projects/move-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project column - * @description Gets information about a project column. - */ - get: operations["projects/get-column"]; - put?: never; - post?: never; - /** - * Delete a project column - * @description Deletes a project column. - */ - delete: operations["projects/delete-column"]; - options?: never; - head?: never; - /** Update an existing project column */ - patch: operations["projects/update-column"]; - trace?: never; - }; - "/projects/columns/{column_id}/cards": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project cards - * @description Lists the project cards in a project. - */ - get: operations["projects/list-cards"]; - put?: never; - /** Create a project card */ - post: operations["projects/create-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project column */ - post: operations["projects/move-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/get"]; - put?: never; - post?: never; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - delete: operations["projects/delete"]; - options?: never; - head?: never; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - patch: operations["projects/update"]; - trace?: never; - }; - "/projects/{project_id}/collaborators": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - get: operations["projects/list-collaborators"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - put: operations["projects/add-collaborator"]; - post?: never; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - delete: operations["projects/remove-collaborator"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}/permission": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - get: operations["projects/get-permission-for-user"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/columns": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project columns - * @description Lists the project columns in a project. - */ - get: operations["projects/list-columns"]; - put?: never; - /** - * Create a project column - * @description Creates a new project column. - */ - post: operations["projects/create-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/rate_limit": { parameters: { query?: never; @@ -6821,6 +7642,7 @@ export interface paths { * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -6849,7 +7671,8 @@ export interface paths { * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * * > [!NOTE] - * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. */ get: operations["repos/get"]; put?: never; @@ -6949,6 +7772,66 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for a repository + * @description Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-repository"]; + /** + * Set GitHub Actions cache retention limit for a repository + * @description Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for a repository + * @description Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-repository"]; + /** + * Set GitHub Actions cache storage limit for a repository + * @description Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/cache/usage": { parameters: { query?: never; @@ -7232,6 +8115,90 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for a repository + * @description Gets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-repository"]; + /** + * Set artifact and log retention settings for a repository + * @description Sets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for a repository + * @description Gets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-repository"]; + /** + * Set fork PR contributor approval permissions for a repository + * @description Sets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for a repository + * @description Gets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-repository"]; + /** + * Set private repo fork PR workflow settings for a repository + * @description Sets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { parameters: { query?: never; @@ -7945,7 +8912,10 @@ export interface paths { }; /** * Get workflow run usage - * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. * @@ -8275,7 +9245,10 @@ export interface paths { }; /** * Get workflow usage - * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -9007,11 +9980,9 @@ export interface paths { put?: never; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; delete?: never; @@ -9128,8 +10099,6 @@ export interface paths { /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; delete?: never; @@ -9236,7 +10205,7 @@ export interface paths { * Commit an autofix for a code scanning alert * @description Commits an autofix for a code scanning alert. * - * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -9865,7 +10834,7 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ put: operations["codespaces/create-or-update-repo-secret"]; post?: never; @@ -9873,7 +10842,7 @@ export interface paths { * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -9891,12 +10860,12 @@ export interface paths { /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. * * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. - * + * The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; @@ -9928,11 +10897,13 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} @@ -9942,6 +10913,8 @@ export interface paths { * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * + * For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + * * **Updating an existing collaborator's permission level** * * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -9959,8 +10932,8 @@ export interface paths { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -9992,13 +10965,15 @@ export interface paths { }; /** * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * @description Checks the repository permission and role of a collaborator. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + * The `role_name` attribute provides the name of the assigned role, including custom roles. The + * `permission` can also be used to determine which base level of access the collaborator has to the repository. + * + * The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. */ get: operations["repos/get-collaborator-permission-level"]; put?: never; @@ -10241,7 +11216,7 @@ export interface paths { }; /** * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ @@ -11121,7 +12096,7 @@ export interface paths { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -11976,6 +12951,35 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Check if immutable releases are enabled for a repository + * @description Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + * enforced by the repository owner. The authenticated user must have admin read access to the repository. + */ + get: operations["repos/check-immutable-releases"]; + /** + * Enable immutable releases + * @description Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + put: operations["repos/enable-immutable-releases"]; + post?: never; + /** + * Disable immutable releases + * @description Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + delete: operations["repos/disable-immutable-releases"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/import": { parameters: { query?: never; @@ -12370,6 +13374,37 @@ export interface paths { patch: operations["issues/update-comment"]; trace?: never; }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Pin an issue comment + * @description You can use the REST API to pin comments on issues. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + put: operations["issues/pin-comment"]; + post?: never; + /** + * Unpin an issue comment + * @description You can use the REST API to unpin comments on issues. + */ + delete: operations["issues/unpin-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { parameters: { query?: never; @@ -12596,6 +13631,105 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocked by + * @description You can use the REST API to list the dependencies an issue is blocked by. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocked-by"]; + put?: never; + /** + * Add a dependency an issue is blocked by + * @description You can use the REST API to add a 'blocked by' relationship to an issue. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-blocked-by-dependency"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove dependency an issue is blocked by + * @description You can use the REST API to remove a dependency that an issue is blocked by. + * + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-dependency-blocked-by"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocking + * @description You can use the REST API to list the dependencies an issue is blocking. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocking"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { parameters: { query?: never; @@ -12635,7 +13769,7 @@ export interface paths { put: operations["issues/set-labels"]; /** * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. + * @description Adds labels to an issue. */ post: operations["issues/add-labels"]; /** @@ -12694,6 +13828,33 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get parent issue + * @description You can use the REST API to get the parent issue of a sub-issue. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/get-parent"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { parameters: { query?: never; @@ -12780,11 +13941,11 @@ export interface paths { * List sub-issues * @description You can use the REST API to list the sub-issues on an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-sub-issues"]; @@ -13358,30 +14519,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/list-for-repo"]; - put?: never; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-repo"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/properties/values": { parameters: { query?: never; @@ -13394,7 +14531,7 @@ export interface paths { * @description Gets all custom property values that are set for a repository. * Users with read access to the repository can use this endpoint. */ - get: operations["repos/get-custom-properties-values"]; + get: operations["repos/custom-properties-for-repos-get-repository-values"]; put?: never; post?: never; delete?: never; @@ -13407,7 +14544,7 @@ export interface paths { * * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ - patch: operations["repos/create-or-update-custom-properties-values"]; + patch: operations["repos/custom-properties-for-repos-create-or-update-repository-values"]; trace?: never; }; "/repos/{owner}/{repo}/pulls": { @@ -14450,6 +15587,46 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset history + * @description Get the history of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset version + * @description Get a version of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/secret-scanning/alerts": { parameters: { query?: never; @@ -14499,6 +15676,8 @@ export interface paths { * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * + * You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + * * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -14565,6 +15744,9 @@ export interface paths { * Get secret scanning scan history for a repository * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * + * > [!NOTE] + * > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-scan-history"]; @@ -14946,66 +16128,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/tags/protection": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Closing down - List tag protection states for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - * - * This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ - get: operations["repos/list-tag-protection"]; - put?: never; - /** - * Closing down - Create a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - * - * This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - post: operations["repos/create-tag-protection"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Closing down - Delete a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - * - * This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - delete: operations["repos/delete-tag-protection"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/tarball/{ref}": { parameters: { query?: never; @@ -15529,250 +16651,6 @@ export interface paths { patch: operations["teams/update-legacy"]; trace?: never; }; - "/teams/{team_id}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-legacy"]; - put?: never; - /** - * Create a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-legacy"]; - put?: never; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; - put?: never; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-legacy"]; - put?: never; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/invitations": { parameters: { query?: never; @@ -15937,70 +16815,6 @@ export interface paths { patch?: never; trace?: never; }; - "/teams/{team_id}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ - get: operations["teams/list-projects-legacy"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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. - */ - get: operations["teams/check-permissions-for-project-legacy"]; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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. - */ - put: operations["teams/add-or-update-project-permissions-legacy"]; - post?: never; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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. - */ - delete: operations["teams/remove-project-legacy"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/repos": { parameters: { query?: never; @@ -16869,7 +17683,7 @@ export interface paths { * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; delete?: never; @@ -17304,26 +18118,6 @@ export interface paths { patch?: never; trace?: never; }; - "/user/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-authenticated-user"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/user/public_emails": { parameters: { query?: never; @@ -17625,6 +18419,26 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{user_id}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for user owned project + * @description Create draft issue item for the specified user owned project. + */ + post: operations["projects/create-draft-item-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -17647,6 +18461,26 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{user_id}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for a user-owned project + * @description Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}": { parameters: { query?: never; @@ -17673,6 +18507,90 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["users/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["users/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["users/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + */ + delete: operations["users/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/attestations/{subject_digest}": { parameters: { query?: never; @@ -18131,7 +19049,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/projects": { + "/users/{username}/projectsV2": { parameters: { query?: never; header?: never; @@ -18139,8 +19057,8 @@ export interface paths { cookie?: never; }; /** - * List user projects - * @description Lists projects for a user. + * List projects for user + * @description List all projects owned by a specific user accessible by the authenticated user. */ get: operations["projects/list-for-user"]; put?: never; @@ -18151,6 +19069,142 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for user + * @description Get a specific user-owned project. + */ + get: operations["projects/get-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for user + * @description List all fields for a specific user-owned project. + */ + get: operations["projects/list-fields-for-user"]; + put?: never; + /** + * Add field to user owned project + * @description Add a field to a specified user owned project. + */ + post: operations["projects/add-field-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for user + * @description Get a specific field for a user-owned project. + */ + get: operations["projects/get-field-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user owned project + * @description List all items for a specific user-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-user"]; + put?: never; + /** + * Add item to user owned project + * @description Add an issue or pull request item to the specified user owned project. + */ + post: operations["projects/add-item-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for a user owned project + * @description Get a specific item from a user-owned project. + */ + get: operations["projects/get-user-item"]; + put?: never; + post?: never; + /** + * Delete project item for user + * @description Delete a specific item from a user-owned project. + */ + delete: operations["projects/delete-item-for-user"]; + options?: never; + head?: never; + /** + * Update project item for user + * @description Update a specific item in a user-owned project. + */ + patch: operations["projects/update-item-for-user"]; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user project view + * @description List items in a user project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/received_events": { parameters: { query?: never; @@ -18216,7 +19270,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/actions": { + "/users/{username}/settings/billing/premium_request/usage": { parameters: { query?: never; header?: never; @@ -18224,14 +19278,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get billing premium request usage report for a user + * @description Gets a report of premium request usage for a user. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-github-actions-billing-user"]; + get: operations["billing/get-github-billing-premium-request-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18240,7 +19292,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/packages": { + "/users/{username}/settings/billing/usage": { parameters: { query?: never; header?: never; @@ -18248,14 +19300,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * Get billing usage report for a user + * @description Gets a report of the total usage for a user. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** This endpoint is only available to users with access to the enhanced billing platform. */ - get: operations["billing/get-github-packages-billing-user"]; + get: operations["billing/get-github-billing-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18264,7 +19314,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/shared-storage": { + "/users/{username}/settings/billing/usage/summary": { parameters: { query?: never; header?: never; @@ -18272,14 +19322,15 @@ export interface paths { cookie?: never; }; /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Get billing usage summary for a user + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Gets a summary report of usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-shared-storage-billing-user"]; + get: operations["billing/get-github-billing-usage-summary-report-user"]; put?: never; post?: never; delete?: never; @@ -18508,13 +19559,13 @@ export interface components { readonly vulnerable_functions: string[] | null; }; "cvss-severities": { - cvss_v3: { + cvss_v3?: { /** @description The CVSS 3 vector string. */ vector_string: string | null; /** @description The CVSS 3 score. */ readonly score: number | null; } | null; - cvss_v4: { + cvss_v4?: { /** @description The CVSS 4 vector string. */ vector_string: string | null; /** @description The CVSS 4 score. */ @@ -18523,8 +19574,8 @@ export interface components { } | null; /** @description The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss). */ "security-advisory-epss": { - percentage: number; - percentile: number; + percentage?: number; + percentile?: number; } | null; /** * Simple User @@ -18705,10 +19756,10 @@ export interface components { * @description Basic Error */ "basic-error": { - message: string; - documentation_url: string; - url: string; - status: string; + message?: string; + documentation_url?: string; + url?: string; + status?: string; }; /** * Validation Error Simple @@ -18821,16 +19872,16 @@ export interface components { * } */ permissions: { - issues: string; - checks: string; - metadata: string; - contents: string; - deployments: string; + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; } & { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" @@ -18838,16 +19889,10 @@ export interface components { */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * Format: uri @@ -18871,10 +19916,10 @@ export interface components { * @description Configuration object of the webhook */ "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"]; + 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"]; }; /** * Simple webhook delivery @@ -18882,6 +19927,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -18928,11 +19974,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -18949,12 +19997,12 @@ export interface components { * @description Scim Error */ "scim-error": { - message: string | null; - documentation_url: string | null; - detail: string | null; - status: number; - scimType: string | null; - schemas: string[]; + message?: string | null; + documentation_url?: string | null; + detail?: string | null; + status?: number; + scimType?: string | null; + schemas?: string[]; }; /** * Validation Error @@ -19098,242 +20146,267 @@ export interface components { * @description The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. * @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** * @description The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. * @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create and retrieve build artifact metadata records. + * @enum {string} + */ + artifact_metadata?: "read" | "write"; + /** + * @description The level of permission to create and retrieve the access token for repository attestations. + * @enum {string} + */ + attestations?: "read" | "write"; /** * @description The level of permission to grant the access token for checks on code. * @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. * @enum {string} */ - codespaces: "read" | "write"; + codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** - * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @description The level of permission to grant the access token to manage Dependabot secrets. * @enum {string} */ - dependabot_secrets: "read" | "write"; + dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; + /** + * @description The level of permission to grant the access token for discussions and related comments and labels. + * @enum {string} + */ + discussions?: "read" | "write"; /** * @description The level of permission to grant the access token for managing repository environments. * @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** * @description The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. * @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the merge queues for a repository. + * @enum {string} + */ + merge_queues?: "read" | "write"; /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. * @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** * @description The level of permission to grant the access token for packages published to GitHub Packages. * @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** * @description The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. * @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** * @description The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. * @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. * @enum {string} */ - repository_custom_properties: "read" | "write"; + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** * @description The level of permission to grant the access token to manage repository projects, columns, and cards. * @enum {string} */ - repository_projects: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token to view and manage secret scanning alerts. * @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** * @description The level of permission to grant the access token to manage repository secrets. * @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage security events like code scanning alerts. * @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** * @description The level of permission to grant the access token to manage just a single file. * @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** * @description The level of permission to grant the access token for commit statuses. * @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** * @description The level of permission to grant the access token to manage Dependabot alerts. * @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** * @description The level of permission to grant the access token to update GitHub Actions workflow files. * @enum {string} */ - workflows: "write"; + workflows?: "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + * @enum {string} + */ + custom_properties_for_organizations?: "read" | "write"; /** * @description The level of permission to grant the access token for organization teams and members. * @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** * @description The level of permission to grant the access token to manage access to an organization. * @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ - organization_custom_roles: "read" | "write"; + organization_custom_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom organization roles management. * @enum {string} */ - organization_custom_org_roles: "read" | "write"; + organization_custom_org_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom property management. + * @description The level of permission to grant the access token for repository custom properties management at the organization level. * @enum {string} */ - organization_custom_properties: "read" | "write" | "admin"; + 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 public preview and is subject to change. * @enum {string} */ - organization_copilot_seat_management: "write"; + organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ - organization_announcement_banners: "read" | "write"; + organization_announcement_banners?: "read" | "write"; /** * @description The level of permission to grant the access token to view events triggered by an activity in an organization. * @enum {string} */ - organization_events: "read"; + organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization. * @enum {string} */ - organization_personal_access_tokens: "read" | "write"; + organization_personal_access_tokens?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization. * @enum {string} */ - organization_personal_access_token_requests: "read" | "write"; + organization_personal_access_token_requests?: "read" | "write"; /** * @description The level of permission to grant the access token for viewing an organization's plan. * @enum {string} */ - organization_plan: "read"; + organization_plan?: "read"; /** * @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"; + organization_projects?: "read" | "write" | "admin"; /** * @description The level of permission to grant the access token for organization packages published to GitHub Packages. * @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** * @description The level of permission to grant the access token to manage organization secrets. * @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. * @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage users blocked by the organization. * @enum {string} */ - organization_user_blocking: "read" | "write"; - /** - * @description The level of permission to grant the access token to manage team discussions and related comments. - * @enum {string} - */ - team_discussions: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the email addresses belonging to a user. * @enum {string} */ - email_addresses: "read" | "write"; + email_addresses?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the followers belonging to a user. * @enum {string} */ - followers: "read" | "write"; + followers?: "read" | "write"; /** * @description The level of permission to grant the access token to manage git SSH keys. * @enum {string} */ - git_ssh_keys: "read" | "write"; + git_ssh_keys?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. * @enum {string} */ - gpg_keys: "read" | "write"; + gpg_keys?: "read" | "write"; /** * @description The level of permission to grant the access token to view and manage interaction limits on a repository. * @enum {string} */ - interaction_limits: "read" | "write"; + interaction_limits?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the profile settings belonging to a user. * @enum {string} */ - profile: "write"; + profile?: "write"; /** * @description The level of permission to grant the access token to list and manage repositories a user is starring. * @enum {string} */ - starring: "read" | "write"; + starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token for organization custom properties management at the enterprise level. + * @enum {string} + */ + enterprise_custom_properties_for_organizations?: "read" | "write" | "admin"; }; /** * Simple User @@ -19442,6 +20515,8 @@ export interface components { html_url: string; /** @example 1 */ app_id: number; + /** @example Iv1.ab1112223334445c */ + client_id?: string; /** @description The ID of the user or organization this token is being scoped to. */ target_id: number; /** @example Organization */ @@ -19730,6 +20805,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -19848,6 +20935,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; }; /** * Installation Token @@ -20375,83 +21467,120 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Actions cache retention limit for an enterprise + * @description GitHub Actions cache retention policy for an enterprise. + */ + "actions-cache-retention-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an enterprise + * @description GitHub Actions cache storage policy for an enterprise. + */ + "actions-cache-storage-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** @description A code security configuration */ "code-security-configuration": { /** @description The ID of the code security configuration */ - id: number; + id?: number; /** @description The name of the code security configuration. Must be unique within the organization. */ - name: string; + name?: string; /** * @description The type of the code security configuration. * @enum {string} */ - target_type: "global" | "organization" | "enterprise"; + target_type?: "global" | "organization" | "enterprise"; /** @description A description of the code security configuration */ - description: string; + description?: string; /** * @description The enablement status of GitHub Advanced Security * @enum {string} */ - advanced_security: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - dependency_graph: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - dependabot_alerts: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - dependabot_security_updates: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal + * @enum {string|null} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set" | null; + /** @description Feature options for code scanning */ + code_scanning_options?: { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** * @description The enablement status of code scanning default setup * @enum {string} */ - code_scanning_default_setup: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; /** @description Feature options for code scanning default setup */ - code_scanning_default_setup_options: { + code_scanning_default_setup_options?: { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string|null} */ - runner_type: "standard" | "labeled" | "not_set" | null; + runner_type?: "standard" | "labeled" | "not_set" | null; /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ - runner_label: string | null; + runner_label?: string | null; } | null; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - secret_scanning: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + 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"; + secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set"; /** @description Feature options for secret scanning delegated bypass */ - secret_scanning_delegated_bypass_options: { + secret_scanning_delegated_bypass_options?: { /** @description The bypass reviewers for secret scanning delegated bypass */ - reviewers: { + reviewers?: { /** @description The ID of the team or role selected as a bypass reviewer */ reviewer_id: number; /** @@ -20459,52 +21588,74 @@ export interface components { * @enum {string} */ reviewer_type: "TEAM" | "ROLE"; + /** @description The ID of the security configuration associated with this bypass reviewer */ + security_configuration_id?: number; }[]; }; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - enforcement: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; /** * Format: uri * @description The URL of the configuration */ - url: string; + url?: string; /** * Format: uri * @description The URL of the configuration */ - html_url: string; + html_url?: string; /** Format: date-time */ - created_at: string; + created_at?: string; /** Format: date-time */ - updated_at: string; + updated_at?: string; }; + /** @description Security Configuration feature options for code scanning */ + "code-scanning-options": { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** @description Feature options for code scanning default setup */ "code-scanning-default-setup-options": { /** * @description Whether to use labeled runners or standard GitHub runners. * @enum {string} */ - runner_type: "standard" | "labeled" | "not_set"; + runner_type?: "standard" | "labeled" | "not_set"; /** @description The label of the runner to use for code scanning default setup when runner_type is 'labeled'. */ - runner_label: string | null; + runner_label?: string | null; } | null; /** @description A list of default code security configurations */ "code-security-default-configurations": { @@ -20512,8 +21663,8 @@ export interface components { * @description The visibility of newly created repositories for which the code security configuration will be applied to by default * @enum {unknown} */ - default_for_new_repos: "public" | "private_and_internal" | "all"; - configuration: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "public" | "private_and_internal" | "all"; + configuration?: components["schemas"]["code-security-configuration"]; }[]; /** * Simple Repository @@ -20763,8 +21914,8 @@ export interface components { * @description The attachment status of the code security configuration on the repository. * @enum {string} */ - status: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - repository: components["schemas"]["simple-repository"]; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + repository?: components["schemas"]["simple-repository"]; }; /** @description The security alert number. */ "alert-number": number; @@ -20893,6 +22044,36 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ "alert-auto-dismissed-at": string | null; + /** + * Dependabot alert dismissal request + * @description Information about an active dismissal request for this Dependabot alert. + */ + "dependabot-alert-dismissal-request-simple": { + /** @description The unique identifier of the dismissal request. */ + id?: number; + /** + * @description The current status of the dismissal request. + * @enum {string} + */ + status?: "pending" | "approved" | "rejected" | "cancelled"; + /** @description The user who requested the dismissal. */ + requester?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The login name of the user. */ + login?: string; + }; + /** + * Format: date-time + * @description The date and time when the dismissal request was created. + */ + created_at?: string; + /** + * Format: uri + * @description The API URL to get more information about this dismissal request. + */ + url?: string; + } | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20903,14 +22084,22 @@ export interface components { readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ readonly dependency: { - package: components["schemas"]["dependabot-alert-package"]; + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ - readonly manifest_path: string; + readonly manifest_path?: string; /** * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ - readonly scope: "development" | "runtime" | null; + readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -20929,81 +22118,86 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "nullable-alert-updated-at": string | null; - /** - * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. - * @enum {string} - */ - "secret-scanning-alert-state": "open" | "resolved"; - /** - * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. - * @enum {string|null} + * Enterprise Team + * @description Group of enterprise owners and/or members */ - "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; - "organization-secret-scanning-alert": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at: components["schemas"]["nullable-alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + description?: string; + slug: string; + /** Format: uri */ + url: string; /** - * Format: uri - * @description The REST API URL of the code locations for this alert. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example disabled | all */ - locations_url: string; - state: components["schemas"]["secret-scanning-alert-state"]; - resolution: components["schemas"]["secret-scanning-alert-resolution"]; + sync_to_organizations?: string; + /** @example disabled | selected | all */ + organization_selection_type?: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id: string | null; /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example Justice League */ - resolved_at: string | null; - resolved_by: components["schemas"]["nullable-simple-user"]; - /** @description The type of secret that secret scanning detected. */ - secret_type: string; + group_name?: string | null; /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league */ - secret_type_display_name: string; - /** @description The secret that was detected. */ - secret: string; - repository: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed: boolean | null; - push_protection_bypassed_by: components["schemas"]["nullable-simple-user"]; + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * Format: uri + * @example https://api.github.com/orgs/github */ - push_protection_bypassed_at: string | null; - push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ - push_protection_bypass_request_reviewer_comment: string | null; - /** @description An optional comment when requesting a push protection bypass. */ - push_protection_bypass_request_comment: string | null; + url: string; /** * Format: uri - * @description The URL to a push protection bypass request. + * @example https://api.github.com/orgs/github/repos */ - push_protection_bypass_request_html_url: string | null; - /** @description The comment that was optionally added when this alert was closed */ - resolution_comment: string | null; + repos_url: string; /** - * @description The token status as of the latest validity check. - * @enum {string} + * Format: uri + * @example https://api.github.com/orgs/github/events */ - 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; + 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; }; /** * Actor @@ -21019,6 +22213,193 @@ export interface components { /** Format: uri */ avatar_url: string; }; + /** + * Label + * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + /** + * Format: int64 + * @description Unique identifier for the label. + * @example 208045946 + */ + id: number; + /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ + node_id: string; + /** + * Format: uri + * @description URL for the label + * @example https://api.github.com/repositories/42/labels/bug + */ + url: string; + /** + * @description The name of the label. + * @example bug + */ + name: string; + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ + description: string | null; + /** + * @description 6-character hex code, without the leading #, identifying the color + * @example FFFFFF + */ + color: string; + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ + default: boolean; + }; + /** + * Discussion + * @description A Discussion in a repository. + */ + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** Reactions */ + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + /** + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} + */ + state: "open" | "closed" | "locked" | "converting" | "transferring"; + /** + * @description The reason for the current state + * @example resolved + * @enum {string|null} + */ + state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + labels?: components["schemas"]["label"][]; + }; /** * Milestone * @description A collection of related issues and pull requests. @@ -21088,6 +22469,37 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -21143,16 +22555,16 @@ export interface components { * } */ permissions: { - issues: string; - checks: string; - metadata: string; - contents: string; - deployments: string; + issues?: string; + checks?: string; + metadata?: string; + contents?: string; + deployments?: string; } & { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" @@ -21160,16 +22572,10 @@ export interface components { */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * author_association @@ -21198,6 +22604,111 @@ export interface components { completed: number; percent_completed: number; }; + /** + * Pinned Issue Comment + * @description Context around who pinned an issue comment and when it was pinned. + */ + "nullable-pinned-issue-comment": { + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + pinned_at: string; + pinned_by: components["schemas"]["nullable-simple-user"]; + } | null; + /** + * Issue Comment + * @description Comments provide a way for people to collaborate on an issue. + */ + "nullable-issue-comment": { + /** + * Format: int64 + * @description Unique identifier of the issue comment + * @example 42 + */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the issue comment + * @example https://api.github.com/repositories/42/issues/comments/1 + */ + url: string; + /** + * @description Contents of the issue comment + * @example What version of Safari were you using when you observed this bug? + */ + body?: string; + body_text?: string; + body_html?: string; + /** Format: uri */ + html_url: string; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + updated_at: string; + /** Format: uri */ + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + } | null; + /** Issue Dependencies Summary */ + "issue-dependencies-summary": { + blocked_by: number; + blocking: number; + total_blocked_by: number; + total_blocking: number; + }; + /** + * Issue Field Value + * @description A value assigned to an issue field + */ + "issue-field-value": { + /** + * Format: int64 + * @description Unique identifier for the issue field. + * @example 1 + */ + issue_field_id: number; + /** @example IFT_GDKND */ + node_id: string; + /** + * @description The data type of the issue field + * @example text + * @enum {string} + */ + data_type: "text" | "single_select" | "number" | "date"; + /** @description The value of the issue field */ + value: (string | number) | null; + /** @description Details about the selected option (only present for single_select fields) */ + single_select_option?: { + /** + * Format: int64 + * @description Unique identifier for the option. + * @example 1 + */ + id: number; + /** + * @description The name of the option + * @example High + */ + name: string; + /** + * @description The color of the option + * @example red + */ + color: string; + } | null; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -21236,7 +22747,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -21257,14 +22768,14 @@ export interface components { */ labels: (string | { /** Format: int64 */ - id: number; - node_id: string; + id?: number; + node_id?: string; /** Format: uri */ - url: string; - name: string; - description: string | null; - color: string | null; - default: boolean; + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; @@ -21296,11 +22807,20 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; }; /** * Issue Comment @@ -21342,9 +22862,132 @@ export interface components { updated_at: string; /** Format: uri */ issue_url: string; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + }; + /** Pull Request Minimal */ + "pull-request-minimal": { + /** Format: int64 */ + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + }; + /** + * Release Asset + * @description Data related to a release. + */ + "release-asset": { + /** Format: uri */ + url: string; + /** Format: uri */ + browser_download_url: string; + id: number; + node_id: string; + /** + * @description The file name of the asset. + * @example Team Environment + */ + name: string; + label: string | null; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded" | "open"; + content_type: string; + size: number; + digest: string | null; + download_count: number; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + uploader: components["schemas"]["nullable-simple-user"]; + }; + /** + * Release + * @description A release. + */ + release: { + /** Format: uri */ + url: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + assets_url: string; + upload_url: string; + /** Format: uri */ + tarball_url: string | null; + /** Format: uri */ + zipball_url: string | null; + id: number; + node_id: string; + /** + * @description The name of the tag. + * @example v1.0.0 + */ + tag_name: string; + /** + * @description Specifies the commitish value that determines where the Git tag is created from. + * @example master + */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ + draft: boolean; + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ + prerelease: boolean; + /** + * @description Whether or not the release is immutable. + * @example false + */ + immutable?: boolean; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + published_at: string | null; + /** Format: date-time */ + updated_at?: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + mentions_count?: number; + /** + * Format: uri + * @description The URL of the release discussion. + */ + discussion_url?: string; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Event @@ -21361,19 +23004,7 @@ export interface components { url: string; }; org?: components["schemas"]["actor"]; - payload: { - action: string; - issue: components["schemas"]["issue"]; - comment: components["schemas"]["issue-comment"]; - pages: { - page_name: string; - title: string; - summary: string | null; - action: string; - sha: string; - html_url: string; - }[]; - }; + payload: components["schemas"]["create-event"] | components["schemas"]["delete-event"] | components["schemas"]["discussion-event"] | components["schemas"]["issues-event"] | components["schemas"]["issue-comment-event"] | components["schemas"]["fork-event"] | components["schemas"]["gollum-event"] | components["schemas"]["member-event"] | components["schemas"]["public-event"] | components["schemas"]["push-event"] | components["schemas"]["pull-request-event"] | components["schemas"]["pull-request-review-comment-event"] | components["schemas"]["pull-request-review-event"] | components["schemas"]["commit-comment-event"] | components["schemas"]["release-event"] | components["schemas"]["watch-event"]; public: boolean; /** Format: date-time */ created_at: string | null; @@ -21455,11 +23086,11 @@ export interface components { html_url: string; files: { [key: string]: { - filename: string; - type: string; - language: string; - raw_url: string; - size: number; + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 @@ -21561,17 +23192,17 @@ export interface components { * @description Gist History */ "gist-history": { - user: components["schemas"]["nullable-simple-user"]; - version: string; + user?: components["schemas"]["nullable-simple-user"]; + version?: string; /** Format: date-time */ - committed_at: string; - change_status: { - total: number; - additions: number; - deletions: number; + committed_at?: string; + change_status?: { + total?: number; + additions?: number; + deletions?: number; }; /** Format: uri */ - url: string; + url?: string; }; /** * Gist Simple @@ -21579,23 +23210,23 @@ export interface components { */ "gist-simple": { /** @deprecated */ - forks: { - id: string; + forks?: { + id?: string; /** Format: uri */ - url: string; - user: components["schemas"]["public-user"]; + url?: string; + user?: components["schemas"]["public-user"]; /** Format: date-time */ - created_at: string; + created_at?: string; /** Format: date-time */ - updated_at: string; + updated_at?: string; }[] | null; /** @deprecated */ - history: components["schemas"]["gist-history"][] | null; + history?: components["schemas"]["gist-history"][] | null; /** * Gist * @description Gist */ - fork_of: { + fork_of?: { /** Format: uri */ url: string; /** Format: uri */ @@ -21612,11 +23243,11 @@ export interface components { html_url: string; files: { [key: string]: { - filename: string; - type: string; - language: string; - raw_url: string; - size: number; + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; }; }; public: boolean; @@ -21635,23 +23266,23 @@ export interface components { forks?: unknown[]; history?: unknown[]; } | null; - url: string; - forks_url: string; - commits_url: string; - id: string; - node_id: string; - git_pull_url: string; - git_push_url: string; - html_url: string; - files: { + url?: string; + forks_url?: string; + commits_url?: string; + id?: string; + node_id?: string; + git_pull_url?: string; + git_push_url?: string; + html_url?: string; + files?: { [key: string]: { - filename: string; - type: string; - language: string; - raw_url: string; - size: number; - truncated: boolean; - content: string; + filename?: string; + type?: string; + language?: string; + raw_url?: string; + size?: number; + truncated?: boolean; + content?: string; /** * @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. * @default utf-8 @@ -21659,16 +23290,16 @@ export interface components { encoding: string; } | null; }; - public: boolean; - created_at: string; - updated_at: string; - description: string | null; - comments: number; - comments_enabled: boolean; - user: string | null; - comments_url: string; - owner: components["schemas"]["simple-user"]; - truncated: boolean; + public?: boolean; + created_at?: string; + updated_at?: string; + description?: string | null; + comments?: number; + comments_enabled?: boolean; + user?: string | null; + comments_url?: string; + owner?: components["schemas"]["simple-user"]; + truncated?: boolean; }; /** * Gist Comment @@ -21716,9 +23347,9 @@ export interface components { version: string; user: components["schemas"]["nullable-simple-user"]; change_status: { - total: number; - additions: number; - deletions: number; + total?: number; + additions?: number; + deletions?: number; }; /** * Format: date-time @@ -21908,21 +23539,21 @@ export interface components { organization_billing_email?: string; email?: string | null; marketplace_pending_change?: { - is_installed: boolean; - effective_date: string; - unit_count: number | null; - id: number; - plan: components["schemas"]["marketplace-listing-plan"]; + is_installed?: boolean; + effective_date?: string; + unit_count?: number | null; + id?: number; + plan?: components["schemas"]["marketplace-listing-plan"]; } | null; marketplace_purchase: { - billing_cycle: string; - next_billing_date: string | null; - is_installed: boolean; - unit_count: number | null; - on_free_trial: boolean; - free_trial_ends_on: string | null; - updated_at: string; - plan: components["schemas"]["marketplace-listing-plan"]; + billing_cycle?: string; + next_billing_date?: string | null; + is_installed?: boolean; + unit_count?: number | null; + on_free_trial?: boolean; + free_trial_ends_on?: string | null; + updated_at?: string; + plan?: components["schemas"]["marketplace-listing-plan"]; }; }; /** @@ -21933,10 +23564,10 @@ export interface components { /** @example true */ verifiable_password_authentication: boolean; ssh_key_fingerprints?: { - SHA256_RSA: string; - SHA256_DSA: string; - SHA256_ECDSA: string; - SHA256_ED25519: string; + SHA256_RSA?: string; + SHA256_DSA?: string; + SHA256_ECDSA?: string; + SHA256_ED25519?: string; }; /** * @example [ @@ -22023,54 +23654,83 @@ export interface components { */ copilot?: string[]; domains?: { - website: string[]; - codespaces: string[]; - copilot: string[]; - packages: string[]; - actions: string[]; - actions_inbound: { - full_domains: string[]; - wildcard_domains: string[]; + website?: string[]; + codespaces?: string[]; + copilot?: string[]; + packages?: string[]; + actions?: string[]; + actions_inbound?: { + full_domains?: string[]; + wildcard_domains?: string[]; }; - artifact_attestations: { + artifact_attestations?: { /** * @example [ * "example" * ] */ - trust_domain: string; - services: string[]; + trust_domain?: string; + services?: string[]; }; }; }; "security-and-analysis": { - advanced_security: { + /** + * @description Enable or disable GitHub Advanced Security for the repository. + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ + advanced_security?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + code_security?: { /** @enum {string} */ - status: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; /** @description Enable or disable Dependabot security updates for the repository. */ - dependabot_security_updates: { + dependabot_security_updates?: { /** * @description The enablement status of Dependabot security updates for the repository. * @enum {string} */ - status: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + secret_scanning?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_push_protection?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; }; - secret_scanning: { + secret_scanning_non_provider_patterns?: { /** @enum {string} */ - status: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - secret_scanning_push_protection: { + secret_scanning_ai_detection?: { /** @enum {string} */ - status: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - secret_scanning_non_provider_patterns: { + secret_scanning_delegated_alert_dismissal?: { /** @enum {string} */ - status: "enabled" | "disabled"; + status?: "enabled" | "disabled"; }; - secret_scanning_ai_detection: { + secret_scanning_delegated_bypass?: { /** @enum {string} */ - status: "enabled" | "disabled"; + status?: "enabled" | "disabled"; + }; + 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"; + }[]; }; } | null; /** @@ -22237,6 +23897,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -22256,11 +23922,11 @@ export interface components { */ updated_at?: string | null; permissions?: { - admin: boolean; - maintain: boolean; - push: boolean; - triage: boolean; - pull: boolean; + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; /** @example admin */ role_name?: string; @@ -22270,11 +23936,11 @@ export interface components { network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; license?: { - key: string; - name: string; - spdx_id: string; - url: string; - node_id: string; + key?: string; + name?: string; + spdx_id?: string; + url?: string | null; + node_id?: string; } | null; /** @example 0 */ forks?: number; @@ -22286,6 +23952,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Thread @@ -22339,46 +24009,435 @@ export interface components { repository_url?: string; }; /** - * Organization Simple - * @description A GitHub organization. + * Actions cache retention limit for an organization + * @description GitHub Actions cache retention policy for an organization. */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ + "actions-cache-retention-limit-for-organization": { + /** + * @description For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an organization + * @description GitHub Actions cache storage policy for an organization. + */ + "actions-cache-storage-limit-for-organization": { + /** + * @description For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; + /** + * Simple Repository + * @description A GitHub repository. + */ + "nullable-simple-repository": { + /** + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 + */ id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ url: string; + /** + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + */ + archive_url: string; + /** + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} + */ + assignees_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + */ + blobs_url: string; + /** + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} + */ + branches_url: string; + /** + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + */ + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - repos_url: string; + contributors_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments + */ + deployments_url: string; + /** + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads + */ + downloads_url: string; + /** + * Format: uri + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ + /** + * Format: uri + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks + */ + forks_url: string; + /** + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + */ + git_commits_url: string; + /** + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + */ + git_refs_url: string; + /** + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + */ + git_tags_url: string; + /** + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + */ + issue_comment_url: string; + /** + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + */ + issue_events_url: string; + /** + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} + */ 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; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; + } | null; + /** + * Dependabot Repository Access Details + * @description Information about repositories that Dependabot is able to access in an organization + */ + "dependabot-repository-access-details": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string|null} + */ + default_level?: "public" | "internal" | null; + accessible_repositories?: components["schemas"]["nullable-simple-repository"][]; }; - "billing-usage-report": { + budget: { + /** + * @description The unique identifier for the budget + * @example 2066deda-923f-43f9-88d2-62395a28c0cdd + */ + id: string; + /** + * @description The type of pricing for the budget + * @example SkuPricing + * @enum {string} + */ + budget_type: "SkuPricing" | "ProductPricing"; + /** @description The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description The type of limit enforcement for the budget + * @example true + */ + prevent_further_usage: boolean; + /** + * @description The scope of the budget (enterprise, organization, repository, cost center) + * @example enterprise + */ + budget_scope: string; + /** + * @description The name of the entity for the budget (enterprise does not require a name). + * @example octocat/hello-world + */ + budget_entity_name?: string; + /** @description A single product or sku to apply the budget to. */ + budget_product_sku: string; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients: string[]; + }; + }; + get_all_budgets: { + /** @description Array of budget objects for the enterprise */ + budgets: components["schemas"]["budget"][]; + /** @description Indicates if there are more pages of results available (maps to hasNextPage from billing platform) */ + has_next_page?: boolean; + /** @description Total number of budgets matching the query */ + total_count?: number; + }; + "get-budget": { + /** @description ID of the budget. */ + id: string; + /** + * @description The type of scope for the budget + * @example enterprise + * @enum {string} + */ + budget_scope: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @example octocat/hello-world + */ + budget_entity_name: string; + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description Whether to prevent additional spending once the budget is exceeded + * @example true + */ + prevent_further_usage: boolean; + /** + * @description A single product or sku to apply the budget to. + * @example actions_linux + */ + budget_product_sku: string; + /** + * @description The type of pricing for the budget + * @example ProductPricing + * @enum {string} + */ + budget_type: "ProductPricing" | "SkuPricing"; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert?: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients?: string[]; + }; + }; + "delete-budget": { + /** @description A message indicating the result of the deletion operation */ + message: string; + /** @description The ID of the deleted budget */ + id: string; + }; + "billing-premium-request-usage-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the user for the usage report. */ + user?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report": { + usageItems?: { /** @description Date of the usage line item. */ date: string; /** @description Product name. */ @@ -22403,6 +24462,46 @@ export interface components { repositoryName?: string; }[]; }; + "billing-usage-summary-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22508,6 +24607,11 @@ export interface components { seats?: number; }; default_repository_permission?: string | null; + /** + * @description The default branch for repositories created in this organization. + * @example main + */ + default_repository_branch?: string | null; /** @example true */ members_can_create_repositories?: boolean | null; /** @example true */ @@ -22526,6 +24630,22 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; + /** @example true */ + members_can_delete_repositories?: boolean; + /** @example true */ + members_can_change_repo_visibility?: boolean; + /** @example true */ + members_can_invite_outside_collaborators?: boolean; + /** @example true */ + members_can_delete_issues?: boolean; + /** @example true */ + display_commenter_full_name_setting_enabled?: boolean; + /** @example true */ + readers_can_create_discussions?: boolean; + /** @example true */ + members_can_create_teams?: boolean; + /** @example true */ + members_can_view_dependency_insights?: boolean; /** @example false */ members_can_fork_private_repositories?: boolean | null; /** @example false */ @@ -22671,7 +24791,7 @@ export interface components { * @description The image version of the hosted runner pool. * @example latest */ - version: string; + version?: string; } | null; /** * Github-owned VM details. @@ -22708,17 +24828,17 @@ export interface components { * @description Whether public IP is enabled. * @example true */ - enabled: boolean; + enabled?: boolean; /** * @description The prefix for the public IP. * @example 20.80.208.150 */ - prefix: string; + prefix?: string; /** * @description The length of the IP prefix. * @example 28 */ - length: number; + length?: number; }; /** * GitHub-hosted hosted runner @@ -22772,12 +24892,91 @@ export interface components { * @example 2022-10-09T23:39:01Z */ last_active_on?: string | null; + /** @description Whether custom image generation is enabled for the hosted runners. */ + image_gen?: boolean; + }; + /** + * GitHub-hosted runner custom image details + * @description Provides details of a custom runner image + */ + "actions-hosted-runner-custom-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example 1 + */ + id: number; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Total size of all the image versions in GB. + * @example 200 + */ + total_versions_size: number; + /** + * @description Display name for this image. + * @example CustomImage + */ + name: string; + /** + * @description The image provider. + * @example custom + */ + source: string; + /** + * @description The number of image versions associated with the image. + * @example 4 + */ + versions_count: number; + /** + * @description The latest image version associated with the image. + * @example 1.3.0 + */ + latest_version: string; + /** + * @description The number of image versions associated with the image. + * @example Ready + */ + state: string; + }; + /** + * GitHub-hosted runner custom image version details. + * @description Provides details of a hosted runner custom image version + */ + "actions-hosted-runner-custom-image-version": { + /** + * @description The version of image. + * @example 1.0.0 + */ + version: string; + /** + * @description The state of image version. + * @example Ready + */ + state: string; + /** + * @description Image version size in GB. + * @example 30 + */ + size_gb: number; + /** + * @description The creation date time of the image version. + * @example 2024-11-09T23:39:01Z + */ + created_on: string; + /** + * @description The image version status details. + * @example None + */ + state_details: string; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - "actions-hosted-runner-image": { + "actions-hosted-runner-curated-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 @@ -22847,25 +25046,74 @@ export interface components { "allowed-actions": "all" | "local_only" | "selected"; /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */ "selected-actions-url": string; + /** @description Whether actions must be pinned to a full-length commit SHA. */ + "sha-pinning-required": boolean; "actions-organization-permissions": { enabled_repositories: components["schemas"]["enabled-repositories"]; /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ selected_repositories_url?: string; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + "actions-artifact-and-log-retention-response": { + /** @description The number of days artifacts and logs are retained */ + days: number; + /** @description The maximum number of days that can be configured */ + maximum_allowed_days: number; + }; + "actions-artifact-and-log-retention": { + /** @description The number of days to retain artifacts and logs */ + days: number; + }; + "actions-fork-pr-contributor-approval": { + /** + * @description The policy that controls when fork PR workflows require approval from a maintainer. + * @enum {string} + */ + approval_policy: "first_time_contributors_new_to_github" | "first_time_contributors" | "all_external_contributors"; + }; + "actions-fork-pr-workflows-private-repos": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows: boolean; + }; + "actions-fork-pr-workflows-private-repos-request": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows?: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables?: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows?: boolean; }; "selected-actions": { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ - github_owned_allowed: boolean; + github_owned_allowed?: boolean; /** @description Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. */ - verified_allowed: boolean; + verified_allowed?: boolean; /** * @description Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. * * > [!NOTE] * > The `patterns_allowed` setting only applies to public repositories. */ - patterns_allowed: string[]; + patterns_allowed?: string[]; + }; + "self-hosted-runners-settings": { + /** + * @description The policy that controls whether self-hosted runners can be used by repositories in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + /** @description The URL to the endpoint for managing selected repositories for self-hosted runners in the organization */ + selected_repositories_url?: string; }; /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows. @@ -22879,8 +25127,8 @@ export interface components { can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; }; "actions-set-default-workflow-permissions": { - default_workflow_permissions: components["schemas"]["actions-default-workflow-permissions"]; - can_approve_pull_request_reviews: components["schemas"]["actions-can-approve-pull-request-reviews"]; + 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; @@ -22930,12 +25178,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -22956,6 +25204,7 @@ export interface components { status: string; busy: boolean; labels: components["schemas"]["runner-label"][]; + ephemeral?: boolean; }; /** * Runner Application @@ -23090,6 +25339,219 @@ export interface components { */ selected_repositories_url?: string; }; + /** + * Artifact Deployment Record + * @description Artifact Metadata Deployment Record + */ + "artifact-deployment-record": { + id?: number; + digest?: string; + logical_environment?: string; + physical_environment?: string; + cluster?: string; + deployment_name?: string; + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + created_at?: string; + updated_at?: string; + /** @description The ID of the provenance attestation associated with the deployment record. */ + attestation_id?: number | null; + }; + /** + * Campaign state + * @description Indicates whether a campaign is open or closed + * @enum {string} + */ + "campaign-state": "open" | "closed"; + /** + * Campaign alert type + * @description Indicates the alert type of a campaign + * @enum {string} + */ + "campaign-alert-type": "code_scanning" | "secret_scanning"; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "nullable-team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; + /** + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 + */ + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Campaign summary + * @description The campaign metadata and alert stats. + */ + "campaign-summary": { + /** @description The number of the newly created campaign */ + number: number; + /** + * Format: date-time + * @description The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** @description The campaign name */ + name?: string; + /** @description The campaign description */ + description: string; + /** @description The campaign managers */ + managers: components["schemas"]["simple-user"][]; + /** @description The campaign team managers */ + team_managers?: components["schemas"]["team"][]; + /** + * Format: date-time + * @description The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + published_at?: string; + /** + * Format: date-time + * @description The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at: string; + /** + * Format: date-time + * @description The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + */ + closed_at?: string | null; + state: components["schemas"]["campaign-state"]; + /** + * Format: uri + * @description The contact link of the campaign. + */ + contact_link: string | null; + alert_stats?: { + /** @description The number of open alerts */ + open_count: number; + /** @description The number of closed alerts */ + closed_count: number; + /** @description The number of in-progress alerts */ + in_progress_count: number; + }; + }; /** @description The name of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-name": string; /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ @@ -23123,36 +25585,36 @@ export interface components { "code-scanning-alert-dismissed-comment": string | null; "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ - id: string | null; + id?: string | null; /** @description The name of the rule used to detect the alert. */ - name: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - severity: "none" | "note" | "warning" | "error" | null; + severity?: "none" | "note" | "warning" | "error" | null; /** * @description The security severity of the alert. * @enum {string|null} */ - security_severity_level: "low" | "medium" | "high" | "critical" | null; + security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ - description: string; + description?: string; /** @description A description of the rule used to detect the alert. */ - full_description: string; + full_description?: string; /** @description A set of tags applicable for the rule. */ - tags: string[] | null; + tags?: string[] | null; /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help: string | null; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri: string | null; + help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; "code-scanning-analysis-tool": { - name: components["schemas"]["code-scanning-analysis-tool-name"]; - version: components["schemas"]["code-scanning-analysis-tool-version"]; - guid: components["schemas"]["code-scanning-analysis-tool-guid"]; + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + version?: components["schemas"]["code-scanning-analysis-tool-version"]; + guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; }; /** * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, @@ -23167,11 +25629,11 @@ export interface components { "code-scanning-analysis-category": string; /** @description Describe a region within a file for the alert. */ "code-scanning-alert-location": { - path: string; - start_line: number; - end_line: number; - start_column: number; - end_column: number; + path?: string; + start_line?: number; + end_line?: number; + start_column?: number; + end_column?: number; }; /** * @description A classification of the file. For example to identify it as generated. @@ -23179,22 +25641,22 @@ export interface components { */ "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; "code-scanning-alert-instance": { - ref: components["schemas"]["code-scanning-ref"]; - analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment: components["schemas"]["code-scanning-alert-environment"]; - category: components["schemas"]["code-scanning-analysis-category"]; - state: components["schemas"]["code-scanning-alert-state"]; - commit_sha: string; - message: { - text: string; + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-state"]; + commit_sha?: string; + message?: { + text?: string; }; - location: components["schemas"]["code-scanning-alert-location"]; - html_url: string; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; /** * @description Classifications that have been applied to the file that triggered the alert. * For example identifying it as documentation, or a generated file. */ - classifications: components["schemas"]["code-scanning-alert-classification"][]; + classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; "code-scanning-organization-alert-items": { number: components["schemas"]["alert-number"]; @@ -23213,6 +25675,8 @@ export interface components { tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * Codespace machine @@ -23328,21 +25792,21 @@ export interface components { * @description The number of commits the local repository is ahead of the remote. * @example 0 */ - ahead: number; + ahead?: number; /** * @description The number of commits the local repository is behind the remote. * @example 0 */ - behind: number; + behind?: number; /** @description Whether the local repository has unpushed changes. */ - has_unpushed_changes: boolean; + has_unpushed_changes?: boolean; /** @description Whether the local repository has uncommitted changes. */ - has_uncommitted_changes: boolean; + has_uncommitted_changes?: boolean; /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - ref: string; + ref?: string; }; /** * @description The initally assigned location of a new codespace. @@ -23388,7 +25852,7 @@ export interface components { recent_folders: string[]; runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - allowed_port_privacy_settings: string[] | null; + allowed_port_privacy_settings?: string[] | null; }; /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ pending_operation?: boolean | null; @@ -23470,46 +25934,46 @@ export interface components { created_at?: string; }; /** - * Copilot Business Seat Breakdown + * Copilot Seat Breakdown * @description The breakdown of Copilot Business seats for the organization. */ - "copilot-seat-breakdown": { + "copilot-organization-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ - total: number; + total?: number; /** @description Seats added during the current billing cycle. */ - added_this_cycle: number; + added_this_cycle?: number; /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ - pending_cancellation: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ - pending_invitation: number; + pending_cancellation?: number; + /** @description The number of users who have been invited to receive a Copilot seat through this organization. */ + pending_invitation?: number; /** @description The number of seats that have used Copilot during the current billing cycle. */ - active_this_cycle: number; + active_this_cycle?: number; /** @description The number of seats that have not used Copilot during the current billing cycle. */ - inactive_this_cycle: number; + inactive_this_cycle?: number; }; /** * 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"]; + seat_breakdown: components["schemas"]["copilot-organization-seat-breakdown"]; /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @description The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). * @enum {string} */ - public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + public_code_suggestions: "allow" | "block" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @description The organization policy for allowing or disallowing Copilot Chat in the IDE. * @enum {string} */ ide_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @description The organization policy for allowing or disallowing Copilot features on GitHub.com. * @enum {string} */ platform_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @description The organization policy for allowing or disallowing Copilot CLI. * @enum {string} */ cli?: "enabled" | "disabled" | "unconfigured"; @@ -23522,7 +25986,7 @@ export interface components { * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ - plan_type?: "business" | "enterprise" | "unknown"; + plan_type?: "business" | "enterprise"; } & { [key: string]: unknown; }; @@ -23565,135 +26029,12 @@ export interface components { /** @example A great organization */ description: string | null; } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; - /** @example Justice League */ - group_name?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league - */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; + assignee?: components["schemas"]["nullable-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; @@ -23709,6 +26050,11 @@ export interface components { last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + */ + last_authenticated_at?: string | null; /** * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. @@ -23726,46 +26072,53 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; + /** + * Copilot Organization Content Exclusion Details + * @description List all Copilot Content Exclusion rules for an organization. + */ + "copilot-organization-content-exclusion-details": { + [key: string]: string[]; + }; /** @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; + total_engaged_users?: number; /** @description Code completion metrics for active languages. */ - languages: { + languages?: { /** @description Name of the language used for Copilot code completion suggestions. */ - name: string; + 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; + total_engaged_users?: number; }[]; - editors: ({ + editors?: ({ /** @description Name of the given editor. */ - name: string; + 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; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - models: { + models?: { /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - name: string; + name?: string; /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - custom_model_training_date: string | null; + 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; + total_engaged_users?: number; /** @description Code completion metrics for active languages, for the given editor. */ - languages: { + languages?: { /** @description Name of the language used for Copilot code completion suggestions, for the given editor. */ - name: string; + 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; + total_engaged_users?: number; /** @description The number of Copilot code suggestions generated for the given editor, for the given language. */ - total_code_suggestions: number; + 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; + 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; + 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; + total_code_lines_accepted?: number; }[]; }[]; } & { @@ -23777,49 +26130,49 @@ export interface components { /** @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: { + total_engaged_users?: number; + editors?: { /** @description Name of the given editor. */ - name: string; + name?: string; /** @description The number of users who prompted Copilot Chat in the specified editor. */ - total_engaged_users: number; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - models: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - name: string; + models?: { + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - custom_model_training_date: string | null; + 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; + total_engaged_users?: number; /** @description The total number of chats initiated by users in the given editor and model. */ - total_chats: number; + 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; + 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; + total_chat_copy_events?: number; }[]; }[]; } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** @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; + total_engaged_users?: number; /** @description List of model metrics for a custom models and the default model. */ - models: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - name: string; + models?: { + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model (if applicable). */ - custom_model_training_date: string | null; + 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; + total_engaged_users?: number; /** @description Total number of chats initiated by users on github.com. */ - total_chats: number; + total_chats?: number; }[]; } & { [key: string]: unknown; @@ -23827,25 +26180,25 @@ export interface components { /** @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; + total_engaged_users?: number; /** @description Repositories in which users used Copilot for Pull Requests to generate pull request summaries */ - repositories: { + repositories?: { /** @description Repository name */ - name: string; + 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; + total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ - models: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ - name: string; + models?: { + /** @description Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. */ + name?: string; /** @description Indicates whether a model is custom or default. */ - is_custom_model: boolean; + is_custom_model?: boolean; /** @description The training date for the custom model. */ - custom_model_training_date: string | null; + 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; + 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; + total_engaged_users?: number; }[]; }[]; } & { @@ -23872,52 +26225,6 @@ export interface components { } & { [key: string]: unknown; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { - /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users: number; - } & { - [key: string]: unknown; - })[] | null; - }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -24123,6 +26430,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -24142,11 +26455,11 @@ export interface components { */ updated_at?: string | null; permissions?: { - admin: boolean; - maintain: boolean; - push: boolean; - triage: boolean; - pull: boolean; + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; /** @example admin */ role_name?: string; @@ -24156,11 +26469,11 @@ export interface components { network_count?: number; code_of_conduct?: components["schemas"]["code-of-conduct"]; license?: { - key: string; - name: string; - spdx_id: string; - url: string; - node_id: string; + key?: string; + name?: string; + spdx_id?: string; + url?: string | null; + node_id?: string; } | null; /** @example 0 */ forks?: number; @@ -24172,6 +26485,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; } | null; /** * Package @@ -24271,13 +26588,13 @@ export interface components { active: boolean; config: { /** @example "http://example.com/2" */ - url: string; + url?: string; /** @example "0" */ - insecure_ssl: string; + insecure_ssl?: string; /** @example "form" */ - content_type: string; + content_type?: string; /** @example "********" */ - secret: string; + secret?: string; }; /** * Format: date-time @@ -24297,35 +26614,35 @@ export interface components { */ "api-insights-route-stats": { /** @description The HTTP method */ - http_method: string; + http_method?: string; /** @description The API path's route template */ - api_route: string; + api_route?: string; /** * Format: int64 * @description The total number of requests within the queried time period */ - total_request_count: number; + 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; + 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; + 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; + subject_id?: number; + total_request_count?: number; + rate_limited_request_count?: number; + last_rate_limited_timestamp?: string | null; + last_request_timestamp?: string; }[]; /** * Summary Stats @@ -24336,41 +26653,41 @@ export interface components { * Format: int64 * @description The total number of requests within the queried time period */ - total_request_count: number; + 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; + rate_limited_request_count?: number; }; /** * Time Stats * @description API Insights usage time stats for an organization */ "api-insights-time-stats": { - timestamp: string; + timestamp?: string; /** Format: int64 */ - total_request_count: number; + total_request_count?: number; /** Format: int64 */ - rate_limited_request_count: number; + 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; + actor_type?: string; + actor_name?: string; /** Format: int64 */ - actor_id: number; + actor_id?: number; /** Format: int64 */ - integration_id: number | null; + 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; + 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. @@ -24406,6 +26723,32 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; /** * Org Membership * @description Org Membership @@ -24428,6 +26771,20 @@ export interface components { * @enum {string} */ role: "admin" | "member" | "billing_manager"; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; /** * Format: uri * @example https://api.github.com/orgs/octocat @@ -24560,6 +26917,21 @@ export interface components { /** Format: uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Team Simple @@ -24623,6 +26995,21 @@ export interface components { * @example uid=example,ou=users,dc=github,dc=com */ ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * A Role Assignment for a User @@ -24778,13 +27165,13 @@ export interface components { repositories_url: string; /** @description Permissions requested, categorized by type of permission. */ permissions: { - organization: { + organization?: { [key: string]: string; }; - repository: { + repository?: { [key: string]: string; }; - other: { + other?: { [key: string]: string; }; }; @@ -24818,13 +27205,13 @@ export interface components { repositories_url: string; /** @description Permissions requested, categorized by type of permission. */ permissions: { - organization: { + organization?: { [key: string]: string; }; - repository: { + repository?: { [key: string]: string; }; - other: { + other?: { [key: string]: string; }; }; @@ -24855,12 +27242,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string | null; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. * @enum {string} @@ -24885,12 +27282,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} @@ -24904,69 +27311,568 @@ export interface components { updated_at: string; }; /** - * Project - * @description Projects are a way to organize columns and cards of work. + * Projects v2 Status Update + * @description An status update belonging to a project */ - project: { + "nullable-projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test + * Format: date-time + * @description The time when the status update was created. + * @example 2022-04-28T12:00:00Z */ - owner_url: string; + created_at: string; + /** + * Format: date-time + * @description The time when the status update was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @description The start date of the period covered by the update. + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @description The target date associated with the update. + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + } | null; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + /** @description The unique identifier of the project. */ + id: number; + /** @description The node ID of the project. */ + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + /** @description The project title. */ + title: string; + /** @description A short description of the project. */ + description: string | null; + /** @description Whether the project is visible to anyone with access to the owner. */ + public: boolean; + /** + * Format: date-time + * @description The time when the project was closed. + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @description The time when the project was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the project was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @description The project number. */ + number: number; + /** @description A concise summary of the project. */ + short_description: string | null; + /** + * Format: date-time + * @description The time when the project was deleted. + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: components["schemas"]["nullable-simple-user"]; + /** + * @description The current state of the project. + * @enum {string} + */ + state?: "open" | "closed"; + latest_status_update?: components["schemas"]["nullable-projects-v2-status-update"]; + /** @description Whether this project is a template */ + is_template?: boolean; + }; + /** + * Link + * @description Hypermedia Link + */ + link: { + href: string; + }; + /** + * Auto merge + * @description The status of auto merging a pull request. + */ + "auto-merge": { + enabled_by: components["schemas"]["simple-user"]; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + /** @description Title for the merge commit message. */ + commit_title: string; + /** @description Commit message for the merge commit. */ + commit_message: string; + } | null; + /** + * Pull Request Simple + * @description Pull Request Simple + */ + "pull-request-simple": { /** * Format: uri - * @example https://api.github.com/projects/1002604 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + node_id: string; /** * Format: uri - * @example https://github.com/api-playground/projects-test/projects/12 + * @example https://github.com/octocat/Hello-World/pull/1347 */ html_url: string; /** * Format: uri - * @example https://api.github.com/projects/1002604/columns + * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - columns_url: string; - /** @example 1002604 */ + diff_url: string; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World/pull/1347.patch + */ + patch_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + */ + commits_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + */ + review_comments_url: string; + /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ + review_comment_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + */ + comments_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + statuses_url: string; + /** @example 1347 */ + number: number; + /** @example open */ + state: string; + /** @example true */ + locked: boolean; + /** @example new-feature */ + title: string; + user: components["schemas"]["nullable-simple-user"]; + /** @example Please pull these awesome changes */ + body: string | null; + labels: { + /** Format: int64 */ + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: components["schemas"]["nullable-milestone"]; + /** @example too heated */ + active_lock_reason?: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + updated_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + merged_at: string | null; + /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ + draft?: boolean; + }; + /** + * Draft Issue + * @description A draft issue in a project + */ + "projects-v2-draft-issue": { + /** @description The ID of the draft issue */ id: number; - /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ + /** @description The node ID of the draft issue */ node_id: string; + /** @description The title of the draft issue */ + title: string; + /** @description The body content of the draft issue */ + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; /** - * @description Name of the project - * @example Week One Sprint + * Format: date-time + * @description The time the draft issue was created + */ + created_at: string; + /** + * Format: date-time + * @description The time the draft issue was last updated + */ + updated_at: string; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-simple": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The content represented by the item. */ + content?: components["schemas"]["issue"] | components["schemas"]["pull-request-simple"] | components["schemas"]["projects-v2-draft-issue"]; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The URL of the project this item belongs to. */ + project_url?: string; + /** + * Format: uri + * @description The URL of the item in the project. + */ + item_url?: string; + }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-options": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option, in raw text and HTML formats. */ + name: { + raw: string; + html: string; + }; + /** @description The description of the option, in raw text and HTML formats. */ + description: { + raw: string; + html: string; + }; + /** @description The color associated with the option. */ + color: string; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-settings": { + /** @description The unique identifier of the iteration setting. */ + id: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date: string; + /** @description The duration of the iteration in days. */ + duration: number; + /** @description The iteration title, in raw text and HTML formats. */ + title: { + raw: string; + html: string; + }; + /** @description Whether the iteration has been completed. */ + completed: boolean; + }; + /** + * Projects v2 Field + * @description A field inside a projects v2 project + */ + "projects-v2-field": { + /** @description The unique identifier of the field. */ + id: number; + /** @description The node ID of the field. */ + node_id?: string; + /** + * @description The API URL of the project that contains the field. + * @example https://api.github.com/projects/1 + */ + project_url: string; + /** @description The name of the field. */ name: string; /** - * @description Body of the project - * @example This project represents the sprint of the first week in January + * @description The field's data type. + * @enum {string} */ - body: string | null; - /** @example 1 */ - number: number; + data_type: "assignees" | "linked_pull_requests" | "reviewers" | "labels" | "milestone" | "repository" | "title" | "text" | "single_select" | "number" | "date" | "iteration" | "issue_type" | "parent_issue" | "sub_issues_progress"; + /** @description The options available for single select fields. */ + options?: components["schemas"]["projects-v2-single-select-options"][]; + /** @description Configuration for iteration fields. */ + configuration?: { + /** @description The day of the week when the iteration starts. */ + start_day?: number; + /** @description The duration of the iteration in days. */ + duration?: number; + iterations?: components["schemas"]["projects-v2-iteration-settings"][]; + }; /** - * @description State of the project; either 'open' or 'closed' - * @example open + * Format: date-time + * @description The time when the field was created. + * @example 2022-04-28T12:00:00Z */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + created_at: string; /** * Format: date-time - * @example 2011-04-10T20:09:31Z + * @description The time when the field was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + }; + "projects-v2-field-single-select-option": { + /** @description The display name of the option. */ + name?: string; + /** + * @description The color associated with the option. + * @enum {string} + */ + color?: "BLUE" | "GRAY" | "GREEN" | "ORANGE" | "PINK" | "PURPLE" | "RED" | "YELLOW"; + /** @description The description of the option. */ + description?: string; + }; + /** @description The configuration for iteration fields. */ + "projects-v2-field-iteration-configuration": { + /** + * Format: date + * @description The start date of the first iteration. + */ + start_date?: string; + /** @description The default duration for iterations in days. Individual iterations can override this value. */ + duration?: number; + /** @description Zero or more iterations for the field. */ + iterations?: { + /** @description The title of the iteration. */ + title?: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date?: string; + /** @description The duration of the iteration in days. */ + duration?: number; + }[]; + }; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-with-content": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** + * Format: uri + * @description The API URL of the project that contains this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/3 + */ + project_url?: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + /** @description The content of the item, which varies by content type. */ + content?: { + [key: string]: unknown; + } | null; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time - * @example 2014-03-03T18:58:10Z + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z */ updated_at: string; /** - * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The API URL of this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/items/3 + */ + item_url?: string | null; + /** @description The fields and values associated with this item. */ + fields?: { + [key: string]: unknown; + }[]; + }; + /** + * Projects v2 View + * @description A view inside a projects v2 project + */ + "projects-v2-view": { + /** @description The unique identifier of the view. */ + id: number; + /** @description The number of the view within the project. */ + number: number; + /** @description The name of the view. */ + name: string; + /** + * @description The layout of the view. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; + layout: "table" | "board" | "roadmap"; + /** @description The node ID of the view. */ + node_id: string; + /** + * @description The API URL of the project that contains the view. + * @example https://api.github.com/orgs/octocat/projectsV2/1 + */ + project_url: string; + /** + * Format: uri + * @description The web URL of the view. + * @example https://github.com/orgs/octocat/projects/1/views/1 + */ + html_url: string; + creator: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the view was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the view was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The filter query for the view. + * @example is:issue is:open + */ + filter?: string | null; + /** @description The list of field IDs that are visible in the view. */ + visible_fields: number[]; + /** @description The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". */ + sort_by: (number | string)[][]; + /** @description The list of field IDs used for horizontal grouping. */ + group_by: number[]; + /** @description The list of field IDs used for vertical grouping (board layout). */ + vertical_group_by: number[]; }; /** * Organization Custom Property @@ -24991,7 +27897,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -25009,6 +27915,8 @@ export interface components { * @enum {string|null} */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Set Payload @@ -25020,7 +27928,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -25032,6 +27940,14 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Value @@ -25295,6 +28211,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -25413,6 +28341,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; } | null; /** * Code Of Conduct Simple @@ -25635,6 +28568,14 @@ export interface components { has_downloads?: boolean; /** @example true */ has_discussions: boolean; + /** @example true */ + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -25757,7 +28698,7 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** @description The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -25765,22 +28706,22 @@ 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. Also, `pull_request` is only applicable to branch rulesets. + * @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. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode: "always" | "pull_request" | "exempt"; }; /** * Repository ruleset conditions for ref names * @description Parameters for a repository ruleset ref name condition */ "repository-ruleset-conditions": { - ref_name: { + ref_name?: { /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - include: string[]; + include?: string[]; /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - exclude: string[]; + exclude?: string[]; }; }; /** @@ -25790,11 +28731,11 @@ export interface components { "repository-ruleset-conditions-repository-name-target": { repository_name: { /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - include: string[]; + include?: string[]; /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - exclude: string[]; + exclude?: string[]; /** @description Whether renaming of target repositories is prevented. */ - protected: boolean; + protected?: boolean; }; }; /** @@ -25804,7 +28745,7 @@ export interface components { "repository-ruleset-conditions-repository-id-target": { repository_id: { /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - repository_ids: number[]; + repository_ids?: number[]; }; }; /** @@ -25829,9 +28770,9 @@ export interface components { "repository-ruleset-conditions-repository-property-target": { repository_property: { /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ - include: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ - exclude: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; }; }; /** @@ -25928,17 +28869,29 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * Reviewer + * @description A required reviewing team + */ + "repository-rule-params-reviewer": { + /** @description ID of the reviewer which must review changes to matching files. */ + id: number; + /** + * @description The type of the reviewer + * @enum {string} + */ + type: "Team"; + }; /** * 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. */ + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. */ 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; + reviewer: components["schemas"]["repository-rule-params-reviewer"]; }; /** * pull_request @@ -25948,8 +28901,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { - /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ - allowed_merge_methods?: string[]; + /** @description Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. */ + allowed_merge_methods?: ("merge" | "squash" | "rebase")[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25960,6 +28913,13 @@ export interface components { required_approving_review_count: number; /** @description All conversations on code must be resolved before a pull request can be merged. */ required_review_thread_resolution: boolean; + /** + * @description > [!NOTE] + * > `required_reviewers` is in beta and subject to change. + * + * A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + */ + required_reviewers?: components["schemas"]["repository-rule-params-required-reviewer-configuration"][]; }; }; /** @@ -26004,7 +28964,7 @@ export interface components { /** @enum {string} */ type: "commit_message_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26025,7 +28985,7 @@ export interface components { /** @enum {string} */ type: "commit_author_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26046,7 +29006,7 @@ export interface components { /** @enum {string} */ type: "committer_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26067,7 +29027,7 @@ export interface components { /** @enum {string} */ type: "branch_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26088,7 +29048,7 @@ export interface components { /** @enum {string} */ type: "tag_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26101,6 +29061,54 @@ export interface components { pattern: string; }; }; + /** + * file_path_restriction + * @description Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + */ + "repository-rule-file-path-restriction": { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + }; + /** + * max_file_path_length + * @description Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + */ + "repository-rule-max-file-path-length": { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths. */ + max_file_path_length: number; + }; + }; + /** + * file_extension_restriction + * @description Prevent commits that include files with specified file extensions from being pushed to the commit graph. + */ + "repository-rule-file-extension-restriction": { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + }; + /** + * max_file_size + * @description Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + */ + "repository-rule-max-file-size": { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + }; /** * RestrictedCommits * @description Restricted commit @@ -26170,38 +29178,35 @@ export interface components { }; }; /** - * Repository Rule - * @description A repository rule. + * copilot_code_review + * @description Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + "repository-rule-copilot-code-review": { /** @enum {string} */ - type: "file_path_restriction"; + type: "copilot_code_review"; parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - restricted_file_paths: string[]; + /** @description Copilot automatically reviews draft pull requests before they are marked as ready for review. */ + review_draft_pull_requests?: boolean; + /** @description Copilot automatically reviews each new push to the pull request. */ + review_on_push?: boolean; }; - } | { - /** @enum {string} */ - type: "max_file_path_length"; - parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - max_file_path_length: number; - }; - } | { - /** @enum {string} */ - type: "file_extension_restriction"; - parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - restricted_file_extensions: string[]; - }; - } | { - /** @enum {string} */ - type: "max_file_size"; - parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - max_file_size: number; - }; - } | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"]; + }; + /** + * CopilotCodeReviewAnalysisTool + * @description A tool that must provide code review results for this rule to pass. + */ + "repository-rule-params-copilot-code-review-analysis-tool": { + /** + * @description The name of a code review analysis tool + * @enum {string} + */ + name: "CodeQL" | "ESLint" | "PMD"; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -26231,16 +29236,16 @@ export interface components { * querying the repository-level endpoint. * @enum {string} */ - current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + current_user_can_bypass?: "always" | "pull_requests_only" | "never" | "exempt"; node_id?: string; _links?: { - self: { + self?: { /** @description The URL of the ruleset */ - href: string; + href?: string; }; - html: { + html?: { /** @description The html URL of the ruleset */ - href: string; + href?: string; } | null; }; conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; @@ -26250,105 +29255,462 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** + * Repository Rule + * @description A repository rule. + */ + "org-rules": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Rule Suites * @description Response */ "rule-suites": { /** @description The unique identifier of the rule insight. */ - id: number; + id?: number; /** @description The number that identifies the user. */ - actor_id: number; + actor_id?: number; /** @description The handle for the GitHub user account. */ - actor_name: string; + actor_name?: string; /** @description The first commit sha before the push evaluation. */ - before_sha: string; + before_sha?: string; /** @description The last commit sha in the push evaluation. */ - after_sha: string; + after_sha?: string; /** @description The ref name that the evaluation ran on. */ - ref: string; + ref?: string; /** @description The ID of the repository associated with the rule evaluation. */ - repository_id: number; + repository_id?: number; /** @description The name of the repository without the `.git` extension. */ - repository_name: string; + repository_name?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at?: string; /** * @description The result of the rule evaluations for rules with the `active` enforcement status. * @enum {string} */ - result: "pass" | "fail" | "bypass"; + result?: "pass" | "fail" | "bypass"; /** * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. * @enum {string} */ - evaluation_result: "pass" | "fail" | "bypass"; + evaluation_result?: "pass" | "fail" | "bypass"; }[]; + /** + * Pull request rule suite metadata + * @description Metadata for a pull request rule evaluation result. + */ + "rule-suite-pull-request": { + /** @description The pull request associated with the rule evaluation. */ + pull_request?: { + /** @description The unique identifier of the pull request. */ + id?: number; + /** @description The number of the pull request. */ + number?: number; + /** @description The user who created the pull request. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The reviews associated with the pull request. */ + reviews?: { + /** @description The unique identifier of the review. */ + id?: number; + /** @description The user who submitted the review. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The state of the review. */ + state?: string; + }[]; + }; + }; /** * Rule Suite * @description Response */ "rule-suite": { /** @description The unique identifier of the rule insight. */ - id: number; + id?: number; /** @description The number that identifies the user. */ - actor_id: number | null; + actor_id?: number | null; /** @description The handle for the GitHub user account. */ - actor_name: string | null; - /** @description The first commit sha before the push evaluation. */ - before_sha: string; - /** @description The last commit sha in the push evaluation. */ - after_sha: string; + actor_name?: string | null; + /** @description The previous commit SHA of the ref. */ + before_sha?: string; + /** @description The new commit SHA of the ref. */ + after_sha?: string; /** @description The ref name that the evaluation ran on. */ - ref: string; + ref?: string; /** @description The ID of the repository associated with the rule evaluation. */ - repository_id: number; + repository_id?: number; /** @description The name of the repository without the `.git` extension. */ - repository_name: string; + repository_name?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at?: string; /** * @description The result of the rule evaluations for rules with the `active` enforcement status. * @enum {string} */ - result: "pass" | "fail" | "bypass"; + result?: "pass" | "fail" | "bypass"; /** * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. Null if no rules with `evaluate` enforcement status were run. * @enum {string|null} */ - evaluation_result: "pass" | "fail" | "bypass" | null; + evaluation_result?: "pass" | "fail" | "bypass" | null; /** @description Details on the evaluated rules. */ - rule_evaluations: { - rule_source: { + rule_evaluations?: { + rule_source?: { /** @description The type of rule source. */ - type: string; + type?: string; /** @description The ID of the rule source. */ - id: number | null; + id?: number | null; /** @description The name of the rule source. */ - name: string | null; + name?: string | null; }; /** * @description The enforcement level of this rule source. * @enum {string} */ - enforcement: "active" | "evaluate" | "deleted ruleset"; + enforcement?: "active" | "evaluate" | "deleted ruleset"; /** * @description The result of the evaluation of the individual rule. * @enum {string} */ - result: "pass" | "fail"; + result?: "pass" | "fail"; /** @description The type of rule. */ - rule_type: string; + rule_type?: string; /** @description The detailed failure message for the rule. Null if the rule passed. */ - details: string | null; + details?: string | null; }[]; }; + /** + * Ruleset version + * @description The historical version of a ruleset + */ + "ruleset-version": { + /** @description The ID of the previous version of the ruleset */ + version_id: number; + /** @description The actor who updated the ruleset */ + actor: { + id?: number; + type?: string; + }; + /** Format: date-time */ + updated_at: string; + }; + "ruleset-version-with-state": components["schemas"]["ruleset-version"] & { + /** @description The state of the ruleset version */ + state: Record; + }; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "nullable-alert-updated-at": string | null; + /** + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + * @enum {string} + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; + /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ + "secret-scanning-location-commit": { + /** + * @description The file path in the repository + * @example /example/secrets.txt + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** @description The API URL to get the associated blob resource */ + blob_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + commit_sha: string; + /** @description The API URL to get the associated commit resource */ + commit_url: string; + }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; + /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ + "secret-scanning-location-issue-title": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_title_url: string; + }; + /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ + "secret-scanning-location-issue-body": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_body_url: string; + }; + /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ + "secret-scanning-location-issue-comment": { + /** + * Format: uri + * @description The API URL to get the issue comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + issue_comment_url: string; + }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; + /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */ + "nullable-secret-scanning-first-detected-location": (components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]) | null; + "organization-secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; + /** @description The secret that was detected. */ + secret?: string; + repository?: components["schemas"]["simple-repository"]; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description The comment that was optionally added when this alert was closed */ + resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @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; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */ + "secret-scanning-row-version": string | null; + "secret-scanning-pattern-override": { + /** @description The ID of the pattern. */ + token_type?: string; + /** @description The version of this pattern if it's a custom pattern. */ + custom_pattern_version?: string | null; + /** @description The slug of the pattern. */ + slug?: string; + /** @description The user-friendly name for the pattern. */ + display_name?: string; + /** @description The total number of alerts generated by this pattern. */ + alert_total?: number; + /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */ + alert_total_percentage?: number; + /** @description The number of false positive alerts generated by this pattern. */ + false_positives?: number; + /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */ + false_positive_rate?: number; + /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */ + bypass_rate?: number; + /** + * @description The default push protection setting for this pattern. + * @enum {string} + */ + default_setting?: "disabled" | "enabled"; + /** + * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + * @enum {string|null} + */ + enterprise_setting?: "not-set" | "disabled" | "enabled" | null; + /** + * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + * @enum {string} + */ + setting?: "not-set" | "disabled" | "enabled"; + }; + /** + * Secret scanning pattern configuration + * @description A collection of secret scanning patterns and their settings related to push protection. + */ + "secret-scanning-pattern-configuration": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Overrides for partner patterns. */ + provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + /** @description Overrides for custom patterns defined by the organization. */ + custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ @@ -26464,8 +29826,8 @@ export interface components { cwe_ids: string[] | null; credits: { /** @description The username of the user credited. */ - login: string; - type: components["schemas"]["security-advisory-credit-types"]; + login?: string; + type?: components["schemas"]["security-advisory-credit-types"]; }[] | null; readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; /** @description A list of users that collaborate on the advisory. */ @@ -26475,61 +29837,19 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; - "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; - minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU: number; - /** @description Total minutes used on macOS runner machines. */ - MACOS: number; - /** @description Total minutes used on Windows runner machines. */ - WINDOWS: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - ubuntu_4_core: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - ubuntu_8_core: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - ubuntu_16_core: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - ubuntu_32_core: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - ubuntu_64_core: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - windows_4_core: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - windows_8_core: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - windows_16_core: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - windows_32_core: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - windows_64_core: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - macos_12_core: number; - /** @description Total minutes used on all runner machines. */ - total: number; - }; - }; - "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; + /** + * Check immutable releases organization settings + * @description Check immutable releases settings for an organization. + */ + "immutable-releases-organization-settings": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */ + selected_repositories_url?: string; }; /** * Hosted compute network configuration @@ -26556,6 +29876,16 @@ export interface components { * @example 123ABC456DEF789 */ network_settings_ids?: string[]; + /** + * @description The unique identifier of each failover network settings in the configuration. + * @example 123ABC456DEF789 + */ + failover_network_settings_ids?: string[]; + /** + * @description Indicates whether the failover network resource is enabled. + * @example true + */ + failover_network_enabled?: boolean; /** * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. @@ -26726,6 +30056,11 @@ export interface components { /** Format: date-time */ archived_at: string | null; }; + /** + * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com + */ + "ldap-dn": string; /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. @@ -26798,163 +30133,22 @@ export interface components { */ updated_at: string; organization: components["schemas"]["team-organization"]; + ldap_dn?: components["schemas"]["ldap-dn"]; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** @example 0 */ - comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; - /** - * @description The unique sequence number of a team discussion. - * @example 42 - */ - number: number; - /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true - */ - pinned: boolean; - /** - * @description Whether or not this discussion should be restricted to team members and organization owners. - * @example true - */ - private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Team Discussion Comment - * @description A reply to a discussion within a team. - */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - body: string; - /** @example

Do you like apples?

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @description The ownership type of the team + * @enum {string} */ - discussion_url: string; + type: "enterprise" | "organization"; /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @description Unique identifier of the organization to which this team belongs + * @example 37 */ - html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + organization_id?: number; /** - * @description The unique sequence number of a team discussion comment. + * @description Unique identifier of the enterprise to which this team belongs * @example 42 */ - number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - reaction: { - /** @example 1 */ - id: number; - /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z - */ - created_at: string; + enterprise_id?: number; }; /** * Team Membership @@ -26976,34 +30170,6 @@ export interface components { */ state: "active" | "pending"; }; - /** - * Team Project - * @description A team's access to a project. - */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; - permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; /** * Team Repository * @description A team's access to a repository. @@ -27309,111 +30475,6 @@ export interface components { watchers: number; master_branch?: string; }; - /** - * Project Card - * @description Project cards represent a scope of work. - */ - "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - url: string; - /** - * Format: int64 - * @description The project card's ID - * @example 42 - */ - id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; - /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @example 2016-09-05T14:21:06Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:20:22Z - */ - updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - column_name?: string; - project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - }; - /** - * Project Column - * @description Project columns contain cards of work. - */ - "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - updated_at: string; - }; - /** - * Project Collaborator Permission - * @description Project Collaborator Permission - */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - }; /** Rate Limit */ "rate-limit": { limit: number; @@ -27437,6 +30498,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + dependency_sbom?: components["schemas"]["rate-limit"]; code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; @@ -27472,19 +30534,46 @@ export interface components { expires_at: string | null; /** Format: date-time */ updated_at: string | null; + /** + * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + */ + digest?: string | null; workflow_run?: { /** @example 10 */ - id: number; + id?: number; /** @example 42 */ - repository_id: number; + repository_id?: number; /** @example 42 */ - head_repository_id: number; + head_repository_id?: number; /** @example main */ - head_branch: string; + head_branch?: string; /** @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha?: string; } | null; }; + /** + * Actions cache retention limit for a repository + * @description GitHub Actions cache retention policy for a repository. + */ + "actions-cache-retention-limit-for-repository": { + /** + * @description The maximum number of days to keep caches in this repository. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for a repository + * @description GitHub Actions cache storage policy for a repository. + */ + "actions-cache-storage-limit-for-repository": { + /** + * @description The maximum total cache size for this repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** * Repository actions caches * @description Repository actions caches @@ -27498,25 +30587,25 @@ export interface components { /** @description Array of caches */ actions_caches: { /** @example 2 */ - id: number; + id?: number; /** @example refs/heads/main */ - ref: string; + ref?: string; /** @example Linux-node-958aff96db2d75d67787d1e634ae70b659de937b */ - key: string; + key?: string; /** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */ - version: string; + version?: string; /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - last_accessed_at: string; + last_accessed_at?: string; /** * Format: date-time * @example 2019-01-24T22:45:36.000Z */ - created_at: string; + created_at?: string; /** @example 1024 */ - size_in_bytes: number; + size_in_bytes?: number; }[]; }; /** @@ -27718,6 +30807,7 @@ export interface components { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; "actions-workflow-access-to-repository": { /** @@ -27738,33 +30828,6 @@ export interface components { sha: string; ref?: string; }; - /** Pull Request Minimal */ - "pull-request-minimal": { - /** Format: int64 */ - id: number; - number: number; - url: string; - head: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - base: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - }; /** * Simple Commit * @description A commit. @@ -27960,30 +31023,30 @@ export interface components { * @description The id of the environment. * @example 56780428 */ - id: number; + id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id: string; + node_id?: string; /** * @description The name of the environment. * @example staging */ - name: string; + name?: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url: string; + url?: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url: string; + html_url?: string; /** * Format: date-time * @description The time that the environment was created, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - created_at: string; + created_at?: string; /** * Format: date-time * @description The time that the environment was last updated, in ISO 8601 format. * @example 2020-11-23T22:00:40Z */ - updated_at: string; + updated_at?: string; }[]; /** * @description Whether deployment to the environment(s) was approved or rejected or pending (with comments) @@ -28032,18 +31095,18 @@ export interface components { * @description The id of the environment. * @example 56780428 */ - id: number; + id?: number; /** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */ - node_id: string; + node_id?: string; /** * @description The name of the environment. * @example staging */ - name: string; + name?: string; /** @example https://api.github.com/repos/github/hello-world/environments/staging */ - url: string; + url?: string; /** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */ - html_url: string; + html_url?: string; }; /** * @description The set duration of the wait timer @@ -28063,8 +31126,8 @@ export interface components { current_user_can_approve: boolean; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers: { - type: components["schemas"]["deployment-reviewer-type"]; - reviewer: components["schemas"]["simple-user"] | components["schemas"]["team"]; + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; }[]; }; /** @@ -28148,7 +31211,7 @@ export interface components { */ "workflow-run-usage": { billable: { - UBUNTU: { + UBUNTU?: { total_ms: number; jobs: number; job_runs?: { @@ -28156,7 +31219,7 @@ export interface components { duration_ms: number; }[]; }; - MACOS: { + MACOS?: { total_ms: number; jobs: number; job_runs?: { @@ -28164,7 +31227,7 @@ export interface components { duration_ms: number; }[]; }; - WINDOWS: { + WINDOWS?: { total_ms: number; jobs: number; job_runs?: { @@ -28215,20 +31278,40 @@ export interface components { */ deleted_at?: string; }; + /** + * Workflow Run ID + * Format: int64 + * @description The ID of the workflow run. + */ + "workflow-run-id": number; + /** + * Workflow Dispatch Response + * @description Response containing the workflow run ID and URLs. + */ + "workflow-dispatch-response": { + workflow_run_id: components["schemas"]["workflow-run-id"]; + /** + * Format: uri + * @description The URL to the workflow run. + */ + run_url: string; + /** Format: uri */ + html_url: string; + }; /** * Workflow Usage * @description Workflow Usage */ "workflow-usage": { billable: { - UBUNTU: { - total_ms: number; + UBUNTU?: { + total_ms?: number; }; - MACOS: { - total_ms: number; + MACOS?: { + total_ms?: number; }; - WINDOWS: { - total_ms: number; + WINDOWS?: { + total_ms?: number; }; }; }; @@ -28292,6 +31375,8 @@ export interface components { * @example true */ is_alphanumeric: boolean; + /** Format: date-time */ + updated_at?: string | null; }; /** * Check Dependabot security updates @@ -28349,26 +31434,26 @@ export interface components { url?: string; dismissal_restrictions?: { /** @description The list of users with review dismissal access. */ - users: components["schemas"]["simple-user"][]; + users?: components["schemas"]["simple-user"][]; /** @description The list of teams with review dismissal access. */ - teams: components["schemas"]["team"][]; + teams?: components["schemas"]["team"][]; /** @description The list of apps with review dismissal access. */ - apps: components["schemas"]["integration"][]; + apps?: components["schemas"]["integration"][]; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */ - url: string; + url?: string; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */ - users_url: string; + users_url?: string; /** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */ - teams_url: string; + teams_url?: string; }; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ bypass_pull_request_allowances?: { /** @description The list of users allowed to bypass pull request requirements. */ - users: components["schemas"]["simple-user"][]; + users?: components["schemas"]["simple-user"][]; /** @description The list of teams allowed to bypass pull request requirements. */ - teams: components["schemas"]["team"][]; + teams?: components["schemas"]["team"][]; /** @description The list of apps allowed to bypass pull request requirements. */ - apps: components["schemas"]["integration"][]; + apps?: components["schemas"]["integration"][]; }; /** @example true */ dismiss_stale_reviews: boolean; @@ -28397,98 +31482,84 @@ export interface components { /** Format: uri */ apps_url: string; users: { - login: string; + login?: string; /** Format: int64 */ - id: number; - node_id: string; - avatar_url: string; - gravatar_id: string; - url: string; - html_url: string; - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; - subscriptions_url: string; - organizations_url: string; - repos_url: string; - events_url: string; - received_events_url: string; - type: string; - site_admin: boolean; - user_view_type: string; - }[]; - teams: { - id: number; - node_id: string; - url: string; - html_url: string; - name: string; - slug: string; - description: string | null; - privacy: string; - notification_setting: string; - permission: string; - members_url: string; - repositories_url: string; - parent: string | null; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; + user_view_type?: string; }[]; + teams: components["schemas"]["team"][]; apps: { - id: number; - slug: string; - node_id: string; - owner: { - login: string; - id: number; - node_id: string; - url: string; - repos_url: string; - events_url: string; - hooks_url: string; - issues_url: string; - members_url: string; - public_members_url: string; - avatar_url: string; - description: string; + id?: number; + slug?: string; + node_id?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + url?: string; + repos_url?: string; + events_url?: string; + hooks_url?: string; + issues_url?: string; + members_url?: string; + public_members_url?: string; + avatar_url?: string; + description?: string; /** @example "" */ - gravatar_id: string; + gravatar_id?: string; /** @example "https://github.com/testorg-ea8ec76d71c3af4b" */ - html_url: string; + html_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */ - followers_url: string; + followers_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */ - following_url: string; + following_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */ - gists_url: string; + gists_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */ - starred_url: string; + starred_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */ - subscriptions_url: string; + subscriptions_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */ - organizations_url: string; + organizations_url?: string; /** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */ - received_events_url: string; + received_events_url?: string; /** @example "Organization" */ - type: string; + type?: string; /** @example false */ - site_admin: boolean; + site_admin?: boolean; /** @example public */ - user_view_type: string; + user_view_type?: string; }; - name: string; - client_id: string; - description: string; - external_url: string; - html_url: string; - created_at: string; - updated_at: string; - permissions: { - metadata: string; - contents: string; - issues: string; - single_file: string; + name?: string; + client_id?: string; + description?: string; + external_url?: string; + html_url?: string; + created_at?: string; + updated_at?: string; + permissions?: { + metadata?: string; + contents?: string; + issues?: string; + single_file?: string; }; - events: string[]; + events?: string[]; }[]; }; /** @@ -28496,32 +31567,32 @@ export interface components { * @description Branch Protection */ "branch-protection": { - url: string; - enabled: boolean; - required_status_checks: components["schemas"]["protected-branch-required-status-check"]; - enforce_admins: components["schemas"]["protected-branch-admin-enforced"]; - required_pull_request_reviews: components["schemas"]["protected-branch-pull-request-review"]; - restrictions: components["schemas"]["branch-restriction-policy"]; - required_linear_history: { - enabled: boolean; + url?: string; + enabled?: boolean; + required_status_checks?: components["schemas"]["protected-branch-required-status-check"]; + enforce_admins?: components["schemas"]["protected-branch-admin-enforced"]; + required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"]; + restrictions?: components["schemas"]["branch-restriction-policy"]; + required_linear_history?: { + enabled?: boolean; }; - allow_force_pushes: { - enabled: boolean; + allow_force_pushes?: { + enabled?: boolean; }; - allow_deletions: { - enabled: boolean; + allow_deletions?: { + enabled?: boolean; }; - block_creations: { - enabled: boolean; + block_creations?: { + enabled?: boolean; }; - required_conversation_resolution: { - enabled: boolean; + required_conversation_resolution?: { + enabled?: boolean; }; /** @example "branch/with/protection" */ - name: string; + name?: string; /** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */ - protection_url: string; - required_signatures: { + protection_url?: string; + required_signatures?: { /** * Format: uri * @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures @@ -28531,12 +31602,12 @@ export interface components { enabled: boolean; }; /** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */ - lock_branch: { + lock_branch?: { /** @default false */ enabled: boolean; }; /** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */ - allow_fork_syncing: { + allow_fork_syncing?: { /** @default false */ enabled: boolean; }; @@ -28563,11 +31634,14 @@ export interface components { */ "nullable-git-user": { /** @example "Chris Wanstrath" */ - name: string; + name?: string; /** @example "chris@ozmm.org" */ - email: string; - /** @example "2007-10-29T02:42:39.000-07:00" */ - date: string; + email?: string; + /** + * Format: date-time + * @example "2007-10-29T02:42:39.000-07:00" + */ + date?: string; } | null; /** Verification */ verification: { @@ -28575,7 +31649,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** * Diff Entry @@ -28583,7 +31657,7 @@ export interface components { */ "diff-entry": { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string | null; /** @example file1.txt */ filename: string; /** @@ -28681,9 +31755,9 @@ export interface components { html_url?: string; }[]; stats?: { - additions: number; - deletions: number; - total: number; + additions?: number; + deletions?: number; + total?: number; }; files?: components["schemas"]["diff-entry"][]; }; @@ -28798,7 +31872,7 @@ export interface components { }; restrictions?: components["schemas"]["branch-restriction-policy"]; required_conversation_resolution?: { - enabled: boolean; + enabled?: boolean; }; block_creations?: { enabled: boolean; @@ -29077,7 +32151,7 @@ export interface components { */ "check-suite-preference": { preferences: { - auto_trigger_checks: { + auto_trigger_checks?: { app_id: number; setting: boolean; }[]; @@ -29100,32 +32174,34 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule-summary"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; "code-scanning-alert-rule": { /** @description A unique identifier for the rule used to detect the alert. */ - id: string | null; + id?: string | null; /** @description The name of the rule used to detect the alert. */ - name: string; + name?: string; /** * @description The severity of the alert. * @enum {string|null} */ - severity: "none" | "note" | "warning" | "error" | null; + severity?: "none" | "note" | "warning" | "error" | null; /** * @description The security severity of the alert. * @enum {string|null} */ - security_severity_level: "low" | "medium" | "high" | "critical" | null; + security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ - description: string; + description?: string; /** @description A description of the rule used to detect the alert. */ - full_description: string; + full_description?: string; /** @description A set of tags applicable for the rule. */ - tags: string[] | null; + tags?: string[] | null; /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help: string | null; + help?: string | null; /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri: string | null; + help_uri?: string | null; }; "code-scanning-alert": { number: components["schemas"]["alert-number"]; @@ -29143,12 +32219,18 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** @description If `true`, attempt to create an alert dismissal request. */ + "code-scanning-alert-create-request": boolean; + /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */ + "code-scanning-alert-assignees": string[]; /** * @description The status of an autofix. * @enum {string} @@ -29169,15 +32251,38 @@ export interface components { /** @description Commit an autofix for a code scanning alert */ "code-scanning-autofix-commits": { /** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - target_ref: string; + target_ref?: string; /** @description Commit message to be used. */ - message: string; + message?: string; } | null; "code-scanning-autofix-commits-response": { /** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - target_ref: string; + target_ref?: string; /** @description SHA of commit with autofix. */ - sha: string; + sha?: string; + }; + /** + * @description State of a code scanning alert instance. + * @enum {string|null} + */ + "code-scanning-alert-instance-state": "open" | "fixed" | null; + "code-scanning-alert-instance-list": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-instance-state"]; + commit_sha?: string; + message?: { + text?: string; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; }; /** * @description An identifier for the upload. @@ -29277,7 +32382,7 @@ export interface components { * @description The language targeted by the CodeQL query * @enum {string} */ - "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift"; + "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift"; /** * Repository Identifier * @description Repository Identifier @@ -29406,35 +32511,40 @@ export interface components { * @description Code scanning default setup has been configured or not. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** @description Languages to be analyzed. */ - languages: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[]; /** * @description Runner type to be used. * @enum {string|null} */ - runner_type: "standard" | "labeled" | null; + runner_type?: "standard" | "labeled" | null; /** * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ - runner_label: string | null; + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ - query_suite: "default" | "extended"; + query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** * Format: date-time * @description Timestamp of latest configuration update. * @example 2023-12-06T14:20:20.000Z */ - updated_at: string | null; + updated_at?: string | null; /** * @description The frequency of the periodic analysis. * @enum {string|null} */ - schedule: "weekly" | null; + schedule?: "weekly" | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup-update": { @@ -29442,24 +32552,29 @@ export interface components { * @description The desired state of code scanning default setup. * @enum {string} */ - state: "configured" | "not-configured"; + state?: "configured" | "not-configured"; /** * @description Runner type to be used. * @enum {string} */ - runner_type: "standard" | "labeled"; + runner_type?: "standard" | "labeled"; /** * @description Runner label to be used if the runner type is labeled. * @example code-scanning */ - runner_label: string | null; + runner_label?: string | null; /** * @description CodeQL query suite to be used. * @enum {string} */ - query_suite: "default" | "extended"; + query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** @description CodeQL languages to be analyzed. */ - languages: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; + languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; /** * @description You can use `run_url` to track the status of the run. This includes a property status and conclusion. @@ -29467,9 +32582,9 @@ export interface components { */ "code-scanning-default-setup-update-response": { /** @description ID of the corresponding run. */ - run_id: number; + run_id?: number; /** @description URL of the corresponding run. */ - run_url: string; + run_url?: string; }; /** * @description The full Git reference, formatted as `refs/heads/`, @@ -29480,26 +32595,26 @@ export interface components { /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; "code-scanning-sarifs-receipt": { - id: components["schemas"]["code-scanning-analysis-sarif-id"]; + id?: components["schemas"]["code-scanning-analysis-sarif-id"]; /** * Format: uri * @description The REST API URL for checking the status of the upload. */ - readonly url: string; + readonly url?: string; }; "code-scanning-sarifs-status": { /** * @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed. * @enum {string} */ - processing_status: "pending" | "complete" | "failed"; + processing_status?: "pending" | "complete" | "failed"; /** * Format: uri * @description The REST API URL for getting the analyses associated with the upload. */ - readonly analyses_url: string | null; + readonly analyses_url?: string | null; /** @description Any errors that ocurred during processing of the delivery. */ - readonly errors: string[] | null; + readonly errors?: string[] | null; }; /** @description Code security configuration associated with a repository and attachment status */ "code-security-configuration-for-repository": { @@ -29507,8 +32622,8 @@ export interface components { * @description The attachment status of the code security configuration on the repository. * @enum {string} */ - status: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; - configuration: components["schemas"]["code-security-configuration"]; + status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise"; + configuration?: components["schemas"]["code-security-configuration"]; }; /** * CODEOWNERS errors @@ -29857,180 +32972,38 @@ export interface components { reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Branch Short - * @description Branch Short - */ - "branch-short": { - name: string; - commit: { - sha: string; - url: string; - }; - protected: boolean; - }; - /** - * Link - * @description Hypermedia Link - */ - link: { - href: string; - }; - /** - * Auto merge - * @description The status of auto merging a pull request. - */ - "auto-merge": { - enabled_by: components["schemas"]["simple-user"]; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - /** @description Title for the merge commit message. */ - commit_title: string; - /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; - /** - * Pull Request Simple - * @description Pull Request Simple + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - "pull-request-simple": { - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 - */ - url: string; - /** - * Format: int64 - * @example 1 - */ + reaction: { + /** @example 1 */ id: number; - /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + /** @example MDg6UmVhY3Rpb24x */ node_id: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347 - */ - html_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.diff - */ - diff_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.patch - */ - patch_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - */ - commits_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - */ - review_comments_url: string; - /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - */ - comments_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - */ - statuses_url: string; - /** @example 1347 */ - number: number; - /** @example open */ - state: string; - /** @example true */ - locked: boolean; - /** @example new-feature */ - title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ - body: string | null; - labels: { - /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ - active_lock_reason?: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - created_at: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - updated_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * @description The reaction to use + * @example heart + * @enum {string} */ - closed_at: string | null; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** * Format: date-time - * @example 2011-01-26T19:01:12Z + * @example 2016-05-20T20:09:31Z */ - merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; - head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; - base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; + created_at: string; + }; + /** + * Branch Short + * @description Branch Short + */ + "branch-short": { + name: string; + commit: { sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; - _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; + url: string; }; - author_association: components["schemas"]["author-association"]; - auto_merge: components["schemas"]["auto-merge"]; - /** - * @description Indicates whether or not the pull request is a draft. - * @example false - */ - draft?: boolean; + protected: boolean; }; /** Simple Commit Status */ "simple-commit-status": { @@ -30226,6 +33199,7 @@ export interface components { self: string; }; }[]; + encoding?: string; _links: { /** Format: uri */ git: string | null; @@ -30372,52 +33346,52 @@ export interface components { */ "file-commit": { content: { - name: string; - path: string; - sha: string; - size: number; - url: string; - html_url: string; - git_url: string; - download_url: string; - type: string; - _links: { - self: string; - git: string; - html: string; + name?: string; + path?: string; + sha?: string; + size?: number; + url?: string; + html_url?: string; + git_url?: string; + download_url?: string; + type?: string; + _links?: { + self?: string; + git?: string; + html?: string; }; } | null; commit: { - sha: string; - node_id: string; - url: string; - html_url: string; - author: { - date: string; - name: string; - email: string; + sha?: string; + node_id?: string; + url?: string; + html_url?: string; + author?: { + date?: string; + name?: string; + email?: string; }; - committer: { - date: string; - name: string; - email: string; + committer?: { + date?: string; + name?: string; + email?: string; }; - message: string; - tree: { - url: string; - sha: string; + message?: string; + tree?: { + url?: string; + sha?: string; }; - parents: { - url: string; - html_url: string; - sha: string; + parents?: { + url?: string; + html_url?: string; + sha?: string; }[]; - verification: { - verified: boolean; - reason: string; - signature: string | null; - payload: string | null; - verified_at: string | null; + verification?: { + verified?: boolean; + reason?: string; + signature?: string | null; + payload?: string | null; + verified_at?: string | null; }; }; }; @@ -30425,14 +33399,14 @@ export interface components { "secret-scanning-push-protection-bypass-placeholder-id": string; /** @description Repository rule violation was detected */ "repository-rule-violation-error": { - message: string; - documentation_url: string; - status: string; - metadata: { - secret_scanning: { - bypass_placeholders: { - placeholder_id: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; - token_type: string; + message?: string; + documentation_url?: string; + status?: string; + metadata?: { + secret_scanning?: { + bypass_placeholders?: { + placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"]; + token_type?: string; }[]; }; }; @@ -30483,14 +33457,22 @@ export interface components { readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open"; /** @description Details for the vulnerable dependency. */ readonly dependency: { - package: components["schemas"]["dependabot-alert-package"]; + package?: components["schemas"]["dependabot-alert-package"]; /** @description The full path to the dependency manifest file, relative to the root of the repository. */ - readonly manifest_path: string; + readonly manifest_path?: string; /** * @description The execution scope of the vulnerable dependency. * @enum {string|null} */ - readonly scope: "development" | "runtime" | null; + readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -30509,6 +33491,9 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; }; /** * Dependabot Secret @@ -30612,52 +33597,52 @@ export interface components { * @description A unique SPDX identifier for the package. * @example SPDXRef-Package */ - SPDXID: string; + SPDXID?: string; /** * @description The name of the package. * @example github/github */ - name: string; + name?: string; /** * @description The version of the package. If the package does not have an exact version specified, * a version range is given. * @example 1.0.0 */ - versionInfo: string; + versionInfo?: string; /** * @description The location where the package can be downloaded, * or NOASSERTION if this has not been determined. * @example NOASSERTION */ - downloadLocation: string; + downloadLocation?: string; /** * @description Whether the package's file content has been subjected to * analysis during the creation of the SPDX document. * @example false */ - filesAnalyzed: boolean; + filesAnalyzed?: boolean; /** * @description The license of the package as determined while creating the SPDX document. * @example MIT */ - licenseConcluded: string; + licenseConcluded?: string; /** * @description The license of the package as declared by its author, or NOASSERTION if this information * was not available when the SPDX document was created. * @example NOASSERTION */ - licenseDeclared: string; + licenseDeclared?: string; /** * @description The distribution source of this package, or NOASSERTION if this was not determined. * @example NOASSERTION */ - supplier: string; + supplier?: string; /** * @description The copyright holders of the package, and any dates present with those notices, if available. * @example Copyright (c) 1985 GitHub.com */ - copyrightText: string; - externalRefs: { + copyrightText?: string; + externalRefs?: { /** * @description The category of reference to an external resource this reference refers to. * @example PACKAGE-MANAGER @@ -30680,11 +33665,11 @@ export interface components { * @description The type of relationship between the two SPDX elements. * @example DEPENDS_ON */ - relationshipType: string; + relationshipType?: string; /** @description The SPDX identifier of the package that is the source of the relationship. */ - spdxElementId: string; + spdxElementId?: string; /** @description The SPDX identifier of the package that is the target of the relationship. */ - relatedSpdxElement: string; + relatedSpdxElement?: string; }[]; }; }; @@ -30700,25 +33685,25 @@ export interface components { * @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. * @example pkg:/npm/%40actions/http-client@1.0.11 */ - package_url: string; - metadata: components["schemas"]["metadata"]; + package_url?: string; + metadata?: components["schemas"]["metadata"]; /** * @description A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. * @example direct * @enum {string} */ - relationship: "direct" | "indirect"; + relationship?: "direct" | "indirect"; /** * @description A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. * @example runtime * @enum {string} */ - scope: "runtime" | "development"; + scope?: "runtime" | "development"; /** * @description Array of package-url (PURLs) of direct child dependencies. * @example @actions/http-client */ - dependencies: string[]; + dependencies?: string[]; }; manifest: { /** @@ -30731,7 +33716,7 @@ export interface components { * @description The path of the manifest file relative to the root of the Git repository. * @example /src/build/package-lock.json */ - source_location: string; + source_location?: string; }; metadata?: components["schemas"]["metadata"]; /** @description A collection of resolved package dependencies. */ @@ -30951,8 +33936,8 @@ export interface components { type: string; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: { - type: components["schemas"]["deployment-reviewer-type"]; - reviewer: components["schemas"]["simple-user"] | components["schemas"]["team"]; + type?: components["schemas"]["deployment-reviewer-type"]; + reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"]; }[]; } | { /** @example 3515 */ @@ -30978,20 +33963,20 @@ export interface components { * @description The unique identifier of the branch or tag policy. * @example 361471 */ - id: number; + id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ - node_id: string; + node_id?: string; /** * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ - name: string; + name?: string; /** * @description Whether this rule targets a branch or tag. * @example branch * @enum {string} */ - type: "branch" | "tag"; + type?: "branch" | "tag"; }; /** Deployment branch and tag policy name pattern */ "deployment-branch-policy-name-pattern-with-type": { @@ -31172,7 +34157,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -31242,7 +34227,7 @@ export interface components { "git-tree": { sha: string; /** Format: uri */ - url: string; + url?: string; truncated: boolean; /** * @description Objects specifying a tree structure @@ -31253,35 +34238,7 @@ export interface components { * "type": "blob", * "size": 30, * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" - * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" - * ] + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" * } * ] */ @@ -31295,9 +34252,9 @@ export interface components { /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ sha: string; /** @example 12 */ - size: number; + size?: number; /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ - url: string; + url?: string; }[]; }; /** Hook Response */ @@ -31368,6 +34325,22 @@ export interface components { deliveries_url?: string; last_response: components["schemas"]["hook-response"]; }; + /** + * Check immutable releases + * @description Check immutable releases + */ + "check-immutable-releases": { + /** + * @description Whether immutable releases are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether immutable releases are enforced by the repository owner. + * @example false + */ + enforced_by_owner: boolean; + }; /** * Import * @description A repository import from an external source. @@ -31391,9 +34364,9 @@ export interface components { large_files_size?: number; large_files_count?: number; project_choices?: { - vcs: string; - tfvc_project: string; - human_name: string; + vcs?: string; + tfvc_project?: string; + human_name?: string; }[]; message?: string; authors_count?: number | null; @@ -31470,7 +34443,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -31491,14 +34464,14 @@ export interface components { */ labels: (string | { /** Format: int64 */ - id: number; - node_id: string; + id?: number; + node_id?: string; /** Format: uri */ - url: string; - name: string; - description: string | null; - color: string | null; - default: boolean; + url?: string; + name?: string; + description?: string | null; + color?: string | null; + default?: boolean; })[]; assignee: components["schemas"]["nullable-simple-user"]; assignees?: components["schemas"]["simple-user"][] | null; @@ -31530,11 +34503,20 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; } | null; /** * Issue Event Label @@ -31930,46 +34912,6 @@ export interface components { * @description Issue Event for Issue */ "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; - /** - * Label - * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). - */ - label: { - /** - * Format: int64 - * @description Unique identifier for the label. - * @example 208045946 - */ - id: number; - /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; - /** - * Format: uri - * @description URL for the label - * @example https://api.github.com/repositories/42/labels/bug - */ - url: string; - /** - * @description The name of the label. - * @example bug - */ - name: string; - /** - * @description Optional description of the label, such as its purpose. - * @example Something isn't working - */ - description: string | null; - /** - * @description 6-character hex code, without the leading #, identifying the color - * @example FFFFFF - */ - color: string; - /** - * @description Whether this label comes by default in a new repository. - * @example true - */ - default: boolean; - }; /** * Timeline Comment Event * @description Timeline Comment Event @@ -32014,6 +34956,7 @@ export interface components { author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** * Timeline Cross Referenced Event @@ -32027,8 +34970,8 @@ export interface components { /** Format: date-time */ updated_at: string; source: { - type: string; - issue: components["schemas"]["issue"]; + type?: string; + issue?: components["schemas"]["issue"]; }; }; /** @@ -32113,7 +35056,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -32159,6 +35102,8 @@ export interface components { }; /** Format: date-time */ submitted_at?: string; + /** Format: date-time */ + updated_at?: string | null; /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 @@ -32230,7 +35175,7 @@ export interface components { * @example 8 */ in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the comment. * @example We should probably include a check for null values here. @@ -32330,19 +35275,19 @@ export interface components { * @description Timeline Line Commented Event */ "timeline-line-commented-event": { - event: string; - node_id: string; - comments: components["schemas"]["pull-request-review-comment"][]; + event?: string; + node_id?: string; + comments?: components["schemas"]["pull-request-review-comment"][]; }; /** * Timeline Commit Commented Event * @description Timeline Commit Commented Event */ "timeline-commit-commented-event": { - event: string; - node_id: string; - commit_id: string; - comments: components["schemas"]["commit-comment"][]; + event?: string; + node_id?: string; + commit_id?: string; + comments?: components["schemas"]["commit-comment"][]; }; /** * Timeline Assigned Issue Event @@ -32410,6 +35355,7 @@ export interface components { created_at: string; read_only: boolean; added_by?: string | null; + /** Format: date-time */ last_used?: string | null; enabled?: boolean; }; @@ -32455,10 +35401,10 @@ export interface components { * @description Results of a successful merge upstream request */ "merged-upstream": { - message: string; + message?: string; /** @enum {string} */ - merge_type: "merge" | "fast-forward" | "none"; - base_branch: string; + merge_type?: "merge" | "fast-forward" | "none"; + base_branch?: string; }; /** * Milestone @@ -32682,72 +35628,72 @@ export interface components { * @description The current status of the deployment. * @enum {string} */ - status: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; }; /** * Pages Health Check Status * @description Pages Health Check Status */ "pages-health-check": { - domain: { - host: string; - uri: string; - nameservers: string; - dns_resolves: boolean; - is_proxied: boolean | null; - is_cloudflare_ip: boolean | null; - is_fastly_ip: boolean | null; - is_old_ip_address: boolean | null; - is_a_record: boolean | null; - has_cname_record: boolean | null; - has_mx_records_present: boolean | null; - is_valid_domain: boolean; - is_apex_domain: boolean; - should_be_a_record: boolean | null; - is_cname_to_github_user_domain: boolean | null; - is_cname_to_pages_dot_github_dot_com: boolean | null; - is_cname_to_fastly: boolean | null; - is_pointed_to_github_pages_ip: boolean | null; - is_non_github_pages_ip_present: boolean | null; - is_pages_domain: boolean; - is_served_by_pages: boolean | null; - is_valid: boolean; - reason: string | null; - responds_to_https: boolean; - enforces_https: boolean; - https_error: string | null; - is_https_eligible: boolean | null; - caa_error: string | null; - }; - alt_domain: { - host: string; - uri: string; - nameservers: string; - dns_resolves: boolean; - is_proxied: boolean | null; - is_cloudflare_ip: boolean | null; - is_fastly_ip: boolean | null; - is_old_ip_address: boolean | null; - is_a_record: boolean | null; - has_cname_record: boolean | null; - has_mx_records_present: boolean | null; - is_valid_domain: boolean; - is_apex_domain: boolean; - should_be_a_record: boolean | null; - is_cname_to_github_user_domain: boolean | null; - is_cname_to_pages_dot_github_dot_com: boolean | null; - is_cname_to_fastly: boolean | null; - is_pointed_to_github_pages_ip: boolean | null; - is_non_github_pages_ip_present: boolean | null; - is_pages_domain: boolean; - is_served_by_pages: boolean | null; - is_valid: boolean; - reason: string | null; - responds_to_https: boolean; - enforces_https: boolean; - https_error: string | null; - is_https_eligible: boolean | null; - caa_error: string | null; + domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; + }; + alt_domain?: { + host?: string; + uri?: string; + nameservers?: string; + dns_resolves?: boolean; + is_proxied?: boolean | null; + is_cloudflare_ip?: boolean | null; + is_fastly_ip?: boolean | null; + is_old_ip_address?: boolean | null; + is_a_record?: boolean | null; + has_cname_record?: boolean | null; + has_mx_records_present?: boolean | null; + is_valid_domain?: boolean; + is_apex_domain?: boolean; + should_be_a_record?: boolean | null; + is_cname_to_github_user_domain?: boolean | null; + is_cname_to_pages_dot_github_dot_com?: boolean | null; + is_cname_to_fastly?: boolean | null; + is_pointed_to_github_pages_ip?: boolean | null; + is_non_github_pages_ip_present?: boolean | null; + is_pages_domain?: boolean; + is_served_by_pages?: boolean | null; + is_valid?: boolean; + reason?: string | null; + responds_to_https?: boolean; + enforces_https?: boolean; + https_error?: string | null; + is_https_eligible?: boolean | null; + caa_error?: string | null; } | null; }; /** @@ -33093,93 +36039,11 @@ export interface components { * @example 2 */ original_start_line?: number | null; - }; - /** - * Release Asset - * @description Data related to a release. - */ - "release-asset": { - /** Format: uri */ - url: string; - /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; /** - * @description The file name of the asset. - * @example Team Environment - */ - name: string; - label: string | null; - /** - * @description State of the release asset. + * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - }; - /** - * Release - * @description A release. - */ - release: { - /** Format: uri */ - url: string; - /** Format: uri */ - html_url: string; - /** Format: uri */ - assets_url: string; - upload_url: string; - /** Format: uri */ - tarball_url: string | null; - /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; - /** - * @description The name of the tag. - * @example v1.0.0 - */ - tag_name: string; - /** - * @description Specifies the commitish value that determines where the Git tag is created from. - * @example master - */ - target_commitish: string; - name: string | null; - body?: string | null; - /** - * @description true to create a draft (unpublished) release, false to create a published one. - * @example false - */ - draft: boolean; - /** - * @description Whether to identify the release as a prerelease or a full release. - * @example false - */ - prerelease: boolean; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; - /** - * Format: uri - * @description The URL of the release discussion. - */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; }; /** * Generated Release Notes Content @@ -33203,250 +36067,93 @@ export interface components { * @description The type of source for the ruleset that includes this rule. * @enum {string} */ - ruleset_source_type: "Repository" | "Organization"; + ruleset_source_type?: "Repository" | "Organization"; /** @description The name of the source of the ruleset that includes this rule. */ - ruleset_source: string; + ruleset_source?: string; /** @description The ID of the ruleset that includes this rule. */ - ruleset_id: number; + ruleset_id?: number; }; /** * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at: components["schemas"]["nullable-alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url: string; - state: components["schemas"]["secret-scanning-alert-state"]; - resolution: components["schemas"]["secret-scanning-alert-resolution"]; + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at: string | null; - resolved_by: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment to resolve an alert. */ - resolution_comment: string | null; + resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ - secret_type: string; + secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ - secret_type_display_name: string; + secret_type_display_name?: string; /** @description The secret that was detected. */ - secret: string; + secret?: string; /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed: boolean | null; - push_protection_bypassed_by: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - push_protection_bypassed_at: string | null; - push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment when reviewing a push protection bypass. */ - push_protection_bypass_request_reviewer_comment: string | null; + push_protection_bypass_request_reviewer_comment?: string | null; /** @description An optional comment when requesting a push protection bypass. */ - push_protection_bypass_request_comment: string | null; + push_protection_bypass_request_comment?: string | null; /** * Format: uri * @description The URL to a push protection bypass request. */ - push_protection_bypass_request_html_url: string | null; + push_protection_bypass_request_html_url?: string | null; /** * @description The token status as of the latest validity check. * @enum {string} */ - validity: "active" | "inactive" | "unknown"; + validity?: "active" | "inactive" | "unknown"; /** @description Whether the detected secret was publicly leaked. */ - publicly_leaked: boolean | null; + 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`. */ + multi_repo?: boolean | null; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */ "secret-scanning-alert-resolution-comment": string | null; - /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { - /** - * @description The file path in the repository - * @example /example/secrets.txt - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** @description The API URL to get the associated blob resource */ - blob_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - commit_sha: string; - /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ - "secret-scanning-location-wiki-commit": { - /** - * @description The file path of the wiki page - * @example /example/Home.md - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** - * @description The GitHub URL to get the associated wiki page - * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - page_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_sha: string; - /** - * @description The GitHub URL to get the associated wiki commit - * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_url: string; - }; - /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ - "secret-scanning-location-issue-title": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_title_url: string; - }; - /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ - "secret-scanning-location-issue-body": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_body_url: string; - }; - /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ - "secret-scanning-location-issue-comment": { - /** - * Format: uri - * @description The API URL to get the issue comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - issue_comment_url: string; - }; - /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ - "secret-scanning-location-discussion-title": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082 - */ - discussion_title_url: string; - }; - /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ - "secret-scanning-location-discussion-body": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussion-4566270 - */ - discussion_body_url: string; - }; - /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ - "secret-scanning-location-discussion-comment": { - /** - * Format: uri - * @description The API URL to get the discussion comment where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 - */ - discussion_comment_url: string; - }; - /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ - "secret-scanning-location-pull-request-title": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_title_url: string; - }; - /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ - "secret-scanning-location-pull-request-body": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_body_url: string; - }; - /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ - "secret-scanning-location-pull-request-comment": { - /** - * Format: uri - * @description The API URL to get the pull request comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - pull_request_comment_url: string; - }; - /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ - "secret-scanning-location-pull-request-review": { - /** - * Format: uri - * @description The API URL to get the pull request review where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - */ - pull_request_review_url: string; - }; - /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ - "secret-scanning-location-pull-request-review-comment": { - /** - * Format: uri - * @description The API URL to get the pull request review comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - */ - pull_request_review_comment_url: string; - }; + /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */ + "secret-scanning-alert-assignee": string | null; "secret-scanning-location": { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - type: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; - details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; + type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; /** * @description The reason for bypassing push protection. @@ -33454,37 +36161,37 @@ export interface components { */ "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later"; "secret-scanning-push-protection-bypass": { - reason: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; + reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"]; /** * Format: date-time * @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - expire_at: string | null; + expire_at?: string | null; /** @description The token type this bypass is for. */ - token_type: string; + token_type?: string; }; /** @description Information on a single scan performed by secret scanning on the repository */ "secret-scanning-scan": { /** @description The type of scan */ - type: string; + type?: string; /** @description The state of the scan. Either "completed", "running", or "pending" */ - status: string; + status?: string; /** * Format: date-time * @description The time that the scan was completed. Empty if the scan is running */ - completed_at: string | null; + completed_at?: string | null; /** * Format: date-time * @description The time that the scan was started. Empty if the scan is pending */ - started_at: string | null; + started_at?: string | null; }; "secret-scanning-scan-history": { - incremental_scans: components["schemas"]["secret-scanning-scan"][]; - pattern_update_scans: components["schemas"]["secret-scanning-scan"][]; - backfill_scans: components["schemas"]["secret-scanning-scan"][]; - custom_pattern_backfill_scans: (components["schemas"]["secret-scanning-scan"] & { + incremental_scans?: components["schemas"]["secret-scanning-scan"][]; + pattern_update_scans?: components["schemas"]["secret-scanning-scan"][]; + backfill_scans?: components["schemas"]["secret-scanning-scan"][]; + custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & { /** @description Name of the custom pattern for custom pattern scans */ pattern_name?: string; /** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */ @@ -33571,13 +36278,13 @@ export interface components { }; "repository-advisory-update": { /** @description A short summary of the advisory. */ - summary: string; + summary?: string; /** @description A detailed description of what the advisory impacts. */ - description: string; + description?: string; /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; + cve_id?: string | null; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - vulnerabilities: { + vulnerabilities?: { /** @description The name of the package affected by the vulnerability. */ package: { ecosystem: components["schemas"]["security-advisory-ecosystems"]; @@ -33592,9 +36299,9 @@ export interface components { vulnerable_functions?: string[] | null; }[]; /** @description A list of Common Weakness Enumeration (CWE) IDs. */ - cwe_ids: string[] | null; + cwe_ids?: string[] | null; /** @description A list of users receiving credit for their participation in the security advisory. */ - credits: { + credits?: { /** @description The username of the user credited. */ login: string; type: components["schemas"]["security-advisory-credit-types"]; @@ -33603,18 +36310,18 @@ export interface components { * @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`. * @enum {string|null} */ - severity: "critical" | "high" | "medium" | "low" | null; + severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ - cvss_vector_string: string | null; + cvss_vector_string?: string | null; /** * @description The state of the advisory. * @enum {string} */ - state: "published" | "closed" | "draft"; + state?: "published" | "closed" | "draft"; /** @description A list of usernames who have been granted write access to the advisory. */ - collaborating_users: string[] | null; + collaborating_users?: string[] | null; /** @description A list of team slugs which have been granted write access to the advisory. */ - collaborating_teams: string[] | null; + collaborating_teams?: string[] | null; }; /** * Stargazer @@ -33671,10 +36378,10 @@ export interface components { * ] */ weeks: { - w: number; - a: number; - d: number; - c: number; + w?: number; + a?: number; + d?: number; + c?: number; }[]; }; /** Participation Stats */ @@ -33735,22 +36442,6 @@ export interface components { tarball_url: string; node_id: string; }; - /** - * Tag protection - * @description Tag protection - */ - "tag-protection": { - /** @example 2 */ - id?: number; - /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - /** @example 2011-01-26T19:01:12Z */ - updated_at?: string; - /** @example true */ - enabled?: boolean; - /** @example v1.* */ - pattern: string; - }; /** * Topic * @description A topic aggregates entities that are related to a subject. @@ -33815,13 +36506,13 @@ export interface components { }; /** Search Result Text Matches */ "search-result-text-matches": { - object_url: string; - object_type: string | null; - property: string; - fragment: string; - matches: { - text: string; - indices: number[]; + object_url?: string; + object_type?: string | null; + property?: string; + fragment?: string; + matches?: { + text?: string; + indices?: number[]; }[]; }[]; /** @@ -33887,9 +36578,9 @@ export interface components { author: components["schemas"]["nullable-simple-user"]; committer: components["schemas"]["nullable-git-user"]; parents: { - url: string; - html_url: string; - sha: string; + url?: string; + html_url?: string; + sha?: string; }[]; repository: components["schemas"]["minimal-repository"]; score: number; @@ -33923,20 +36614,17 @@ export interface components { user: components["schemas"]["nullable-simple-user"]; labels: { /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - color: string; - default: boolean; - description: string | null; + id?: number; + node_id?: string; + url?: string; + name?: string; + color?: string; + default?: boolean; + description?: string | null; }[]; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -33970,7 +36658,9 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; reactions?: components["schemas"]["reaction-rollup"]; }; /** @@ -34089,6 +36779,12 @@ export interface components { has_wiki: boolean; has_downloads: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -34137,19 +36833,19 @@ export interface components { logo_url?: string | null; text_matches?: components["schemas"]["search-result-text-matches"]; related?: { - topic_relation: { - id: number; - name: string; - topic_id: number; - relation_type: string; + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; }; }[] | null; aliases?: { - topic_relation: { - id: number; - name: string; - topic_id: number; - relation_type: string; + topic_relation?: { + id?: number; + name?: string; + topic_id?: number; + relation_type?: string; }; }[] | null; }; @@ -34398,38 +37094,38 @@ export interface components { * @description State of the latest export * @example succeeded | failed | in_progress */ - state: string | null; + state?: string | null; /** * Format: date-time * @description Completion time of the last export operation * @example 2021-01-01T19:01:12Z */ - completed_at: string | null; + completed_at?: string | null; /** * @description Name of the exported branch * @example codespace-monalisa-octocat-hello-world-g4wpq6h95q */ - branch: string | null; + branch?: string | null; /** * @description Git commit SHA of the exported branch * @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 */ - sha: string | null; + sha?: string | null; /** * @description Id for the export details * @example latest */ - id: string; + id?: string; /** * @description Url for fetching export details * @example https://api.github.com/user/codespaces/:name/exports/latest */ - export_url: string; + export_url?: string; /** * @description Web url for the exported branch * @example https://github.com/octocat/hello-world/tree/:branch */ - html_url: string | null; + html_url?: string | null; }; /** * Codespace @@ -34503,21 +37199,21 @@ export interface components { * @description The number of commits the local repository is ahead of the remote. * @example 0 */ - ahead: number; + ahead?: number; /** * @description The number of commits the local repository is behind the remote. * @example 0 */ - behind: number; + behind?: number; /** @description Whether the local repository has unpushed changes. */ - has_unpushed_changes: boolean; + has_unpushed_changes?: boolean; /** @description Whether the local repository has uncommitted changes. */ - has_uncommitted_changes: boolean; + has_uncommitted_changes?: boolean; /** * @description The current branch (or SHA if in detached HEAD state) of the local repository. * @example main */ - ref: string; + ref?: string; }; /** * @description The initally assigned location of a new codespace. @@ -34563,7 +37259,7 @@ export interface components { recent_folders: string[]; runtime_constraints?: { /** @description The privacy settings a user can select from when forwarding a port. */ - allowed_port_privacy_settings: string[] | null; + allowed_port_privacy_settings?: string[] | null; }; /** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */ pending_operation?: boolean | null; @@ -34626,8 +37322,8 @@ export interface components { * ] */ emails: { - email: string; - verified: boolean; + email?: string; + verified?: boolean; }[]; /** * @example [ @@ -34649,23 +37345,23 @@ export interface components { */ subkeys: { /** Format: int64 */ - id: number; - primary_key_id: number; - key_id: string; - public_key: string; - emails: { - email: string; - verified: boolean; + id?: number; + primary_key_id?: number; + key_id?: string; + public_key?: string; + emails?: { + email?: string; + verified?: boolean; }[]; - subkeys: unknown[]; - can_sign: boolean; - can_encrypt_comms: boolean; - can_encrypt_storage: boolean; - can_certify: boolean; - created_at: string; - expires_at: string | null; - raw_key: string | null; - revoked: boolean; + subkeys?: unknown[]; + can_sign?: boolean; + can_encrypt_comms?: boolean; + can_encrypt_storage?: boolean; + can_certify?: boolean; + created_at?: string; + expires_at?: string | null; + raw_key?: string | null; + revoked?: boolean; }[]; /** @example true */ can_sign: boolean; @@ -34698,6 +37394,8 @@ export interface components { created_at: string; verified: boolean; read_only: boolean; + /** Format: date-time */ + last_used?: string | null; }; /** Marketplace Account */ "marketplace-account": { @@ -34770,45 +37468,6 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; - /** - * Sigstore Bundle v0.1 - * @description Sigstore Bundle v0.1 - */ - "sigstore-bundle-0": { - mediaType: string; - verificationMaterial: { - x509CertificateChain: { - certificates: { - rawBytes: string; - }[]; - }; - tlogEntries: { - logIndex: string; - logId: { - keyId: string; - }; - kindVersion: { - kind: string; - version: string; - }; - integratedTime: string; - inclusionPromise: { - signedEntryTimestamp: string; - }; - inclusionProof: string | null; - canonicalizedBody: string; - }[]; - timestampVerificationData: string | null; - }; - dsseEnvelope: { - payload: string; - payloadType: string; - signatures: { - sig: string; - keyid: string; - }[]; - }; - }; /** * Hovercard * @description Hovercard @@ -34826,6 +37485,114 @@ export interface components { "key-simple": { id: number; key: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + last_used?: string | null; + }; + "billing-premium-request-usage-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report-user": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; /** * Enterprise @@ -35177,6 +37944,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -35211,111 +37989,111 @@ export interface components { */ allow_rebase_merge: boolean; template_repository?: { - id: number; - node_id: string; - name: string; - full_name: string; - owner: { - login: string; - id: number; - node_id: string; - avatar_url: string; - gravatar_id: string; - url: string; - html_url: string; - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; - subscriptions_url: string; - organizations_url: string; - repos_url: string; - events_url: string; - received_events_url: string; - type: string; - site_admin: boolean; + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; }; - private: boolean; - html_url: string; - description: string; - fork: boolean; - url: string; - 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; - contributors_url: string; - deployments_url: string; - downloads_url: string; - events_url: string; - forks_url: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - notifications_url: string; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - clone_url: string; - mirror_url: string; - hooks_url: string; - svn_url: string; - homepage: string; - language: string; - forks_count: number; - stargazers_count: number; - watchers_count: number; - size: number; - default_branch: string; - open_issues_count: number; - is_template: boolean; - topics: string[]; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_downloads: boolean; - archived: boolean; - disabled: boolean; - visibility: string; - pushed_at: string; - created_at: string; - updated_at: string; - permissions: { - admin: boolean; - maintain: boolean; - push: boolean; - triage: boolean; - pull: boolean; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + 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; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; - allow_rebase_merge: boolean; - temp_clone_token: string; - allow_squash_merge: boolean; - allow_auto_merge: boolean; - delete_branch_on_merge: boolean; - allow_update_branch: boolean; - use_squash_pr_title_as_default: boolean; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -35323,7 +38101,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - squash_merge_commit_title: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -35332,7 +38110,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - squash_merge_commit_message: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -35340,7 +38118,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - merge_commit_title: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -35349,10 +38127,10 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - merge_commit_message: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_merge_commit: boolean; - subscribers_count: number; - network_count: number; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; } | null; temp_clone_token?: string; /** @@ -35496,46 +38274,46 @@ export interface components { /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ - after: string | null; - app: components["schemas"]["integration"]; + after?: string | null; + app?: components["schemas"]["integration"]; /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */ - before: string | null; + before?: string | null; /** * @example neutral * @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; + conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null; /** Format: date-time */ - created_at: string; + created_at?: string; /** @example master */ - head_branch: string | null; + head_branch?: string | null; /** * @description The SHA of the head commit that is being checked. * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */ - head_sha: string; + head_sha?: string; /** @example 5 */ - id: number; + id?: number; /** @example MDEwOkNoZWNrU3VpdGU1 */ - node_id: string; - pull_requests: components["schemas"]["pull-request-minimal"][]; - repository: components["schemas"]["minimal-repository"]; + node_id?: string; + pull_requests?: components["schemas"]["pull-request-minimal"][]; + repository?: components["schemas"]["minimal-repository"]; /** * @example completed * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "pending" | "waiting"; + status?: "queued" | "in_progress" | "completed" | "pending" | "waiting"; /** Format: date-time */ - updated_at: string; + updated_at?: string; /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */ - url: string; + url?: string; }; /** * CheckRun * @description A check performed on the code of a given code change */ "check-run-with-simple-check-suite": { - app: components["schemas"]["nullable-integration"]; + app: components["schemas"]["integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** * Format: date-time @@ -35634,30 +38412,105 @@ export interface components { /** Format: uri */ url: string; } | null; - webhooks_approver: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + /** + * Deployment + * @description A request for a specific ref(branch,sha,tag) to be deployed + */ + "nullable-deployment": { + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1 + */ + url: string; + /** + * Format: int64 + * @description Unique identifier of the deployment + * @example 42 + */ id: number; - login: string; + /** @example MDEwOkRlcGxveW1lbnQx */ node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ + sha: string; + /** + * @description The ref to deploy. This can be a branch, tag, or sha. + * @example topic-branch + */ + ref: string; + /** + * @description Parameter to specify a task to execute + * @example deploy + */ + task: string; + payload: { + [key: string]: unknown; + } | string; + /** @example staging */ + original_environment?: string; + /** + * @description Name for the target deployment environment. + * @example production + */ + environment: string; + /** @example Deploy request from hubot */ + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + created_at: string; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + */ + statuses_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example + */ + repository_url: string; + /** + * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. + * @example true + */ + transient_environment?: boolean; + /** + * @description Specifies if the given environment is one that end-users directly interact with. Default: false. + * @example true + */ + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + } | null; + webhooks_approver: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; webhooks_reviewers: { /** User */ - reviewer: { + reviewer?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35694,7 +38547,7 @@ export interface components { url?: string; } | null; /** @enum {string} */ - type: "User"; + type?: "User"; }[]; webhooks_workflow_job_run: { conclusion: unknown; @@ -35818,15 +38671,39 @@ export interface components { user_view_type?: string; } | null; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; + webhooks_comment: { + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: number | null; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + updated_at: string; /** User */ - answer_chosen_by: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35842,6 +38719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35863,37 +38741,78 @@ export interface components { url?: string; user_view_type?: string; } | null; - answer_html_url: string | null; + }; + /** Label */ + webhooks_label: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }; + /** @description An array of repository objects that the installation can access. */ + webhooks_repositories: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + webhooks_repositories_added: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** + * @description Describe whether all repositories have been selected or there's a selection involved + * @enum {string} + */ + webhooks_repository_selection: "all" | "selected"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + webhooks_issue_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue comment */ body: string; - category: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; /** Format: date-time */ created_at: string; + /** Format: uri */ html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ id: number; - locked: boolean; + /** Format: uri */ + issue_url: string; node_id: string; - number: number; + performed_via_github_app: components["schemas"]["integration"]; /** Reactions */ - reactions?: { + reactions: { "+1": number; "-1": number; confused: number; @@ -35906,226 +38825,13 @@ export interface components { /** Format: uri */ url: string; }; - repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; - timeline_url?: string; - title: string; /** Format: date-time */ updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - labels?: components["schemas"]["label"][]; - }; - webhooks_comment: { - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - repository_url: string; - updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - /** Label */ - webhooks_label: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }; - /** @description An array of repository objects that the installation can access. */ - webhooks_repositories: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were added to the installation. */ - webhooks_repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - webhooks_repository_selection: "all" | "selected"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - webhooks_issue_comment: { - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - body: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - /** - * Format: int64 - * @description Unique identifier of the issue comment - */ - id: number; - /** Format: uri */ - issue_url: string; - node_id: string; - performed_via_github_app: components["schemas"]["integration"]; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue comment - */ - url: string; + /** + * Format: uri + * @description URL for the issue comment + */ + url: string; /** User */ user: { /** Format: uri */ @@ -36165,10 +38871,11 @@ export interface components { url?: string; user_view_type?: string; } | null; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** @description The changes to the comment. */ webhooks_changes: { - body: { + body?: { /** @description The previous version of the body. */ from: string; }; @@ -36429,75 +39136,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -36506,15 +39211,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -36532,12 +39237,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36548,6 +39251,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36923,75 +39627,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -37000,15 +39702,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -37026,12 +39728,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37042,6 +39742,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37227,6 +39928,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -37242,6 +39958,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Merge Group @@ -37501,6 +40232,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -37535,111 +40277,111 @@ export interface components { */ allow_rebase_merge: boolean; template_repository?: { - id: number; - node_id: string; - name: string; - full_name: string; - owner: { - login: string; - id: number; - node_id: string; - avatar_url: string; - gravatar_id: string; - url: string; - html_url: string; - followers_url: string; - following_url: string; - gists_url: string; - starred_url: string; - subscriptions_url: string; - organizations_url: string; - repos_url: string; - events_url: string; - received_events_url: string; - type: string; - site_admin: boolean; + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; + avatar_url?: string; + gravatar_id?: string; + url?: string; + html_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + starred_url?: string; + subscriptions_url?: string; + organizations_url?: string; + repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: string; + site_admin?: boolean; }; - private: boolean; - html_url: string; - description: string; - fork: boolean; - url: string; - 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; - contributors_url: string; - deployments_url: string; - downloads_url: string; - events_url: string; - forks_url: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - notifications_url: string; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - clone_url: string; - mirror_url: string; - hooks_url: string; - svn_url: string; - homepage: string; - language: string; - forks_count: number; - stargazers_count: number; - watchers_count: number; - size: number; - default_branch: string; - open_issues_count: number; - is_template: boolean; - topics: string[]; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_downloads: boolean; - archived: boolean; - disabled: boolean; - visibility: string; - pushed_at: string; - created_at: string; - updated_at: string; - permissions: { - admin: boolean; - maintain: boolean; - push: boolean; - triage: boolean; - pull: boolean; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + 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; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; }; - allow_rebase_merge: boolean; - temp_clone_token: string; - allow_squash_merge: boolean; - allow_auto_merge: boolean; - delete_branch_on_merge: boolean; - allow_update_branch: boolean; - use_squash_pr_title_as_default: boolean; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description The default value for a squash merge commit title: * @@ -37647,7 +40389,7 @@ export interface components { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - squash_merge_commit_title: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -37656,7 +40398,7 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - squash_merge_commit_message: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description The default value for a merge commit title. * @@ -37664,7 +40406,7 @@ export interface components { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - merge_commit_title: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -37673,10 +40415,10 @@ export interface components { * - `BLANK` - default to a blank commit message. * @enum {string} */ - merge_commit_message: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_merge_commit: boolean; - subscribers_count: number; - network_count: number; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; } | null; temp_clone_token?: string; /** @@ -37846,6 +40588,20 @@ export interface components { /** Format: uri */ organization_url: string; role: string; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; state: string; /** Format: uri */ url: string; @@ -37899,37 +40655,37 @@ export interface components { owner: components["schemas"]["simple-user"]; /** @description New requested permissions, categorized by type of permission. */ permissions_added: { - organization: { + organization?: { [key: string]: string; }; - repository: { + repository?: { [key: string]: string; }; - other: { + other?: { [key: string]: string; }; }; /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ permissions_upgraded: { - organization: { + organization?: { [key: string]: string; }; - repository: { + repository?: { [key: string]: string; }; - other: { + other?: { [key: string]: string; }; }; /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ permissions_result: { - organization: { + organization?: { [key: string]: string; }; - repository: { + repository?: { [key: string]: string; }; - other: { + other?: { [key: string]: string; }; }; @@ -38109,79 +40865,44 @@ export interface components { /** Format: uri */ url: string; }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - "projects-v2": { - id: number; - node_id: string; - owner: components["schemas"]["simple-user"]; - creator: components["schemas"]["simple-user"]; - title: string; - description: string | null; - public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - updated_at: string; - number: number; - short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - deleted_at: string | null; - deleted_by: components["schemas"]["nullable-simple-user"]; - }; webhooks_project_changes: { - archived_at: { + archived_at?: { /** Format: date-time */ - from: string | null; + from?: string | null; /** Format: date-time */ - to: string | null; + to?: string | null; }; }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; /** * Projects v2 Item * @description An item belonging to a project */ "projects-v2-item": { + /** @description The unique identifier of the project item. */ id: number; + /** @description The node ID of the project item. */ node_id?: string; + /** @description The node ID of the project that contains this item. */ project_node_id?: string; + /** @description The node ID of the content represented by this item. */ content_node_id: string; content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the item was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the item was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; /** * Format: date-time + * @description The time when the item was archived. * @example 2022-04-28T12:00:00Z */ archived_at: string | null; @@ -38191,9 +40912,13 @@ export interface components { * @description An option for a single select field */ "projects-v2-single-select-option": { + /** @description The unique identifier of the option. */ id: string; + /** @description The display name of the option. */ name: string; + /** @description The color associated with the option. */ color?: string | null; + /** @description A short description of the option. */ description?: string | null; }; /** @@ -38201,39 +40926,57 @@ export interface components { * @description An iteration setting for an iteration field */ "projects-v2-iteration-setting": { + /** @description The unique identifier of the iteration setting. */ id: string; + /** @description The iteration title. */ title: string; + /** @description The iteration title, rendered as HTML. */ + title_html?: string; + /** @description The duration of the iteration in days. */ duration?: number | null; + /** @description The start date of the iteration. */ start_date?: string | null; + /** @description Whether the iteration has been completed. */ + completed?: boolean; }; /** * Projects v2 Status Update * @description An status update belonging to a project */ "projects-v2-status-update": { + /** @description The unique identifier of the status update. */ id: number; + /** @description The node ID of the status update. */ node_id: string; + /** @description The node ID of the project that this status update belongs to. */ project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the status update was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the status update was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; - /** @enum {string|null} */ + /** + * @description The current status. + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** * Format: date + * @description The start date of the period covered by the update. * @example 2022-04-28 */ start_date?: string; /** * Format: date + * @description The target date associated with the update. * @example 2022-04-28 */ target_date?: string; @@ -38589,6 +41332,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -38935,6 +41688,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -39670,6 +42433,8 @@ export interface components { state: string; /** Format: date-time */ submitted_at: string | null; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -39729,6 +42494,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -39819,6 +42585,8 @@ export interface components { body: string | null; /** Format: date-time */ created_at: string | null; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ @@ -39826,6 +42594,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -39877,6 +42647,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -39974,6 +42745,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -40000,6 +42773,8 @@ export interface components { tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri-template */ upload_url: string; /** Format: uri */ @@ -40067,7 +42842,7 @@ export interface components { number: number; severity: string; /** @enum {string} */ - state: "open"; + state: "auto_dismissed" | "open"; }; /** * @description The reason for resolving the alert. @@ -40075,59 +42850,60 @@ export interface components { */ "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; "secret-scanning-alert-webhook": { - number: components["schemas"]["alert-number"]; - created_at: components["schemas"]["alert-created-at"]; - updated_at: components["schemas"]["nullable-alert-updated-at"]; - url: components["schemas"]["alert-url"]; - html_url: components["schemas"]["alert-html-url"]; + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri * @description The REST API URL of the code locations for this alert. */ - locations_url: string; - resolution: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + locations_url?: string; + resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; /** * Format: date-time * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - resolved_at: string | null; - resolved_by: components["schemas"]["nullable-simple-user"]; + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment to resolve an alert. */ - resolution_comment: string | null; + resolution_comment?: string | null; /** @description The type of secret that secret scanning detected. */ - secret_type: string; + secret_type?: string; /** * @description User-friendly name for the detected secret, matching the `secret_type`. * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */ - secret_type_display_name: string; + secret_type_display_name?: string; /** * @description The token status as of the latest validity check. * @enum {string} */ - validity: "active" | "inactive" | "unknown"; + validity?: "active" | "inactive" | "unknown"; /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed: boolean | null; - push_protection_bypassed_by: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; /** * Format: date-time * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - push_protection_bypassed_at: string | null; - push_protection_bypass_request_reviewer: components["schemas"]["nullable-simple-user"]; + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; /** @description An optional comment when reviewing a push protection bypass. */ - push_protection_bypass_request_reviewer_comment: string | null; + push_protection_bypass_request_reviewer_comment?: string | null; /** @description An optional comment when requesting a push protection bypass. */ - push_protection_bypass_request_comment: string | null; + push_protection_bypass_request_comment?: string | null; /** * Format: uri * @description The URL to a push protection bypass request. */ - push_protection_bypass_request_html_url: string | null; + push_protection_bypass_request_html_url?: string | null; /** @description Whether the detected secret was publicly leaked. */ - publicly_leaked: boolean | null; + publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ - multi_repo: boolean | null; + multi_repo?: boolean | null; + assigned_to?: components["schemas"]["nullable-simple-user"]; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -40170,25 +42946,25 @@ export interface components { webhooks_sponsorship: { created_at: string; maintainer?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; node_id: string; privacy_level: string; @@ -40351,6 +43127,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -40369,6 +43160,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** branch protection configuration disabled event */ "webhook-branch-protection-configuration-disabled": { @@ -40418,40 +43224,40 @@ export interface components { action: "edited"; /** @description If the action was `edited`, the changes to the rule. */ changes?: { - admin_enforced: { + admin_enforced?: { from: boolean | null; }; - authorized_actor_names: { + authorized_actor_names?: { from: string[]; }; - authorized_actors_only: { + authorized_actors_only?: { from: boolean | null; }; - authorized_dismissal_actors_only: { + authorized_dismissal_actors_only?: { from: boolean | null; }; - linear_history_requirement_enforcement_level: { + linear_history_requirement_enforcement_level?: { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; - lock_branch_enforcement_level: { + lock_branch_enforcement_level?: { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; - lock_allows_fork_sync: { + lock_allows_fork_sync?: { from: boolean | null; }; - pull_request_reviews_enforcement_level: { + pull_request_reviews_enforcement_level?: { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; - require_last_push_approval: { + require_last_push_approval?: { from: boolean | null; }; - required_status_checks: { + required_status_checks?: { from: string[]; }; - required_status_checks_enforcement_level: { + required_status_checks_enforcement_level?: { /** @enum {string} */ from: "off" | "non_admins" | "everyone"; }; @@ -40469,6 +43275,7 @@ export interface components { action?: "completed"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40487,6 +43294,7 @@ export interface components { action?: "created"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40505,12 +43313,13 @@ export interface components { action: "requested_action"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; /** @description The action requested by the user. */ requested_action?: { /** @description The integrator reference of the action requested by the user. */ - identifier: string; + identifier?: string; }; sender: components["schemas"]["simple-user"]; }; @@ -40528,6 +43337,7 @@ export interface components { action?: "rerequested"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40609,75 +43419,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write" | "admin"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -40853,75 +43661,83 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + artifact_metadata?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + attestations?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + copilot_requests?: "write"; /** @enum {string} */ - emails: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + merge_queues?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + models?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - pages: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write" | "admin"; + packages?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - single_file: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -41097,75 +43913,83 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + artifact_metadata?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + attestations?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + copilot_requests?: "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + merge_queues?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + models?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - packages: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write" | "admin"; + pages?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -41278,6 +44102,7 @@ export interface components { action: "appeared_in_branch"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41350,14 +44175,14 @@ export interface components { /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ environment: string; location?: { - end_column: number; - end_line: number; - path: string; - start_column: number; - start_line: number; + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; message?: { - text: string; + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ ref: string; @@ -41408,6 +44233,7 @@ export interface components { action: "closed_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41480,14 +44306,14 @@ export interface components { /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ environment: string; location?: { - end_column: number; - end_line: number; - path: string; - start_column: number; - start_line: number; + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; message?: { - text: string; + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ ref: string; @@ -41530,129 +44356,170 @@ export interface components { }; /** Format: uri */ url: string; - }; - commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - ref: components["schemas"]["webhooks_code_scanning_ref"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** code_scanning_alert created event */ - "webhook-code-scanning-alert-created": { - /** @enum {string} */ - action: "created"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: unknown; - dismissed_by: unknown; - dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: unknown; - /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - fixed_at?: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - instances_url?: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column: number; - end_line: number; - path: string; - start_column: number; - start_line: number; - }; - message?: { - text: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. - * @enum {string|null} - */ - state: "open" | "dismissed" | null; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - } | null; - updated_at?: string | null; - /** Format: uri */ - url: string; - }; - commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - ref: components["schemas"]["webhooks_code_scanning_ref"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** code_scanning_alert fixed event */ - "webhook-code-scanning-alert-fixed": { - /** @enum {string} */ - action: "fixed"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; /** User */ - dismissed_by: { + dismissal_approved_by?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** code_scanning_alert created event */ + "webhook-code-scanning-alert-created": { + /** @enum {string} */ + action: "created"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string | null; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: unknown; + dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: unknown; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + instances_url?: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | null; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + } | null; + updated_at?: string | null; + /** Format: uri */ + url: string; + dismissal_approved_by?: unknown; + assignees?: components["schemas"]["simple-user"][]; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** code_scanning_alert fixed event */ + "webhook-code-scanning-alert-fixed": { + /** @enum {string} */ + action: "fixed"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -41715,14 +44582,14 @@ export interface components { /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ environment: string; location?: { - end_column: number; - end_line: number; - path: string; - start_column: number; - start_line: number; + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; message?: { - text: string; + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ ref: string; @@ -41780,6 +44647,7 @@ export interface components { action: "reopened"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41798,6 +44666,7 @@ export interface components { * @description The GitHub URL of the alert resource. */ html_url: string; + instances_url?: string; /** Alert Instance */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ @@ -41809,14 +44678,14 @@ export interface components { /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ environment: string; location?: { - end_column: number; - end_line: number; - path: string; - start_column: number; - start_line: number; + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; message?: { - text: string; + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ ref: string; @@ -41857,9 +44726,11 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; + updated_at?: string | null; /** Format: uri */ url: string; - } | null; + dismissal_approved_by?: unknown; + }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41876,6 +44747,7 @@ export interface components { action: "reopened_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41905,14 +44777,14 @@ export interface components { /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ environment: string; location?: { - end_column: number; - end_line: number; - path: string; - start_column: number; - start_line: number; + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; }; message?: { - text: string; + text?: string; }; /** @description The full Git reference, formatted as `refs/heads/`. */ ref: string; @@ -41957,6 +44829,135 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** code_scanning_alert updated_assignment event */ + "webhook-code-scanning-alert-updated-assignment": { + /** @enum {string} */ + action: "updated_assignment"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | "fixed" | null; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + 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"]; + }; /** commit_comment created event */ "webhook-commit-comment-created": { /** @@ -42094,6 +45095,16 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** custom property promoted to business event */ + "webhook-custom-property-promoted-to-enterprise": { + /** @enum {string} */ + action: "promote_to_enterprise"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ @@ -42133,6 +45144,17 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** Dependabot alert assignees changed event */ + "webhook-dependabot-alert-assignees-changed": { + /** @enum {string} */ + action: "assignees_changed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { /** @enum {string} */ @@ -42346,75 +45368,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -42494,71 +45514,71 @@ export interface components { head_branch: string; head_commit?: unknown; head_repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: unknown; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; head_sha: string; /** Format: uri */ @@ -42604,71 +45624,71 @@ export interface components { sha: string; }[] | null; repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: unknown; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; rerun_url?: string; run_attempt: number; @@ -42726,22 +45746,26 @@ export interface components { /** deployment protection rule requested event */ "webhook-deployment-protection-rule-requested": { /** @enum {string} */ - action: "requested"; + action?: "requested"; /** @description The name of the environment that has the deployment protection rule. */ - environment: string; + environment?: string; /** @description The event that triggered the deployment protection rule. */ - event: string; + event?: string; + /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + sha?: string; + /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + ref?: string; /** * Format: uri * @description The URL to review the deployment protection rule. */ - deployment_callback_url: string; - deployment: components["schemas"]["deployment"]; - pull_requests: components["schemas"]["pull-request"][]; - repository: components["schemas"]["repository-webhooks"]; - organization: components["schemas"]["organization-simple-webhooks"]; - installation: components["schemas"]["simple-installation"]; - sender: components["schemas"]["simple-user"]; + deployment_callback_url?: string; + deployment?: components["schemas"]["nullable-deployment"]; + pull_requests?: components["schemas"]["pull-request"][]; + repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + sender?: components["schemas"]["simple-user"]; }; "webhook-deployment-review-approved": { /** @enum {string} */ @@ -42757,14 +45781,14 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { - conclusion: unknown; - created_at: string; - environment: string; - html_url: string; - id: number; - name: string | null; - status: string; - updated_at: string; + conclusion?: unknown; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; }[]; /** Deployment Workflow Run */ workflow_run: { @@ -42820,72 +45844,72 @@ export interface components { head_branch: string; head_commit?: Record | null; head_repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: string | null; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; head_sha: string; /** Format: uri */ @@ -42931,72 +45955,72 @@ export interface components { sha: string; }[] | null; repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: string | null; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; rerun_url?: string; run_attempt: number; @@ -43065,14 +46089,14 @@ export interface components { since: string; workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; workflow_job_runs?: { - conclusion: string | null; - created_at: string; - environment: string; - html_url: string; - id: number; - name: string | null; - status: string; - updated_at: string; + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; }[]; /** Deployment Workflow Run */ workflow_run: { @@ -43127,72 +46151,72 @@ export interface components { head_branch: string; head_commit?: Record | null; head_repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: string | null; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; head_sha: string; /** Format: uri */ @@ -43238,72 +46262,72 @@ export interface components { sha: string; }[] | null; repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: string | null; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; rerun_url?: string; run_attempt: number; @@ -43370,7 +46394,7 @@ export interface components { requestor: components["schemas"]["webhooks_user"]; reviewers: { /** User */ - reviewer: { + reviewer?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -43408,7 +46432,7 @@ export interface components { user_view_type?: string; } | null; /** @enum {string} */ - type: "User" | "Team"; + type?: "User" | "Team"; }[]; sender: components["schemas"]["simple-user"]; since: string; @@ -43475,72 +46499,72 @@ export interface components { head_branch: string; head_commit?: Record | null; head_repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: string | null; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; head_sha: string; /** Format: uri */ @@ -43586,72 +46610,72 @@ export interface components { sha: string; }[] | null; repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: string | null; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; rerun_url?: string; run_attempt: number; @@ -43851,75 +46875,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -44051,75 +47073,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -44196,71 +47216,71 @@ export interface components { head_branch: string; head_commit?: unknown; head_repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: unknown; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; head_sha: string; /** Format: uri */ @@ -44306,71 +47326,71 @@ export interface components { sha: string; }[] | null; repository?: { - 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; - contributors_url: string; - deployments_url: string; - description: unknown; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - hooks_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + 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; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; - private: boolean; - pulls_url: string; - releases_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; rerun_url?: string; run_attempt: number; @@ -44544,10 +47564,10 @@ export interface components { /** @enum {string} */ action: "edited"; changes?: { - body: { + body?: { from: string; }; - title: { + title?: { from: string; }; }; @@ -44963,24 +47983,24 @@ export interface components { open_issues?: number; open_issues_count?: number; owner?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; private?: boolean; public?: boolean; @@ -45090,14 +48110,14 @@ export interface components { repositories_added: components["schemas"]["webhooks_repositories_added"]; /** @description An array of repository objects, which were removed from the installation. */ repositories_removed: { - full_name: string; + full_name?: string; /** @description Unique identifier of the repository */ - id: number; + id?: number; /** @description The name of the repository. */ - name: string; - node_id: string; + name?: string; + node_id?: string; /** @description Whether the repository is private or public. */ - private: boolean; + private?: boolean; }[]; repository?: components["schemas"]["repository-webhooks"]; repository_selection: components["schemas"]["webhooks_repository_selection"]; @@ -45183,10 +48203,10 @@ export interface components { /** @enum {string} */ action: "renamed"; changes: { - login: { + login?: { from: string; }; - slug: { + slug?: { from: string; }; }; @@ -45260,6 +48280,7 @@ export interface components { * @description URL for the issue comment */ url: string; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -45555,75 +48576,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write" | "admin"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -45632,15 +48651,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -45658,12 +48677,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45674,6 +48689,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -45792,16 +48808,16 @@ export interface components { number?: number; performed_via_github_app?: Record | null; reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; }; repository_url?: string; /** @@ -45814,25 +48830,25 @@ export interface components { updated_at?: string; url?: string; user?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -46099,75 +49115,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -46176,15 +49190,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -46202,12 +49216,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46218,6 +49228,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46336,16 +49347,16 @@ export interface components { number?: number; performed_via_github_app?: Record | null; reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; }; repository_url?: string; /** @@ -46358,26 +49369,26 @@ export interface components { updated_at?: string; url?: string; user?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -46645,75 +49656,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -46722,15 +49731,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -46748,12 +49757,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46764,6 +49769,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46882,16 +49888,16 @@ export interface components { number?: number; performed_via_github_app?: Record | null; reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; }; repository_url?: string; /** @@ -46904,56 +49910,39 @@ export interface components { updated_at?: string; url?: string; user?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; }; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "closed"; + /** issue_comment pinned event */ + "webhook-issue-comment-pinned": { + /** @enum {string} */ + action: "pinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -47155,7 +50144,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47206,75 +50195,75 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + team_discussions?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -47283,15 +50272,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -47309,12 +50298,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47325,6 +50310,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -47373,80 +50359,132 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; assignees?: (Record | null)[]; author_association?: string; body?: string | null; - closed_at: string | null; + closed_at?: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; labels_url?: string; - locked?: boolean; + locked: boolean; milestone?: Record | null; node_id?: string; number?: number; performed_via_github_app?: Record | null; reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - url: string; + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; }; repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; timeline_url?: string; title?: string; updated_at?: string; url?: string; user?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; /** Format: int64 */ - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issue_comment unpinned event */ + "webhook-issue-comment-unpinned": { /** @enum {string} */ - action: "deleted"; + action: "unpinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -47483,7 +50521,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47520,9 +50558,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47607,7 +50646,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47647,7 +50686,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47698,75 +50737,75 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + team_discussions?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -47775,15 +50814,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -47801,12 +50840,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47817,6 +50852,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -47858,31 +50894,15 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; - }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { - /** @enum {string} */ - action: "demilestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } & { + active_lock_reason?: string | null; /** User */ - assignee?: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47917,8 +50937,182 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - assignees: ({ + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** blocked by issue added event */ + "webhook-issue-dependencies-blocked-by-added": { + /** @enum {string} */ + action: "blocked_by_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocked by issue removed event */ + "webhook-issue-dependencies-blocked-by-removed": { + /** @enum {string} */ + action: "blocked_by_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue added event */ + "webhook-issue-dependencies-blocking-added": { + /** @enum {string} */ + action: "blocking_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue removed event */ + "webhook-issue-dependencies-blocking-removed": { + /** @enum {string} */ + action: "blocking_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47953,6 +51147,44 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47976,7 +51208,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -47990,7 +51222,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -48077,7 +51309,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48128,75 +51360,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -48205,15 +51435,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -48231,12 +51461,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48247,6 +51475,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48293,27 +51522,76 @@ export interface components { url?: string; user_view_type?: string; } | null; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels?: (Record | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** @enum {string} */ + state: "closed" | "open"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; }; - milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body: { - /** @description The previous version of the body. */ - from: string; - }; - title: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -48356,7 +51634,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48393,9 +51671,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48480,7 +51759,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48520,7 +51799,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48571,75 +51850,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -48648,15 +51925,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -48674,12 +51951,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48690,6 +51965,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48731,21 +52007,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** 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"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "labeled"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -48791,7 +52066,6 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48851,7 +52125,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -48865,7 +52139,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -48952,7 +52226,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49003,75 +52277,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -49080,15 +52352,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -49106,12 +52378,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49122,6 +52392,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -49169,15 +52440,26 @@ export interface components { user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "locked"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -49220,7 +52502,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -49257,10 +52539,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49284,7 +52565,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -49298,11 +52579,10 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -49346,7 +52626,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -49386,7 +52666,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49437,75 +52717,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -49514,15 +52792,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -49540,12 +52818,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49554,6 +52830,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -49597,20 +52874,21 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; }; - /** issues milestoned event */ - "webhook-issues-milestoned": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "milestoned"; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -49653,9 +52931,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49689,7 +52968,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -49715,7 +52994,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -49729,7 +53008,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -49816,7 +53095,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49867,75 +53146,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -49944,15 +53221,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -49970,12 +53247,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49984,6 +53259,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -50027,31 +53303,158 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - milestone: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues opened event */ - "webhook-issues-opened": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "opened"; - changes?: { + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - old_issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + /** @enum {boolean} */ + locked: true; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; /** User */ - assignee?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50088,7 +53491,738 @@ export interface components { url?: string; user_view_type?: string; } | null; - assignees: ({ + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + /** @description Title of the issue */ + title: string; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues milestoned event */ + "webhook-issues-milestoned": { + /** @enum {string} */ + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; + type?: components["schemas"]["issue-type"]; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues opened event */ + "webhook-issues-opened": { + /** @enum {string} */ + action: "opened"; + changes?: { + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + old_issue: { + /** @enum {string|null} */ + active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50130,21 +54264,21 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - body: string | null; + body?: string | null; /** Format: date-time */ - closed_at: string | null; - comments: number; + closed_at?: string | null; + comments?: number; /** Format: uri */ - comments_url: string; + comments_url?: string; /** Format: date-time */ - created_at: string; + created_at?: string; draft?: boolean; /** Format: uri */ - events_url: string; + events_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: int64 */ id: number; labels?: { @@ -50163,13 +54297,13 @@ export interface components { url: string; }[]; /** Format: uri-template */ - labels_url: string; + labels_url?: string; locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - milestone: { + milestone?: { /** Format: date-time */ closed_at: string | null; closed_issues: number; @@ -50237,7 +54371,7 @@ export interface components { /** Format: uri */ url: string; } | null; - node_id: string; + node_id?: string; number: number; /** * App @@ -50299,75 +54433,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -50376,18 +54508,18 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ - reactions: { + reactions?: { "+1": number; "-1": number; confused: number; @@ -50401,13 +54533,10 @@ export interface components { url: string; }; /** Format: uri */ - repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + repository_url?: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50417,16 +54546,17 @@ export interface components { /** Format: uri */ timeline_url?: string; /** @description Title of the issue */ - title: string; + title?: string; /** Format: date-time */ - updated_at: string; + updated_at?: string; /** * Format: uri * @description URL for the issue */ - url: string; + url?: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - user: { + user?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50464,6 +54594,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; } | null; /** * Repository @@ -50557,6 +54688,16 @@ export interface components { git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether downloads are enabled. * @default true @@ -50971,75 +55112,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - administration: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; - /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -51048,15 +55187,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -51074,12 +55213,9 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51090,6 +55226,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -51097,6 +55234,7 @@ export interface components { * @description URL for the issue */ url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -51412,75 +55550,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write" | "admin"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write" | "admin"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -51489,15 +55625,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -51515,12 +55651,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51577,6 +55711,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -51843,75 +55978,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -51920,15 +56053,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -51946,12 +56079,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51962,6 +56093,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52125,6 +56257,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -52267,6 +56409,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues typed event */ + "webhook-issues-typed": { + /** @enum {string} */ + action: "typed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** issues unassigned event */ "webhook-issues-unassigned": { /** @@ -52557,75 +56711,73 @@ export interface components { /** @description The set of permissions for the GitHub app */ permissions?: { /** @enum {string} */ - actions: "read" | "write"; - /** @enum {string} */ - administration: "read" | "write"; + actions?: "read" | "write"; /** @enum {string} */ - checks: "read" | "write"; + administration?: "read" | "write"; /** @enum {string} */ - content_references: "read" | "write"; + checks?: "read" | "write"; /** @enum {string} */ - contents: "read" | "write"; + content_references?: "read" | "write"; /** @enum {string} */ - deployments: "read" | "write"; + contents?: "read" | "write"; /** @enum {string} */ - discussions: "read" | "write"; + deployments?: "read" | "write"; /** @enum {string} */ - emails: "read" | "write"; + discussions?: "read" | "write"; /** @enum {string} */ - environments: "read" | "write"; + emails?: "read" | "write"; /** @enum {string} */ - issues: "read" | "write"; + environments?: "read" | "write"; /** @enum {string} */ - keys: "read" | "write"; + issues?: "read" | "write"; /** @enum {string} */ - members: "read" | "write"; + keys?: "read" | "write"; /** @enum {string} */ - metadata: "read" | "write"; + members?: "read" | "write"; /** @enum {string} */ - organization_administration: "read" | "write"; + metadata?: "read" | "write"; /** @enum {string} */ - organization_hooks: "read" | "write"; + organization_administration?: "read" | "write"; /** @enum {string} */ - organization_packages: "read" | "write"; + organization_hooks?: "read" | "write"; /** @enum {string} */ - organization_plan: "read" | "write"; + organization_packages?: "read" | "write"; /** @enum {string} */ - organization_projects: "read" | "write"; + organization_plan?: "read" | "write"; /** @enum {string} */ - organization_secrets: "read" | "write"; + organization_projects?: "read" | "write"; /** @enum {string} */ - organization_self_hosted_runners: "read" | "write"; + organization_secrets?: "read" | "write"; /** @enum {string} */ - organization_user_blocking: "read" | "write"; + organization_self_hosted_runners?: "read" | "write"; /** @enum {string} */ - packages: "read" | "write"; + organization_user_blocking?: "read" | "write"; /** @enum {string} */ - pages: "read" | "write"; + packages?: "read" | "write"; /** @enum {string} */ - pull_requests: "read" | "write"; + pages?: "read" | "write"; /** @enum {string} */ - repository_hooks: "read" | "write"; + pull_requests?: "read" | "write"; /** @enum {string} */ - repository_projects: "read" | "write"; + repository_hooks?: "read" | "write"; /** @enum {string} */ - secret_scanning_alerts: "read" | "write"; + repository_projects?: "read" | "write"; /** @enum {string} */ - secrets: "read" | "write"; + secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ - security_events: "read" | "write"; + secrets?: "read" | "write"; /** @enum {string} */ - security_scanning_alert: "read" | "write"; + security_events?: "read" | "write"; /** @enum {string} */ - single_file: "read" | "write"; + security_scanning_alert?: "read" | "write"; /** @enum {string} */ - statuses: "read" | "write"; + single_file?: "read" | "write"; /** @enum {string} */ - team_discussions: "read" | "write"; + statuses?: "read" | "write"; /** @enum {string} */ - vulnerability_alerts: "read" | "write"; + vulnerability_alerts?: "read" | "write"; /** @enum {string} */ - workflows: "read" | "write"; + workflows?: "read" | "write"; }; /** @description The slug name of the GitHub app */ slug?: string; @@ -52634,15 +56786,15 @@ export interface components { } | null; pull_request?: { /** Format: uri */ - diff_url: string; + diff_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: date-time */ - merged_at: string | null; + merged_at?: string | null; /** Format: uri */ - patch_url: string; + patch_url?: string; /** Format: uri */ - url: string; + url?: string; }; /** Reactions */ reactions: { @@ -52660,12 +56812,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -52676,6 +56826,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52738,6 +56889,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues untyped event */ + "webhook-issues-untyped": { + /** @enum {string} */ + action: "untyped"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** label created event */ "webhook-label-created": { /** @enum {string} */ @@ -52766,15 +56929,15 @@ export interface components { action: "edited"; /** @description The changes to the label if the action was `edited`. */ changes?: { - color: { + color?: { /** @description The previous version of the color if the action was `edited`. */ from: string; }; - description: { + description?: { /** @description The previous version of the description if the action was `edited`. */ from: string; }; - name: { + name?: { /** @description The previous version of the name if the action was `edited`. */ from: string; }; @@ -52940,12 +57103,12 @@ export interface components { * assigned to the collaborator, use the `role_name` field instead, which will provide the full * role name, including custom roles. */ - permission: { + permission?: { /** @enum {string} */ to: "write" | "admin" | "read"; }; /** @description The role assigned to the collaborator. */ - role_name: { + role_name?: { to: string; }; }; @@ -52962,13 +57125,13 @@ export interface components { action: "edited"; /** @description The changes to the collaborator permissions */ changes: { - old_permission: { + old_permission?: { /** @description The previous permissions of the collaborator if the action was edited. */ from: string; }; - permission: { - from: string | null; - to: string | null; + permission?: { + from?: string | null; + to?: string | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53125,7 +57288,7 @@ export interface components { /** @enum {string} */ action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ hook: { active: boolean; config: { @@ -53189,15 +57352,15 @@ export interface components { action: "edited"; /** @description The changes to the milestone if the action was `edited`. */ changes: { - description: { + description?: { /** @description The previous version of the description if the action was `edited`. */ from: string; }; - due_on: { + due_on?: { /** @description The previous version of the due date if the action was `edited`. */ from: string; }; - title: { + title?: { /** @description The previous version of the title if the action was `edited`. */ from: string; }; @@ -53346,8 +57509,8 @@ export interface components { /** @enum {string} */ action: "renamed"; changes?: { - login: { - from: string; + login?: { + from?: string; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -53359,22 +57522,22 @@ export interface components { }; /** Ruby Gems metadata */ "webhook-rubygems-metadata": { - name: string; - description: string; - readme: string; - homepage: string; - version_info: { - version: string; + name?: string; + description?: string; + readme?: string; + homepage?: string; + version_info?: { + version?: string; }; - platform: string; - metadata: { + platform?: string; + metadata?: { [key: string]: string; }; - repo: string; - dependencies: { + repo?: string; + dependencies?: { [key: string]: string; }[]; - commit_oid: string; + commit_oid?: string; }; /** package published event */ "webhook-package-published": { @@ -53474,17 +57637,17 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels: Record | null; - manifest: Record | null; - tag: { - digest: string; - name: string; + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; }; } | null; created_at?: string; description: string; docker_metadata?: { - tags: string[]; + tags?: string[]; }[]; draft?: boolean; /** Format: uri */ @@ -53497,52 +57660,52 @@ export interface components { }[]; name: string; npm_metadata?: { - name: string; - version: string; - npm_user: string; - author: Record | null; - bugs: Record | null; - dependencies: Record; - dev_dependencies: Record; - peer_dependencies: Record; - optional_dependencies: Record; - description: string; - dist: Record | null; - git_head: string; - homepage: string; - license: string; - main: string; - repository: Record | null; - scripts: Record; - id: string; - node_version: string; - npm_version: string; - has_shrinkwrap: boolean; - maintainers: Record[]; - contributors: Record[]; - engines: Record; - keywords: string[]; - files: string[]; - bin: Record; - man: Record; - directories: Record | null; - os: string[]; - cpu: string[]; - readme: string; - installation_command: string; - release_id: number; - commit_oid: string; - published_via_actions: boolean; - deleted_by_id: number; + name?: string; + version?: string; + npm_user?: string; + author?: Record | null; + bugs?: Record | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: Record | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: Record | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: Record[]; + contributors?: Record[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: Record | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; } | null; nuget_metadata?: { - id: number | string; - name: string; - value: boolean | string | number | { - url: string; - branch: string; - commit: string; - type: string; + id?: number | string; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; }; }[] | null; package_files: { @@ -53736,7 +57899,7 @@ export interface components { created_at: string; description: string; docker_metadata?: { - tags: string[]; + tags?: string[]; }[]; draft?: boolean; /** Format: uri */ @@ -53945,16 +58108,16 @@ export interface components { * Webhook * @description The webhook that is being pinged */ - hook: { + hook?: { /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ active: boolean; /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ app_id?: number; config: { - content_type: components["schemas"]["webhook-config-content-type"]; - insecure_ssl: components["schemas"]["webhook-config-insecure-ssl"]; - secret: components["schemas"]["webhook-config-secret"]; - url: components["schemas"]["webhook-config-url"]; + content_type?: components["schemas"]["webhook-config-content-type"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + secret?: components["schemas"]["webhook-config-secret"]; + url?: components["schemas"]["webhook-config-url"]; }; /** Format: date-time */ created_at: string; @@ -53981,12 +58144,12 @@ export interface components { url?: string; }; /** @description The ID of the webhook that triggered the ping. */ - hook_id: number; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; + hook_id?: number; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user"]; /** @description Random string of GitHub zen. */ - zen: string; + zen?: string; }; /** @description The webhooks ping payload encoded with URL encoding. */ "webhook-ping-form-encoded": { @@ -54185,24 +58348,24 @@ export interface components { column_url?: string; created_at?: string; creator?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; } | null; id?: number; node_id?: string; @@ -54252,7 +58415,7 @@ export interface components { /** @enum {string} */ action: "edited"; changes: { - name: { + name?: { from: string; }; }; @@ -54302,11 +58465,11 @@ export interface components { action: "edited"; /** @description The changes to the project if the action was `edited`. */ changes?: { - body: { + body?: { /** @description The previous version of the body if the action was `edited`. */ from: string; }; - name: { + name?: { /** @description The changes to the project if the action was `edited`. */ from: string; }; @@ -54361,21 +58524,21 @@ export interface components { /** @enum {string} */ action: "edited"; changes: { - description: { - from: string | null; - to: string | null; + description?: { + from?: string | null; + to?: string | null; }; - public: { - from: boolean; - to: boolean; + public?: { + from?: boolean; + to?: boolean; }; - short_description: { - from: string | null; - to: string | null; + short_description?: { + from?: string | null; + to?: string | null; }; - title: { - from: string; - to: string; + title?: { + from?: string; + to?: string; }; }; installation?: components["schemas"]["simple-installation"]; @@ -54398,9 +58561,9 @@ export interface components { /** @enum {string} */ action: "converted"; changes: { - content_type: { - from: string | null; - to: string; + content_type?: { + from?: string | null; + to?: string; }; }; installation?: components["schemas"]["simple-installation"]; @@ -54436,17 +58599,17 @@ export interface components { */ changes?: { field_value: { - field_node_id: string; - field_type: string; - field_name: string; - project_number: number; - from: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; - to: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + field_node_id?: string; + field_type?: string; + field_name?: string; + project_number?: number; + from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; + to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null; }; } | { body: { - from: string | null; - to: string | null; + from?: string | null; + to?: string | null; }; }; installation?: components["schemas"]["simple-installation"]; @@ -54459,9 +58622,9 @@ export interface components { /** @enum {string} */ action: "reordered"; changes: { - previous_projects_v2_item_node_id: { - from: string | null; - to: string | null; + previous_projects_v2_item_node_id?: { + from?: string | null; + to?: string | null; }; }; installation?: components["schemas"]["simple-installation"]; @@ -54511,27 +58674,27 @@ export interface components { /** @enum {string} */ action: "edited"; changes?: { - body: { - from: string | null; - to: string | null; + body?: { + from?: string | null; + to?: string | null; }; - status: { + status?: { /** @enum {string|null} */ - from: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** @enum {string|null} */ - to: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; }; - start_date: { + start_date?: { /** Format: date */ - from: string | null; + from?: string | null; /** Format: date */ - to: string | null; + to?: string | null; }; - target_date: { + target_date?: { /** Format: date */ - from: string | null; + from?: string | null; /** Format: date */ - to: string | null; + to?: string | null; }; }; installation?: components["schemas"]["simple-installation"]; @@ -54852,6 +59015,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -55198,6 +59371,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -56048,6 +60231,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; has_pages: boolean; /** * @description Whether projects are enabled. @@ -56405,6 +60598,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57267,6 +61470,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57613,6 +61826,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -58508,6 +62731,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -58854,6 +63087,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -59420,7 +63663,7 @@ export interface components { action: "edited"; /** @description The changes to the comment if the action was `edited`. */ changes: { - base: { + base?: { ref: { from: string; }; @@ -59428,11 +63671,11 @@ export interface components { from: string; }; }; - body: { + body?: { /** @description The previous version of the body if the action was `edited`. */ from: string; }; - title: { + title?: { /** @description The previous version of the title if the action was `edited`. */ from: string; }; @@ -59748,6 +63991,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60094,6 +64347,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60956,6 +65219,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -61302,6 +65575,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62163,6 +66446,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62509,6 +66802,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63562,6 +67865,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63901,6 +68214,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -64708,6 +69031,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65047,6 +69380,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65856,6 +70199,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -66195,6 +70548,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67002,6 +71365,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67341,6 +71714,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67880,6 +72263,8 @@ export interface components { state: "dismissed" | "approved" | "changes_requested"; /** Format: date-time */ submitted_at: string; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -67927,7 +72312,7 @@ export interface components { /** @enum {string} */ action: "edited"; changes: { - body: { + body?: { /** @description The previous version of the body if the action was `edited`. */ from: string; }; @@ -69288,6 +73673,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69627,6 +74022,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70526,6 +74931,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70872,6 +75287,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71790,6 +76215,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -72136,6 +76571,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73035,6 +77480,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73381,6 +77836,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74295,6 +78760,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74634,6 +79109,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75442,6 +79927,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75742,6 +80237,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76354,6 +80859,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request_review_thread unresolved event */ "webhook-pull-request-review-thread-unresolved": { @@ -76656,6 +81163,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76956,6 +81473,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -77568,6 +82095,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request synchronize event */ "webhook-pull-request-synchronize": { @@ -77874,6 +82403,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -78220,6 +82759,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79075,6 +83624,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79421,6 +83980,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80283,6 +84852,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80629,6 +85208,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81483,6 +86072,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81829,6 +86428,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -82638,6 +87247,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -82835,17 +87454,17 @@ export interface components { body?: string | Record; body_html?: string; container_metadata?: { - labels: Record | null; - manifest: Record | null; - tag: { - digest: string; - name: string; + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; }; }; created_at?: string; description: string; docker_metadata?: { - tags: string[]; + tags?: string[]; }[]; draft?: boolean; html_url: string; @@ -82857,52 +87476,52 @@ export interface components { }[]; name: string; npm_metadata?: { - name: string; - version: string; - npm_user: string; - author: (string | Record) | null; - bugs: (string | Record) | null; - dependencies: Record; - dev_dependencies: Record; - peer_dependencies: Record; - optional_dependencies: Record; - description: string; - dist: (string | Record) | null; - git_head: string; - homepage: string; - license: string; - main: string; - repository: (string | Record) | null; - scripts: Record; - id: string; - node_version: string; - npm_version: string; - has_shrinkwrap: boolean; - maintainers: string[]; - contributors: string[]; - engines: Record; - keywords: string[]; - files: string[]; - bin: Record; - man: Record; - directories: (string | Record) | null; - os: string[]; - cpu: string[]; - readme: string; - installation_command: string; - release_id: number; - commit_oid: string; - published_via_actions: boolean; - deleted_by_id: number; + name?: string; + version?: string; + npm_user?: string; + author?: (string | Record) | null; + bugs?: (string | Record) | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: (string | Record) | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: (string | Record) | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: string[]; + contributors?: string[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: (string | Record) | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; } | null; nuget_metadata?: { - id: (string | Record | number) | null; - name: string; - value: boolean | string | number | { - url: string; - branch: string; - commit: string; - type: string; + id?: (string | Record | number) | null; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; }; }[] | null; package_files: { @@ -82921,37 +87540,37 @@ export interface components { package_url: string; prerelease?: boolean; release?: { - author: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; - user_view_type: string; + author?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; }; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string | null; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; - url: string; + created_at?: string; + draft?: boolean; + html_url?: string; + id?: number; + name?: string | null; + prerelease?: boolean; + published_at?: string; + tag_name?: string; + target_commitish?: string; + url?: string; }; rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; summary: string; @@ -82962,11 +87581,11 @@ export interface components { version: string; } | null; registry: { - about_url: string; - name: string; - type: string; - url: string; - vendor: string; + about_url?: string; + name?: string; + type?: string; + url?: string; + vendor?: string; } | null; updated_at: string | null; }; @@ -83036,7 +87655,7 @@ export interface components { created_at: string; description: string; docker_metadata?: ({ - tags: string[]; + tags?: string[]; } | null)[]; draft?: boolean; html_url: string; @@ -83048,17 +87667,17 @@ export interface components { }[]; name: string; package_files: { - content_type: string; - created_at: string; - download_url: string; - id: number; - md5: string | null; - name: string; - sha1: string | null; - sha256: string; - size: number; - state: string; - updated_at: string; + content_type?: string; + created_at?: string; + download_url?: string; + id?: number; + md5?: string | null; + name?: string; + sha1?: string | null; + sha256?: string; + size?: number; + state?: string; + updated_at?: string; }[]; package_url: string; prerelease?: boolean; @@ -83136,15 +87755,19 @@ export interface components { /** @enum {string} */ action: "edited"; changes: { - body: { + body?: { /** @description The previous version of the body if the action was `edited`. */ from: string; }; - name: { + name?: { /** @description The previous version of the name if the action was `edited`. */ from: string; }; - make_latest: { + tag_name?: { + /** @description The previous version of the tag_name if the action was `edited`. */ + from: string; + }; + make_latest?: { /** @description Whether this release was explicitly `edited` to be the latest. */ to: boolean; }; @@ -83181,6 +87804,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -83278,6 +87902,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @@ -83309,6 +87935,8 @@ export interface components { target_commitish: string; /** Format: uri-template */ upload_url: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ url: string; /** Format: uri */ @@ -83422,17 +88050,17 @@ export interface components { /** @enum {string} */ action: "edited"; changes: { - default_branch: { + default_branch?: { from: string; }; - description: { + description?: { from: string | null; }; - homepage: { + homepage?: { from: string | null; }; - topics: { - from: string[] | null; + topics?: { + from?: string[] | null; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -83520,47 +88148,47 @@ export interface components { repository?: components["schemas"]["repository-webhooks"]; repository_ruleset: components["schemas"]["repository-ruleset"]; changes?: { - name: { - from: string; - }; - enforcement: { - from: string; - }; - conditions: { - added: components["schemas"]["repository-ruleset-conditions"][]; - deleted: components["schemas"]["repository-ruleset-conditions"][]; - updated: { - condition: components["schemas"]["repository-ruleset-conditions"]; - changes: { - condition_type: { - from: string; + name?: { + from?: string; + }; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; }; - target: { - from: string; + target?: { + from?: string; }; - include: { - from: string[]; + include?: { + from?: string[]; }; - exclude: { - from: string[]; + exclude?: { + from?: string[]; }; }; }[]; }; - rules: { - added: components["schemas"]["repository-rule"][]; - deleted: components["schemas"]["repository-rule"][]; - updated: { - rule: components["schemas"]["repository-rule"]; - changes: { - configuration: { - from: string; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; }; - rule_type: { - from: string; + rule_type?: { + from?: string; }; - pattern: { - from: string; + pattern?: { + from?: string; }; }; }[]; @@ -83576,7 +88204,7 @@ export interface components { owner: { from: { /** Organization */ - organization: { + organization?: { /** Format: uri */ avatar_url: string; description: string | null; @@ -83601,7 +88229,7 @@ export interface components { url: string; }; /** User */ - user: { + user?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -83826,6 +88454,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert assigned event */ + "webhook-secret-scanning-alert-assigned": { + /** @enum {string} */ + action: "assigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 created event */ "webhook-secret-scanning-alert-created": { /** @enum {string} */ @@ -83886,6 +88526,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert unassigned event */ + "webhook-secret-scanning-alert-unassigned": { + /** @enum {string} */ + action: "unassigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 validated event */ "webhook-secret-scanning-alert-validated": { /** @enum {string} */ @@ -84009,8 +88661,8 @@ export interface components { /** security_and_analysis event */ "webhook-security-and-analysis": { changes: { - from: { - security_and_analysis: components["schemas"]["security-and-analysis"]; + from?: { + security_and_analysis?: components["schemas"]["security-and-analysis"]; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -84046,7 +88698,7 @@ export interface components { /** @enum {string} */ action: "edited"; changes: { - privacy_level: { + privacy_level?: { /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ from: string; }; @@ -84137,39 +88789,39 @@ export interface components { /** User */ author: { /** Format: uri */ - avatar_url: string; - deleted: boolean; - email: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - events_url: string; + events_url?: string; /** Format: uri */ - followers_url: string; + followers_url?: string; /** Format: uri-template */ - following_url: string; + following_url?: string; /** Format: uri-template */ - gists_url: string; - gravatar_id: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - html_url: string; - id: number; - login: string; - name: string; - node_id: string; + html_url?: string; + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - organizations_url: string; + organizations_url?: string; /** Format: uri */ - received_events_url: string; + received_events_url?: string; /** Format: uri */ - repos_url: string; - site_admin: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - starred_url: string; + starred_url?: string; /** Format: uri */ - subscriptions_url: string; + subscriptions_url?: string; /** @enum {string} */ - type: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - url: string; + url?: string; } | null; /** Format: uri */ comments_url: string; @@ -84215,45 +88867,45 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; - verified_at?: string | null; + verified_at: string | null; }; }; /** User */ committer: { /** Format: uri */ - avatar_url: string; - deleted: boolean; - email: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - events_url: string; + events_url?: string; /** Format: uri */ - followers_url: string; + followers_url?: string; /** Format: uri-template */ - following_url: string; + following_url?: string; /** Format: uri-template */ - gists_url: string; - gravatar_id: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - html_url: string; - id: number; - login: string; - name: string; - node_id: string; + html_url?: string; + id?: number; + login?: string; + name?: string; + node_id?: string; /** Format: uri */ - organizations_url: string; + organizations_url?: string; /** Format: uri */ - received_events_url: string; + received_events_url?: string; /** Format: uri */ - repos_url: string; - site_admin: boolean; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - starred_url: string; + starred_url?: string; /** Format: uri */ - subscriptions_url: string; + subscriptions_url?: string; /** @enum {string} */ - type: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - url: string; + url?: string; } | null; /** Format: uri */ html_url: string; @@ -85130,31 +89782,31 @@ export interface components { action: "edited"; /** @description The changes to the team if the action was `edited`. */ changes: { - description: { + description?: { /** @description The previous version of the description if the action was `edited`. */ from: string; }; - name: { + name?: { /** @description The previous version of the name if the action was `edited`. */ from: string; }; - privacy: { + privacy?: { /** @description The previous version of the team's privacy if the action was `edited`. */ from: string; }; - notification_setting: { + notification_setting?: { /** @description The previous version of the team's notification setting if the action was `edited`. */ from: string; }; - repository: { + repository?: { permissions: { from: { /** @description The previous version of the team member's `admin` permission on a repository, if the action was `edited`. */ - admin: boolean; + admin?: boolean; /** @description The previous version of the team member's `pull` permission on a repository, if the action was `edited`. */ - pull: boolean; + pull?: boolean; /** @description The previous version of the team member's `push` permission on a repository, if the action was `edited`. */ - push: boolean; + push?: boolean; }; }; }; @@ -87338,6 +91990,334 @@ export interface components { display_title: string; }; }; + /** CreateEvent */ + "create-event": { + ref: string; + ref_type: string; + full_ref: string; + master_branch: string; + description?: string | null; + pusher_type: string; + }; + /** DeleteEvent */ + "delete-event": { + ref: string; + ref_type: string; + full_ref: string; + pusher_type: string; + }; + /** DiscussionEvent */ + "discussion-event": { + action: string; + discussion: components["schemas"]["discussion"]; + }; + /** IssuesEvent */ + "issues-event": { + action: string; + issue: components["schemas"]["issue"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** IssueCommentEvent */ + "issue-comment-event": { + action: string; + issue: components["schemas"]["issue"]; + comment: components["schemas"]["issue-comment"]; + }; + /** ForkEvent */ + "fork-event": { + action: string; + forkee: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + private?: boolean; + owner?: components["schemas"]["simple-user"]; + html_url?: string; + description?: string | null; + fork?: boolean; + url?: string; + forks_url?: string; + keys_url?: string; + collaborators_url?: string; + teams_url?: string; + hooks_url?: string; + issue_events_url?: string; + events_url?: string; + assignees_url?: string; + branches_url?: string; + tags_url?: string; + blobs_url?: string; + git_tags_url?: string; + git_refs_url?: string; + trees_url?: string; + statuses_url?: string; + languages_url?: string; + stargazers_url?: string; + contributors_url?: string; + subscribers_url?: string; + subscription_url?: string; + commits_url?: string; + git_commits_url?: string; + comments_url?: string; + issue_comment_url?: string; + contents_url?: string; + compare_url?: string; + merges_url?: string; + archive_url?: string; + downloads_url?: string; + issues_url?: string; + pulls_url?: string; + milestones_url?: string; + notifications_url?: string; + labels_url?: string; + releases_url?: string; + deployments_url?: string; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + /** Format: date-time */ + pushed_at?: string | null; + git_url?: string; + ssh_url?: string; + clone_url?: string; + svn_url?: string; + homepage?: string | null; + size?: number; + stargazers_count?: number; + watchers_count?: number; + language?: string | null; + has_issues?: boolean; + has_projects?: boolean; + has_downloads?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + forks_count?: number; + mirror_url?: string | null; + archived?: boolean; + disabled?: boolean; + open_issues_count?: number; + license?: components["schemas"]["nullable-license-simple"]; + allow_forking?: boolean; + is_template?: boolean; + web_commit_signoff_required?: boolean; + topics?: string[]; + visibility?: string; + forks?: number; + open_issues?: number; + watchers?: number; + default_branch?: string; + public?: boolean; + }; + }; + /** GollumEvent */ + "gollum-event": { + pages: { + page_name?: string | null; + title?: string | null; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + /** MemberEvent */ + "member-event": { + action: string; + member: components["schemas"]["simple-user"]; + }; + /** PublicEvent */ + "public-event": Record; + /** PushEvent */ + "push-event": { + repository_id: number; + push_id: number; + ref: string; + head: string; + before: string; + }; + /** PullRequestEvent */ + "pull-request-event": { + action: string; + number: number; + pull_request: components["schemas"]["pull-request-minimal"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** PullRequestReviewCommentEvent */ + "pull-request-review-comment-event": { + action: string; + pull_request: components["schemas"]["pull-request-minimal"]; + comment: { + id: number; + node_id: string; + /** Format: uri */ + url: string; + pull_request_review_id: number | null; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + subject_type?: string | null; + commit_id: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + body: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + pull_request_url: string; + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + original_commit_id: string; + /** Reactions */ + reactions: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + /** Format: uri */ + url?: string; + }; + in_reply_to_id?: number; + }; + }; + /** PullRequestReviewEvent */ + "pull-request-review-event": { + action: string; + review: { + id?: number; + node_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + body?: string; + commit_id?: string; + submitted_at?: string | null; + state?: string; + /** Format: uri */ + html_url?: string; + /** Format: uri */ + pull_request_url?: string; + _links?: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + updated_at?: string; + }; + pull_request: components["schemas"]["pull-request-minimal"]; + }; + /** CommitCommentEvent */ + "commit-comment-event": { + action: string; + comment: { + /** Format: uri */ + html_url?: string; + /** Format: uri */ + url?: string; + id?: number; + node_id?: string; + body?: string; + path?: string | null; + position?: number | null; + line?: number | null; + commit_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + }; + /** ReleaseEvent */ + "release-event": { + action: string; + release: components["schemas"]["release"] & { + is_short_description_html_truncated?: boolean; + short_description_html?: string; + }; + }; + /** WatchEvent */ + "watch-event": { + action: string; + }; }; responses: { /** @description Validation failed, or the endpoint has been spammed. */ @@ -87411,6 +92391,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + internal_error: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Conflict */ conflict: { headers: { @@ -87434,9 +92423,9 @@ export interface components { }; content: { "application/json": { - code: string; - message: string; - documentation_url: string; + code?: string; + message?: string; + documentation_url?: string; }; }; }; @@ -87447,13 +92436,13 @@ export interface components { }; content: { "application/json": { - block: { - reason: string; - created_at: string; - html_url: string | null; + block?: { + reason?: string; + created_at?: string; + html_url?: string | null; }; - message: string; - documentation_url: string; + message?: string; + documentation_url?: string; }; }; }; @@ -87466,6 +92455,42 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting all budgets */ + get_all_budgets: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get_all_budgets"]; + }; + }; + /** @description Response when updating a budget */ + budget: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get-budget"]; + }; + }; + /** @description Response when deleting a budget */ + "delete-budget": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["delete-budget"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-org"]; + }; + }; /** @description Billing usage report response for an organization */ billing_usage_report_org: { headers: { @@ -87475,13 +92500,13 @@ export interface components { "application/json": components["schemas"]["billing-usage-report"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_org: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-summary-report-org"]; }; }; /** @description Response */ @@ -87521,6 +92546,15 @@ export interface components { }; }; }; + /** @description Payload Too Large */ + too_large: { + headers: { + [name: string]: unknown; + }; + content: { + "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: { @@ -87537,8 +92571,15 @@ export interface components { }; content?: never; }; - /** @description Gone */ - gone: { + /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */ + enterprise_team_unsupported: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Temporary Redirect */ + temporary_redirect: { headers: { [name: string]: unknown; }; @@ -87546,8 +92587,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Temporary Redirect */ - temporary_redirect: { + /** @description Gone */ + gone: { headers: { [name: string]: unknown; }; @@ -87591,6 +92632,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if analysis could not be processed */ + unprocessable_analysis: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -87607,7 +92657,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ + /** @description Response if the configuration change cannot be made because the repository is not in the required state */ + code_scanning_invalid_state: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */ dependency_review_forbidden: { headers: { [name: string]: unknown; @@ -87634,6 +92693,33 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-summary-report-user"]; + }; + }; }; parameters: { /** @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)." */ @@ -87662,7 +92748,7 @@ export interface components { "assignment-id": number; /** @description The unique identifier of the classroom. */ "classroom-id": number; - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: string; /** @description The unique identifier of the code security configuration. */ "configuration-id": number; @@ -87695,6 +92781,17 @@ export interface components { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ "dependabot-alert-comma-separated-epss": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + "dependabot-alert-comma-separated-has": string | "patch"[]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + "dependabot-alert-comma-separated-assignees": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @@ -87704,32 +92801,16 @@ export interface components { * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first": number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last": number; - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "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 version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": string; + /** @description The handle for the GitHub user account. */ + username: string; + /** @description The organization name. The name is not case sensitive. */ + org: string; + /** @description The slug of the team name. */ + "team-slug": string; + /** @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)." */ + "public-events-per-page": number; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -87756,16 +92837,30 @@ export interface components { "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org": number; - /** @description The organization name. The name is not case sensitive. */ - org: string; - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description The ID corresponding to the budget. */ + budget: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ "billing-usage-report-year": number; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - "billing-usage-report-month": number; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + "billing-usage-report-month-default": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ "billing-usage-report-day": number; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - "billing-usage-report-hour": number; + /** @description The user name to query usage for. The name is not case sensitive. */ + "billing-usage-report-user": string; + /** @description The model name to query usage for. The name is not case sensitive. */ + "billing-usage-report-model": string; + /** @description The product name to query usage for. The name is not case sensitive. */ + "billing-usage-report-product": string; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + "billing-usage-report-month": number; + /** @description The repository name to query for usage in the format owner/repository. */ + "billing-usage-report-repository": string; + /** @description The SKU to query for usage. */ + "billing-usage-report-sku": string; + /** @description Image definition ID of custom image */ + "actions-custom-image-definition-id": number; + /** @description Version of a custom image */ + "actions-custom-image-version": string; /** @description Unique identifier of the GitHub-hosted runner. */ "hosted-runner-id": number; /** @description The unique identifier of the repository. */ @@ -87784,12 +92879,31 @@ export interface components { "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; - /** @description The handle for the GitHub user account. */ - username: string; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + "subject-digest": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + "dependabot-alert-comma-separated-artifact-registry-urls": string; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + "dependabot-alert-comma-separated-artifact-registry": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + "dependabot-alert-comma-separated-runtime-risk": string; /** @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 */ @@ -87816,14 +92930,14 @@ export interface components { "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ "codespace-name": string; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @@ -87851,8 +92965,18 @@ export interface components { "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "personal-access-token-after": string; + /** @description The ID of the token */ + "personal-access-token-token-id": string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The project's number. */ + "project-number": number; + /** @description The unique identifier of the field. */ + "field-id": number; + /** @description The unique identifier of the project item. */ + "item-id": number; + /** @description The number that identifies the project view. */ + "view-number": number; /** @description The custom property name */ "custom-property-name": string; /** @@ -87868,12 +92992,12 @@ export interface components { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ "actor-name-in-query": string; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ "rule-suite-result": "pass" | "fail" | "bypass" | "all"; /** * @description The unique identifier of the rule suite result. @@ -87882,22 +93006,32 @@ export interface components { * for organizations. */ "rule-suite-id": number; + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + "secret-scanning-alert-resolution": string; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + "secret-scanning-alert-assignee": string; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + "secret-scanning-alert-sort": "created" | "updated"; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ "secret-scanning-pagination-before-org-repo": string; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @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 A boolean value representing whether or not to hide literal secrets in the results. */ + "secret-scanning-alert-hide-secret": boolean; /** @description Unique identifier of the hosted compute network configuration. */ "network-configuration-id": string; /** @description Unique identifier of the hosted compute network settings. */ "network-settings-id": string; - /** @description The number that identifies the discussion. */ - "discussion-number": number; - /** @description The number that identifies the comment. */ - "comment-number": number; - /** @description The unique identifier of the reaction. */ - "reaction-id": number; - /** @description The unique identifier of the project. */ - "project-id": number; /** @description The security feature to enable or disable. */ "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; /** @@ -87907,10 +93041,6 @@ export interface components { * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; - /** @description The unique identifier of the card. */ - "card-id": number; - /** @description The unique identifier of the column. */ - "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ "artifact-name": string; /** @description The unique identifier of the artifact. */ @@ -87967,6 +93097,8 @@ export interface components { "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 unique identifier of the reaction. */ + "reaction-id": number; /** @description The SHA of the commit. */ "commit-sha": string; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ @@ -88013,14 +93145,17 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The unique identifier of the tag protection. */ - "tag-protection-id": number; /** @description The time frame to display results for. */ per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ "since-repo": number; /** @description 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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + "issues-advanced-search": string; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ @@ -88037,6 +93172,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred": "created" | "updated"; + /** @description The unique identifier of the user. */ + "user-id": string; }; requestBodies: never; headers: { @@ -88104,7 +93241,7 @@ export interface operations { * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; /** @@ -88278,10 +93415,10 @@ export interface operations { 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"]; + 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"]; }; }; }; @@ -88480,15 +93617,15 @@ export interface operations { content: { "application/json": { /** @description List of repository names that the token should have access to */ - repositories: string[]; + repositories?: string[]; /** * @description List of repository IDs that the token should have access to * @example [ * 1 * ] */ - repository_ids: number[]; - permissions: components["schemas"]["app-permissions"]; + repository_ids?: number[]; + permissions?: components["schemas"]["app-permissions"]; }; }; }; @@ -88952,6 +94089,27 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of credentials to be revoked, up to 1000 per request. */ + credentials: string[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; + }; + }; "emojis/get": { parameters: { query?: never; @@ -88972,7 +94130,113 @@ export interface operations { }; }; }; - 304: components["responses"]["not_modified"]; + 304: components["responses"]["not_modified"]; + }; + }; + "actions/get-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; "code-security/get-configurations-for-enterprise": { @@ -88987,7 +94251,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89012,7 +94276,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89025,11 +94289,19 @@ export interface operations { /** @description A description of the code security configuration */ description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled @@ -89048,7 +94320,7 @@ export interface operations { * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. * @default false */ - labeled_runners: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts @@ -89062,6 +94334,7 @@ export interface operations { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled @@ -89069,6 +94342,17 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled @@ -89093,6 +94377,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89128,7 +94430,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89151,7 +94453,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89179,7 +94481,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89200,7 +94502,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89211,75 +94513,113 @@ export interface operations { content: { "application/json": { /** @description The name of the code security configuration. Must be unique across the enterprise. */ - name: string; + name?: string; /** @description A description of the code security configuration */ - description: string; + description?: string; + /** + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** - * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @description The enablement status of GitHub Code Security features. * @enum {string} */ - advanced_security: "enabled" | "disabled"; + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} */ - dependency_graph: "enabled" | "disabled" | "not_set"; + dependency_graph?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Automatic dependency submission * @enum {string} */ - dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options: { + dependency_graph_autosubmit_action_options?: { /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners: boolean; + labeled_runners?: boolean; }; /** * @description The enablement status of Dependabot alerts * @enum {string} */ - dependabot_alerts: "enabled" | "disabled" | "not_set"; + dependabot_alerts?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependabot security updates * @enum {string} */ - dependabot_security_updates: "enabled" | "disabled" | "not_set"; + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of code scanning default setup * @enum {string} */ - code_scanning_default_setup: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} */ - secret_scanning: "enabled" | "disabled" | "not_set"; + secret_scanning?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning push protection * @enum {string} */ - secret_scanning_push_protection: "enabled" | "disabled" | "not_set"; + secret_scanning_push_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning validity checks * @enum {string} */ - secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning non-provider patterns * @enum {string} */ - secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} */ - private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; /** * @description The enforcement status for a security configuration * @enum {string} */ - enforcement: "enforced" | "unenforced"; + enforcement?: "enforced" | "unenforced"; }; }; }; @@ -89304,7 +94644,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89315,7 +94655,7 @@ export interface operations { content: { "application/json": { /** - * @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` + * @description The type of repositories to attach the configuration to. * @enum {string} */ scope: "all" | "all_without_configurations"; @@ -89334,7 +94674,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89348,7 +94688,7 @@ export interface operations { * @description Specify which types of repository this security configuration should be applied to by default. * @enum {string} */ - default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; }; }; @@ -89364,8 +94704,8 @@ export interface operations { * @description Specifies which types of repository this security configuration is applied to by default. * @enum {string} */ - default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; - configuration: components["schemas"]["code-security-configuration"]; + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; }; }; }; @@ -89391,7 +94731,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89445,6 +94785,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -89460,24 +94811,12 @@ export interface operations { 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89499,35 +94838,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - "secret-scanning/list-alerts-for-enterprise": { + "enterprise-teams/list": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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 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 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"]; + /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89541,14 +94862,239 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["enterprise-team"][]; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-public-events": { + "enterprise-teams/create": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description A description of the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be set. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + }; + }; + "enterprise-team-memberships/list": { + 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 slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to add to the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully added team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to be removed from the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully removed team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User is a member of the enterprise team. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully added team member */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-team-organizations/get-assignments": { 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)." */ @@ -89557,6 +95103,290 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description An array of organizations the team is assigned to */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to assign the team to. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully assigned the enterprise team to organizations. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to unassign the team from. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully unassigned the enterprise team from organizations. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/get-assignment": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The team is assigned to the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + /** @description The team is not assigned to the organization */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully assigned the enterprise team to the organization. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + }; + }; + "enterprise-team-organizations/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully unassigned the enterprise team from the organization. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-teams/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A new name for the team. */ + name?: string | null; + /** @description A new description for the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be changed. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/list-public-events": { + 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"]["public-events-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?: never; cookie?: never; }; @@ -89806,7 +95636,7 @@ export interface operations { * @description The description of the gist. * @example Example Ruby script */ - description: string; + description?: string; /** * @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename * (including extension) of the targeted gist file. For example: `hello.py`. @@ -89820,12 +95650,12 @@ export interface operations { * } * } */ - files: { + files?: { [key: string]: { /** @description The new content of the file. */ - content: string; + content?: string; /** @description The new filename for the file. */ - filename: string | null; + filename?: string | null; } | null; }; } | null; @@ -90763,9 +96593,9 @@ export interface operations { * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - last_read_at: string; + last_read_at?: string; /** @description Whether the notification has been read. */ - read: boolean; + read?: boolean; }; }; }; @@ -90777,7 +96607,7 @@ export interface operations { }; content: { "application/json": { - message: string; + message?: string; }; }; }; @@ -90906,7 +96736,7 @@ export interface operations { * @description Whether to block all notifications from a thread. * @default false */ - ignored: boolean; + ignored?: boolean; }; }; }; @@ -91000,17 +96830,425 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "actions/get-actions-cache-retention-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-retention-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-organization": { + 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": components["schemas"]["actions-cache-retention-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-storage-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-organization": { + 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": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/repository-access-for-org": { + parameters: { + query?: { + /** @description The page number of results to fetch. */ + page?: number; + /** @description Number of results per page. */ + 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"]["dependabot-repository-access-details"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/update-repository-access-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 List of repository IDs to add. */ + repository_ids_to_add?: number[]; + /** @description List of repository IDs to remove. */ + repository_ids_to_remove?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/set-repository-access-default-level": { + 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 The default repository access level for Dependabot updates. + * @example internal + * @enum {string} + */ + default_level: "public" | "internal"; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "billing/get-all-budgets-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_all_budgets"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "billing/get-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/delete-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete-budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/update-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert?: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients?: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** @description The name of the entity to apply the budget to */ + budget_entity_name?: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + responses: { + /** @description Budget updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Budget successfully updated. */ + message?: string; + budget?: { + /** @description ID of the budget. */ + id?: string; + /** + * Format: float + * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. + */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @default + */ + budget_entity_name: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Budget not found or feature not enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "billing/get-github-billing-premium-request-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The user name to query usage for. The name is not case sensitive. */ + user?: components["parameters"]["billing-usage-report-user"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "billing/get-github-billing-usage-report-org": { parameters: { query?: { - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ year?: components["parameters"]["billing-usage-report-year"]; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ month?: components["parameters"]["billing-usage-report-month"]; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ day?: components["parameters"]["billing-usage-report-day"]; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - hour?: components["parameters"]["billing-usage-report-hour"]; }; header?: never; path: { @@ -91028,6 +97266,38 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "billing/get-github-billing-usage-summary-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -91083,73 +97353,73 @@ export interface operations { content: { "application/json": { /** @description Billing email address. This address is not publicized. */ - billing_email: string; + billing_email?: string; /** @description The company name. */ - company: string; + company?: string; /** @description The publicly visible email address. */ - email: string; + email?: string; /** @description The Twitter username of the company. */ - twitter_username: string; + twitter_username?: string; /** @description The location. */ - location: string; + location?: string; /** @description The shorthand name of the company. */ - name: string; + name?: string; /** @description The description of the company. The maximum size is 160 characters. */ - description: string; + description?: string; /** @description Whether an organization can use organization projects. */ - has_organization_projects: boolean; + has_organization_projects?: boolean; /** @description Whether repositories that belong to the organization can use repository projects. */ - has_repository_projects: boolean; + has_repository_projects?: boolean; /** * @description Default permission level members have for organization repositories. * @default read * @enum {string} */ - default_repository_permission: "read" | "write" | "admin" | "none"; + default_repository_permission?: "read" | "write" | "admin" | "none"; /** * @description Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. * @default true */ - members_can_create_repositories: boolean; + members_can_create_repositories?: boolean; /** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_internal_repositories: boolean; + members_can_create_internal_repositories?: boolean; /** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_private_repositories: boolean; + members_can_create_private_repositories?: boolean; /** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */ - members_can_create_public_repositories: boolean; + 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 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"; + members_allowed_repository_creation_type?: "all" | "private" | "none"; /** * @description Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_pages: boolean; + members_can_create_pages?: boolean; /** * @description Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_public_pages: boolean; + members_can_create_public_pages?: boolean; /** * @description Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted. * @default true */ - members_can_create_private_pages: boolean; + members_can_create_private_pages?: boolean; /** * @description Whether organization members can fork private organization repositories. * @default false */ - members_can_fork_private_repositories: boolean; + members_can_fork_private_repositories?: boolean; /** * @description Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface. * @default false */ - web_commit_signoff_required: boolean; + web_commit_signoff_required?: boolean; /** @example "http://github.blog" */ - blog: string; + blog?: string; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91160,7 +97430,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - advanced_security_enabled_for_new_repositories: boolean; + advanced_security_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91171,7 +97441,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - dependabot_alerts_enabled_for_new_repositories: boolean; + dependabot_alerts_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91182,7 +97452,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - dependabot_security_updates_enabled_for_new_repositories: boolean; + dependabot_security_updates_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91193,7 +97463,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - dependency_graph_enabled_for_new_repositories: boolean; + dependency_graph_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91204,7 +97474,7 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - secret_scanning_enabled_for_new_repositories: boolean; + secret_scanning_enabled_for_new_repositories?: boolean; /** * @deprecated * @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. @@ -91215,13 +97485,13 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request. */ - secret_scanning_push_protection_enabled_for_new_repositories: boolean; + secret_scanning_push_protection_enabled_for_new_repositories?: boolean; /** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */ - secret_scanning_push_protection_custom_link_enabled: boolean; + 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; + 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; + deploy_keys_enabled_for_repositories?: boolean; }; }; }; @@ -91353,14 +97623,14 @@ export interface operations { /** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ image: { /** @description The unique identifier of the runner image. */ - id: string; + id?: string; /** * @description The source of the runner image. * @enum {string} */ - source: "github" | "partner" | "custom"; + source?: "github" | "partner" | "custom"; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ - version: string | null; + version?: string | null; }; /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ size: string; @@ -91370,6 +97640,11 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** + * @description Whether this runner should be used to generate custom images. + * @default false + */ + image_gen?: boolean; }; }; }; @@ -91385,6 +97660,160 @@ export interface operations { }; }; }; + "actions/list-custom-images-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-custom-image"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image"]; + }; + }; + }; + }; + "actions/delete-custom-image-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-custom-image-versions-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @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; + image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"]; + }; + }; + }; + }; + "actions/delete-custom-image-version-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/get-hosted-runners-github-owned-images-for-org": { parameters: { query?: never; @@ -91405,7 +97834,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -91431,7 +97860,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -91579,15 +98008,19 @@ export interface operations { content: { "application/json": { /** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - name: string; + name?: string; /** @description The existing runner group to add this runner to. */ - runner_group_id: number; + runner_group_id?: number; /** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */ - maximum_runners: number; + maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ - enable_static_ip: boolean; + enable_static_ip?: boolean; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size?: string; + /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image_id?: string; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ - image_version: string | null; + image_version?: string | null; }; }; }; @@ -91693,6 +98126,7 @@ export interface operations { "application/json": { enabled_repositories: components["schemas"]["enabled-repositories"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -91706,6 +98140,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + 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"]["actions-artifact-and-log-retention-response"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-organization": { + 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": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-organization": { + 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": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-organization": { + 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": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { @@ -91859,6 +98459,184 @@ export interface operations { }; }; }; + "actions/get-self-hosted-runners-permissions-organization": { + parameters: { + query?: never; + 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"]["self-hosted-runners-settings"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-self-hosted-runners-permissions-organization": { + 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 The policy that controls whether self-hosted runners can be used in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-self-hosted-runners-organization": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-selected-repositories-self-hosted-runners-organization": { + 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 IDs of repositories that can use repository-level self-hosted runners */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/enable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/disable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { query?: never; @@ -92441,6 +99219,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -92536,6 +99315,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-org": { @@ -92743,9 +99523,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} @@ -93058,16 +99838,16 @@ export interface operations { content: { "application/json": { /** @description The name of the variable. */ - name: string; + name?: string; /** @description The value of the variable. */ - value: string; + value?: string; /** * @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. * @enum {string} */ - visibility: "all" | "private" | "selected"; + visibility?: "all" | "private" | "selected"; /** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */ - selected_repository_ids: number[]; + selected_repository_ids?: number[]; }; }; }; @@ -93220,191 +100000,309 @@ export interface operations { }; }; }; - "orgs/list-attestations": { + "orgs/create-artifact-deployment-record": { 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 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - subject_digest: string; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the artifact. + * @example libfoo + */ + name: string; + /** @description The hex encoded digest of the artifact. */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * @description The status of the artifact. Can be either deployed or decommissioned. + * @enum {string} + */ + status: "deployed" | "decommissioned"; + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The deployment cluster. */ + cluster?: string; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a cluster, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + */ + deployment_name: string; + /** @description The tags associated with the deployment. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; responses: { - /** @description Response */ + /** @description Artifact deployment record stored successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { - attestations: { - /** - * @description The attestation's Sigstore Bundle. - * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - */ - bundle: { - mediaType: string; - verificationMaterial: { - [key: string]: unknown; - }; - dsseEnvelope: { - [key: string]: unknown; - }; - }; - repository_id: number; - bundle_url: string; - }[]; + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; }; }; }; }; }; - "orgs/list-blocked-users": { + "orgs/set-cluster-deployment-records": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The cluster name. */ + cluster: string; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The list of deployments to record. */ + deployments: { + /** + * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name parameter must also be identical across all entries. + */ + name: string; + /** + * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name and version parameters must also be identical across all entries. + */ + digest: string; + /** + * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + * the version parameter must also be identical across all entries. + * @example 1.2.3 + */ + version?: string; + /** + * @description The deployment status of the artifact. + * @enum {string} + */ + status?: "deployed" | "decommissioned"; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a record set, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + * The deployment_name must be unique across all entries in the deployments array. + */ + deployment_name: string; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + /** @description Key-value pairs to tag the deployment record. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + }[]; + }; + }; + }; responses: { - /** @description Response */ + /** @description Deployment records created or updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; }; }; }; }; - "orgs/check-blocked-user": { + "orgs/create-artifact-storage-record": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description If the user is blocked */ - 204: { - headers: { - [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the artifact. + * @example libfoo + */ + name: string; + /** + * @description The digest of the artifact (algorithm:hex-encoded-digest). + * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * Format: uri + * @description The URL where the artifact is stored. + * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3 + */ + artifact_url?: string; + /** + * Format: uri + * @description The path of the artifact. + * @example com/github/bar/libfoo-1.2.3 + */ + path?: string; + /** + * Format: uri + * @description The base URL of the artifact registry. + * @example https://reg.example.com/artifactory/ + */ + registry_url: string; + /** + * @description The repository name within the registry. + * @example bar + */ + repository?: string; + /** + * @description The status of the artifact (e.g., active, inactive). + * @default active + * @example active + * @enum {string} + */ + status?: "active" | "eol" | "deleted"; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; }; - content?: never; }; - /** @description If the user is not blocked */ - 404: { + }; + responses: { + /** @description Artifact metadata storage record stored successfully. */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": { + /** @example 1 */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string | null; + registry_url?: string; + repository?: string | null; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; }; }; }; }; - "orgs/block-user": { + "orgs/list-artifact-deployment-records": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + subject_digest: components["parameters"]["subject-digest"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 204: { + /** @description Successful response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/unblock-user": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; + content: { + "application/json": { + /** + * @description The number of deployment records for this digest and organization + * @example 3 + */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; }; - content?: never; }; }; }; - "code-scanning/list-alerts-for-org": { + "orgs/list-artifact-storage-records": { parameters: { - query?: { - /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; - /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; - /** @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 page number of the results to fetch. For 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 If specified, only code scanning alerts with this state will be returned. */ - state?: components["schemas"]["code-scanning-alert-state-query"]; - /** @description The property by which to sort the results. */ - sort?: "created" | "updated"; - /** @description If specified, only code scanning alerts with this severity will be returned. */ - severity?: components["schemas"]["code-scanning-alert-severity"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** + * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + */ + subject_digest: string; }; cookie?: never; }; @@ -93413,24 +100311,36 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; + "application/json": { + /** + * @description The number of storage records for this digest and organization + * @example 3 + */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string; + registry_url?: string; + repository?: string; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "code-security/get-configurations-for-org": { + "orgs/list-attestations-bulk": { parameters: { query?: { - /** @description The target type of the code security configuration */ - target_type?: "global" | "all"; /** @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?: number; + per_page?: components["parameters"]["per-page"]; /** @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)." */ @@ -93443,154 +100353,62 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["code-security-configuration"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "code-security/create-configuration": { - 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 The name of the code security configuration. Must be unique within the organization. */ - name: string; - /** @description A description of the code security configuration */ - description: string; - /** - * @description The enablement status of GitHub Advanced Security - * @default disabled - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @default enabled - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @default disabled - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** - * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. - * @default false - */ - labeled_runners: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @default disabled - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @default disabled - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @default disabled - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; - /** - * @description The enablement status of secret scanning - * @default disabled - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @default disabled - * @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 - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non provider patterns - * @default disabled - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @default disabled - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @default enforced - * @enum {string} + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. */ - enforcement?: "enforced" | "unenforced"; + predicate_type?: string; }; }; }; responses: { - /** @description Successfully created code security configuration */ - 201: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; }; }; }; }; - "code-security/get-default-configurations": { + "orgs/delete-attestations-bulk": { parameters: { query?: never; header?: never; @@ -93600,57 +100418,79 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; responses: { /** @description Response */ 200: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["code-security-default-configurations"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "code-security/detach-configuration": { + "orgs/delete-attestations-by-subject-digest": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Subject Digest */ + subject_digest: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description An array of repository IDs to detach from configurations. */ - selected_repository_ids: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - }; - responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; }; }; - "code-security/get-configuration": { + "orgs/list-attestation-repositories": { parameters: { - query?: never; + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -93662,280 +100502,223 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; + "application/json": { + id?: number; + name?: string; + }[]; }; }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "code-security/delete-configuration": { + "orgs/delete-attestations-by-id": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description Attestation ID */ + attestation_id: number; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; }; }; - "code-security/update-configuration": { + "orgs/list-attestations": { parameters: { - query?: never; + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The name of the code security configuration. Must be unique within the organization. */ - name: string; - /** @description A description of the code security configuration */ - description: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options: components["schemas"]["code-scanning-default-setup-options"]; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @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; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { /** - * @description The type of the bypass reviewer - * @enum {string} + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - reviewer_type: "TEAM" | "ROLE"; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + } | null; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; - /** - * @description The enablement status of secret scanning validity checks - * @enum {string} - */ - secret_scanning_validity_checks: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} - */ - secret_scanning_non_provider_patterns: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @enum {string} - */ - private_vulnerability_reporting: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @enum {string} - */ - enforcement: "enforced" | "unenforced"; }; }; }; + }; + "orgs/list-blocked-users": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description Response when a configuration is updated */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; - }; - }; - /** @description Response when no new updates are made */ - 204: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["simple-user"][]; }; - content?: never; }; }; }; - "code-security/attach-configuration": { + "orgs/check-blocked-user": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @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" | "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[]; + requestBody?: never; + responses: { + /** @description If the user is blocked */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description If the user is not blocked */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; }; }; - }; - responses: { - 202: components["responses"]["accepted"]; }; }; - "code-security/set-configuration-as-default": { + "orgs/block-user": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Specify which types of repository this security configuration should be applied to by default. - * @enum {string} - */ - default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; - }; - }; - }; + requestBody?: never; responses: { - /** @description Default successfully changed. */ - 200: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - /** - * @description Specifies which types of repository this security configuration is applied to by default. - * @enum {string} - */ - default_for_new_repos: "all" | "none" | "private_and_internal" | "public"; - configuration: components["schemas"]["code-security-configuration"]; - }; - }; + content?: never; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "code-security/get-repositories-for-configuration": { + "orgs/unblock-user": { 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?: number; - /** @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 A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. - * - * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` - */ - status?: string; - }; + 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["code-security-configuration-repositories"][]; - }; + content?: never; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "codespaces/list-in-organization": { + "campaigns/list-org-campaigns": { 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 The number of results per page (max 100). For 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 If specified, only campaigns with this state will be returned. */ + state?: components["schemas"]["campaign-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated" | "ends_at" | "published"; }; header?: never; path: { @@ -93949,23 +100732,18 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; + "application/json": components["schemas"]["campaign-summary"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/set-codespaces-access": { + "campaigns/create-campaign": { parameters: { query?: never; header?: never; @@ -93978,150 +100756,237 @@ export interface operations { requestBody: { content: { "application/json": { + /** @description The name of the campaign */ + name: string; + /** @description A description for the campaign */ + description: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; /** - * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. - * @enum {string} + * Format: date-time + * @description The end date and time of the campaign. The date must be in the future. */ - visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; - /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ - selected_usernames?: string[]; - }; + ends_at: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + /** @description The code scanning alerts to include in this campaign */ + code_scanning_alerts?: { + /** @description The repository id */ + repository_id: number; + /** @description The alert numbers */ + alert_numbers: number[]; + }[] | null; + /** + * @description If true, will automatically generate issues for the campaign. The default is false. + * @default false + */ + generate_issues?: boolean; + } & (unknown | unknown); }; }; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ + /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Too Many Requests */ + 429: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/set-codespaces-access-users": { + "campaigns/get-campaign-summary": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members whose codespaces be billed to the organization. */ - selected_usernames: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ - 400: { + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/delete-codespaces-access-users": { + "campaigns/delete-campaign": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ - selected_usernames: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response when successfully modifying permissions. */ + /** @description Deletion successful */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ - 400: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/list-org-secrets": { + "campaigns/update-campaign": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The name of the campaign */ + name?: string; + /** @description A description for the campaign */ + description?: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; + /** + * Format: date-time + * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at?: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + state?: components["schemas"]["campaign-state"]; + }; + }; + }; responses: { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-org-secret"][]; - }; + "application/json": components["schemas"]["campaign-summary"]; + }; + }; + /** @description Bad Request */ + 400: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; }; }; - }; - }; - "codespaces/get-org-public-key": { - parameters: { - query?: never; + 503: components["responses"]["service_unavailable"]; + }; + }; + "code-scanning/list-alerts-for-org": { + parameters: { + query?: { + /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name?: components["parameters"]["tool-name"]; + /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid?: components["parameters"]["tool-guid"]; + /** @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 page number of the results to fetch. For 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 If specified, only code scanning alerts with this state will be returned. */ + state?: components["schemas"]["code-scanning-alert-state-query"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated"; + /** @description If specified, only code scanning alerts with this severity will be returned. */ + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94134,23 +100999,33 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; }; }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/get-org-secret": { + "code-security/get-configurations-for-org": { parameters: { - query?: never; + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @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?: number; + /** @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"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -94159,103 +101034,197 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespaces-org-secret"]; + "application/json": components["schemas"]["code-security-configuration"][]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "codespaces/create-or-update-org-secret": { + "code-security/create-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id?: string; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; /** - * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @default disabled * @enum {string} */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: number[]; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @default disabled + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default not_set + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @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 + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; }; responses: { - /** @description Response when creating a secret */ + /** @description Successfully created code security configuration */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["code-security-configuration"]; }; - content?: never; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "codespaces/delete-org-secret": { + "code-security/get-default-configurations": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - }; - }; - "codespaces/list-selected-repos-for-org-secret": { - 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 The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -94267,236 +101236,375 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "codespaces/set-selected-repos-for-org-secret": { + "code-security/detach-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; + /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */ + selected_repository_ids?: number[]; }; }; }; responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type not set to selected */ - 409: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 409: components["responses"]["conflict"]; }; }; - "codespaces/add-selected-repo-to-org-secret": { + "code-security/get-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description No Content when repository was added to the selected list */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type is not set to selected */ - 409: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["code-security-configuration"]; }; - content?: never; }; - 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "codespaces/remove-selected-repo-from-org-secret": { + "code-security/delete-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response when repository was removed from the selected list */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type not set to selected */ - 409: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; }; }; - "copilot/get-copilot-organization-details": { + "code-security/update-configuration": { 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 code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @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} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; + }; + }; + }; responses: { - /** @description OK */ + /** @description Response when a configuration is updated */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-organization-details"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description There is a problem with your account's associated payment method. */ - 422: { + /** @description Response when no new updates are made */ + 204: { headers: { [name: string]: unknown; }; content?: never; }; - 500: components["responses"]["internal_error"]; }; }; - "copilot/list-copilot-seats": { + "code-security/attach-configuration": { 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?: number; + 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 code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @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" | "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[]; + }; }; + }; + responses: { + 202: components["responses"]["accepted"]; + }; + }; + "code-security/set-configuration-as-default": { + 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 code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + }; + }; + }; responses: { - /** @description Response */ + /** @description Default successfully changed. */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ - total_seats: number; - seats: components["schemas"]["copilot-seat-details"][]; + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; }; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-seats-for-teams": { + "code-security/get-repositories-for-configuration": { parameters: { - query?: never; + 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?: number; + /** @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 A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; + }; header?: never; path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description List of team names within the organization to which to grant access to GitHub Copilot. */ - selected_teams: string[]; - }; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description OK */ - 201: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - seats_created: number; - }; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 500: components["responses"]["internal_error"]; }; }; - "copilot/cancel-copilot-seat-assignment-for-teams": { + "codespaces/list-in-organization": { parameters: { - query?: never; + 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. */ @@ -94504,40 +101612,28 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The names of teams from which to revoke access to GitHub Copilot. */ - selected_teams: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description OK */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { - seats_cancelled: number; + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-seats-for-users": { + "codespaces/set-codespaces-access": { parameters: { query?: never; header?: never; @@ -94550,37 +101646,38 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ - selected_usernames: string[]; + /** + * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. + * @enum {string} + */ + visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; + /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ + selected_usernames?: string[]; }; }; }; responses: { - /** @description OK */ - 201: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - seats_created: number; - }; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "copilot/cancel-copilot-seat-assignment-for-users": { + "codespaces/set-codespaces-access-users": { parameters: { query?: never; header?: never; @@ -94593,48 +101690,35 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ + /** @description The usernames of the organization members whose codespaces be billed to the organization. */ selected_usernames: string[]; }; }; }; responses: { - /** @description OK */ - 200: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - seats_cancelled: number; - }; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ - 422: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-organization": { + "codespaces/delete-codespaces-access-users": { 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; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94642,147 +101726,36 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ + selected_usernames: string[]; }; }; - 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?: { - /** @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: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; - "dependabot/list-alerts-for-org": { - parameters: { - query?: { - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. - * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - state?: components["parameters"]["dependabot-alert-comma-separated-states"]; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. - * - * Can be: `low`, `medium`, `high`, `critical` - */ - severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; - /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; - /** - * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - * - An exact number (`n`) - * - Comparators such as `>n`, `=n`, `<=n` - * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 - * - * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. - */ - epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; - /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - scope?: components["parameters"]["dependabot-alert-scope"]; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. - */ - sort?: components["parameters"]["dependabot-alert-sort"]; - /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; - /** @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"]; + content?: never; }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["dependabot-alert-with-repository"][]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "dependabot/list-org-secrets": { + "codespaces/list-org-secrets": { 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)." */ @@ -94808,13 +101781,13 @@ export interface operations { content: { "application/json": { total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; + secrets: components["schemas"]["codespaces-org-secret"][]; }; }; }; }; }; - "dependabot/get-org-public-key": { + "codespaces/get-org-public-key": { parameters: { query?: never; header?: never; @@ -94832,12 +101805,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - "dependabot/get-org-secret": { + "codespaces/get-org-secret": { parameters: { query?: never; header?: never; @@ -94854,15 +101827,16 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; + "application/json": components["schemas"]["codespaces-org-secret"]; }; }; }; }; - "dependabot/create-or-update-org-secret": { + "codespaces/create-or-update-org-secret": { parameters: { query?: never; header?: never; @@ -94877,17 +101851,17 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ encrypted_value?: string; - /** @description ID of the key you used to encrypt the secret. */ + /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ visibility: "all" | "private" | "selected"; - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; + /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: number[]; }; }; }; @@ -94908,9 +101882,11 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "dependabot/delete-org-secret": { + "codespaces/delete-org-secret": { parameters: { query?: never; header?: never; @@ -94931,9 +101907,10 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "dependabot/list-selected-repos-for-org-secret": { + "codespaces/list-selected-repos-for-org-secret": { 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)." */ @@ -94964,9 +101941,10 @@ export interface operations { }; }; }; + 404: components["responses"]["not_found"]; }; }; - "dependabot/set-selected-repos-for-org-secret": { + "codespaces/set-selected-repos-for-org-secret": { parameters: { query?: never; header?: never; @@ -94981,7 +101959,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -94994,9 +101972,17 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + /** @description Conflict when visibility type not set to selected */ + 409: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "dependabot/add-selected-repo-to-org-secret": { + "codespaces/add-selected-repo-to-org-secret": { parameters: { query?: never; header?: never; @@ -95018,6 +102004,7 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ 409: { headers: { @@ -95025,9 +102012,10 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed"]; }; }; - "dependabot/remove-selected-repo-from-org-secret": { + "codespaces/remove-selected-repo-from-org-secret": { parameters: { query?: never; header?: never; @@ -95049,6 +102037,7 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { headers: { @@ -95056,9 +102045,10 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed"]; }; }; - "packages/list-docker-migration-conflicting-packages-for-organization": { + "copilot/get-copilot-organization-details": { parameters: { query?: never; header?: never; @@ -95070,54 +102060,35 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package"][]; + "application/json": components["schemas"]["copilot-organization-details"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - }; - }; - "activity/list-public-org-events": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["event"][]; - }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-failed-invitations": { + "copilot/list-copilot-seats": { 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 The number of results per page (max 100). For 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: { @@ -95135,20 +102106,22 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"][]; + "application/json": { + /** @description Total number of Copilot seats for the organization currently being billed. */ + total_seats?: number; + seats?: components["schemas"]["copilot-seat-details"][]; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-webhooks": { + "copilot/add-copilot-seats-for-teams": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -95156,22 +102129,40 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description List of team names within the organization to which to grant access to GitHub Copilot. */ + selected_teams: string[]; + }; + }; + }; responses: { - /** @description Response */ - 200: { + /** @description OK */ + 201: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"][]; + "application/json": { + seats_created: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/create-webhook": { + "copilot/cancel-copilot-seat-assignment-for-teams": { parameters: { query?: never; header?: never; @@ -95184,226 +102175,207 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Must be passed as "web". */ - name: string; - /** @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"]; - /** @example "kdaigle" */ - username?: string; - /** @example "password" */ - password?: string; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. - * @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; + /** @description The names of teams from which to revoke access to GitHub Copilot. */ + selected_teams: string[]; }; }; }; responses: { - /** @description Response */ - 201: { + /** @description OK */ + 200: { headers: { - /** @example https://api.github.com/orgs/octocat/hooks/1 */ - Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_cancelled: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/get-webhook": { + "copilot/add-copilot-seats-for-users": { 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; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ + selected_usernames: string[]; + }; + }; + }; responses: { - /** @description Response */ - 200: { + /** @description OK */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_created: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-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: { + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { headers: { [name: string]: unknown; }; content?: never; }; - 404: components["responses"]["not_found"]; - }; - }; - "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; + 500: components["responses"]["internal_error"]; }; - 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; + }; + "copilot/cancel-copilot-seat-assignment-for-users": { + 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 The usernames of the organization members for which to revoke access to GitHub Copilot. */ + selected_usernames: string[]; }; }; }; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_cancelled: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/get-webhook-config-for-org": { + "copilot/copilot-content-exclusion-for-organization": { 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 */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["copilot-organization-content-exclusion-details"]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/update-webhook-config-for-org": { + "copilot/set-copilot-content-exclusion-for-organization": { 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?: { + /** @description The content exclusion rules to set */ + 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"]; + [key: string]: (string | { + ifAnyMatch: string[]; + } | { + ifNoneMatch: string[]; + })[]; }; }; }; responses: { - /** @description Response */ + /** @description Success */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": { + message?: string; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 413: components["responses"]["too_large"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-webhook-deliveries": { + "copilot/copilot-metrics-for-organization": { 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"]; + /** @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 100 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 100). For 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 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; }; @@ -95415,23 +102387,94 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/get-webhook-delivery": { + "dependabot/list-alerts-for-org": { parameters: { - query?: never; + query?: { + /** + * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` + */ + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** + * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` + */ + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** + * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` + */ + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** + * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. + */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"]; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ + scope?: components["parameters"]["dependabot-alert-scope"]; + /** + * @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. + */ + sort?: components["parameters"]["dependabot-alert-sort"]; + /** @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 number of results per page (max 100). For 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 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; }; @@ -95443,83 +102486,55 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; + 304: components["responses"]["not_modified"]; 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/redeliver-webhook-delivery": { + "dependabot/list-org-secrets": { 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"]; + 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"]; }; - 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: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-dependabot-secret"][]; + }; + }; }; - 404: components["responses"]["not_found"]; }; }; - "api-insights/get-route-stats-by-actor": { + "dependabot/get-org-public-key": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; - }; + query?: never; 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; }; @@ -95531,33 +102546,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-route-stats"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - "api-insights/get-subject-stats": { + "dependabot/get-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -95569,85 +102571,96 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-subject-stats"]; + "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - "api-insights/get-summary-stats": { + "dependabot/create-or-update-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + encrypted_value?: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: (number | string)[]; + }; + }; + }; responses: { - /** @description Response */ - 200: { + /** @description Response when creating a secret */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "api-insights/get-summary-stats-by-user": { + "dependabot/delete-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; - }; + content?: never; }; }; }; - "api-insights/get-summary-stats-by-actor": { + "dependabot/list-selected-repos-for-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -95659,131 +102672,113 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; }; }; - "api-insights/get-time-stats": { + "dependabot/set-selected-repos-for-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids: number[]; + }; + }; + }; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-time-stats"]; - }; + content?: never; }; }; }; - "api-insights/get-time-stats-by-user": { + "dependabot/add-selected-repo-to-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description No Content when repository was added to the selected list */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-time-stats"]; + content?: never; + }; + /** @description Conflict when visibility type is not set to selected */ + 409: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "api-insights/get-time-stats-by-actor": { + "dependabot/remove-selected-repo-from-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description Response when repository was removed from the selected list */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-time-stats"]; + content?: never; + }; + /** @description Conflict when visibility type not set to selected */ + 409: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "api-insights/get-user-stats": { + "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -95795,14 +102790,21 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-user-stats"]; + "application/json": components["schemas"]["package"][]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "apps/get-org-installation": { + "activity/list-public-org-events": { parameters: { - query?: never; + 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. */ @@ -95818,12 +102820,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["installation"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "orgs/list-app-installations": { + "orgs/list-failed-invitations": { 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)." */ @@ -95847,17 +102849,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; + "application/json": components["schemas"]["organization-invitation"][]; }; }; + 404: components["responses"]["not_found"]; }; }; - "interactions/get-restrictions-for-org": { + "orgs/list-webhooks": { parameters: { - query?: never; + 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. */ @@ -95870,15 +102875,17 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["org-hook"][]; }; }; + 404: components["responses"]["not_found"]; }; }; - "interactions/set-restrictions-for-org": { + "orgs/create-webhook": { parameters: { query?: never; header?: never; @@ -95890,204 +102897,227 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["interaction-limit"]; + "application/json": { + /** @description Must be passed as "web". */ + name: string; + /** @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"]; + /** @example "kdaigle" */ + username?: string; + /** @example "password" */ + password?: string; + }; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + * @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; + }; }; }; responses: { /** @description Response */ - 200: { + 201: { headers: { + /** @example https://api.github.com/orgs/octocat/hooks/1 */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["org-hook"]; }; }; + 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "interactions/remove-restrictions-for-org": { + "orgs/get-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: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-hook"]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/list-pending-invitations": { + "orgs/delete-webhook": { 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 Filter invitations by their member role. */ - role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; - /** @description Filter invitations by their invitation source. */ - invitation_source?: "all" | "member" | "scim"; - }; + 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: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - "orgs/create-invitation": { + "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 **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id: number; - /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email: string; + /** @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 The role for the new member. - * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. - * @default direct_member - * @enum {string} + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. + * @default [ + * "push" + * ] */ - role: "admin" | "direct_member" | "billing_manager" | "reinstate"; - /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids: number[]; + 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 */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"]; + "application/json": components["schemas"]["org-hook"]; }; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "orgs/cancel-invitation": { + "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 invitation. */ - invitation_id: components["parameters"]["invitation-id"]; + /** @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: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["webhook-config"]; + }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-invitation-teams": { + "orgs/update-webhook-config-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"]; - }; + 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 invitation. */ - invitation_id: components["parameters"]["invitation-id"]; + /** @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; + 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: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["webhook-config"]; }; }; - 404: components["responses"]["not_found"]; }; }; - "issues/list-for-org": { + "orgs/list-webhook-deliveries": { parameters: { query?: { - /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; - /** @description Indicates the state of the issues to return. */ - state?: "open" | "closed" | "all"; - /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; - /** @description What to sort results by. */ - sort?: "created" | "updated" | "comments"; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; /** @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 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; }; @@ -96096,32 +103126,26 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issue"][]; + "application/json": components["schemas"]["hook-delivery-item"][]; }; }; - 404: components["responses"]["not_found"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-members": { + "orgs/get-webhook-delivery": { parameters: { - query?: { - /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */ - filter?: "2fa_disabled" | "all"; - /** @description Filter members returned by their role. */ - role?: "all" | "admin" | "member"; - /** @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"]; - }; + 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; }; @@ -96130,64 +103154,45 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["hook-delivery"]; }; }; + 400: components["responses"]["bad_request"]; 422: components["responses"]["validation_failed"]; }; }; - "orgs/check-membership-for-user": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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 if requester is an organization member and user is a member */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if requester is not an organization member */ - 302: { - headers: { - /** @example https://api.github.com/orgs/github/public_members/pezra */ - Location?: string; - [name: string]: unknown; - }; - content?: never; - }; - /** @description Not Found if requester is an organization member and user is not a member */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 202: components["responses"]["accepted"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/remove-member": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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; }; @@ -96200,23 +103205,35 @@ export interface operations { }; content?: never; }; - 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "codespaces/get-codespaces-for-user-in-org": { + "api-insights/get-route-stats-by-actor": { 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"]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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; }; @@ -96228,54 +103245,33 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; + "application/json": components["schemas"]["api-insights-route-stats"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "codespaces/delete-from-organization": { + "api-insights/get-subject-stats": { parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; }; - cookie?: never; - }; - requestBody?: never; - responses: { - 202: components["responses"]["accepted"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; - "codespaces/stop-in-organization": { - parameters: { - query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; @@ -96287,61 +103283,53 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespace"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/get-copilot-seat-details-for-user": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description The user's GitHub Copilot seat details, including usage. */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-seat-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ - 422: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; - content?: never; }; - 500: components["responses"]["internal_error"]; }; }; - "orgs/get-membership-for-user": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description The ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -96353,39 +103341,31 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/set-membership-for-user": { + "api-insights/get-summary-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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 The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. - * @default member - * @enum {string} - */ - role: "admin" | "member"; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -96393,47 +103373,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-membership"]; - }; - }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/remove-membership-for-user": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; - content?: never; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "migrations/list-for-org": { + "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 The page number of the results to fetch. For 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 Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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: { @@ -96447,211 +103400,182 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"][]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; }; }; - "migrations/start-for-org": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 ID of the user to query for stats */ + user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; - /** - * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. - * @default false - * @example true - */ - lock_repositories?: boolean; - /** - * @description Indicates whether metadata should be excluded and only git source should be included for the migration. - * @default false - */ - exclude_metadata?: boolean; - /** - * @description Indicates whether the repository git data should be excluded from the migration. - * @default false - */ - exclude_git_data?: boolean; - /** - * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). - * @default false - * @example true - */ - exclude_attachments?: boolean; - /** - * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). - * @default false - * @example true - */ - exclude_releases?: boolean; - /** - * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. - * @default false - * @example true - */ - exclude_owner_projects?: boolean; - /** - * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). - * @default false - * @example true - */ - org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ - exclude?: "repositories"[]; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "migrations/get-status-for-org": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: { - /** @description Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 migration. */ - migration_id: components["parameters"]["migration-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: { - /** - * @description * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/download-archive-for-org": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the migration. */ - migration_id: components["parameters"]["migration-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 */ - 302: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-user-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/delete-archive-for-org": { + "apps/get-org-installation": { 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 migration. */ - migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["installation"]; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/unlock-repo-for-org": { + "orgs/list-app-installations": { parameters: { - query?: never; + 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 The unique identifier of the migration. */ - migration_id: components["parameters"]["migration-id"]; - /** @description repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + }; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/list-repos-for-org": { + "interactions/get-restrictions-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"]; - }; + 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 migration. */ - migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; @@ -96660,17 +103584,15 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; - 404: components["responses"]["not_found"]; }; }; - "orgs/list-org-roles": { + "interactions/set-restrictions-for-org": { parameters: { query?: never; header?: never; @@ -96680,35 +103602,31 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; responses: { - /** @description Response - list of organization roles */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of organization roles available to the organization. */ - total_count: number; - /** @description The list of organization roles available to the organization. */ - roles: components["schemas"]["organization-role"][]; - }; + "application/json": components["schemas"]["interaction-limit-response"]; }; }; - 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "orgs/revoke-all-org-roles-team": { + "interactions/remove-restrictions-for-org": { parameters: { query?: never; 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; }; @@ -96723,79 +103641,95 @@ export interface operations { }; }; }; - "orgs/assign-team-to-org-role": { + "orgs/list-pending-invitations": { parameters: { - query?: never; + 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 Filter invitations by their member role. */ + role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; + /** @description Filter invitations by their invitation source. */ + invitation_source?: "all" | "member" | "scim"; + }; 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"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization, team or role does not exist. */ - 404: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["organization-invitation"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/revoke-org-role-team": { + "orgs/create-invitation": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ + invitee_id?: number; + /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ + email?: string; + /** + * @description The role for the new member. + * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + * @default direct_member + * @enum {string} + */ + role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; + /** @description Specify IDs for the teams you want to invite new members to. */ + team_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ - 204: { + 201: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"]; + }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/revoke-all-org-roles-user": { + "orgs/cancel-invitation": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description The unique identifier of the invitation. */ + invitation_id: components["parameters"]["invitation-id"]; }; cookie?: never; }; @@ -96808,85 +103742,81 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/assign-user-to-org-role": { + "orgs/list-invitation-teams": { parameters: { - query?: never; + 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 The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; + /** @description The unique identifier of the invitation. */ + invitation_id: components["parameters"]["invitation-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization, user or role does not exist. */ - 404: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["team"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/revoke-org-role-user": { + "orgs/list-issue-types": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["issue-type"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/get-org-role": { + "orgs/create-issue-type": { 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 role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["organization-create-issue-type"]; + }; + }; responses: { /** @description Response */ 200: { @@ -96894,61 +103824,86 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-role"]; + "application/json": components["schemas"]["issue-type"]; }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/list-org-role-teams": { + "orgs/update-issue-type": { 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"]; - }; + 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 role. */ - role_id: components["parameters"]["role-id"]; + /** @description The unique identifier of the issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; responses: { - /** @description Response - List of assigned teams */ + /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-role-assignment"][]; + "application/json": components["schemas"]["issue-type"]; }; }; - /** @description Response if the organization or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/delete-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; }; - /** @description Response if the organization roles feature is not enabled or validation failed. */ - 422: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/list-org-role-users": { + "issues/list-for-org": { parameters: { query?: { + /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + /** @description Indicates the state of the issues to return. */ + state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; + /** @description What to sort results by. */ + sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; /** @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)." */ @@ -96958,44 +103913,31 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response - List of assigned users */ + /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["user-role-assignment"][]; - }; - }; - /** @description Response if the organization or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled or validation failed. */ - 422: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["issue"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/list-outside-collaborators": { + "orgs/list-members": { parameters: { query?: { - /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ - filter?: "2fa_disabled" | "all"; + /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; + /** @description Filter members returned by their role. */ + role?: "all" | "admin" | "member"; /** @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)." */ @@ -97020,9 +103962,10 @@ export interface operations { "application/json": components["schemas"]["simple-user"][]; }; }; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/convert-member-to-outside-collaborator": { + "orgs/check-membership-for-user": { parameters: { query?: never; header?: never; @@ -97034,45 +103977,34 @@ export interface operations { }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. - * @default false - */ - async: boolean; - }; - }; - }; + requestBody?: never; responses: { - /** @description User is getting converted asynchronously */ - 202: { + /** @description Response if requester is an organization member and user is a member */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": Record; - }; + content?: never; }; - /** @description User was converted */ - 204: { + /** @description Response if requester is not an organization member */ + 302: { headers: { + /** @example https://api.github.com/orgs/github/public_members/pezra */ + Location?: string; [name: string]: unknown; }; content?: never; }; - /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - 403: { + /** @description Not Found if requester is an organization member and user is not a member */ + 404: { headers: { [name: string]: unknown; }; content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "orgs/remove-outside-collaborator": { + "orgs/remove-member": { parameters: { query?: never; header?: never; @@ -97093,41 +104025,23 @@ export interface operations { }; content?: never; }; - /** @description Unprocessable Entity if user is a member of the organization */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message: string; - documentation_url: string; - }; - }; - }; + 403: components["responses"]["forbidden"]; }; }; - "packages/list-packages-for-organization": { + "codespaces/get-codespaces-for-user-in-org": { parameters: { - query: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. - * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - visibility?: components["parameters"]["package-visibility"]; - /** @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?: number; + 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?: number; + 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 The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97139,150 +104053,120 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; + }; }; }; - 400: components["responses"]["package_es_list_error"]; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-package-for-organization": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; - /** @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"]["package"]; - }; - }; - }; - }; - "packages/delete-package-for-org": { + "codespaces/delete-from-organization": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The name of the codespace. */ + codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/restore-package-for-org": { + "codespaces/stop-in-organization": { parameters: { - query?: { - /** @description package token */ - token?: string; - }; + query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The name of the codespace. */ + codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["codespace"]; + }; }; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-all-package-versions-for-package-owned-by-org": { + "copilot/get-copilot-seat-details-for-user": { 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"]; - /** @description The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; + query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description The user's GitHub Copilot seat details, including usage. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package-version"][]; + "application/json": components["schemas"]["copilot-seat-details"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-package-version-for-organization": { + "orgs/get-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97294,54 +104178,62 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["org-membership"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "packages/delete-package-version-for-org": { + "orgs/set-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The role to give the user in the organization. Can be one of: + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. + * @default member + * @enum {string} + */ + role?: "admin" | "member"; + }; }; - cookie?: never; }; - requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-membership"]; + }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "packages/restore-package-version-for-org": { + "orgs/remove-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97354,32 +104246,19 @@ export interface operations { }; content?: never; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "orgs/list-pat-grant-requests": { + "migrations/list-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 The property by which to sort the results. */ - sort?: components["parameters"]["personal-access-token-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description A list of owner usernames to use to filter the results. */ - owner?: components["parameters"]["personal-access-token-owner"]; - /** @description The name of the repository to use to filter the results. */ - repository?: components["parameters"]["personal-access-token-repository"]; - /** @description The permission to use to filter the results. */ - permission?: components["parameters"]["personal-access-token-permission"]; - /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_before?: components["parameters"]["personal-access-token-before"]; - /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; header?: never; path: { @@ -97397,16 +104276,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; + "application/json": components["schemas"]["migration"][]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/review-pat-grant-requests-in-bulk": { + "migrations/start-for-org": { parameters: { query?: never; header?: never; @@ -97419,203 +104294,176 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ - pat_request_ids?: number[]; + /** @description A list of arrays indicating which repositories should be migrated. */ + repositories: string[]; /** - * @description Action to apply to the requests. - * @enum {string} + * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false + * @example true */ - action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ - reason?: string | null; - }; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "orgs/review-pat-grant-request": { - 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 request for access via fine-grained personal access token. */ - pat_request_id: number; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { + lock_repositories?: boolean; /** - * @description Action to apply to the request. - * @enum {string} + * @description Indicates whether metadata should be excluded and only git source should be included for the migration. + * @default false */ - action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ - reason?: string | null; + exclude_metadata?: boolean; + /** + * @description Indicates whether the repository git data should be excluded from the migration. + * @default false + */ + exclude_git_data?: boolean; + /** + * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false + * @example true + */ + exclude_attachments?: boolean; + /** + * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false + * @example true + */ + exclude_releases?: boolean; + /** + * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false + * @example true + */ + exclude_owner_projects?: boolean; + /** + * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + * @default false + * @example true + */ + org_metadata_only?: boolean; + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ + exclude?: "repositories"[]; }; }; }; responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["migration"]; + }; + }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grant-request-repositories": { + "migrations/get-status-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 Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the request for access via fine-grained personal access token. */ - pat_request_id: number; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** + * @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["migration"]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grants": { + "migrations/download-archive-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 The property by which to sort the results. */ - sort?: components["parameters"]["personal-access-token-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description A list of owner usernames to use to filter the results. */ - owner?: components["parameters"]["personal-access-token-owner"]; - /** @description The name of the repository to use to filter the results. */ - repository?: components["parameters"]["personal-access-token-repository"]; - /** @description The permission to use to filter the results. */ - permission?: components["parameters"]["personal-access-token-permission"]; - /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_before?: components["parameters"]["personal-access-token-before"]; - /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_after?: components["parameters"]["personal-access-token-after"]; - }; + 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 migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 302: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["organization-programmatic-access-grant"][]; - }; + content?: never; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/update-pat-accesses": { + "migrations/delete-archive-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 migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Action to apply to the fine-grained personal access token. - * @enum {string} - */ - action: "revoke"; - /** @description The IDs of the fine-grained personal access tokens. */ - pat_ids: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 202: components["responses"]["accepted"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/update-pat-access": { + "migrations/unlock-repo-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 fine-grained personal access token. */ - pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ + repo_name: components["parameters"]["repo-name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Action to apply to the fine-grained personal access token. - * @enum {string} - */ - action: "revoke"; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grant-repositories": { + "migrations/list-repos-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)." */ @@ -97627,8 +104475,8 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the fine-grained personal access token. */ - pat_id: number; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; @@ -97644,19 +104492,12 @@ export interface operations { "application/json": components["schemas"]["minimal-repository"][]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "private-registries/list-org-private-registries": { + "orgs/list-org-roles": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -97666,142 +104507,145 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description Response - list of organization roles */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { "application/json": { - total_count: number; - configurations: components["schemas"]["org-private-registry-configuration"][]; + /** @description The total number of organization roles available to the organization. */ + total_count?: number; + /** @description The list of organization roles available to the organization. */ + roles?: components["schemas"]["organization-role"][]; }; }; }; - 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "private-registries/create-org-private-registry": { + "orgs/revoke-all-org-roles-team": { parameters: { query?: never; 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: { - content: { - "application/json": { - /** - * @description The registry type. - * @enum {string} - */ - registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - encrypted_value: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id: string; - /** - * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. - * @enum {string} - */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + }; + }; + "orgs/assign-team-to-org-role": { + parameters: { + query?: never; + 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"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The organization private registry configuration */ - 201: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + content?: never; + }; + /** @description Response if the organization, team or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "private-registries/get-org-public-key": { + "orgs/revoke-org-role-team": { parameters: { query?: never; 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"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": { - /** - * @description The identifier for the key. - * @example 012345678912345678 - */ - key_id: string; - /** - * @description The Base64 encoded public key. - * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - */ - key: string; - }; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "private-registries/get-org-private-registry": { + "orgs/revoke-all-org-roles-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description The specified private registry configuration for the organization */ - 200: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-private-registry-configuration"]; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "private-registries/delete-org-private-registry": { + "orgs/assign-user-to-org-role": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; @@ -97814,63 +104658,122 @@ export interface operations { }; content?: never; }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; + /** @description Response if the organization, user or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "private-registries/update-org-private-registry": { + "orgs/revoke-org-role-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description The registry type. - * @enum {string} - */ - registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - username: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - encrypted_value: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id: string; - /** - * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. - * @enum {string} - */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ - selected_repository_ids: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; + }; + "orgs/get-org-role": { + 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 role. */ + role_id: components["parameters"]["role-id"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-role"]; + }; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "projects/list-for-org": { + "orgs/list-org-role-teams": { + 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 The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response - List of assigned teams */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "orgs/list-org-role-users": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; /** @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)." */ @@ -97880,64 +104783,49 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description Response - List of assigned users */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["user-role-assignment"][]; }; }; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/create-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 The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; + /** @description Response if the organization or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - /** @description Response */ - 201: { + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project"]; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/get-all-custom-properties": { + "orgs/list-outside-collaborators": { parameters: { - query?: never; + query?: { + /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; + /** @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. */ @@ -97950,92 +104838,125 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties": { + "orgs/convert-member-to-outside-collaborator": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/json": { - /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["custom-property"][]; + /** + * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. + * @default false + */ + async?: boolean; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description User is getting converted asynchronously */ + 202: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"][]; + "application/json": Record; }; }; - 403: components["responses"]["forbidden"]; + /** @description User was converted */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 404: components["responses"]["not_found"]; }; }; - "orgs/get-custom-property": { + "orgs/remove-outside-collaborator": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unprocessable Entity if user is a member of the organization */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"]; + "application/json": { + message?: string; + documentation_url?: string; + }; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-property": { + "packages/list-packages-for-organization": { parameters: { - query?: never; + query: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + /** + * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + */ + visibility?: components["parameters"]["package-visibility"]; + /** @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?: number; + /** @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?: number; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["custom-property-set-payload"]; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -98043,44 +104964,50 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["package"][]; }; }; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/remove-custom-property": { + "packages/get-package-for-organization": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["package"]; + }; + }; }; }; - "orgs/list-custom-properties-values-for-repos": { + "packages/delete-package-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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - repository_query?: string; - }; + query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98089,62 +105016,64 @@ export interface operations { requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-repo-custom-property-values"][]; - }; + content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties-values-for-repos": { + "packages/restore-package-for-org": { parameters: { - query?: never; + query?: { + /** @description package token */ + token?: string; + }; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The names of repositories that the custom property values will be applied to. */ - repository_names: string[]; - /** @description List of custom property names and associated values to apply to the repositories. */ - properties: components["schemas"]["custom-property-value"][]; - }; - }; - }; + requestBody?: never; responses: { - /** @description No Content when custom property values are successfully created or updated */ + /** @description Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-public-members": { + "packages/get-all-package-versions-for-package-owned-by-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 The number of results per page (max 100). For 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 state of the package, either active or deleted. */ + state?: "active" | "deleted"; }; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98155,54 +105084,59 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["package-version"][]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/check-public-membership-for-user": { + "packages/get-package-version-for-organization": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response if user is a public member */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description Not Found if user is not a public member */ - 404: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["package-version"]; }; - content?: never; }; }; }; - "orgs/set-public-membership-for-authenticated-user": { + "packages/delete-package-version-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; @@ -98215,18 +105149,24 @@ export interface operations { }; content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/remove-public-membership-for-authenticated-user": { + "packages/restore-package-version-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; @@ -98239,21 +105179,34 @@ export interface operations { }; content?: never; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "repos/list-for-org": { + "orgs/list-pat-grant-requests": { parameters: { query?: { - /** @description Specifies the types of repositories you want returned. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; /** @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 The property by which to sort the results. */ + sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ + owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ + repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ + permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; header?: never; path: { @@ -98271,12 +105224,16 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "repos/create-in-org": { + "orgs/review-pat-grant-requests-in-bulk": { parameters: { query?: never; header?: never; @@ -98289,249 +105246,62 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The name of the repository. */ - name: string; - /** @description A short description of the repository. */ - description?: string; - /** @description A URL with more information about the repository. */ - homepage?: string; - /** - * @description Whether the repository is private. - * @default false - */ - private?: boolean; - /** - * @description The visibility of the repository. - * @enum {string} - */ - visibility?: "public" | "private"; - /** - * @description Either `true` to enable issues for this repository or `false` to disable them. - * @default true - */ - has_issues?: boolean; - /** - * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. - * @default true - */ - has_projects?: boolean; - /** - * @description Either `true` to enable the wiki for this repository or `false` to disable it. - * @default true - */ - has_wiki?: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - has_downloads?: boolean; - /** - * @description Either `true` to make this repo available as a template repository or `false` to prevent it. - * @default false - */ - is_template?: boolean; - /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; - /** - * @description Pass `true` to create an initial commit with empty README. - * @default false - */ - auto_init?: boolean; - /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; - /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; - /** - * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - * @default true - */ - allow_squash_merge?: boolean; - /** - * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. - * @default false - */ - allow_auto_merge?: boolean; - /** - * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** - * @default false - */ - 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 is closing down. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default?: boolean; - /** - * @description Required when using `squash_merge_commit_message`. - * - * The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description Required when using `merge_commit_message`. - * - * The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ + pat_request_ids?: number[]; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * @description Action to apply to the requests. * @enum {string} */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; + action: "approve" | "deny"; + /** @description Reason for approving or denying the requests. Max 1024 characters. */ + reason?: string | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - /** @example https://api.github.com/repos/octocat/Hello-World */ - Location?: string; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; + 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/get-org-rulesets": { - 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 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: { - /** @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"]["repository-ruleset"][]; - }; - }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/create-org-ruleset": { + "orgs/review-pat-grant-request": { 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 request for access via fine-grained personal access token. */ + pat_request_id: number; }; cookie?: never; }; - /** @description Request body */ requestBody: { content: { "application/json": { - /** @description The name of the ruleset. */ - name: string; /** - * @description The target of the ruleset - * @default branch + * @description Action to apply to the request. * @enum {string} */ - target?: "branch" | "tag" | "push" | "repository"; - enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions?: components["schemas"]["org-ruleset-conditions"]; - /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + action: "approve" | "deny"; + /** @description Reason for approving or denying the request. Max 1024 characters. */ + reason?: string | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-rule-suites": { + "orgs/list-pat-grant-request-repositories": { parameters: { query?: { - /** @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?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. */ - repository_name?: components["parameters"]["repository-name-in-query"]; - /** - * @description The time period to filter by. - * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). - */ - time_period?: components["parameters"]["time-period"]; - /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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)." */ @@ -98541,6 +105311,8 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the request for access via fine-grained personal access token. */ + pat_request_id: number; }; cookie?: never; }; @@ -98549,30 +105321,46 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-rule-suite": { + "orgs/list-pat-grants": { parameters: { - query?: never; + 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 The property by which to sort the results. */ + sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ + owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ + repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ + permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** - * @description The unique identifier of the rule suite result. - * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) - * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) - * for organizations. - */ - rule_suite_id: components["parameters"]["rule-suite-id"]; }; cookie?: never; }; @@ -98581,141 +105369,122 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["organization-programmatic-access-grant"][]; }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-ruleset": { + "orgs/update-pat-accesses": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the ruleset. */ - ruleset_id: number; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; + requestBody: { + content: { + "application/json": { + /** + * @description Action to apply to the fine-grained personal access token. + * @enum {string} + */ + action: "revoke"; + /** @description The IDs of the fine-grained personal access tokens. */ + pat_ids: number[]; }; }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/update-org-ruleset": { + "orgs/update-pat-access": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the ruleset. */ - ruleset_id: number; + /** @description The unique identifier of the fine-grained personal access token. */ + pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; cookie?: never; }; - /** @description Request body */ - requestBody?: { + requestBody: { content: { "application/json": { - /** @description The name of the ruleset. */ - name: string; /** - * @description The target of the ruleset + * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - target: "branch" | "tag" | "push" | "repository"; - enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions: components["schemas"]["org-ruleset-conditions"]; - /** @description An array of rules within the ruleset. */ - rules: components["schemas"]["repository-rule"][]; + action: "revoke"; }; }; }; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/delete-org-ruleset": { + "orgs/list-pat-grant-repositories": { parameters: { - query?: never; + 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 The ID of the ruleset. */ - ruleset_id: number; + /** @description Unique identifier of the fine-grained personal access token. */ + pat_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - "secret-scanning/list-alerts-for-org": { + "private-registries/list-org-private-registries": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; - /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - 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"]; + /** @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: { @@ -98733,29 +105502,77 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; }; }; + 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "security-advisories/list-org-repository-advisories": { + "private-registries/create-org-private-registry": { parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "published"; - /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ - state?: "triage" | "draft" | "published" | "closed"; + 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 The registry type. + * @enum {string} + */ + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url: string; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -98768,48 +105585,62 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository-advisory"][]; + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; }; }; - 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; }; }; - "orgs/list-security-manager-teams": { + "private-registries/get-org-private-registry": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description The specified private registry configuration for the organization */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-simple"][]; + "application/json": components["schemas"]["org-private-registry-configuration"]; }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/add-security-manager-team": { + "private-registries/delete-org-private-registry": { parameters: { query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -98822,21 +105653,56 @@ export interface operations { }; content?: never; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/remove-security-manager-team": { + "private-registries/update-org-private-registry": { parameters: { query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -98845,11 +105711,22 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "billing/get-github-actions-billing-org": { + "projects/list-for-org": { parameters: { - query?: never; + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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. */ @@ -98862,19 +105739,25 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["projects-v2"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "billing/get-github-packages-billing-org": { + "projects/get-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98885,47 +105768,70 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["projects-v2"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "billing/get-shared-storage-billing-org": { + "projects/create-draft-item-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; - requestBody?: never; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; responses: { /** @description Response */ - 200: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/list-network-configurations-for-org": { + "projects/list-fields-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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98940,19 +105846,21 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - network_configurations: components["schemas"]["network-configuration"][]; - }; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/create-network-configuration-for-org": { + "projects/add-field-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98961,39 +105869,65 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + /** @description The ID of the IssueField to create the field for. */ + issue_field_id: number; + } | { + /** @description The name of the field. */ name: string; /** - * @description The hosted compute service to use for the network configuration. + * @description The field's data type. * @enum {string} */ - compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - network_settings_ids: string[]; + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; }; }; }; responses: { - /** @description Response */ + /** @description Response for adding a field to an organization-owned project. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-configuration"]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "hosted-compute/get-network-configuration-for-org": { + "projects/get-field-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -99006,117 +105940,123 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-configuration"]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/delete-network-configuration-from-org": { + "projects/list-items-for-org": { parameters: { - query?: never; + query?: { + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/update-network-configuration-for-org": { + "projects/add-item-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 hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ requestBody: { content: { "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - name: string; /** - * @description The hosted compute service to use for the network configuration. + * @description The type of item to add to the project. Must be either Issue or PullRequest. * @enum {string} */ - compute_service: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - network_settings_ids: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["network-configuration"]; - }; - }; - }; - }; - "hosted-compute/get-network-settings-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 hosted compute network settings. */ - network_settings_id: components["parameters"]["network-settings-id"]; + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); }; - cookie?: never; }; - requestBody?: never; responses: { /** @description Response */ - 200: { + 201: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-settings"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "copilot/copilot-metrics-for-team": { + "projects/get-org-item": { 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; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; @@ -99125,161 +106065,189 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; 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": { + "projects/delete-item-for-org": { 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; - }; + query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "teams/list": { + "projects/update-item-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"]; - }; + query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; - requestBody?: never; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; responses: { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/create": { + "projects/create-view-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The name of the team. */ - name: string; - /** @description The description of the team. */ - description?: string; - /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; - /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; /** - * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board * @enum {string} */ - privacy?: "secret" | "closed"; + layout: "table" | "board" | "roadmap"; /** - * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` - * @enum {string} + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; + filter?: string; /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] */ - permission?: "pull" | "push"; - /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; + visible_fields?: number[]; }; }; }; responses: { - /** @description Response */ + /** @description Response for creating a view in an organization-owned project. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["projects-v2-view"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; }; }; - "teams/get-by-name": { + "projects/list-view-items-for-org": { parameters: { - query?: never; + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -99288,127 +106256,85 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "teams/delete-in-org": { + "orgs/custom-properties-for-repos-get-organization-definitions": { parameters: { query?: never; 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 */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["custom-property"][]; + }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/update-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-definitions": { parameters: { query?: never; 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?: { + requestBody: { content: { "application/json": { - /** @description The name of the team. */ - name: string; - /** @description The description of the team. */ - description: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - privacy: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - permission: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - parent_team_id: number | null; + /** @description The array of custom properties to create or update. */ + properties: components["schemas"]["custom-property"][]; }; }; }; responses: { - /** @description Response when the updated information already exists */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-full"]; - }; - }; /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-in-org": { + "orgs/custom-properties-for-repos-get-organization-definition": { parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 Pinned discussions only filter */ - pinned?: string; - }; + query?: never; 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"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; @@ -99417,147 +106343,135 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"][]; + "application/json": components["schemas"]["custom-property"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/create-discussion-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-definition": { parameters: { query?: never; 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"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["custom-property"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/get-discussion-in-org": { + "orgs/custom-properties-for-repos-delete-organization-definition": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/delete-discussion-in-org": { + "orgs/custom-properties-for-repos-get-organization-values": { parameters: { - query?: never; + 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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + repository_query?: string; + }; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/update-discussion-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-values": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; + /** @description The names of repositories that the custom property values will be applied to. */ + repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussion-comments-in-org": { + "orgs/list-public-members": { parameters: { query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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)." */ @@ -99567,10 +106481,6 @@ export interface operations { 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; @@ -99583,87 +106493,74 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion-comment"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - "teams/create-discussion-comment-in-org": { + "orgs/check-public-membership-for-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response */ - 201: { + /** @description Response if user is a public member */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; + content?: never; + }; + /** @description Not Found if user is not a public member */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "teams/get-discussion-comment-in-org": { + "orgs/set-public-membership-for-authenticated-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; + content?: never; }; + 403: components["responses"]["forbidden"]; }; }; - "teams/delete-discussion-comment-in-org": { + "orgs/remove-public-membership-for-authenticated-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -99678,62 +106575,217 @@ export interface operations { }; }; }; - "teams/update-discussion-comment-in-org": { + "repos/list-for-org": { + parameters: { + query?: { + /** @description Specifies the types of repositories you want returned. */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + "repos/create-in-org": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The discussion comment's body text. */ - body: string; + /** @description The name of the repository. */ + name: string; + /** @description A short description of the repository. */ + description?: string; + /** @description A URL with more information about the repository. */ + homepage?: string; + /** + * @description Whether the repository is private. + * @default false + */ + private?: boolean; + /** + * @description The visibility of the repository. + * @enum {string} + */ + visibility?: "public" | "private"; + /** + * @description Either `true` to enable issues for this repository or `false` to disable them. + * @default true + */ + has_issues?: boolean; + /** + * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + * @default true + */ + has_projects?: boolean; + /** + * @description Either `true` to enable the wiki for this repository or `false` to disable it. + * @default true + */ + has_wiki?: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + has_downloads?: boolean; + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ + is_template?: boolean; + /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ + team_id?: number; + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ + auto_init?: boolean; + /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ + gitignore_template?: string; + /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + license_template?: string; + /** + * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + * @default true + */ + allow_squash_merge?: boolean; + /** + * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ + allow_auto_merge?: boolean; + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** + * @default false + */ + 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 is closing down. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default?: boolean; + /** + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; }; }; responses: { /** @description Response */ - 200: { + 201: { headers: { + /** @example https://api.github.com/repos/octocat/Hello-World */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["full-repository"]; }; }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "reactions/list-for-team-discussion-comment-in-org": { + "repos/get-org-rulesets": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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 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: { /** @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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; @@ -99742,110 +106794,147 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/create-for-team-discussion-comment-in-org": { + "repos/create-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; + /** @description Request body */ requestBody: { content: { "application/json": { + /** @description The name of the ruleset. */ + name: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The target of the ruleset + * @default branch * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + target?: "branch" | "tag" | "push" | "repository"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["org-rules"][]; }; }; }; responses: { - /** @description Response when the reaction type has already been added to this team discussion comment */ - 200: { + /** @description Response */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-org-rule-suites": { + parameters: { + query?: { + /** @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?: components["parameters"]["ref-in-query"]; + /** @description The name of the repository to filter on. */ + repository_name?: components["parameters"]["repository-name-in-query"]; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). + */ + time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["rule-suites"]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/delete-for-team-discussion-comment": { + "repos/get-org-rule-suite": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; + /** + * @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. + */ + rule_suite_id: components["parameters"]["rule-suite-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["rule-suite"]; + }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/list-for-team-discussion-in-org": { + "repos/get-org-ruleset": { parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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"]; - }; + query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -99854,37 +106943,45 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"][]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/create-for-team-discussion-in-org": { + "repos/update-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; - requestBody: { + /** @description Request body */ + requestBody?: { content: { "application/json": { + /** @description The name of the ruleset. */ + name?: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The target of the ruleset * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + target?: "branch" | "tag" | "push" | "repository"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["org-rules"][]; }; }; }; @@ -99895,33 +106992,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/delete-for-team-discussion": { + "repos/delete-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -99934,9 +107021,11 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "teams/list-pending-invitations-in-org": { + "orgs/get-org-ruleset-history": { 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)." */ @@ -99948,8 +107037,8 @@ export interface operations { 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"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -99958,31 +107047,81 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["ruleset-version"][]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "teams/list-members-in-org": { + "orgs/get-org-ruleset-version": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "secret-scanning/list-alerts-for-org": { parameters: { query?: { - /** @description Filters members returned by their role in the team. */ - role?: "member" | "maintainer" | "all"; - /** @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 Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ + 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; 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; }; @@ -99995,22 +107134,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["organization-secret-scanning-alert"][]; }; }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - "teams/get-membership-for-user-in-org": { + "secret-scanning/list-org-pattern-configs": { parameters: { query?: never; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; @@ -100022,41 +107159,48 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description if user has no team membership */ - 404: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["secret-scanning-pattern-configuration"]; }; - content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/add-or-update-membership-for-user-in-org": { + "secret-scanning/update-org-pattern-configs": { parameters: { query?: never; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** - * @description The role that this user should have in the team. - * @default member - * @enum {string} - */ - role: "member" | "maintainer"; + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Pattern settings for provider patterns. */ + provider_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "not-set" | "disabled" | "enabled"; + }[]; + /** @description Pattern settings for custom patterns. */ + custom_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + custom_pattern_version?: components["schemas"]["secret-scanning-row-version"]; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "disabled" | "enabled"; + }[]; }; }; }; @@ -100067,71 +107211,64 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Unprocessable Entity if you attempt to add an organization to a team */ - 422: { - headers: { - [name: string]: unknown; + "application/json": { + /** @description The updated pattern configuration version. */ + pattern_config_version?: string; + }; }; - content?: never; }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/remove-membership-for-user-in-org": { + "security-advisories/list-org-repository-advisories": { parameters: { - query?: never; + query?: { + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["repository-advisory"][]; }; - content?: never; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - "teams/list-projects-in-org": { + "orgs/list-security-manager-teams": { 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"]; - }; + query?: never; 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; }; @@ -100140,16 +107277,15 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-project"][]; + "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - "teams/check-permissions-for-project-in-org": { + "orgs/add-security-manager-team": { parameters: { query?: never; header?: never; @@ -100158,24 +107294,13 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { + 204: { headers: { [name: string]: unknown; }; @@ -100183,7 +107308,7 @@ export interface operations { }; }; }; - "teams/add-or-update-project-permissions-in-org": { + "orgs/remove-security-manager-team": { parameters: { query?: never; header?: never; @@ -100192,22 +107317,10 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission: "read" | "write" | "admin"; - } | null; - }; - }; + requestBody?: never; responses: { /** @description Response */ 204: { @@ -100216,35 +107329,55 @@ export interface operations { }; content?: never; }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { + }; + }; + "orgs/get-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Immutable releases settings response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message: string; - documentation_url: string; - }; + "application/json": components["schemas"]["immutable-releases-organization-settings"]; }; }; }; }; - "teams/remove-project-in-org": { + "orgs/set-immutable-releases-settings": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -100255,20 +107388,18 @@ export interface operations { }; }; }; - "teams/list-repos-in-org": { + "orgs/get-immutable-releases-settings-repositories": { 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 The number of results per page (max 100). For 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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; }; cookie?: never; }; @@ -100277,82 +107408,58 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; }; }; - "teams/check-permissions-for-repo-in-org": { + "orgs/set-immutable-releases-settings-repositories": { parameters: { query?: never; 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"]; - /** @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"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Alternative response with repository permissions */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-repository"]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids: number[]; }; }; - /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ + }; + responses: { + /** @description Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description Not Found if team does not have permission for the repository */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; }; }; - "teams/add-or-update-repo-permissions-in-org": { + "orgs/enable-selected-repository-immutable-releases-organization": { parameters: { query?: never; 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"]; - /** @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 unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ - permission: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 204: { @@ -100363,19 +107470,15 @@ export interface operations { }; }; }; - "teams/remove-repo-in-org": { + "orgs/disable-selected-repository-immutable-releases-organization": { parameters: { query?: never; 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"]; - /** @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 unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; @@ -100390,7 +107493,7 @@ export interface operations { }; }; }; - "teams/list-child-in-org": { + "hosted-compute/list-network-configurations-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)." */ @@ -100402,80 +107505,72 @@ export interface operations { 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 if child teams exist */ + /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; }; }; }; }; - "orgs/enable-or-disable-security-product-on-all-org-repos": { + "hosted-compute/create-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The security feature to enable or disable. */ - security_product: components["parameters"]["security-product"]; - /** - * @description The action to take. - * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ - enablement: components["parameters"]["org-security-product-enablement"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; /** - * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @description The hosted compute service to use for the network configuration. * @enum {string} */ - query_suite: "default" | "extended"; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids: string[]; }; }; }; responses: { - /** @description Action started */ - 204: { + /** @description Response */ + 201: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["network-configuration"]; }; - content?: never; }; }; }; - "projects/get-card": { + "hosted-compute/get-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -100484,25 +107579,24 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["network-configuration"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "projects/delete-card": { + "hosted-compute/delete-network-configuration-from-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -100515,47 +107609,32 @@ export interface operations { }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message: string; - documentation_url: string; - errors: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; }; }; - "projects/update-card": { + "hosted-compute/update-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; /** - * @description The project card's note - * @example Update all gems - */ - note: string | null; - /** - * @description Whether or not the card is archived - * @example false + * @description The hosted compute service to use for the network configuration. + * @enum {string} */ - archived: boolean; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids?: string[]; }; }; }; @@ -100566,99 +107645,55 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["network-configuration"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "projects/move-card": { + "hosted-compute/get-network-settings-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. - * @example bottom - */ - position: string; - /** - * @description The unique identifier of the column the card should be moved to - * @example 42 - */ - column_id?: number; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": Record; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message: string; - documentation_url: string; - errors: { - code: string; - message: string; - resource: string; - field: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - /** @description Response */ - 503: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - code: string; - message: string; - documentation_url: string; - errors: { - code: string; - message: string; - }[]; - }; + "application/json": components["schemas"]["network-settings"]; }; }; }; }; - "projects/get-column": { + "copilot/copilot-metrics-for-team": { parameters: { - query?: never; + 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 100 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 100). For 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 unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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; }; @@ -100670,89 +107705,120 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; }; }; - "projects/delete-column": { + "teams/list": { parameters: { - query?: never; + 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 unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["team"][]; + }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - "projects/update-column": { + "teams/create": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; + /** @description List GitHub usernames for organization members who will become team maintainers. */ + maintainers?: string[]; + /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ + repo_names?: string[]; /** - * @description Name of the project column - * @example Remaining tasks + * @description The level of privacy this team should have. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` + * @enum {string} */ - name: string; + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} + */ + permission?: "pull" | "push"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number; }; }; }; responses: { /** @description Response */ - 200: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"]; + "application/json": components["schemas"]["team-full"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "projects/list-cards": { + "teams/get-by-name": { parameters: { - query?: { - /** @description Filters the project cards that are returned by the card's state. */ - archived_state?: "all" | "archived" | "not_archived"; - /** @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"]; - }; + query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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; }; @@ -100761,135 +107827,158 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"][]; + "application/json": components["schemas"]["team-full"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "projects/create-card": { + "teams/delete-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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: { + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 422: components["responses"]["enterprise_team_unsupported"]; + }; + }; + "teams/update-in-org": { + parameters: { + query?: never; + 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?: { content: { "application/json": { + /** @description The name of the team. */ + name?: string; + /** @description The description of the team. */ + description?: string; /** - * @description The project card's note - * @example Update all gems + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * @enum {string} */ - note: string | null; - } | { + privacy?: "secret" | "closed"; /** - * @description The unique identifier of the content associated with the card - * @example 42 + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} */ - content_id: number; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The piece of content associated with the card - * @example PullRequest + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} */ - content_type: string; + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - /** @description Validation failed */ - 422: { + /** @description Response when the updated information already exists */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["team-full"]; }; }; /** @description Response */ - 503: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": { - code: string; - message: string; - documentation_url: string; - errors: { - code: string; - message: string; - }[]; - }; + "application/json": components["schemas"]["team-full"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "projects/move-column": { + "teams/list-pending-invitations-in-org": { parameters: { - query?: never; + 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 unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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: { - content: { - "application/json": { - /** - * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. - * @example last - */ - position: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 201: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": Record; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - "projects/get": { + "teams/list-members-in-org": { parameters: { - query?: never; + query?: { + /** @description Filters members returned by their role in the team. */ + role?: "member" | "maintainer" | "all"; + /** @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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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; }; @@ -100898,62 +107987,60 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["simple-user"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; }; }; - "projects/delete": { + "teams/get-membership-for-user-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Delete Success */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["team-membership"]; + }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { + /** @description if user has no team membership */ + 404: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - message: string; - documentation_url: string; - errors: string[]; - }; - }; + content?: never; }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; }; }; - "projects/update": { + "teams/add-or-update-membership-for-user-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -100961,27 +108048,11 @@ export interface operations { content: { "application/json": { /** - * @description Name of the project - * @example Week One Sprint - */ - name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body: string | null; - /** - * @description State of the project; either 'open' or 'closed' - * @example open - */ - state: string; - /** - * @description The baseline permission that all organization members have on this project + * @description The role that this user should have in the team. + * @default member * @enum {string} */ - organization_permission: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. */ - private: boolean; + role?: "member" | "maintainer"; }; }; }; @@ -100992,40 +108063,60 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["team-membership"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ + /** @description Forbidden if team synchronization is set up */ 403: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - message: string; - documentation_url: string; - errors: string[]; - }; + content?: never; + }; + /** @description Unprocessable Entity if you attempt to add an organization to a team */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - /** @description Not Found if the authenticated user does not have access to the project */ - 404: { + }; + }; + "teams/remove-membership-for-user-in-org": { + parameters: { + query?: never; + 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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden if team synchronization is set up */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "projects/list-collaborators": { + "teams/list-repos-in-org": { parameters: { query?: { - /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; /** @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)." */ @@ -101033,8 +108124,10 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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; }; @@ -101047,69 +108140,78 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/add-collaborator": { + "teams/check-permissions-for-repo-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant the collaborator. - * @default write - * @example write - * @enum {string} - */ - permission: "read" | "write" | "admin"; - } | null; - }; - }; + requestBody?: never; responses: { - /** @description Response */ + /** @description Alternative response with repository permissions */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-repository"]; + }; + }; + /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + /** @description Not Found if team does not have permission for the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/remove-collaborator": { + "teams/add-or-update-repo-permissions-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ + permission?: string; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -101118,44 +108220,36 @@ export interface operations { }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/get-permission-for-user": { + "teams/remove-repo-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/list-columns": { + "teams/list-child-in-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)." */ @@ -101165,63 +108259,73 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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 */ + /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"][]; + "application/json": components["schemas"]["team"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; }; }; - "projects/create-column": { + "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ + security_product: components["parameters"]["security-product"]; + /** + * @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. + */ + enablement: components["parameters"]["org-security-product-enablement"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/json": { /** - * @description Name of the project column - * @example Remaining tasks + * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @enum {string} */ - name: string; + query_suite?: "default" | "extended"; }; }; }; responses: { - /** @description Response */ - 201: { + /** @description Action started */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project-column"]; + content?: never; + }; + /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; }; }; "rate-limit/get": { @@ -101306,12 +108410,13 @@ export interface operations { }; content: { "application/json": { - message: string; - documentation_url: string; + message?: string; + documentation_url?: string; }; }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "repos/update": { @@ -101330,22 +108435,22 @@ export interface operations { content: { "application/json": { /** @description The name of the repository. */ - name: string; + name?: string; /** @description A short description of the repository. */ - description: string; + description?: string; /** @description A URL with more information about the repository. */ - homepage: string; + homepage?: string; /** * @description Either `true` to make the repository private or `false` to make it public. Default: `false`. * **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. * @default false */ - private: boolean; + private?: boolean; /** * @description The visibility of the repository. * @enum {string} */ - visibility: "public" | "private"; + visibility?: "public" | "private"; /** * @description Specify which security and analysis features to enable or disable for the repository. * @@ -101356,91 +108461,132 @@ export interface operations { * * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ - security_and_analysis: { - /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ - advanced_security: { + security_and_analysis?: { + /** + * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. + * For more information, see "[About GitHub Advanced + * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ + advanced_security?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */ + code_security?: { /** @description Can be `enabled` or `disabled`. */ - status: string; + status?: string; }; /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ - secret_scanning: { + secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ - status: string; + status?: string; }; /** @description Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */ - secret_scanning_push_protection: { + secret_scanning_push_protection?: { /** @description Can be `enabled` or `disabled`. */ - status: string; + 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: { + secret_scanning_ai_detection?: { /** @description Can be `enabled` or `disabled`. */ - status: string; + 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: { + secret_scanning_non_provider_patterns?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */ + secret_scanning_delegated_alert_dismissal?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */ + secret_scanning_delegated_bypass?: { /** @description Can be `enabled` or `disabled`. */ - status: string; + status?: string; + }; + /** + * @description Feature options for secret scanning delegated bypass. + * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + */ + secret_scanning_delegated_bypass_options?: { + /** + * @description The bypass reviewers for secret scanning delegated bypass. + * If you omit this field, the existing set of reviewers is unchanged. + */ + 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"; + }[]; }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. * @default true */ - has_issues: boolean; + has_issues?: boolean; /** * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. * @default true */ - has_projects: boolean; + has_projects?: boolean; /** * @description Either `true` to enable the wiki for this repository or `false` to disable it. * @default true */ - has_wiki: boolean; + has_wiki?: boolean; /** * @description Either `true` to make this repo available as a template repository or `false` to prevent it. * @default false */ - is_template: boolean; + is_template?: boolean; /** @description Updates the default branch for this repository. */ - default_branch: string; + default_branch?: string; /** * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. * @default true */ - allow_squash_merge: boolean; + allow_squash_merge?: boolean; /** * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. * @default true */ - allow_merge_commit: boolean; + allow_merge_commit?: boolean; /** * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. * @default true */ - allow_rebase_merge: boolean; + allow_rebase_merge?: boolean; /** * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. * @default false */ - allow_auto_merge: boolean; + allow_auto_merge?: boolean; /** * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. * @default false */ - delete_branch_on_merge: boolean; + delete_branch_on_merge?: boolean; /** * @description Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise. * @default false */ - allow_update_branch: boolean; + 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 is closing down. Please use `squash_merge_commit_title` instead. * @default false */ - use_squash_pr_title_as_default: boolean; + use_squash_pr_title_as_default?: boolean; /** * @description Required when using `squash_merge_commit_message`. * @@ -101450,7 +108596,7 @@ export interface operations { * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - squash_merge_commit_title: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** * @description The default value for a squash merge commit message: * @@ -101459,7 +108605,7 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - squash_merge_commit_message: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** * @description Required when using `merge_commit_message`. * @@ -101469,7 +108615,7 @@ export interface operations { * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @enum {string} */ - merge_commit_title: "PR_TITLE" | "MERGE_MESSAGE"; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** * @description The default value for a merge commit message. * @@ -101478,22 +108624,22 @@ export interface operations { * - `BLANK` - default to a blank commit message. * @enum {string} */ - merge_commit_message: "PR_BODY" | "PR_TITLE" | "BLANK"; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** * @description Whether to archive this repository. `false` will unarchive a previously archived repository. * @default false */ - archived: boolean; + archived?: boolean; /** * @description Either `true` to allow private forks, or `false` to prevent private forks. * @default false */ - allow_forking: boolean; + allow_forking?: boolean; /** * @description Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits. * @default false */ - web_commit_signoff_required: boolean; + web_commit_signoff_required?: boolean; }; }; }; @@ -101629,6 +108775,120 @@ export interface operations { 410: components["responses"]["gone"]; }; }; + "actions/get-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "actions/get-actions-cache-usage": { parameters: { query?: never; @@ -101823,7 +109083,7 @@ export interface operations { * @description Whether to enable debug logging for the re-run. * @default false */ - enable_debug_logging: boolean; + enable_debug_logging?: boolean; } | null; }; }; @@ -102014,6 +109274,7 @@ export interface operations { "application/json": { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -102079,6 +109340,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-allowed-actions-repository": { parameters: { query?: never; @@ -102283,6 +109710,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -102386,6 +109814,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-repo": { @@ -103082,7 +110511,7 @@ export interface operations { * @description Whether to enable debug logging for the re-run. * @default false */ - enable_debug_logging: boolean; + enable_debug_logging?: boolean; } | null; }; }; @@ -103119,7 +110548,7 @@ export interface operations { * @description Whether to enable debug logging for the re-run. * @default false */ - enable_debug_logging: boolean; + enable_debug_logging?: boolean; } | null; }; }; @@ -103454,9 +110883,9 @@ export interface operations { content: { "application/json": { /** @description The name of the variable. */ - name: string; + name?: string; /** @description The value of the variable. */ - value: string; + value?: string; }; }; }; @@ -103575,15 +111004,26 @@ export interface operations { "application/json": { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ ref: string; - /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { [key: string]: unknown; }; + /** @description Whether the response should include the workflow run ID and URLs. */ + return_run_details?: boolean; }; }; }; responses: { - /** @description Response */ + /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["workflow-dispatch-response"]; + }; + }; + /** @description Empty response when `return_run_details` parameter is `false`. */ 204: { headers: { [name: string]: unknown; @@ -103837,11 +111277,11 @@ export interface operations { * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ bundle: { - mediaType: string; - verificationMaterial: { + mediaType?: string; + verificationMaterial?: { [key: string]: unknown; }; - dsseEnvelope: { + dsseEnvelope?: { [key: string]: unknown; }; }; @@ -103857,7 +111297,7 @@ export interface operations { content: { "application/json": { /** @description The ID of the attestation. */ - id: number; + id?: number; }; }; }; @@ -103874,6 +111314,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -103895,22 +111341,23 @@ export interface operations { }; content: { "application/json": { - attestations: { + attestations?: { /** * @description The attestation's Sigstore Bundle. * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - bundle: { - mediaType: string; - verificationMaterial: { + bundle?: { + mediaType?: string; + verificationMaterial?: { [key: string]: unknown; }; - dsseEnvelope: { + dsseEnvelope?: { [key: string]: unknown; }; }; - repository_id: number; - bundle_url: string; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; @@ -104246,33 +111693,33 @@ export interface operations { /** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */ required_pull_request_reviews: { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ - dismissal_restrictions: { + dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users: string[]; + users?: string[]; /** @description The list of team `slug`s with dismissal access */ - teams: string[]; + teams?: string[]; /** @description The list of app `slug`s with dismissal access */ - apps: string[]; + apps?: string[]; }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews: boolean; + dismiss_stale_reviews?: boolean; /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */ - require_code_owner_reviews: boolean; + require_code_owner_reviews?: boolean; /** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`. * @default false */ - require_last_push_approval: boolean; + require_last_push_approval?: boolean; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - bypass_pull_request_allowances: { + bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users: string[]; + users?: string[]; /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams: string[]; + teams?: string[]; /** @description The list of app `slug`s allowed to bypass pull request requirements. */ - apps: string[]; + apps?: string[]; }; } | null; /** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */ @@ -104499,33 +111946,33 @@ export interface operations { content: { "application/json": { /** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */ - dismissal_restrictions: { + dismissal_restrictions?: { /** @description The list of user `login`s with dismissal access */ - users: string[]; + users?: string[]; /** @description The list of team `slug`s with dismissal access */ - teams: string[]; + teams?: string[]; /** @description The list of app `slug`s with dismissal access */ - apps: string[]; + apps?: string[]; }; /** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */ - dismiss_stale_reviews: boolean; + dismiss_stale_reviews?: boolean; /** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */ - require_code_owner_reviews: boolean; + require_code_owner_reviews?: boolean; /** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */ - required_approving_review_count: number; + required_approving_review_count?: number; /** * @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false` * @default false */ - require_last_push_approval: boolean; + require_last_push_approval?: boolean; /** @description Allow specific users, teams, or apps to bypass pull request requirements. */ - bypass_pull_request_allowances: { + bypass_pull_request_allowances?: { /** @description The list of user `login`s allowed to bypass pull request requirements. */ - users: string[]; + users?: string[]; /** @description The list of team `slug`s allowed to bypass pull request requirements. */ - teams: string[]; + teams?: string[]; /** @description The list of app `slug`s allowed to bypass pull request requirements. */ - apps: string[]; + apps?: string[]; }; }; }; @@ -104696,14 +112143,14 @@ export interface operations { content: { "application/json": { /** @description Require branches to be up to date before merging. */ - strict: boolean; + strict?: boolean; /** * @deprecated * @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[]; + contexts?: string[]; /** @description The list of status checks to require in order to merge into this branch. */ - checks: { + checks?: { /** @description The name of the required check */ context: string; /** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */ @@ -105455,7 +112902,7 @@ export interface operations { [key: string]: unknown; }) | ({ /** @enum {unknown} */ - status: "queued" | "in_progress"; + status?: "queued" | "in_progress"; } & { [key: string]: unknown; })); @@ -105518,34 +112965,34 @@ export interface operations { content: { "application/json": { /** @description The name of the check. For example, "code-coverage". */ - name: string; + name?: string; /** @description The URL of the integrator's site that has the full details of the check. */ - details_url: string; + details_url?: string; /** @description A reference for the run on the integrator's system. */ - external_id: string; + external_id?: string; /** * Format: date-time * @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - started_at: string; + started_at?: string; /** * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. * @enum {string} */ - conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; + conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out"; /** * Format: date-time * @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - completed_at: string; + completed_at?: string; /** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */ - output: { + output?: { /** @description **Required**. */ title?: string; /** @description Can contain Markdown. */ @@ -105587,7 +113034,7 @@ export interface operations { }[]; }; /** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */ - actions: { + actions?: { /** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */ label: string; /** @description A short explanation of what this action would do. The maximum size is 40 characters. */ @@ -105602,7 +113049,7 @@ export interface operations { [key: string]: unknown; }) | ({ /** @enum {unknown} */ - status: "queued" | "in_progress"; + status?: "queued" | "in_progress"; } & { [key: string]: unknown; }); @@ -105756,7 +113203,7 @@ export interface operations { content: { "application/json": { /** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. */ - auto_trigger_checks: { + auto_trigger_checks?: { /** @description The `id` of the GitHub App. */ app_id: number; /** @@ -105903,6 +113350,11 @@ export interface operations { state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; header?: never; path: { @@ -105978,10 +113430,12 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; + state?: components["schemas"]["code-scanning-alert-set-state"]; dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - }; + create_request?: components["schemas"]["code-scanning-alert-create-request"]; + assignees?: components["schemas"]["code-scanning-alert-assignees"]; + } | unknown | unknown; }; }; responses: { @@ -105994,6 +113448,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-alert"]; }; }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 503: components["responses"]["service_unavailable"]; @@ -106150,7 +113605,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; + "application/json": components["schemas"]["code-scanning-alert-instance-list"][]; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; @@ -106228,13 +113683,14 @@ export interface operations { }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; - "application/json+sarif": { + "application/sarif+json": { [key: string]: unknown; }; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_analysis"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -106538,6 +113994,7 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; + 422: components["responses"]["code_scanning_invalid_state"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -106763,30 +114220,30 @@ export interface operations { content: { "application/json": { /** @description Git ref (typically a branch name) for this codespace */ - ref: string; + ref?: string; /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - client_ip: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - machine: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - devcontainer_path: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - multi_repo_permissions_opt_out: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - working_directory: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - display_name: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - retention_period_minutes: number; + retention_period_minutes?: number; } | null; }; }; @@ -106924,8 +114381,8 @@ export interface operations { }; content: { "application/json": { - billable_owner: components["schemas"]["simple-user"]; - defaults: { + billable_owner?: components["schemas"]["simple-user"]; + defaults?: { location: string; devcontainer_path: string | null; }; @@ -107076,9 +114533,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */ - encrypted_value: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - key_id: string; + key_id?: string; }; }; }; @@ -107215,7 +114672,7 @@ export interface operations { * @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. * @default push */ - permission: string; + permission?: string; }; }; }; @@ -107242,7 +114699,19 @@ export interface operations { content?: never; }; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; + /** + * @description Response when: + * - validation failed, or the endpoint has been spammed + * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; }; }; "repos/remove-collaborator": { @@ -107984,7 +115453,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -108106,16 +115579,16 @@ export interface operations { /** @description object containing information about the committer. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - email: string; + email?: string; }; /** @description object containing information about the author. */ author?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - email: string; + email?: string; }; }; }; @@ -108212,6 +115685,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -108223,32 +115707,12 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** - * @deprecated - * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. - */ - page?: number; - /** - * @deprecated - * @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?: number; /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; + /** @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: { @@ -108339,7 +115803,7 @@ export interface operations { * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ - state: "dismissed" | "open"; + state?: "dismissed" | "open"; /** * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert. * @enum {string} @@ -108347,7 +115811,13 @@ export interface operations { dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; /** @description An optional comment associated with dismissing the alert. */ dismissed_comment?: string; - }; + /** + * @description Usernames to assign to this Dependabot Alert. + * Pass one or more user logins to _replace_ the set of assignees on this alert. + * Send an empty array (`[]`) to clear all assignees from the alert. + */ + assignees?: string[]; + } | unknown | unknown; }; }; responses: { @@ -108471,9 +115941,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */ - encrypted_value: string; + encrypted_value?: string; /** @description ID of the key you used to encrypt the secret. */ - key_id: string; + key_id?: string; }; }; }; @@ -108728,7 +116198,7 @@ export interface operations { }; content: { "application/json": { - message: string; + message?: string; }; }; }; @@ -108993,8 +116463,8 @@ export interface operations { * @description The number of environments in this repository * @example 5 */ - total_count: number; - environments: components["schemas"]["environment"][]; + total_count?: number; + environments?: components["schemas"]["environment"][]; }; }; }; @@ -109044,18 +116514,18 @@ export interface operations { requestBody?: { content: { "application/json": { - wait_timer: components["schemas"]["wait-timer"]; - prevent_self_review: components["schemas"]["prevent-self-review"]; + wait_timer?: components["schemas"]["wait-timer"]; + prevent_self_review?: components["schemas"]["prevent-self-review"]; /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ - reviewers: { - type: components["schemas"]["deployment-reviewer-type"]; + reviewers?: { + type?: components["schemas"]["deployment-reviewer-type"]; /** * @description The id of the user or team who can review the deployment * @example 4532992 */ - id: number; + id?: number; }[] | null; - deployment_branch_policy: components["schemas"]["deployment-branch-policy-settings"]; + deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; } | null; }; }; @@ -109305,8 +116775,8 @@ export interface operations { * @description The number of enabled custom deployment protection rules for this environment * @example 10 */ - total_count: number; - custom_deployment_protection_rules: components["schemas"]["deployment-protection-rule"][]; + total_count?: number; + custom_deployment_protection_rules?: components["schemas"]["deployment-protection-rule"][]; }; }; }; @@ -109330,7 +116800,7 @@ export interface operations { content: { "application/json": { /** @description The ID of the custom app that will be enabled on the environment. */ - integration_id: number; + integration_id?: number; }; }; }; @@ -109378,8 +116848,8 @@ export interface operations { * @description The total number of custom deployment protection rule integrations available for this environment. * @example 35 */ - total_count: number; - available_custom_deployment_protection_rule_integrations: components["schemas"]["custom-deployment-rule-app"][]; + total_count?: number; + available_custom_deployment_protection_rule_integrations?: components["schemas"]["custom-deployment-rule-app"][]; }; }; }; @@ -109753,9 +117223,9 @@ export interface operations { content: { "application/json": { /** @description The name of the variable. */ - name: string; + name?: string; /** @description The value of the variable. */ - value: string; + value?: string; }; }; }; @@ -109849,11 +117319,11 @@ export interface operations { content: { "application/json": { /** @description Optional parameter to specify the organization name if forking into an organization. */ - organization: string; + organization?: string; /** @description When forking from an existing repository, a new name for the fork. */ - name: string; + name?: string; /** @description When forking from an existing repository, fork with only the default branch. */ - default_branch_only: boolean; + default_branch_only?: boolean; } | null; }; }; @@ -109990,14 +117460,14 @@ export interface operations { /** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */ committer?: { /** @description The name of the author (or committer) of the commit */ - name: string; + name?: string; /** @description The email of the author (or committer) of the commit */ - email: string; + email?: string; /** * Format: date-time * @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - date: string; + date?: string; }; /** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */ signature?: string; @@ -110179,7 +117649,13 @@ export interface operations { content?: never; }; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; "git/update-ref": { @@ -110329,29 +117805,29 @@ export interface operations { /** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */ tree: { /** @description The file referenced in the tree. */ - path: string; + path?: string; /** * @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink. * @enum {string} */ - mode: "100644" | "100755" | "040000" | "160000" | "120000"; + mode?: "100644" | "100755" | "040000" | "160000" | "120000"; /** * @description Either `blob`, `tree`, or `commit`. * @enum {string} */ - type: "blob" | "tree" | "commit"; + type?: "blob" | "tree" | "commit"; /** * @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - sha: string | null; + sha?: string | null; /** * @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. * * **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error. */ - content: string; + content?: string; }[]; /** * @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. @@ -110460,13 +117936,13 @@ export interface operations { content: { "application/json": { /** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */ - name: string; + name?: string; /** @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"]; + 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. @@ -110474,12 +117950,12 @@ export interface operations { * "push" * ] */ - events: string[]; + events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active: boolean; + active?: boolean; } | null; }; }; @@ -110571,23 +118047,23 @@ export interface operations { requestBody: { content: { "application/json": { - config: components["schemas"]["webhook-config"]; + config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ * "push" * ] */ - events: string[]; + events?: string[]; /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events: string[]; + add_events?: string[]; /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events: string[]; + remove_events?: string[]; /** * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. * @default true */ - active: boolean; + active?: boolean; }; }; }; @@ -110649,10 +118125,10 @@ export interface operations { 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"]; + 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"]; }; }; }; @@ -110806,6 +118282,74 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "repos/check-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response if immutable releases are enabled */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["check-immutable-releases"]; + }; + }; + /** @description Not Found if immutable releases are not enabled for the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "repos/enable-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; + }; + }; + "repos/disable-immutable-releases": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; + }; + }; "migrations/get-import-status": { parameters: { query?: never; @@ -110921,20 +118465,20 @@ export interface operations { content: { "application/json": { /** @description The username to provide to the originating repository. */ - vcs_username: string; + vcs_username?: string; /** @description The password to provide to the originating repository. */ - vcs_password: string; + vcs_password?: string; /** * @description The type of version control system you are migrating from. * @example "git" * @enum {string} */ - vcs: "subversion" | "tfvc" | "git" | "mercurial"; + vcs?: "subversion" | "tfvc" | "git" | "mercurial"; /** * @description For a tfvc import, the name of the project that is being imported. * @example "project1" */ - tfvc_project: string; + tfvc_project?: string; } | null; }; }; @@ -110998,9 +118542,9 @@ export interface operations { content: { "application/json": { /** @description The new Git author email. */ - email: string; + email?: string; /** @description The new Git author name. */ - name: string; + name?: string; }; }; }; @@ -111277,7 +118821,7 @@ export interface operations { * @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`. * @enum {string} */ - permissions: "read" | "write" | "maintain" | "triage" | "admin"; + permissions?: "read" | "write" | "maintain" | "triage" | "admin"; }; }; }; @@ -111302,6 +118846,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -111369,13 +118915,18 @@ export interface operations { 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._ */ labels?: (string | { - id: number; - name: string; - description: string | null; - color: string | null; + id?: number; + name?: string; + description?: string | null; + color?: string | null; })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ + * @example Epic + */ + type?: string | null; }; }; }; @@ -111466,7 +119017,99 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "issues/delete-comment": { + "issues/delete-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "issues/update-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The contents of the comment. */ + body: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/pin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unpin-comment": { parameters: { query?: never; header?: never; @@ -111489,41 +119132,11 @@ export interface operations { }; content?: never; }; - }; - }; - "issues/update-comment": { - 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 unique identifier of the comment. */ - comment_id: components["parameters"]["comment-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The contents of the comment. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 503: components["responses"]["service_unavailable"]; }; }; "reactions/list-for-issue-comment": { @@ -111711,7 +119324,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -111746,32 +119363,37 @@ export interface operations { content: { "application/json": { /** @description The title of the issue. */ - title: (string | number) | null; + title?: (string | number) | null; /** @description The contents of the issue. */ - body: string | null; + body?: string | null; /** @description Username to assign to this issue. **This field is closing down.** */ - assignee: string | null; + assignee?: string | null; /** * @description The open or closed state of the issue. * @enum {string} */ - state: "open" | "closed"; + state?: "open" | "closed"; /** * @description The reason for the state change. Ignored unless `state` is changed. * @example not_planned * @enum {string|null} */ - state_reason: "completed" | "not_planned" | "reopened" | null; - milestone: (string | number) | null; + state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null; + milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ - labels: (string | { - id: number; - name: string; - description: string | null; - color: string | null; + labels?: (string | { + id?: number; + name?: string; + description?: string | null; + color?: string | null; })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ - assignees: string[]; + assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + * @example Epic + */ + type?: string | null; }; }; }; @@ -111811,7 +119433,7 @@ export interface operations { content: { "application/json": { /** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */ - assignees: string[]; + assignees?: string[]; }; }; }; @@ -111845,7 +119467,7 @@ export interface operations { content: { "application/json": { /** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */ - assignees: string[]; + assignees?: string[]; }; }; }; @@ -111973,6 +119595,154 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + "issues/list-dependencies-blocked-by": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-blocked-by-dependency": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the issue that blocks the current issue */ + issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/remove-dependency-blocked-by": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + /** @description The id of the blocking issue to remove as a dependency */ + issue_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-dependencies-blocking": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; "issues/list-events": { parameters: { query?: { @@ -112061,9 +119831,9 @@ export interface operations { content: { "application/json": { /** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */ - labels: string[]; + labels?: string[]; } | string[] | { - labels: { + labels?: { name: string; }[]; } | { @@ -112104,15 +119874,11 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ - labels: string[]; + /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ + labels?: string[]; } | string[] | { - labels: { - name: string; - }[]; - } | { name: string; - }[] | string; + }[]; }; }; responses: { @@ -112215,7 +119981,7 @@ export interface operations { * * `spam` * @enum {string} */ - lock_reason: "off-topic" | "too heated" | "resolved" | "spam"; + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; } | null; }; }; @@ -112260,6 +120026,36 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "issues/get-parent": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; "reactions/list-for-issue": { parameters: { query?: { @@ -112461,7 +120257,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -112830,11 +120626,11 @@ export interface operations { content: { "application/json": { /** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */ - new_name: string; + new_name?: string; /** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ - color: string; + color?: string; /** @description A short description of the label. Must be 100 characters or fewer. */ - description: string; + description?: string; }; }; }; @@ -113168,20 +120964,20 @@ export interface operations { content: { "application/json": { /** @description The title of the milestone. */ - title: string; + title?: string; /** * @description The state of the milestone. Either `open` or `closed`. * @default open * @enum {string} */ - state: "open" | "closed"; + state?: "open" | "closed"; /** @description A description of the milestone. */ - description: string; + description?: string; /** * Format: date-time * @description The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - due_on: string; + due_on?: string; }; }; }; @@ -113288,7 +121084,7 @@ export interface operations { * Format: date-time * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. */ - last_read_at: string; + last_read_at?: string; }; }; }; @@ -113300,8 +121096,8 @@ export interface operations { }; content: { "application/json": { - message: string; - url: string; + message?: string; + url?: string; }; }; }; @@ -113356,15 +121152,15 @@ export interface operations { content: { "application/json": { /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site)." */ - cname: string | null; + cname?: string | null; /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced: boolean; + https_enforced?: boolean; /** * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. * @enum {string} */ - build_type: "legacy" | "workflow"; - source: ("gh-pages" | "master" | "master /docs") | { + build_type?: "legacy" | "workflow"; + source?: ("gh-pages" | "master" | "master /docs") | { /** @description The repository branch used to publish your site's source files. */ branch: string; /** @@ -113408,9 +121204,9 @@ export interface operations { * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. * @enum {string} */ - build_type: "legacy" | "workflow"; + build_type?: "legacy" | "workflow"; /** @description The source branch and directory used to publish your Pages site. */ - source: { + source?: { /** @description The repository branch used to publish your site's source files. */ branch: string; /** @@ -113781,84 +121577,7 @@ export interface operations { 422: components["responses"]["bad_request"]; }; }; - "projects/list-for-repo": { - parameters: { - query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; - /** @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 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/create-for-repo": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "repos/get-custom-properties-values": { + "repos/custom-properties-for-repos-get-repository-values": { parameters: { query?: never; header?: never; @@ -113885,7 +121604,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/create-or-update-custom-properties-values": { + "repos/custom-properties-for-repos-create-or-update-repository-values": { parameters: { query?: never; header?: never; @@ -114303,18 +122022,18 @@ export interface operations { content: { "application/json": { /** @description The title of the pull request. */ - title: string; + title?: string; /** @description The contents of the pull request. */ - body: string; + body?: string; /** * @description State of this Pull Request. Either `open` or `closed`. * @enum {string} */ - state: "open" | "closed"; + state?: "open" | "closed"; /** @description The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. */ - base: string; + base?: string; /** @description Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - maintainer_can_modify: boolean; + maintainer_can_modify?: boolean; }; }; }; @@ -114350,28 +122069,28 @@ export interface operations { content: { "application/json": { /** @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; + location?: string; /** * @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"; + geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest"; /** @description IP for location auto-detection when proxying a request */ - client_ip: string; + client_ip?: string; /** @description Machine type to use for this codespace */ - machine: string; + machine?: string; /** @description Path to devcontainer.json config to use for this codespace */ - devcontainer_path: string; + devcontainer_path?: string; /** @description Whether to authorize requested permissions from devcontainer.json */ - multi_repo_permissions_opt_out: boolean; + multi_repo_permissions_opt_out?: boolean; /** @description Working directory for this codespace */ - working_directory: string; + working_directory?: string; /** @description Time in minutes before codespace stops from inactivity */ - idle_timeout_minutes: number; + idle_timeout_minutes?: number; /** @description Display name for this codespace */ - display_name: string; + display_name?: string; /** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */ - retention_period_minutes: number; + retention_period_minutes?: number; } | null; }; }; @@ -114668,16 +122387,16 @@ export interface operations { content: { "application/json": { /** @description Title for the automatic commit message. */ - commit_title: string; + commit_title?: string; /** @description Extra detail to append to automatic commit message. */ - commit_message: string; + commit_message?: string; /** @description SHA that pull request head must match to allow merge. */ - sha: string; + sha?: string; /** * @description The merge method to use. * @enum {string} */ - merge_method: "merge" | "squash" | "rebase"; + merge_method?: "merge" | "squash" | "rebase"; } | null; }; }; @@ -114700,8 +122419,8 @@ export interface operations { }; content: { "application/json": { - message: string; - documentation_url: string; + message?: string; + documentation_url?: string; }; }; }; @@ -114712,8 +122431,8 @@ export interface operations { }; content: { "application/json": { - message: string; - documentation_url: string; + message?: string; + documentation_url?: string; }; }; }; @@ -114766,9 +122485,9 @@ export interface operations { content: { "application/json": { /** @description An array of user `login`s that will be requested. */ - reviewers: string[]; + reviewers?: string[]; /** @description An array of team `slug`s that will be requested. */ - team_reviewers: string[]; + team_reviewers?: string[]; } | unknown | unknown; }; }; @@ -114880,16 +122599,16 @@ export interface operations { content: { "application/json": { /** @description The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. */ - commit_id: string; + commit_id?: string; /** @description **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. */ - body: string; + body?: string; /** * @description The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready. * @enum {string} */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; + event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; /** @description Use the following table to specify the location, destination, and contents of the draft review comment. */ - comments: { + comments?: { /** @description The relative path to the file that necessitates a review comment. */ path: string; /** @description 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. */ @@ -115161,7 +122880,7 @@ export interface operations { content: { "application/json": { /** @description The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref. */ - expected_head_sha: string; + expected_head_sha?: string; } | null; }; }; @@ -115173,8 +122892,8 @@ export interface operations { }; content: { "application/json": { - message: string; - url: string; + message?: string; + url?: string; }; }; }; @@ -115422,11 +123141,11 @@ export interface operations { content: { "application/json": { /** @description The file name of the asset. */ - name: string; + name?: string; /** @description An alternate short description of the asset. Used in place of the filename. */ - label: string; + label?: string; /** @example "uploaded" */ - state: string; + state?: string; }; }; }; @@ -115611,25 +123330,25 @@ export interface operations { content: { "application/json": { /** @description The name of the tag. */ - tag_name: string; + tag_name?: string; /** @description Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch. */ - target_commitish: string; + target_commitish?: string; /** @description The name of the release. */ - name: string; + name?: string; /** @description Text describing the contents of the tag. */ - body: string; + body?: string; /** @description `true` makes the release a draft, and `false` publishes the release. */ - draft: boolean; + draft?: boolean; /** @description `true` to identify the release as a prerelease, `false` to identify the release as a full release. */ - prerelease: boolean; + prerelease?: boolean; /** * @description Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version. * @default true * @enum {string} */ - make_latest: "true" | "false" | "legacy"; + make_latest?: "true" | "false" | "legacy"; /** @description If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository)." */ - discussion_category_name: string; + discussion_category_name?: string; }; }; }; @@ -115954,6 +123673,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -115965,12 +123685,12 @@ export interface operations { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; @@ -116086,18 +123806,18 @@ export interface operations { content: { "application/json": { /** @description The name of the ruleset. */ - name: string; + name?: string; /** * @description The target of the ruleset * @enum {string} */ - target: "branch" | "tag" | "push"; - enforcement: components["schemas"]["repository-rule-enforcement"]; + target?: "branch" | "tag" | "push"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions: components["schemas"]["repository-ruleset-conditions"]; + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["repository-ruleset-conditions"]; /** @description An array of rules within the ruleset. */ - rules: components["schemas"]["repository-rule"][]; + rules?: components["schemas"]["repository-rule"][]; }; }; }; @@ -116112,6 +123832,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -116142,15 +123863,82 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "repos/get-repo-ruleset-history": { + 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 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 ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-repo-ruleset-version": { + 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 ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "secret-scanning/list-alerts-for-repo": { parameters: { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ @@ -116169,6 +123957,8 @@ export interface operations { 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; header?: never; path: { @@ -116202,7 +123992,10 @@ export interface operations { }; "secret-scanning/get-alert": { parameters: { - query?: never; + query?: { + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; + }; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -116253,10 +124046,11 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; + state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; - }; + assignee?: components["schemas"]["secret-scanning-alert-assignee"]; + } | unknown | unknown; }; }; responses: { @@ -116283,7 +124077,7 @@ export interface operations { }; content?: never; }; - /** @description State does not match the resolution or resolution comment */ + /** @description State does not match the resolution or resolution comment, or assignee does not have write access to the repository */ 422: { headers: { [name: string]: unknown; @@ -116953,9 +124747,9 @@ export interface operations { content: { "application/json": { /** @description Determines if notifications should be received from this repository. */ - subscribed: boolean; + subscribed?: boolean; /** @description Determines if all notifications should be blocked from this repository. */ - ignored: boolean; + ignored?: boolean; }; }; }; @@ -117025,94 +124819,6 @@ export interface operations { }; }; }; - "repos/list-tag-protection": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag-protection"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/create-tag-protection": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional glob pattern to match against when enforcing tag protection. */ - pattern: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-tag-protection": { - 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 unique identifier of the tag protection. */ - tag_protection_id: components["parameters"]["tag-protection-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; "repos/download-tarball-archive": { parameters: { query?: never; @@ -117653,6 +125359,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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + advanced_search?: components["parameters"]["issues-advanced-search"]; }; header?: never; path?: never; @@ -117944,447 +125655,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; - "teams/create-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/get-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/delete-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/list-discussion-comments-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - "teams/create-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/get-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/delete-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-comment-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; "teams/list-pending-invitations-legacy": { parameters: { query?: { @@ -118590,7 +125860,7 @@ export interface operations { * @default member * @enum {string} */ - role: "member" | "maintainer"; + role?: "member" | "maintainer"; }; }; }; @@ -118651,140 +125921,6 @@ export interface operations { }; }; }; - "teams/list-projects-legacy": { - 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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "teams/check-permissions-for-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/add-or-update-project-permissions-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission: "read" | "write" | "admin"; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message: string; - documentation_url: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "teams/remove-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "teams/list-repos-legacy": { parameters: { query?: { @@ -118877,7 +126013,7 @@ export interface operations { * @description The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. * @enum {string} */ - permission: "pull" | "push" | "admin"; + permission?: "pull" | "push" | "admin"; }; }; }; @@ -118987,36 +126123,36 @@ export interface operations { * @description The new name of the user. * @example Omar Jahandar */ - name: string; + name?: string; /** * @description The publicly visible email address of the user. * @example omar@example.com */ - email: string; + email?: string; /** * @description The new blog URL of the user. * @example blog.example.com */ - blog: string; + blog?: string; /** * @description The new Twitter username of the user. * @example therealomarj */ - twitter_username: string | null; + twitter_username?: string | null; /** * @description The new company of the user. * @example Acme corporation */ - company: string; + company?: string; /** * @description The new location of the user. * @example Berlin, Germany */ - location: string; + location?: string; /** @description The new hiring availability of the user. */ - hireable: boolean; + hireable?: boolean; /** @description The new short biography of the user. */ - bio: string; + bio?: string; }; }; }; @@ -119585,11 +126721,11 @@ export interface operations { content: { "application/json": { /** @description A valid machine to transition this codespace to. */ - machine: string; + machine?: string; /** @description Display name for this codespace */ - display_name: string; + display_name?: string; /** @description Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in. */ - recent_folders: string[]; + recent_folders?: string[]; }; }; }; @@ -119707,12 +126843,12 @@ export interface operations { content: { "application/json": { /** @description A name for the new repository. */ - name: string; + name?: string; /** * @description Whether the new repository should be private. * @default false */ - private: boolean; + private?: boolean; }; }; }; @@ -121212,45 +128348,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "projects/create-for-authenticated-user": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; "users/list-public-emails-for-authenticated-user": { parameters: { query?: { @@ -121317,6 +128414,7 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { @@ -121999,6 +129097,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "projects/create-draft-item-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; "users/list": { parameters: { query?: { @@ -122027,6 +129163,76 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "projects/create-view-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in a user-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; "users/get-by-username": { parameters: { query?: never; @@ -122051,6 +129257,173 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "users/delete-attestations-bulk": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "users/list-attestations": { parameters: { query?: { @@ -122060,6 +129433,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -122079,10 +129458,23 @@ export interface operations { }; content: { "application/json": { - attestations: { - bundle: components["schemas"]["sigstore-bundle-0"]; - repository_id: number; - bundle_url: string; + attestations?: { + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; }; @@ -122724,12 +130116,14 @@ export interface operations { "projects/list-for-user": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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: { @@ -122747,22 +130141,57 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-events-for-user": { + "projects/get-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-fields-for-user": { 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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -122773,24 +130202,131 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-public-events-for-user": { + "projects/add-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-user": { parameters: { query?: { + /** @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 number of results per page (max 100). For 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 Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -122801,32 +130337,204 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "repos/list-for-user": { + "projects/add-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-user-item": { parameters: { query?: { - /** @description Limit results to repositories of the specified type. */ - type?: "all" | "owner" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-view-items-for-user": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -122839,14 +130547,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "billing/get-github-actions-billing-user": { + "activity/list-received-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -122862,14 +130579,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-github-packages-billing-user": { + "activity/list-received-public-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -122885,14 +130607,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-shared-storage-billing-user": { + "repos/list-for-user": { parameters: { - query?: never; + query?: { + /** @description Limit results to repositories of the specified type. */ + type?: "all" | "owner" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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 handle for the GitHub user account. */ @@ -122905,14 +130638,105 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; + "billing/get-github-billing-premium-request-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "users/list-social-accounts-for-user": { parameters: { query?: { @@ -123069,7 +130893,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": string; + "text/plain": string; }; }; }; diff --git a/packages/openapi-typescript/examples/github-api-root-types.ts b/packages/openapi-typescript/examples/github-api-root-types.ts index 18af3fe0a..07ce6c0b6 100644 --- a/packages/openapi-typescript/examples/github-api-root-types.ts +++ b/packages/openapi-typescript/examples/github-api-root-types.ts @@ -262,7 +262,7 @@ export interface paths { post?: never; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -308,7 +308,7 @@ export interface paths { get?: never; /** * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * @description Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -580,6 +580,38 @@ export interface paths { patch?: never; trace?: never; }; + "/credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Revoke a list of credentials + * @description Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + * + * This endpoint currently accepts the following credential types: + * - Personal access tokens (classic) + * - Fine-grained personal access tokens + * + * Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + * GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + * + * To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + * + * > [!NOTE] + * > Any authenticated requests will return a 403. + */ + post: operations["credentials/revoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/emojis": { parameters: { query?: never; @@ -600,6 +632,66 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an enterprise + * @description Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-enterprise"]; + /** + * Set GitHub Actions cache retention limit for an enterprise + * @description Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an enterprise + * @description Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-enterprise"]; + /** + * Set GitHub Actions cache storage limit for an enterprise + * @description Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; @@ -800,7 +892,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/teams": { parameters: { query?: never; header?: never; @@ -808,16 +900,34 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * List enterprise teams + * @description List all teams in the enterprise for the authenticated user */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["enterprise-teams/list"]; + put?: never; + /** + * Create an enterprise team + * @description To create an enterprise team, the authenticated user must be an owner of the enterprise. + */ + post: operations["enterprise-teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members in an enterprise team + * @description Lists all team members in an enterprise team. + */ + get: operations["enterprise-team-memberships/list"]; put?: never; post?: never; delete?: never; @@ -826,6 +936,192 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk add team members + * @description Add multiple team members to an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk remove team members + * @description Remove multiple team members from an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get enterprise team membership + * @description Returns whether the user is a member of the enterprise team. + */ + get: operations["enterprise-team-memberships/get"]; + /** + * Add team member + * @description Add a team member to an enterprise team. + */ + put: operations["enterprise-team-memberships/add"]; + post?: never; + /** + * Remove team membership + * @description Remove membership of a specific user from a particular team in an enterprise. + */ + delete: operations["enterprise-team-memberships/remove"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignments + * @description Get all organizations assigned to an enterprise team + */ + get: operations["enterprise-team-organizations/get-assignments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add organization assignments + * @description Assign an enterprise team to multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Remove organization assignments + * @description Unassign an enterprise team from multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignment + * @description Check if an enterprise team is assigned to an organization + */ + get: operations["enterprise-team-organizations/get-assignment"]; + /** + * Add an organization assignment + * @description Assign an enterprise team to an organization. + */ + put: operations["enterprise-team-organizations/add"]; + post?: never; + /** + * Delete an organization assignment + * @description Unassign an enterprise team from an organization. + */ + delete: operations["enterprise-team-organizations/delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an enterprise team + * @description Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. + */ + get: operations["enterprise-teams/get"]; + put?: never; + post?: never; + /** + * Delete an enterprise team + * @description To delete an enterprise team, the authenticated user must be an enterprise owner. + * + * If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + */ + delete: operations["enterprise-teams/delete"]; + options?: never; + head?: never; + /** + * Update an enterprise team + * @description To edit a team, the authenticated user must be an enterprise owner. + */ + patch: operations["enterprise-teams/update"]; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -1306,7 +1602,10 @@ export interface paths { }; get?: never; put?: never; - /** Render a Markdown document */ + /** + * Render a Markdown document + * @description Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + */ post: operations["markdown/render"]; delete?: never; options?: never; @@ -1643,6 +1942,213 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an organization + * @description Gets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-organization"]; + /** + * Set GitHub Actions cache retention limit for an organization + * @description Sets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an organization + * @description Gets GitHub Actions cache storage limit for an organization. All repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-organization"]; + /** + * Set GitHub Actions cache storage limit for an organization + * @description Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists the repositories Dependabot can access in an organization + * @description Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + */ + get: operations["dependabot/repository-access-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Updates Dependabot's repository access list for an organization + * @description Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + * + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + * + * **Example request body:** + * ```json + * { + * "repository_ids_to_add": [123, 456], + * "repository_ids_to_remove": [789] + * } + * ``` + */ + patch: operations["dependabot/update-repository-access-for-org"]; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access/default-level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set the default repository access level for Dependabot + * @description Sets the default level of repository access Dependabot will have while performing an update. Available values are: + * - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + * - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + * + * Unauthorized users will not see the existence of this endpoint. + * + * This operation supports both server-to-server and user-to-server access. + */ + put: operations["dependabot/set-repository-access-default-level"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all budgets for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-all-budgets-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a budget by ID for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-budget-org"]; + put?: never; + post?: never; + /** + * Delete a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + */ + delete: operations["billing/delete-budget-org"]; + options?: never; + head?: never; + /** + * Update a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + */ + patch: operations["billing/update-budget-org"]; + trace?: never; + }; + "/organizations/{org}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for an organization + * @description Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/organizations/{org}/settings/billing/usage": { parameters: { query?: never; @@ -1665,6 +2171,31 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-usage-summary-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -1676,7 +2207,7 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * @@ -1790,6 +2321,106 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners/images/custom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List custom images for an organization + * @description List custom images for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a custom image definition for GitHub Actions Hosted Runners + * @description Get a custom image definition for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-for-org"]; + put?: never; + post?: never; + /** + * Delete a custom image from the organization + * @description Delete a custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List image versions of a custom image for an organization + * @description List image versions of a custom image for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-image-versions-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an image version of a custom image for GitHub Actions Hosted Runners + * @description Get an image version of a custom image for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-version-for-org"]; + put?: never; + post?: never; + /** + * Delete an image version of custom image from the organization + * @description Delete an image version of custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-version-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/hosted-runners/images/github-owned": { parameters: { query?: never; @@ -1977,6 +2608,86 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for an organization + * @description Gets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-organization"]; + /** + * Set artifact and log retention settings for an organization + * @description Sets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for an organization + * @description Gets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-organization"]; + /** + * Set fork PR contributor approval permissions for an organization + * @description Sets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for an organization + * @description Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-organization"]; + /** + * Set private repo fork PR workflow settings for an organization + * @description Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/repositories": { parameters: { query?: never; @@ -2062,6 +2773,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/self-hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get self-hosted runners settings for an organization + * @description Gets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-self-hosted-runners-permissions-organization"]; + /** + * Set self-hosted runners settings for an organization + * @description Sets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repositories allowed to use self-hosted runners in an organization + * @description Lists repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/list-selected-repositories-self-hosted-runners-organization"]; + /** + * Set repositories allowed to use self-hosted runners in an organization + * @description Sets repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-selected-repositories-self-hosted-runners-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a repository to the list of repositories allowed to use self-hosted runners in an organization + * @description Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/enable-selected-repository-self-hosted-runners-organization"]; + post?: never; + /** + * Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + * @description Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + delete: operations["actions/disable-selected-repository-self-hosted-runners-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/workflow": { parameters: { query?: never; @@ -2836,6 +3631,230 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/artifacts/metadata/deployment-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an artifact deployment record + * @description Create or update deployment records for an artifact associated + * with an organization. + * This endpoint allows you to record information about a specific + * artifact, such as its name, digest, environments, cluster, and + * deployment. + * The deployment name has to be uniqe within a cluster (i.e a + * combination of logical, physical environment and cluster) as it + * identifies unique deployment. + * Multiple requests for the same combination of logical, physical + * environment, cluster and deployment name will only create one + * record, successive request will update the existing record. + * This allows for a stable tracking of a deployment where the actual + * deployed artifact can change over time. + */ + post: operations["orgs/create-artifact-deployment-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Set cluster deployment records + * @description Set deployment records for a given cluster. + * If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + * 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + * If no existing records match, new records will be created. + */ + post: operations["orgs/set-cluster-deployment-records"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/storage-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create artifact metadata storage record + * @description Create metadata storage records for artifacts associated with an organization. + * This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + * associated with a repository owned by the organization. + */ + post: operations["orgs/create-artifact-storage-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact deployment records + * @description List deployment records for an artifact metadata associated with an organization. + */ + get: operations["orgs/list-artifact-deployment-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact storage records + * @description List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + */ + get: operations["orgs/list-artifact-storage-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["orgs/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["orgs/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["orgs/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestation repositories + * @description List repositories owned by the provided organization that have created at least one attested artifact + * Results will be sorted in ascending order by repository ID + */ + get: operations["orgs/list-attestation-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + */ + delete: operations["orgs/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/attestations/{subject_digest}": { parameters: { query?: never; @@ -2908,6 +3927,81 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/campaigns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List campaigns for an organization + * @description Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/list-org-campaigns"]; + put?: never; + /** + * Create a campaign for an organization + * @description Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + post: operations["campaigns/create-campaign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns/{campaign_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a campaign for an organization + * @description Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/get-campaign-summary"]; + put?: never; + post?: never; + /** + * Delete a campaign for an organization + * @description Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + delete: operations["campaigns/delete-campaign"]; + options?: never; + head?: never; + /** + * Update a campaign + * @description Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + patch: operations["campaigns/update-campaign"]; + trace?: never; + }; "/orgs/{org}/code-scanning/alerts": { parameters: { query?: never; @@ -2945,7 +4039,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-configurations-for-org"]; put?: never; @@ -2977,7 +4071,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-default-configurations"]; put?: never; @@ -3120,7 +4214,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-repositories-for-configuration"]; put?: never; @@ -3395,7 +4489,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ @@ -3502,7 +4596,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot/content_exclusion": { parameters: { query?: never; header?: never; @@ -3510,23 +4604,41 @@ export interface paths { 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. + * Get Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * > [!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. + * Gets information about an organization's Copilot content exclusion path rules. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." * - * 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. + * Organization owners can view details about Copilot content exclusion rules for the organization. * - * 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 `copilot` or `read:org` scopes to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + * > [!CAUTION] + * > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + * > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. */ - get: operations["copilot/copilot-metrics-for-organization"]; - put?: never; + get: operations["copilot/copilot-content-exclusion-for-organization"]; + /** + * Set Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Sets Copilot content exclusion path rules for an organization. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + * + * Organization owners can set Copilot content exclusion rules for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + * + * > [!CAUTION] + * > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + * > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + */ + put: operations["copilot/set-copilot-content-exclusion-for-organization"]; post?: never; delete?: never; options?: never; @@ -3534,7 +4646,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/usage": { + "/orgs/{org}/copilot/metrics": { parameters: { query?: never; header?: never; @@ -3542,23 +4654,22 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for organization members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * 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. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * > [!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. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 100 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. * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + * 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/usage-metrics-for-org"]; + get: operations["copilot/copilot-metrics-for-organization"]; put?: never; post?: never; delete?: never; @@ -4342,6 +5453,69 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/issue-types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + */ + get: operations["orgs/list-issue-types"]; + put?: never; + /** + * Create issue type for an organization + * @description Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-issue-type"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update issue type for an organization + * @description Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/update-issue-type"]; + post?: never; + /** + * Delete issue type for an organization + * @description Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-issue-type"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/issues": { parameters: { query?: never; @@ -4409,6 +5583,9 @@ export interface paths { /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-member"]; options?: never; @@ -4497,7 +5674,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4543,6 +5720,9 @@ export interface paths { * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-membership-for-user"]; options?: never; @@ -5238,10 +6418,7 @@ export interface paths { }; /** * List private registries for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Lists all private registry configurations available at the organization-level without revealing their encrypted + * @description Lists all private registry configurations available at the organization-level without revealing their encrypted * values. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -5250,10 +6427,7 @@ export interface paths { put?: never; /** * Create a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5273,10 +6447,7 @@ export interface paths { }; /** * Get private registries public key for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * @description Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5298,10 +6469,7 @@ export interface paths { }; /** * Get a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * @description Get the configuration of a single private registry defined for an organization, omitting its encrypted value. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5310,10 +6478,7 @@ export interface paths { post?: never; /** * Delete a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Delete a private registry configuration at the organization-level. + * @description Delete a private registry configuration at the organization-level. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5322,17 +6487,14 @@ export interface paths { head?: never; /** * Update a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["private-registries/update-org-private-registry"]; trace?: never; }; - "/orgs/{org}/projects": { + "/orgs/{org}/projectsV2": { parameters: { query?: never; header?: never; @@ -5340,16 +6502,188 @@ export interface paths { cookie?: never; }; /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * List projects for organization + * @description List all projects owned by a specific organization accessible by the authenticated user. */ get: operations["projects/list-for-org"]; put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * Get project for organization + * @description Get a specific organization-owned project. */ - post: operations["projects/create-for-org"]; + get: operations["projects/get-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for organization owned project + * @description Create draft issue item for the specified organization owned project. + */ + post: operations["projects/create-draft-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for organization + * @description List all fields for a specific organization-owned project. + */ + get: operations["projects/list-fields-for-org"]; + put?: never; + /** + * Add a field to an organization-owned project. + * @description Add a field to an organization-owned project. + */ + post: operations["projects/add-field-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for organization + * @description Get a specific field for an organization-owned project. + */ + get: operations["projects/get-field-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization owned project + * @description List all items for a specific organization-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-org"]; + put?: never; + /** + * Add item to organization owned project + * @description Add an issue or pull request item to the specified organization owned project. + */ + post: operations["projects/add-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for an organization owned project + * @description Get a specific item from an organization-owned project. + */ + get: operations["projects/get-org-item"]; + put?: never; + post?: never; + /** + * Delete project item for organization + * @description Delete a specific item from an organization-owned project. + */ + delete: operations["projects/delete-item-for-org"]; + options?: never; + head?: never; + /** + * Update project item for organization + * @description Update a specific item in an organization-owned project. + */ + patch: operations["projects/update-item-for-org"]; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for an organization-owned project + * @description Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization project view + * @description List items in an organization project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-org"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; @@ -5368,7 +6702,7 @@ export interface paths { * @description Gets all custom properties defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-all-custom-properties"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definitions"]; put?: never; post?: never; delete?: never; @@ -5378,11 +6712,15 @@ export interface paths { * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-definitions"]; trace?: never; }; "/orgs/{org}/properties/schema/{custom_property_name}": { @@ -5397,7 +6735,7 @@ export interface paths { * @description Gets a custom property that is defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-custom-property"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definition"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. @@ -5406,7 +6744,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - put: operations["orgs/create-or-update-custom-property"]; + put: operations["orgs/custom-properties-for-repos-create-or-update-organization-definition"]; post?: never; /** * Remove a custom property for an organization @@ -5416,7 +6754,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - delete: operations["orgs/remove-custom-property"]; + delete: operations["orgs/custom-properties-for-repos-delete-organization-definition"]; options?: never; head?: never; patch?: never; @@ -5434,7 +6772,7 @@ export interface paths { * @description Lists organization repositories with all of their custom property values. * Organization members can read these properties. */ - get: operations["orgs/list-custom-properties-values-for-repos"]; + get: operations["orgs/custom-properties-for-repos-get-organization-values"]; put?: never; post?: never; delete?: never; @@ -5453,7 +6791,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-values"]; trace?: never; }; "/orgs/{org}/public_members": { @@ -5632,6 +6970,46 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset history + * @description Get the history of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset version + * @description Get a version of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/secret-scanning/alerts": { parameters: { query?: never; @@ -5656,6 +7034,34 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/secret-scanning/pattern-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization pattern configurations + * @description Lists the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `read:org` scope to use this endpoint. + */ + get: operations["secret-scanning/list-org-pattern-configs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update organization pattern configurations + * @description Updates the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["secret-scanning/update-org-pattern-configs"]; + trace?: never; + }; "/orgs/{org}/security-advisories": { parameters: { query?: never; @@ -5730,7 +7136,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/actions": { + "/orgs/{org}/settings/immutable-releases": { parameters: { query?: never; header?: never; @@ -5738,15 +7144,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get immutable releases settings for an organization + * @description Gets the immutable releases policy for repositories in an organization. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings"]; + /** + * Set immutable releases settings for an organization + * @description Sets the immutable releases policy for repositories in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-actions-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings"]; post?: never; delete?: never; options?: never; @@ -5754,7 +7164,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/packages": { + "/orgs/{org}/settings/immutable-releases/repositories": { parameters: { query?: never; header?: never; @@ -5762,15 +7172,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * List selected repositories for immutable releases enforcement + * @description List all of the repositories that have been selected for immutable releases enforcement in an organization. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings-repositories"]; + /** + * Set selected repositories for immutable releases enforcement + * @description Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-packages-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings-repositories"]; post?: never; delete?: never; options?: never; @@ -5778,25 +7192,29 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/shared-storage": { + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Enable a selected repository for immutable releases in an organization + * @description Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-shared-storage-billing-org"]; - put?: never; + put: operations["orgs/enable-selected-repository-immutable-releases-organization"]; post?: never; - delete?: never; + /** + * Disable a selected repository for immutable releases in an organization + * @description Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/disable-selected-repository-immutable-releases-organization"]; options?: never; head?: never; patch?: never; @@ -5900,7 +7318,7 @@ export interface paths { * > [!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, + * The response contains metrics for up to 100 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. * @@ -5918,42 +7336,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/team/{team_slug}/copilot/usage": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a summary of Copilot usage for a team - * @description > [!NOTE] - * > 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. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - get: operations["copilot/usage-metrics-for-team"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -6019,286 +7401,6 @@ export interface paths { patch: operations["teams/update-in-org"]; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-in-org"]; - put?: never; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-in-org"]; - put?: never; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; - put?: never; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion comment reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-in-org"]; - put?: never; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/invitations": { parameters: { query?: never; @@ -6402,66 +7504,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ - get: operations["teams/list-projects-in-org"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - get: operations["teams/check-permissions-for-project-in-org"]; - /** - * Add or update team project permissions - * @description 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. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - put: operations["teams/add-or-update-project-permissions-in-org"]; - post?: never; - /** - * Remove a project from a team - * @description 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. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - delete: operations["teams/remove-project-in-org"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/repos": { parameters: { query?: never; @@ -6581,227 +7623,6 @@ export interface paths { patch?: never; trace?: never; }; - "/projects/columns/cards/{card_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project card - * @description Gets information about a project card. - */ - get: operations["projects/get-card"]; - put?: never; - post?: never; - /** - * Delete a project card - * @description Deletes a project card - */ - delete: operations["projects/delete-card"]; - options?: never; - head?: never; - /** Update an existing project card */ - patch: operations["projects/update-card"]; - trace?: never; - }; - "/projects/columns/cards/{card_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project card */ - post: operations["projects/move-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project column - * @description Gets information about a project column. - */ - get: operations["projects/get-column"]; - put?: never; - post?: never; - /** - * Delete a project column - * @description Deletes a project column. - */ - delete: operations["projects/delete-column"]; - options?: never; - head?: never; - /** Update an existing project column */ - patch: operations["projects/update-column"]; - trace?: never; - }; - "/projects/columns/{column_id}/cards": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project cards - * @description Lists the project cards in a project. - */ - get: operations["projects/list-cards"]; - put?: never; - /** Create a project card */ - post: operations["projects/create-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project column */ - post: operations["projects/move-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/get"]; - put?: never; - post?: never; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - delete: operations["projects/delete"]; - options?: never; - head?: never; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - patch: operations["projects/update"]; - trace?: never; - }; - "/projects/{project_id}/collaborators": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - get: operations["projects/list-collaborators"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - put: operations["projects/add-collaborator"]; - post?: never; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - delete: operations["projects/remove-collaborator"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}/permission": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - get: operations["projects/get-permission-for-user"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/columns": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project columns - * @description Lists the project columns in a project. - */ - get: operations["projects/list-columns"]; - put?: never; - /** - * Create a project column - * @description Creates a new project column. - */ - post: operations["projects/create-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/rate_limit": { parameters: { query?: never; @@ -6821,6 +7642,7 @@ export interface paths { * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -6849,7 +7671,8 @@ export interface paths { * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * * > [!NOTE] - * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. */ get: operations["repos/get"]; put?: never; @@ -6949,6 +7772,66 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for a repository + * @description Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-repository"]; + /** + * Set GitHub Actions cache retention limit for a repository + * @description Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for a repository + * @description Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-repository"]; + /** + * Set GitHub Actions cache storage limit for a repository + * @description Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/cache/usage": { parameters: { query?: never; @@ -7232,6 +8115,90 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for a repository + * @description Gets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-repository"]; + /** + * Set artifact and log retention settings for a repository + * @description Sets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for a repository + * @description Gets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-repository"]; + /** + * Set fork PR contributor approval permissions for a repository + * @description Sets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for a repository + * @description Gets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-repository"]; + /** + * Set private repo fork PR workflow settings for a repository + * @description Sets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { parameters: { query?: never; @@ -7945,7 +8912,10 @@ export interface paths { }; /** * Get workflow run usage - * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. * @@ -8275,7 +9245,10 @@ export interface paths { }; /** * Get workflow usage - * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -9007,11 +9980,9 @@ export interface paths { put?: never; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; delete?: never; @@ -9128,8 +10099,6 @@ export interface paths { /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; delete?: never; @@ -9236,7 +10205,7 @@ export interface paths { * Commit an autofix for a code scanning alert * @description Commits an autofix for a code scanning alert. * - * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -9865,7 +10834,7 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ put: operations["codespaces/create-or-update-repo-secret"]; post?: never; @@ -9873,7 +10842,7 @@ export interface paths { * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -9891,12 +10860,12 @@ export interface paths { /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. * * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. - * + * The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; @@ -9928,11 +10897,13 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} @@ -9942,6 +10913,8 @@ export interface paths { * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * + * For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + * * **Updating an existing collaborator's permission level** * * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -9959,8 +10932,8 @@ export interface paths { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -9992,13 +10965,15 @@ export interface paths { }; /** * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * @description Checks the repository permission and role of a collaborator. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + * The `role_name` attribute provides the name of the assigned role, including custom roles. The + * `permission` can also be used to determine which base level of access the collaborator has to the repository. + * + * The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. */ get: operations["repos/get-collaborator-permission-level"]; put?: never; @@ -10241,7 +11216,7 @@ export interface paths { }; /** * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ @@ -11121,7 +12096,7 @@ export interface paths { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -11976,6 +12951,35 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Check if immutable releases are enabled for a repository + * @description Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + * enforced by the repository owner. The authenticated user must have admin read access to the repository. + */ + get: operations["repos/check-immutable-releases"]; + /** + * Enable immutable releases + * @description Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + put: operations["repos/enable-immutable-releases"]; + post?: never; + /** + * Disable immutable releases + * @description Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + delete: operations["repos/disable-immutable-releases"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/import": { parameters: { query?: never; @@ -12370,6 +13374,37 @@ export interface paths { patch: operations["issues/update-comment"]; trace?: never; }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Pin an issue comment + * @description You can use the REST API to pin comments on issues. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + put: operations["issues/pin-comment"]; + post?: never; + /** + * Unpin an issue comment + * @description You can use the REST API to unpin comments on issues. + */ + delete: operations["issues/unpin-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { parameters: { query?: never; @@ -12596,6 +13631,105 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocked by + * @description You can use the REST API to list the dependencies an issue is blocked by. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocked-by"]; + put?: never; + /** + * Add a dependency an issue is blocked by + * @description You can use the REST API to add a 'blocked by' relationship to an issue. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-blocked-by-dependency"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove dependency an issue is blocked by + * @description You can use the REST API to remove a dependency that an issue is blocked by. + * + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-dependency-blocked-by"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocking + * @description You can use the REST API to list the dependencies an issue is blocking. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocking"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { parameters: { query?: never; @@ -12635,7 +13769,7 @@ export interface paths { put: operations["issues/set-labels"]; /** * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. + * @description Adds labels to an issue. */ post: operations["issues/add-labels"]; /** @@ -12694,6 +13828,33 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get parent issue + * @description You can use the REST API to get the parent issue of a sub-issue. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/get-parent"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { parameters: { query?: never; @@ -12780,11 +13941,11 @@ export interface paths { * List sub-issues * @description You can use the REST API to list the sub-issues on an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-sub-issues"]; @@ -13358,30 +14519,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/list-for-repo"]; - put?: never; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-repo"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/properties/values": { parameters: { query?: never; @@ -13394,7 +14531,7 @@ export interface paths { * @description Gets all custom property values that are set for a repository. * Users with read access to the repository can use this endpoint. */ - get: operations["repos/get-custom-properties-values"]; + get: operations["repos/custom-properties-for-repos-get-repository-values"]; put?: never; post?: never; delete?: never; @@ -13407,7 +14544,7 @@ export interface paths { * * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ - patch: operations["repos/create-or-update-custom-properties-values"]; + patch: operations["repos/custom-properties-for-repos-create-or-update-repository-values"]; trace?: never; }; "/repos/{owner}/{repo}/pulls": { @@ -14450,6 +15587,46 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset history + * @description Get the history of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset version + * @description Get a version of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/secret-scanning/alerts": { parameters: { query?: never; @@ -14499,6 +15676,8 @@ export interface paths { * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * + * You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + * * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -14565,6 +15744,9 @@ export interface paths { * Get secret scanning scan history for a repository * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * + * > [!NOTE] + * > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-scan-history"]; @@ -14946,66 +16128,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/tags/protection": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Closing down - List tag protection states for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - * - * This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ - get: operations["repos/list-tag-protection"]; - put?: never; - /** - * Closing down - Create a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - * - * This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - post: operations["repos/create-tag-protection"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Closing down - Delete a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - * - * This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - delete: operations["repos/delete-tag-protection"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/tarball/{ref}": { parameters: { query?: never; @@ -15529,250 +16651,6 @@ export interface paths { patch: operations["teams/update-legacy"]; trace?: never; }; - "/teams/{team_id}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-legacy"]; - put?: never; - /** - * Create a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-legacy"]; - put?: never; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; - put?: never; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-legacy"]; - put?: never; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/invitations": { parameters: { query?: never; @@ -15937,70 +16815,6 @@ export interface paths { patch?: never; trace?: never; }; - "/teams/{team_id}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ - get: operations["teams/list-projects-legacy"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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. - */ - get: operations["teams/check-permissions-for-project-legacy"]; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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. - */ - put: operations["teams/add-or-update-project-permissions-legacy"]; - post?: never; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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. - */ - delete: operations["teams/remove-project-legacy"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/repos": { parameters: { query?: never; @@ -16869,7 +17683,7 @@ export interface paths { * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; delete?: never; @@ -17304,26 +18118,6 @@ export interface paths { patch?: never; trace?: never; }; - "/user/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-authenticated-user"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/user/public_emails": { parameters: { query?: never; @@ -17625,6 +18419,26 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{user_id}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for user owned project + * @description Create draft issue item for the specified user owned project. + */ + post: operations["projects/create-draft-item-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -17647,6 +18461,26 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{user_id}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for a user-owned project + * @description Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}": { parameters: { query?: never; @@ -17673,6 +18507,90 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["users/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["users/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["users/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + */ + delete: operations["users/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/attestations/{subject_digest}": { parameters: { query?: never; @@ -18131,7 +19049,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/projects": { + "/users/{username}/projectsV2": { parameters: { query?: never; header?: never; @@ -18139,8 +19057,8 @@ export interface paths { cookie?: never; }; /** - * List user projects - * @description Lists projects for a user. + * List projects for user + * @description List all projects owned by a specific user accessible by the authenticated user. */ get: operations["projects/list-for-user"]; put?: never; @@ -18151,6 +19069,142 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for user + * @description Get a specific user-owned project. + */ + get: operations["projects/get-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for user + * @description List all fields for a specific user-owned project. + */ + get: operations["projects/list-fields-for-user"]; + put?: never; + /** + * Add field to user owned project + * @description Add a field to a specified user owned project. + */ + post: operations["projects/add-field-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for user + * @description Get a specific field for a user-owned project. + */ + get: operations["projects/get-field-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user owned project + * @description List all items for a specific user-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-user"]; + put?: never; + /** + * Add item to user owned project + * @description Add an issue or pull request item to the specified user owned project. + */ + post: operations["projects/add-item-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for a user owned project + * @description Get a specific item from a user-owned project. + */ + get: operations["projects/get-user-item"]; + put?: never; + post?: never; + /** + * Delete project item for user + * @description Delete a specific item from a user-owned project. + */ + delete: operations["projects/delete-item-for-user"]; + options?: never; + head?: never; + /** + * Update project item for user + * @description Update a specific item in a user-owned project. + */ + patch: operations["projects/update-item-for-user"]; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user project view + * @description List items in a user project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/received_events": { parameters: { query?: never; @@ -18216,7 +19270,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/actions": { + "/users/{username}/settings/billing/premium_request/usage": { parameters: { query?: never; header?: never; @@ -18224,14 +19278,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get billing premium request usage report for a user + * @description Gets a report of premium request usage for a user. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-github-actions-billing-user"]; + get: operations["billing/get-github-billing-premium-request-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18240,7 +19292,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/packages": { + "/users/{username}/settings/billing/usage": { parameters: { query?: never; header?: never; @@ -18248,14 +19300,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * Get billing usage report for a user + * @description Gets a report of the total usage for a user. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** This endpoint is only available to users with access to the enhanced billing platform. */ - get: operations["billing/get-github-packages-billing-user"]; + get: operations["billing/get-github-billing-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18264,7 +19314,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/shared-storage": { + "/users/{username}/settings/billing/usage/summary": { parameters: { query?: never; header?: never; @@ -18272,14 +19322,15 @@ export interface paths { cookie?: never; }; /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Get billing usage summary for a user + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Gets a summary report of usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-shared-storage-billing-user"]; + get: operations["billing/get-github-billing-usage-summary-report-user"]; put?: never; post?: never; delete?: never; @@ -18830,7 +19881,7 @@ export interface components { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" @@ -18838,16 +19889,10 @@ export interface components { */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * Format: uri @@ -18882,6 +19927,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -18928,11 +19974,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -19104,6 +20152,16 @@ export interface components { * @enum {string} */ administration?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create and retrieve build artifact metadata records. + * @enum {string} + */ + artifact_metadata?: "read" | "write"; + /** + * @description The level of permission to create and retrieve the access token for repository attestations. + * @enum {string} + */ + attestations?: "read" | "write"; /** * @description The level of permission to grant the access token for checks on code. * @enum {string} @@ -19120,7 +20178,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @description The level of permission to grant the access token to manage Dependabot secrets. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -19129,6 +20187,11 @@ export interface components { * @enum {string} */ deployments?: "read" | "write"; + /** + * @description The level of permission to grant the access token for discussions and related comments and labels. + * @enum {string} + */ + discussions?: "read" | "write"; /** * @description The level of permission to grant the access token for managing repository environments. * @enum {string} @@ -19139,6 +20202,11 @@ export interface components { * @enum {string} */ issues?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the merge queues for a repository. + * @enum {string} + */ + merge_queues?: "read" | "write"; /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. * @enum {string} @@ -19209,6 +20277,11 @@ export interface components { * @enum {string} */ workflows?: "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + * @enum {string} + */ + custom_properties_for_organizations?: "read" | "write"; /** * @description The level of permission to grant the access token for organization teams and members. * @enum {string} @@ -19230,7 +20303,7 @@ export interface components { */ organization_custom_org_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom property management. + * @description The level of permission to grant the access token for repository custom properties management at the organization level. * @enum {string} */ organization_custom_properties?: "read" | "write" | "admin"; @@ -19294,11 +20367,6 @@ export interface components { * @enum {string} */ organization_user_blocking?: "read" | "write"; - /** - * @description The level of permission to grant the access token to manage team discussions and related comments. - * @enum {string} - */ - team_discussions?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the email addresses belonging to a user. * @enum {string} @@ -19334,6 +20402,11 @@ export interface components { * @enum {string} */ starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token for organization custom properties management at the enterprise level. + * @enum {string} + */ + enterprise_custom_properties_for_organizations?: "read" | "write" | "admin"; }; /** * Simple User @@ -19442,6 +20515,8 @@ export interface components { html_url: string; /** @example 1 */ app_id: number; + /** @example Iv1.ab1112223334445c */ + client_id?: string; /** @description The ID of the user or organization this token is being scoped to. */ target_id: number; /** @example Organization */ @@ -19730,6 +20805,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -19848,6 +20935,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; }; /** * Installation Token @@ -20375,6 +21467,28 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Actions cache retention limit for an enterprise + * @description GitHub Actions cache retention policy for an enterprise. + */ + "actions-cache-retention-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an enterprise + * @description GitHub Actions cache storage policy for an enterprise. + */ + "actions-cache-storage-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** @description A code security configuration */ "code-security-configuration": { /** @description The ID of the code security configuration */ @@ -20392,7 +21506,7 @@ export interface components { * @description The enablement status of GitHub Advanced Security * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -20418,6 +21532,16 @@ export interface components { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal + * @enum {string|null} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set" | null; + /** @description Feature options for code scanning */ + code_scanning_options?: { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** * @description The enablement status of code scanning default setup * @enum {string} @@ -20433,6 +21557,11 @@ export interface components { /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ runner_label?: string | null; } | null; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -20459,6 +21588,8 @@ export interface components { * @enum {string} */ reviewer_type: "TEAM" | "ROLE"; + /** @description The ID of the security configuration associated with this bypass reviewer */ + security_configuration_id?: number; }[]; }; /** @@ -20471,6 +21602,21 @@ export interface components { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -20496,6 +21642,11 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** @description Security Configuration feature options for code scanning */ + "code-scanning-options": { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** @description Feature options for code scanning default setup */ "code-scanning-default-setup-options": { /** @@ -20893,6 +22044,36 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ "alert-auto-dismissed-at": string | null; + /** + * Dependabot alert dismissal request + * @description Information about an active dismissal request for this Dependabot alert. + */ + "dependabot-alert-dismissal-request-simple": { + /** @description The unique identifier of the dismissal request. */ + id?: number; + /** + * @description The current status of the dismissal request. + * @enum {string} + */ + status?: "pending" | "approved" | "rejected" | "cancelled"; + /** @description The user who requested the dismissal. */ + requester?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The login name of the user. */ + login?: string; + }; + /** + * Format: date-time + * @description The date and time when the dismissal request was created. + */ + created_at?: string; + /** + * Format: uri + * @description The API URL to get more information about this dismissal request. + */ + url?: string; + } | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20911,6 +22092,14 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -20929,81 +22118,86 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "nullable-alert-updated-at": string | null; - /** - * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. - * @enum {string} - */ - "secret-scanning-alert-state": "open" | "resolved"; - /** - * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. - * @enum {string|null} + * Enterprise Team + * @description Group of enterprise owners and/or members */ - "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["nullable-alert-updated-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + description?: string; + slug: string; + /** Format: uri */ + url: string; /** - * Format: uri - * @description The REST API URL of the code locations for this alert. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example disabled | all */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + sync_to_organizations?: string; + /** @example disabled | selected | all */ + organization_selection_type?: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id: string | null; /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example Justice League */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + group_name?: string | null; /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league */ - secret_type_display_name?: string; - /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed?: boolean | null; - push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * Format: uri + * @example https://api.github.com/orgs/github */ - push_protection_bypassed_at?: string | null; - push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ - push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ - push_protection_bypass_request_comment?: string | null; + url: string; /** * Format: uri - * @description The URL to a push protection bypass request. + * @example https://api.github.com/orgs/github/repos */ - push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ - resolution_comment?: string | null; + repos_url: string; /** - * @description The token status as of the latest validity check. - * @enum {string} + * Format: uri + * @example https://api.github.com/orgs/github/events */ - 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; + 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; }; /** * Actor @@ -21019,6 +22213,193 @@ export interface components { /** Format: uri */ avatar_url: string; }; + /** + * Label + * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + /** + * Format: int64 + * @description Unique identifier for the label. + * @example 208045946 + */ + id: number; + /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ + node_id: string; + /** + * Format: uri + * @description URL for the label + * @example https://api.github.com/repositories/42/labels/bug + */ + url: string; + /** + * @description The name of the label. + * @example bug + */ + name: string; + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ + description: string | null; + /** + * @description 6-character hex code, without the leading #, identifying the color + * @example FFFFFF + */ + color: string; + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ + default: boolean; + }; + /** + * Discussion + * @description A Discussion in a repository. + */ + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** Reactions */ + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + /** + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} + */ + state: "open" | "closed" | "locked" | "converting" | "transferring"; + /** + * @description The reason for the current state + * @example resolved + * @enum {string|null} + */ + state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + labels?: components["schemas"]["label"][]; + }; /** * Milestone * @description A collection of related issues and pull requests. @@ -21088,6 +22469,37 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -21152,7 +22564,7 @@ export interface components { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" @@ -21160,16 +22572,10 @@ export interface components { */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * author_association @@ -21198,6 +22604,111 @@ export interface components { completed: number; percent_completed: number; }; + /** + * Pinned Issue Comment + * @description Context around who pinned an issue comment and when it was pinned. + */ + "nullable-pinned-issue-comment": { + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + pinned_at: string; + pinned_by: components["schemas"]["nullable-simple-user"]; + } | null; + /** + * Issue Comment + * @description Comments provide a way for people to collaborate on an issue. + */ + "nullable-issue-comment": { + /** + * Format: int64 + * @description Unique identifier of the issue comment + * @example 42 + */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the issue comment + * @example https://api.github.com/repositories/42/issues/comments/1 + */ + url: string; + /** + * @description Contents of the issue comment + * @example What version of Safari were you using when you observed this bug? + */ + body?: string; + body_text?: string; + body_html?: string; + /** Format: uri */ + html_url: string; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + updated_at: string; + /** Format: uri */ + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + } | null; + /** Issue Dependencies Summary */ + "issue-dependencies-summary": { + blocked_by: number; + blocking: number; + total_blocked_by: number; + total_blocking: number; + }; + /** + * Issue Field Value + * @description A value assigned to an issue field + */ + "issue-field-value": { + /** + * Format: int64 + * @description Unique identifier for the issue field. + * @example 1 + */ + issue_field_id: number; + /** @example IFT_GDKND */ + node_id: string; + /** + * @description The data type of the issue field + * @example text + * @enum {string} + */ + data_type: "text" | "single_select" | "number" | "date"; + /** @description The value of the issue field */ + value: (string | number) | null; + /** @description Details about the selected option (only present for single_select fields) */ + single_select_option?: { + /** + * Format: int64 + * @description Unique identifier for the option. + * @example 1 + */ + id: number; + /** + * @description The name of the option + * @example High + */ + name: string; + /** + * @description The color of the option + * @example red + */ + color: string; + } | null; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -21236,7 +22747,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -21296,11 +22807,20 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; }; /** * Issue Comment @@ -21342,9 +22862,132 @@ export interface components { updated_at: string; /** Format: uri */ issue_url: string; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + }; + /** Pull Request Minimal */ + "pull-request-minimal": { + /** Format: int64 */ + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + }; + /** + * Release Asset + * @description Data related to a release. + */ + "release-asset": { + /** Format: uri */ + url: string; + /** Format: uri */ + browser_download_url: string; + id: number; + node_id: string; + /** + * @description The file name of the asset. + * @example Team Environment + */ + name: string; + label: string | null; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded" | "open"; + content_type: string; + size: number; + digest: string | null; + download_count: number; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + uploader: components["schemas"]["nullable-simple-user"]; + }; + /** + * Release + * @description A release. + */ + release: { + /** Format: uri */ + url: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + assets_url: string; + upload_url: string; + /** Format: uri */ + tarball_url: string | null; + /** Format: uri */ + zipball_url: string | null; + id: number; + node_id: string; + /** + * @description The name of the tag. + * @example v1.0.0 + */ + tag_name: string; + /** + * @description Specifies the commitish value that determines where the Git tag is created from. + * @example master + */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ + draft: boolean; + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ + prerelease: boolean; + /** + * @description Whether or not the release is immutable. + * @example false + */ + immutable?: boolean; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + published_at: string | null; + /** Format: date-time */ + updated_at?: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + mentions_count?: number; + /** + * Format: uri + * @description The URL of the release discussion. + */ + discussion_url?: string; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Event @@ -21361,19 +23004,7 @@ export interface components { url: string; }; org?: components["schemas"]["actor"]; - payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; - pages?: { - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - }[]; - }; + payload: components["schemas"]["create-event"] | components["schemas"]["delete-event"] | components["schemas"]["discussion-event"] | components["schemas"]["issues-event"] | components["schemas"]["issue-comment-event"] | components["schemas"]["fork-event"] | components["schemas"]["gollum-event"] | components["schemas"]["member-event"] | components["schemas"]["public-event"] | components["schemas"]["push-event"] | components["schemas"]["pull-request-event"] | components["schemas"]["pull-request-review-comment-event"] | components["schemas"]["pull-request-review-event"] | components["schemas"]["commit-comment-event"] | components["schemas"]["release-event"] | components["schemas"]["watch-event"]; public: boolean; /** Format: date-time */ created_at: string | null; @@ -22044,10 +23675,19 @@ export interface components { }; }; "security-and-analysis": { + /** + * @description Enable or disable GitHub Advanced Security for the repository. + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ advanced_security?: { /** @enum {string} */ status?: "enabled" | "disabled"; }; + code_security?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; /** @description Enable or disable Dependabot security updates for the repository. */ dependabot_security_updates?: { /** @@ -22072,6 +23712,26 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_delegated_alert_dismissal?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_delegated_bypass?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + 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"; + }[]; + }; } | null; /** * Minimal Repository @@ -22237,6 +23897,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -22273,7 +23939,7 @@ export interface components { key?: string; name?: string; spdx_id?: string; - url?: string; + url?: string | null; node_id?: string; } | null; /** @example 0 */ @@ -22286,6 +23952,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Thread @@ -22339,43 +24009,432 @@ export interface components { repository_url?: string; }; /** - * Organization Simple - * @description A GitHub organization. + * Actions cache retention limit for an organization + * @description GitHub Actions cache retention policy for an organization. */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ + "actions-cache-retention-limit-for-organization": { + /** + * @description For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an organization + * @description GitHub Actions cache storage policy for an organization. + */ + "actions-cache-storage-limit-for-organization": { + /** + * @description For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; + /** + * Simple Repository + * @description A GitHub repository. + */ + "nullable-simple-repository": { + /** + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 + */ id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ url: string; + /** + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + */ + archive_url: string; + /** + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} + */ + assignees_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + */ + blobs_url: string; + /** + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} + */ + branches_url: string; + /** + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + */ + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - repos_url: string; + contributors_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments + */ + deployments_url: string; + /** + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads + */ + downloads_url: string; + /** + * Format: uri + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ + /** + * Format: uri + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks + */ + forks_url: string; + /** + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + */ + git_commits_url: string; + /** + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + */ + git_refs_url: string; + /** + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + */ + git_tags_url: string; + /** + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + */ + issue_comment_url: string; + /** + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + */ + issue_events_url: string; + /** + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} + */ 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; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; + } | null; + /** + * Dependabot Repository Access Details + * @description Information about repositories that Dependabot is able to access in an organization + */ + "dependabot-repository-access-details": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string|null} + */ + default_level?: "public" | "internal" | null; + accessible_repositories?: components["schemas"]["nullable-simple-repository"][]; + }; + budget: { + /** + * @description The unique identifier for the budget + * @example 2066deda-923f-43f9-88d2-62395a28c0cdd + */ + id: string; + /** + * @description The type of pricing for the budget + * @example SkuPricing + * @enum {string} + */ + budget_type: "SkuPricing" | "ProductPricing"; + /** @description The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description The type of limit enforcement for the budget + * @example true + */ + prevent_further_usage: boolean; + /** + * @description The scope of the budget (enterprise, organization, repository, cost center) + * @example enterprise + */ + budget_scope: string; + /** + * @description The name of the entity for the budget (enterprise does not require a name). + * @example octocat/hello-world + */ + budget_entity_name?: string; + /** @description A single product or sku to apply the budget to. */ + budget_product_sku: string; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients: string[]; + }; + }; + get_all_budgets: { + /** @description Array of budget objects for the enterprise */ + budgets: components["schemas"]["budget"][]; + /** @description Indicates if there are more pages of results available (maps to hasNextPage from billing platform) */ + has_next_page?: boolean; + /** @description Total number of budgets matching the query */ + total_count?: number; + }; + "get-budget": { + /** @description ID of the budget. */ + id: string; + /** + * @description The type of scope for the budget + * @example enterprise + * @enum {string} + */ + budget_scope: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @example octocat/hello-world + */ + budget_entity_name: string; + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description Whether to prevent additional spending once the budget is exceeded + * @example true + */ + prevent_further_usage: boolean; + /** + * @description A single product or sku to apply the budget to. + * @example actions_linux + */ + budget_product_sku: string; + /** + * @description The type of pricing for the budget + * @example ProductPricing + * @enum {string} + */ + budget_type: "ProductPricing" | "SkuPricing"; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert?: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients?: string[]; + }; + }; + "delete-budget": { + /** @description A message indicating the result of the deletion operation */ + message: string; + /** @description The ID of the deleted budget */ + id: string; + }; + "billing-premium-request-usage-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the user for the usage report. */ + user?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; "billing-usage-report": { usageItems?: { @@ -22403,6 +24462,46 @@ export interface components { repositoryName?: string; }[]; }; + "billing-usage-summary-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22508,6 +24607,11 @@ export interface components { seats?: number; }; default_repository_permission?: string | null; + /** + * @description The default branch for repositories created in this organization. + * @example main + */ + default_repository_branch?: string | null; /** @example true */ members_can_create_repositories?: boolean | null; /** @example true */ @@ -22526,6 +24630,22 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; + /** @example true */ + members_can_delete_repositories?: boolean; + /** @example true */ + members_can_change_repo_visibility?: boolean; + /** @example true */ + members_can_invite_outside_collaborators?: boolean; + /** @example true */ + members_can_delete_issues?: boolean; + /** @example true */ + display_commenter_full_name_setting_enabled?: boolean; + /** @example true */ + readers_can_create_discussions?: boolean; + /** @example true */ + members_can_create_teams?: boolean; + /** @example true */ + members_can_view_dependency_insights?: boolean; /** @example false */ members_can_fork_private_repositories?: boolean | null; /** @example false */ @@ -22671,7 +24791,7 @@ export interface components { * @description The image version of the hosted runner pool. * @example latest */ - version: string; + version?: string; } | null; /** * Github-owned VM details. @@ -22772,12 +24892,91 @@ export interface components { * @example 2022-10-09T23:39:01Z */ last_active_on?: string | null; + /** @description Whether custom image generation is enabled for the hosted runners. */ + image_gen?: boolean; + }; + /** + * GitHub-hosted runner custom image details + * @description Provides details of a custom runner image + */ + "actions-hosted-runner-custom-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example 1 + */ + id: number; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Total size of all the image versions in GB. + * @example 200 + */ + total_versions_size: number; + /** + * @description Display name for this image. + * @example CustomImage + */ + name: string; + /** + * @description The image provider. + * @example custom + */ + source: string; + /** + * @description The number of image versions associated with the image. + * @example 4 + */ + versions_count: number; + /** + * @description The latest image version associated with the image. + * @example 1.3.0 + */ + latest_version: string; + /** + * @description The number of image versions associated with the image. + * @example Ready + */ + state: string; + }; + /** + * GitHub-hosted runner custom image version details. + * @description Provides details of a hosted runner custom image version + */ + "actions-hosted-runner-custom-image-version": { + /** + * @description The version of image. + * @example 1.0.0 + */ + version: string; + /** + * @description The state of image version. + * @example Ready + */ + state: string; + /** + * @description Image version size in GB. + * @example 30 + */ + size_gb: number; + /** + * @description The creation date time of the image version. + * @example 2024-11-09T23:39:01Z + */ + created_on: string; + /** + * @description The image version status details. + * @example None + */ + state_details: string; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - "actions-hosted-runner-image": { + "actions-hosted-runner-curated-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 @@ -22847,12 +25046,52 @@ export interface components { "allowed-actions": "all" | "local_only" | "selected"; /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */ "selected-actions-url": string; + /** @description Whether actions must be pinned to a full-length commit SHA. */ + "sha-pinning-required": boolean; "actions-organization-permissions": { enabled_repositories: components["schemas"]["enabled-repositories"]; /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ selected_repositories_url?: string; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + "actions-artifact-and-log-retention-response": { + /** @description The number of days artifacts and logs are retained */ + days: number; + /** @description The maximum number of days that can be configured */ + maximum_allowed_days: number; + }; + "actions-artifact-and-log-retention": { + /** @description The number of days to retain artifacts and logs */ + days: number; + }; + "actions-fork-pr-contributor-approval": { + /** + * @description The policy that controls when fork PR workflows require approval from a maintainer. + * @enum {string} + */ + approval_policy: "first_time_contributors_new_to_github" | "first_time_contributors" | "all_external_contributors"; + }; + "actions-fork-pr-workflows-private-repos": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows: boolean; + }; + "actions-fork-pr-workflows-private-repos-request": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows?: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables?: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows?: boolean; }; "selected-actions": { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ @@ -22867,6 +25106,15 @@ export interface components { */ patterns_allowed?: string[]; }; + "self-hosted-runners-settings": { + /** + * @description The policy that controls whether self-hosted runners can be used by repositories in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + /** @description The URL to the endpoint for managing selected repositories for self-hosted runners in the organization */ + selected_repositories_url?: string; + }; /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows. * @enum {string} @@ -22930,12 +25178,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -22956,6 +25204,7 @@ export interface components { status: string; busy: boolean; labels: components["schemas"]["runner-label"][]; + ephemeral?: boolean; }; /** * Runner Application @@ -23090,101 +25339,314 @@ export interface components { */ selected_repositories_url?: string; }; - /** @description The name of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - "code-scanning-analysis-tool-guid": string | null; /** - * @description State of a code scanning alert. - * @enum {string} + * Artifact Deployment Record + * @description Artifact Metadata Deployment Record */ - "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; + "artifact-deployment-record": { + id?: number; + digest?: string; + logical_environment?: string; + physical_environment?: string; + cluster?: string; + deployment_name?: string; + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + created_at?: string; + updated_at?: string; + /** @description The ID of the provenance attestation associated with the deployment record. */ + attestation_id?: number | null; + }; /** - * @description Severity of a code scanning alert. + * Campaign state + * @description Indicates whether a campaign is open or closed * @enum {string} */ - "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; - /** - * Format: uri - * @description The REST API URL for fetching the list of instances for an alert. - */ - "alert-instances-url": string; + "campaign-state": "open" | "closed"; /** - * @description State of a code scanning alert. - * @enum {string|null} + * Campaign alert type + * @description Indicates the alert type of a campaign + * @enum {string} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; + "campaign-alert-type": "code_scanning" | "secret_scanning"; /** - * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. - * @enum {string|null} + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. */ - "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ - "code-scanning-alert-dismissed-comment": string | null; - "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; - /** @description The name of the rule used to detect the alert. */ - name?: string; + "nullable-team-simple": { /** - * @description The severity of the alert. - * @enum {string|null} + * @description Unique identifier of the team + * @example 1 */ - severity?: "none" | "note" | "warning" | "error" | null; + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; /** - * @description The security severity of the alert. - * @enum {string|null} + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - security_severity_level?: "low" | "medium" | "high" | "critical" | null; - /** @description A short description of the rule used to detect the alert. */ - description?: string; - /** @description A description of the rule used to detect the alert. */ - full_description?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - }; - /** @description The version of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-version": string | null; - "code-scanning-analysis-tool": { - name?: components["schemas"]["code-scanning-analysis-tool-name"]; - version?: components["schemas"]["code-scanning-analysis-tool-version"]; - guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ - "code-scanning-ref": string; - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - "code-scanning-analysis-analysis-key": string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - "code-scanning-alert-environment": string; - /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - "code-scanning-analysis-category": string; - /** @description Describe a region within a file for the alert. */ - "code-scanning-alert-location": { - path?: string; - start_line?: number; - end_line?: number; - start_column?: number; - end_column?: number; - }; - /** - * @description A classification of the file. For example to identify it as generated. - * @enum {string|null} - */ - "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; - "code-scanning-alert-instance": { - ref?: components["schemas"]["code-scanning-ref"]; - analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment?: components["schemas"]["code-scanning-alert-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; - state?: components["schemas"]["code-scanning-alert-state"]; - commit_sha?: string; + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Campaign summary + * @description The campaign metadata and alert stats. + */ + "campaign-summary": { + /** @description The number of the newly created campaign */ + number: number; + /** + * Format: date-time + * @description The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** @description The campaign name */ + name?: string; + /** @description The campaign description */ + description: string; + /** @description The campaign managers */ + managers: components["schemas"]["simple-user"][]; + /** @description The campaign team managers */ + team_managers?: components["schemas"]["team"][]; + /** + * Format: date-time + * @description The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + published_at?: string; + /** + * Format: date-time + * @description The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at: string; + /** + * Format: date-time + * @description The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + */ + closed_at?: string | null; + state: components["schemas"]["campaign-state"]; + /** + * Format: uri + * @description The contact link of the campaign. + */ + contact_link: string | null; + alert_stats?: { + /** @description The number of open alerts */ + open_count: number; + /** @description The number of closed alerts */ + closed_count: number; + /** @description The number of in-progress alerts */ + in_progress_count: number; + }; + }; + /** @description The name of the tool used to generate the code scanning analysis. */ + "code-scanning-analysis-tool-name": string; + /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + "code-scanning-analysis-tool-guid": string | null; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; + /** + * @description Severity of a code scanning alert. + * @enum {string} + */ + "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; + /** + * Format: uri + * @description The REST API URL for fetching the list of instances for an alert. + */ + "alert-instances-url": string; + /** + * @description State of a code scanning alert. + * @enum {string|null} + */ + "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} + */ + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; + /** @description The dismissal comment associated with the dismissal of the alert. */ + "code-scanning-alert-dismissed-comment": string | null; + "code-scanning-alert-rule-summary": { + /** @description A unique identifier for the rule used to detect the alert. */ + id?: string | null; + /** @description The name of the rule used to detect the alert. */ + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity?: "none" | "note" | "warning" | "error" | null; + /** + * @description The security severity of the alert. + * @enum {string|null} + */ + security_severity_level?: "low" | "medium" | "high" | "critical" | null; + /** @description A short description of the rule used to detect the alert. */ + description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + }; + /** @description The version of the tool used to generate the code scanning analysis. */ + "code-scanning-analysis-tool-version": string | null; + "code-scanning-analysis-tool": { + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + version?: components["schemas"]["code-scanning-analysis-tool-version"]; + guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; + }; + /** + * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. + */ + "code-scanning-ref": string; + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + "code-scanning-analysis-analysis-key": string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + "code-scanning-alert-environment": string; + /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ + "code-scanning-analysis-category": string; + /** @description Describe a region within a file for the alert. */ + "code-scanning-alert-location": { + path?: string; + start_line?: number; + end_line?: number; + start_column?: number; + end_column?: number; + }; + /** + * @description A classification of the file. For example to identify it as generated. + * @enum {string|null} + */ + "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; + "code-scanning-alert-instance": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-state"]; + commit_sha?: string; message?: { text?: string; }; @@ -23213,6 +25675,8 @@ export interface components { tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * Codespace machine @@ -23470,17 +25934,17 @@ export interface components { created_at?: string; }; /** - * Copilot Business Seat Breakdown + * Copilot Seat Breakdown * @description The breakdown of Copilot Business seats for the organization. */ - "copilot-seat-breakdown": { + "copilot-organization-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ total?: number; /** @description Seats added during the current billing cycle. */ added_this_cycle?: number; /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ pending_cancellation?: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ + /** @description The number of users who have been invited to receive a Copilot seat through this organization. */ pending_invitation?: number; /** @description The number of seats that have used Copilot during the current billing cycle. */ active_this_cycle?: number; @@ -23492,24 +25956,24 @@ export interface components { * @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"]; + seat_breakdown: components["schemas"]["copilot-organization-seat-breakdown"]; /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @description The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). * @enum {string} */ - public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + public_code_suggestions: "allow" | "block" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @description The organization policy for allowing or disallowing Copilot Chat in the IDE. * @enum {string} */ ide_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @description The organization policy for allowing or disallowing Copilot features on GitHub.com. * @enum {string} */ platform_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @description The organization policy for allowing or disallowing Copilot CLI. * @enum {string} */ cli?: "enabled" | "disabled" | "unconfigured"; @@ -23522,7 +25986,7 @@ export interface components { * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ - plan_type?: "business" | "enterprise" | "unknown"; + plan_type?: "business" | "enterprise"; } & { [key: string]: unknown; }; @@ -23565,135 +26029,12 @@ export interface components { /** @example A great organization */ description: string | null; } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; - /** @example Justice League */ - group_name?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league - */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; + assignee?: components["schemas"]["nullable-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; @@ -23709,6 +26050,11 @@ export interface components { last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + */ + last_authenticated_at?: string | null; /** * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. @@ -23726,6 +26072,13 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; + /** + * Copilot Organization Content Exclusion Details + * @description List all Copilot Content Exclusion rules for an organization. + */ + "copilot-organization-content-exclusion-details": { + [key: string]: string[]; + }; /** @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. */ @@ -23785,7 +26138,7 @@ export interface components { total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ models?: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -23804,13 +26157,13 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** @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 model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -23836,7 +26189,7 @@ export interface components { total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ models?: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -23872,52 +26225,6 @@ export interface components { } & { [key: string]: unknown; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { - /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; - }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -24123,6 +26430,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -24159,7 +26472,7 @@ export interface components { key?: string; name?: string; spdx_id?: string; - url?: string; + url?: string | null; node_id?: string; } | null; /** @example 0 */ @@ -24172,6 +26485,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; } | null; /** * Package @@ -24406,6 +26723,32 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; /** * Org Membership * @description Org Membership @@ -24428,6 +26771,20 @@ export interface components { * @enum {string} */ role: "admin" | "member" | "billing_manager"; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; /** * Format: uri * @example https://api.github.com/orgs/octocat @@ -24560,6 +26917,21 @@ export interface components { /** Format: uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Team Simple @@ -24623,6 +26995,21 @@ export interface components { * @example uid=example,ou=users,dc=github,dc=com */ ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * A Role Assignment for a User @@ -24855,12 +27242,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string | null; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. * @enum {string} @@ -24885,12 +27282,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} @@ -24904,69 +27311,568 @@ export interface components { updated_at: string; }; /** - * Project - * @description Projects are a way to organize columns and cards of work. + * Projects v2 Status Update + * @description An status update belonging to a project */ - project: { + "nullable-projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test + * Format: date-time + * @description The time when the status update was created. + * @example 2022-04-28T12:00:00Z */ - owner_url: string; + created_at: string; + /** + * Format: date-time + * @description The time when the status update was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @description The start date of the period covered by the update. + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @description The target date associated with the update. + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + } | null; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + /** @description The unique identifier of the project. */ + id: number; + /** @description The node ID of the project. */ + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + /** @description The project title. */ + title: string; + /** @description A short description of the project. */ + description: string | null; + /** @description Whether the project is visible to anyone with access to the owner. */ + public: boolean; + /** + * Format: date-time + * @description The time when the project was closed. + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @description The time when the project was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the project was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @description The project number. */ + number: number; + /** @description A concise summary of the project. */ + short_description: string | null; + /** + * Format: date-time + * @description The time when the project was deleted. + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: components["schemas"]["nullable-simple-user"]; + /** + * @description The current state of the project. + * @enum {string} + */ + state?: "open" | "closed"; + latest_status_update?: components["schemas"]["nullable-projects-v2-status-update"]; + /** @description Whether this project is a template */ + is_template?: boolean; + }; + /** + * Link + * @description Hypermedia Link + */ + link: { + href: string; + }; + /** + * Auto merge + * @description The status of auto merging a pull request. + */ + "auto-merge": { + enabled_by: components["schemas"]["simple-user"]; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + /** @description Title for the merge commit message. */ + commit_title: string; + /** @description Commit message for the merge commit. */ + commit_message: string; + } | null; + /** + * Pull Request Simple + * @description Pull Request Simple + */ + "pull-request-simple": { /** * Format: uri - * @example https://api.github.com/projects/1002604 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + node_id: string; /** * Format: uri - * @example https://github.com/api-playground/projects-test/projects/12 + * @example https://github.com/octocat/Hello-World/pull/1347 */ html_url: string; /** * Format: uri - * @example https://api.github.com/projects/1002604/columns + * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - columns_url: string; - /** @example 1002604 */ + diff_url: string; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World/pull/1347.patch + */ + patch_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + */ + commits_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + */ + review_comments_url: string; + /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ + review_comment_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + */ + comments_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + statuses_url: string; + /** @example 1347 */ + number: number; + /** @example open */ + state: string; + /** @example true */ + locked: boolean; + /** @example new-feature */ + title: string; + user: components["schemas"]["nullable-simple-user"]; + /** @example Please pull these awesome changes */ + body: string | null; + labels: { + /** Format: int64 */ + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: components["schemas"]["nullable-milestone"]; + /** @example too heated */ + active_lock_reason?: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + updated_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + merged_at: string | null; + /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ + draft?: boolean; + }; + /** + * Draft Issue + * @description A draft issue in a project + */ + "projects-v2-draft-issue": { + /** @description The ID of the draft issue */ id: number; - /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ + /** @description The node ID of the draft issue */ node_id: string; + /** @description The title of the draft issue */ + title: string; + /** @description The body content of the draft issue */ + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time the draft issue was created + */ + created_at: string; + /** + * Format: date-time + * @description The time the draft issue was last updated + */ + updated_at: string; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-simple": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The content represented by the item. */ + content?: components["schemas"]["issue"] | components["schemas"]["pull-request-simple"] | components["schemas"]["projects-v2-draft-issue"]; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; /** - * @description Name of the project - * @example Week One Sprint + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The URL of the project this item belongs to. + */ + project_url?: string; + /** + * Format: uri + * @description The URL of the item in the project. + */ + item_url?: string; + }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-options": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option, in raw text and HTML formats. */ + name: { + raw: string; + html: string; + }; + /** @description The description of the option, in raw text and HTML formats. */ + description: { + raw: string; + html: string; + }; + /** @description The color associated with the option. */ + color: string; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-settings": { + /** @description The unique identifier of the iteration setting. */ + id: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date: string; + /** @description The duration of the iteration in days. */ + duration: number; + /** @description The iteration title, in raw text and HTML formats. */ + title: { + raw: string; + html: string; + }; + /** @description Whether the iteration has been completed. */ + completed: boolean; + }; + /** + * Projects v2 Field + * @description A field inside a projects v2 project + */ + "projects-v2-field": { + /** @description The unique identifier of the field. */ + id: number; + /** @description The node ID of the field. */ + node_id?: string; + /** + * @description The API URL of the project that contains the field. + * @example https://api.github.com/projects/1 + */ + project_url: string; + /** @description The name of the field. */ name: string; /** - * @description Body of the project - * @example This project represents the sprint of the first week in January + * @description The field's data type. + * @enum {string} */ - body: string | null; - /** @example 1 */ - number: number; + data_type: "assignees" | "linked_pull_requests" | "reviewers" | "labels" | "milestone" | "repository" | "title" | "text" | "single_select" | "number" | "date" | "iteration" | "issue_type" | "parent_issue" | "sub_issues_progress"; + /** @description The options available for single select fields. */ + options?: components["schemas"]["projects-v2-single-select-options"][]; + /** @description Configuration for iteration fields. */ + configuration?: { + /** @description The day of the week when the iteration starts. */ + start_day?: number; + /** @description The duration of the iteration in days. */ + duration?: number; + iterations?: components["schemas"]["projects-v2-iteration-settings"][]; + }; /** - * @description State of the project; either 'open' or 'closed' - * @example open + * Format: date-time + * @description The time when the field was created. + * @example 2022-04-28T12:00:00Z */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + created_at: string; /** * Format: date-time - * @example 2011-04-10T20:09:31Z + * @description The time when the field was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + }; + "projects-v2-field-single-select-option": { + /** @description The display name of the option. */ + name?: string; + /** + * @description The color associated with the option. + * @enum {string} + */ + color?: "BLUE" | "GRAY" | "GREEN" | "ORANGE" | "PINK" | "PURPLE" | "RED" | "YELLOW"; + /** @description The description of the option. */ + description?: string; + }; + /** @description The configuration for iteration fields. */ + "projects-v2-field-iteration-configuration": { + /** + * Format: date + * @description The start date of the first iteration. + */ + start_date?: string; + /** @description The default duration for iterations in days. Individual iterations can override this value. */ + duration?: number; + /** @description Zero or more iterations for the field. */ + iterations?: { + /** @description The title of the iteration. */ + title?: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date?: string; + /** @description The duration of the iteration in days. */ + duration?: number; + }[]; + }; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-with-content": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** + * Format: uri + * @description The API URL of the project that contains this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/3 + */ + project_url?: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + /** @description The content of the item, which varies by content type. */ + content?: { + [key: string]: unknown; + } | null; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time - * @example 2014-03-03T18:58:10Z + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z */ updated_at: string; /** - * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The API URL of this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/items/3 + */ + item_url?: string | null; + /** @description The fields and values associated with this item. */ + fields?: { + [key: string]: unknown; + }[]; + }; + /** + * Projects v2 View + * @description A view inside a projects v2 project + */ + "projects-v2-view": { + /** @description The unique identifier of the view. */ + id: number; + /** @description The number of the view within the project. */ + number: number; + /** @description The name of the view. */ + name: string; + /** + * @description The layout of the view. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; + layout: "table" | "board" | "roadmap"; + /** @description The node ID of the view. */ + node_id: string; + /** + * @description The API URL of the project that contains the view. + * @example https://api.github.com/orgs/octocat/projectsV2/1 + */ + project_url: string; + /** + * Format: uri + * @description The web URL of the view. + * @example https://github.com/orgs/octocat/projects/1/views/1 + */ + html_url: string; + creator: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the view was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the view was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The filter query for the view. + * @example is:issue is:open + */ + filter?: string | null; + /** @description The list of field IDs that are visible in the view. */ + visible_fields: number[]; + /** @description The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". */ + sort_by: (number | string)[][]; + /** @description The list of field IDs used for horizontal grouping. */ + group_by: number[]; + /** @description The list of field IDs used for vertical grouping (board layout). */ + vertical_group_by: number[]; }; /** * Organization Custom Property @@ -24991,7 +27897,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -25009,6 +27915,8 @@ export interface components { * @enum {string|null} */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Set Payload @@ -25020,7 +27928,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -25032,6 +27940,14 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Value @@ -25295,6 +28211,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -25413,6 +28341,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; } | null; /** * Code Of Conduct Simple @@ -25635,6 +28568,14 @@ export interface components { has_downloads?: boolean; /** @example true */ has_discussions: boolean; + /** @example true */ + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -25757,7 +28698,7 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** @description The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -25765,11 +28706,11 @@ 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. Also, `pull_request` is only applicable to branch rulesets. + * @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. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode: "always" | "pull_request" | "exempt"; }; /** * Repository ruleset conditions for ref names @@ -25928,17 +28869,29 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * Reviewer + * @description A required reviewing team + */ + "repository-rule-params-reviewer": { + /** @description ID of the reviewer which must review changes to matching files. */ + id: number; + /** + * @description The type of the reviewer + * @enum {string} + */ + type: "Team"; + }; /** * 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. */ + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. */ 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; + reviewer: components["schemas"]["repository-rule-params-reviewer"]; }; /** * pull_request @@ -25948,8 +28901,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { - /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ - allowed_merge_methods?: string[]; + /** @description Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. */ + allowed_merge_methods?: ("merge" | "squash" | "rebase")[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25960,6 +28913,13 @@ export interface components { required_approving_review_count: number; /** @description All conversations on code must be resolved before a pull request can be merged. */ required_review_thread_resolution: boolean; + /** + * @description > [!NOTE] + * > `required_reviewers` is in beta and subject to change. + * + * A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + */ + required_reviewers?: components["schemas"]["repository-rule-params-required-reviewer-configuration"][]; }; }; /** @@ -26004,7 +28964,7 @@ export interface components { /** @enum {string} */ type: "commit_message_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26025,7 +28985,7 @@ export interface components { /** @enum {string} */ type: "commit_author_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26046,7 +29006,7 @@ export interface components { /** @enum {string} */ type: "committer_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26067,7 +29027,7 @@ export interface components { /** @enum {string} */ type: "branch_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26088,7 +29048,7 @@ export interface components { /** @enum {string} */ type: "tag_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26101,6 +29061,54 @@ export interface components { pattern: string; }; }; + /** + * file_path_restriction + * @description Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + */ + "repository-rule-file-path-restriction": { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + }; + /** + * max_file_path_length + * @description Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + */ + "repository-rule-max-file-path-length": { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths. */ + max_file_path_length: number; + }; + }; + /** + * file_extension_restriction + * @description Prevent commits that include files with specified file extensions from being pushed to the commit graph. + */ + "repository-rule-file-extension-restriction": { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + }; + /** + * max_file_size + * @description Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + */ + "repository-rule-max-file-size": { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + }; /** * RestrictedCommits * @description Restricted commit @@ -26170,38 +29178,35 @@ export interface components { }; }; /** - * Repository Rule - * @description A repository rule. + * copilot_code_review + * @description Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { - /** @enum {string} */ - type: "file_path_restriction"; - parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - restricted_file_paths: string[]; - }; - } | { + "repository-rule-copilot-code-review": { /** @enum {string} */ - type: "max_file_path_length"; + type: "copilot_code_review"; parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - max_file_path_length: number; + /** @description Copilot automatically reviews draft pull requests before they are marked as ready for review. */ + review_draft_pull_requests?: boolean; + /** @description Copilot automatically reviews each new push to the pull request. */ + review_on_push?: boolean; }; - } | { - /** @enum {string} */ - type: "file_extension_restriction"; - parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - restricted_file_extensions: string[]; - }; - } | { - /** @enum {string} */ - type: "max_file_size"; - parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - max_file_size: number; - }; - } | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"]; + }; + /** + * CopilotCodeReviewAnalysisTool + * @description A tool that must provide code review results for this rule to pass. + */ + "repository-rule-params-copilot-code-review-analysis-tool": { + /** + * @description The name of a code review analysis tool + * @enum {string} + */ + name: "CodeQL" | "ESLint" | "PMD"; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -26231,7 +29236,7 @@ export interface components { * querying the repository-level endpoint. * @enum {string} */ - current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + current_user_can_bypass?: "always" | "pull_requests_only" | "never" | "exempt"; node_id?: string; _links?: { self?: { @@ -26250,6 +29255,11 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** + * Repository Rule + * @description A repository rule. + */ + "org-rules": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Rule Suites * @description Response @@ -26287,6 +29297,44 @@ export interface components { */ evaluation_result?: "pass" | "fail" | "bypass"; }[]; + /** + * Pull request rule suite metadata + * @description Metadata for a pull request rule evaluation result. + */ + "rule-suite-pull-request": { + /** @description The pull request associated with the rule evaluation. */ + pull_request?: { + /** @description The unique identifier of the pull request. */ + id?: number; + /** @description The number of the pull request. */ + number?: number; + /** @description The user who created the pull request. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The reviews associated with the pull request. */ + reviews?: { + /** @description The unique identifier of the review. */ + id?: number; + /** @description The user who submitted the review. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The state of the review. */ + state?: string; + }[]; + }; + }; /** * Rule Suite * @description Response @@ -26298,9 +29346,9 @@ export interface components { actor_id?: number | null; /** @description The handle for the GitHub user account. */ actor_name?: string | null; - /** @description The first commit sha before the push evaluation. */ + /** @description The previous commit SHA of the ref. */ before_sha?: string; - /** @description The last commit sha in the push evaluation. */ + /** @description The new commit SHA of the ref. */ after_sha?: string; /** @description The ref name that the evaluation ran on. */ ref?: string; @@ -26349,6 +29397,320 @@ export interface components { details?: string | null; }[]; }; + /** + * Ruleset version + * @description The historical version of a ruleset + */ + "ruleset-version": { + /** @description The ID of the previous version of the ruleset */ + version_id: number; + /** @description The actor who updated the ruleset */ + actor: { + id?: number; + type?: string; + }; + /** Format: date-time */ + updated_at: string; + }; + "ruleset-version-with-state": components["schemas"]["ruleset-version"] & { + /** @description The state of the ruleset version */ + state: Record; + }; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "nullable-alert-updated-at": string | null; + /** + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + * @enum {string} + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; + /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ + "secret-scanning-location-commit": { + /** + * @description The file path in the repository + * @example /example/secrets.txt + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** @description The API URL to get the associated blob resource */ + blob_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + commit_sha: string; + /** @description The API URL to get the associated commit resource */ + commit_url: string; + }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; + /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ + "secret-scanning-location-issue-title": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_title_url: string; + }; + /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ + "secret-scanning-location-issue-body": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_body_url: string; + }; + /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ + "secret-scanning-location-issue-comment": { + /** + * Format: uri + * @description The API URL to get the issue comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + issue_comment_url: string; + }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; + /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */ + "nullable-secret-scanning-first-detected-location": (components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]) | null; + "organization-secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; + /** @description The secret that was detected. */ + secret?: string; + repository?: components["schemas"]["simple-repository"]; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description The comment that was optionally added when this alert was closed */ + resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @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; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */ + "secret-scanning-row-version": string | null; + "secret-scanning-pattern-override": { + /** @description The ID of the pattern. */ + token_type?: string; + /** @description The version of this pattern if it's a custom pattern. */ + custom_pattern_version?: string | null; + /** @description The slug of the pattern. */ + slug?: string; + /** @description The user-friendly name for the pattern. */ + display_name?: string; + /** @description The total number of alerts generated by this pattern. */ + alert_total?: number; + /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */ + alert_total_percentage?: number; + /** @description The number of false positive alerts generated by this pattern. */ + false_positives?: number; + /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */ + false_positive_rate?: number; + /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */ + bypass_rate?: number; + /** + * @description The default push protection setting for this pattern. + * @enum {string} + */ + default_setting?: "disabled" | "enabled"; + /** + * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + * @enum {string|null} + */ + enterprise_setting?: "not-set" | "disabled" | "enabled" | null; + /** + * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + * @enum {string} + */ + setting?: "not-set" | "disabled" | "enabled"; + }; + /** + * Secret scanning pattern configuration + * @description A collection of secret scanning patterns and their settings related to push protection. + */ + "secret-scanning-pattern-configuration": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Overrides for partner patterns. */ + provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + /** @description Overrides for custom patterns defined by the organization. */ + custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ @@ -26475,61 +29837,19 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; - "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; - minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - total?: number; - }; - }; - "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; + /** + * Check immutable releases organization settings + * @description Check immutable releases settings for an organization. + */ + "immutable-releases-organization-settings": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */ + selected_repositories_url?: string; }; /** * Hosted compute network configuration @@ -26556,6 +29876,16 @@ export interface components { * @example 123ABC456DEF789 */ network_settings_ids?: string[]; + /** + * @description The unique identifier of each failover network settings in the configuration. + * @example 123ABC456DEF789 + */ + failover_network_settings_ids?: string[]; + /** + * @description Indicates whether the failover network resource is enabled. + * @example true + */ + failover_network_enabled?: boolean; /** * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. @@ -26726,6 +30056,11 @@ export interface components { /** Format: date-time */ archived_at: string | null; }; + /** + * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com + */ + "ldap-dn": string; /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. @@ -26798,163 +30133,22 @@ export interface components { */ updated_at: string; organization: components["schemas"]["team-organization"]; + ldap_dn?: components["schemas"]["ldap-dn"]; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** @example 0 */ - comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; - /** - * @description The unique sequence number of a team discussion. - * @example 42 - */ - number: number; - /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true - */ - pinned: boolean; - /** - * @description Whether or not this discussion should be restricted to team members and organization owners. - * @example true - */ - private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Team Discussion Comment - * @description A reply to a discussion within a team. - */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - body: string; - /** @example

Do you like apples?

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @description The ownership type of the team + * @enum {string} */ - discussion_url: string; + type: "enterprise" | "organization"; /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @description Unique identifier of the organization to which this team belongs + * @example 37 */ - html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + organization_id?: number; /** - * @description The unique sequence number of a team discussion comment. + * @description Unique identifier of the enterprise to which this team belongs * @example 42 */ - number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - reaction: { - /** @example 1 */ - id: number; - /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z - */ - created_at: string; + enterprise_id?: number; }; /** * Team Membership @@ -26976,34 +30170,6 @@ export interface components { */ state: "active" | "pending"; }; - /** - * Team Project - * @description A team's access to a project. - */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; - permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; /** * Team Repository * @description A team's access to a repository. @@ -27309,111 +30475,6 @@ export interface components { watchers: number; master_branch?: string; }; - /** - * Project Card - * @description Project cards represent a scope of work. - */ - "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - url: string; - /** - * Format: int64 - * @description The project card's ID - * @example 42 - */ - id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; - /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @example 2016-09-05T14:21:06Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:20:22Z - */ - updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - column_name?: string; - project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - }; - /** - * Project Column - * @description Project columns contain cards of work. - */ - "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - updated_at: string; - }; - /** - * Project Collaborator Permission - * @description Project Collaborator Permission - */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - }; /** Rate Limit */ "rate-limit": { limit: number; @@ -27437,6 +30498,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + dependency_sbom?: components["schemas"]["rate-limit"]; code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; @@ -27472,6 +30534,11 @@ export interface components { expires_at: string | null; /** Format: date-time */ updated_at: string | null; + /** + * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + */ + digest?: string | null; workflow_run?: { /** @example 10 */ id?: number; @@ -27485,6 +30552,28 @@ export interface components { head_sha?: string; } | null; }; + /** + * Actions cache retention limit for a repository + * @description GitHub Actions cache retention policy for a repository. + */ + "actions-cache-retention-limit-for-repository": { + /** + * @description The maximum number of days to keep caches in this repository. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for a repository + * @description GitHub Actions cache storage policy for a repository. + */ + "actions-cache-storage-limit-for-repository": { + /** + * @description The maximum total cache size for this repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** * Repository actions caches * @description Repository actions caches @@ -27718,6 +30807,7 @@ export interface components { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; "actions-workflow-access-to-repository": { /** @@ -27738,33 +30828,6 @@ export interface components { sha: string; ref?: string; }; - /** Pull Request Minimal */ - "pull-request-minimal": { - /** Format: int64 */ - id: number; - number: number; - url: string; - head: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - base: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - }; /** * Simple Commit * @description A commit. @@ -28215,6 +31278,26 @@ export interface components { */ deleted_at?: string; }; + /** + * Workflow Run ID + * Format: int64 + * @description The ID of the workflow run. + */ + "workflow-run-id": number; + /** + * Workflow Dispatch Response + * @description Response containing the workflow run ID and URLs. + */ + "workflow-dispatch-response": { + workflow_run_id: components["schemas"]["workflow-run-id"]; + /** + * Format: uri + * @description The URL to the workflow run. + */ + run_url: string; + /** Format: uri */ + html_url: string; + }; /** * Workflow Usage * @description Workflow Usage @@ -28292,6 +31375,8 @@ export interface components { * @example true */ is_alphanumeric: boolean; + /** Format: date-time */ + updated_at?: string | null; }; /** * Check Dependabot security updates @@ -28418,21 +31503,7 @@ export interface components { site_admin?: boolean; user_view_type?: string; }[]; - teams: { - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - notification_setting?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - }[]; + teams: components["schemas"]["team"][]; apps: { id?: number; slug?: string; @@ -28566,7 +31637,10 @@ export interface components { name?: string; /** @example "chris@ozmm.org" */ email?: string; - /** @example "2007-10-29T02:42:39.000-07:00" */ + /** + * Format: date-time + * @example "2007-10-29T02:42:39.000-07:00" + */ date?: string; } | null; /** Verification */ @@ -28575,7 +31649,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** * Diff Entry @@ -28583,7 +31657,7 @@ export interface components { */ "diff-entry": { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string | null; /** @example file1.txt */ filename: string; /** @@ -29100,6 +32174,8 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule-summary"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; "code-scanning-alert-rule": { /** @description A unique identifier for the rule used to detect the alert. */ @@ -29143,12 +32219,18 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** @description If `true`, attempt to create an alert dismissal request. */ + "code-scanning-alert-create-request": boolean; + /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */ + "code-scanning-alert-assignees": string[]; /** * @description The status of an autofix. * @enum {string} @@ -29179,6 +32261,29 @@ export interface components { /** @description SHA of commit with autofix. */ sha?: string; }; + /** + * @description State of a code scanning alert instance. + * @enum {string|null} + */ + "code-scanning-alert-instance-state": "open" | "fixed" | null; + "code-scanning-alert-instance-list": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-instance-state"]; + commit_sha?: string; + message?: { + text?: string; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -29277,7 +32382,7 @@ export interface components { * @description The language targeted by the CodeQL query * @enum {string} */ - "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift"; + "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift"; /** * Repository Identifier * @description Repository Identifier @@ -29424,6 +32529,11 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** * Format: date-time * @description Timestamp of latest configuration update. @@ -29458,6 +32568,11 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** @description CodeQL languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; @@ -29857,180 +32972,38 @@ export interface components { reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Branch Short - * @description Branch Short - */ - "branch-short": { - name: string; - commit: { - sha: string; - url: string; - }; - protected: boolean; - }; - /** - * Link - * @description Hypermedia Link - */ - link: { - href: string; - }; - /** - * Auto merge - * @description The status of auto merging a pull request. - */ - "auto-merge": { - enabled_by: components["schemas"]["simple-user"]; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - /** @description Title for the merge commit message. */ - commit_title: string; - /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; - /** - * Pull Request Simple - * @description Pull Request Simple + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - "pull-request-simple": { - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 - */ - url: string; - /** - * Format: int64 - * @example 1 - */ + reaction: { + /** @example 1 */ id: number; - /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + /** @example MDg6UmVhY3Rpb24x */ node_id: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347 - */ - html_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.diff - */ - diff_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.patch - */ - patch_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - */ - commits_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - */ - review_comments_url: string; - /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - */ - comments_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - */ - statuses_url: string; - /** @example 1347 */ - number: number; - /** @example open */ - state: string; - /** @example true */ - locked: boolean; - /** @example new-feature */ - title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ - body: string | null; - labels: { - /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ - active_lock_reason?: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - created_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - updated_at: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * @description The reaction to use + * @example heart + * @enum {string} */ - closed_at: string | null; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** * Format: date-time - * @example 2011-01-26T19:01:12Z + * @example 2016-05-20T20:09:31Z */ - merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; - head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; - base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; + created_at: string; + }; + /** + * Branch Short + * @description Branch Short + */ + "branch-short": { + name: string; + commit: { sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; - _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; + url: string; }; - author_association: components["schemas"]["author-association"]; - auto_merge: components["schemas"]["auto-merge"]; - /** - * @description Indicates whether or not the pull request is a draft. - * @example false - */ - draft?: boolean; + protected: boolean; }; /** Simple Commit Status */ "simple-commit-status": { @@ -30226,6 +33199,7 @@ export interface components { self: string; }; }[]; + encoding?: string; _links: { /** Format: uri */ git: string | null; @@ -30491,6 +33465,14 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -30509,6 +33491,9 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; }; /** * Dependabot Secret @@ -31172,7 +34157,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -31242,7 +34227,7 @@ export interface components { "git-tree": { sha: string; /** Format: uri */ - url: string; + url?: string; truncated: boolean; /** * @description Objects specifying a tree structure @@ -31253,47 +34238,19 @@ export interface components { * "type": "blob", * "size": 30, * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" - * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" - * ] + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" * } * ] */ tree: { /** @example test/file.rb */ - path?: string; + path: string; /** @example 040000 */ - mode?: string; + mode: string; /** @example tree */ - type?: string; + type: string; /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha: string; /** @example 12 */ size?: number; /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ @@ -31368,6 +34325,22 @@ export interface components { deliveries_url?: string; last_response: components["schemas"]["hook-response"]; }; + /** + * Check immutable releases + * @description Check immutable releases + */ + "check-immutable-releases": { + /** + * @description Whether immutable releases are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether immutable releases are enforced by the repository owner. + * @example false + */ + enforced_by_owner: boolean; + }; /** * Import * @description A repository import from an external source. @@ -31470,7 +34443,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -31530,11 +34503,20 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; } | null; /** * Issue Event Label @@ -31930,46 +34912,6 @@ export interface components { * @description Issue Event for Issue */ "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; - /** - * Label - * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). - */ - label: { - /** - * Format: int64 - * @description Unique identifier for the label. - * @example 208045946 - */ - id: number; - /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; - /** - * Format: uri - * @description URL for the label - * @example https://api.github.com/repositories/42/labels/bug - */ - url: string; - /** - * @description The name of the label. - * @example bug - */ - name: string; - /** - * @description Optional description of the label, such as its purpose. - * @example Something isn't working - */ - description: string | null; - /** - * @description 6-character hex code, without the leading #, identifying the color - * @example FFFFFF - */ - color: string; - /** - * @description Whether this label comes by default in a new repository. - * @example true - */ - default: boolean; - }; /** * Timeline Comment Event * @description Timeline Comment Event @@ -32014,6 +34956,7 @@ export interface components { author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** * Timeline Cross Referenced Event @@ -32113,7 +35056,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -32159,6 +35102,8 @@ export interface components { }; /** Format: date-time */ submitted_at?: string; + /** Format: date-time */ + updated_at?: string | null; /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 @@ -32230,7 +35175,7 @@ export interface components { * @example 8 */ in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the comment. * @example We should probably include a check for null values here. @@ -32410,6 +35355,7 @@ export interface components { created_at: string; read_only: boolean; added_by?: string | null; + /** Format: date-time */ last_used?: string | null; enabled?: boolean; }; @@ -33093,93 +36039,11 @@ export interface components { * @example 2 */ original_start_line?: number | null; - }; - /** - * Release Asset - * @description Data related to a release. - */ - "release-asset": { - /** Format: uri */ - url: string; - /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; /** - * @description The file name of the asset. - * @example Team Environment - */ - name: string; - label: string | null; - /** - * @description State of the release asset. + * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - }; - /** - * Release - * @description A release. - */ - release: { - /** Format: uri */ - url: string; - /** Format: uri */ - html_url: string; - /** Format: uri */ - assets_url: string; - upload_url: string; - /** Format: uri */ - tarball_url: string | null; - /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; - /** - * @description The name of the tag. - * @example v1.0.0 - */ - tag_name: string; - /** - * @description Specifies the commitish value that determines where the Git tag is created from. - * @example master - */ - target_commitish: string; - name: string | null; - body?: string | null; - /** - * @description true to create a draft (unpublished) release, false to create a published one. - * @example false - */ - draft: boolean; - /** - * @description Whether to identify the release as a prerelease or a full release. - * @example false - */ - prerelease: boolean; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; - /** - * Format: uri - * @description The URL of the release discussion. - */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; }; /** * Generated Release Notes Content @@ -33213,7 +36077,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -33271,174 +36135,17 @@ export interface components { 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`. */ + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */ "secret-scanning-alert-resolution-comment": string | null; - /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { - /** - * @description The file path in the repository - * @example /example/secrets.txt - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** @description The API URL to get the associated blob resource */ - blob_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - commit_sha: string; - /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ - "secret-scanning-location-wiki-commit": { - /** - * @description The file path of the wiki page - * @example /example/Home.md - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** - * @description The GitHub URL to get the associated wiki page - * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - page_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_sha: string; - /** - * @description The GitHub URL to get the associated wiki commit - * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_url: string; - }; - /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ - "secret-scanning-location-issue-title": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_title_url: string; - }; - /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ - "secret-scanning-location-issue-body": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_body_url: string; - }; - /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ - "secret-scanning-location-issue-comment": { - /** - * Format: uri - * @description The API URL to get the issue comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - issue_comment_url: string; - }; - /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ - "secret-scanning-location-discussion-title": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082 - */ - discussion_title_url: string; - }; - /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ - "secret-scanning-location-discussion-body": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussion-4566270 - */ - discussion_body_url: string; - }; - /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ - "secret-scanning-location-discussion-comment": { - /** - * Format: uri - * @description The API URL to get the discussion comment where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 - */ - discussion_comment_url: string; - }; - /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ - "secret-scanning-location-pull-request-title": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_title_url: string; - }; - /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ - "secret-scanning-location-pull-request-body": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_body_url: string; - }; - /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ - "secret-scanning-location-pull-request-comment": { - /** - * Format: uri - * @description The API URL to get the pull request comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - pull_request_comment_url: string; - }; - /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ - "secret-scanning-location-pull-request-review": { - /** - * Format: uri - * @description The API URL to get the pull request review where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - */ - pull_request_review_url: string; - }; - /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ - "secret-scanning-location-pull-request-review-comment": { - /** - * Format: uri - * @description The API URL to get the pull request review comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - */ - pull_request_review_comment_url: string; - }; + /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */ + "secret-scanning-alert-assignee": string | null; "secret-scanning-location": { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. @@ -33735,22 +36442,6 @@ export interface components { tarball_url: string; node_id: string; }; - /** - * Tag protection - * @description Tag protection - */ - "tag-protection": { - /** @example 2 */ - id?: number; - /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - /** @example 2011-01-26T19:01:12Z */ - updated_at?: string; - /** @example true */ - enabled?: boolean; - /** @example v1.* */ - pattern: string; - }; /** * Topic * @description A topic aggregates entities that are related to a subject. @@ -33931,12 +36622,9 @@ export interface components { default?: boolean; description?: string | null; }[]; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -33970,7 +36658,9 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; reactions?: components["schemas"]["reaction-rollup"]; }; /** @@ -34089,6 +36779,12 @@ export interface components { has_wiki: boolean; has_downloads: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -34698,6 +37394,8 @@ export interface components { created_at: string; verified: boolean; read_only: boolean; + /** Format: date-time */ + last_used?: string | null; }; /** Marketplace Account */ "marketplace-account": { @@ -34770,45 +37468,6 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; - /** - * Sigstore Bundle v0.1 - * @description Sigstore Bundle v0.1 - */ - "sigstore-bundle-0": { - mediaType?: string; - verificationMaterial?: { - x509CertificateChain?: { - certificates?: { - rawBytes?: string; - }[]; - }; - tlogEntries?: { - logIndex?: string; - logId?: { - keyId?: string; - }; - kindVersion?: { - kind?: string; - version?: string; - }; - integratedTime?: string; - inclusionPromise?: { - signedEntryTimestamp?: string; - }; - inclusionProof?: string | null; - canonicalizedBody?: string; - }[]; - timestampVerificationData?: string | null; - }; - dsseEnvelope?: { - payload?: string; - payloadType?: string; - signatures?: { - sig?: string; - keyid?: string; - }[]; - }; - }; /** * Hovercard * @description Hovercard @@ -34826,6 +37485,114 @@ export interface components { "key-simple": { id: number; key: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + last_used?: string | null; + }; + "billing-premium-request-usage-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report-user": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; /** * Enterprise @@ -35177,6 +37944,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -35535,7 +38313,7 @@ export interface components { * @description A check performed on the code of a given code change */ "check-run-with-simple-check-suite": { - app: components["schemas"]["nullable-integration"]; + app: components["schemas"]["integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** * Format: date-time @@ -35634,6 +38412,81 @@ export interface components { /** Format: uri */ url: string; } | null; + /** + * Deployment + * @description A request for a specific ref(branch,sha,tag) to be deployed + */ + "nullable-deployment": { + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1 + */ + url: string; + /** + * Format: int64 + * @description Unique identifier of the deployment + * @example 42 + */ + id: number; + /** @example MDEwOkRlcGxveW1lbnQx */ + node_id: string; + /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ + sha: string; + /** + * @description The ref to deploy. This can be a branch, tag, or sha. + * @example topic-branch + */ + ref: string; + /** + * @description Parameter to specify a task to execute + * @example deploy + */ + task: string; + payload: { + [key: string]: unknown; + } | string; + /** @example staging */ + original_environment?: string; + /** + * @description Name for the target deployment environment. + * @example production + */ + environment: string; + /** @example Deploy request from hubot */ + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + created_at: string; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + */ + statuses_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example + */ + repository_url: string; + /** + * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. + * @example true + */ + transient_environment?: boolean; + /** + * @description Specifies if the given environment is one that end-users directly interact with. Default: false. + * @example true + */ + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + } | null; webhooks_approver: { avatar_url?: string; events_url?: string; @@ -35818,15 +38671,39 @@ export interface components { user_view_type?: string; } | null; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; + webhooks_comment: { + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: number | null; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + updated_at: string; /** User */ - answer_chosen_by: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35842,6 +38719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35863,37 +38741,78 @@ export interface components { url?: string; user_view_type?: string; } | null; - answer_html_url: string | null; + }; + /** Label */ + webhooks_label: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }; + /** @description An array of repository objects that the installation can access. */ + webhooks_repositories: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + webhooks_repositories_added: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** + * @description Describe whether all repositories have been selected or there's a selection involved + * @enum {string} + */ + webhooks_repository_selection: "all" | "selected"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + webhooks_issue_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue comment */ body: string; - category: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; /** Format: date-time */ created_at: string; + /** Format: uri */ html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ id: number; - locked: boolean; + /** Format: uri */ + issue_url: string; node_id: string; - number: number; + performed_via_github_app: components["schemas"]["integration"]; /** Reactions */ - reactions?: { + reactions: { "+1": number; "-1": number; confused: number; @@ -35906,226 +38825,13 @@ export interface components { /** Format: uri */ url: string; }; - repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; - timeline_url?: string; - title: string; /** Format: date-time */ updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - labels?: components["schemas"]["label"][]; - }; - webhooks_comment: { - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - repository_url: string; - updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - /** Label */ - webhooks_label: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }; - /** @description An array of repository objects that the installation can access. */ - webhooks_repositories: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were added to the installation. */ - webhooks_repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - webhooks_repository_selection: "all" | "selected"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - webhooks_issue_comment: { - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - body: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - /** - * Format: int64 - * @description Unique identifier of the issue comment - */ - id: number; - /** Format: uri */ - issue_url: string; - node_id: string; - performed_via_github_app: components["schemas"]["integration"]; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue comment - */ - url: string; + /** + * Format: uri + * @description URL for the issue comment + */ + url: string; /** User */ user: { /** Format: uri */ @@ -36165,6 +38871,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** @description The changes to the comment. */ webhooks_changes: { @@ -36493,8 +39200,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -36532,12 +39237,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36548,6 +39251,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36987,8 +39691,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -37026,12 +39728,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37042,6 +39742,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37227,6 +39928,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -37242,6 +39958,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Merge Group @@ -37501,6 +40232,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -37846,6 +40588,20 @@ export interface components { /** Format: uri */ organization_url: string; role: string; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; state: string; /** Format: uri */ url: string; @@ -38109,42 +40865,6 @@ export interface components { /** Format: uri */ url: string; }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - "projects-v2": { - id: number; - node_id: string; - owner: components["schemas"]["simple-user"]; - creator: components["schemas"]["simple-user"]; - title: string; - description: string | null; - public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - updated_at: string; - number: number; - short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - deleted_at: string | null; - deleted_by: components["schemas"]["nullable-simple-user"]; - }; webhooks_project_changes: { archived_at?: { /** Format: date-time */ @@ -38153,35 +40873,36 @@ export interface components { to?: string | null; }; }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; /** * Projects v2 Item * @description An item belonging to a project */ "projects-v2-item": { + /** @description The unique identifier of the project item. */ id: number; + /** @description The node ID of the project item. */ node_id?: string; + /** @description The node ID of the project that contains this item. */ project_node_id?: string; + /** @description The node ID of the content represented by this item. */ content_node_id: string; content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the item was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the item was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; /** * Format: date-time + * @description The time when the item was archived. * @example 2022-04-28T12:00:00Z */ archived_at: string | null; @@ -38191,9 +40912,13 @@ export interface components { * @description An option for a single select field */ "projects-v2-single-select-option": { + /** @description The unique identifier of the option. */ id: string; + /** @description The display name of the option. */ name: string; + /** @description The color associated with the option. */ color?: string | null; + /** @description A short description of the option. */ description?: string | null; }; /** @@ -38201,39 +40926,57 @@ export interface components { * @description An iteration setting for an iteration field */ "projects-v2-iteration-setting": { + /** @description The unique identifier of the iteration setting. */ id: string; + /** @description The iteration title. */ title: string; + /** @description The iteration title, rendered as HTML. */ + title_html?: string; + /** @description The duration of the iteration in days. */ duration?: number | null; + /** @description The start date of the iteration. */ start_date?: string | null; + /** @description Whether the iteration has been completed. */ + completed?: boolean; }; /** * Projects v2 Status Update * @description An status update belonging to a project */ "projects-v2-status-update": { + /** @description The unique identifier of the status update. */ id: number; + /** @description The node ID of the status update. */ node_id: string; + /** @description The node ID of the project that this status update belongs to. */ project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the status update was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the status update was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; - /** @enum {string|null} */ + /** + * @description The current status. + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** * Format: date + * @description The start date of the period covered by the update. * @example 2022-04-28 */ start_date?: string; /** * Format: date + * @description The target date associated with the update. * @example 2022-04-28 */ target_date?: string; @@ -38589,6 +41332,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -38935,6 +41688,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -39670,6 +42433,8 @@ export interface components { state: string; /** Format: date-time */ submitted_at: string | null; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -39729,6 +42494,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -39819,6 +42585,8 @@ export interface components { body: string | null; /** Format: date-time */ created_at: string | null; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ @@ -39826,6 +42594,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -39877,6 +42647,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -39974,6 +42745,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -40000,6 +42773,8 @@ export interface components { tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri-template */ upload_url: string; /** Format: uri */ @@ -40067,7 +42842,7 @@ export interface components { number: number; severity: string; /** @enum {string} */ - state: "open"; + state: "auto_dismissed" | "open"; }; /** * @description The reason for resolving the alert. @@ -40128,6 +42903,7 @@ export interface components { publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ multi_repo?: boolean | null; + assigned_to?: components["schemas"]["nullable-simple-user"]; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -40351,6 +43127,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -40369,6 +43160,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** branch protection configuration disabled event */ "webhook-branch-protection-configuration-disabled": { @@ -40469,6 +43275,7 @@ export interface components { action?: "completed"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40487,6 +43294,7 @@ export interface components { action?: "created"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40505,6 +43313,7 @@ export interface components { action: "requested_action"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; /** @description The action requested by the user. */ @@ -40528,6 +43337,7 @@ export interface components { action?: "rerequested"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40673,8 +43483,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -40857,12 +43665,18 @@ export interface components { /** @enum {string} */ administration?: "read" | "write"; /** @enum {string} */ + artifact_metadata?: "read" | "write"; + /** @enum {string} */ + attestations?: "read" | "write"; + /** @enum {string} */ checks?: "read" | "write"; /** @enum {string} */ content_references?: "read" | "write"; /** @enum {string} */ contents?: "read" | "write"; /** @enum {string} */ + copilot_requests?: "write"; + /** @enum {string} */ deployments?: "read" | "write"; /** @enum {string} */ discussions?: "read" | "write"; @@ -40877,8 +43691,12 @@ export interface components { /** @enum {string} */ members?: "read" | "write"; /** @enum {string} */ + merge_queues?: "read" | "write"; + /** @enum {string} */ metadata?: "read" | "write"; /** @enum {string} */ + models?: "read" | "write"; + /** @enum {string} */ organization_administration?: "read" | "write"; /** @enum {string} */ organization_hooks?: "read" | "write"; @@ -40917,8 +43735,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -41101,12 +43917,18 @@ export interface components { /** @enum {string} */ administration?: "read" | "write"; /** @enum {string} */ + artifact_metadata?: "read" | "write"; + /** @enum {string} */ + attestations?: "read" | "write"; + /** @enum {string} */ checks?: "read" | "write"; /** @enum {string} */ content_references?: "read" | "write"; /** @enum {string} */ contents?: "read" | "write"; /** @enum {string} */ + copilot_requests?: "write"; + /** @enum {string} */ deployments?: "read" | "write"; /** @enum {string} */ discussions?: "read" | "write"; @@ -41121,8 +43943,12 @@ export interface components { /** @enum {string} */ members?: "read" | "write"; /** @enum {string} */ + merge_queues?: "read" | "write"; + /** @enum {string} */ metadata?: "read" | "write"; /** @enum {string} */ + models?: "read" | "write"; + /** @enum {string} */ organization_administration?: "read" | "write"; /** @enum {string} */ organization_hooks?: "read" | "write"; @@ -41161,8 +43987,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -41278,6 +44102,7 @@ export interface components { action: "appeared_in_branch"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41408,6 +44233,7 @@ export interface components { action: "closed_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41530,6 +44356,44 @@ export interface components { }; /** Format: uri */ url: string; + /** User */ + dismissal_approved_by?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41626,6 +44490,8 @@ export interface components { updated_at?: string | null; /** Format: uri */ url: string; + dismissal_approved_by?: unknown; + assignees?: components["schemas"]["simple-user"][]; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41641,6 +44507,7 @@ export interface components { action: "fixed"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41780,6 +44647,7 @@ export interface components { action: "reopened"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41798,6 +44666,7 @@ export interface components { * @description The GitHub URL of the alert resource. */ html_url: string; + instances_url?: string; /** Alert Instance */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ @@ -41857,9 +44726,11 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; + updated_at?: string | null; /** Format: uri */ url: string; - } | null; + dismissal_approved_by?: unknown; + }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41876,6 +44747,7 @@ export interface components { action: "reopened_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41957,6 +44829,135 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** code_scanning_alert updated_assignment event */ + "webhook-code-scanning-alert-updated-assignment": { + /** @enum {string} */ + action: "updated_assignment"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | "fixed" | null; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + 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"]; + }; /** commit_comment created event */ "webhook-commit-comment-created": { /** @@ -42094,6 +45095,16 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** custom property promoted to business event */ + "webhook-custom-property-promoted-to-enterprise": { + /** @enum {string} */ + action: "promote_to_enterprise"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ @@ -42133,6 +45144,17 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** Dependabot alert assignees changed event */ + "webhook-dependabot-alert-assignees-changed": { + /** @enum {string} */ + action: "assignees_changed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { /** @enum {string} */ @@ -42410,8 +45432,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -42731,12 +45751,16 @@ export interface components { environment?: string; /** @description The event that triggered the deployment protection rule. */ event?: string; + /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + sha?: string; + /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + ref?: string; /** * Format: uri * @description The URL to review the deployment protection rule. */ deployment_callback_url?: string; - deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["nullable-deployment"]; pull_requests?: components["schemas"]["pull-request"][]; repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -43915,8 +46939,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -44115,8 +47137,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45260,6 +48280,7 @@ export interface components { * @description URL for the issue comment */ url: string; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -45619,8 +48640,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45658,12 +48677,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45674,6 +48689,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46163,8 +49179,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -46202,12 +49216,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46218,6 +49228,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46709,8 +49720,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -46748,12 +49757,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46764,6 +49769,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46929,31 +49935,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "closed"; + /** issue_comment pinned event */ + "webhook-issue-comment-pinned": { + /** @enum {string} */ + action: "pinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -47155,7 +50144,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47240,7 +50229,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -47309,12 +50298,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47325,6 +50310,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -47373,20 +50359,71 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; assignees?: (Record | null)[]; author_association?: string; body?: string | null; - closed_at: string | null; + closed_at?: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; labels_url?: string; - locked?: boolean; + locked: boolean; milestone?: Record | null; node_id?: string; number?: number; @@ -47404,8 +50441,11 @@ export interface components { url?: string; }; repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; timeline_url?: string; title?: string; updated_at?: string; @@ -47437,16 +50477,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issue_comment unpinned event */ + "webhook-issue-comment-unpinned": { /** @enum {string} */ - action: "deleted"; + action: "unpinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -47483,7 +50521,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47520,9 +50558,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47607,7 +50646,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47647,7 +50686,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47801,12 +50840,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47817,6 +50852,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -47858,31 +50894,15 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; - }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { - /** @enum {string} */ - action: "demilestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } & { + active_lock_reason?: string | null; /** User */ - assignee?: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47917,8 +50937,182 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - assignees: ({ + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** blocked by issue added event */ + "webhook-issue-dependencies-blocked-by-added": { + /** @enum {string} */ + action: "blocked_by_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocked by issue removed event */ + "webhook-issue-dependencies-blocked-by-removed": { + /** @enum {string} */ + action: "blocked_by_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue added event */ + "webhook-issue-dependencies-blocking-added": { + /** @enum {string} */ + action: "blocking_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue removed event */ + "webhook-issue-dependencies-blocking-removed": { + /** @enum {string} */ + action: "blocking_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47953,6 +51147,44 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47976,7 +51208,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -47990,7 +51222,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -48077,7 +51309,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48192,8 +51424,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -48231,12 +51461,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48247,6 +51475,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48293,27 +51522,76 @@ export interface components { url?: string; user_view_type?: string; } | null; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels?: (Record | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** @enum {string} */ + state: "closed" | "open"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; }; - milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - title?: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -48356,7 +51634,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48393,9 +51671,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48480,7 +51759,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48520,7 +51799,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48605,7 +51884,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -48635,8 +51914,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -48674,12 +51951,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48690,6 +51965,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48731,21 +52007,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** 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"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "labeled"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -48791,7 +52066,6 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48851,7 +52125,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -48865,7 +52139,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -48952,7 +52226,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49067,8 +52341,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49106,12 +52378,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49122,6 +52392,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -49169,15 +52440,26 @@ export interface components { user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "locked"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -49220,7 +52502,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -49257,10 +52539,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49284,7 +52565,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -49298,11 +52579,10 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -49346,7 +52626,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -49386,7 +52666,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49471,7 +52751,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -49501,8 +52781,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49540,12 +52818,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49554,6 +52830,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -49597,20 +52874,21 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; }; - /** issues milestoned event */ - "webhook-issues-milestoned": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "milestoned"; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -49653,9 +52931,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49689,7 +52968,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -49715,7 +52994,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -49729,7 +53008,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -49816,7 +53095,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49931,8 +53210,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49970,12 +53247,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49984,6 +53259,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -50027,31 +53303,158 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - milestone: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues opened event */ - "webhook-issues-opened": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "opened"; - changes?: { + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - old_issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + /** @enum {boolean} */ + locked: true; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; /** User */ - assignee?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50088,7 +53491,738 @@ export interface components { url?: string; user_view_type?: string; } | null; - assignees: ({ + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + /** @description Title of the issue */ + title: string; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues milestoned event */ + "webhook-issues-milestoned": { + /** @enum {string} */ + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; + type?: components["schemas"]["issue-type"]; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues opened event */ + "webhook-issues-opened": { + /** @enum {string} */ + action: "opened"; + changes?: { + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + old_issue: { + /** @enum {string|null} */ + active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50130,21 +54264,21 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - body: string | null; + body?: string | null; /** Format: date-time */ - closed_at: string | null; - comments: number; + closed_at?: string | null; + comments?: number; /** Format: uri */ - comments_url: string; + comments_url?: string; /** Format: date-time */ - created_at: string; + created_at?: string; draft?: boolean; /** Format: uri */ - events_url: string; + events_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: int64 */ id: number; labels?: { @@ -50163,13 +54297,13 @@ export interface components { url: string; }[]; /** Format: uri-template */ - labels_url: string; + labels_url?: string; locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - milestone: { + milestone?: { /** Format: date-time */ closed_at: string | null; closed_issues: number; @@ -50237,7 +54371,7 @@ export interface components { /** Format: uri */ url: string; } | null; - node_id: string; + node_id?: string; number: number; /** * App @@ -50363,8 +54497,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -50387,7 +54519,7 @@ export interface components { url?: string; }; /** Reactions */ - reactions: { + reactions?: { "+1": number; "-1": number; confused: number; @@ -50401,13 +54533,10 @@ export interface components { url: string; }; /** Format: uri */ - repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + repository_url?: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50417,16 +54546,17 @@ export interface components { /** Format: uri */ timeline_url?: string; /** @description Title of the issue */ - title: string; + title?: string; /** Format: date-time */ - updated_at: string; + updated_at?: string; /** * Format: uri * @description URL for the issue */ - url: string; + url?: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - user: { + user?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50464,6 +54594,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; } | null; /** * Repository @@ -50557,6 +54688,16 @@ export interface components { git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether downloads are enabled. * @default true @@ -51035,8 +55176,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -51074,12 +55213,9 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51090,6 +55226,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -51097,6 +55234,7 @@ export interface components { * @description URL for the issue */ url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -51476,8 +55614,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -51515,12 +55651,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51577,6 +55711,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -51907,8 +56042,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -51946,12 +56079,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51962,6 +56093,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52125,6 +56257,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -52267,6 +56409,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues typed event */ + "webhook-issues-typed": { + /** @enum {string} */ + action: "typed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** issues unassigned event */ "webhook-issues-unassigned": { /** @@ -52621,8 +56775,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -52660,12 +56812,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -52676,6 +56826,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52738,6 +56889,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues untyped event */ + "webhook-issues-untyped": { + /** @enum {string} */ + action: "untyped"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** label created event */ "webhook-label-created": { /** @enum {string} */ @@ -53125,7 +57288,7 @@ export interface components { /** @enum {string} */ action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ hook: { active: boolean; config: { @@ -54852,352 +59015,372 @@ export interface components { * @default false */ has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** - * Format: int64 - * @description Unique identifier of the repository - */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash 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; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string | null; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash 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; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sha: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; + /** Format: uri */ + comments_url: string; + commits?: number; + /** Format: uri */ + commits_url: string; + /** Format: date-time */ + created_at: string; + deletions?: number; + /** Format: uri */ + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { + label: string | null; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. * @default true */ - has_downloads: boolean; + has_pull_requests: boolean; /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} */ - has_discussions: boolean; + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -56048,6 +60231,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; has_pages: boolean; /** * @description Whether projects are enabled. @@ -56405,6 +60598,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57267,6 +61470,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57613,6 +61826,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -58508,6 +62731,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -58854,6 +63087,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -59748,6 +63991,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60094,6 +64347,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60956,6 +65219,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -61302,6 +65575,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62163,6 +66446,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62509,6 +66802,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63562,6 +67865,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63901,6 +68214,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -64708,6 +69031,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65047,6 +69380,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65856,6 +70199,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -66195,6 +70548,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67002,6 +71365,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67341,6 +71714,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67880,6 +72263,8 @@ export interface components { state: "dismissed" | "approved" | "changes_requested"; /** Format: date-time */ submitted_at: string; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -69288,6 +73673,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69627,6 +74022,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70526,6 +74931,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70872,6 +75287,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71790,6 +76215,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -72136,6 +76571,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73035,6 +77480,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73381,6 +77836,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74295,6 +78760,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74634,6 +79109,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75442,6 +79927,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75742,6 +80237,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76354,6 +80859,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request_review_thread unresolved event */ "webhook-pull-request-review-thread-unresolved": { @@ -76656,6 +81163,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76956,6 +81473,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -77568,6 +82095,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request synchronize event */ "webhook-pull-request-synchronize": { @@ -77874,6 +82403,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -78220,6 +82759,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79075,6 +83624,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79421,6 +83980,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80283,6 +84852,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80629,6 +85208,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81483,6 +86072,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81829,6 +86428,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -82638,6 +87247,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -83144,6 +87763,10 @@ export interface components { /** @description The previous version of the name if the action was `edited`. */ from: string; }; + tag_name?: { + /** @description The previous version of the tag_name if the action was `edited`. */ + from: string; + }; make_latest?: { /** @description Whether this release was explicitly `edited` to be the latest. */ to: boolean; @@ -83181,6 +87804,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -83278,6 +87902,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @@ -83309,6 +87935,8 @@ export interface components { target_commitish: string; /** Format: uri-template */ upload_url: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ url: string; /** Format: uri */ @@ -83826,6 +88454,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert assigned event */ + "webhook-secret-scanning-alert-assigned": { + /** @enum {string} */ + action: "assigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 created event */ "webhook-secret-scanning-alert-created": { /** @enum {string} */ @@ -83886,6 +88526,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert unassigned event */ + "webhook-secret-scanning-alert-unassigned": { + /** @enum {string} */ + action: "unassigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 validated event */ "webhook-secret-scanning-alert-validated": { /** @enum {string} */ @@ -84215,7 +88867,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; - verified_at?: string | null; + verified_at: string | null; }; }; /** User */ @@ -87338,6 +91990,334 @@ export interface components { display_title: string; }; }; + /** CreateEvent */ + "create-event": { + ref: string; + ref_type: string; + full_ref: string; + master_branch: string; + description?: string | null; + pusher_type: string; + }; + /** DeleteEvent */ + "delete-event": { + ref: string; + ref_type: string; + full_ref: string; + pusher_type: string; + }; + /** DiscussionEvent */ + "discussion-event": { + action: string; + discussion: components["schemas"]["discussion"]; + }; + /** IssuesEvent */ + "issues-event": { + action: string; + issue: components["schemas"]["issue"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** IssueCommentEvent */ + "issue-comment-event": { + action: string; + issue: components["schemas"]["issue"]; + comment: components["schemas"]["issue-comment"]; + }; + /** ForkEvent */ + "fork-event": { + action: string; + forkee: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + private?: boolean; + owner?: components["schemas"]["simple-user"]; + html_url?: string; + description?: string | null; + fork?: boolean; + url?: string; + forks_url?: string; + keys_url?: string; + collaborators_url?: string; + teams_url?: string; + hooks_url?: string; + issue_events_url?: string; + events_url?: string; + assignees_url?: string; + branches_url?: string; + tags_url?: string; + blobs_url?: string; + git_tags_url?: string; + git_refs_url?: string; + trees_url?: string; + statuses_url?: string; + languages_url?: string; + stargazers_url?: string; + contributors_url?: string; + subscribers_url?: string; + subscription_url?: string; + commits_url?: string; + git_commits_url?: string; + comments_url?: string; + issue_comment_url?: string; + contents_url?: string; + compare_url?: string; + merges_url?: string; + archive_url?: string; + downloads_url?: string; + issues_url?: string; + pulls_url?: string; + milestones_url?: string; + notifications_url?: string; + labels_url?: string; + releases_url?: string; + deployments_url?: string; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + /** Format: date-time */ + pushed_at?: string | null; + git_url?: string; + ssh_url?: string; + clone_url?: string; + svn_url?: string; + homepage?: string | null; + size?: number; + stargazers_count?: number; + watchers_count?: number; + language?: string | null; + has_issues?: boolean; + has_projects?: boolean; + has_downloads?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + forks_count?: number; + mirror_url?: string | null; + archived?: boolean; + disabled?: boolean; + open_issues_count?: number; + license?: components["schemas"]["nullable-license-simple"]; + allow_forking?: boolean; + is_template?: boolean; + web_commit_signoff_required?: boolean; + topics?: string[]; + visibility?: string; + forks?: number; + open_issues?: number; + watchers?: number; + default_branch?: string; + public?: boolean; + }; + }; + /** GollumEvent */ + "gollum-event": { + pages: { + page_name?: string | null; + title?: string | null; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + /** MemberEvent */ + "member-event": { + action: string; + member: components["schemas"]["simple-user"]; + }; + /** PublicEvent */ + "public-event": Record; + /** PushEvent */ + "push-event": { + repository_id: number; + push_id: number; + ref: string; + head: string; + before: string; + }; + /** PullRequestEvent */ + "pull-request-event": { + action: string; + number: number; + pull_request: components["schemas"]["pull-request-minimal"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** PullRequestReviewCommentEvent */ + "pull-request-review-comment-event": { + action: string; + pull_request: components["schemas"]["pull-request-minimal"]; + comment: { + id: number; + node_id: string; + /** Format: uri */ + url: string; + pull_request_review_id: number | null; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + subject_type?: string | null; + commit_id: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + body: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + pull_request_url: string; + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + original_commit_id: string; + /** Reactions */ + reactions: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + /** Format: uri */ + url?: string; + }; + in_reply_to_id?: number; + }; + }; + /** PullRequestReviewEvent */ + "pull-request-review-event": { + action: string; + review: { + id?: number; + node_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + body?: string; + commit_id?: string; + submitted_at?: string | null; + state?: string; + /** Format: uri */ + html_url?: string; + /** Format: uri */ + pull_request_url?: string; + _links?: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + updated_at?: string; + }; + pull_request: components["schemas"]["pull-request-minimal"]; + }; + /** CommitCommentEvent */ + "commit-comment-event": { + action: string; + comment: { + /** Format: uri */ + html_url?: string; + /** Format: uri */ + url?: string; + id?: number; + node_id?: string; + body?: string; + path?: string | null; + position?: number | null; + line?: number | null; + commit_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + }; + /** ReleaseEvent */ + "release-event": { + action: string; + release: components["schemas"]["release"] & { + is_short_description_html_truncated?: boolean; + short_description_html?: string; + }; + }; + /** WatchEvent */ + "watch-event": { + action: string; + }; }; responses: { /** @description Validation failed, or the endpoint has been spammed. */ @@ -87411,6 +92391,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + internal_error: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Conflict */ conflict: { headers: { @@ -87466,6 +92455,42 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting all budgets */ + get_all_budgets: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get_all_budgets"]; + }; + }; + /** @description Response when updating a budget */ + budget: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get-budget"]; + }; + }; + /** @description Response when deleting a budget */ + "delete-budget": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["delete-budget"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-org"]; + }; + }; /** @description Billing usage report response for an organization */ billing_usage_report_org: { headers: { @@ -87475,13 +92500,13 @@ export interface components { "application/json": components["schemas"]["billing-usage-report"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_org: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-summary-report-org"]; }; }; /** @description Response */ @@ -87521,6 +92546,15 @@ export interface components { }; }; }; + /** @description Payload Too Large */ + too_large: { + headers: { + [name: string]: unknown; + }; + content: { + "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: { @@ -87537,8 +92571,15 @@ export interface components { }; content?: never; }; - /** @description Gone */ - gone: { + /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */ + enterprise_team_unsupported: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Temporary Redirect */ + temporary_redirect: { headers: { [name: string]: unknown; }; @@ -87546,8 +92587,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Temporary Redirect */ - temporary_redirect: { + /** @description Gone */ + gone: { headers: { [name: string]: unknown; }; @@ -87591,6 +92632,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if analysis could not be processed */ + unprocessable_analysis: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -87607,7 +92657,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ + /** @description Response if the configuration change cannot be made because the repository is not in the required state */ + code_scanning_invalid_state: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */ dependency_review_forbidden: { headers: { [name: string]: unknown; @@ -87634,6 +92693,33 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-summary-report-user"]; + }; + }; }; parameters: { /** @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)." */ @@ -87662,7 +92748,7 @@ export interface components { "assignment-id": number; /** @description The unique identifier of the classroom. */ "classroom-id": number; - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: string; /** @description The unique identifier of the code security configuration. */ "configuration-id": number; @@ -87695,6 +92781,17 @@ export interface components { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ "dependabot-alert-comma-separated-epss": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + "dependabot-alert-comma-separated-has": string | "patch"[]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + "dependabot-alert-comma-separated-assignees": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @@ -87704,32 +92801,16 @@ export interface components { * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first": number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last": number; - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "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 version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": string; + /** @description The handle for the GitHub user account. */ + username: string; + /** @description The organization name. The name is not case sensitive. */ + org: string; + /** @description The slug of the team name. */ + "team-slug": string; + /** @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)." */ + "public-events-per-page": number; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -87756,16 +92837,30 @@ export interface components { "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org": number; - /** @description The organization name. The name is not case sensitive. */ - org: string; - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description The ID corresponding to the budget. */ + budget: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ "billing-usage-report-year": number; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - "billing-usage-report-month": number; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + "billing-usage-report-month-default": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ "billing-usage-report-day": number; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - "billing-usage-report-hour": number; + /** @description The user name to query usage for. The name is not case sensitive. */ + "billing-usage-report-user": string; + /** @description The model name to query usage for. The name is not case sensitive. */ + "billing-usage-report-model": string; + /** @description The product name to query usage for. The name is not case sensitive. */ + "billing-usage-report-product": string; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + "billing-usage-report-month": number; + /** @description The repository name to query for usage in the format owner/repository. */ + "billing-usage-report-repository": string; + /** @description The SKU to query for usage. */ + "billing-usage-report-sku": string; + /** @description Image definition ID of custom image */ + "actions-custom-image-definition-id": number; + /** @description Version of a custom image */ + "actions-custom-image-version": string; /** @description Unique identifier of the GitHub-hosted runner. */ "hosted-runner-id": number; /** @description The unique identifier of the repository. */ @@ -87784,12 +92879,31 @@ export interface components { "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; - /** @description The handle for the GitHub user account. */ - username: string; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + "subject-digest": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + "dependabot-alert-comma-separated-artifact-registry-urls": string; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + "dependabot-alert-comma-separated-artifact-registry": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + "dependabot-alert-comma-separated-runtime-risk": string; /** @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 */ @@ -87816,14 +92930,14 @@ export interface components { "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ "codespace-name": string; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @@ -87851,8 +92965,18 @@ export interface components { "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "personal-access-token-after": string; + /** @description The ID of the token */ + "personal-access-token-token-id": string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The project's number. */ + "project-number": number; + /** @description The unique identifier of the field. */ + "field-id": number; + /** @description The unique identifier of the project item. */ + "item-id": number; + /** @description The number that identifies the project view. */ + "view-number": number; /** @description The custom property name */ "custom-property-name": string; /** @@ -87868,12 +92992,12 @@ export interface components { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ "actor-name-in-query": string; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ "rule-suite-result": "pass" | "fail" | "bypass" | "all"; /** * @description The unique identifier of the rule suite result. @@ -87882,22 +93006,32 @@ export interface components { * for organizations. */ "rule-suite-id": number; + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + "secret-scanning-alert-resolution": string; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + "secret-scanning-alert-assignee": string; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + "secret-scanning-alert-sort": "created" | "updated"; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ "secret-scanning-pagination-before-org-repo": string; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @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 A boolean value representing whether or not to hide literal secrets in the results. */ + "secret-scanning-alert-hide-secret": boolean; /** @description Unique identifier of the hosted compute network configuration. */ "network-configuration-id": string; /** @description Unique identifier of the hosted compute network settings. */ "network-settings-id": string; - /** @description The number that identifies the discussion. */ - "discussion-number": number; - /** @description The number that identifies the comment. */ - "comment-number": number; - /** @description The unique identifier of the reaction. */ - "reaction-id": number; - /** @description The unique identifier of the project. */ - "project-id": number; /** @description The security feature to enable or disable. */ "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; /** @@ -87907,10 +93041,6 @@ export interface components { * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; - /** @description The unique identifier of the card. */ - "card-id": number; - /** @description The unique identifier of the column. */ - "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ "artifact-name": string; /** @description The unique identifier of the artifact. */ @@ -87967,6 +93097,8 @@ export interface components { "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 unique identifier of the reaction. */ + "reaction-id": number; /** @description The SHA of the commit. */ "commit-sha": string; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ @@ -88013,14 +93145,17 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The unique identifier of the tag protection. */ - "tag-protection-id": number; /** @description The time frame to display results for. */ per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ "since-repo": number; /** @description 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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + "issues-advanced-search": string; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ @@ -88037,6 +93172,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred": "created" | "updated"; + /** @description The unique identifier of the user. */ + "user-id": string; }; requestBodies: never; headers: { @@ -88057,1033 +93194,6 @@ export interface components { }; pathItems: never; } -export type SchemaRoot = components['schemas']['root']; -export type SchemaSecurityAdvisoryEcosystems = components['schemas']['security-advisory-ecosystems']; -export type SchemaVulnerability = components['schemas']['vulnerability']; -export type SchemaCvssSeverities = components['schemas']['cvss-severities']; -export type SchemaSecurityAdvisoryEpss = components['schemas']['security-advisory-epss']; -export type SchemaSimpleUser = components['schemas']['simple-user']; -export type SchemaSecurityAdvisoryCreditTypes = components['schemas']['security-advisory-credit-types']; -export type SchemaGlobalAdvisory = components['schemas']['global-advisory']; -export type SchemaBasicError = components['schemas']['basic-error']; -export type SchemaValidationErrorSimple = components['schemas']['validation-error-simple']; -export type SchemaEnterprise = components['schemas']['enterprise']; -export type SchemaIntegration = components['schemas']['integration']; -export type SchemaWebhookConfigUrl = components['schemas']['webhook-config-url']; -export type SchemaWebhookConfigContentType = components['schemas']['webhook-config-content-type']; -export type SchemaWebhookConfigSecret = components['schemas']['webhook-config-secret']; -export type SchemaWebhookConfigInsecureSsl = components['schemas']['webhook-config-insecure-ssl']; -export type SchemaWebhookConfig = components['schemas']['webhook-config']; -export type SchemaHookDeliveryItem = components['schemas']['hook-delivery-item']; -export type SchemaScimError = components['schemas']['scim-error']; -export type SchemaValidationError = components['schemas']['validation-error']; -export type SchemaHookDelivery = components['schemas']['hook-delivery']; -export type SchemaIntegrationInstallationRequest = components['schemas']['integration-installation-request']; -export type SchemaAppPermissions = components['schemas']['app-permissions']; -export type SchemaNullableSimpleUser = components['schemas']['nullable-simple-user']; -export type SchemaInstallation = components['schemas']['installation']; -export type SchemaNullableLicenseSimple = components['schemas']['nullable-license-simple']; -export type SchemaRepository = components['schemas']['repository']; -export type SchemaInstallationToken = components['schemas']['installation-token']; -export type SchemaNullableScopedInstallation = components['schemas']['nullable-scoped-installation']; -export type SchemaAuthorization = components['schemas']['authorization']; -export type SchemaSimpleClassroomRepository = components['schemas']['simple-classroom-repository']; -export type SchemaSimpleClassroomOrganization = components['schemas']['simple-classroom-organization']; -export type SchemaClassroom = components['schemas']['classroom']; -export type SchemaClassroomAssignment = components['schemas']['classroom-assignment']; -export type SchemaSimpleClassroomUser = components['schemas']['simple-classroom-user']; -export type SchemaSimpleClassroom = components['schemas']['simple-classroom']; -export type SchemaSimpleClassroomAssignment = components['schemas']['simple-classroom-assignment']; -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 SchemaCodeSecurityConfiguration = components['schemas']['code-security-configuration']; -export type SchemaCodeScanningDefaultSetupOptions = components['schemas']['code-scanning-default-setup-options']; -export type SchemaCodeSecurityDefaultConfigurations = components['schemas']['code-security-default-configurations']; -export type SchemaSimpleRepository = components['schemas']['simple-repository']; -export type SchemaCodeSecurityConfigurationRepositories = components['schemas']['code-security-configuration-repositories']; -export type SchemaAlertNumber = components['schemas']['alert-number']; -export type SchemaDependabotAlertPackage = components['schemas']['dependabot-alert-package']; -export type SchemaDependabotAlertSecurityVulnerability = components['schemas']['dependabot-alert-security-vulnerability']; -export type SchemaDependabotAlertSecurityAdvisory = components['schemas']['dependabot-alert-security-advisory']; -export type SchemaAlertUrl = components['schemas']['alert-url']; -export type SchemaAlertHtmlUrl = components['schemas']['alert-html-url']; -export type SchemaAlertCreatedAt = components['schemas']['alert-created-at']; -export type SchemaAlertUpdatedAt = components['schemas']['alert-updated-at']; -export type SchemaAlertDismissedAt = components['schemas']['alert-dismissed-at']; -export type SchemaAlertFixedAt = components['schemas']['alert-fixed-at']; -export type SchemaAlertAutoDismissedAt = components['schemas']['alert-auto-dismissed-at']; -export type SchemaDependabotAlertWithRepository = components['schemas']['dependabot-alert-with-repository']; -export type SchemaNullableAlertUpdatedAt = components['schemas']['nullable-alert-updated-at']; -export type SchemaSecretScanningAlertState = components['schemas']['secret-scanning-alert-state']; -export type SchemaSecretScanningAlertResolution = components['schemas']['secret-scanning-alert-resolution']; -export type SchemaOrganizationSecretScanningAlert = components['schemas']['organization-secret-scanning-alert']; -export type SchemaActor = components['schemas']['actor']; -export type SchemaNullableMilestone = components['schemas']['nullable-milestone']; -export type SchemaNullableIntegration = components['schemas']['nullable-integration']; -export type SchemaAuthorAssociation = components['schemas']['author-association']; -export type SchemaReactionRollup = components['schemas']['reaction-rollup']; -export type SchemaSubIssuesSummary = components['schemas']['sub-issues-summary']; -export type SchemaIssue = components['schemas']['issue']; -export type SchemaIssueComment = components['schemas']['issue-comment']; -export type SchemaEvent = components['schemas']['event']; -export type SchemaLinkWithType = components['schemas']['link-with-type']; -export type SchemaFeed = components['schemas']['feed']; -export type SchemaBaseGist = components['schemas']['base-gist']; -export type SchemaPublicUser = components['schemas']['public-user']; -export type SchemaGistHistory = components['schemas']['gist-history']; -export type SchemaGistSimple = components['schemas']['gist-simple']; -export type SchemaGistComment = components['schemas']['gist-comment']; -export type SchemaGistCommit = components['schemas']['gist-commit']; -export type SchemaGitignoreTemplate = components['schemas']['gitignore-template']; -export type SchemaLicenseSimple = components['schemas']['license-simple']; -export type SchemaLicense = components['schemas']['license']; -export type SchemaMarketplaceListingPlan = components['schemas']['marketplace-listing-plan']; -export type SchemaMarketplacePurchase = components['schemas']['marketplace-purchase']; -export type SchemaApiOverview = components['schemas']['api-overview']; -export type SchemaSecurityAndAnalysis = components['schemas']['security-and-analysis']; -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 SchemaBillingUsageReport = components['schemas']['billing-usage-report']; -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']; -export type SchemaNullableActionsHostedRunnerPoolImage = components['schemas']['nullable-actions-hosted-runner-pool-image']; -export type SchemaActionsHostedRunnerMachineSpec = components['schemas']['actions-hosted-runner-machine-spec']; -export type SchemaPublicIp = components['schemas']['public-ip']; -export type SchemaActionsHostedRunner = components['schemas']['actions-hosted-runner']; -export type SchemaActionsHostedRunnerImage = components['schemas']['actions-hosted-runner-image']; -export type SchemaActionsHostedRunnerLimits = components['schemas']['actions-hosted-runner-limits']; -export type SchemaOidcCustomSub = components['schemas']['oidc-custom-sub']; -export type SchemaEmptyObject = components['schemas']['empty-object']; -export type SchemaEnabledRepositories = components['schemas']['enabled-repositories']; -export type SchemaAllowedActions = components['schemas']['allowed-actions']; -export type SchemaSelectedActionsUrl = components['schemas']['selected-actions-url']; -export type SchemaActionsOrganizationPermissions = components['schemas']['actions-organization-permissions']; -export type SchemaSelectedActions = components['schemas']['selected-actions']; -export type SchemaActionsDefaultWorkflowPermissions = components['schemas']['actions-default-workflow-permissions']; -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']; -export type SchemaAuthenticationToken = components['schemas']['authentication-token']; -export type SchemaOrganizationActionsSecret = components['schemas']['organization-actions-secret']; -export type SchemaActionsPublicKey = components['schemas']['actions-public-key']; -export type SchemaOrganizationActionsVariable = components['schemas']['organization-actions-variable']; -export type SchemaCodeScanningAnalysisToolName = components['schemas']['code-scanning-analysis-tool-name']; -export type SchemaCodeScanningAnalysisToolGuid = components['schemas']['code-scanning-analysis-tool-guid']; -export type SchemaCodeScanningAlertStateQuery = components['schemas']['code-scanning-alert-state-query']; -export type SchemaCodeScanningAlertSeverity = components['schemas']['code-scanning-alert-severity']; -export type SchemaAlertInstancesUrl = components['schemas']['alert-instances-url']; -export type SchemaCodeScanningAlertState = components['schemas']['code-scanning-alert-state']; -export type SchemaCodeScanningAlertDismissedReason = components['schemas']['code-scanning-alert-dismissed-reason']; -export type SchemaCodeScanningAlertDismissedComment = components['schemas']['code-scanning-alert-dismissed-comment']; -export type SchemaCodeScanningAlertRuleSummary = components['schemas']['code-scanning-alert-rule-summary']; -export type SchemaCodeScanningAnalysisToolVersion = components['schemas']['code-scanning-analysis-tool-version']; -export type SchemaCodeScanningAnalysisTool = components['schemas']['code-scanning-analysis-tool']; -export type SchemaCodeScanningRef = components['schemas']['code-scanning-ref']; -export type SchemaCodeScanningAnalysisAnalysisKey = components['schemas']['code-scanning-analysis-analysis-key']; -export type SchemaCodeScanningAlertEnvironment = components['schemas']['code-scanning-alert-environment']; -export type SchemaCodeScanningAnalysisCategory = components['schemas']['code-scanning-analysis-category']; -export type SchemaCodeScanningAlertLocation = components['schemas']['code-scanning-alert-location']; -export type SchemaCodeScanningAlertClassification = components['schemas']['code-scanning-alert-classification']; -export type SchemaCodeScanningAlertInstance = components['schemas']['code-scanning-alert-instance']; -export type SchemaCodeScanningOrganizationAlertItems = components['schemas']['code-scanning-organization-alert-items']; -export type SchemaNullableCodespaceMachine = components['schemas']['nullable-codespace-machine']; -export type SchemaCodespace = components['schemas']['codespace']; -export type SchemaCodespacesOrgSecret = components['schemas']['codespaces-org-secret']; -export type SchemaCodespacesPublicKey = components['schemas']['codespaces-public-key']; -export type SchemaCopilotSeatBreakdown = components['schemas']['copilot-seat-breakdown']; -export type SchemaCopilotOrganizationDetails = components['schemas']['copilot-organization-details']; -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 SchemaOrganizationDependabotSecret = components['schemas']['organization-dependabot-secret']; -export type SchemaDependabotPublicKey = components['schemas']['dependabot-public-key']; -export type SchemaNullableMinimalRepository = components['schemas']['nullable-minimal-repository']; -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']; -export type SchemaInteractionLimit = components['schemas']['interaction-limit']; -export type SchemaOrgMembership = components['schemas']['org-membership']; -export type SchemaMigration = components['schemas']['migration']; -export type SchemaOrganizationRole = components['schemas']['organization-role']; -export type SchemaTeamRoleAssignment = components['schemas']['team-role-assignment']; -export type SchemaTeamSimple = components['schemas']['team-simple']; -export type SchemaUserRoleAssignment = components['schemas']['user-role-assignment']; -export type SchemaPackageVersion = components['schemas']['package-version']; -export type SchemaOrganizationProgrammaticAccessGrantRequest = components['schemas']['organization-programmatic-access-grant-request']; -export type SchemaOrganizationProgrammaticAccessGrant = components['schemas']['organization-programmatic-access-grant']; -export type SchemaOrgPrivateRegistryConfiguration = components['schemas']['org-private-registry-configuration']; -export type SchemaOrgPrivateRegistryConfigurationWithSelectedRepositories = components['schemas']['org-private-registry-configuration-with-selected-repositories']; -export type SchemaProject = components['schemas']['project']; -export type SchemaCustomProperty = components['schemas']['custom-property']; -export type SchemaCustomPropertySetPayload = components['schemas']['custom-property-set-payload']; -export type SchemaCustomPropertyValue = components['schemas']['custom-property-value']; -export type SchemaOrgRepoCustomPropertyValues = components['schemas']['org-repo-custom-property-values']; -export type SchemaNullableRepository = components['schemas']['nullable-repository']; -export type SchemaCodeOfConductSimple = components['schemas']['code-of-conduct-simple']; -export type SchemaFullRepository = components['schemas']['full-repository']; -export type SchemaRepositoryRuleEnforcement = components['schemas']['repository-rule-enforcement']; -export type SchemaRepositoryRulesetBypassActor = components['schemas']['repository-ruleset-bypass-actor']; -export type SchemaRepositoryRulesetConditions = components['schemas']['repository-ruleset-conditions']; -export type SchemaRepositoryRulesetConditionsRepositoryNameTarget = components['schemas']['repository-ruleset-conditions-repository-name-target']; -export type SchemaRepositoryRulesetConditionsRepositoryIdTarget = components['schemas']['repository-ruleset-conditions-repository-id-target']; -export type SchemaRepositoryRulesetConditionsRepositoryPropertySpec = components['schemas']['repository-ruleset-conditions-repository-property-spec']; -export type SchemaRepositoryRulesetConditionsRepositoryPropertyTarget = components['schemas']['repository-ruleset-conditions-repository-property-target']; -export type SchemaOrgRulesetConditions = components['schemas']['org-ruleset-conditions']; -export type SchemaRepositoryRuleCreation = components['schemas']['repository-rule-creation']; -export type SchemaRepositoryRuleUpdate = components['schemas']['repository-rule-update']; -export type SchemaRepositoryRuleDeletion = components['schemas']['repository-rule-deletion']; -export type SchemaRepositoryRuleRequiredLinearHistory = components['schemas']['repository-rule-required-linear-history']; -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']; -export type SchemaRepositoryRuleNonFastForward = components['schemas']['repository-rule-non-fast-forward']; -export type SchemaRepositoryRuleCommitMessagePattern = components['schemas']['repository-rule-commit-message-pattern']; -export type SchemaRepositoryRuleCommitAuthorEmailPattern = components['schemas']['repository-rule-commit-author-email-pattern']; -export type SchemaRepositoryRuleCommitterEmailPattern = components['schemas']['repository-rule-committer-email-pattern']; -export type SchemaRepositoryRuleBranchNamePattern = components['schemas']['repository-rule-branch-name-pattern']; -export type SchemaRepositoryRuleTagNamePattern = components['schemas']['repository-rule-tag-name-pattern']; -export type SchemaRepositoryRuleParamsRestrictedCommits = components['schemas']['repository-rule-params-restricted-commits']; -export type SchemaRepositoryRuleParamsWorkflowFileReference = components['schemas']['repository-rule-params-workflow-file-reference']; -export type SchemaRepositoryRuleWorkflows = components['schemas']['repository-rule-workflows']; -export type SchemaRepositoryRuleParamsCodeScanningTool = components['schemas']['repository-rule-params-code-scanning-tool']; -export type SchemaRepositoryRuleCodeScanning = components['schemas']['repository-rule-code-scanning']; -export type SchemaRepositoryRule = components['schemas']['repository-rule']; -export type SchemaRepositoryRuleset = components['schemas']['repository-ruleset']; -export type SchemaRuleSuites = components['schemas']['rule-suites']; -export type SchemaRuleSuite = components['schemas']['rule-suite']; -export type SchemaRepositoryAdvisoryVulnerability = components['schemas']['repository-advisory-vulnerability']; -export type SchemaRepositoryAdvisoryCredit = components['schemas']['repository-advisory-credit']; -export type SchemaRepositoryAdvisory = components['schemas']['repository-advisory']; -export type SchemaActionsBillingUsage = components['schemas']['actions-billing-usage']; -export type SchemaPackagesBillingUsage = components['schemas']['packages-billing-usage']; -export type SchemaCombinedBillingUsage = components['schemas']['combined-billing-usage']; -export type SchemaNetworkConfiguration = components['schemas']['network-configuration']; -export type SchemaNetworkSettings = components['schemas']['network-settings']; -export type SchemaTeamOrganization = components['schemas']['team-organization']; -export type SchemaTeamFull = components['schemas']['team-full']; -export type SchemaTeamDiscussion = components['schemas']['team-discussion']; -export type SchemaTeamDiscussionComment = components['schemas']['team-discussion-comment']; -export type SchemaReaction = components['schemas']['reaction']; -export type SchemaTeamMembership = components['schemas']['team-membership']; -export type SchemaTeamProject = components['schemas']['team-project']; -export type SchemaTeamRepository = components['schemas']['team-repository']; -export type SchemaProjectCard = components['schemas']['project-card']; -export type SchemaProjectColumn = components['schemas']['project-column']; -export type SchemaProjectCollaboratorPermission = components['schemas']['project-collaborator-permission']; -export type SchemaRateLimit = components['schemas']['rate-limit']; -export type SchemaRateLimitOverview = components['schemas']['rate-limit-overview']; -export type SchemaArtifact = components['schemas']['artifact']; -export type SchemaActionsCacheList = components['schemas']['actions-cache-list']; -export type SchemaJob = components['schemas']['job']; -export type SchemaOidcCustomSubRepo = components['schemas']['oidc-custom-sub-repo']; -export type SchemaActionsSecret = components['schemas']['actions-secret']; -export type SchemaActionsVariable = components['schemas']['actions-variable']; -export type SchemaActionsEnabled = components['schemas']['actions-enabled']; -export type SchemaActionsRepositoryPermissions = components['schemas']['actions-repository-permissions']; -export type SchemaActionsWorkflowAccessToRepository = components['schemas']['actions-workflow-access-to-repository']; -export type SchemaReferencedWorkflow = components['schemas']['referenced-workflow']; -export type SchemaPullRequestMinimal = components['schemas']['pull-request-minimal']; -export type SchemaNullableSimpleCommit = components['schemas']['nullable-simple-commit']; -export type SchemaWorkflowRun = components['schemas']['workflow-run']; -export type SchemaEnvironmentApprovals = components['schemas']['environment-approvals']; -export type SchemaReviewCustomGatesCommentRequired = components['schemas']['review-custom-gates-comment-required']; -export type SchemaReviewCustomGatesStateRequired = components['schemas']['review-custom-gates-state-required']; -export type SchemaDeploymentReviewerType = components['schemas']['deployment-reviewer-type']; -export type SchemaPendingDeployment = components['schemas']['pending-deployment']; -export type SchemaDeployment = components['schemas']['deployment']; -export type SchemaWorkflowRunUsage = components['schemas']['workflow-run-usage']; -export type SchemaWorkflow = components['schemas']['workflow']; -export type SchemaWorkflowUsage = components['schemas']['workflow-usage']; -export type SchemaActivity = components['schemas']['activity']; -export type SchemaAutolink = components['schemas']['autolink']; -export type SchemaCheckAutomatedSecurityFixes = components['schemas']['check-automated-security-fixes']; -export type SchemaProtectedBranchRequiredStatusCheck = components['schemas']['protected-branch-required-status-check']; -export type SchemaProtectedBranchAdminEnforced = components['schemas']['protected-branch-admin-enforced']; -export type SchemaProtectedBranchPullRequestReview = components['schemas']['protected-branch-pull-request-review']; -export type SchemaBranchRestrictionPolicy = components['schemas']['branch-restriction-policy']; -export type SchemaBranchProtection = components['schemas']['branch-protection']; -export type SchemaShortBranch = components['schemas']['short-branch']; -export type SchemaNullableGitUser = components['schemas']['nullable-git-user']; -export type SchemaVerification = components['schemas']['verification']; -export type SchemaDiffEntry = components['schemas']['diff-entry']; -export type SchemaCommit = components['schemas']['commit']; -export type SchemaBranchWithProtection = components['schemas']['branch-with-protection']; -export type SchemaStatusCheckPolicy = components['schemas']['status-check-policy']; -export type SchemaProtectedBranch = components['schemas']['protected-branch']; -export type SchemaDeploymentSimple = components['schemas']['deployment-simple']; -export type SchemaCheckRun = components['schemas']['check-run']; -export type SchemaCheckAnnotation = components['schemas']['check-annotation']; -export type SchemaSimpleCommit = components['schemas']['simple-commit']; -export type SchemaCheckSuite = components['schemas']['check-suite']; -export type SchemaCheckSuitePreference = components['schemas']['check-suite-preference']; -export type SchemaCodeScanningAlertItems = components['schemas']['code-scanning-alert-items']; -export type SchemaCodeScanningAlertRule = components['schemas']['code-scanning-alert-rule']; -export type SchemaCodeScanningAlert = components['schemas']['code-scanning-alert']; -export type SchemaCodeScanningAlertSetState = components['schemas']['code-scanning-alert-set-state']; -export type SchemaCodeScanningAutofixStatus = components['schemas']['code-scanning-autofix-status']; -export type SchemaCodeScanningAutofixDescription = components['schemas']['code-scanning-autofix-description']; -export type SchemaCodeScanningAutofixStartedAt = components['schemas']['code-scanning-autofix-started-at']; -export type SchemaCodeScanningAutofix = components['schemas']['code-scanning-autofix']; -export type SchemaCodeScanningAutofixCommits = components['schemas']['code-scanning-autofix-commits']; -export type SchemaCodeScanningAutofixCommitsResponse = components['schemas']['code-scanning-autofix-commits-response']; -export type SchemaCodeScanningAnalysisSarifId = components['schemas']['code-scanning-analysis-sarif-id']; -export type SchemaCodeScanningAnalysisCommitSha = components['schemas']['code-scanning-analysis-commit-sha']; -export type SchemaCodeScanningAnalysisEnvironment = components['schemas']['code-scanning-analysis-environment']; -export type SchemaCodeScanningAnalysisCreatedAt = components['schemas']['code-scanning-analysis-created-at']; -export type SchemaCodeScanningAnalysisUrl = components['schemas']['code-scanning-analysis-url']; -export type SchemaCodeScanningAnalysis = components['schemas']['code-scanning-analysis']; -export type SchemaCodeScanningAnalysisDeletion = components['schemas']['code-scanning-analysis-deletion']; -export type SchemaCodeScanningCodeqlDatabase = components['schemas']['code-scanning-codeql-database']; -export type SchemaCodeScanningVariantAnalysisLanguage = components['schemas']['code-scanning-variant-analysis-language']; -export type SchemaCodeScanningVariantAnalysisRepository = components['schemas']['code-scanning-variant-analysis-repository']; -export type SchemaCodeScanningVariantAnalysisStatus = components['schemas']['code-scanning-variant-analysis-status']; -export type SchemaCodeScanningVariantAnalysisSkippedRepoGroup = components['schemas']['code-scanning-variant-analysis-skipped-repo-group']; -export type SchemaCodeScanningVariantAnalysis = components['schemas']['code-scanning-variant-analysis']; -export type SchemaCodeScanningVariantAnalysisRepoTask = components['schemas']['code-scanning-variant-analysis-repo-task']; -export type SchemaCodeScanningDefaultSetup = components['schemas']['code-scanning-default-setup']; -export type SchemaCodeScanningDefaultSetupUpdate = components['schemas']['code-scanning-default-setup-update']; -export type SchemaCodeScanningDefaultSetupUpdateResponse = components['schemas']['code-scanning-default-setup-update-response']; -export type SchemaCodeScanningRefFull = components['schemas']['code-scanning-ref-full']; -export type SchemaCodeScanningAnalysisSarifFile = components['schemas']['code-scanning-analysis-sarif-file']; -export type SchemaCodeScanningSarifsReceipt = components['schemas']['code-scanning-sarifs-receipt']; -export type SchemaCodeScanningSarifsStatus = components['schemas']['code-scanning-sarifs-status']; -export type SchemaCodeSecurityConfigurationForRepository = components['schemas']['code-security-configuration-for-repository']; -export type SchemaCodeownersErrors = components['schemas']['codeowners-errors']; -export type SchemaCodespaceMachine = components['schemas']['codespace-machine']; -export type SchemaCodespacesPermissionsCheckForDevcontainer = components['schemas']['codespaces-permissions-check-for-devcontainer']; -export type SchemaRepoCodespacesSecret = components['schemas']['repo-codespaces-secret']; -export type SchemaCollaborator = components['schemas']['collaborator']; -export type SchemaRepositoryInvitation = components['schemas']['repository-invitation']; -export type SchemaNullableCollaborator = components['schemas']['nullable-collaborator']; -export type SchemaRepositoryCollaboratorPermission = components['schemas']['repository-collaborator-permission']; -export type SchemaCommitComment = components['schemas']['commit-comment']; -export type SchemaBranchShort = components['schemas']['branch-short']; -export type SchemaLink = components['schemas']['link']; -export type SchemaAutoMerge = components['schemas']['auto-merge']; -export type SchemaPullRequestSimple = components['schemas']['pull-request-simple']; -export type SchemaSimpleCommitStatus = components['schemas']['simple-commit-status']; -export type SchemaCombinedCommitStatus = components['schemas']['combined-commit-status']; -export type SchemaStatus = components['schemas']['status']; -export type SchemaNullableCodeOfConductSimple = components['schemas']['nullable-code-of-conduct-simple']; -export type SchemaNullableCommunityHealthFile = components['schemas']['nullable-community-health-file']; -export type SchemaCommunityProfile = components['schemas']['community-profile']; -export type SchemaCommitComparison = components['schemas']['commit-comparison']; -export type SchemaContentTree = components['schemas']['content-tree']; -export type SchemaContentDirectory = components['schemas']['content-directory']; -export type SchemaContentFile = components['schemas']['content-file']; -export type SchemaContentSymlink = components['schemas']['content-symlink']; -export type SchemaContentSubmodule = components['schemas']['content-submodule']; -export type SchemaFileCommit = components['schemas']['file-commit']; -export type SchemaSecretScanningPushProtectionBypassPlaceholderId = components['schemas']['secret-scanning-push-protection-bypass-placeholder-id']; -export type SchemaRepositoryRuleViolationError = components['schemas']['repository-rule-violation-error']; -export type SchemaContributor = components['schemas']['contributor']; -export type SchemaDependabotAlert = components['schemas']['dependabot-alert']; -export type SchemaDependabotSecret = components['schemas']['dependabot-secret']; -export type SchemaDependencyGraphDiff = components['schemas']['dependency-graph-diff']; -export type SchemaDependencyGraphSpdxSbom = components['schemas']['dependency-graph-spdx-sbom']; -export type SchemaMetadata = components['schemas']['metadata']; -export type SchemaDependency = components['schemas']['dependency']; -export type SchemaManifest = components['schemas']['manifest']; -export type SchemaSnapshot = components['schemas']['snapshot']; -export type SchemaDeploymentStatus = components['schemas']['deployment-status']; -export type SchemaWaitTimer = components['schemas']['wait-timer']; -export type SchemaDeploymentBranchPolicySettings = components['schemas']['deployment-branch-policy-settings']; -export type SchemaEnvironment = components['schemas']['environment']; -export type SchemaPreventSelfReview = components['schemas']['prevent-self-review']; -export type SchemaDeploymentBranchPolicy = components['schemas']['deployment-branch-policy']; -export type SchemaDeploymentBranchPolicyNamePatternWithType = components['schemas']['deployment-branch-policy-name-pattern-with-type']; -export type SchemaDeploymentBranchPolicyNamePattern = components['schemas']['deployment-branch-policy-name-pattern']; -export type SchemaCustomDeploymentRuleApp = components['schemas']['custom-deployment-rule-app']; -export type SchemaDeploymentProtectionRule = components['schemas']['deployment-protection-rule']; -export type SchemaShortBlob = components['schemas']['short-blob']; -export type SchemaBlob = components['schemas']['blob']; -export type SchemaGitCommit = components['schemas']['git-commit']; -export type SchemaGitRef = components['schemas']['git-ref']; -export type SchemaGitTag = components['schemas']['git-tag']; -export type SchemaGitTree = components['schemas']['git-tree']; -export type SchemaHookResponse = components['schemas']['hook-response']; -export type SchemaHook = components['schemas']['hook']; -export type SchemaImport = components['schemas']['import']; -export type SchemaPorterAuthor = components['schemas']['porter-author']; -export type SchemaPorterLargeFile = components['schemas']['porter-large-file']; -export type SchemaNullableIssue = components['schemas']['nullable-issue']; -export type SchemaIssueEventLabel = components['schemas']['issue-event-label']; -export type SchemaIssueEventDismissedReview = components['schemas']['issue-event-dismissed-review']; -export type SchemaIssueEventMilestone = components['schemas']['issue-event-milestone']; -export type SchemaIssueEventProjectCard = components['schemas']['issue-event-project-card']; -export type SchemaIssueEventRename = components['schemas']['issue-event-rename']; -export type SchemaIssueEvent = components['schemas']['issue-event']; -export type SchemaLabeledIssueEvent = components['schemas']['labeled-issue-event']; -export type SchemaUnlabeledIssueEvent = components['schemas']['unlabeled-issue-event']; -export type SchemaAssignedIssueEvent = components['schemas']['assigned-issue-event']; -export type SchemaUnassignedIssueEvent = components['schemas']['unassigned-issue-event']; -export type SchemaMilestonedIssueEvent = components['schemas']['milestoned-issue-event']; -export type SchemaDemilestonedIssueEvent = components['schemas']['demilestoned-issue-event']; -export type SchemaRenamedIssueEvent = components['schemas']['renamed-issue-event']; -export type SchemaReviewRequestedIssueEvent = components['schemas']['review-requested-issue-event']; -export type SchemaReviewRequestRemovedIssueEvent = components['schemas']['review-request-removed-issue-event']; -export type SchemaReviewDismissedIssueEvent = components['schemas']['review-dismissed-issue-event']; -export type SchemaLockedIssueEvent = components['schemas']['locked-issue-event']; -export type SchemaAddedToProjectIssueEvent = components['schemas']['added-to-project-issue-event']; -export type SchemaMovedColumnInProjectIssueEvent = components['schemas']['moved-column-in-project-issue-event']; -export type SchemaRemovedFromProjectIssueEvent = components['schemas']['removed-from-project-issue-event']; -export type SchemaConvertedNoteToIssueIssueEvent = components['schemas']['converted-note-to-issue-issue-event']; -export type SchemaIssueEventForIssue = components['schemas']['issue-event-for-issue']; -export type SchemaLabel = components['schemas']['label']; -export type SchemaTimelineCommentEvent = components['schemas']['timeline-comment-event']; -export type SchemaTimelineCrossReferencedEvent = components['schemas']['timeline-cross-referenced-event']; -export type SchemaTimelineCommittedEvent = components['schemas']['timeline-committed-event']; -export type SchemaTimelineReviewedEvent = components['schemas']['timeline-reviewed-event']; -export type SchemaPullRequestReviewComment = components['schemas']['pull-request-review-comment']; -export type SchemaTimelineLineCommentedEvent = components['schemas']['timeline-line-commented-event']; -export type SchemaTimelineCommitCommentedEvent = components['schemas']['timeline-commit-commented-event']; -export type SchemaTimelineAssignedIssueEvent = components['schemas']['timeline-assigned-issue-event']; -export type SchemaTimelineUnassignedIssueEvent = components['schemas']['timeline-unassigned-issue-event']; -export type SchemaStateChangeIssueEvent = components['schemas']['state-change-issue-event']; -export type SchemaTimelineIssueEvents = components['schemas']['timeline-issue-events']; -export type SchemaDeployKey = components['schemas']['deploy-key']; -export type SchemaLanguage = components['schemas']['language']; -export type SchemaLicenseContent = components['schemas']['license-content']; -export type SchemaMergedUpstream = components['schemas']['merged-upstream']; -export type SchemaMilestone = components['schemas']['milestone']; -export type SchemaPagesSourceHash = components['schemas']['pages-source-hash']; -export type SchemaPagesHttpsCertificate = components['schemas']['pages-https-certificate']; -export type SchemaPage = components['schemas']['page']; -export type SchemaPageBuild = components['schemas']['page-build']; -export type SchemaPageBuildStatus = components['schemas']['page-build-status']; -export type SchemaPageDeployment = components['schemas']['page-deployment']; -export type SchemaPagesDeploymentStatus = components['schemas']['pages-deployment-status']; -export type SchemaPagesHealthCheck = components['schemas']['pages-health-check']; -export type SchemaPullRequest = components['schemas']['pull-request']; -export type SchemaPullRequestMergeResult = components['schemas']['pull-request-merge-result']; -export type SchemaPullRequestReviewRequest = components['schemas']['pull-request-review-request']; -export type SchemaPullRequestReview = components['schemas']['pull-request-review']; -export type SchemaReviewComment = components['schemas']['review-comment']; -export type SchemaReleaseAsset = components['schemas']['release-asset']; -export type SchemaRelease = components['schemas']['release']; -export type SchemaReleaseNotesContent = components['schemas']['release-notes-content']; -export type SchemaRepositoryRuleRulesetInfo = components['schemas']['repository-rule-ruleset-info']; -export type SchemaRepositoryRuleDetailed = components['schemas']['repository-rule-detailed']; -export type SchemaSecretScanningAlert = components['schemas']['secret-scanning-alert']; -export type SchemaSecretScanningAlertResolutionComment = components['schemas']['secret-scanning-alert-resolution-comment']; -export type SchemaSecretScanningLocationCommit = components['schemas']['secret-scanning-location-commit']; -export type SchemaSecretScanningLocationWikiCommit = components['schemas']['secret-scanning-location-wiki-commit']; -export type SchemaSecretScanningLocationIssueTitle = components['schemas']['secret-scanning-location-issue-title']; -export type SchemaSecretScanningLocationIssueBody = components['schemas']['secret-scanning-location-issue-body']; -export type SchemaSecretScanningLocationIssueComment = components['schemas']['secret-scanning-location-issue-comment']; -export type SchemaSecretScanningLocationDiscussionTitle = components['schemas']['secret-scanning-location-discussion-title']; -export type SchemaSecretScanningLocationDiscussionBody = components['schemas']['secret-scanning-location-discussion-body']; -export type SchemaSecretScanningLocationDiscussionComment = components['schemas']['secret-scanning-location-discussion-comment']; -export type SchemaSecretScanningLocationPullRequestTitle = components['schemas']['secret-scanning-location-pull-request-title']; -export type SchemaSecretScanningLocationPullRequestBody = components['schemas']['secret-scanning-location-pull-request-body']; -export type SchemaSecretScanningLocationPullRequestComment = components['schemas']['secret-scanning-location-pull-request-comment']; -export type SchemaSecretScanningLocationPullRequestReview = components['schemas']['secret-scanning-location-pull-request-review']; -export type SchemaSecretScanningLocationPullRequestReviewComment = components['schemas']['secret-scanning-location-pull-request-review-comment']; -export type SchemaSecretScanningLocation = components['schemas']['secret-scanning-location']; -export type SchemaSecretScanningPushProtectionBypassReason = components['schemas']['secret-scanning-push-protection-bypass-reason']; -export type SchemaSecretScanningPushProtectionBypass = components['schemas']['secret-scanning-push-protection-bypass']; -export type SchemaSecretScanningScan = components['schemas']['secret-scanning-scan']; -export type SchemaSecretScanningScanHistory = components['schemas']['secret-scanning-scan-history']; -export type SchemaRepositoryAdvisoryCreate = components['schemas']['repository-advisory-create']; -export type SchemaPrivateVulnerabilityReportCreate = components['schemas']['private-vulnerability-report-create']; -export type SchemaRepositoryAdvisoryUpdate = components['schemas']['repository-advisory-update']; -export type SchemaStargazer = components['schemas']['stargazer']; -export type SchemaCodeFrequencyStat = components['schemas']['code-frequency-stat']; -export type SchemaCommitActivity = components['schemas']['commit-activity']; -export type SchemaContributorActivity = components['schemas']['contributor-activity']; -export type SchemaParticipationStats = components['schemas']['participation-stats']; -export type SchemaRepositorySubscription = components['schemas']['repository-subscription']; -export type SchemaTag = components['schemas']['tag']; -export type SchemaTagProtection = components['schemas']['tag-protection']; -export type SchemaTopic = components['schemas']['topic']; -export type SchemaTraffic = components['schemas']['traffic']; -export type SchemaCloneTraffic = components['schemas']['clone-traffic']; -export type SchemaContentTraffic = components['schemas']['content-traffic']; -export type SchemaReferrerTraffic = components['schemas']['referrer-traffic']; -export type SchemaViewTraffic = components['schemas']['view-traffic']; -export type SchemaSearchResultTextMatches = components['schemas']['search-result-text-matches']; -export type SchemaCodeSearchResultItem = components['schemas']['code-search-result-item']; -export type SchemaCommitSearchResultItem = components['schemas']['commit-search-result-item']; -export type SchemaIssueSearchResultItem = components['schemas']['issue-search-result-item']; -export type SchemaLabelSearchResultItem = components['schemas']['label-search-result-item']; -export type SchemaRepoSearchResultItem = components['schemas']['repo-search-result-item']; -export type SchemaTopicSearchResultItem = components['schemas']['topic-search-result-item']; -export type SchemaUserSearchResultItem = components['schemas']['user-search-result-item']; -export type SchemaPrivateUser = components['schemas']['private-user']; -export type SchemaCodespacesSecret = components['schemas']['codespaces-secret']; -export type SchemaCodespacesUserPublicKey = components['schemas']['codespaces-user-public-key']; -export type SchemaCodespaceExportDetails = components['schemas']['codespace-export-details']; -export type SchemaCodespaceWithFullRepository = components['schemas']['codespace-with-full-repository']; -export type SchemaEmail = components['schemas']['email']; -export type SchemaGpgKey = components['schemas']['gpg-key']; -export type SchemaKey = components['schemas']['key']; -export type SchemaMarketplaceAccount = components['schemas']['marketplace-account']; -export type SchemaUserMarketplacePurchase = components['schemas']['user-marketplace-purchase']; -export type SchemaSocialAccount = components['schemas']['social-account']; -export type SchemaSshSigningKey = components['schemas']['ssh-signing-key']; -export type SchemaStarredRepository = components['schemas']['starred-repository']; -export type SchemaSigstoreBundle_0 = components['schemas']['sigstore-bundle-0']; -export type SchemaHovercard = components['schemas']['hovercard']; -export type SchemaKeySimple = components['schemas']['key-simple']; -export type SchemaEnterpriseWebhooks = components['schemas']['enterprise-webhooks']; -export type SchemaSimpleInstallation = components['schemas']['simple-installation']; -export type SchemaOrganizationSimpleWebhooks = components['schemas']['organization-simple-webhooks']; -export type SchemaRepositoryWebhooks = components['schemas']['repository-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']; -export type SchemaWebhooksCodeScanningCommitOid = components['schemas']['webhooks_code_scanning_commit_oid']; -export type SchemaWebhooksCodeScanningRef = components['schemas']['webhooks_code_scanning_ref']; -export type SchemaWebhooksDeployPusherType = components['schemas']['webhooks_deploy_pusher_type']; -export type SchemaWebhooksRef_0 = components['schemas']['webhooks_ref_0']; -export type SchemaWebhooksDeployKey = components['schemas']['webhooks_deploy_key']; -export type SchemaWebhooksWorkflow = components['schemas']['webhooks_workflow']; -export type SchemaWebhooksApprover = components['schemas']['webhooks_approver']; -export type SchemaWebhooksReviewers = components['schemas']['webhooks_reviewers']; -export type SchemaWebhooksWorkflowJobRun = components['schemas']['webhooks_workflow_job_run']; -export type SchemaWebhooksUser = components['schemas']['webhooks_user']; -export type SchemaWebhooksAnswer = components['schemas']['webhooks_answer']; -export type SchemaDiscussion = components['schemas']['discussion']; -export type SchemaWebhooksComment = components['schemas']['webhooks_comment']; -export type SchemaWebhooksLabel = components['schemas']['webhooks_label']; -export type SchemaWebhooksRepositories = components['schemas']['webhooks_repositories']; -export type SchemaWebhooksRepositoriesAdded = components['schemas']['webhooks_repositories_added']; -export type SchemaWebhooksRepositorySelection = components['schemas']['webhooks_repository_selection']; -export type SchemaWebhooksIssueComment = components['schemas']['webhooks_issue_comment']; -export type SchemaWebhooksChanges = components['schemas']['webhooks_changes']; -export type SchemaWebhooksIssue = components['schemas']['webhooks_issue']; -export type SchemaWebhooksMilestone = components['schemas']['webhooks_milestone']; -export type SchemaWebhooksIssue_2 = components['schemas']['webhooks_issue_2']; -export type SchemaWebhooksUserMannequin = components['schemas']['webhooks_user_mannequin']; -export type SchemaWebhooksMarketplacePurchase = components['schemas']['webhooks_marketplace_purchase']; -export type SchemaWebhooksPreviousMarketplacePurchase = components['schemas']['webhooks_previous_marketplace_purchase']; -export type SchemaWebhooksTeam = components['schemas']['webhooks_team']; -export type SchemaMergeGroup = components['schemas']['merge-group']; -export type SchemaNullableRepositoryWebhooks = components['schemas']['nullable-repository-webhooks']; -export type SchemaWebhooksMilestone_3 = components['schemas']['webhooks_milestone_3']; -export type SchemaWebhooksMembership = components['schemas']['webhooks_membership']; -export type SchemaPersonalAccessTokenRequest = components['schemas']['personal-access-token-request']; -export type SchemaWebhooksProjectCard = components['schemas']['webhooks_project_card']; -export type SchemaWebhooksProject = components['schemas']['webhooks_project']; -export type SchemaWebhooksProjectColumn = components['schemas']['webhooks_project_column']; -export type SchemaProjectsV2 = components['schemas']['projects-v2']; -export type SchemaWebhooksProjectChanges = components['schemas']['webhooks_project_changes']; -export type SchemaProjectsV2ItemContentType = components['schemas']['projects-v2-item-content-type']; -export type SchemaProjectsV2Item = components['schemas']['projects-v2-item']; -export type SchemaProjectsV2SingleSelectOption = components['schemas']['projects-v2-single-select-option']; -export type SchemaProjectsV2IterationSetting = components['schemas']['projects-v2-iteration-setting']; -export type SchemaProjectsV2StatusUpdate = components['schemas']['projects-v2-status-update']; -export type SchemaWebhooksNumber = components['schemas']['webhooks_number']; -export type SchemaPullRequestWebhook = components['schemas']['pull-request-webhook']; -export type SchemaWebhooksPullRequest_5 = components['schemas']['webhooks_pull_request_5']; -export type SchemaWebhooksReviewComment = components['schemas']['webhooks_review_comment']; -export type SchemaWebhooksReview = components['schemas']['webhooks_review']; -export type SchemaWebhooksNullableString = components['schemas']['webhooks_nullable_string']; -export type SchemaWebhooksRelease = components['schemas']['webhooks_release']; -export type SchemaWebhooksRelease_1 = components['schemas']['webhooks_release_1']; -export type SchemaWebhooksAlert = components['schemas']['webhooks_alert']; -export type SchemaSecretScanningAlertResolutionWebhook = components['schemas']['secret-scanning-alert-resolution-webhook']; -export type SchemaSecretScanningAlertWebhook = components['schemas']['secret-scanning-alert-webhook']; -export type SchemaWebhooksSecurityAdvisory = components['schemas']['webhooks_security_advisory']; -export type SchemaWebhooksSponsorship = components['schemas']['webhooks_sponsorship']; -export type SchemaWebhooksEffectiveDate = components['schemas']['webhooks_effective_date']; -export type SchemaWebhooksChanges_8 = components['schemas']['webhooks_changes_8']; -export type SchemaWebhooksTeam_1 = components['schemas']['webhooks_team_1']; -export type SchemaWebhookBranchProtectionConfigurationDisabled = components['schemas']['webhook-branch-protection-configuration-disabled']; -export type SchemaWebhookBranchProtectionConfigurationEnabled = components['schemas']['webhook-branch-protection-configuration-enabled']; -export type SchemaWebhookBranchProtectionRuleCreated = components['schemas']['webhook-branch-protection-rule-created']; -export type SchemaWebhookBranchProtectionRuleDeleted = components['schemas']['webhook-branch-protection-rule-deleted']; -export type SchemaWebhookBranchProtectionRuleEdited = components['schemas']['webhook-branch-protection-rule-edited']; -export type SchemaWebhookCheckRunCompleted = components['schemas']['webhook-check-run-completed']; -export type SchemaWebhookCheckRunCompletedFormEncoded = components['schemas']['webhook-check-run-completed-form-encoded']; -export type SchemaWebhookCheckRunCreated = components['schemas']['webhook-check-run-created']; -export type SchemaWebhookCheckRunCreatedFormEncoded = components['schemas']['webhook-check-run-created-form-encoded']; -export type SchemaWebhookCheckRunRequestedAction = components['schemas']['webhook-check-run-requested-action']; -export type SchemaWebhookCheckRunRequestedActionFormEncoded = components['schemas']['webhook-check-run-requested-action-form-encoded']; -export type SchemaWebhookCheckRunRerequested = components['schemas']['webhook-check-run-rerequested']; -export type SchemaWebhookCheckRunRerequestedFormEncoded = components['schemas']['webhook-check-run-rerequested-form-encoded']; -export type SchemaWebhookCheckSuiteCompleted = components['schemas']['webhook-check-suite-completed']; -export type SchemaWebhookCheckSuiteRequested = components['schemas']['webhook-check-suite-requested']; -export type SchemaWebhookCheckSuiteRerequested = components['schemas']['webhook-check-suite-rerequested']; -export type SchemaWebhookCodeScanningAlertAppearedInBranch = components['schemas']['webhook-code-scanning-alert-appeared-in-branch']; -export type SchemaWebhookCodeScanningAlertClosedByUser = components['schemas']['webhook-code-scanning-alert-closed-by-user']; -export type SchemaWebhookCodeScanningAlertCreated = components['schemas']['webhook-code-scanning-alert-created']; -export type SchemaWebhookCodeScanningAlertFixed = components['schemas']['webhook-code-scanning-alert-fixed']; -export type SchemaWebhookCodeScanningAlertReopened = components['schemas']['webhook-code-scanning-alert-reopened']; -export type SchemaWebhookCodeScanningAlertReopenedByUser = components['schemas']['webhook-code-scanning-alert-reopened-by-user']; -export type SchemaWebhookCommitCommentCreated = components['schemas']['webhook-commit-comment-created']; -export type SchemaWebhookCreate = components['schemas']['webhook-create']; -export type SchemaWebhookCustomPropertyCreated = components['schemas']['webhook-custom-property-created']; -export type SchemaWebhookCustomPropertyDeleted = components['schemas']['webhook-custom-property-deleted']; -export type SchemaWebhookCustomPropertyUpdated = components['schemas']['webhook-custom-property-updated']; -export type SchemaWebhookCustomPropertyValuesUpdated = components['schemas']['webhook-custom-property-values-updated']; -export type SchemaWebhookDelete = components['schemas']['webhook-delete']; -export type SchemaWebhookDependabotAlertAutoDismissed = components['schemas']['webhook-dependabot-alert-auto-dismissed']; -export type SchemaWebhookDependabotAlertAutoReopened = components['schemas']['webhook-dependabot-alert-auto-reopened']; -export type SchemaWebhookDependabotAlertCreated = components['schemas']['webhook-dependabot-alert-created']; -export type SchemaWebhookDependabotAlertDismissed = components['schemas']['webhook-dependabot-alert-dismissed']; -export type SchemaWebhookDependabotAlertFixed = components['schemas']['webhook-dependabot-alert-fixed']; -export type SchemaWebhookDependabotAlertReintroduced = components['schemas']['webhook-dependabot-alert-reintroduced']; -export type SchemaWebhookDependabotAlertReopened = components['schemas']['webhook-dependabot-alert-reopened']; -export type SchemaWebhookDeployKeyCreated = components['schemas']['webhook-deploy-key-created']; -export type SchemaWebhookDeployKeyDeleted = components['schemas']['webhook-deploy-key-deleted']; -export type SchemaWebhookDeploymentCreated = components['schemas']['webhook-deployment-created']; -export type SchemaWebhookDeploymentProtectionRuleRequested = components['schemas']['webhook-deployment-protection-rule-requested']; -export type SchemaWebhookDeploymentReviewApproved = components['schemas']['webhook-deployment-review-approved']; -export type SchemaWebhookDeploymentReviewRejected = components['schemas']['webhook-deployment-review-rejected']; -export type SchemaWebhookDeploymentReviewRequested = components['schemas']['webhook-deployment-review-requested']; -export type SchemaWebhookDeploymentStatusCreated = components['schemas']['webhook-deployment-status-created']; -export type SchemaWebhookDiscussionAnswered = components['schemas']['webhook-discussion-answered']; -export type SchemaWebhookDiscussionCategoryChanged = components['schemas']['webhook-discussion-category-changed']; -export type SchemaWebhookDiscussionClosed = components['schemas']['webhook-discussion-closed']; -export type SchemaWebhookDiscussionCommentCreated = components['schemas']['webhook-discussion-comment-created']; -export type SchemaWebhookDiscussionCommentDeleted = components['schemas']['webhook-discussion-comment-deleted']; -export type SchemaWebhookDiscussionCommentEdited = components['schemas']['webhook-discussion-comment-edited']; -export type SchemaWebhookDiscussionCreated = components['schemas']['webhook-discussion-created']; -export type SchemaWebhookDiscussionDeleted = components['schemas']['webhook-discussion-deleted']; -export type SchemaWebhookDiscussionEdited = components['schemas']['webhook-discussion-edited']; -export type SchemaWebhookDiscussionLabeled = components['schemas']['webhook-discussion-labeled']; -export type SchemaWebhookDiscussionLocked = components['schemas']['webhook-discussion-locked']; -export type SchemaWebhookDiscussionPinned = components['schemas']['webhook-discussion-pinned']; -export type SchemaWebhookDiscussionReopened = components['schemas']['webhook-discussion-reopened']; -export type SchemaWebhookDiscussionTransferred = components['schemas']['webhook-discussion-transferred']; -export type SchemaWebhookDiscussionUnanswered = components['schemas']['webhook-discussion-unanswered']; -export type SchemaWebhookDiscussionUnlabeled = components['schemas']['webhook-discussion-unlabeled']; -export type SchemaWebhookDiscussionUnlocked = components['schemas']['webhook-discussion-unlocked']; -export type SchemaWebhookDiscussionUnpinned = components['schemas']['webhook-discussion-unpinned']; -export type SchemaWebhookFork = components['schemas']['webhook-fork']; -export type SchemaWebhookGithubAppAuthorizationRevoked = components['schemas']['webhook-github-app-authorization-revoked']; -export type SchemaWebhookGollum = components['schemas']['webhook-gollum']; -export type SchemaWebhookInstallationCreated = components['schemas']['webhook-installation-created']; -export type SchemaWebhookInstallationDeleted = components['schemas']['webhook-installation-deleted']; -export type SchemaWebhookInstallationNewPermissionsAccepted = components['schemas']['webhook-installation-new-permissions-accepted']; -export type SchemaWebhookInstallationRepositoriesAdded = components['schemas']['webhook-installation-repositories-added']; -export type SchemaWebhookInstallationRepositoriesRemoved = components['schemas']['webhook-installation-repositories-removed']; -export type SchemaWebhookInstallationSuspend = components['schemas']['webhook-installation-suspend']; -export type SchemaWebhookInstallationTargetRenamed = components['schemas']['webhook-installation-target-renamed']; -export type SchemaWebhookInstallationUnsuspend = components['schemas']['webhook-installation-unsuspend']; -export type SchemaWebhookIssueCommentCreated = components['schemas']['webhook-issue-comment-created']; -export type SchemaWebhookIssueCommentDeleted = components['schemas']['webhook-issue-comment-deleted']; -export type SchemaWebhookIssueCommentEdited = components['schemas']['webhook-issue-comment-edited']; -export type SchemaWebhookIssuesAssigned = components['schemas']['webhook-issues-assigned']; -export type SchemaWebhookIssuesClosed = components['schemas']['webhook-issues-closed']; -export type SchemaWebhookIssuesDeleted = components['schemas']['webhook-issues-deleted']; -export type SchemaWebhookIssuesDemilestoned = components['schemas']['webhook-issues-demilestoned']; -export type SchemaWebhookIssuesEdited = components['schemas']['webhook-issues-edited']; -export type SchemaWebhookIssuesLabeled = components['schemas']['webhook-issues-labeled']; -export type SchemaWebhookIssuesLocked = components['schemas']['webhook-issues-locked']; -export type SchemaWebhookIssuesMilestoned = components['schemas']['webhook-issues-milestoned']; -export type SchemaWebhookIssuesOpened = components['schemas']['webhook-issues-opened']; -export type SchemaWebhookIssuesPinned = components['schemas']['webhook-issues-pinned']; -export type SchemaWebhookIssuesReopened = components['schemas']['webhook-issues-reopened']; -export type SchemaWebhookIssuesTransferred = components['schemas']['webhook-issues-transferred']; -export type SchemaWebhookIssuesUnassigned = components['schemas']['webhook-issues-unassigned']; -export type SchemaWebhookIssuesUnlabeled = components['schemas']['webhook-issues-unlabeled']; -export type SchemaWebhookIssuesUnlocked = components['schemas']['webhook-issues-unlocked']; -export type SchemaWebhookIssuesUnpinned = components['schemas']['webhook-issues-unpinned']; -export type SchemaWebhookLabelCreated = components['schemas']['webhook-label-created']; -export type SchemaWebhookLabelDeleted = components['schemas']['webhook-label-deleted']; -export type SchemaWebhookLabelEdited = components['schemas']['webhook-label-edited']; -export type SchemaWebhookMarketplacePurchaseCancelled = components['schemas']['webhook-marketplace-purchase-cancelled']; -export type SchemaWebhookMarketplacePurchaseChanged = components['schemas']['webhook-marketplace-purchase-changed']; -export type SchemaWebhookMarketplacePurchasePendingChange = components['schemas']['webhook-marketplace-purchase-pending-change']; -export type SchemaWebhookMarketplacePurchasePendingChangeCancelled = components['schemas']['webhook-marketplace-purchase-pending-change-cancelled']; -export type SchemaWebhookMarketplacePurchasePurchased = components['schemas']['webhook-marketplace-purchase-purchased']; -export type SchemaWebhookMemberAdded = components['schemas']['webhook-member-added']; -export type SchemaWebhookMemberEdited = components['schemas']['webhook-member-edited']; -export type SchemaWebhookMemberRemoved = components['schemas']['webhook-member-removed']; -export type SchemaWebhookMembershipAdded = components['schemas']['webhook-membership-added']; -export type SchemaWebhookMembershipRemoved = components['schemas']['webhook-membership-removed']; -export type SchemaWebhookMergeGroupChecksRequested = components['schemas']['webhook-merge-group-checks-requested']; -export type SchemaWebhookMergeGroupDestroyed = components['schemas']['webhook-merge-group-destroyed']; -export type SchemaWebhookMetaDeleted = components['schemas']['webhook-meta-deleted']; -export type SchemaWebhookMilestoneClosed = components['schemas']['webhook-milestone-closed']; -export type SchemaWebhookMilestoneCreated = components['schemas']['webhook-milestone-created']; -export type SchemaWebhookMilestoneDeleted = components['schemas']['webhook-milestone-deleted']; -export type SchemaWebhookMilestoneEdited = components['schemas']['webhook-milestone-edited']; -export type SchemaWebhookMilestoneOpened = components['schemas']['webhook-milestone-opened']; -export type SchemaWebhookOrgBlockBlocked = components['schemas']['webhook-org-block-blocked']; -export type SchemaWebhookOrgBlockUnblocked = components['schemas']['webhook-org-block-unblocked']; -export type SchemaWebhookOrganizationDeleted = components['schemas']['webhook-organization-deleted']; -export type SchemaWebhookOrganizationMemberAdded = components['schemas']['webhook-organization-member-added']; -export type SchemaWebhookOrganizationMemberInvited = components['schemas']['webhook-organization-member-invited']; -export type SchemaWebhookOrganizationMemberRemoved = components['schemas']['webhook-organization-member-removed']; -export type SchemaWebhookOrganizationRenamed = components['schemas']['webhook-organization-renamed']; -export type SchemaWebhookRubygemsMetadata = components['schemas']['webhook-rubygems-metadata']; -export type SchemaWebhookPackagePublished = components['schemas']['webhook-package-published']; -export type SchemaWebhookPackageUpdated = components['schemas']['webhook-package-updated']; -export type SchemaWebhookPageBuild = components['schemas']['webhook-page-build']; -export type SchemaWebhookPersonalAccessTokenRequestApproved = components['schemas']['webhook-personal-access-token-request-approved']; -export type SchemaWebhookPersonalAccessTokenRequestCancelled = components['schemas']['webhook-personal-access-token-request-cancelled']; -export type SchemaWebhookPersonalAccessTokenRequestCreated = components['schemas']['webhook-personal-access-token-request-created']; -export type SchemaWebhookPersonalAccessTokenRequestDenied = components['schemas']['webhook-personal-access-token-request-denied']; -export type SchemaWebhookPing = components['schemas']['webhook-ping']; -export type SchemaWebhookPingFormEncoded = components['schemas']['webhook-ping-form-encoded']; -export type SchemaWebhookProjectCardConverted = components['schemas']['webhook-project-card-converted']; -export type SchemaWebhookProjectCardCreated = components['schemas']['webhook-project-card-created']; -export type SchemaWebhookProjectCardDeleted = components['schemas']['webhook-project-card-deleted']; -export type SchemaWebhookProjectCardEdited = components['schemas']['webhook-project-card-edited']; -export type SchemaWebhookProjectCardMoved = components['schemas']['webhook-project-card-moved']; -export type SchemaWebhookProjectClosed = components['schemas']['webhook-project-closed']; -export type SchemaWebhookProjectColumnCreated = components['schemas']['webhook-project-column-created']; -export type SchemaWebhookProjectColumnDeleted = components['schemas']['webhook-project-column-deleted']; -export type SchemaWebhookProjectColumnEdited = components['schemas']['webhook-project-column-edited']; -export type SchemaWebhookProjectColumnMoved = components['schemas']['webhook-project-column-moved']; -export type SchemaWebhookProjectCreated = components['schemas']['webhook-project-created']; -export type SchemaWebhookProjectDeleted = components['schemas']['webhook-project-deleted']; -export type SchemaWebhookProjectEdited = components['schemas']['webhook-project-edited']; -export type SchemaWebhookProjectReopened = components['schemas']['webhook-project-reopened']; -export type SchemaWebhookProjectsV2ProjectClosed = components['schemas']['webhook-projects-v2-project-closed']; -export type SchemaWebhookProjectsV2ProjectCreated = components['schemas']['webhook-projects-v2-project-created']; -export type SchemaWebhookProjectsV2ProjectDeleted = components['schemas']['webhook-projects-v2-project-deleted']; -export type SchemaWebhookProjectsV2ProjectEdited = components['schemas']['webhook-projects-v2-project-edited']; -export type SchemaWebhookProjectsV2ItemArchived = components['schemas']['webhook-projects-v2-item-archived']; -export type SchemaWebhookProjectsV2ItemConverted = components['schemas']['webhook-projects-v2-item-converted']; -export type SchemaWebhookProjectsV2ItemCreated = components['schemas']['webhook-projects-v2-item-created']; -export type SchemaWebhookProjectsV2ItemDeleted = components['schemas']['webhook-projects-v2-item-deleted']; -export type SchemaWebhookProjectsV2ItemEdited = components['schemas']['webhook-projects-v2-item-edited']; -export type SchemaWebhookProjectsV2ItemReordered = components['schemas']['webhook-projects-v2-item-reordered']; -export type SchemaWebhookProjectsV2ItemRestored = components['schemas']['webhook-projects-v2-item-restored']; -export type SchemaWebhookProjectsV2ProjectReopened = components['schemas']['webhook-projects-v2-project-reopened']; -export type SchemaWebhookProjectsV2StatusUpdateCreated = components['schemas']['webhook-projects-v2-status-update-created']; -export type SchemaWebhookProjectsV2StatusUpdateDeleted = components['schemas']['webhook-projects-v2-status-update-deleted']; -export type SchemaWebhookProjectsV2StatusUpdateEdited = components['schemas']['webhook-projects-v2-status-update-edited']; -export type SchemaWebhookPublic = components['schemas']['webhook-public']; -export type SchemaWebhookPullRequestAssigned = components['schemas']['webhook-pull-request-assigned']; -export type SchemaWebhookPullRequestAutoMergeDisabled = components['schemas']['webhook-pull-request-auto-merge-disabled']; -export type SchemaWebhookPullRequestAutoMergeEnabled = components['schemas']['webhook-pull-request-auto-merge-enabled']; -export type SchemaWebhookPullRequestClosed = components['schemas']['webhook-pull-request-closed']; -export type SchemaWebhookPullRequestConvertedToDraft = components['schemas']['webhook-pull-request-converted-to-draft']; -export type SchemaWebhookPullRequestDemilestoned = components['schemas']['webhook-pull-request-demilestoned']; -export type SchemaWebhookPullRequestDequeued = components['schemas']['webhook-pull-request-dequeued']; -export type SchemaWebhookPullRequestEdited = components['schemas']['webhook-pull-request-edited']; -export type SchemaWebhookPullRequestEnqueued = components['schemas']['webhook-pull-request-enqueued']; -export type SchemaWebhookPullRequestLabeled = components['schemas']['webhook-pull-request-labeled']; -export type SchemaWebhookPullRequestLocked = components['schemas']['webhook-pull-request-locked']; -export type SchemaWebhookPullRequestMilestoned = components['schemas']['webhook-pull-request-milestoned']; -export type SchemaWebhookPullRequestOpened = components['schemas']['webhook-pull-request-opened']; -export type SchemaWebhookPullRequestReadyForReview = components['schemas']['webhook-pull-request-ready-for-review']; -export type SchemaWebhookPullRequestReopened = components['schemas']['webhook-pull-request-reopened']; -export type SchemaWebhookPullRequestReviewCommentCreated = components['schemas']['webhook-pull-request-review-comment-created']; -export type SchemaWebhookPullRequestReviewCommentDeleted = components['schemas']['webhook-pull-request-review-comment-deleted']; -export type SchemaWebhookPullRequestReviewCommentEdited = components['schemas']['webhook-pull-request-review-comment-edited']; -export type SchemaWebhookPullRequestReviewDismissed = components['schemas']['webhook-pull-request-review-dismissed']; -export type SchemaWebhookPullRequestReviewEdited = components['schemas']['webhook-pull-request-review-edited']; -export type SchemaWebhookPullRequestReviewRequestRemoved = components['schemas']['webhook-pull-request-review-request-removed']; -export type SchemaWebhookPullRequestReviewRequested = components['schemas']['webhook-pull-request-review-requested']; -export type SchemaWebhookPullRequestReviewSubmitted = components['schemas']['webhook-pull-request-review-submitted']; -export type SchemaWebhookPullRequestReviewThreadResolved = components['schemas']['webhook-pull-request-review-thread-resolved']; -export type SchemaWebhookPullRequestReviewThreadUnresolved = components['schemas']['webhook-pull-request-review-thread-unresolved']; -export type SchemaWebhookPullRequestSynchronize = components['schemas']['webhook-pull-request-synchronize']; -export type SchemaWebhookPullRequestUnassigned = components['schemas']['webhook-pull-request-unassigned']; -export type SchemaWebhookPullRequestUnlabeled = components['schemas']['webhook-pull-request-unlabeled']; -export type SchemaWebhookPullRequestUnlocked = components['schemas']['webhook-pull-request-unlocked']; -export type SchemaWebhookPush = components['schemas']['webhook-push']; -export type SchemaWebhookRegistryPackagePublished = components['schemas']['webhook-registry-package-published']; -export type SchemaWebhookRegistryPackageUpdated = components['schemas']['webhook-registry-package-updated']; -export type SchemaWebhookReleaseCreated = components['schemas']['webhook-release-created']; -export type SchemaWebhookReleaseDeleted = components['schemas']['webhook-release-deleted']; -export type SchemaWebhookReleaseEdited = components['schemas']['webhook-release-edited']; -export type SchemaWebhookReleasePrereleased = components['schemas']['webhook-release-prereleased']; -export type SchemaWebhookReleasePublished = components['schemas']['webhook-release-published']; -export type SchemaWebhookReleaseReleased = components['schemas']['webhook-release-released']; -export type SchemaWebhookReleaseUnpublished = components['schemas']['webhook-release-unpublished']; -export type SchemaWebhookRepositoryAdvisoryPublished = components['schemas']['webhook-repository-advisory-published']; -export type SchemaWebhookRepositoryAdvisoryReported = components['schemas']['webhook-repository-advisory-reported']; -export type SchemaWebhookRepositoryArchived = components['schemas']['webhook-repository-archived']; -export type SchemaWebhookRepositoryCreated = components['schemas']['webhook-repository-created']; -export type SchemaWebhookRepositoryDeleted = components['schemas']['webhook-repository-deleted']; -export type SchemaWebhookRepositoryDispatchSample = components['schemas']['webhook-repository-dispatch-sample']; -export type SchemaWebhookRepositoryEdited = components['schemas']['webhook-repository-edited']; -export type SchemaWebhookRepositoryImport = components['schemas']['webhook-repository-import']; -export type SchemaWebhookRepositoryPrivatized = components['schemas']['webhook-repository-privatized']; -export type SchemaWebhookRepositoryPublicized = components['schemas']['webhook-repository-publicized']; -export type SchemaWebhookRepositoryRenamed = components['schemas']['webhook-repository-renamed']; -export type SchemaWebhookRepositoryRulesetCreated = components['schemas']['webhook-repository-ruleset-created']; -export type SchemaWebhookRepositoryRulesetDeleted = components['schemas']['webhook-repository-ruleset-deleted']; -export type SchemaWebhookRepositoryRulesetEdited = components['schemas']['webhook-repository-ruleset-edited']; -export type SchemaWebhookRepositoryTransferred = components['schemas']['webhook-repository-transferred']; -export type SchemaWebhookRepositoryUnarchived = components['schemas']['webhook-repository-unarchived']; -export type SchemaWebhookRepositoryVulnerabilityAlertCreate = components['schemas']['webhook-repository-vulnerability-alert-create']; -export type SchemaWebhookRepositoryVulnerabilityAlertDismiss = components['schemas']['webhook-repository-vulnerability-alert-dismiss']; -export type SchemaWebhookRepositoryVulnerabilityAlertReopen = components['schemas']['webhook-repository-vulnerability-alert-reopen']; -export type SchemaWebhookRepositoryVulnerabilityAlertResolve = components['schemas']['webhook-repository-vulnerability-alert-resolve']; -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']; -export type SchemaWebhookSecretScanningScanCompleted = components['schemas']['webhook-secret-scanning-scan-completed']; -export type SchemaWebhookSecurityAdvisoryPublished = components['schemas']['webhook-security-advisory-published']; -export type SchemaWebhookSecurityAdvisoryUpdated = components['schemas']['webhook-security-advisory-updated']; -export type SchemaWebhookSecurityAdvisoryWithdrawn = components['schemas']['webhook-security-advisory-withdrawn']; -export type SchemaWebhookSecurityAndAnalysis = components['schemas']['webhook-security-and-analysis']; -export type SchemaWebhookSponsorshipCancelled = components['schemas']['webhook-sponsorship-cancelled']; -export type SchemaWebhookSponsorshipCreated = components['schemas']['webhook-sponsorship-created']; -export type SchemaWebhookSponsorshipEdited = components['schemas']['webhook-sponsorship-edited']; -export type SchemaWebhookSponsorshipPendingCancellation = components['schemas']['webhook-sponsorship-pending-cancellation']; -export type SchemaWebhookSponsorshipPendingTierChange = components['schemas']['webhook-sponsorship-pending-tier-change']; -export type SchemaWebhookSponsorshipTierChanged = components['schemas']['webhook-sponsorship-tier-changed']; -export type SchemaWebhookStarCreated = components['schemas']['webhook-star-created']; -export type SchemaWebhookStarDeleted = components['schemas']['webhook-star-deleted']; -export type SchemaWebhookStatus = components['schemas']['webhook-status']; -export type SchemaWebhookSubIssuesParentIssueAdded = components['schemas']['webhook-sub-issues-parent-issue-added']; -export type SchemaWebhookSubIssuesParentIssueRemoved = components['schemas']['webhook-sub-issues-parent-issue-removed']; -export type SchemaWebhookSubIssuesSubIssueAdded = components['schemas']['webhook-sub-issues-sub-issue-added']; -export type SchemaWebhookSubIssuesSubIssueRemoved = components['schemas']['webhook-sub-issues-sub-issue-removed']; -export type SchemaWebhookTeamAdd = components['schemas']['webhook-team-add']; -export type SchemaWebhookTeamAddedToRepository = components['schemas']['webhook-team-added-to-repository']; -export type SchemaWebhookTeamCreated = components['schemas']['webhook-team-created']; -export type SchemaWebhookTeamDeleted = components['schemas']['webhook-team-deleted']; -export type SchemaWebhookTeamEdited = components['schemas']['webhook-team-edited']; -export type SchemaWebhookTeamRemovedFromRepository = components['schemas']['webhook-team-removed-from-repository']; -export type SchemaWebhookWatchStarted = components['schemas']['webhook-watch-started']; -export type SchemaWebhookWorkflowDispatch = components['schemas']['webhook-workflow-dispatch']; -export type SchemaWebhookWorkflowJobCompleted = components['schemas']['webhook-workflow-job-completed']; -export type SchemaWebhookWorkflowJobInProgress = components['schemas']['webhook-workflow-job-in-progress']; -export type SchemaWebhookWorkflowJobQueued = components['schemas']['webhook-workflow-job-queued']; -export type SchemaWebhookWorkflowJobWaiting = components['schemas']['webhook-workflow-job-waiting']; -export type SchemaWebhookWorkflowRunCompleted = components['schemas']['webhook-workflow-run-completed']; -export type SchemaWebhookWorkflowRunInProgress = components['schemas']['webhook-workflow-run-in-progress']; -export type SchemaWebhookWorkflowRunRequested = components['schemas']['webhook-workflow-run-requested']; -export type ResponseValidationFailedSimple = components['responses']['validation_failed_simple']; -export type ResponseNotFound = components['responses']['not_found']; -export type ResponseBadRequest = components['responses']['bad_request']; -export type ResponseValidationFailed = components['responses']['validation_failed']; -export type ResponseAccepted = components['responses']['accepted']; -export type ResponseNotModified = components['responses']['not_modified']; -export type ResponseRequiresAuthentication = components['responses']['requires_authentication']; -export type ResponseForbidden = components['responses']['forbidden']; -export type ResponseConflict = components['responses']['conflict']; -export type ResponseNoContent = components['responses']['no_content']; -export type ResponseServiceUnavailable = components['responses']['service_unavailable']; -export type ResponseForbiddenGist = components['responses']['forbidden_gist']; -export type ResponseMovedPermanently = components['responses']['moved_permanently']; -export type ResponseBillingUsageReportOrg = components['responses']['billing_usage_report_org']; -export type ResponseInternalError = components['responses']['internal_error']; -export type ResponseActionsRunnerJitconfig = components['responses']['actions_runner_jitconfig']; -export type ResponseActionsRunnerLabels = components['responses']['actions_runner_labels']; -export type ResponseActionsRunnerLabelsReadonly = components['responses']['actions_runner_labels_readonly']; -export type ResponseUsageMetricsApiDisabled = components['responses']['usage_metrics_api_disabled']; -export type ResponsePackageEsListError = components['responses']['package_es_list_error']; -export type ResponseGone = components['responses']['gone']; -export type ResponseTemporaryRedirect = components['responses']['temporary_redirect']; -export type ResponseCodeScanningForbiddenRead = components['responses']['code_scanning_forbidden_read']; -export type ResponseCodeScanningForbiddenWrite = components['responses']['code_scanning_forbidden_write']; -export type ResponseCodeScanningBadRequest = components['responses']['code_scanning_bad_request']; -export type ResponseCodeScanningAutofixCreateForbidden = components['responses']['code_scanning_autofix_create_forbidden']; -export type ResponseFound = components['responses']['found']; -export type ResponseCodeScanningConflict = components['responses']['code_scanning_conflict']; -export type ResponseDependencyReviewForbidden = components['responses']['dependency_review_forbidden']; -export type ResponsePorterMaintenance = components['responses']['porter_maintenance']; -export type ResponseUnacceptable = components['responses']['unacceptable']; -export type ParameterPaginationBefore = components['parameters']['pagination-before']; -export type ParameterPaginationAfter = components['parameters']['pagination-after']; -export type ParameterDirection = components['parameters']['direction']; -export type ParameterGhsaId = components['parameters']['ghsa_id']; -export type ParameterPerPage = components['parameters']['per-page']; -export type ParameterCursor = components['parameters']['cursor']; -export type ParameterDeliveryId = components['parameters']['delivery-id']; -export type ParameterPage = components['parameters']['page']; -export type ParameterSince = components['parameters']['since']; -export type ParameterInstallationId = components['parameters']['installation-id']; -export type ParameterClientId = components['parameters']['client-id']; -export type ParameterAppSlug = components['parameters']['app-slug']; -export type ParameterAssignmentId = components['parameters']['assignment-id']; -export type ParameterClassroomId = components['parameters']['classroom-id']; -export type ParameterEnterprise = components['parameters']['enterprise']; -export type ParameterConfigurationId = components['parameters']['configuration-id']; -export type ParameterDependabotAlertCommaSeparatedStates = components['parameters']['dependabot-alert-comma-separated-states']; -export type ParameterDependabotAlertCommaSeparatedSeverities = components['parameters']['dependabot-alert-comma-separated-severities']; -export type ParameterDependabotAlertCommaSeparatedEcosystems = components['parameters']['dependabot-alert-comma-separated-ecosystems']; -export type ParameterDependabotAlertCommaSeparatedPackages = components['parameters']['dependabot-alert-comma-separated-packages']; -export type ParameterDependabotAlertCommaSeparatedEpss = components['parameters']['dependabot-alert-comma-separated-epss']; -export type ParameterDependabotAlertScope = components['parameters']['dependabot-alert-scope']; -export type ParameterDependabotAlertSort = components['parameters']['dependabot-alert-sort']; -export type ParameterPaginationFirst = components['parameters']['pagination-first']; -export type ParameterPaginationLast = components['parameters']['pagination-last']; -export type ParameterSecretScanningAlertState = components['parameters']['secret-scanning-alert-state']; -export type ParameterSecretScanningAlertSecretType = components['parameters']['secret-scanning-alert-secret-type']; -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 ParameterGistId = components['parameters']['gist-id']; -export type ParameterCommentId = components['parameters']['comment-id']; -export type ParameterLabels = components['parameters']['labels']; -export type ParameterAccountId = components['parameters']['account-id']; -export type ParameterPlanId = components['parameters']['plan-id']; -export type ParameterSort = components['parameters']['sort']; -export type ParameterOwner = components['parameters']['owner']; -export type ParameterRepo = components['parameters']['repo']; -export type ParameterAll = components['parameters']['all']; -export type ParameterParticipating = components['parameters']['participating']; -export type ParameterBefore = components['parameters']['before']; -export type ParameterThreadId = components['parameters']['thread-id']; -export type ParameterSinceOrg = components['parameters']['since-org']; -export type ParameterOrg = components['parameters']['org']; -export type ParameterBillingUsageReportYear = components['parameters']['billing-usage-report-year']; -export type ParameterBillingUsageReportMonth = components['parameters']['billing-usage-report-month']; -export type ParameterBillingUsageReportDay = components['parameters']['billing-usage-report-day']; -export type ParameterBillingUsageReportHour = components['parameters']['billing-usage-report-hour']; -export type ParameterHostedRunnerId = components['parameters']['hosted-runner-id']; -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']; -export type ParameterVariablesPerPage = components['parameters']['variables-per-page']; -export type ParameterVariableName = components['parameters']['variable-name']; -export type ParameterUsername = components['parameters']['username']; -export type ParameterToolName = components['parameters']['tool-name']; -export type ParameterToolGuid = components['parameters']['tool-guid']; -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 ParameterApiInsightsApiRouteSubstring = components['parameters']['api-insights-api-route-substring']; -export type ParameterApiInsightsSort = components['parameters']['api-insights-sort']; -export type ParameterApiInsightsSubjectNameSubstring = components['parameters']['api-insights-subject-name-substring']; -export type ParameterApiInsightsUserId = components['parameters']['api-insights-user-id']; -export type ParameterApiInsightsTimestampIncrement = components['parameters']['api-insights-timestamp-increment']; -export type ParameterApiInsightsActorNameSubstring = components['parameters']['api-insights-actor-name-substring']; -export type ParameterInvitationId = components['parameters']['invitation-id']; -export type ParameterCodespaceName = components['parameters']['codespace-name']; -export type ParameterMigrationId = components['parameters']['migration-id']; -export type ParameterRepoName = components['parameters']['repo-name']; -export type ParameterTeamSlug = components['parameters']['team-slug']; -export type ParameterRoleId = components['parameters']['role-id']; -export type ParameterPackageVisibility = components['parameters']['package-visibility']; -export type ParameterPackageType = components['parameters']['package-type']; -export type ParameterPackageName = components['parameters']['package-name']; -export type ParameterPackageVersionId = components['parameters']['package-version-id']; -export type ParameterPersonalAccessTokenSort = components['parameters']['personal-access-token-sort']; -export type ParameterPersonalAccessTokenOwner = components['parameters']['personal-access-token-owner']; -export type ParameterPersonalAccessTokenRepository = components['parameters']['personal-access-token-repository']; -export type ParameterPersonalAccessTokenPermission = components['parameters']['personal-access-token-permission']; -export type ParameterPersonalAccessTokenBefore = components['parameters']['personal-access-token-before']; -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']; -export type ParameterActorNameInQuery = components['parameters']['actor-name-in-query']; -export type ParameterRuleSuiteResult = components['parameters']['rule-suite-result']; -export type ParameterRuleSuiteId = components['parameters']['rule-suite-id']; -export type ParameterSecretScanningPaginationBeforeOrgRepo = components['parameters']['secret-scanning-pagination-before-org-repo']; -export type ParameterSecretScanningPaginationAfterOrgRepo = components['parameters']['secret-scanning-pagination-after-org-repo']; -export type ParameterNetworkConfigurationId = components['parameters']['network-configuration-id']; -export type ParameterNetworkSettingsId = components['parameters']['network-settings-id']; -export type ParameterDiscussionNumber = components['parameters']['discussion-number']; -export type ParameterCommentNumber = components['parameters']['comment-number']; -export type ParameterReactionId = components['parameters']['reaction-id']; -export type ParameterProjectId = components['parameters']['project-id']; -export type ParameterSecurityProduct = components['parameters']['security-product']; -export type ParameterOrgSecurityProductEnablement = components['parameters']['org-security-product-enablement']; -export type ParameterCardId = components['parameters']['card-id']; -export type ParameterColumnId = components['parameters']['column-id']; -export type ParameterArtifactName = components['parameters']['artifact-name']; -export type ParameterArtifactId = components['parameters']['artifact-id']; -export type ParameterActionsCacheGitRefFull = components['parameters']['actions-cache-git-ref-full']; -export type ParameterActionsCacheKey = components['parameters']['actions-cache-key']; -export type ParameterActionsCacheListSort = components['parameters']['actions-cache-list-sort']; -export type ParameterActionsCacheKeyRequired = components['parameters']['actions-cache-key-required']; -export type ParameterCacheId = components['parameters']['cache-id']; -export type ParameterJobId = components['parameters']['job-id']; -export type ParameterActor = components['parameters']['actor']; -export type ParameterWorkflowRunBranch = components['parameters']['workflow-run-branch']; -export type ParameterEvent = components['parameters']['event']; -export type ParameterWorkflowRunStatus = components['parameters']['workflow-run-status']; -export type ParameterCreated = components['parameters']['created']; -export type ParameterExcludePullRequests = components['parameters']['exclude-pull-requests']; -export type ParameterWorkflowRunCheckSuiteId = components['parameters']['workflow-run-check-suite-id']; -export type ParameterWorkflowRunHeadSha = components['parameters']['workflow-run-head-sha']; -export type ParameterRunId = components['parameters']['run-id']; -export type ParameterAttemptNumber = components['parameters']['attempt-number']; -export type ParameterWorkflowId = components['parameters']['workflow-id']; -export type ParameterAutolinkId = components['parameters']['autolink-id']; -export type ParameterBranch = components['parameters']['branch']; -export type ParameterCheckRunId = components['parameters']['check-run-id']; -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']; -export type ParameterDependabotAlertCommaSeparatedManifests = components['parameters']['dependabot-alert-comma-separated-manifests']; -export type ParameterDependabotAlertNumber = components['parameters']['dependabot-alert-number']; -export type ParameterManifestPath = components['parameters']['manifest-path']; -export type ParameterDeploymentId = components['parameters']['deployment-id']; -export type ParameterEnvironmentName = components['parameters']['environment-name']; -export type ParameterBranchPolicyId = components['parameters']['branch-policy-id']; -export type ParameterProtectionRuleId = components['parameters']['protection-rule-id']; -export type ParameterGitRefOnly = components['parameters']['git-ref-only']; -export type ParameterSinceUser = components['parameters']['since-user']; -export type ParameterIssueNumber = components['parameters']['issue-number']; -export type ParameterKeyId = components['parameters']['key-id']; -export type ParameterMilestoneNumber = components['parameters']['milestone-number']; -export type ParameterPagesDeploymentId = components['parameters']['pages-deployment-id']; -export type ParameterPullNumber = components['parameters']['pull-number']; -export type ParameterReviewId = components['parameters']['review-id']; -export type ParameterAssetId = components['parameters']['asset-id']; -export type ParameterReleaseId = components['parameters']['release-id']; -export type ParameterTagProtectionId = components['parameters']['tag-protection-id']; -export type ParameterPer = components['parameters']['per']; -export type ParameterSinceRepo = components['parameters']['since-repo']; -export type ParameterOrder = components['parameters']['order']; -export type ParameterTeamId = components['parameters']['team-id']; -export type ParameterRepositoryIdInQuery = components['parameters']['repository-id-in-query']; -export type ParameterExportId = components['parameters']['export-id']; -export type ParameterGpgKeyId = components['parameters']['gpg-key-id']; -export type ParameterSinceRepoDate = components['parameters']['since-repo-date']; -export type ParameterBeforeRepoDate = components['parameters']['before-repo-date']; -export type ParameterSshSigningKeyId = components['parameters']['ssh-signing-key-id']; -export type ParameterSortStarred = components['parameters']['sort-starred']; -export type HeaderLink = components['headers']['link']; -export type HeaderContentType = components['headers']['content-type']; -export type HeaderXCommonMarkerVersion = components['headers']['x-common-marker-version']; -export type HeaderXRateLimitLimit = components['headers']['x-rate-limit-limit']; -export type HeaderXRateLimitRemaining = components['headers']['x-rate-limit-remaining']; -export type HeaderXRateLimitReset = components['headers']['x-rate-limit-reset']; -export type HeaderLocation = components['headers']['location']; export type $defs = Record; export interface operations { "meta/root": { @@ -89131,7 +93241,7 @@ export interface operations { * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; /** @@ -89955,12 +94065,134 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "codes-of-conduct/get-conduct-code": { + "codes-of-conduct/get-conduct-code": { + parameters: { + query?: never; + header?: never; + path: { + key: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + }; + }; + "credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of credentials to be revoked, up to 1000 per request. */ + credentials: string[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; + }; + }; + "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: string; + }; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + "actions/get-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-enterprise": { parameters: { query?: never; header?: never; path: { - key: string; + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; cookie?: never; }; @@ -89972,34 +94204,39 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-of-conduct"]; + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; }; }; - 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "emojis/get": { + "actions/set-actions-cache-storage-limit-for-enterprise": { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - [key: string]: string; - }; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; "code-security/get-configurations-for-enterprise": { @@ -90014,7 +94251,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -90039,7 +94276,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -90052,11 +94289,19 @@ export interface operations { /** @description A description of the code security configuration */ description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled @@ -90089,6 +94334,7 @@ export interface operations { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled @@ -90096,6 +94342,17 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled @@ -90120,6 +94377,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -90155,7 +94430,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -90178,7 +94453,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -90206,7 +94481,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -90227,7 +94502,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -90242,10 +94517,18 @@ export interface operations { /** @description A description of the code security configuration */ description?: string; /** - * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -90277,6 +94560,18 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -90297,6 +94592,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -90331,7 +94644,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -90342,7 +94655,7 @@ export interface operations { content: { "application/json": { /** - * @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` + * @description The type of repositories to attach the configuration to. * @enum {string} */ scope: "all" | "all_without_configurations"; @@ -90361,7 +94674,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -90418,7 +94731,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -90472,6 +94785,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -90487,24 +94811,12 @@ export interface operations { 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -90526,35 +94838,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - "secret-scanning/list-alerts-for-enterprise": { + "enterprise-teams/list": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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 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 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"]; + /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -90568,14 +94862,239 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["enterprise-team"][]; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-public-events": { + "enterprise-teams/create": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description A description of the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be set. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + }; + }; + "enterprise-team-memberships/list": { + 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 slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to add to the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully added team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to be removed from the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully removed team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User is a member of the enterprise team. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully added team member */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-team-organizations/get-assignments": { 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)." */ @@ -90584,6 +95103,290 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description An array of organizations the team is assigned to */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to assign the team to. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully assigned the enterprise team to organizations. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to unassign the team from. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully unassigned the enterprise team from organizations. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/get-assignment": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The team is assigned to the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + /** @description The team is not assigned to the organization */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully assigned the enterprise team to the organization. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + }; + }; + "enterprise-team-organizations/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully unassigned the enterprise team from the organization. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-teams/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A new name for the team. */ + name?: string | null; + /** @description A new description for the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be changed. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/list-public-events": { + 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"]["public-events-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?: never; cookie?: never; }; @@ -92027,17 +96830,425 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "actions/get-actions-cache-retention-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-retention-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-organization": { + 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": components["schemas"]["actions-cache-retention-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-storage-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-organization": { + 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": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/repository-access-for-org": { + parameters: { + query?: { + /** @description The page number of results to fetch. */ + page?: number; + /** @description Number of results per page. */ + 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"]["dependabot-repository-access-details"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/update-repository-access-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 List of repository IDs to add. */ + repository_ids_to_add?: number[]; + /** @description List of repository IDs to remove. */ + repository_ids_to_remove?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/set-repository-access-default-level": { + 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 The default repository access level for Dependabot updates. + * @example internal + * @enum {string} + */ + default_level: "public" | "internal"; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "billing/get-all-budgets-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_all_budgets"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "billing/get-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/delete-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete-budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/update-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert?: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients?: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** @description The name of the entity to apply the budget to */ + budget_entity_name?: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + responses: { + /** @description Budget updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Budget successfully updated. */ + message?: string; + budget?: { + /** @description ID of the budget. */ + id?: string; + /** + * Format: float + * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. + */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @default + */ + budget_entity_name: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Budget not found or feature not enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "billing/get-github-billing-premium-request-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The user name to query usage for. The name is not case sensitive. */ + user?: components["parameters"]["billing-usage-report-user"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "billing/get-github-billing-usage-report-org": { parameters: { query?: { - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ year?: components["parameters"]["billing-usage-report-year"]; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ month?: components["parameters"]["billing-usage-report-month"]; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ day?: components["parameters"]["billing-usage-report-day"]; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - hour?: components["parameters"]["billing-usage-report-hour"]; }; header?: never; path: { @@ -92055,6 +97266,38 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "billing/get-github-billing-usage-summary-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -92397,6 +97640,11 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** + * @description Whether this runner should be used to generate custom images. + * @default false + */ + image_gen?: boolean; }; }; }; @@ -92412,6 +97660,160 @@ export interface operations { }; }; }; + "actions/list-custom-images-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-custom-image"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image"]; + }; + }; + }; + }; + "actions/delete-custom-image-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-custom-image-versions-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @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; + image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"]; + }; + }; + }; + }; + "actions/delete-custom-image-version-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/get-hosted-runners-github-owned-images-for-org": { parameters: { query?: never; @@ -92432,7 +97834,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -92458,7 +97860,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -92613,6 +98015,10 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size?: string; + /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image_id?: string; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ image_version?: string | null; }; @@ -92720,6 +98126,7 @@ export interface operations { "application/json": { enabled_repositories: components["schemas"]["enabled-repositories"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -92733,6 +98140,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + 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"]["actions-artifact-and-log-retention-response"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-organization": { + 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": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-organization": { + 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": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-organization": { + 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": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { @@ -92886,6 +98459,184 @@ export interface operations { }; }; }; + "actions/get-self-hosted-runners-permissions-organization": { + parameters: { + query?: never; + 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"]["self-hosted-runners-settings"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-self-hosted-runners-permissions-organization": { + 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 The policy that controls whether self-hosted runners can be used in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-self-hosted-runners-organization": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-selected-repositories-self-hosted-runners-organization": { + 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 IDs of repositories that can use repository-level self-hosted runners */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/enable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/disable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { query?: never; @@ -93468,6 +99219,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -93563,6 +99315,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-org": { @@ -93770,9 +99523,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} @@ -94247,154 +100000,467 @@ export interface operations { }; }; }; - "orgs/list-attestations": { + "orgs/create-artifact-deployment-record": { 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 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"]; + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** @description The hex encoded digest of the artifact. */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * @description The status of the artifact. Can be either deployed or decommissioned. + * @enum {string} + */ + status: "deployed" | "decommissioned"; + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The deployment cluster. */ + cluster?: string; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a cluster, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + */ + deployment_name: string; + /** @description The tags associated with the deployment. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact deployment record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/set-cluster-deployment-records": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - subject_digest: string; + /** @description The cluster name. */ + cluster: string; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The list of deployments to record. */ + deployments: { + /** + * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name parameter must also be identical across all entries. + */ + name: string; + /** + * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name and version parameters must also be identical across all entries. + */ + digest: string; + /** + * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + * the version parameter must also be identical across all entries. + * @example 1.2.3 + */ + version?: string; + /** + * @description The deployment status of the artifact. + * @enum {string} + */ + status?: "deployed" | "decommissioned"; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a record set, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + * The deployment_name must be unique across all entries in the deployments array. + */ + deployment_name: string; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + /** @description Key-value pairs to tag the deployment record. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + }[]; + }; + }; + }; responses: { - /** @description Response */ + /** @description Deployment records created or updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { - attestations?: { - /** - * @description The attestation's Sigstore Bundle. - * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - */ - bundle?: { - mediaType?: string; - verificationMaterial?: { - [key: string]: unknown; - }; - dsseEnvelope?: { - [key: string]: unknown; - }; - }; - repository_id?: number; - bundle_url?: string; - }[]; + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; }; }; }; }; }; - "orgs/list-blocked-users": { + "orgs/create-artifact-storage-record": { 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"]; + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** + * @description The digest of the artifact (algorithm:hex-encoded-digest). + * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * Format: uri + * @description The URL where the artifact is stored. + * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3 + */ + artifact_url?: string; + /** + * Format: uri + * @description The path of the artifact. + * @example com/github/bar/libfoo-1.2.3 + */ + path?: string; + /** + * Format: uri + * @description The base URL of the artifact registry. + * @example https://reg.example.com/artifactory/ + */ + registry_url: string; + /** + * @description The repository name within the registry. + * @example bar + */ + repository?: string; + /** + * @description The status of the artifact (e.g., active, inactive). + * @default active + * @example active + * @enum {string} + */ + status?: "active" | "eol" | "deleted"; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact metadata storage record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example 1 */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string | null; + registry_url?: string; + repository?: string | null; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-artifact-deployment-records": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + subject_digest: components["parameters"]["subject-digest"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": { + /** + * @description The number of deployment records for this digest and organization + * @example 3 + */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; }; }; }; }; - "orgs/check-blocked-user": { + "orgs/list-artifact-storage-records": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** + * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + */ + subject_digest: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description If the user is blocked */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + /** + * @description The number of storage records for this digest and organization + * @example 3 + */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string; + registry_url?: string; + repository?: string; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; }; - /** @description If the user is not blocked */ - 404: { + }; + }; + "orgs/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; }; }; }; }; - "orgs/block-user": { + "orgs/delete-attestations-bulk": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; content?: never; }; - 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/unblock-user": { + "orgs/delete-attestations-by-subject-digest": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; }; cookie?: never; }; requestBody?: never; responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; /** @description Response */ 204: { headers: { @@ -94402,31 +100468,24 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "code-scanning/list-alerts-for-org": { + "orgs/list-attestation-repositories": { parameters: { query?: { - /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; - /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + /** @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 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 page number of the results to fetch. For 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 If specified, only code scanning alerts with this state will be returned. */ - state?: components["schemas"]["code-scanning-alert-state-query"]; - /** @description The property by which to sort the results. */ - sort?: "created" | "updated"; - /** @description If specified, only code scanning alerts with this severity will be returned. */ - severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -94440,33 +100499,26 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; + "application/json": { + id?: number; + name?: string; + }[]; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "code-security/get-configurations-for-org": { + "orgs/delete-attestations-by-id": { parameters: { - query?: { - /** @description The target type of the code security configuration */ - target_type?: "global" | "all"; - /** @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?: number; - /** @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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Attestation ID */ + attestation_id: number; }; cookie?: never; }; @@ -94477,568 +100529,464 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["code-security-configuration"][]; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "code-security/create-configuration": { + "orgs/list-attestations": { parameters: { - query?: never; + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The name of the code security configuration. Must be unique within the organization. */ - name: string; - /** @description A description of the code security configuration */ - description: string; - /** - * @description The enablement status of GitHub Advanced Security - * @default disabled - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @default enabled - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @default disabled - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** - * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. - * @default false - */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @default disabled - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @default disabled - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @default disabled - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; - /** - * @description The enablement status of secret scanning - * @default disabled - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @default disabled - * @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; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { /** - * @description The type of the bypass reviewer - * @enum {string} + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - reviewer_type: "TEAM" | "ROLE"; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + } | null; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; - /** - * @description The enablement status of secret scanning validity checks - * @default disabled - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non provider patterns - * @default disabled - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @default disabled - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @default enforced - * @enum {string} - */ - enforcement?: "enforced" | "unenforced"; }; }; }; + }; + "orgs/list-blocked-users": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description Successfully created code security configuration */ - 201: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - "code-security/get-default-configurations": { + "orgs/check-blocked-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description If the user is blocked */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description If the user is not blocked */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-default-configurations"]; + "application/json": components["schemas"]["basic-error"]; }; }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "code-security/detach-configuration": { + "orgs/block-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description An array of repository IDs to detach from configurations. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - "code-security/get-configuration": { + "orgs/unblock-user": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["code-security-configuration"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "code-security/delete-configuration": { + "campaigns/list-org-campaigns": { parameters: { - query?: never; + 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"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description If specified, only campaigns with this state will be returned. */ + state?: components["schemas"]["campaign-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated" | "ends_at" | "published"; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"][]; + }; + }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + 503: components["responses"]["service_unavailable"]; }; }; - "code-security/update-configuration": { + "campaigns/create-campaign": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The name of the code security configuration. Must be unique within the organization. */ - name?: string; - /** @description A description of the code security configuration */ - description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @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} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** @description The name of the campaign */ + name: string; + /** @description A description for the campaign */ + description: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} + * Format: date-time + * @description The end date and time of the campaign. The date must be in the future. */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + ends_at: string; /** - * @description The enablement status of private vulnerability reporting - * @enum {string} + * Format: uri + * @description The contact link of the campaign. Must be a URI. */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + contact_link?: string | null; + /** @description The code scanning alerts to include in this campaign */ + code_scanning_alerts?: { + /** @description The repository id */ + repository_id: number; + /** @description The alert numbers */ + alert_numbers: number[]; + }[] | null; /** - * @description The enforcement status for a security configuration - * @enum {string} + * @description If true, will automatically generate issues for the campaign. The default is false. + * @default false */ - enforcement?: "enforced" | "unenforced"; - }; + generate_issues?: boolean; + } & (unknown | unknown); }; }; responses: { - /** @description Response when a configuration is updated */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["campaign-summary"]; }; }; - /** @description Response when no new updates are made */ - 204: { + /** @description Bad Request */ + 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; - }; - }; - "code-security/attach-configuration": { - 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @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" | "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[]; + /** @description Too Many Requests */ + 429: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 202: components["responses"]["accepted"]; + 503: components["responses"]["service_unavailable"]; }; }; - "code-security/set-configuration-as-default": { + "campaigns/get-campaign-summary": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Specify which types of repository this security configuration should be applied to by default. - * @enum {string} - */ - default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - }; - }; - }; + requestBody?: never; responses: { - /** @description Default successfully changed. */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - /** - * @description Specifies which types of repository this security configuration is applied to by default. - * @enum {string} - */ - default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - configuration?: components["schemas"]["code-security-configuration"]; - }; + "application/json": components["schemas"]["campaign-summary"]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - }; - }; - "code-security/get-repositories-for-configuration": { - 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?: number; - /** @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 A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. - * - * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` - */ - status?: string; - }; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + /** @description Unprocessable Entity */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration-repositories"][]; + "application/json": components["schemas"]["basic-error"]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/list-in-organization": { + "campaigns/delete-campaign": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description Deletion successful */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/set-codespaces-access": { + "campaigns/update-campaign": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description The name of the campaign */ + name?: string; + /** @description A description for the campaign */ + description?: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; /** - * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. - * @enum {string} + * Format: date-time + * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; - /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ - selected_usernames?: string[]; + ends_at?: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + state?: components["schemas"]["campaign-state"]; }; }; }; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ + /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/set-codespaces-access-users": { + "code-scanning/list-alerts-for-org": { parameters: { - query?: never; + query?: { + /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name?: components["parameters"]["tool-name"]; + /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid?: components["parameters"]["tool-guid"]; + /** @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 page number of the results to fetch. For 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 If specified, only code scanning alerts with this state will be returned. */ + state?: components["schemas"]["code-scanning-alert-state-query"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated"; + /** @description If specified, only code scanning alerts with this severity will be returned. */ + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -95046,38 +100994,34 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members whose codespaces be billed to the organization. */ - selected_usernames: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ - 400: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; }; - content?: never; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/delete-codespaces-access-users": { + "code-security/get-configurations-for-org": { parameters: { - query?: never; + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @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?: number; + /** @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"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -95085,43 +101029,24 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ - selected_usernames: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ - 400: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["code-security-configuration"][]; }; - content?: never; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "codespaces/list-org-secrets": { + "code-security/create-configuration": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -95129,55 +101054,177 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-org-secret"][]; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @default disabled + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default not_set + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @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 + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; }; - }; - "codespaces/get-org-public-key": { - parameters: { - query?: never; - 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: { + /** @description Successfully created code security configuration */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; }; }; - "codespaces/get-org-secret": { + "code-security/get-default-configurations": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -95186,154 +101233,250 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespaces-org-secret"]; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "codespaces/create-or-update-org-secret": { + "code-security/detach-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id?: string; - /** - * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. - * @enum {string} - */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */ selected_repository_ids?: number[]; }; }; }; responses: { - /** @description Response when creating a secret */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; }; }; - "codespaces/delete-org-secret": { + "code-security/get-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "codespaces/list-selected-repos-for-org-secret": { + "code-security/delete-configuration": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - "codespaces/set-selected-repos-for-org-secret": { + "code-security/update-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @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} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; }; responses: { - /** @description Response */ - 204: { + /** @description Response when a configuration is updated */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type not set to selected */ - 409: { + /** @description Response when no new updates are made */ + 204: { headers: { [name: string]: unknown; }; @@ -95341,118 +101484,101 @@ export interface operations { }; }; }; - "codespaces/add-selected-repo-to-org-secret": { + "code-security/attach-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description No Content when repository was added to the selected list */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type is not set to selected */ - 409: { - headers: { - [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @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" | "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[]; }; - content?: never; }; - 422: components["responses"]["validation_failed"]; + }; + responses: { + 202: components["responses"]["accepted"]; }; }; - "codespaces/remove-selected-repo-from-org-secret": { + "code-security/set-configuration-as-default": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response when repository was removed from the selected list */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type not set to selected */ - 409: { - headers: { - [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; - content?: never; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "copilot/get-copilot-organization-details": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; }; - cookie?: never; }; - requestBody?: never; responses: { - /** @description OK */ + /** @description Default successfully changed. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-organization-details"]; + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description There is a problem with your account's associated payment method. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 500: components["responses"]["internal_error"]; }; }; - "copilot/list-copilot-seats": { + "code-security/get-repositories-for-configuration": { 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?: number; + /** @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 A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -95461,69 +101587,24 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ - total_seats?: number; - seats?: components["schemas"]["copilot-seat-details"][]; - }; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-seats-for-teams": { + "codespaces/list-in-organization": { 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 List of team names within the organization to which to grant access to GitHub Copilot. */ - selected_teams: string[]; - }; - }; - }; - responses: { - /** @description OK */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - seats_created: number; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; + 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"]; }; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/cancel-copilot-seat-assignment-for-teams": { - parameters: { - query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -95531,40 +101612,28 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The names of teams from which to revoke access to GitHub Copilot. */ - selected_teams: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description OK */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { - seats_cancelled: number; + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-seats-for-users": { + "codespaces/set-codespaces-access": { parameters: { query?: never; header?: never; @@ -95577,37 +101646,38 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ - selected_usernames: string[]; + /** + * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. + * @enum {string} + */ + visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; + /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ + selected_usernames?: string[]; }; }; }; responses: { - /** @description OK */ - 201: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - seats_created: number; - }; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "copilot/cancel-copilot-seat-assignment-for-users": { + "codespaces/set-codespaces-access-users": { parameters: { query?: never; header?: never; @@ -95620,48 +101690,35 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ + /** @description The usernames of the organization members whose codespaces be billed to the organization. */ selected_usernames: string[]; }; }; }; responses: { - /** @description OK */ - 200: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - seats_cancelled: number; - }; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ - 422: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-organization": { + "codespaces/delete-codespaces-access-users": { 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; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -95669,147 +101726,36 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ + selected_usernames: string[]; }; }; - 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?: { - /** @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: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; - "dependabot/list-alerts-for-org": { - parameters: { - query?: { - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. - * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - state?: components["parameters"]["dependabot-alert-comma-separated-states"]; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. - * - * Can be: `low`, `medium`, `high`, `critical` - */ - severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; - /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; - /** - * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - * - An exact number (`n`) - * - Comparators such as `>n`, `=n`, `<=n` - * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 - * - * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. - */ - epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; - /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - scope?: components["parameters"]["dependabot-alert-scope"]; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. - */ - sort?: components["parameters"]["dependabot-alert-sort"]; - /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; - /** @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"]; + content?: never; }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["dependabot-alert-with-repository"][]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "dependabot/list-org-secrets": { + "codespaces/list-org-secrets": { 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)." */ @@ -95835,13 +101781,13 @@ export interface operations { content: { "application/json": { total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; + secrets: components["schemas"]["codespaces-org-secret"][]; }; }; }; }; }; - "dependabot/get-org-public-key": { + "codespaces/get-org-public-key": { parameters: { query?: never; header?: never; @@ -95859,12 +101805,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - "dependabot/get-org-secret": { + "codespaces/get-org-secret": { parameters: { query?: never; header?: never; @@ -95881,15 +101827,16 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; + "application/json": components["schemas"]["codespaces-org-secret"]; }; }; }; }; - "dependabot/create-or-update-org-secret": { + "codespaces/create-or-update-org-secret": { parameters: { query?: never; header?: never; @@ -95904,17 +101851,17 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ encrypted_value?: string; - /** @description ID of the key you used to encrypt the secret. */ + /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ visibility: "all" | "private" | "selected"; - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; + /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: number[]; }; }; }; @@ -95935,9 +101882,11 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "dependabot/delete-org-secret": { + "codespaces/delete-org-secret": { parameters: { query?: never; header?: never; @@ -95958,9 +101907,10 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "dependabot/list-selected-repos-for-org-secret": { + "codespaces/list-selected-repos-for-org-secret": { 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)." */ @@ -95991,9 +101941,10 @@ export interface operations { }; }; }; + 404: components["responses"]["not_found"]; }; }; - "dependabot/set-selected-repos-for-org-secret": { + "codespaces/set-selected-repos-for-org-secret": { parameters: { query?: never; header?: never; @@ -96008,7 +101959,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -96021,9 +101972,17 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + /** @description Conflict when visibility type not set to selected */ + 409: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "dependabot/add-selected-repo-to-org-secret": { + "codespaces/add-selected-repo-to-org-secret": { parameters: { query?: never; header?: never; @@ -96045,6 +102004,7 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ 409: { headers: { @@ -96052,9 +102012,10 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed"]; }; }; - "dependabot/remove-selected-repo-from-org-secret": { + "codespaces/remove-selected-repo-from-org-secret": { parameters: { query?: never; header?: never; @@ -96076,6 +102037,7 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { headers: { @@ -96083,9 +102045,10 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed"]; }; }; - "packages/list-docker-migration-conflicting-packages-for-organization": { + "copilot/get-copilot-organization-details": { parameters: { query?: never; header?: never; @@ -96097,84 +102060,35 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package"][]; + "application/json": components["schemas"]["copilot-organization-details"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - }; - }; - "activity/list-public-org-events": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["event"][]; - }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-failed-invitations": { + "copilot/list-copilot-seats": { 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/list-webhooks": { - 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"]; + per_page?: number; }; header?: never; path: { @@ -96192,13 +102106,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"][]; + "application/json": { + /** @description Total number of Copilot seats for the organization currently being billed. */ + total_seats?: number; + seats?: components["schemas"]["copilot-seat-details"][]; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/create-webhook": { + "copilot/add-copilot-seats-for-teams": { parameters: { query?: never; header?: never; @@ -96211,342 +102132,250 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Must be passed as "web". */ - name: string; - /** @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"]; - /** @example "kdaigle" */ - username?: string; - /** @example "password" */ - password?: string; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. - * @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; + /** @description List of team names within the organization to which to grant access to GitHub Copilot. */ + selected_teams: string[]; }; }; }; responses: { - /** @description Response */ + /** @description OK */ 201: { - headers: { - /** @example https://api.github.com/orgs/octocat/hooks/1 */ - Location?: string; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/get-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 */ - 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_created: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-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: { + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { headers: { [name: string]: unknown; }; content?: never; }; - 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/update-webhook": { + "copilot/cancel-copilot-seat-assignment-for-teams": { 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?: { + 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; + /** @description The names of teams from which to revoke access to GitHub Copilot. */ + selected_teams: string[]; }; }; }; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_cancelled: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 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: { + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["webhook-config"]; - }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/update-webhook-config-for-org": { + "copilot/add-copilot-seats-for-users": { 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?: { + 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"]; + /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ + selected_usernames: string[]; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description OK */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": { + seats_created: number; + }; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-webhook-deliveries": { + "copilot/cancel-copilot-seat-assignment-for-users": { 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"]; - }; + 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; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ + selected_usernames: string[]; + }; + }; + }; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": { + seats_cancelled: number; + }; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/get-webhook-delivery": { + "copilot/copilot-content-exclusion-for-organization": { 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 */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["copilot-organization-content-exclusion-details"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/redeliver-webhook-delivery": { + "copilot/set-copilot-content-exclusion-for-organization": { 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"]; + /** @description The content exclusion rules to set */ + requestBody: { + content: { + "application/json": { + [key: string]: (string | { + ifAnyMatch: string[]; + } | { + ifNoneMatch: string[]; + })[]; + }; }; - cookie?: never; }; - requestBody?: never; responses: { - /** @description Response */ - 204: { + /** @description Success */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + message?: string; + }; + }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 413: components["responses"]["too_large"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; }; }; - "api-insights/get-route-stats-by-actor": { + "copilot/copilot-metrics-for-organization": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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 100 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 results per page (max 100). For 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"]; - /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + /** @description The number of days of metrics to display per page (max 100). For 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 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; }; @@ -96558,28 +102387,89 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-route-stats"]; + "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"]; }; }; - "api-insights/get-subject-stats": { + "dependabot/list-alerts-for-org": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; + query?: { + /** + * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` + */ + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** + * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` + */ + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** + * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` + */ + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** + * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. + */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"]; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ + scope?: components["parameters"]["dependabot-alert-scope"]; + /** + * @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. + */ + sort?: components["parameters"]["dependabot-alert-sort"]; /** @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"]; - /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + /** @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 number of results per page (max 100). For 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: { @@ -96596,18 +102486,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-subject-stats"]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "api-insights/get-summary-stats": { + "dependabot/list-org-secrets": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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: { @@ -96621,28 +102516,25 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-dependabot-secret"][]; + }; }; }; }; }; - "api-insights/get-summary-stats-by-user": { + "dependabot/get-org-public-key": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -96654,27 +102546,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - "api-insights/get-summary-stats-by-actor": { + "dependabot/get-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; - }; + query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -96686,91 +102571,96 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - "api-insights/get-time-stats": { + "dependabot/create-or-update-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + encrypted_value?: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: (number | string)[]; + }; + }; + }; responses: { - /** @description Response */ - 200: { + /** @description Response when creating a secret */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "api-insights/get-time-stats-by-user": { + "dependabot/delete-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-time-stats"]; - }; + content?: never; }; }; }; - "api-insights/get-time-stats-by-actor": { + "dependabot/list-selected-repos-for-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; + 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 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -96782,107 +102672,107 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; }; }; - "api-insights/get-user-stats": { + "dependabot/set-selected-repos-for-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids: number[]; + }; + }; + }; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-user-stats"]; - }; + content?: never; }; }; }; - "apps/get-org-installation": { + "dependabot/add-selected-repo-to-org-secret": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description No Content when repository was added to the selected list */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["installation"]; + content?: never; + }; + /** @description Conflict when visibility type is not set to selected */ + 409: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "orgs/list-app-installations": { + "dependabot/remove-selected-repo-from-org-secret": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description Response when repository was removed from the selected list */ + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; + content?: never; + }; + /** @description Conflict when visibility type not set to selected */ + 409: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "interactions/get-restrictions-for-org": { + "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { query?: never; header?: never; @@ -96900,14 +102790,21 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["package"][]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "interactions/set-restrictions-for-org": { + "activity/list-public-org-events": { parameters: { - query?: never; + 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. */ @@ -96915,11 +102812,7 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -96927,15 +102820,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["event"][]; }; }; - 422: components["responses"]["validation_failed"]; }; }; - "interactions/remove-restrictions-for-org": { + "orgs/list-failed-invitations": { parameters: { - query?: never; + 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. */ @@ -96946,25 +102843,25 @@ export interface operations { requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/list-pending-invitations": { + "orgs/list-webhooks": { 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 Filter invitations by their member role. */ - role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; - /** @description Filter invitations by their invitation source. */ - invitation_source?: "all" | "member" | "scim"; }; header?: never; path: { @@ -96982,13 +102879,13 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["org-hook"][]; }; }; 404: components["responses"]["not_found"]; }; }; - "orgs/create-invitation": { + "orgs/create-webhook": { parameters: { query?: never; header?: never; @@ -96998,25 +102895,34 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id?: number; - /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email?: string; + /** @description Must be passed as "web". */ + name: string; + /** @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"]; + /** @example "kdaigle" */ + username?: string; + /** @example "password" */ + password?: string; + }; /** - * @description The role for the new member. - * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. - * @default direct_member - * @enum {string} + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + * @default [ + * "push" + * ] */ - role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; - /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids?: number[]; + events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; }; }; }; @@ -97024,131 +102930,130 @@ export interface operations { /** @description Response */ 201: { headers: { + /** @example https://api.github.com/orgs/octocat/hooks/1 */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"]; + "application/json": components["schemas"]["org-hook"]; }; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "orgs/cancel-invitation": { + "orgs/get-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 invitation. */ - invitation_id: components["parameters"]["invitation-id"]; + /** @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: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-hook"]; + }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-invitation-teams": { + "orgs/delete-webhook": { 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"]; - }; + 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 invitation. */ - invitation_id: components["parameters"]["invitation-id"]; + /** @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: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team"][]; - }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - "issues/list-for-org": { + "orgs/update-webhook": { parameters: { - query?: { - /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; - /** @description Indicates the state of the issues to return. */ - state?: "open" | "closed" | "all"; - /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; - /** @description What to sort results by. */ - sort?: "created" | "updated" | "comments"; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - /** @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"]; - }; + 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; + 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: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issue"][]; + "application/json": components["schemas"]["org-hook"]; }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-members": { + "orgs/get-webhook-config-for-org": { parameters: { - query?: { - /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */ - filter?: "2fa_disabled" | "all"; - /** @description Filter members returned by their role. */ - role?: "all" | "admin" | "member"; - /** @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"]; - }; + 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; }; @@ -97157,93 +103062,90 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["webhook-config"]; }; }; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/check-membership-for-user": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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 if requester is an organization member and user is a member */ - 204: { - headers: { - [name: string]: unknown; + 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"]; }; - content?: never; }; - /** @description Response if requester is not an organization member */ - 302: { + }; + responses: { + /** @description Response */ + 200: { headers: { - /** @example https://api.github.com/orgs/github/public_members/pezra */ - Location?: string; [name: string]: unknown; }; - content?: never; - }; - /** @description Not Found if requester is an organization member and user is not a member */ - 404: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["webhook-config"]; }; - content?: never; }; }; }; - "orgs/remove-member": { + "orgs/list-webhook-deliveries": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; }; - 403: components["responses"]["forbidden"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "codespaces/get-codespaces-for-user-in-org": { + "orgs/get-webhook-delivery": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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; }; @@ -97255,120 +103157,121 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; + "application/json": components["schemas"]["hook-delivery"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "codespaces/delete-from-organization": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + /** @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"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "codespaces/stop-in-organization": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + /** @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: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["codespace"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/get-copilot-seat-details-for-user": { + "api-insights/get-route-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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 The user's GitHub Copilot seat details, including usage. */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-seat-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ - 422: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["api-insights-route-stats"]; }; - content?: never; }; - 500: components["responses"]["internal_error"]; }; }; - "orgs/get-membership-for-user": { + "api-insights/get-subject-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97380,39 +103283,27 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/set-membership-for-user": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. - * @default member - * @enum {string} - */ - role?: "admin" | "member"; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -97420,52 +103311,57 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/remove-membership-for-user": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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-summary-stats"]; + }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "migrations/list-for-org": { + "api-insights/get-summary-stats-by-actor": { 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 Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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; }; @@ -97474,18 +103370,24 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"][]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "migrations/start-for-org": { + "api-insights/get-time-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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. */ @@ -97493,179 +103395,149 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; - /** - * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. - * @default false - * @example true - */ - lock_repositories?: boolean; - /** - * @description Indicates whether metadata should be excluded and only git source should be included for the migration. - * @default false - */ - exclude_metadata?: boolean; - /** - * @description Indicates whether the repository git data should be excluded from the migration. - * @default false - */ - exclude_git_data?: boolean; - /** - * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). - * @default false - * @example true - */ - exclude_attachments?: boolean; - /** - * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). - * @default false - * @example true - */ - exclude_releases?: boolean; - /** - * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. - * @default false - * @example true - */ - exclude_owner_projects?: boolean; - /** - * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). - * @default false - * @example true - */ - org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ - exclude?: "repositories"[]; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "migrations/get-status-for-org": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: { - /** @description Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 migration. */ - migration_id: components["parameters"]["migration-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 * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/download-archive-for-org": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 migration. */ - migration_id: components["parameters"]["migration-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: { /** @description Response */ - 302: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/delete-archive-for-org": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the migration. */ - migration_id: components["parameters"]["migration-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"]; }; }; - "migrations/unlock-repo-for-org": { + "apps/get-org-installation": { 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 migration. */ - migration_id: components["parameters"]["migration-id"]; - /** @description repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["installation"]; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/list-repos-for-org": { + "orgs/list-app-installations": { 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)." */ @@ -97677,8 +103549,6 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the migration. */ - migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; @@ -97691,13 +103561,15 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + }; }; }; - 404: components["responses"]["not_found"]; }; }; - "orgs/list-org-roles": { + "interactions/get-restrictions-for-org": { parameters: { query?: never; header?: never; @@ -97709,58 +103581,52 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response - list of organization roles */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of organization roles available to the organization. */ - total_count?: number; - /** @description The list of organization roles available to the organization. */ - roles?: components["schemas"]["organization-role"][]; - }; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/revoke-all-org-roles-team": { + "interactions/set-restrictions-for-org": { parameters: { query?: never; 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; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["interaction-limit-response"]; + }; }; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/assign-team-to-org-role": { + "interactions/remove-restrictions-for-org": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; @@ -97773,56 +103639,97 @@ export interface operations { }; content?: never; }; - /** @description Response if the organization, team or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; + }; + }; + "orgs/list-pending-invitations": { + 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 Filter invitations by their member role. */ + role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; + /** @description Filter invitations by their invitation source. */ + invitation_source?: "all" | "member" | "scim"; }; - /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ - 422: { + 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: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/revoke-org-role-team": { + "orgs/create-invitation": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ + invitee_id?: number; + /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ + email?: string; + /** + * @description The role for the new member. + * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + * @default direct_member + * @enum {string} + */ + role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; + /** @description Specify IDs for the teams you want to invite new members to. */ + team_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ - 204: { + 201: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"]; + }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/revoke-all-org-roles-user": { + "orgs/cancel-invitation": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description The unique identifier of the invitation. */ + invitation_id: components["parameters"]["invitation-id"]; }; cookie?: never; }; @@ -97835,85 +103742,81 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/assign-user-to-org-role": { + "orgs/list-invitation-teams": { parameters: { - query?: never; + 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 The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; + /** @description The unique identifier of the invitation. */ + invitation_id: components["parameters"]["invitation-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization, user or role does not exist. */ - 404: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["team"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/revoke-org-role-user": { + "orgs/list-issue-types": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["issue-type"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/get-org-role": { + "orgs/create-issue-type": { 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 role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["organization-create-issue-type"]; + }; + }; responses: { /** @description Response */ 200: { @@ -97921,61 +103824,86 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-role"]; + "application/json": components["schemas"]["issue-type"]; }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/list-org-role-teams": { + "orgs/update-issue-type": { 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"]; - }; + 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 role. */ - role_id: components["parameters"]["role-id"]; + /** @description The unique identifier of the issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; responses: { - /** @description Response - List of assigned teams */ + /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-role-assignment"][]; + "application/json": components["schemas"]["issue-type"]; }; }; - /** @description Response if the organization or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/delete-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; }; - /** @description Response if the organization roles feature is not enabled or validation failed. */ - 422: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/list-org-role-users": { + "issues/list-for-org": { parameters: { query?: { + /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + /** @description Indicates the state of the issues to return. */ + state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; + /** @description What to sort results by. */ + sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; /** @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)." */ @@ -97985,44 +103913,31 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response - List of assigned users */ + /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["user-role-assignment"][]; - }; - }; - /** @description Response if the organization or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled or validation failed. */ - 422: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["issue"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/list-outside-collaborators": { + "orgs/list-members": { parameters: { query?: { - /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ - filter?: "2fa_disabled" | "all"; + /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; + /** @description Filter members returned by their role. */ + role?: "all" | "admin" | "member"; /** @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)." */ @@ -98047,9 +103962,10 @@ export interface operations { "application/json": components["schemas"]["simple-user"][]; }; }; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/convert-member-to-outside-collaborator": { + "orgs/check-membership-for-user": { parameters: { query?: never; header?: never; @@ -98061,45 +103977,34 @@ export interface operations { }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. - * @default false - */ - async?: boolean; - }; - }; - }; + requestBody?: never; responses: { - /** @description User is getting converted asynchronously */ - 202: { + /** @description Response if requester is an organization member and user is a member */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": Record; - }; + content?: never; }; - /** @description User was converted */ - 204: { + /** @description Response if requester is not an organization member */ + 302: { headers: { + /** @example https://api.github.com/orgs/github/public_members/pezra */ + Location?: string; [name: string]: unknown; }; content?: never; }; - /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - 403: { + /** @description Not Found if requester is an organization member and user is not a member */ + 404: { headers: { [name: string]: unknown; }; content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "orgs/remove-outside-collaborator": { + "orgs/remove-member": { parameters: { query?: never; header?: never; @@ -98120,41 +104025,23 @@ export interface operations { }; content?: never; }; - /** @description Unprocessable Entity if user is a member of the organization */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + 403: components["responses"]["forbidden"]; }; }; - "packages/list-packages-for-organization": { + "codespaces/get-codespaces-for-user-in-org": { parameters: { - query: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. - * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - visibility?: components["parameters"]["package-visibility"]; - /** @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?: number; + 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?: number; + 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 The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -98166,150 +104053,120 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; + }; }; }; - 400: components["responses"]["package_es_list_error"]; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-package-for-organization": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; - /** @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"]["package"]; - }; - }; - }; - }; - "packages/delete-package-for-org": { + "codespaces/delete-from-organization": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The name of the codespace. */ + codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/restore-package-for-org": { + "codespaces/stop-in-organization": { parameters: { - query?: { - /** @description package token */ - token?: string; - }; + query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The name of the codespace. */ + codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["codespace"]; + }; }; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-all-package-versions-for-package-owned-by-org": { + "copilot/get-copilot-seat-details-for-user": { 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"]; - /** @description The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; + query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description The user's GitHub Copilot seat details, including usage. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package-version"][]; + "application/json": components["schemas"]["copilot-seat-details"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-package-version-for-organization": { + "orgs/get-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -98321,54 +104178,62 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["org-membership"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "packages/delete-package-version-for-org": { + "orgs/set-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description The role to give the user in the organization. Can be one of: + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. + * @default member + * @enum {string} + */ + role?: "admin" | "member"; + }; + }; + }; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-membership"]; + }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "packages/restore-package-version-for-org": { + "orgs/remove-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -98381,32 +104246,19 @@ export interface operations { }; content?: never; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "orgs/list-pat-grant-requests": { + "migrations/list-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 The property by which to sort the results. */ - sort?: components["parameters"]["personal-access-token-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description A list of owner usernames to use to filter the results. */ - owner?: components["parameters"]["personal-access-token-owner"]; - /** @description The name of the repository to use to filter the results. */ - repository?: components["parameters"]["personal-access-token-repository"]; - /** @description The permission to use to filter the results. */ - permission?: components["parameters"]["personal-access-token-permission"]; - /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_before?: components["parameters"]["personal-access-token-before"]; - /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; header?: never; path: { @@ -98424,16 +104276,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; + "application/json": components["schemas"]["migration"][]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/review-pat-grant-requests-in-bulk": { + "migrations/start-for-org": { parameters: { query?: never; header?: never; @@ -98446,203 +104294,176 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ - pat_request_ids?: number[]; + /** @description A list of arrays indicating which repositories should be migrated. */ + repositories: string[]; /** - * @description Action to apply to the requests. - * @enum {string} + * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false + * @example true */ - action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ - reason?: string | null; - }; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "orgs/review-pat-grant-request": { - 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 request for access via fine-grained personal access token. */ - pat_request_id: number; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { + lock_repositories?: boolean; /** - * @description Action to apply to the request. - * @enum {string} + * @description Indicates whether metadata should be excluded and only git source should be included for the migration. + * @default false */ - action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ - reason?: string | null; + exclude_metadata?: boolean; + /** + * @description Indicates whether the repository git data should be excluded from the migration. + * @default false + */ + exclude_git_data?: boolean; + /** + * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false + * @example true + */ + exclude_attachments?: boolean; + /** + * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false + * @example true + */ + exclude_releases?: boolean; + /** + * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false + * @example true + */ + exclude_owner_projects?: boolean; + /** + * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + * @default false + * @example true + */ + org_metadata_only?: boolean; + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ + exclude?: "repositories"[]; }; }; }; responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["migration"]; + }; + }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grant-request-repositories": { + "migrations/get-status-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 Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the request for access via fine-grained personal access token. */ - pat_request_id: number; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** + * @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["migration"]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grants": { + "migrations/download-archive-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 The property by which to sort the results. */ - sort?: components["parameters"]["personal-access-token-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description A list of owner usernames to use to filter the results. */ - owner?: components["parameters"]["personal-access-token-owner"]; - /** @description The name of the repository to use to filter the results. */ - repository?: components["parameters"]["personal-access-token-repository"]; - /** @description The permission to use to filter the results. */ - permission?: components["parameters"]["personal-access-token-permission"]; - /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_before?: components["parameters"]["personal-access-token-before"]; - /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_after?: components["parameters"]["personal-access-token-after"]; - }; + 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 migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 302: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["organization-programmatic-access-grant"][]; - }; + content?: never; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/update-pat-accesses": { + "migrations/delete-archive-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 migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Action to apply to the fine-grained personal access token. - * @enum {string} - */ - action: "revoke"; - /** @description The IDs of the fine-grained personal access tokens. */ - pat_ids: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 202: components["responses"]["accepted"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/update-pat-access": { + "migrations/unlock-repo-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 fine-grained personal access token. */ - pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ + repo_name: components["parameters"]["repo-name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Action to apply to the fine-grained personal access token. - * @enum {string} - */ - action: "revoke"; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grant-repositories": { + "migrations/list-repos-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)." */ @@ -98654,8 +104475,8 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the fine-grained personal access token. */ - pat_id: number; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; @@ -98671,19 +104492,12 @@ export interface operations { "application/json": components["schemas"]["minimal-repository"][]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "private-registries/list-org-private-registries": { + "orgs/list-org-roles": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -98693,142 +104507,145 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description Response - list of organization roles */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { "application/json": { - total_count: number; - configurations: components["schemas"]["org-private-registry-configuration"][]; + /** @description The total number of organization roles available to the organization. */ + total_count?: number; + /** @description The list of organization roles available to the organization. */ + roles?: components["schemas"]["organization-role"][]; }; }; }; - 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "private-registries/create-org-private-registry": { + "orgs/revoke-all-org-roles-team": { parameters: { query?: never; 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: { - content: { - "application/json": { - /** - * @description The registry type. - * @enum {string} - */ - registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - encrypted_value: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id: string; - /** - * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. - * @enum {string} - */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + }; + }; + "orgs/assign-team-to-org-role": { + parameters: { + query?: never; + 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"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The organization private registry configuration */ - 201: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + content?: never; + }; + /** @description Response if the organization, team or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "private-registries/get-org-public-key": { + "orgs/revoke-org-role-team": { parameters: { query?: never; 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"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": { - /** - * @description The identifier for the key. - * @example 012345678912345678 - */ - key_id: string; - /** - * @description The Base64 encoded public key. - * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - */ - key: string; - }; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "private-registries/get-org-private-registry": { + "orgs/revoke-all-org-roles-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description The specified private registry configuration for the organization */ - 200: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-private-registry-configuration"]; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "private-registries/delete-org-private-registry": { + "orgs/assign-user-to-org-role": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; @@ -98841,63 +104658,77 @@ export interface operations { }; content?: never; }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; + /** @description Response if the organization, user or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "private-registries/update-org-private-registry": { + "orgs/revoke-org-role-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description The registry type. - * @enum {string} - */ - registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - encrypted_value?: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id?: string; - /** - * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. - * @enum {string} - */ - visibility?: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; + }; + "orgs/get-org-role": { + 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 role. */ + role_id: components["parameters"]["role-id"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-role"]; + }; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "projects/list-for-org": { + "orgs/list-org-role-teams": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; /** @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)." */ @@ -98907,64 +104738,94 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description Response - List of assigned teams */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; - 422: components["responses"]["validation_failed_simple"]; + /** @description Response if the organization or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/create-for-org": { + "orgs/list-org-role-users": { parameters: { - query?: never; + 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 The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response */ - 201: { + /** @description Response - List of assigned users */ + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["user-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/get-all-custom-properties": { + "orgs/list-outside-collaborators": { parameters: { - query?: never; + query?: { + /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; + /** @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. */ @@ -98977,92 +104838,125 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties": { + "orgs/convert-member-to-outside-collaborator": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/json": { - /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["custom-property"][]; + /** + * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. + * @default false + */ + async?: boolean; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description User is getting converted asynchronously */ + 202: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"][]; + "application/json": Record; }; }; - 403: components["responses"]["forbidden"]; + /** @description User was converted */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 404: components["responses"]["not_found"]; }; }; - "orgs/get-custom-property": { + "orgs/remove-outside-collaborator": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unprocessable Entity if user is a member of the organization */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"]; + "application/json": { + message?: string; + documentation_url?: string; + }; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-property": { + "packages/list-packages-for-organization": { parameters: { - query?: never; + query: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + /** + * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + */ + visibility?: components["parameters"]["package-visibility"]; + /** @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?: number; + /** @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?: number; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["custom-property-set-payload"]; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -99070,44 +104964,50 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["package"][]; }; }; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/remove-custom-property": { + "packages/get-package-for-organization": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["package"]; + }; + }; }; }; - "orgs/list-custom-properties-values-for-repos": { + "packages/delete-package-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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - repository_query?: string; - }; + query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -99116,62 +105016,64 @@ export interface operations { requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-repo-custom-property-values"][]; - }; + content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties-values-for-repos": { + "packages/restore-package-for-org": { parameters: { - query?: never; + query?: { + /** @description package token */ + token?: string; + }; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The names of repositories that the custom property values will be applied to. */ - repository_names: string[]; - /** @description List of custom property names and associated values to apply to the repositories. */ - properties: components["schemas"]["custom-property-value"][]; - }; - }; - }; + requestBody?: never; responses: { - /** @description No Content when custom property values are successfully created or updated */ + /** @description Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-public-members": { + "packages/get-all-package-versions-for-package-owned-by-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 The number of results per page (max 100). For 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 state of the package, either active or deleted. */ + state?: "active" | "deleted"; }; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -99182,54 +105084,59 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["package-version"][]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/check-public-membership-for-user": { + "packages/get-package-version-for-organization": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response if user is a public member */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description Not Found if user is not a public member */ - 404: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["package-version"]; }; - content?: never; }; }; }; - "orgs/set-public-membership-for-authenticated-user": { + "packages/delete-package-version-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; @@ -99242,18 +105149,24 @@ export interface operations { }; content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/remove-public-membership-for-authenticated-user": { + "packages/restore-package-version-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; @@ -99266,21 +105179,34 @@ export interface operations { }; content?: never; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "repos/list-for-org": { + "orgs/list-pat-grant-requests": { parameters: { query?: { - /** @description Specifies the types of repositories you want returned. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; /** @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 The property by which to sort the results. */ + sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ + owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ + repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ + permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; header?: never; path: { @@ -99298,12 +105224,16 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "repos/create-in-org": { + "orgs/review-pat-grant-requests-in-bulk": { parameters: { query?: never; header?: never; @@ -99316,249 +105246,62 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The name of the repository. */ - name: string; - /** @description A short description of the repository. */ - description?: string; - /** @description A URL with more information about the repository. */ - homepage?: string; - /** - * @description Whether the repository is private. - * @default false - */ - private?: boolean; - /** - * @description The visibility of the repository. - * @enum {string} - */ - visibility?: "public" | "private"; - /** - * @description Either `true` to enable issues for this repository or `false` to disable them. - * @default true - */ - has_issues?: boolean; - /** - * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. - * @default true - */ - has_projects?: boolean; - /** - * @description Either `true` to enable the wiki for this repository or `false` to disable it. - * @default true - */ - has_wiki?: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - has_downloads?: boolean; - /** - * @description Either `true` to make this repo available as a template repository or `false` to prevent it. - * @default false - */ - is_template?: boolean; - /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; - /** - * @description Pass `true` to create an initial commit with empty README. - * @default false - */ - auto_init?: boolean; - /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; - /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; - /** - * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - * @default true - */ - allow_squash_merge?: boolean; - /** - * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. - * @default false - */ - allow_auto_merge?: boolean; - /** - * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** - * @default false - */ - 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 is closing down. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default?: boolean; - /** - * @description Required when using `squash_merge_commit_message`. - * - * The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description Required when using `merge_commit_message`. - * - * The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ + pat_request_ids?: number[]; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * @description Action to apply to the requests. * @enum {string} */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; + action: "approve" | "deny"; + /** @description Reason for approving or denying the requests. Max 1024 characters. */ + reason?: string | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - /** @example https://api.github.com/repos/octocat/Hello-World */ - Location?: string; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; + 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/get-org-rulesets": { - 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 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: { - /** @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"]["repository-ruleset"][]; - }; - }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/create-org-ruleset": { + "orgs/review-pat-grant-request": { 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 request for access via fine-grained personal access token. */ + pat_request_id: number; }; cookie?: never; }; - /** @description Request body */ requestBody: { content: { "application/json": { - /** @description The name of the ruleset. */ - name: string; /** - * @description The target of the ruleset - * @default branch + * @description Action to apply to the request. * @enum {string} */ - target?: "branch" | "tag" | "push" | "repository"; - enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions?: components["schemas"]["org-ruleset-conditions"]; - /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + action: "approve" | "deny"; + /** @description Reason for approving or denying the request. Max 1024 characters. */ + reason?: string | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-rule-suites": { + "orgs/list-pat-grant-request-repositories": { parameters: { query?: { - /** @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?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. */ - repository_name?: components["parameters"]["repository-name-in-query"]; - /** - * @description The time period to filter by. - * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). - */ - time_period?: components["parameters"]["time-period"]; - /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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)." */ @@ -99568,6 +105311,8 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the request for access via fine-grained personal access token. */ + pat_request_id: number; }; cookie?: never; }; @@ -99576,30 +105321,46 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; - "repos/get-org-rule-suite": { - parameters: { - query?: never; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "orgs/list-pat-grants": { + 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 The property by which to sort the results. */ + sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ + owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ + repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ + permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** - * @description The unique identifier of the rule suite result. - * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) - * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) - * for organizations. - */ - rule_suite_id: components["parameters"]["rule-suite-id"]; }; cookie?: never; }; @@ -99608,141 +105369,122 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["organization-programmatic-access-grant"][]; }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-ruleset": { + "orgs/update-pat-accesses": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the ruleset. */ - ruleset_id: number; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; + requestBody: { + content: { + "application/json": { + /** + * @description Action to apply to the fine-grained personal access token. + * @enum {string} + */ + action: "revoke"; + /** @description The IDs of the fine-grained personal access tokens. */ + pat_ids: number[]; }; }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/update-org-ruleset": { + "orgs/update-pat-access": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the ruleset. */ - ruleset_id: number; + /** @description The unique identifier of the fine-grained personal access token. */ + pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; cookie?: never; }; - /** @description Request body */ - requestBody?: { + requestBody: { content: { "application/json": { - /** @description The name of the ruleset. */ - name?: string; /** - * @description The target of the ruleset + * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - target?: "branch" | "tag" | "push" | "repository"; - enforcement?: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions?: components["schemas"]["org-ruleset-conditions"]; - /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + action: "revoke"; }; }; }; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/delete-org-ruleset": { + "orgs/list-pat-grant-repositories": { parameters: { - query?: never; + 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 The ID of the ruleset. */ - ruleset_id: number; + /** @description Unique identifier of the fine-grained personal access token. */ + pat_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - "secret-scanning/list-alerts-for-org": { + "private-registries/list-org-private-registries": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; - /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - 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"]; + /** @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: { @@ -99760,29 +105502,77 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; }; }; + 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "security-advisories/list-org-repository-advisories": { + "private-registries/create-org-private-registry": { parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "published"; - /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ - state?: "triage" | "draft" | "published" | "closed"; + 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 The registry type. + * @enum {string} + */ + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url: string; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -99795,48 +105585,62 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository-advisory"][]; + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; }; }; - 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; }; }; - "orgs/list-security-manager-teams": { + "private-registries/get-org-private-registry": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description The specified private registry configuration for the organization */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-simple"][]; + "application/json": components["schemas"]["org-private-registry-configuration"]; }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/add-security-manager-team": { + "private-registries/delete-org-private-registry": { parameters: { query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -99849,21 +105653,56 @@ export interface operations { }; content?: never; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/remove-security-manager-team": { + "private-registries/update-org-private-registry": { parameters: { query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -99872,11 +105711,22 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "billing/get-github-actions-billing-org": { + "projects/list-for-org": { parameters: { - query?: never; + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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. */ @@ -99889,19 +105739,25 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["projects-v2"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "billing/get-github-packages-billing-org": { + "projects/get-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -99912,47 +105768,70 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["projects-v2"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "billing/get-shared-storage-billing-org": { + "projects/create-draft-item-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; - requestBody?: never; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; responses: { /** @description Response */ - 200: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/list-network-configurations-for-org": { + "projects/list-fields-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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -99967,19 +105846,21 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - network_configurations: components["schemas"]["network-configuration"][]; - }; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/create-network-configuration-for-org": { + "projects/add-field-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -99988,39 +105869,65 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + /** @description The ID of the IssueField to create the field for. */ + issue_field_id: number; + } | { + /** @description The name of the field. */ name: string; /** - * @description The hosted compute service to use for the network configuration. + * @description The field's data type. * @enum {string} */ - compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - network_settings_ids: string[]; + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; }; }; }; responses: { - /** @description Response */ + /** @description Response for adding a field to an organization-owned project. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-configuration"]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "hosted-compute/get-network-configuration-for-org": { + "projects/get-field-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -100033,117 +105940,123 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-configuration"]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/delete-network-configuration-from-org": { + "projects/list-items-for-org": { parameters: { - query?: never; + query?: { + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/update-network-configuration-for-org": { + "projects/add-item-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 hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ requestBody: { content: { "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - name?: string; /** - * @description The hosted compute service to use for the network configuration. + * @description The type of item to add to the project. Must be either Issue or PullRequest. * @enum {string} */ - compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - network_settings_ids?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["network-configuration"]; - }; - }; - }; - }; - "hosted-compute/get-network-settings-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 hosted compute network settings. */ - network_settings_id: components["parameters"]["network-settings-id"]; + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); }; - cookie?: never; }; - requestBody?: never; responses: { /** @description Response */ - 200: { + 201: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-settings"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "copilot/copilot-metrics-for-team": { + "projects/get-org-item": { 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; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; @@ -100152,161 +106065,189 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; 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": { + "projects/delete-item-for-org": { 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; - }; + query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "teams/list": { + "projects/update-item-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"]; - }; + query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; - requestBody?: never; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; responses: { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/create": { + "projects/create-view-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The name of the team. */ + /** + * @description The name of the view. + * @example Sprint Board + */ name: string; - /** @description The description of the team. */ - description?: string; - /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; - /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; /** - * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * @description The layout of the view. + * @example board * @enum {string} */ - privacy?: "secret" | "closed"; + layout: "table" | "board" | "roadmap"; /** - * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` - * @enum {string} + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; + filter?: string; /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] */ - permission?: "pull" | "push"; - /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; + visible_fields?: number[]; }; }; }; responses: { - /** @description Response */ + /** @description Response for creating a view in an organization-owned project. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["projects-v2-view"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; }; }; - "teams/get-by-name": { + "projects/list-view-items-for-org": { parameters: { - query?: never; + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -100315,127 +106256,85 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "teams/delete-in-org": { + "orgs/custom-properties-for-repos-get-organization-definitions": { parameters: { query?: never; 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 */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["custom-property"][]; + }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/update-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-definitions": { parameters: { query?: never; 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?: { + requestBody: { content: { "application/json": { - /** @description The name of the team. */ - name?: string; - /** @description The description of the team. */ - description?: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; + /** @description The array of custom properties to create or update. */ + properties: components["schemas"]["custom-property"][]; }; }; }; responses: { - /** @description Response when the updated information already exists */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-full"]; - }; - }; /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-in-org": { + "orgs/custom-properties-for-repos-get-organization-definition": { parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 Pinned discussions only filter */ - pinned?: string; - }; + query?: never; 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"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; @@ -100444,147 +106343,135 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"][]; + "application/json": components["schemas"]["custom-property"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/create-discussion-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-definition": { parameters: { query?: never; 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"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["custom-property"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/get-discussion-in-org": { + "orgs/custom-properties-for-repos-delete-organization-definition": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/delete-discussion-in-org": { + "orgs/custom-properties-for-repos-get-organization-values": { parameters: { - query?: never; + 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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + repository_query?: string; + }; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/update-discussion-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-values": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** @description The discussion post's title. */ - title?: string; - /** @description The discussion post's body text. */ - body?: string; + /** @description The names of repositories that the custom property values will be applied to. */ + repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussion-comments-in-org": { + "orgs/list-public-members": { parameters: { query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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)." */ @@ -100594,10 +106481,6 @@ export interface operations { 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; @@ -100610,87 +106493,74 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion-comment"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - "teams/create-discussion-comment-in-org": { + "orgs/check-public-membership-for-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response */ - 201: { + /** @description Response if user is a public member */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; + content?: never; + }; + /** @description Not Found if user is not a public member */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "teams/get-discussion-comment-in-org": { + "orgs/set-public-membership-for-authenticated-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; + content?: never; }; + 403: components["responses"]["forbidden"]; }; }; - "teams/delete-discussion-comment-in-org": { + "orgs/remove-public-membership-for-authenticated-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -100705,62 +106575,217 @@ export interface operations { }; }; }; - "teams/update-discussion-comment-in-org": { + "repos/list-for-org": { + parameters: { + query?: { + /** @description Specifies the types of repositories you want returned. */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + "repos/create-in-org": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The discussion comment's body text. */ - body: string; + /** @description The name of the repository. */ + name: string; + /** @description A short description of the repository. */ + description?: string; + /** @description A URL with more information about the repository. */ + homepage?: string; + /** + * @description Whether the repository is private. + * @default false + */ + private?: boolean; + /** + * @description The visibility of the repository. + * @enum {string} + */ + visibility?: "public" | "private"; + /** + * @description Either `true` to enable issues for this repository or `false` to disable them. + * @default true + */ + has_issues?: boolean; + /** + * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + * @default true + */ + has_projects?: boolean; + /** + * @description Either `true` to enable the wiki for this repository or `false` to disable it. + * @default true + */ + has_wiki?: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + has_downloads?: boolean; + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ + is_template?: boolean; + /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ + team_id?: number; + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ + auto_init?: boolean; + /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ + gitignore_template?: string; + /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + license_template?: string; + /** + * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + * @default true + */ + allow_squash_merge?: boolean; + /** + * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ + allow_auto_merge?: boolean; + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** + * @default false + */ + 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 is closing down. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default?: boolean; + /** + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; }; }; responses: { /** @description Response */ - 200: { + 201: { headers: { + /** @example https://api.github.com/repos/octocat/Hello-World */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["full-repository"]; }; }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "reactions/list-for-team-discussion-comment-in-org": { + "repos/get-org-rulesets": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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 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: { /** @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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; @@ -100769,110 +106794,147 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/create-for-team-discussion-comment-in-org": { + "repos/create-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; + /** @description Request body */ requestBody: { content: { "application/json": { + /** @description The name of the ruleset. */ + name: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The target of the ruleset + * @default branch * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + target?: "branch" | "tag" | "push" | "repository"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["org-rules"][]; }; }; }; responses: { - /** @description Response when the reaction type has already been added to this team discussion comment */ - 200: { + /** @description Response */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-org-rule-suites": { + parameters: { + query?: { + /** @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?: components["parameters"]["ref-in-query"]; + /** @description The name of the repository to filter on. */ + repository_name?: components["parameters"]["repository-name-in-query"]; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). + */ + time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["rule-suites"]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/delete-for-team-discussion-comment": { + "repos/get-org-rule-suite": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; + /** + * @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. + */ + rule_suite_id: components["parameters"]["rule-suite-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["rule-suite"]; + }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; - }; - "reactions/list-for-team-discussion-in-org": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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"]; - }; + }; + "repos/get-org-ruleset": { + parameters: { + query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -100881,37 +106943,45 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"][]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/create-for-team-discussion-in-org": { + "repos/update-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; - requestBody: { + /** @description Request body */ + requestBody?: { content: { "application/json": { + /** @description The name of the ruleset. */ + name?: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The target of the ruleset * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + target?: "branch" | "tag" | "push" | "repository"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["org-rules"][]; }; }; }; @@ -100922,33 +106992,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/delete-for-team-discussion": { + "repos/delete-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -100961,9 +107021,11 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "teams/list-pending-invitations-in-org": { + "orgs/get-org-ruleset-history": { 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)." */ @@ -100975,8 +107037,8 @@ export interface operations { 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"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -100985,31 +107047,81 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["ruleset-version"][]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "teams/list-members-in-org": { + "orgs/get-org-ruleset-version": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "secret-scanning/list-alerts-for-org": { parameters: { query?: { - /** @description Filters members returned by their role in the team. */ - role?: "member" | "maintainer" | "all"; - /** @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 Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ + 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; 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; }; @@ -101022,22 +107134,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["organization-secret-scanning-alert"][]; }; }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - "teams/get-membership-for-user-in-org": { + "secret-scanning/list-org-pattern-configs": { parameters: { query?: never; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; @@ -101049,41 +107159,48 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description if user has no team membership */ - 404: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["secret-scanning-pattern-configuration"]; }; - content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/add-or-update-membership-for-user-in-org": { + "secret-scanning/update-org-pattern-configs": { parameters: { query?: never; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** - * @description The role that this user should have in the team. - * @default member - * @enum {string} - */ - role?: "member" | "maintainer"; + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Pattern settings for provider patterns. */ + provider_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "not-set" | "disabled" | "enabled"; + }[]; + /** @description Pattern settings for custom patterns. */ + custom_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + custom_pattern_version?: components["schemas"]["secret-scanning-row-version"]; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "disabled" | "enabled"; + }[]; }; }; }; @@ -101094,71 +107211,64 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Unprocessable Entity if you attempt to add an organization to a team */ - 422: { - headers: { - [name: string]: unknown; + "application/json": { + /** @description The updated pattern configuration version. */ + pattern_config_version?: string; + }; }; - content?: never; }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/remove-membership-for-user-in-org": { + "security-advisories/list-org-repository-advisories": { parameters: { - query?: never; + query?: { + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["repository-advisory"][]; }; - content?: never; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - "teams/list-projects-in-org": { + "orgs/list-security-manager-teams": { 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"]; - }; + query?: never; 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; }; @@ -101167,16 +107277,15 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-project"][]; + "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - "teams/check-permissions-for-project-in-org": { + "orgs/add-security-manager-team": { parameters: { query?: never; header?: never; @@ -101185,24 +107294,13 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { + 204: { headers: { [name: string]: unknown; }; @@ -101210,7 +107308,7 @@ export interface operations { }; }; }; - "teams/add-or-update-project-permissions-in-org": { + "orgs/remove-security-manager-team": { parameters: { query?: never; header?: never; @@ -101219,22 +107317,10 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; + requestBody?: never; responses: { /** @description Response */ 204: { @@ -101243,35 +107329,55 @@ export interface operations { }; content?: never; }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { + }; + }; + "orgs/get-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Immutable releases settings response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message?: string; - documentation_url?: string; - }; + "application/json": components["schemas"]["immutable-releases-organization-settings"]; }; }; }; }; - "teams/remove-project-in-org": { + "orgs/set-immutable-releases-settings": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -101282,20 +107388,18 @@ export interface operations { }; }; }; - "teams/list-repos-in-org": { + "orgs/get-immutable-releases-settings-repositories": { 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 The number of results per page (max 100). For 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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; }; cookie?: never; }; @@ -101304,82 +107408,58 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; }; }; - "teams/check-permissions-for-repo-in-org": { + "orgs/set-immutable-releases-settings-repositories": { parameters: { query?: never; 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"]; - /** @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"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Alternative response with repository permissions */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-repository"]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids: number[]; }; }; - /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ + }; + responses: { + /** @description Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description Not Found if team does not have permission for the repository */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; }; }; - "teams/add-or-update-repo-permissions-in-org": { + "orgs/enable-selected-repository-immutable-releases-organization": { parameters: { query?: never; 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"]; - /** @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 unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ - permission?: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 204: { @@ -101390,19 +107470,15 @@ export interface operations { }; }; }; - "teams/remove-repo-in-org": { + "orgs/disable-selected-repository-immutable-releases-organization": { parameters: { query?: never; 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"]; - /** @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 unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; @@ -101417,7 +107493,7 @@ export interface operations { }; }; }; - "teams/list-child-in-org": { + "hosted-compute/list-network-configurations-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)." */ @@ -101429,80 +107505,72 @@ export interface operations { 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 if child teams exist */ + /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; }; }; }; }; - "orgs/enable-or-disable-security-product-on-all-org-repos": { + "hosted-compute/create-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The security feature to enable or disable. */ - security_product: components["parameters"]["security-product"]; - /** - * @description The action to take. - * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ - enablement: components["parameters"]["org-security-product-enablement"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; /** - * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @description The hosted compute service to use for the network configuration. * @enum {string} */ - query_suite?: "default" | "extended"; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids: string[]; }; }; }; responses: { - /** @description Action started */ - 204: { + /** @description Response */ + 201: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["network-configuration"]; }; - content?: never; }; }; }; - "projects/get-card": { + "hosted-compute/get-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -101511,25 +107579,24 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["network-configuration"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "projects/delete-card": { + "hosted-compute/delete-network-configuration-from-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -101542,154 +107609,35 @@ export interface operations { }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - note?: string | null; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "projects/move-card": { + "hosted-compute/update-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; /** - * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. - * @example bottom - */ - position: string; - /** - * @description The unique identifier of the column the card should be moved to - * @example 42 + * @description The hosted compute service to use for the network configuration. + * @enum {string} */ - column_id?: number; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": Record; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - resource?: string; - field?: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - /** @description Response */ - 503: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - }[]; - }; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids?: string[]; }; }; }; - }; - "projects/get-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody?: never; responses: { /** @description Response */ 200: { @@ -101697,60 +107645,59 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"]; + "application/json": components["schemas"]["network-configuration"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "projects/delete-column": { + "hosted-compute/get-network-settings-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["network-settings"]; + }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; }; }; - "projects/update-column": { + "copilot/copilot-metrics-for-team": { parameters: { - query?: never; + 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 100 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 100). For 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 unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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: { - content: { - "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -101758,19 +107705,18 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; }; }; - "projects/list-cards": { + "teams/list": { parameters: { query?: { - /** @description Filters the project cards that are returned by the card's state. */ - archived_state?: "all" | "archived" | "not_archived"; /** @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)." */ @@ -101778,8 +107724,8 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; @@ -101792,43 +107738,61 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"][]; + "application/json": components["schemas"]["team"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - "projects/create-card": { + "teams/create": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; + /** @description List GitHub usernames for organization members who will become team maintainers. */ + maintainers?: string[]; + /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ + repo_names?: string[]; /** - * @description The project card's note - * @example Update all gems + * @description The level of privacy this team should have. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` + * @enum {string} */ - note: string | null; - } | { + privacy?: "secret" | "closed"; /** - * @description The unique identifier of the content associated with the card - * @example 42 + * @description The notification setting the team has chosen. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` + * @enum {string} */ - content_id: number; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The piece of content associated with the card - * @example PullRequest + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} */ - content_type: string; + permission?: "pull" | "push"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number; }; }; }; @@ -101839,84 +107803,148 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["team-full"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - /** @description Validation failed */ - 422: { + 422: components["responses"]["validation_failed"]; + }; + }; + "teams/get-by-name": { + parameters: { + query?: never; + 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"]["validation-error"] | components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["team-full"]; }; }; + 404: components["responses"]["not_found"]; + }; + }; + "teams/delete-in-org": { + parameters: { + query?: never; + 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 */ - 503: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - }[]; - }; - }; + content?: never; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - "projects/move-column": { + "teams/update-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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: { + requestBody?: { content: { "application/json": { + /** @description The name of the team. */ + name?: string; + /** @description The description of the team. */ + description?: string; + /** + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * @enum {string} + */ + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. - * @example last + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} */ - position: string; + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; responses: { + /** @description Response when the updated information already exists */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; /** @description Response */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": Record; + "application/json": components["schemas"]["team-full"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "projects/get": { + "teams/list-pending-invitations-in-org": { parameters: { - query?: never; + 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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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; }; @@ -101925,62 +107953,94 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - "projects/delete": { + "teams/list-members-in-org": { parameters: { - query?: never; + query?: { + /** @description Filters members returned by their role in the team. */ + role?: "member" | "maintainer" | "all"; + /** @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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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 Delete Success */ - 204: { + /** @description Response */ + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { + }; + }; + "teams/get-membership-for-user-in-org": { + parameters: { + query?: never; + 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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; + "application/json": components["schemas"]["team-membership"]; }; }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; + /** @description if user has no team membership */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/update": { + "teams/add-or-update-membership-for-user-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -101988,27 +108048,11 @@ export interface operations { content: { "application/json": { /** - * @description Name of the project - * @example Week One Sprint - */ - name?: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - /** - * @description State of the project; either 'open' or 'closed' - * @example open - */ - state?: string; - /** - * @description The baseline permission that all organization members have on this project + * @description The role that this user should have in the team. + * @default member * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; + role?: "member" | "maintainer"; }; }; }; @@ -102019,40 +108063,60 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["team-membership"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ + /** @description Forbidden if team synchronization is set up */ 403: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; + content?: never; + }; + /** @description Unprocessable Entity if you attempt to add an organization to a team */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - /** @description Not Found if the authenticated user does not have access to the project */ - 404: { + }; + }; + "teams/remove-membership-for-user-in-org": { + parameters: { + query?: never; + 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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden if team synchronization is set up */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "projects/list-collaborators": { + "teams/list-repos-in-org": { parameters: { query?: { - /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; /** @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)." */ @@ -102060,8 +108124,10 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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; }; @@ -102074,69 +108140,78 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/add-collaborator": { + "teams/check-permissions-for-repo-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant the collaborator. - * @default write - * @example write - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; + requestBody?: never; responses: { - /** @description Response */ + /** @description Alternative response with repository permissions */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-repository"]; + }; + }; + /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + /** @description Not Found if team does not have permission for the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/remove-collaborator": { + "teams/add-or-update-repo-permissions-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ + permission?: string; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -102145,44 +108220,36 @@ export interface operations { }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/get-permission-for-user": { + "teams/remove-repo-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/list-columns": { + "teams/list-child-in-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)." */ @@ -102192,63 +108259,73 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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 */ + /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"][]; + "application/json": components["schemas"]["team"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; }; }; - "projects/create-column": { + "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ + security_product: components["parameters"]["security-product"]; + /** + * @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. + */ + enablement: components["parameters"]["org-security-product-enablement"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/json": { /** - * @description Name of the project column - * @example Remaining tasks + * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @enum {string} */ - name: string; + query_suite?: "default" | "extended"; }; }; }; responses: { - /** @description Response */ - 201: { + /** @description Action started */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project-column"]; + content?: never; + }; + /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; }; }; "rate-limit/get": { @@ -102339,6 +108416,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "repos/update": { @@ -102384,11 +108462,22 @@ export interface operations { * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { - /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ + /** + * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. + * For more information, see "[About GitHub Advanced + * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */ + code_security?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ @@ -102409,6 +108498,36 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */ + secret_scanning_delegated_alert_dismissal?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */ + secret_scanning_delegated_bypass?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** + * @description Feature options for secret scanning delegated bypass. + * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + */ + secret_scanning_delegated_bypass_options?: { + /** + * @description The bypass reviewers for secret scanning delegated bypass. + * If you omit this field, the existing set of reviewers is unchanged. + */ + 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"; + }[]; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -102656,6 +108775,120 @@ export interface operations { 410: components["responses"]["gone"]; }; }; + "actions/get-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "actions/get-actions-cache-usage": { parameters: { query?: never; @@ -103041,6 +109274,7 @@ export interface operations { "application/json": { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -103106,6 +109340,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-allowed-actions-repository": { parameters: { query?: never; @@ -103310,6 +109710,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -103413,6 +109814,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-repo": { @@ -104293,9 +110695,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; }; }; }; @@ -104602,15 +111004,26 @@ export interface operations { "application/json": { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ ref: string; - /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { [key: string]: unknown; }; + /** @description Whether the response should include the workflow run ID and URLs. */ + return_run_details?: boolean; }; }; }; responses: { - /** @description Response */ + /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["workflow-dispatch-response"]; + }; + }; + /** @description Empty response when `return_run_details` parameter is `false`. */ 204: { headers: { [name: string]: unknown; @@ -104901,6 +111314,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -104938,6 +111357,7 @@ export interface operations { }; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -106930,6 +113350,11 @@ export interface operations { state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; header?: never; path: { @@ -107005,10 +113430,12 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; + state?: components["schemas"]["code-scanning-alert-set-state"]; dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - }; + create_request?: components["schemas"]["code-scanning-alert-create-request"]; + assignees?: components["schemas"]["code-scanning-alert-assignees"]; + } | unknown | unknown; }; }; responses: { @@ -107021,6 +113448,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-alert"]; }; }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 503: components["responses"]["service_unavailable"]; @@ -107177,7 +113605,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; + "application/json": components["schemas"]["code-scanning-alert-instance-list"][]; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; @@ -107255,13 +113683,14 @@ export interface operations { }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; - "application/json+sarif": { + "application/sarif+json": { [key: string]: unknown; }; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_analysis"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -107565,6 +113994,7 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; + 422: components["responses"]["code_scanning_invalid_state"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -108269,7 +114699,19 @@ export interface operations { content?: never; }; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; + /** + * @description Response when: + * - validation failed, or the endpoint has been spammed + * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; }; }; "repos/remove-collaborator": { @@ -109011,7 +115453,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -109239,6 +115685,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -109250,32 +115707,12 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** - * @deprecated - * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. - */ - page?: number; - /** - * @deprecated - * @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?: number; /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; + /** @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: { @@ -109366,7 +115803,7 @@ export interface operations { * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ - state: "dismissed" | "open"; + state?: "dismissed" | "open"; /** * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert. * @enum {string} @@ -109374,7 +115811,13 @@ export interface operations { dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; /** @description An optional comment associated with dismissing the alert. */ dismissed_comment?: string; - }; + /** + * @description Usernames to assign to this Dependabot Alert. + * Pass one or more user logins to _replace_ the set of assignees on this alert. + * Send an empty array (`[]`) to clear all assignees from the alert. + */ + assignees?: string[]; + } | unknown | unknown; }; }; responses: { @@ -111206,7 +117649,13 @@ export interface operations { content?: never; }; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; "git/update-ref": { @@ -111581,7 +118030,233 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/update-webhook": { + "repos/update-webhook": { + 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 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": { + config?: components["schemas"]["webhook-config"]; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + * @default [ + * "push" + * ] + */ + events?: string[]; + /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ + add_events?: string[]; + /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ + remove_events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/get-webhook-config-for-repo": { + 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 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"]; + }; + }; + }; + }; + "repos/update-webhook-config-for-repo": { + 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 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"]; + }; + }; + }; + }; + "repos/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 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 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"]; + }; + }; + "repos/get-webhook-delivery": { + 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 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"]; + }; + }; + "repos/redeliver-webhook-delivery": { + 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 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"]; + }; + }; + "repos/ping-webhook": { + 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 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"]; + }; + }; + "repos/test-push-webhook": { parameters: { query?: never; header?: never; @@ -111595,44 +118270,19 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - config?: components["schemas"]["webhook-config"]; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. - * @default [ - * "push" - * ] - */ - events?: string[]; - /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; - /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active?: boolean; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["hook"]; - }; + content?: never; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/get-webhook-config-for-repo": { + "repos/check-immutable-releases": { parameters: { query?: never; header?: never; @@ -111641,147 +118291,30 @@ export interface operations { 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 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 */ + /** @description Response if immutable releases are enabled */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["check-immutable-releases"]; }; }; - }; - }; - "repos/update-webhook-config-for-repo": { - 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 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"]; - }; - }; - }; - }; - "repos/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 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 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"]; - }; - }; - "repos/get-webhook-delivery": { - 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 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: { + /** @description Not Found if immutable releases are not enabled for the repository */ + 404: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/redeliver-webhook-delivery": { - 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 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"]; + content?: never; }; - cookie?: never; - }; - requestBody?: never; - responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/ping-webhook": { + "repos/enable-immutable-releases": { parameters: { query?: never; header?: never; @@ -111790,24 +118323,16 @@ export interface operations { 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 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"]; + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; }; }; - "repos/test-push-webhook": { + "repos/disable-immutable-releases": { parameters: { query?: never; header?: never; @@ -111816,21 +118341,13 @@ export interface operations { 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 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"]; + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; }; }; "migrations/get-import-status": { @@ -112329,6 +118846,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -112403,6 +118922,11 @@ export interface operations { })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ + * @example Epic + */ + type?: string | null; }; }; }; @@ -112516,41 +119040,103 @@ export interface operations { }; content?: never; }; - }; - }; - "issues/update-comment": { - 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 unique identifier of the comment. */ - comment_id: components["parameters"]["comment-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The contents of the comment. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; + }; + }; + "issues/update-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The contents of the comment. */ + body: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/pin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unpin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 503: components["responses"]["service_unavailable"]; }; }; "reactions/list-for-issue-comment": { @@ -112738,7 +119324,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -112788,7 +119378,7 @@ export interface operations { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "not_planned" | "reopened" | null; + state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null; milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels?: (string | { @@ -112799,6 +119389,11 @@ export interface operations { })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + * @example Epic + */ + type?: string | null; }; }; }; @@ -113000,6 +119595,154 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + "issues/list-dependencies-blocked-by": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-blocked-by-dependency": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the issue that blocks the current issue */ + issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/remove-dependency-blocked-by": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + /** @description The id of the blocking issue to remove as a dependency */ + issue_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-dependencies-blocking": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; "issues/list-events": { parameters: { query?: { @@ -113131,15 +119874,11 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ + /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; } | string[] | { - labels?: { - name: string; - }[]; - } | { name: string; - }[] | string; + }[]; }; }; responses: { @@ -113181,12 +119920,113 @@ export interface operations { }; content?: never; }; - 301: components["responses"]["moved_permanently"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/remove-label": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + name: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/lock": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` + * @enum {string} + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + } | null; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unlock": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; }; }; - "issues/remove-label": { + "issues/get-parent": { parameters: { query?: never; header?: never; @@ -113197,7 +120037,6 @@ export interface operations { repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; - name: string; }; cookie?: never; }; @@ -113209,7 +120048,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["label"][]; + "application/json": components["schemas"]["issue"]; }; }; 301: components["responses"]["moved_permanently"]; @@ -113217,76 +120056,6 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - "issues/lock": { - 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 number that identifies the issue. */ - issue_number: components["parameters"]["issue-number"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` - * @enum {string} - */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - } | null; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/unlock": { - 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 number that identifies the issue. */ - issue_number: components["parameters"]["issue-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; "reactions/list-for-issue": { parameters: { query?: { @@ -113488,7 +120257,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -114808,84 +121577,7 @@ export interface operations { 422: components["responses"]["bad_request"]; }; }; - "projects/list-for-repo": { - parameters: { - query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; - /** @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 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/create-for-repo": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "repos/get-custom-properties-values": { + "repos/custom-properties-for-repos-get-repository-values": { parameters: { query?: never; header?: never; @@ -114912,7 +121604,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/create-or-update-custom-properties-values": { + "repos/custom-properties-for-repos-create-or-update-repository-values": { parameters: { query?: never; header?: never; @@ -116981,6 +123673,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -116992,12 +123685,12 @@ export interface operations { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; @@ -117139,6 +123832,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -117169,15 +123863,82 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "repos/get-repo-ruleset-history": { + 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 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 ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-repo-ruleset-version": { + 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 ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "secret-scanning/list-alerts-for-repo": { parameters: { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ @@ -117196,6 +123957,8 @@ export interface operations { 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; header?: never; path: { @@ -117229,7 +123992,10 @@ export interface operations { }; "secret-scanning/get-alert": { parameters: { - query?: never; + query?: { + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; + }; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -117280,10 +124046,11 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; + state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; - }; + assignee?: components["schemas"]["secret-scanning-alert-assignee"]; + } | unknown | unknown; }; }; responses: { @@ -117310,7 +124077,7 @@ export interface operations { }; content?: never; }; - /** @description State does not match the resolution or resolution comment */ + /** @description State does not match the resolution or resolution comment, or assignee does not have write access to the repository */ 422: { headers: { [name: string]: unknown; @@ -118052,94 +124819,6 @@ export interface operations { }; }; }; - "repos/list-tag-protection": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag-protection"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/create-tag-protection": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional glob pattern to match against when enforcing tag protection. */ - pattern: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-tag-protection": { - 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 unique identifier of the tag protection. */ - tag_protection_id: components["parameters"]["tag-protection-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; "repos/download-tarball-archive": { parameters: { query?: never; @@ -118680,6 +125359,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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + advanced_search?: components["parameters"]["issues-advanced-search"]; }; header?: never; path?: never; @@ -118971,447 +125655,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; - "teams/create-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/get-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/delete-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title?: string; - /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/list-discussion-comments-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - "teams/create-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/get-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/delete-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-comment-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; "teams/list-pending-invitations-legacy": { parameters: { query?: { @@ -119678,140 +125921,6 @@ export interface operations { }; }; }; - "teams/list-projects-legacy": { - 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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "teams/check-permissions-for-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/add-or-update-project-permissions-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "teams/remove-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "teams/list-repos-legacy": { parameters: { query?: { @@ -122239,45 +128348,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "projects/create-for-authenticated-user": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; "users/list-public-emails-for-authenticated-user": { parameters: { query?: { @@ -122344,6 +128414,7 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { @@ -123026,6 +129097,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "projects/create-draft-item-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; "users/list": { parameters: { query?: { @@ -123054,6 +129163,76 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "projects/create-view-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in a user-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; "users/get-by-username": { parameters: { query?: never; @@ -123078,6 +129257,173 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "users/delete-attestations-bulk": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "users/list-attestations": { parameters: { query?: { @@ -123087,6 +129433,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -123107,9 +129459,22 @@ export interface operations { content: { "application/json": { attestations?: { - bundle?: components["schemas"]["sigstore-bundle-0"]; + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -123751,12 +130116,14 @@ export interface operations { "projects/list-for-user": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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: { @@ -123774,22 +130141,57 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-events-for-user": { + "projects/get-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-fields-for-user": { 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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -123800,24 +130202,131 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-public-events-for-user": { + "projects/add-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-user": { parameters: { query?: { + /** @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 number of results per page (max 100). For 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 Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -123828,32 +130337,204 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "repos/list-for-user": { + "projects/add-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-user-item": { parameters: { query?: { - /** @description Limit results to repositories of the specified type. */ - type?: "all" | "owner" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-view-items-for-user": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -123866,14 +130547,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "billing/get-github-actions-billing-user": { + "activity/list-received-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -123889,14 +130579,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-github-packages-billing-user": { + "activity/list-received-public-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -123912,14 +130607,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-shared-storage-billing-user": { + "repos/list-for-user": { parameters: { - query?: never; + query?: { + /** @description Limit results to repositories of the specified type. */ + type?: "all" | "owner" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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 handle for the GitHub user account. */ @@ -123932,14 +130638,105 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; + "billing/get-github-billing-premium-request-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "users/list-social-accounts-for-user": { parameters: { query?: { @@ -124096,7 +130893,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": string; + "text/plain": string; }; }; }; diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index c63dd71bc..07ce6c0b6 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -262,7 +262,7 @@ export interface paths { post?: never; /** * Delete an installation for the authenticated app - * @description Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + * @description Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -308,7 +308,7 @@ export interface paths { get?: never; /** * Suspend an app installation - * @description Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + * @description Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. * * You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. */ @@ -580,6 +580,38 @@ export interface paths { patch?: never; trace?: never; }; + "/credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Revoke a list of credentials + * @description Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + * + * This endpoint currently accepts the following credential types: + * - Personal access tokens (classic) + * - Fine-grained personal access tokens + * + * Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + * GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + * + * To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + * + * > [!NOTE] + * > Any authenticated requests will return a 403. + */ + post: operations["credentials/revoke"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/emojis": { parameters: { query?: never; @@ -600,6 +632,66 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an enterprise + * @description Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-enterprise"]; + /** + * Set GitHub Actions cache retention limit for an enterprise + * @description Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an enterprise + * @description Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-enterprise"]; + /** + * Set GitHub Actions cache storage limit for an enterprise + * @description Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + * enterprise may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-enterprise"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/code-security/configurations": { parameters: { query?: never; @@ -800,7 +892,7 @@ export interface paths { patch?: never; trace?: never; }; - "/enterprises/{enterprise}/secret-scanning/alerts": { + "/enterprises/{enterprise}/teams": { parameters: { query?: never; header?: never; @@ -808,16 +900,34 @@ export interface paths { cookie?: never; }; /** - * List secret scanning alerts for an enterprise - * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * - * Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - * - * The authenticated user must be a member of the enterprise in order to use this endpoint. - * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + * List enterprise teams + * @description List all teams in the enterprise for the authenticated user */ - get: operations["secret-scanning/list-alerts-for-enterprise"]; + get: operations["enterprise-teams/list"]; + put?: never; + /** + * Create an enterprise team + * @description To create an enterprise team, the authenticated user must be an owner of the enterprise. + */ + post: operations["enterprise-teams/create"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List members in an enterprise team + * @description Lists all team members in an enterprise team. + */ + get: operations["enterprise-team-memberships/list"]; put?: never; post?: never; delete?: never; @@ -826,6 +936,192 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk add team members + * @description Add multiple team members to an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Bulk remove team members + * @description Remove multiple team members from an enterprise team. + */ + post: operations["enterprise-team-memberships/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get enterprise team membership + * @description Returns whether the user is a member of the enterprise team. + */ + get: operations["enterprise-team-memberships/get"]; + /** + * Add team member + * @description Add a team member to an enterprise team. + */ + put: operations["enterprise-team-memberships/add"]; + post?: never; + /** + * Remove team membership + * @description Remove membership of a specific user from a particular team in an enterprise. + */ + delete: operations["enterprise-team-memberships/remove"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignments + * @description Get all organizations assigned to an enterprise team + */ + get: operations["enterprise-team-organizations/get-assignments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Add organization assignments + * @description Assign an enterprise team to multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-add"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Remove organization assignments + * @description Unassign an enterprise team from multiple organizations. + */ + post: operations["enterprise-team-organizations/bulk-remove"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization assignment + * @description Check if an enterprise team is assigned to an organization + */ + get: operations["enterprise-team-organizations/get-assignment"]; + /** + * Add an organization assignment + * @description Assign an enterprise team to an organization. + */ + put: operations["enterprise-team-organizations/add"]; + post?: never; + /** + * Delete an organization assignment + * @description Unassign an enterprise team from an organization. + */ + delete: operations["enterprise-team-organizations/delete"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/enterprises/{enterprise}/teams/{team_slug}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an enterprise team + * @description Gets a team using the team's slug. To create the slug, GitHub replaces special characters in the name string, changes all words to lowercase, and replaces spaces with a `-` separator and adds the "ent:" prefix. For example, "My TEam Näme" would become `ent:my-team-name`. + */ + get: operations["enterprise-teams/get"]; + put?: never; + post?: never; + /** + * Delete an enterprise team + * @description To delete an enterprise team, the authenticated user must be an enterprise owner. + * + * If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + */ + delete: operations["enterprise-teams/delete"]; + options?: never; + head?: never; + /** + * Update an enterprise team + * @description To edit a team, the authenticated user must be an enterprise owner. + */ + patch: operations["enterprise-teams/update"]; + trace?: never; + }; "/events": { parameters: { query?: never; @@ -1306,7 +1602,10 @@ export interface paths { }; get?: never; put?: never; - /** Render a Markdown document */ + /** + * Render a Markdown document + * @description Depending on what is rendered in the Markdown, you may need to provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. + */ post: operations["markdown/render"]; delete?: never; options?: never; @@ -1643,6 +1942,213 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for an organization + * @description Gets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-organization"]; + /** + * Set GitHub Actions cache retention limit for an organization + * @description Sets GitHub Actions cache retention limit for an organization. All repositories under this + * organization may not set a higher cache retention limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for an organization + * @description Gets GitHub Actions cache storage limit for an organization. All repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-organization"]; + /** + * Set GitHub Actions cache storage limit for an organization + * @description Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + * organization may not set a higher cache storage limit. + * + * OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Lists the repositories Dependabot can access in an organization + * @description Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + */ + get: operations["dependabot/repository-access-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Updates Dependabot's repository access list for an organization + * @description Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + * + * > [!NOTE] + * > This operation supports both server-to-server and user-to-server access. + * Unauthorized users will not see the existence of this endpoint. + * + * **Example request body:** + * ```json + * { + * "repository_ids_to_add": [123, 456], + * "repository_ids_to_remove": [789] + * } + * ``` + */ + patch: operations["dependabot/update-repository-access-for-org"]; + trace?: never; + }; + "/organizations/{org}/dependabot/repository-access/default-level": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Set the default repository access level for Dependabot + * @description Sets the default level of repository access Dependabot will have while performing an update. Available values are: + * - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + * - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + * + * Unauthorized users will not see the existence of this endpoint. + * + * This operation supports both server-to-server and user-to-server access. + */ + put: operations["dependabot/set-repository-access-default-level"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get all budgets for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-all-budgets-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/organizations/{org}/settings/billing/budgets/{budget_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a budget by ID for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + */ + get: operations["billing/get-budget-org"]; + put?: never; + post?: never; + /** + * Delete a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + */ + delete: operations["billing/delete-budget-org"]; + options?: never; + head?: never; + /** + * Update a budget for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + */ + patch: operations["billing/update-budget-org"]; + trace?: never; + }; + "/organizations/{org}/settings/billing/premium_request/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing premium request usage report for an organization + * @description Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-premium-request-usage-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/organizations/{org}/settings/billing/usage": { parameters: { query?: never; @@ -1665,6 +2171,31 @@ export interface paths { patch?: never; trace?: never; }; + "/organizations/{org}/settings/billing/usage/summary": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get billing usage summary for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + * + * **Note:** Only data from the past 24 months is accessible via this endpoint. + */ + get: operations["billing/get-github-billing-usage-summary-report-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}": { parameters: { query?: never; @@ -1676,7 +2207,7 @@ export interface paths { * Get an organization * @description Gets information about an organization. * - * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). * * To see the full details about an organization, the authenticated user must be an organization owner. * @@ -1790,6 +2321,106 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/hosted-runners/images/custom": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List custom images for an organization + * @description List custom images for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-images-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a custom image definition for GitHub Actions Hosted Runners + * @description Get a custom image definition for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-for-org"]; + put?: never; + post?: never; + /** + * Delete a custom image from the organization + * @description Delete a custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List image versions of a custom image for an organization + * @description List image versions of a custom image for an organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/list-custom-image-versions-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an image version of a custom image for GitHub Actions Hosted Runners + * @description Get an image version of a custom image for GitHub Actions Hosted Runners. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + get: operations["actions/get-custom-image-version-for-org"]; + put?: never; + post?: never; + /** + * Delete an image version of custom image from the organization + * @description Delete an image version of custom image from the organization. + * + * OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + */ + delete: operations["actions/delete-custom-image-version-from-org"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/hosted-runners/images/github-owned": { parameters: { query?: never; @@ -1977,6 +2608,86 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for an organization + * @description Gets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-organization"]; + /** + * Set artifact and log retention settings for an organization + * @description Sets artifact and log retention settings for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for an organization + * @description Gets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-organization"]; + /** + * Set fork PR contributor approval permissions for an organization + * @description Sets the fork PR contributor approval policy for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for an organization + * @description Gets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-organization"]; + /** + * Set private repo fork PR workflow settings for an organization + * @description Sets the settings for whether workflows from fork pull requests can run on private repositories in an organization. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/repositories": { parameters: { query?: never; @@ -2062,6 +2773,90 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/actions/permissions/self-hosted-runners": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get self-hosted runners settings for an organization + * @description Gets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/get-self-hosted-runners-permissions-organization"]; + /** + * Set self-hosted runners settings for an organization + * @description Sets the settings for self-hosted runners for an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-self-hosted-runners-permissions-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List repositories allowed to use self-hosted runners in an organization + * @description Lists repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + get: operations["actions/list-selected-repositories-self-hosted-runners-organization"]; + /** + * Set repositories allowed to use self-hosted runners in an organization + * @description Sets repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/set-selected-repositories-self-hosted-runners-organization"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Add a repository to the list of repositories allowed to use self-hosted runners in an organization + * @description Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + put: operations["actions/enable-selected-repository-self-hosted-runners-organization"]; + post?: never; + /** + * Remove a repository from the list of repositories allowed to use self-hosted runners in an organization + * @description Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + */ + delete: operations["actions/disable-selected-repository-self-hosted-runners-organization"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/actions/permissions/workflow": { parameters: { query?: never; @@ -2836,6 +3631,230 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/artifacts/metadata/deployment-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an artifact deployment record + * @description Create or update deployment records for an artifact associated + * with an organization. + * This endpoint allows you to record information about a specific + * artifact, such as its name, digest, environments, cluster, and + * deployment. + * The deployment name has to be uniqe within a cluster (i.e a + * combination of logical, physical environment and cluster) as it + * identifies unique deployment. + * Multiple requests for the same combination of logical, physical + * environment, cluster and deployment name will only create one + * record, successive request will update the existing record. + * This allows for a stable tracking of a deployment where the actual + * deployed artifact can change over time. + */ + post: operations["orgs/create-artifact-deployment-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Set cluster deployment records + * @description Set deployment records for a given cluster. + * If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + * 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + * If no existing records match, new records will be created. + */ + post: operations["orgs/set-cluster-deployment-records"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/metadata/storage-record": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create artifact metadata storage record + * @description Create metadata storage records for artifacts associated with an organization. + * This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + * associated with a repository owned by the organization. + */ + post: operations["orgs/create-artifact-storage-record"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact deployment records + * @description List deployment records for an artifact metadata associated with an organization. + */ + get: operations["orgs/list-artifact-deployment-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List artifact storage records + * @description List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + * + * The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + */ + get: operations["orgs/list-artifact-storage-records"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["orgs/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["orgs/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["orgs/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/repositories": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List attestation repositories + * @description List repositories owned by the provided organization that have created at least one attested artifact + * Results will be sorted in ascending order by repository ID + */ + get: operations["orgs/list-attestation-repositories"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by an org. + */ + delete: operations["orgs/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/attestations/{subject_digest}": { parameters: { query?: never; @@ -2908,6 +3927,81 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/campaigns": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List campaigns for an organization + * @description Lists campaigns in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/list-org-campaigns"]; + put?: never; + /** + * Create a campaign for an organization + * @description Create a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + * + * Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + * in the campaign. + */ + post: operations["campaigns/create-campaign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/campaigns/{campaign_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a campaign for an organization + * @description Gets a campaign for an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + get: operations["campaigns/get-campaign-summary"]; + put?: never; + post?: never; + /** + * Delete a campaign for an organization + * @description Deletes a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + delete: operations["campaigns/delete-campaign"]; + options?: never; + head?: never; + /** + * Update a campaign + * @description Updates a campaign in an organization. + * + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + */ + patch: operations["campaigns/update-campaign"]; + trace?: never; + }; "/orgs/{org}/code-scanning/alerts": { parameters: { query?: never; @@ -2945,7 +4039,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-configurations-for-org"]; put?: never; @@ -2977,7 +4071,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-default-configurations"]; put?: never; @@ -3120,7 +4214,7 @@ export interface paths { * * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["code-security/get-repositories-for-configuration"]; put?: never; @@ -3395,7 +4489,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. */ @@ -3502,7 +4596,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/metrics": { + "/orgs/{org}/copilot/content_exclusion": { parameters: { query?: never; header?: never; @@ -3510,23 +4604,41 @@ export interface paths { 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. + * Get Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * > [!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. + * Gets information about an organization's Copilot content exclusion path rules. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." * - * 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. + * Organization owners can view details about Copilot content exclusion rules for the organization. * - * 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 `copilot` or `read:org` scopes to use this endpoint. * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + * > [!CAUTION] + * > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + * > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. */ - get: operations["copilot/copilot-metrics-for-organization"]; - put?: never; + get: operations["copilot/copilot-content-exclusion-for-organization"]; + /** + * Set Copilot content exclusion rules for an organization + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. + * + * Sets Copilot content exclusion path rules for an organization. + * To configure these settings, go to the organization's settings on GitHub. + * For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + * + * Organization owners can set Copilot content exclusion rules for the organization. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + * + * > [!CAUTION] + * > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + * > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + */ + put: operations["copilot/set-copilot-content-exclusion-for-organization"]; post?: never; delete?: never; options?: never; @@ -3534,7 +4646,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/copilot/usage": { + "/orgs/{org}/copilot/metrics": { parameters: { query?: never; header?: never; @@ -3542,23 +4654,22 @@ export interface paths { cookie?: never; }; /** - * Get a summary of Copilot usage for organization members - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. + * 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. * - * You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - * across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - * See the response schema tab for detailed metrics definitions. + * > [!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. Usage metrics are processed once per day for the previous day, + * The response contains metrics for up to 100 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. * - * Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + * 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/usage-metrics-for-org"]; + get: operations["copilot/copilot-metrics-for-organization"]; put?: never; post?: never; delete?: never; @@ -4342,6 +5453,69 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/issue-types": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List issue types for an organization + * @description Lists all issue types for an organization. OAuth app tokens and personal access tokens (classic) need the read:org scope to use this endpoint. + */ + get: operations["orgs/list-issue-types"]; + put?: never; + /** + * Create issue type for an organization + * @description Create a new issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + post: operations["orgs/create-issue-type"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/issue-types/{issue_type_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Update issue type for an organization + * @description Updates an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + put: operations["orgs/update-issue-type"]; + post?: never; + /** + * Delete issue type for an organization + * @description Deletes an issue type for an organization. + * + * You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + * + * To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + * personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/delete-issue-type"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/issues": { parameters: { query?: never; @@ -4409,6 +5583,9 @@ export interface paths { /** * Remove an organization member * @description Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-member"]; options?: never; @@ -4497,7 +5674,7 @@ export interface paths { * 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)." + * For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). * * Only organization owners can view Copilot seat assignment details for members of their organization. * @@ -4543,6 +5720,9 @@ export interface paths { * @description In order to remove a user's membership with an organization, the authenticated user must be an organization owner. * * If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + * + * > [!NOTE] + * > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. */ delete: operations["orgs/remove-membership-for-user"]; options?: never; @@ -5238,10 +6418,7 @@ export interface paths { }; /** * List private registries for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Lists all private registry configurations available at the organization-level without revealing their encrypted + * @description Lists all private registry configurations available at the organization-level without revealing their encrypted * values. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. @@ -5250,10 +6427,7 @@ export interface paths { put?: never; /** * Create a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5273,10 +6447,7 @@ export interface paths { }; /** * Get private registries public key for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. + * @description Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. * * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5298,10 +6469,7 @@ export interface paths { }; /** * Get a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Get the configuration of a single private registry defined for an organization, omitting its encrypted value. + * @description Get the configuration of a single private registry defined for an organization, omitting its encrypted value. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5310,10 +6478,7 @@ export interface paths { post?: never; /** * Delete a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Delete a private registry configuration at the organization-level. + * @description Delete a private registry configuration at the organization-level. * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ @@ -5322,17 +6487,14 @@ export interface paths { head?: never; /** * Update a private registry for an organization - * @description > [!NOTE] - * > This endpoint is in public preview and is subject to change. - * - * Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." + * @description Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["private-registries/update-org-private-registry"]; trace?: never; }; - "/orgs/{org}/projects": { + "/orgs/{org}/projectsV2": { parameters: { query?: never; header?: never; @@ -5340,16 +6502,188 @@ export interface paths { cookie?: never; }; /** - * List organization projects - * @description Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * List projects for organization + * @description List all projects owned by a specific organization accessible by the authenticated user. */ get: operations["projects/list-for-org"]; put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; /** - * Create an organization project - * @description Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + * Get project for organization + * @description Get a specific organization-owned project. */ - post: operations["projects/create-for-org"]; + get: operations["projects/get-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for organization owned project + * @description Create draft issue item for the specified organization owned project. + */ + post: operations["projects/create-draft-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for organization + * @description List all fields for a specific organization-owned project. + */ + get: operations["projects/list-fields-for-org"]; + put?: never; + /** + * Add a field to an organization-owned project. + * @description Add a field to an organization-owned project. + */ + post: operations["projects/add-field-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for organization + * @description Get a specific field for an organization-owned project. + */ + get: operations["projects/get-field-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization owned project + * @description List all items for a specific organization-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-org"]; + put?: never; + /** + * Add item to organization owned project + * @description Add an issue or pull request item to the specified organization owned project. + */ + post: operations["projects/add-item-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for an organization owned project + * @description Get a specific item from an organization-owned project. + */ + get: operations["projects/get-org-item"]; + put?: never; + post?: never; + /** + * Delete project item for organization + * @description Delete a specific item from an organization-owned project. + */ + delete: operations["projects/delete-item-for-org"]; + options?: never; + head?: never; + /** + * Update project item for organization + * @description Update a specific item in an organization-owned project. + */ + patch: operations["projects/update-item-for-org"]; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for an organization-owned project + * @description Create a new view in an organization-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-org"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for an organization project view + * @description List items in an organization project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-org"]; + put?: never; + post?: never; delete?: never; options?: never; head?: never; @@ -5368,7 +6702,7 @@ export interface paths { * @description Gets all custom properties defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-all-custom-properties"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definitions"]; put?: never; post?: never; delete?: never; @@ -5378,11 +6712,15 @@ export interface paths { * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. * + * If the property already exists, the existing property will be replaced with the new values. + * Missing optional values will fall back to default values, previous values will be overwritten. + * E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + * * To use this endpoint, the authenticated user must be one of: * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-definitions"]; trace?: never; }; "/orgs/{org}/properties/schema/{custom_property_name}": { @@ -5397,7 +6735,7 @@ export interface paths { * @description Gets a custom property that is defined for an organization. * Organization members can read these properties. */ - get: operations["orgs/get-custom-property"]; + get: operations["orgs/custom-properties-for-repos-get-organization-definition"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. @@ -5406,7 +6744,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - put: operations["orgs/create-or-update-custom-property"]; + put: operations["orgs/custom-properties-for-repos-create-or-update-organization-definition"]; post?: never; /** * Remove a custom property for an organization @@ -5416,7 +6754,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ - delete: operations["orgs/remove-custom-property"]; + delete: operations["orgs/custom-properties-for-repos-delete-organization-definition"]; options?: never; head?: never; patch?: never; @@ -5434,7 +6772,7 @@ export interface paths { * @description Lists organization repositories with all of their custom property values. * Organization members can read these properties. */ - get: operations["orgs/list-custom-properties-values-for-repos"]; + get: operations["orgs/custom-properties-for-repos-get-organization-values"]; put?: never; post?: never; delete?: never; @@ -5453,7 +6791,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ - patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + patch: operations["orgs/custom-properties-for-repos-create-or-update-organization-values"]; trace?: never; }; "/orgs/{org}/public_members": { @@ -5632,6 +6970,46 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset history + * @description Get the history of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get organization ruleset version + * @description Get a version of an organization ruleset. + */ + get: operations["orgs/get-org-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/secret-scanning/alerts": { parameters: { query?: never; @@ -5656,6 +7034,34 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/secret-scanning/pattern-configurations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List organization pattern configurations + * @description Lists the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `read:org` scope to use this endpoint. + */ + get: operations["secret-scanning/list-org-pattern-configs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + /** + * Update organization pattern configurations + * @description Updates the secret scanning pattern configurations for an organization. + * + * Personal access tokens (classic) need the `write:org` scope to use this endpoint. + */ + patch: operations["secret-scanning/update-org-pattern-configs"]; + trace?: never; + }; "/orgs/{org}/security-advisories": { parameters: { query?: never; @@ -5730,7 +7136,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/actions": { + "/orgs/{org}/settings/immutable-releases": { parameters: { query?: never; header?: never; @@ -5738,15 +7144,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for an organization - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get immutable releases settings for an organization + * @description Gets the immutable releases policy for repositories in an organization. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings"]; + /** + * Set immutable releases settings for an organization + * @description Sets the immutable releases policy for repositories in an organization. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-actions-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings"]; post?: never; delete?: never; options?: never; @@ -5754,7 +7164,7 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/packages": { + "/orgs/{org}/settings/immutable-releases/repositories": { parameters: { query?: never; header?: never; @@ -5762,15 +7172,19 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for an organization - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * List selected repositories for immutable releases enforcement + * @description List all of the repositories that have been selected for immutable releases enforcement in an organization. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + get: operations["orgs/get-immutable-releases-settings-repositories"]; + /** + * Set selected repositories for immutable releases enforcement + * @description Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-github-packages-billing-org"]; - put?: never; + put: operations["orgs/set-immutable-releases-settings-repositories"]; post?: never; delete?: never; options?: never; @@ -5778,25 +7192,29 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/settings/billing/shared-storage": { + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; + get?: never; /** - * Get shared storage billing for an organization - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Enable a selected repository for immutable releases in an organization + * @description Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ - get: operations["billing/get-shared-storage-billing-org"]; - put?: never; + put: operations["orgs/enable-selected-repository-immutable-releases-organization"]; post?: never; - delete?: never; + /** + * Disable a selected repository for immutable releases in an organization + * @description Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + */ + delete: operations["orgs/disable-selected-repository-immutable-releases-organization"]; options?: never; head?: never; patch?: never; @@ -5900,7 +7318,7 @@ export interface paths { * > [!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, + * The response contains metrics for up to 100 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. * @@ -5918,42 +7336,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/team/{team_slug}/copilot/usage": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a summary of Copilot usage for a team - * @description > [!NOTE] - * > 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. - * See the response schema tab for detailed metrics definitions. - * - * The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - * and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - * they must have telemetry enabled in their IDE. - * - * > [!NOTE] - * > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - * - * Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - * - * OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - */ - get: operations["copilot/usage-metrics-for-team"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -6019,286 +7401,6 @@ export interface paths { patch: operations["teams/update-in-org"]; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions - * @description List all discussions on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-in-org"]; - put?: never; - /** - * Create a discussion - * @description Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion - * @description Get a specific discussion on a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion - * @description Delete a discussion from a team's page. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments - * @description List all comments on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-in-org"]; - put?: never; - /** - * Create a discussion comment - * @description Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment - * @description Get a specific comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-in-org"]; - put?: never; - post?: never; - /** - * Delete a discussion comment - * @description Deletes a comment on a team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-in-org"]; - options?: never; - head?: never; - /** - * Update a discussion comment - * @description Edits the body text of a discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-in-org"]; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-in-org"]; - put?: never; - /** - * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion comment reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion-comment"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-in-org"]; - put?: never; - /** - * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-in-org"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Delete team discussion reaction - * @description > [!NOTE] - * > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["reactions/delete-for-team-discussion"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/invitations": { parameters: { query?: never; @@ -6402,66 +7504,6 @@ export interface paths { patch?: never; trace?: never; }; - "/orgs/{org}/teams/{team_slug}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects - * @description Lists the organization projects for a team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - */ - get: operations["teams/list-projects-in-org"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project - * @description Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - get: operations["teams/check-permissions-for-project-in-org"]; - /** - * Add or update team project permissions - * @description 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. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - put: operations["teams/add-or-update-project-permissions-in-org"]; - post?: never; - /** - * Remove a project from a team - * @description 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. This endpoint removes the project from the team, but does not delete the project. - * - * > [!NOTE] - * > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - */ - delete: operations["teams/remove-project-in-org"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/orgs/{org}/teams/{team_slug}/repos": { parameters: { query?: never; @@ -6581,227 +7623,6 @@ export interface paths { patch?: never; trace?: never; }; - "/projects/columns/cards/{card_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project card - * @description Gets information about a project card. - */ - get: operations["projects/get-card"]; - put?: never; - post?: never; - /** - * Delete a project card - * @description Deletes a project card - */ - delete: operations["projects/delete-card"]; - options?: never; - head?: never; - /** Update an existing project card */ - patch: operations["projects/update-card"]; - trace?: never; - }; - "/projects/columns/cards/{card_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project card */ - post: operations["projects/move-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project column - * @description Gets information about a project column. - */ - get: operations["projects/get-column"]; - put?: never; - post?: never; - /** - * Delete a project column - * @description Deletes a project column. - */ - delete: operations["projects/delete-column"]; - options?: never; - head?: never; - /** Update an existing project column */ - patch: operations["projects/update-column"]; - trace?: never; - }; - "/projects/columns/{column_id}/cards": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project cards - * @description Lists the project cards in a project. - */ - get: operations["projects/list-cards"]; - put?: never; - /** Create a project card */ - post: operations["projects/create-card"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/columns/{column_id}/moves": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** Move a project column */ - post: operations["projects/move-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a project - * @description Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/get"]; - put?: never; - post?: never; - /** - * Delete a project - * @description Deletes a project board. Returns a `404 Not Found` status if projects are disabled. - */ - delete: operations["projects/delete"]; - options?: never; - head?: never; - /** - * Update a project - * @description Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - patch: operations["projects/update"]; - trace?: never; - }; - "/projects/{project_id}/collaborators": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project collaborators - * @description Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators. - */ - get: operations["projects/list-collaborators"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - /** - * Add project collaborator - * @description Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator. - */ - put: operations["projects/add-collaborator"]; - post?: never; - /** - * Remove user as a collaborator - * @description Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator. - */ - delete: operations["projects/remove-collaborator"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/collaborators/{username}/permission": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get project permission for a user - * @description Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level. - */ - get: operations["projects/get-permission-for-user"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/projects/{project_id}/columns": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List project columns - * @description Lists the project columns in a project. - */ - get: operations["projects/list-columns"]; - put?: never; - /** - * Create a project column - * @description Creates a new project column. - */ - post: operations["projects/create-column"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/rate_limit": { parameters: { query?: never; @@ -6821,6 +7642,7 @@ export interface paths { * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." * * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -6849,7 +7671,8 @@ export interface paths { * @description The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. * * > [!NOTE] - * > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + * > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. */ get: operations["repos/get"]; put?: never; @@ -6949,6 +7772,66 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/cache/retention-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache retention limit for a repository + * @description Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-retention-limit-for-repository"]; + /** + * Set GitHub Actions cache retention limit for a repository + * @description Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + * not manually removed or evicted due to size constraints. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-retention-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/cache/storage-limit": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get GitHub Actions cache storage limit for a repository + * @description Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + get: operations["actions/get-actions-cache-storage-limit-for-repository"]; + /** + * Set GitHub Actions cache storage limit for a repository + * @description Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + * stored before eviction occurs. + * + * OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + */ + put: operations["actions/set-actions-cache-storage-limit-for-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/cache/usage": { parameters: { query?: never; @@ -7232,6 +8115,90 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get artifact and log retention settings for a repository + * @description Gets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-artifact-and-log-retention-settings-repository"]; + /** + * Set artifact and log retention settings for a repository + * @description Sets artifact and log retention settings for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-artifact-and-log-retention-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get fork PR contributor approval permissions for a repository + * @description Gets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-fork-pr-contributor-approval-permissions-repository"]; + /** + * Set fork PR contributor approval permissions for a repository + * @description Sets the fork PR contributor approval policy for a repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-fork-pr-contributor-approval-permissions-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get private repo fork PR workflow settings for a repository + * @description Gets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-private-repo-fork-pr-workflows-settings-repository"]; + /** + * Set private repo fork PR workflow settings for a repository + * @description Sets the settings for whether workflows from fork pull requests can run on a private repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/set-private-repo-fork-pr-workflows-settings-repository"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/actions/permissions/selected-actions": { parameters: { query?: never; @@ -7945,7 +8912,10 @@ export interface paths { }; /** * Get workflow run usage - * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * Anyone with read access to the repository can use this endpoint. * @@ -8275,7 +9245,10 @@ export interface paths { }; /** * Get workflow usage - * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + * @description > [!WARNING] + * > This endpoint is in the process of closing down. Refer to "[Actions Get workflow usage and Get workflow run usage endpoints closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)" for more information. + * + * Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * @@ -9007,11 +9980,9 @@ export interface paths { put?: never; /** * Rerequest a check run - * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; delete?: never; @@ -9128,8 +10099,6 @@ export interface paths { /** * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - * - * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; delete?: never; @@ -9236,7 +10205,7 @@ export interface paths { * Commit an autofix for a code scanning alert * @description Commits an autofix for a code scanning alert. * - * If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + * If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. */ @@ -9865,7 +10834,7 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using * [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ put: operations["codespaces/create-or-update-repo-secret"]; post?: never; @@ -9873,7 +10842,7 @@ export interface paths { * Delete a repository secret * @description Deletes a development environment secret in a repository using the secret name. * - * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -9891,12 +10860,12 @@ export interface paths { /** * List repository collaborators * @description For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - * Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + * The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. * * Team members will include the members of child teams. * - * The authenticated user must have push access to the repository to use this endpoint. - * + * The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; @@ -9928,11 +10897,13 @@ export interface paths { get: operations["repos/check-collaborator"]; /** * Add a repository collaborator - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + * @description Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * - * Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + * Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. * - * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + * For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: * * ``` * Cannot assign {member} permission of {role name} @@ -9942,6 +10913,8 @@ export interface paths { * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * + * For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + * * **Updating an existing collaborator's permission level** * * The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -9959,8 +10932,8 @@ export interface paths { * To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. * * This endpoint also: - * - Cancels any outstanding invitations - * - Unasigns the user from any issues + * - Cancels any outstanding invitations sent by the collaborator + * - Unassigns the user from any issues * - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. * - Unstars the repository * - Updates access permissions to packages @@ -9992,13 +10965,15 @@ export interface paths { }; /** * Get repository permissions for a user - * @description Checks the repository permission of a collaborator. The possible repository - * permissions are `admin`, `write`, `read`, and `none`. + * @description Checks the repository permission and role of a collaborator. * - * *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - * collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - * `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + * The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + * `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + * The `role_name` attribute provides the name of the assigned role, including custom roles. The + * `permission` can also be used to determine which base level of access the collaborator has to the repository. + * + * The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + * There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. */ get: operations["repos/get-collaborator-permission-level"]; put?: never; @@ -10241,7 +11216,7 @@ export interface paths { }; /** * List pull requests associated with a commit - * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + * @description Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. * * To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. */ @@ -11121,7 +12096,7 @@ export interface paths { * * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * - * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). * * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ @@ -11976,6 +12951,35 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/immutable-releases": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Check if immutable releases are enabled for a repository + * @description Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + * enforced by the repository owner. The authenticated user must have admin read access to the repository. + */ + get: operations["repos/check-immutable-releases"]; + /** + * Enable immutable releases + * @description Enables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + put: operations["repos/enable-immutable-releases"]; + post?: never; + /** + * Disable immutable releases + * @description Disables immutable releases for a repository. The authenticated user must have admin access to the repository. + */ + delete: operations["repos/disable-immutable-releases"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/import": { parameters: { query?: never; @@ -12370,6 +13374,37 @@ export interface paths { patch: operations["issues/update-comment"]; trace?: never; }; + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + /** + * Pin an issue comment + * @description You can use the REST API to pin comments on issues. + * + * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + put: operations["issues/pin-comment"]; + post?: never; + /** + * Unpin an issue comment + * @description You can use the REST API to unpin comments on issues. + */ + delete: operations["issues/unpin-comment"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { parameters: { query?: never; @@ -12596,6 +13631,105 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocked by + * @description You can use the REST API to list the dependencies an issue is blocked by. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocked-by"]; + put?: never; + /** + * Add a dependency an issue is blocked by + * @description You can use the REST API to add a 'blocked by' relationship to an issue. + * + * Creating content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + post: operations["issues/add-blocked-by-dependency"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Remove dependency an issue is blocked by + * @description You can use the REST API to remove a dependency that an issue is blocked by. + * + * Removing content too quickly using this endpoint may result in secondary rate limiting. + * For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + * and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + delete: operations["issues/remove-dependency-blocked-by"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List dependencies an issue is blocking + * @description You can use the REST API to list the dependencies an issue is blocking. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/list-dependencies-blocking"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/events": { parameters: { query?: never; @@ -12635,7 +13769,7 @@ export interface paths { put: operations["issues/set-labels"]; /** * Add labels to an issue - * @description Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. + * @description Adds labels to an issue. */ post: operations["issues/add-labels"]; /** @@ -12694,6 +13828,33 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/issues/{issue_number}/parent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get parent issue + * @description You can use the REST API to get the parent issue of a sub-issue. + * + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + * + * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ + get: operations["issues/get-parent"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { parameters: { query?: never; @@ -12780,11 +13941,11 @@ export interface paths { * List sub-issues * @description You can use the REST API to list the sub-issues on an issue. * - * This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). * - * - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - * - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + * - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. * - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["issues/list-sub-issues"]; @@ -13358,30 +14519,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List repository projects - * @description Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - get: operations["projects/list-for-repo"]; - put?: never; - /** - * Create a repository project - * @description Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-repo"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/properties/values": { parameters: { query?: never; @@ -13394,7 +14531,7 @@ export interface paths { * @description Gets all custom property values that are set for a repository. * Users with read access to the repository can use this endpoint. */ - get: operations["repos/get-custom-properties-values"]; + get: operations["repos/custom-properties-for-repos-get-repository-values"]; put?: never; post?: never; delete?: never; @@ -13407,7 +14544,7 @@ export interface paths { * * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. */ - patch: operations["repos/create-or-update-custom-properties-values"]; + patch: operations["repos/custom-properties-for-repos-create-or-update-repository-values"]; trace?: never; }; "/repos/{owner}/{repo}/pulls": { @@ -14450,6 +15587,46 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset history + * @description Get the history of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-history"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get repository ruleset version + * @description Get a version of a repository ruleset. + */ + get: operations["repos/get-repo-ruleset-version"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/secret-scanning/alerts": { parameters: { query?: never; @@ -14499,6 +15676,8 @@ export interface paths { * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. * + * You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + * * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -14565,6 +15744,9 @@ export interface paths { * Get secret scanning scan history for a repository * @description Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. * + * > [!NOTE] + * > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + * * OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. */ get: operations["secret-scanning/get-scan-history"]; @@ -14946,66 +16128,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/tags/protection": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Closing down - List tag protection states for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - * - * This returns the tag protection states of a repository. - * - * This information is only available to repository administrators. - */ - get: operations["repos/list-tag-protection"]; - put?: never; - /** - * Closing down - Create a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - * - * This creates a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - post: operations["repos/create-tag-protection"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - post?: never; - /** - * Closing down - Delete a tag protection state for a repository - * @deprecated - * @description > [!WARNING] - * > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - * - * This deletes a tag protection state for a repository. - * This endpoint is only available to repository administrators. - */ - delete: operations["repos/delete-tag-protection"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/repos/{owner}/{repo}/tarball/{ref}": { parameters: { query?: never; @@ -15529,250 +16651,6 @@ export interface paths { patch: operations["teams/update-legacy"]; trace?: never; }; - "/teams/{team_id}/discussions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - * - * List all discussions on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussions-legacy"]; - put?: never; - /** - * Create a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - * - * Get a specific discussion on a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List discussion comments (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - * - * List all comments on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/list-discussion-comments-legacy"]; - put?: never; - /** - * Create a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - * - * Creates a new comment on a team discussion. - * - * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["teams/create-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - * - * Get a specific comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["teams/get-discussion-comment-legacy"]; - put?: never; - post?: never; - /** - * Delete a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - * - * Deletes a comment on a team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - delete: operations["teams/delete-discussion-comment-legacy"]; - options?: never; - head?: never; - /** - * Update a discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - * - * Edits the body text of a discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - patch: operations["teams/update-discussion-comment-legacy"]; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-comment-legacy"]; - put?: never; - /** - * Create reaction for a team discussion comment (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-comment-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/discussions/{discussion_number}/reactions": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List reactions for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - */ - get: operations["reactions/list-for-team-discussion-legacy"]; - put?: never; - /** - * Create reaction for a team discussion (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - * - * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - * - * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - */ - post: operations["reactions/create-for-team-discussion-legacy"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/invitations": { parameters: { query?: never; @@ -15937,70 +16815,6 @@ export interface paths { patch?: never; trace?: never; }; - "/teams/{team_id}/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List team projects (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - */ - get: operations["teams/list-projects-legacy"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/teams/{team_id}/projects/{project_id}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Check team permissions for a project (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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. - */ - get: operations["teams/check-permissions-for-project-legacy"]; - /** - * Add or update team project permissions (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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. - */ - put: operations["teams/add-or-update-project-permissions-legacy"]; - post?: never; - /** - * Remove a project from a team (Legacy) - * @deprecated - * @description > [!WARNING] - * > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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. - */ - delete: operations["teams/remove-project-legacy"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/teams/{team_id}/repos": { parameters: { query?: never; @@ -16869,7 +17683,7 @@ export interface paths { * Create a public SSH key for the authenticated user * @description Adds a public SSH key to the authenticated user's GitHub account. * - * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; delete?: never; @@ -17304,26 +18118,6 @@ export interface paths { patch?: never; trace?: never; }; - "/user/projects": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * Create a user project - * @description Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - */ - post: operations["projects/create-for-authenticated-user"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/user/public_emails": { parameters: { query?: never; @@ -17625,6 +18419,26 @@ export interface paths { patch?: never; trace?: never; }; + "/user/{user_id}/projectsV2/{project_number}/drafts": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create draft item for user owned project + * @description Create draft issue item for the specified user owned project. + */ + post: operations["projects/create-draft-item-for-authenticated-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users": { parameters: { query?: never; @@ -17647,6 +18461,26 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{user_id}/projectsV2/{project_number}/views": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a view for a user-owned project + * @description Create a new view in a user-owned project. Views allow you to customize how items in a project are displayed and filtered. + */ + post: operations["projects/create-view-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}": { parameters: { query?: never; @@ -17673,6 +18507,90 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/attestations/bulk-list": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * List attestations by bulk subject digests + * @description List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + * + * The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + * + * **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + */ + post: operations["users/list-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/delete-request": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Delete attestations in bulk + * @description Delete artifact attestations in bulk by either subject digests or unique ID. + */ + post: operations["users/delete-attestations-bulk"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/digest/{subject_digest}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by subject digest + * @description Delete an artifact attestation by subject digest. + */ + delete: operations["users/delete-attestations-by-subject-digest"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/attestations/{attestation_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + post?: never; + /** + * Delete attestations by ID + * @description Delete an artifact attestation by unique ID that is associated with a repository owned by a user. + */ + delete: operations["users/delete-attestations-by-id"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/attestations/{subject_digest}": { parameters: { query?: never; @@ -18131,7 +19049,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/projects": { + "/users/{username}/projectsV2": { parameters: { query?: never; header?: never; @@ -18139,8 +19057,8 @@ export interface paths { cookie?: never; }; /** - * List user projects - * @description Lists projects for a user. + * List projects for user + * @description List all projects owned by a specific user accessible by the authenticated user. */ get: operations["projects/list-for-user"]; put?: never; @@ -18151,6 +19069,142 @@ export interface paths { patch?: never; trace?: never; }; + "/users/{username}/projectsV2/{project_number}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project for user + * @description Get a specific user-owned project. + */ + get: operations["projects/get-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List project fields for user + * @description List all fields for a specific user-owned project. + */ + get: operations["projects/list-fields-for-user"]; + put?: never; + /** + * Add field to user owned project + * @description Add a field to a specified user owned project. + */ + post: operations["projects/add-field-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get project field for user + * @description Get a specific field for a user-owned project. + */ + get: operations["projects/get-field-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user owned project + * @description List all items for a specific user-owned project accessible by the authenticated user. + */ + get: operations["projects/list-items-for-user"]; + put?: never; + /** + * Add item to user owned project + * @description Add an issue or pull request item to the specified user owned project. + */ + post: operations["projects/add-item-for-user"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/items/{item_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an item for a user owned project + * @description Get a specific item from a user-owned project. + */ + get: operations["projects/get-user-item"]; + put?: never; + post?: never; + /** + * Delete project item for user + * @description Delete a specific item from a user-owned project. + */ + delete: operations["projects/delete-item-for-user"]; + options?: never; + head?: never; + /** + * Update project item for user + * @description Update a specific item in a user-owned project. + */ + patch: operations["projects/update-item-for-user"]; + trace?: never; + }; + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List items for a user project view + * @description List items in a user project with the saved view's filter applied. + */ + get: operations["projects/list-view-items-for-user"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/users/{username}/received_events": { parameters: { query?: never; @@ -18216,7 +19270,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/actions": { + "/users/{username}/settings/billing/premium_request/usage": { parameters: { query?: never; header?: never; @@ -18224,14 +19278,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Actions billing for a user - * @description Gets the summary of the free and paid GitHub Actions minutes used. + * Get billing premium request usage report for a user + * @description Gets a report of premium request usage for a user. * - * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-github-actions-billing-user"]; + get: operations["billing/get-github-billing-premium-request-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18240,7 +19292,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/packages": { + "/users/{username}/settings/billing/usage": { parameters: { query?: never; header?: never; @@ -18248,14 +19300,12 @@ export interface paths { cookie?: never; }; /** - * Get GitHub Packages billing for a user - * @description Gets the free and paid storage used for GitHub Packages in gigabytes. + * Get billing usage report for a user + * @description Gets a report of the total usage for a user. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** This endpoint is only available to users with access to the enhanced billing platform. */ - get: operations["billing/get-github-packages-billing-user"]; + get: operations["billing/get-github-billing-usage-report-user"]; put?: never; post?: never; delete?: never; @@ -18264,7 +19314,7 @@ export interface paths { patch?: never; trace?: never; }; - "/users/{username}/settings/billing/shared-storage": { + "/users/{username}/settings/billing/usage/summary": { parameters: { query?: never; header?: never; @@ -18272,14 +19322,15 @@ export interface paths { cookie?: never; }; /** - * Get shared storage billing for a user - * @description Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + * Get billing usage summary for a user + * @description > [!NOTE] + * > This endpoint is in public preview and is subject to change. * - * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + * Gets a summary report of usage for a user. * - * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. + * **Note:** Only data from the past 24 months is accessible via this endpoint. */ - get: operations["billing/get-shared-storage-billing-user"]; + get: operations["billing/get-github-billing-usage-summary-report-user"]; put?: never; post?: never; delete?: never; @@ -18830,7 +19881,7 @@ export interface components { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" @@ -18838,16 +19889,10 @@ export interface components { */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * Format: uri @@ -18882,6 +19927,7 @@ export interface components { */ "hook-delivery-item": { /** + * Format: int64 * @description Unique identifier of the webhook delivery. * @example 42 */ @@ -18928,11 +19974,13 @@ export interface components { */ action: string | null; /** + * Format: int64 * @description The id of the GitHub App installation associated with this event. * @example 123 */ installation_id: number | null; /** + * Format: int64 * @description The id of the repository associated with this event. * @example 123 */ @@ -19104,6 +20152,16 @@ export interface components { * @enum {string} */ administration?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create and retrieve build artifact metadata records. + * @enum {string} + */ + artifact_metadata?: "read" | "write"; + /** + * @description The level of permission to create and retrieve the access token for repository attestations. + * @enum {string} + */ + attestations?: "read" | "write"; /** * @description The level of permission to grant the access token for checks on code. * @enum {string} @@ -19120,7 +20178,7 @@ export interface components { */ contents?: "read" | "write"; /** - * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @description The level of permission to grant the access token to manage Dependabot secrets. * @enum {string} */ dependabot_secrets?: "read" | "write"; @@ -19129,6 +20187,11 @@ export interface components { * @enum {string} */ deployments?: "read" | "write"; + /** + * @description The level of permission to grant the access token for discussions and related comments and labels. + * @enum {string} + */ + discussions?: "read" | "write"; /** * @description The level of permission to grant the access token for managing repository environments. * @enum {string} @@ -19139,6 +20202,11 @@ export interface components { * @enum {string} */ issues?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the merge queues for a repository. + * @enum {string} + */ + merge_queues?: "read" | "write"; /** * @description The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. * @enum {string} @@ -19209,6 +20277,11 @@ export interface components { * @enum {string} */ workflows?: "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property. + * @enum {string} + */ + custom_properties_for_organizations?: "read" | "write"; /** * @description The level of permission to grant the access token for organization teams and members. * @enum {string} @@ -19230,7 +20303,7 @@ export interface components { */ organization_custom_org_roles?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom property management. + * @description The level of permission to grant the access token for repository custom properties management at the organization level. * @enum {string} */ organization_custom_properties?: "read" | "write" | "admin"; @@ -19294,11 +20367,6 @@ export interface components { * @enum {string} */ organization_user_blocking?: "read" | "write"; - /** - * @description The level of permission to grant the access token to manage team discussions and related comments. - * @enum {string} - */ - team_discussions?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the email addresses belonging to a user. * @enum {string} @@ -19334,6 +20402,11 @@ export interface components { * @enum {string} */ starring?: "read" | "write"; + /** + * @description The level of permission to grant the access token for organization custom properties management at the enterprise level. + * @enum {string} + */ + enterprise_custom_properties_for_organizations?: "read" | "write" | "admin"; }; /** * Simple User @@ -19442,6 +20515,8 @@ export interface components { html_url: string; /** @example 1 */ app_id: number; + /** @example Iv1.ab1112223334445c */ + client_id?: string; /** @description The ID of the user or organization this token is being scoped to. */ target_id: number; /** @example Organization */ @@ -19730,6 +20805,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -19848,6 +20935,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; }; /** * Installation Token @@ -20375,6 +21467,28 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * Actions cache retention limit for an enterprise + * @description GitHub Actions cache retention policy for an enterprise. + */ + "actions-cache-retention-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an enterprise + * @description GitHub Actions cache storage policy for an enterprise. + */ + "actions-cache-storage-limit-for-enterprise": { + /** + * @description For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** @description A code security configuration */ "code-security-configuration": { /** @description The ID of the code security configuration */ @@ -20392,7 +21506,7 @@ export interface components { * @description The enablement status of GitHub Advanced Security * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -20418,6 +21532,16 @@ export interface components { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal + * @enum {string|null} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set" | null; + /** @description Feature options for code scanning */ + code_scanning_options?: { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** * @description The enablement status of code scanning default setup * @enum {string} @@ -20433,6 +21557,11 @@ export interface components { /** @description The label of the runner to use for code scanning when runner_type is 'labeled'. */ runner_label?: string | null; } | null; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -20459,6 +21588,8 @@ export interface components { * @enum {string} */ reviewer_type: "TEAM" | "ROLE"; + /** @description The ID of the security configuration associated with this bypass reviewer */ + security_configuration_id?: number; }[]; }; /** @@ -20471,6 +21602,21 @@ export interface components { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -20496,6 +21642,11 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** @description Security Configuration feature options for code scanning */ + "code-scanning-options": { + /** @description Whether to allow repos which use advanced setup */ + allow_advanced?: boolean | null; + } | null; /** @description Feature options for code scanning default setup */ "code-scanning-default-setup-options": { /** @@ -20893,6 +22044,36 @@ export interface components { * @description The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ "alert-auto-dismissed-at": string | null; + /** + * Dependabot alert dismissal request + * @description Information about an active dismissal request for this Dependabot alert. + */ + "dependabot-alert-dismissal-request-simple": { + /** @description The unique identifier of the dismissal request. */ + id?: number; + /** + * @description The current status of the dismissal request. + * @enum {string} + */ + status?: "pending" | "approved" | "rejected" | "cancelled"; + /** @description The user who requested the dismissal. */ + requester?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The login name of the user. */ + login?: string; + }; + /** + * Format: date-time + * @description The date and time when the dismissal request was created. + */ + created_at?: string; + /** + * Format: uri + * @description The API URL to get more information about this dismissal request. + */ + url?: string; + } | null; /** @description A Dependabot alert. */ "dependabot-alert-with-repository": { number: components["schemas"]["alert-number"]; @@ -20911,6 +22092,14 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -20929,81 +22118,86 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; repository: components["schemas"]["simple-repository"]; }; /** - * Format: date-time - * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - "nullable-alert-updated-at": string | null; - /** - * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. - * @enum {string} - */ - "secret-scanning-alert-state": "open" | "resolved"; - /** - * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. - * @enum {string|null} + * Enterprise Team + * @description Group of enterprise owners and/or members */ - "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; - "organization-secret-scanning-alert": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["nullable-alert-updated-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; + "enterprise-team": { + /** Format: int64 */ + id: number; + name: string; + description?: string; + slug: string; + /** Format: uri */ + url: string; /** - * Format: uri - * @description The REST API URL of the code locations for this alert. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example disabled | all */ - locations_url?: string; - state?: components["schemas"]["secret-scanning-alert-state"]; - resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + sync_to_organizations?: string; + /** @example disabled | selected | all */ + organization_selection_type?: string; + /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ + group_id: string | null; /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description Retired: this field will not be returned with GHEC enterprise teams. + * @example Justice League */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description The type of secret that secret scanning detected. */ - secret_type?: string; + group_name?: string | null; /** - * @description User-friendly name for the detected secret, matching the `secret_type`. - * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + * Format: uri + * @example https://github.com/enterprises/dc/teams/justice-league */ - secret_type_display_name?: string; - /** @description The secret that was detected. */ - secret?: string; - repository?: components["schemas"]["simple-repository"]; - /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed?: boolean | null; - push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + html_url: string; + members_url: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + }; + /** + * Organization Simple + * @description A GitHub organization. + */ + "organization-simple": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * Format: uri + * @example https://api.github.com/orgs/github */ - push_protection_bypassed_at?: string | null; - push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment when reviewing a push protection bypass. */ - push_protection_bypass_request_reviewer_comment?: string | null; - /** @description An optional comment when requesting a push protection bypass. */ - push_protection_bypass_request_comment?: string | null; + url: string; /** * Format: uri - * @description The URL to a push protection bypass request. + * @example https://api.github.com/orgs/github/repos */ - push_protection_bypass_request_html_url?: string | null; - /** @description The comment that was optionally added when this alert was closed */ - resolution_comment?: string | null; + repos_url: string; /** - * @description The token status as of the latest validity check. - * @enum {string} + * Format: uri + * @example https://api.github.com/orgs/github/events */ - 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; + 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; }; /** * Actor @@ -21019,6 +22213,193 @@ export interface components { /** Format: uri */ avatar_url: string; }; + /** + * Label + * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). + */ + label: { + /** + * Format: int64 + * @description Unique identifier for the label. + * @example 208045946 + */ + id: number; + /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ + node_id: string; + /** + * Format: uri + * @description URL for the label + * @example https://api.github.com/repositories/42/labels/bug + */ + url: string; + /** + * @description The name of the label. + * @example bug + */ + name: string; + /** + * @description Optional description of the label, such as its purpose. + * @example Something isn't working + */ + description: string | null; + /** + * @description 6-character hex code, without the leading #, identifying the color + * @example FFFFFF + */ + color: string; + /** + * @description Whether this label comes by default in a new repository. + * @example true + */ + default: boolean; + }; + /** + * Discussion + * @description A Discussion in a repository. + */ + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + answer_html_url: string | null; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; + id: number; + locked: boolean; + node_id: string; + number: number; + /** Reactions */ + reactions?: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + /** + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} + */ + state: "open" | "closed" | "locked" | "converting" | "transferring"; + /** + * @description The reason for the current state + * @example resolved + * @enum {string|null} + */ + state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + labels?: components["schemas"]["label"][]; + }; /** * Milestone * @description A collection of related issues and pull requests. @@ -21088,6 +22469,37 @@ export interface components { */ due_on: string | null; } | null; + /** + * Issue Type + * @description The type of issue. + */ + "issue-type": { + /** @description The unique identifier of the issue type. */ + id: number; + /** @description The node identifier of the issue type. */ + node_id: string; + /** @description The name of the issue type. */ + name: string; + /** @description The description of the issue type. */ + description: string | null; + /** + * @description The color of the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + /** + * Format: date-time + * @description The time the issue type created. + */ + created_at?: string; + /** + * Format: date-time + * @description The time the issue type last updated. + */ + updated_at?: string; + /** @description The enabled state of the issue type. */ + is_enabled?: boolean; + } | null; /** * GitHub app * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. @@ -21152,7 +22564,7 @@ export interface components { [key: string]: string; }; /** - * @description The list of events for the GitHub app + * @description The list of events for the GitHub app. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation. * @example [ * "label", * "deployment" @@ -21160,16 +22572,10 @@ export interface components { */ events: string[]; /** - * @description The number of installations associated with the GitHub app + * @description The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself. * @example 5 */ installations_count?: number; - /** @example "1d4b2097ac622ba702d19de498f005747a8b21d3" */ - client_secret?: string; - /** @example "6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b" */ - webhook_secret?: string | null; - /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ - pem?: string; } | null; /** * author_association @@ -21198,6 +22604,111 @@ export interface components { completed: number; percent_completed: number; }; + /** + * Pinned Issue Comment + * @description Context around who pinned an issue comment and when it was pinned. + */ + "nullable-pinned-issue-comment": { + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + pinned_at: string; + pinned_by: components["schemas"]["nullable-simple-user"]; + } | null; + /** + * Issue Comment + * @description Comments provide a way for people to collaborate on an issue. + */ + "nullable-issue-comment": { + /** + * Format: int64 + * @description Unique identifier of the issue comment + * @example 42 + */ + id: number; + node_id: string; + /** + * Format: uri + * @description URL for the issue comment + * @example https://api.github.com/repositories/42/issues/comments/1 + */ + url: string; + /** + * @description Contents of the issue comment + * @example What version of Safari were you using when you observed this bug? + */ + body?: string; + body_text?: string; + body_html?: string; + /** Format: uri */ + html_url: string; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-04-14T16:00:49Z + */ + updated_at: string; + /** Format: uri */ + issue_url: string; + author_association?: components["schemas"]["author-association"]; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + } | null; + /** Issue Dependencies Summary */ + "issue-dependencies-summary": { + blocked_by: number; + blocking: number; + total_blocked_by: number; + total_blocking: number; + }; + /** + * Issue Field Value + * @description A value assigned to an issue field + */ + "issue-field-value": { + /** + * Format: int64 + * @description Unique identifier for the issue field. + * @example 1 + */ + issue_field_id: number; + /** @example IFT_GDKND */ + node_id: string; + /** + * @description The data type of the issue field + * @example text + * @enum {string} + */ + data_type: "text" | "single_select" | "number" | "date"; + /** @description The value of the issue field */ + value: (string | number) | null; + /** @description Details about the selected option (only present for single_select fields) */ + single_select_option?: { + /** + * Format: int64 + * @description Unique identifier for the option. + * @example 1 + */ + id: number; + /** + * @description The name of the option + * @example High + */ + name: string; + /** + * @description The color of the option + * @example red + */ + color: string; + } | null; + }; /** * Issue * @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -21236,7 +22747,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -21296,11 +22807,20 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; }; /** * Issue Comment @@ -21342,9 +22862,132 @@ export interface components { updated_at: string; /** Format: uri */ issue_url: string; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; + }; + /** Pull Request Minimal */ + "pull-request-minimal": { + /** Format: int64 */ + id: number; + number: number; + url: string; + head: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + base: { + ref: string; + sha: string; + repo: { + /** Format: int64 */ + id: number; + url: string; + name: string; + }; + }; + }; + /** + * Release Asset + * @description Data related to a release. + */ + "release-asset": { + /** Format: uri */ + url: string; + /** Format: uri */ + browser_download_url: string; + id: number; + node_id: string; + /** + * @description The file name of the asset. + * @example Team Environment + */ + name: string; + label: string | null; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded" | "open"; + content_type: string; + size: number; + digest: string | null; + download_count: number; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + uploader: components["schemas"]["nullable-simple-user"]; + }; + /** + * Release + * @description A release. + */ + release: { + /** Format: uri */ + url: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + assets_url: string; + upload_url: string; + /** Format: uri */ + tarball_url: string | null; + /** Format: uri */ + zipball_url: string | null; + id: number; + node_id: string; + /** + * @description The name of the tag. + * @example v1.0.0 + */ + tag_name: string; + /** + * @description Specifies the commitish value that determines where the Git tag is created from. + * @example master + */ + target_commitish: string; + name: string | null; + body?: string | null; + /** + * @description true to create a draft (unpublished) release, false to create a published one. + * @example false + */ + draft: boolean; + /** + * @description Whether to identify the release as a prerelease or a full release. + * @example false + */ + prerelease: boolean; + /** + * @description Whether or not the release is immutable. + * @example false + */ + immutable?: boolean; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + published_at: string | null; + /** Format: date-time */ + updated_at?: string | null; + author: components["schemas"]["simple-user"]; + assets: components["schemas"]["release-asset"][]; + body_html?: string; + body_text?: string; + mentions_count?: number; + /** + * Format: uri + * @description The URL of the release discussion. + */ + discussion_url?: string; + reactions?: components["schemas"]["reaction-rollup"]; }; /** * Event @@ -21361,19 +23004,7 @@ export interface components { url: string; }; org?: components["schemas"]["actor"]; - payload: { - action?: string; - issue?: components["schemas"]["issue"]; - comment?: components["schemas"]["issue-comment"]; - pages?: { - page_name?: string; - title?: string; - summary?: string | null; - action?: string; - sha?: string; - html_url?: string; - }[]; - }; + payload: components["schemas"]["create-event"] | components["schemas"]["delete-event"] | components["schemas"]["discussion-event"] | components["schemas"]["issues-event"] | components["schemas"]["issue-comment-event"] | components["schemas"]["fork-event"] | components["schemas"]["gollum-event"] | components["schemas"]["member-event"] | components["schemas"]["public-event"] | components["schemas"]["push-event"] | components["schemas"]["pull-request-event"] | components["schemas"]["pull-request-review-comment-event"] | components["schemas"]["pull-request-review-event"] | components["schemas"]["commit-comment-event"] | components["schemas"]["release-event"] | components["schemas"]["watch-event"]; public: boolean; /** Format: date-time */ created_at: string | null; @@ -22044,10 +23675,19 @@ export interface components { }; }; "security-and-analysis": { + /** + * @description Enable or disable GitHub Advanced Security for the repository. + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ advanced_security?: { /** @enum {string} */ status?: "enabled" | "disabled"; }; + code_security?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; /** @description Enable or disable Dependabot security updates for the repository. */ dependabot_security_updates?: { /** @@ -22072,6 +23712,26 @@ export interface components { /** @enum {string} */ status?: "enabled" | "disabled"; }; + secret_scanning_delegated_alert_dismissal?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + secret_scanning_delegated_bypass?: { + /** @enum {string} */ + status?: "enabled" | "disabled"; + }; + 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"; + }[]; + }; } | null; /** * Minimal Repository @@ -22237,6 +23897,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -22273,7 +23939,7 @@ export interface components { key?: string; name?: string; spdx_id?: string; - url?: string; + url?: string | null; node_id?: string; } | null; /** @example 0 */ @@ -22286,6 +23952,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** * Thread @@ -22339,43 +24009,432 @@ export interface components { repository_url?: string; }; /** - * Organization Simple - * @description A GitHub organization. + * Actions cache retention limit for an organization + * @description GitHub Actions cache retention policy for an organization. */ - "organization-simple": { - /** @example github */ - login: string; - /** @example 1 */ + "actions-cache-retention-limit-for-organization": { + /** + * @description For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for an organization + * @description GitHub Actions cache storage policy for an organization. + */ + "actions-cache-storage-limit-for-organization": { + /** + * @description For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; + /** + * Simple Repository + * @description A GitHub repository. + */ + "nullable-simple-repository": { + /** + * Format: int64 + * @description A unique identifier of the repository. + * @example 1296269 + */ id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + /** + * @description The GraphQL identifier of the repository. + * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + */ node_id: string; + /** + * @description The name of the repository. + * @example Hello-World + */ + name: string; + /** + * @description The full, globally unique, name of the repository. + * @example octocat/Hello-World + */ + full_name: string; + owner: components["schemas"]["simple-user"]; + /** @description Whether the repository is private. */ + private: boolean; /** * Format: uri - * @example https://api.github.com/orgs/github + * @description The URL to view the repository on GitHub.com. + * @example https://github.com/octocat/Hello-World + */ + html_url: string; + /** + * @description The repository description. + * @example This your first repo! + */ + description: string | null; + /** @description Whether the repository is a fork. */ + fork: boolean; + /** + * Format: uri + * @description The URL to get more information about the repository from the GitHub API. + * @example https://api.github.com/repos/octocat/Hello-World */ url: string; + /** + * @description A template for the API URL to download the repository as an archive. + * @example https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + */ + archive_url: string; + /** + * @description A template for the API URL to list the available assignees for issues in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/assignees{/user} + */ + assignees_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git blob in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + */ + blobs_url: string; + /** + * @description A template for the API URL to get information about branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/branches{/branch} + */ + branches_url: string; + /** + * @description A template for the API URL to get information about collaborators of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + */ + collaborators_url: string; + /** + * @description A template for the API URL to get information about comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/comments{/number} + */ + comments_url: string; + /** + * @description A template for the API URL to get information about commits on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/commits{/sha} + */ + commits_url: string; + /** + * @description A template for the API URL to compare two commits or refs. + * @example https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + */ + compare_url: string; + /** + * @description A template for the API URL to get the contents of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contents/{+path} + */ + contents_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description A template for the API URL to list the contributors to the repository. + * @example https://api.github.com/repos/octocat/Hello-World/contributors */ - repos_url: string; + contributors_url: string; /** * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The API URL to list the deployments of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/deployments + */ + deployments_url: string; + /** + * Format: uri + * @description The API URL to list the downloads on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/downloads + */ + downloads_url: string; + /** + * Format: uri + * @description The API URL to list the events of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/events */ events_url: string; - /** @example https://api.github.com/orgs/github/hooks */ - hooks_url: string; - /** @example https://api.github.com/orgs/github/issues */ + /** + * Format: uri + * @description The API URL to list the forks of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/forks + */ + forks_url: string; + /** + * @description A template for the API URL to get information about Git commits of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + */ + git_commits_url: string; + /** + * @description A template for the API URL to get information about Git refs of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + */ + git_refs_url: string; + /** + * @description A template for the API URL to get information about Git tags of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + */ + git_tags_url: string; + /** + * @description A template for the API URL to get information about issue comments on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + */ + issue_comment_url: string; + /** + * @description A template for the API URL to get information about issue events on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + */ + issue_events_url: string; + /** + * @description A template for the API URL to get information about issues on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/issues{/number} + */ 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; + /** + * @description A template for the API URL to get information about deploy keys on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + */ + keys_url: string; + /** + * @description A template for the API URL to get information about labels of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/labels{/name} + */ + labels_url: string; + /** + * Format: uri + * @description The API URL to get information about the languages of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @description The API URL to merge branches in the repository. + * @example https://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** + * @description A template for the API URL to get information about milestones of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/milestones{/number} + */ + milestones_url: string; + /** + * @description A template for the API URL to get information about notifications on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + */ + notifications_url: string; + /** + * @description A template for the API URL to get information about pull requests on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/pulls{/number} + */ + pulls_url: string; + /** + * @description A template for the API URL to get information about releases on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/releases{/id} + */ + releases_url: string; + /** + * Format: uri + * @description The API URL to list the stargazers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** + * @description A template for the API URL to get information about statuses of a commit. + * @example https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + */ + statuses_url: string; + /** + * Format: uri + * @description The API URL to list the subscribers on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @description The API URL to subscribe to notifications for this repository. + * @example https://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @description The API URL to get information about tags on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @description The API URL to list the teams on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** + * @description A template for the API URL to create or retrieve a raw Git tree of the repository. + * @example https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + */ + trees_url: string; + /** + * Format: uri + * @description The API URL to list the hooks on the repository. + * @example https://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; + } | null; + /** + * Dependabot Repository Access Details + * @description Information about repositories that Dependabot is able to access in an organization + */ + "dependabot-repository-access-details": { + /** + * @description The default repository access level for Dependabot updates. + * @example internal + * @enum {string|null} + */ + default_level?: "public" | "internal" | null; + accessible_repositories?: components["schemas"]["nullable-simple-repository"][]; + }; + budget: { + /** + * @description The unique identifier for the budget + * @example 2066deda-923f-43f9-88d2-62395a28c0cdd + */ + id: string; + /** + * @description The type of pricing for the budget + * @example SkuPricing + * @enum {string} + */ + budget_type: "SkuPricing" | "ProductPricing"; + /** @description The budget amount limit in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description The type of limit enforcement for the budget + * @example true + */ + prevent_further_usage: boolean; + /** + * @description The scope of the budget (enterprise, organization, repository, cost center) + * @example enterprise + */ + budget_scope: string; + /** + * @description The name of the entity for the budget (enterprise does not require a name). + * @example octocat/hello-world + */ + budget_entity_name?: string; + /** @description A single product or sku to apply the budget to. */ + budget_product_sku: string; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients: string[]; + }; + }; + get_all_budgets: { + /** @description Array of budget objects for the enterprise */ + budgets: components["schemas"]["budget"][]; + /** @description Indicates if there are more pages of results available (maps to hasNextPage from billing platform) */ + has_next_page?: boolean; + /** @description Total number of budgets matching the query */ + total_count?: number; + }; + "get-budget": { + /** @description ID of the budget. */ + id: string; + /** + * @description The type of scope for the budget + * @example enterprise + * @enum {string} + */ + budget_scope: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @example octocat/hello-world + */ + budget_entity_name: string; + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount: number; + /** + * @description Whether to prevent additional spending once the budget is exceeded + * @example true + */ + prevent_further_usage: boolean; + /** + * @description A single product or sku to apply the budget to. + * @example actions_linux + */ + budget_product_sku: string; + /** + * @description The type of pricing for the budget + * @example ProductPricing + * @enum {string} + */ + budget_type: "ProductPricing" | "SkuPricing"; + budget_alerting: { + /** + * @description Whether alerts are enabled for this budget + * @example true + */ + will_alert?: boolean; + /** + * @description Array of user login names who will receive alerts + * @example [ + * "mona", + * "lisa" + * ] + */ + alert_recipients?: string[]; + }; + }; + "delete-budget": { + /** @description A message indicating the result of the deletion operation */ + message: string; + /** @description The ID of the deleted budget */ + id: string; + }; + "billing-premium-request-usage-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the user for the usage report. */ + user?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; "billing-usage-report": { usageItems?: { @@ -22403,6 +24462,46 @@ export interface components { repositoryName?: string; }[]; }; + "billing-usage-summary-report-org": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the organization. */ + organization: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; /** * Organization Full * @description Organization Full @@ -22508,6 +24607,11 @@ export interface components { seats?: number; }; default_repository_permission?: string | null; + /** + * @description The default branch for repositories created in this organization. + * @example main + */ + default_repository_branch?: string | null; /** @example true */ members_can_create_repositories?: boolean | null; /** @example true */ @@ -22526,6 +24630,22 @@ export interface components { members_can_create_public_pages?: boolean; /** @example true */ members_can_create_private_pages?: boolean; + /** @example true */ + members_can_delete_repositories?: boolean; + /** @example true */ + members_can_change_repo_visibility?: boolean; + /** @example true */ + members_can_invite_outside_collaborators?: boolean; + /** @example true */ + members_can_delete_issues?: boolean; + /** @example true */ + display_commenter_full_name_setting_enabled?: boolean; + /** @example true */ + readers_can_create_discussions?: boolean; + /** @example true */ + members_can_create_teams?: boolean; + /** @example true */ + members_can_view_dependency_insights?: boolean; /** @example false */ members_can_fork_private_repositories?: boolean | null; /** @example false */ @@ -22671,7 +24791,7 @@ export interface components { * @description The image version of the hosted runner pool. * @example latest */ - version: string; + version?: string; } | null; /** * Github-owned VM details. @@ -22772,12 +24892,91 @@ export interface components { * @example 2022-10-09T23:39:01Z */ last_active_on?: string | null; + /** @description Whether custom image generation is enabled for the hosted runners. */ + image_gen?: boolean; + }; + /** + * GitHub-hosted runner custom image details + * @description Provides details of a custom runner image + */ + "actions-hosted-runner-custom-image": { + /** + * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. + * @example 1 + */ + id: number; + /** + * @description The operating system of the image. + * @example linux-x64 + */ + platform: string; + /** + * @description Total size of all the image versions in GB. + * @example 200 + */ + total_versions_size: number; + /** + * @description Display name for this image. + * @example CustomImage + */ + name: string; + /** + * @description The image provider. + * @example custom + */ + source: string; + /** + * @description The number of image versions associated with the image. + * @example 4 + */ + versions_count: number; + /** + * @description The latest image version associated with the image. + * @example 1.3.0 + */ + latest_version: string; + /** + * @description The number of image versions associated with the image. + * @example Ready + */ + state: string; + }; + /** + * GitHub-hosted runner custom image version details. + * @description Provides details of a hosted runner custom image version + */ + "actions-hosted-runner-custom-image-version": { + /** + * @description The version of image. + * @example 1.0.0 + */ + version: string; + /** + * @description The state of image version. + * @example Ready + */ + state: string; + /** + * @description Image version size in GB. + * @example 30 + */ + size_gb: number; + /** + * @description The creation date time of the image version. + * @example 2024-11-09T23:39:01Z + */ + created_on: string; + /** + * @description The image version status details. + * @example None + */ + state_details: string; }; /** * GitHub-hosted runner image details. * @description Provides details of a hosted runner image */ - "actions-hosted-runner-image": { + "actions-hosted-runner-curated-image": { /** * @description The ID of the image. Use this ID for the `image` parameter when creating a new larger runner. * @example ubuntu-20.04 @@ -22847,12 +25046,52 @@ export interface components { "allowed-actions": "all" | "local_only" | "selected"; /** @description The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. */ "selected-actions-url": string; + /** @description Whether actions must be pinned to a full-length commit SHA. */ + "sha-pinning-required": boolean; "actions-organization-permissions": { enabled_repositories: components["schemas"]["enabled-repositories"]; /** @description The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. */ selected_repositories_url?: string; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; + }; + "actions-artifact-and-log-retention-response": { + /** @description The number of days artifacts and logs are retained */ + days: number; + /** @description The maximum number of days that can be configured */ + maximum_allowed_days: number; + }; + "actions-artifact-and-log-retention": { + /** @description The number of days to retain artifacts and logs */ + days: number; + }; + "actions-fork-pr-contributor-approval": { + /** + * @description The policy that controls when fork PR workflows require approval from a maintainer. + * @enum {string} + */ + approval_policy: "first_time_contributors_new_to_github" | "first_time_contributors" | "all_external_contributors"; + }; + "actions-fork-pr-workflows-private-repos": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows: boolean; + }; + "actions-fork-pr-workflows-private-repos-request": { + /** @description Whether workflows triggered by pull requests from forks are allowed to run on private repositories. */ + run_workflows_from_fork_pull_requests: boolean; + /** @description Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request. */ + send_write_tokens_to_workflows?: boolean; + /** @description Whether to make secrets and variables available to workflows triggered by pull requests from forks. */ + send_secrets_and_variables?: boolean; + /** @description Whether workflows triggered by pull requests from forks require approval from a repository administrator to run. */ + require_approval_for_fork_pr_workflows?: boolean; }; "selected-actions": { /** @description Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. */ @@ -22867,6 +25106,15 @@ export interface components { */ patterns_allowed?: string[]; }; + "self-hosted-runners-settings": { + /** + * @description The policy that controls whether self-hosted runners can be used by repositories in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + /** @description The URL to the endpoint for managing selected repositories for self-hosted runners in the organization */ + selected_repositories_url?: string; + }; /** * @description The default workflow permissions granted to the GITHUB_TOKEN when running workflows. * @enum {string} @@ -22930,12 +25178,12 @@ export interface components { */ runner: { /** - * @description The id of the runner. + * @description The ID of the runner. * @example 5 */ id: number; /** - * @description The id of the runner group. + * @description The ID of the runner group. * @example 1 */ runner_group_id?: number; @@ -22956,6 +25204,7 @@ export interface components { status: string; busy: boolean; labels: components["schemas"]["runner-label"][]; + ephemeral?: boolean; }; /** * Runner Application @@ -23090,101 +25339,314 @@ export interface components { */ selected_repositories_url?: string; }; - /** @description The name of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-name": string; - /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ - "code-scanning-analysis-tool-guid": string | null; /** - * @description State of a code scanning alert. - * @enum {string} + * Artifact Deployment Record + * @description Artifact Metadata Deployment Record */ - "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; + "artifact-deployment-record": { + id?: number; + digest?: string; + logical_environment?: string; + physical_environment?: string; + cluster?: string; + deployment_name?: string; + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + created_at?: string; + updated_at?: string; + /** @description The ID of the provenance attestation associated with the deployment record. */ + attestation_id?: number | null; + }; /** - * @description Severity of a code scanning alert. + * Campaign state + * @description Indicates whether a campaign is open or closed * @enum {string} */ - "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; - /** - * Format: uri - * @description The REST API URL for fetching the list of instances for an alert. - */ - "alert-instances-url": string; + "campaign-state": "open" | "closed"; /** - * @description State of a code scanning alert. - * @enum {string|null} + * Campaign alert type + * @description Indicates the alert type of a campaign + * @enum {string} */ - "code-scanning-alert-state": "open" | "dismissed" | "fixed" | null; + "campaign-alert-type": "code_scanning" | "secret_scanning"; /** - * @description **Required when the state is dismissed.** The reason for dismissing or closing the alert. - * @enum {string|null} + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. */ - "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; - /** @description The dismissal comment associated with the dismissal of the alert. */ - "code-scanning-alert-dismissed-comment": string | null; - "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; - /** @description The name of the rule used to detect the alert. */ - name?: string; + "nullable-team-simple": { /** - * @description The severity of the alert. - * @enum {string|null} + * @description Unique identifier of the team + * @example 1 */ - severity?: "none" | "note" | "warning" | "error" | null; + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; /** - * @description The security severity of the alert. - * @enum {string|null} + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - security_severity_level?: "low" | "medium" | "high" | "critical" | null; - /** @description A short description of the rule used to detect the alert. */ - description?: string; - /** @description A description of the rule used to detect the alert. */ - full_description?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - }; - /** @description The version of the tool used to generate the code scanning analysis. */ - "code-scanning-analysis-tool-version": string | null; - "code-scanning-analysis-tool": { - name?: components["schemas"]["code-scanning-analysis-tool-name"]; - version?: components["schemas"]["code-scanning-analysis-tool-version"]; - guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; - }; - /** - * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, - * `refs/heads/` or simply ``. - */ - "code-scanning-ref": string; - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - "code-scanning-analysis-analysis-key": string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - "code-scanning-alert-environment": string; - /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ - "code-scanning-analysis-category": string; - /** @description Describe a region within a file for the alert. */ - "code-scanning-alert-location": { - path?: string; - start_line?: number; - end_line?: number; - start_column?: number; - end_column?: number; - }; - /** - * @description A classification of the file. For example to identify it as generated. - * @enum {string|null} - */ - "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; - "code-scanning-alert-instance": { - ref?: components["schemas"]["code-scanning-ref"]; - analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; - environment?: components["schemas"]["code-scanning-alert-environment"]; - category?: components["schemas"]["code-scanning-analysis-category"]; - state?: components["schemas"]["code-scanning-alert-state"]; - commit_sha?: string; + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; + /** + * @description Name of the team + * @example Justice League + */ + name: string; + /** + * @description Description of the team + * @example A great team. + */ + description: string | null; + /** + * @description Permission that the team will have for its repositories + * @example admin + */ + permission: string; + /** + * @description The level of privacy this team should have + * @example closed + */ + privacy?: string; + /** + * @description The notification setting the team has set + * @example notifications_enabled + */ + notification_setting?: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos + */ + repositories_url: string; + /** @example justice-league */ + slug: string; + /** + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com + */ + ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + } | null; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + team: { + id: number; + node_id: string; + name: string; + slug: string; + description: string | null; + privacy?: string; + notification_setting?: string; + permission: string; + permissions?: { + pull: boolean; + triage: boolean; + push: boolean; + maintain: boolean; + admin: boolean; + }; + /** Format: uri */ + url: string; + /** + * Format: uri + * @example https://github.com/orgs/rails/teams/core + */ + html_url: string; + members_url: string; + /** Format: uri */ + repositories_url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; + parent: components["schemas"]["nullable-team-simple"]; + }; + /** + * Campaign summary + * @description The campaign metadata and alert stats. + */ + "campaign-summary": { + /** @description The number of the newly created campaign */ + number: number; + /** + * Format: date-time + * @description The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + created_at: string; + /** + * Format: date-time + * @description The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + updated_at: string; + /** @description The campaign name */ + name?: string; + /** @description The campaign description */ + description: string; + /** @description The campaign managers */ + managers: components["schemas"]["simple-user"][]; + /** @description The campaign team managers */ + team_managers?: components["schemas"]["team"][]; + /** + * Format: date-time + * @description The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + published_at?: string; + /** + * Format: date-time + * @description The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. + */ + ends_at: string; + /** + * Format: date-time + * @description The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + */ + closed_at?: string | null; + state: components["schemas"]["campaign-state"]; + /** + * Format: uri + * @description The contact link of the campaign. + */ + contact_link: string | null; + alert_stats?: { + /** @description The number of open alerts */ + open_count: number; + /** @description The number of closed alerts */ + closed_count: number; + /** @description The number of in-progress alerts */ + in_progress_count: number; + }; + }; + /** @description The name of the tool used to generate the code scanning analysis. */ + "code-scanning-analysis-tool-name": string; + /** @description The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. */ + "code-scanning-analysis-tool-guid": string | null; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + "code-scanning-alert-state-query": "open" | "closed" | "dismissed" | "fixed"; + /** + * @description Severity of a code scanning alert. + * @enum {string} + */ + "code-scanning-alert-severity": "critical" | "high" | "medium" | "low" | "warning" | "note" | "error"; + /** + * Format: uri + * @description The REST API URL for fetching the list of instances for an alert. + */ + "alert-instances-url": string; + /** + * @description State of a code scanning alert. + * @enum {string|null} + */ + "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} + */ + "code-scanning-alert-dismissed-reason": "false positive" | "won't fix" | "used in tests" | null; + /** @description The dismissal comment associated with the dismissal of the alert. */ + "code-scanning-alert-dismissed-comment": string | null; + "code-scanning-alert-rule-summary": { + /** @description A unique identifier for the rule used to detect the alert. */ + id?: string | null; + /** @description The name of the rule used to detect the alert. */ + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity?: "none" | "note" | "warning" | "error" | null; + /** + * @description The security severity of the alert. + * @enum {string|null} + */ + security_severity_level?: "low" | "medium" | "high" | "critical" | null; + /** @description A short description of the rule used to detect the alert. */ + description?: string; + /** @description A description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + }; + /** @description The version of the tool used to generate the code scanning analysis. */ + "code-scanning-analysis-tool-version": string | null; + "code-scanning-analysis-tool": { + name?: components["schemas"]["code-scanning-analysis-tool-name"]; + version?: components["schemas"]["code-scanning-analysis-tool-version"]; + guid?: components["schemas"]["code-scanning-analysis-tool-guid"]; + }; + /** + * @description The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, + * `refs/heads/` or simply ``. + */ + "code-scanning-ref": string; + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + "code-scanning-analysis-analysis-key": string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + "code-scanning-alert-environment": string; + /** @description Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. */ + "code-scanning-analysis-category": string; + /** @description Describe a region within a file for the alert. */ + "code-scanning-alert-location": { + path?: string; + start_line?: number; + end_line?: number; + start_column?: number; + end_column?: number; + }; + /** + * @description A classification of the file. For example to identify it as generated. + * @enum {string|null} + */ + "code-scanning-alert-classification": "source" | "generated" | "test" | "library" | null; + "code-scanning-alert-instance": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-state"]; + commit_sha?: string; message?: { text?: string; }; @@ -23213,6 +25675,8 @@ export interface components { tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * Codespace machine @@ -23470,17 +25934,17 @@ export interface components { created_at?: string; }; /** - * Copilot Business Seat Breakdown + * Copilot Seat Breakdown * @description The breakdown of Copilot Business seats for the organization. */ - "copilot-seat-breakdown": { + "copilot-organization-seat-breakdown": { /** @description The total number of seats being billed for the organization as of the current billing cycle. */ total?: number; /** @description Seats added during the current billing cycle. */ added_this_cycle?: number; /** @description The number of seats that are pending cancellation at the end of the current billing cycle. */ pending_cancellation?: number; - /** @description The number of seats that have been assigned to users that have not yet accepted an invitation to this organization. */ + /** @description The number of users who have been invited to receive a Copilot seat through this organization. */ pending_invitation?: number; /** @description The number of seats that have used Copilot during the current billing cycle. */ active_this_cycle?: number; @@ -23492,24 +25956,24 @@ export interface components { * @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"]; + seat_breakdown: components["schemas"]["copilot-organization-seat-breakdown"]; /** - * @description The organization policy for allowing or disallowing Copilot to make suggestions that match public code. + * @description The organization policy for allowing or blocking suggestions matching public code (duplication detection filter). * @enum {string} */ - public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + public_code_suggestions: "allow" | "block" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @description The organization policy for allowing or disallowing Copilot Chat in the IDE. * @enum {string} */ ide_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @description The organization policy for allowing or disallowing Copilot features on GitHub.com. * @enum {string} */ platform_chat?: "enabled" | "disabled" | "unconfigured"; /** - * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @description The organization policy for allowing or disallowing Copilot CLI. * @enum {string} */ cli?: "enabled" | "disabled" | "unconfigured"; @@ -23522,7 +25986,7 @@ export interface components { * @description The Copilot plan of the organization, or the parent enterprise, when applicable. * @enum {string} */ - plan_type?: "business" | "enterprise" | "unknown"; + plan_type?: "business" | "enterprise"; } & { [key: string]: unknown; }; @@ -23565,135 +26029,12 @@ export interface components { /** @example A great organization */ description: string | null; } | null; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "nullable-team-simple": { - /** - * @description Unique identifier of the team - * @example 1 - */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; - /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 - */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * @description Name of the team - * @example Justice League - */ - name: string; - /** - * @description Description of the team - * @example A great team. - */ - description: string | null; - /** - * @description Permission that the team will have for its repositories - * @example admin - */ - permission: string; - /** - * @description The level of privacy this team should have - * @example closed - */ - privacy?: string; - /** - * @description The notification setting the team has set - * @example notifications_enabled - */ - notification_setting?: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - /** @example justice-league */ - slug: string; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - id: number; - node_id: string; - name: string; - slug: string; - description: string | null; - privacy?: string; - notification_setting?: string; - permission: string; - permissions?: { - pull: boolean; - triage: boolean; - push: boolean; - maintain: boolean; - admin: boolean; - }; - /** Format: uri */ - url: string; - /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core - */ - html_url: string; - members_url: string; - /** Format: uri */ - repositories_url: string; - parent: components["schemas"]["nullable-team-simple"]; - }; - /** - * Enterprise Team - * @description Group of enterprise owners and/or members - */ - "enterprise-team": { - /** Format: int64 */ - id: number; - name: string; - slug: string; - /** Format: uri */ - url: string; - /** @example disabled | all */ - sync_to_organizations: string; - /** @example 62ab9291-fae2-468e-974b-7e45096d5021 */ - group_id?: string | null; - /** @example Justice League */ - group_name?: string | null; - /** - * Format: uri - * @example https://github.com/enterprises/dc/teams/justice-league - */ - html_url: string; - members_url: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - }; /** * Copilot Business Seat Detail * @description Information about a Copilot Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - assignee: components["schemas"]["simple-user"]; + assignee?: components["schemas"]["nullable-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; @@ -23709,6 +26050,11 @@ export interface components { last_activity_at?: string | null; /** @description Last editor that was used by the user for a GitHub Copilot completion. */ last_activity_editor?: string | null; + /** + * Format: date-time + * @description Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format. + */ + last_authenticated_at?: string | null; /** * Format: date-time * @description Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format. @@ -23726,6 +26072,13 @@ export interface components { */ plan_type?: "business" | "enterprise" | "unknown"; }; + /** + * Copilot Organization Content Exclusion Details + * @description List all Copilot Content Exclusion rules for an organization. + */ + "copilot-organization-content-exclusion-details": { + [key: string]: string[]; + }; /** @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. */ @@ -23785,7 +26138,7 @@ export interface components { total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ models?: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -23804,13 +26157,13 @@ export interface components { } & { [key: string]: unknown; }) | null; - /** @description Usage metrics for Copilot Chat in github.com */ + /** @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 model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot Chat. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -23836,7 +26189,7 @@ export interface components { total_engaged_users?: number; /** @description List of model metrics for custom models and the default model. */ models?: { - /** @description Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'. */ + /** @description Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'. */ name?: string; /** @description Indicates whether a model is custom or default. */ is_custom_model?: boolean; @@ -23872,52 +26225,6 @@ export interface components { } & { [key: string]: unknown; }; - /** - * Copilot Usage Metrics - * @description Summary of Copilot usage. - */ - "copilot-usage-metrics": { - /** - * Format: date - * @description The date for which the usage metrics are reported, in `YYYY-MM-DD` format. - */ - day: string; - /** @description The total number of Copilot code completion suggestions shown to users. */ - total_suggestions_count?: number; - /** @description The total number of Copilot code completion suggestions accepted by users. */ - total_acceptances_count?: number; - /** @description The total number of lines of code completions suggested by Copilot. */ - total_lines_suggested?: number; - /** @description The total number of lines of code completions accepted by users. */ - total_lines_accepted?: number; - /** @description The total number of users who were shown Copilot code completion suggestions during the day specified. */ - total_active_users?: number; - /** @description The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline). */ - total_chat_acceptances?: number; - /** @description The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE. */ - total_chat_turns?: number; - /** @description The total number of users who interacted with Copilot Chat in the IDE during the day specified. */ - total_active_chat_users?: number; - /** @description Breakdown of Copilot code completions usage by language and editor */ - breakdown: ({ - /** @description The language in which Copilot suggestions were shown to users in the specified editor. */ - language?: string; - /** @description The editor in which Copilot suggestions were shown to users for the specified language. */ - editor?: string; - /** @description The number of Copilot suggestions shown to users in the editor specified during the day specified. */ - suggestions_count?: number; - /** @description The number of Copilot suggestions accepted by users in the editor specified during the day specified. */ - acceptances_count?: number; - /** @description The number of lines of code suggested by Copilot in the editor specified during the day specified. */ - lines_suggested?: number; - /** @description The number of lines of code accepted by users in the editor specified during the day specified. */ - lines_accepted?: number; - /** @description The number of users who were shown Copilot completion suggestions in the editor specified during the day specified. */ - active_users?: number; - } & { - [key: string]: unknown; - })[] | null; - }; /** * Dependabot Secret for an Organization * @description Secrets for GitHub Dependabot for an organization. @@ -24123,6 +26430,12 @@ export interface components { has_pages?: boolean; has_downloads?: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived?: boolean; disabled?: boolean; visibility?: string; @@ -24159,7 +26472,7 @@ export interface components { key?: string; name?: string; spdx_id?: string; - url?: string; + url?: string | null; node_id?: string; } | null; /** @example 0 */ @@ -24172,6 +26485,10 @@ export interface components { /** @example false */ web_commit_signoff_required?: boolean; security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; } | null; /** * Package @@ -24406,6 +26723,32 @@ export interface components { limit: components["schemas"]["interaction-group"]; expiry?: components["schemas"]["interaction-expiry"]; }; + "organization-create-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; + "organization-update-issue-type": { + /** @description Name of the issue type. */ + name: string; + /** @description Whether or not the issue type is enabled at the organization level. */ + is_enabled: boolean; + /** @description Description of the issue type. */ + description?: string | null; + /** + * @description Color for the issue type. + * @enum {string|null} + */ + color?: "gray" | "blue" | "green" | "yellow" | "orange" | "red" | "pink" | "purple" | null; + }; /** * Org Membership * @description Org Membership @@ -24428,6 +26771,20 @@ export interface components { * @enum {string} */ role: "admin" | "member" | "billing_manager"; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; /** * Format: uri * @example https://api.github.com/orgs/octocat @@ -24560,6 +26917,21 @@ export interface components { /** Format: uri */ repositories_url: string; parent: components["schemas"]["nullable-team-simple"]; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Team Simple @@ -24623,6 +26995,21 @@ export interface components { * @example uid=example,ou=users,dc=github,dc=com */ ldap_dn?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * A Role Assignment for a User @@ -24855,12 +27242,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string | null; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. * @enum {string} @@ -24885,12 +27282,22 @@ export interface components { * @description The registry type. * @enum {string} */ - registry_type: "maven_repository"; + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; /** * @description The username to use when authenticating with the private registry. * @example monalisa */ username?: string; + /** + * @description Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base: boolean; /** * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. * @enum {string} @@ -24904,69 +27311,568 @@ export interface components { updated_at: string; }; /** - * Project - * @description Projects are a way to organize columns and cards of work. + * Projects v2 Status Update + * @description An status update belonging to a project */ - project: { + "nullable-projects-v2-status-update": { + /** @description The unique identifier of the status update. */ + id: number; + /** @description The node ID of the status update. */ + node_id: string; + /** @description The node ID of the project that this status update belongs to. */ + project_node_id?: string; + creator?: components["schemas"]["simple-user"]; /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test + * Format: date-time + * @description The time when the status update was created. + * @example 2022-04-28T12:00:00Z */ - owner_url: string; + created_at: string; + /** + * Format: date-time + * @description The time when the status update was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The current status. + * @enum {string|null} + */ + status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; + /** + * Format: date + * @description The start date of the period covered by the update. + * @example 2022-04-28 + */ + start_date?: string; + /** + * Format: date + * @description The target date associated with the update. + * @example 2022-04-28 + */ + target_date?: string; + /** + * @description Body of the status update + * @example The project is off to a great start! + */ + body?: string | null; + } | null; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + /** @description The unique identifier of the project. */ + id: number; + /** @description The node ID of the project. */ + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + /** @description The project title. */ + title: string; + /** @description A short description of the project. */ + description: string | null; + /** @description Whether the project is visible to anyone with access to the owner. */ + public: boolean; + /** + * Format: date-time + * @description The time when the project was closed. + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @description The time when the project was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the project was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** @description The project number. */ + number: number; + /** @description A concise summary of the project. */ + short_description: string | null; + /** + * Format: date-time + * @description The time when the project was deleted. + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: components["schemas"]["nullable-simple-user"]; + /** + * @description The current state of the project. + * @enum {string} + */ + state?: "open" | "closed"; + latest_status_update?: components["schemas"]["nullable-projects-v2-status-update"]; + /** @description Whether this project is a template */ + is_template?: boolean; + }; + /** + * Link + * @description Hypermedia Link + */ + link: { + href: string; + }; + /** + * Auto merge + * @description The status of auto merging a pull request. + */ + "auto-merge": { + enabled_by: components["schemas"]["simple-user"]; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + /** @description Title for the merge commit message. */ + commit_title: string; + /** @description Commit message for the merge commit. */ + commit_message: string; + } | null; + /** + * Pull Request Simple + * @description Pull Request Simple + */ + "pull-request-simple": { /** * Format: uri - * @example https://api.github.com/projects/1002604 + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 */ url: string; + /** + * Format: int64 + * @example 1 + */ + id: number; + /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + node_id: string; /** * Format: uri - * @example https://github.com/api-playground/projects-test/projects/12 + * @example https://github.com/octocat/Hello-World/pull/1347 */ html_url: string; /** * Format: uri - * @example https://api.github.com/projects/1002604/columns + * @example https://github.com/octocat/Hello-World/pull/1347.diff */ - columns_url: string; - /** @example 1002604 */ + diff_url: string; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World/pull/1347.patch + */ + patch_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + */ + commits_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + */ + review_comments_url: string; + /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ + review_comment_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + */ + comments_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + */ + statuses_url: string; + /** @example 1347 */ + number: number; + /** @example open */ + state: string; + /** @example true */ + locked: boolean; + /** @example new-feature */ + title: string; + user: components["schemas"]["nullable-simple-user"]; + /** @example Please pull these awesome changes */ + body: string | null; + labels: { + /** Format: int64 */ + id: number; + node_id: string; + url: string; + name: string; + description: string; + color: string; + default: boolean; + }[]; + milestone: components["schemas"]["nullable-milestone"]; + /** @example too heated */ + active_lock_reason?: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + created_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + updated_at: string; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + merged_at: string | null; + /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ + merge_commit_sha: string | null; + assignee: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][] | null; + requested_reviewers?: components["schemas"]["simple-user"][] | null; + requested_teams?: components["schemas"]["team"][] | null; + head: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + base: { + label: string; + ref: string; + repo: components["schemas"]["repository"]; + sha: string; + user: components["schemas"]["nullable-simple-user"]; + }; + _links: { + comments: components["schemas"]["link"]; + commits: components["schemas"]["link"]; + statuses: components["schemas"]["link"]; + html: components["schemas"]["link"]; + issue: components["schemas"]["link"]; + review_comments: components["schemas"]["link"]; + review_comment: components["schemas"]["link"]; + self: components["schemas"]["link"]; + }; + author_association: components["schemas"]["author-association"]; + auto_merge: components["schemas"]["auto-merge"]; + /** + * @description Indicates whether or not the pull request is a draft. + * @example false + */ + draft?: boolean; + }; + /** + * Draft Issue + * @description A draft issue in a project + */ + "projects-v2-draft-issue": { + /** @description The ID of the draft issue */ id: number; - /** @example MDc6UHJvamVjdDEwMDI2MDQ= */ + /** @description The node ID of the draft issue */ node_id: string; + /** @description The title of the draft issue */ + title: string; + /** @description The body content of the draft issue */ + body?: string | null; + user: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time the draft issue was created + */ + created_at: string; + /** + * Format: date-time + * @description The time the draft issue was last updated + */ + updated_at: string; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-simple": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** @description The content represented by the item. */ + content?: components["schemas"]["issue"] | components["schemas"]["pull-request-simple"] | components["schemas"]["projects-v2-draft-issue"]; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; /** - * @description Name of the project - * @example Week One Sprint + * Format: date-time + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z */ + updated_at: string; + /** + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The URL of the project this item belongs to. + */ + project_url?: string; + /** + * Format: uri + * @description The URL of the item in the project. + */ + item_url?: string; + }; + /** + * Projects v2 Single Select Option + * @description An option for a single select field + */ + "projects-v2-single-select-options": { + /** @description The unique identifier of the option. */ + id: string; + /** @description The display name of the option, in raw text and HTML formats. */ + name: { + raw: string; + html: string; + }; + /** @description The description of the option, in raw text and HTML formats. */ + description: { + raw: string; + html: string; + }; + /** @description The color associated with the option. */ + color: string; + }; + /** + * Projects v2 Iteration Setting + * @description An iteration setting for an iteration field + */ + "projects-v2-iteration-settings": { + /** @description The unique identifier of the iteration setting. */ + id: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date: string; + /** @description The duration of the iteration in days. */ + duration: number; + /** @description The iteration title, in raw text and HTML formats. */ + title: { + raw: string; + html: string; + }; + /** @description Whether the iteration has been completed. */ + completed: boolean; + }; + /** + * Projects v2 Field + * @description A field inside a projects v2 project + */ + "projects-v2-field": { + /** @description The unique identifier of the field. */ + id: number; + /** @description The node ID of the field. */ + node_id?: string; + /** + * @description The API URL of the project that contains the field. + * @example https://api.github.com/projects/1 + */ + project_url: string; + /** @description The name of the field. */ name: string; /** - * @description Body of the project - * @example This project represents the sprint of the first week in January + * @description The field's data type. + * @enum {string} */ - body: string | null; - /** @example 1 */ - number: number; + data_type: "assignees" | "linked_pull_requests" | "reviewers" | "labels" | "milestone" | "repository" | "title" | "text" | "single_select" | "number" | "date" | "iteration" | "issue_type" | "parent_issue" | "sub_issues_progress"; + /** @description The options available for single select fields. */ + options?: components["schemas"]["projects-v2-single-select-options"][]; + /** @description Configuration for iteration fields. */ + configuration?: { + /** @description The day of the week when the iteration starts. */ + start_day?: number; + /** @description The duration of the iteration in days. */ + duration?: number; + iterations?: components["schemas"]["projects-v2-iteration-settings"][]; + }; /** - * @description State of the project; either 'open' or 'closed' - * @example open + * Format: date-time + * @description The time when the field was created. + * @example 2022-04-28T12:00:00Z */ - state: string; - creator: components["schemas"]["nullable-simple-user"]; + created_at: string; /** * Format: date-time - * @example 2011-04-10T20:09:31Z + * @description The time when the field was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + }; + "projects-v2-field-single-select-option": { + /** @description The display name of the option. */ + name?: string; + /** + * @description The color associated with the option. + * @enum {string} + */ + color?: "BLUE" | "GRAY" | "GREEN" | "ORANGE" | "PINK" | "PURPLE" | "RED" | "YELLOW"; + /** @description The description of the option. */ + description?: string; + }; + /** @description The configuration for iteration fields. */ + "projects-v2-field-iteration-configuration": { + /** + * Format: date + * @description The start date of the first iteration. + */ + start_date?: string; + /** @description The default duration for iterations in days. Individual iterations can override this value. */ + duration?: number; + /** @description Zero or more iterations for the field. */ + iterations?: { + /** @description The title of the iteration. */ + title?: string; + /** + * Format: date + * @description The start date of the iteration. + */ + start_date?: string; + /** @description The duration of the iteration in days. */ + duration?: number; + }[]; + }; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item-with-content": { + /** @description The unique identifier of the project item. */ + id: number; + /** @description The node ID of the project item. */ + node_id?: string; + /** + * Format: uri + * @description The API URL of the project that contains this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/3 + */ + project_url?: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + /** @description The content of the item, which varies by content type. */ + content?: { + [key: string]: unknown; + } | null; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the item was created. + * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time - * @example 2014-03-03T18:58:10Z + * @description The time when the item was last updated. + * @example 2022-04-28T12:00:00Z */ updated_at: string; /** - * @description The baseline permission that all organization members have on this project. Only present if owner is an organization. + * Format: date-time + * @description The time when the item was archived. + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + /** + * Format: uri + * @description The API URL of this item. + * @example https://api.github.com/users/monalisa/2/projectsV2/items/3 + */ + item_url?: string | null; + /** @description The fields and values associated with this item. */ + fields?: { + [key: string]: unknown; + }[]; + }; + /** + * Projects v2 View + * @description A view inside a projects v2 project + */ + "projects-v2-view": { + /** @description The unique identifier of the view. */ + id: number; + /** @description The number of the view within the project. */ + number: number; + /** @description The name of the view. */ + name: string; + /** + * @description The layout of the view. * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ - private?: boolean; + layout: "table" | "board" | "roadmap"; + /** @description The node ID of the view. */ + node_id: string; + /** + * @description The API URL of the project that contains the view. + * @example https://api.github.com/orgs/octocat/projectsV2/1 + */ + project_url: string; + /** + * Format: uri + * @description The web URL of the view. + * @example https://github.com/orgs/octocat/projects/1/views/1 + */ + html_url: string; + creator: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time when the view was created. + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @description The time when the view was last updated. + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * @description The filter query for the view. + * @example is:issue is:open + */ + filter?: string | null; + /** @description The list of field IDs that are visible in the view. */ + visible_fields: number[]; + /** @description The sorting configuration for the view. Each element is a tuple of [field_id, direction] where direction is "asc" or "desc". */ + sort_by: (number | string)[][]; + /** @description The list of field IDs used for horizontal grouping. */ + group_by: number[]; + /** @description The list of field IDs used for vertical grouping (board layout). */ + vertical_group_by: number[]; }; /** * Organization Custom Property @@ -24991,7 +27897,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -25009,6 +27915,8 @@ export interface components { * @enum {string|null} */ values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Set Payload @@ -25020,7 +27928,7 @@ export interface components { * @example single_select * @enum {string} */ - value_type: "string" | "single_select" | "multi_select" | "true_false"; + value_type: "string" | "single_select" | "multi_select" | "true_false" | "url"; /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ @@ -25032,6 +27940,14 @@ export interface components { * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; + /** @description Whether setting properties values is mandatory */ + require_explicit_values?: boolean; }; /** * Custom Property Value @@ -25295,6 +28211,18 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -25413,6 +28341,11 @@ export interface components { starred_at?: string; /** @description Whether anonymous git access is enabled for this repository */ anonymous_access_enabled?: boolean; + /** @description The status of the code search index for this repository */ + code_search_index_status?: { + lexical_search_ok?: boolean; + lexical_commit_sha?: string; + }; } | null; /** * Code Of Conduct Simple @@ -25635,6 +28568,14 @@ export interface components { has_downloads?: boolean; /** @example true */ has_discussions: boolean; + /** @example true */ + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @example all + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -25757,7 +28698,7 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ + /** @description The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. */ actor_id?: number | null; /** * @description The type of actor that can bypass a ruleset. @@ -25765,11 +28706,11 @@ 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. Also, `pull_request` is only applicable to branch rulesets. + * @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. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created. * @default always * @enum {string} */ - bypass_mode: "always" | "pull_request"; + bypass_mode: "always" | "pull_request" | "exempt"; }; /** * Repository ruleset conditions for ref names @@ -25928,17 +28869,29 @@ export interface components { /** @enum {string} */ type: "required_signatures"; }; + /** + * Reviewer + * @description A required reviewing team + */ + "repository-rule-params-reviewer": { + /** @description ID of the reviewer which must review changes to matching files. */ + id: number; + /** + * @description The type of the reviewer + * @enum {string} + */ + type: "Team"; + }; /** * 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. */ + /** @description Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax. */ 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; + reviewer: components["schemas"]["repository-rule-params-reviewer"]; }; /** * pull_request @@ -25948,8 +28901,8 @@ export interface components { /** @enum {string} */ type: "pull_request"; parameters?: { - /** @description When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled. */ - allowed_merge_methods?: string[]; + /** @description Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled. */ + allowed_merge_methods?: ("merge" | "squash" | "rebase")[]; /** @description New, reviewable commits pushed will dismiss previous pull request review approvals. */ dismiss_stale_reviews_on_push: boolean; /** @description Require an approving review in pull requests that modify files that have a designated code owner. */ @@ -25960,6 +28913,13 @@ export interface components { required_approving_review_count: number; /** @description All conversations on code must be resolved before a pull request can be merged. */ required_review_thread_resolution: boolean; + /** + * @description > [!NOTE] + * > `required_reviewers` is in beta and subject to change. + * + * A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + */ + required_reviewers?: components["schemas"]["repository-rule-params-required-reviewer-configuration"][]; }; }; /** @@ -26004,7 +28964,7 @@ export interface components { /** @enum {string} */ type: "commit_message_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26025,7 +28985,7 @@ export interface components { /** @enum {string} */ type: "commit_author_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26046,7 +29006,7 @@ export interface components { /** @enum {string} */ type: "committer_email_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26067,7 +29027,7 @@ export interface components { /** @enum {string} */ type: "branch_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26088,7 +29048,7 @@ export interface components { /** @enum {string} */ type: "tag_name_pattern"; parameters?: { - /** @description How this rule will appear to users. */ + /** @description How this rule appears when configuring it. */ name?: string; /** @description If true, the rule will fail if the pattern matches. */ negate?: boolean; @@ -26101,6 +29061,54 @@ export interface components { pattern: string; }; }; + /** + * file_path_restriction + * @description Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names. + */ + "repository-rule-file-path-restriction": { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + }; + /** + * max_file_path_length + * @description Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph. + */ + "repository-rule-max-file-path-length": { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths. */ + max_file_path_length: number; + }; + }; + /** + * file_extension_restriction + * @description Prevent commits that include files with specified file extensions from being pushed to the commit graph. + */ + "repository-rule-file-extension-restriction": { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + }; + /** + * max_file_size + * @description Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. + */ + "repository-rule-max-file-size": { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + }; /** * RestrictedCommits * @description Restricted commit @@ -26170,38 +29178,35 @@ export interface components { }; }; /** - * Repository Rule - * @description A repository rule. + * copilot_code_review + * @description Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { - /** @enum {string} */ - type: "file_path_restriction"; - parameters?: { - /** @description The file paths that are restricted from being pushed to the commit graph. */ - restricted_file_paths: string[]; - }; - } | { + "repository-rule-copilot-code-review": { /** @enum {string} */ - type: "max_file_path_length"; + type: "copilot_code_review"; parameters?: { - /** @description The maximum amount of characters allowed in file paths */ - max_file_path_length: number; + /** @description Copilot automatically reviews draft pull requests before they are marked as ready for review. */ + review_draft_pull_requests?: boolean; + /** @description Copilot automatically reviews each new push to the pull request. */ + review_on_push?: boolean; }; - } | { - /** @enum {string} */ - type: "file_extension_restriction"; - parameters?: { - /** @description The file extensions that are restricted from being pushed to the commit graph. */ - restricted_file_extensions: string[]; - }; - } | { - /** @enum {string} */ - type: "max_file_size"; - parameters?: { - /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ - max_file_size: number; - }; - } | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"]; + }; + /** + * CopilotCodeReviewAnalysisTool + * @description A tool that must provide code review results for this rule to pass. + */ + "repository-rule-params-copilot-code-review-analysis-tool": { + /** + * @description The name of a code review analysis tool + * @enum {string} + */ + name: "CodeQL" | "ESLint" | "PMD"; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-merge-queue"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -26231,7 +29236,7 @@ export interface components { * querying the repository-level endpoint. * @enum {string} */ - current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + current_user_can_bypass?: "always" | "pull_requests_only" | "never" | "exempt"; node_id?: string; _links?: { self?: { @@ -26250,6 +29255,11 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** + * Repository Rule + * @description A repository rule. + */ + "org-rules": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-file-path-restriction"] | components["schemas"]["repository-rule-max-file-path-length"] | components["schemas"]["repository-rule-file-extension-restriction"] | components["schemas"]["repository-rule-max-file-size"] | components["schemas"]["repository-rule-workflows"] | components["schemas"]["repository-rule-code-scanning"] | components["schemas"]["repository-rule-copilot-code-review"]; /** * Rule Suites * @description Response @@ -26287,6 +29297,44 @@ export interface components { */ evaluation_result?: "pass" | "fail" | "bypass"; }[]; + /** + * Pull request rule suite metadata + * @description Metadata for a pull request rule evaluation result. + */ + "rule-suite-pull-request": { + /** @description The pull request associated with the rule evaluation. */ + pull_request?: { + /** @description The unique identifier of the pull request. */ + id?: number; + /** @description The number of the pull request. */ + number?: number; + /** @description The user who created the pull request. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The reviews associated with the pull request. */ + reviews?: { + /** @description The unique identifier of the review. */ + id?: number; + /** @description The user who submitted the review. */ + user?: { + /** @description The unique identifier of the user. */ + id?: number; + /** @description The handle for the GitHub user account. */ + login?: string; + /** @description The type of the user. */ + type?: string; + }; + /** @description The state of the review. */ + state?: string; + }[]; + }; + }; /** * Rule Suite * @description Response @@ -26298,9 +29346,9 @@ export interface components { actor_id?: number | null; /** @description The handle for the GitHub user account. */ actor_name?: string | null; - /** @description The first commit sha before the push evaluation. */ + /** @description The previous commit SHA of the ref. */ before_sha?: string; - /** @description The last commit sha in the push evaluation. */ + /** @description The new commit SHA of the ref. */ after_sha?: string; /** @description The ref name that the evaluation ran on. */ ref?: string; @@ -26349,6 +29397,320 @@ export interface components { details?: string | null; }[]; }; + /** + * Ruleset version + * @description The historical version of a ruleset + */ + "ruleset-version": { + /** @description The ID of the previous version of the ruleset */ + version_id: number; + /** @description The actor who updated the ruleset */ + actor: { + id?: number; + type?: string; + }; + /** Format: date-time */ + updated_at: string; + }; + "ruleset-version-with-state": components["schemas"]["ruleset-version"] & { + /** @description The state of the ruleset version */ + state: Record; + }; + /** + * Format: date-time + * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + "nullable-alert-updated-at": string | null; + /** + * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. + * @enum {string} + */ + "secret-scanning-alert-state": "open" | "resolved"; + /** + * @description **Required when the `state` is `resolved`.** The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null; + /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ + "secret-scanning-location-commit": { + /** + * @description The file path in the repository + * @example /example/secrets.txt + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** @description The API URL to get the associated blob resource */ + blob_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + commit_sha: string; + /** @description The API URL to get the associated commit resource */ + commit_url: string; + }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; + /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ + "secret-scanning-location-issue-title": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_title_url: string; + }; + /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ + "secret-scanning-location-issue-body": { + /** + * Format: uri + * @description The API URL to get the issue where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 + */ + issue_body_url: string; + }; + /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ + "secret-scanning-location-issue-comment": { + /** + * Format: uri + * @description The API URL to get the issue comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + issue_comment_url: string; + }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; + /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */ + "nullable-secret-scanning-first-detected-location": (components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]) | null; + "organization-secret-scanning-alert": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + state?: components["schemas"]["secret-scanning-alert-state"]; + resolution?: components["schemas"]["secret-scanning-alert-resolution"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description User-friendly name for the detected secret, matching the `secret_type`. + * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + */ + secret_type_display_name?: string; + /** @description The secret that was detected. */ + secret?: string; + repository?: components["schemas"]["simple-repository"]; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment when reviewing a push protection bypass. */ + push_protection_bypass_request_reviewer_comment?: string | null; + /** @description An optional comment when requesting a push protection bypass. */ + push_protection_bypass_request_comment?: string | null; + /** + * Format: uri + * @description The URL to a push protection bypass request. + */ + push_protection_bypass_request_html_url?: string | null; + /** @description The comment that was optionally added when this alert was closed */ + resolution_comment?: string | null; + /** + * @description The token status as of the latest validity check. + * @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; + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */ + "secret-scanning-row-version": string | null; + "secret-scanning-pattern-override": { + /** @description The ID of the pattern. */ + token_type?: string; + /** @description The version of this pattern if it's a custom pattern. */ + custom_pattern_version?: string | null; + /** @description The slug of the pattern. */ + slug?: string; + /** @description The user-friendly name for the pattern. */ + display_name?: string; + /** @description The total number of alerts generated by this pattern. */ + alert_total?: number; + /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */ + alert_total_percentage?: number; + /** @description The number of false positive alerts generated by this pattern. */ + false_positives?: number; + /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */ + false_positive_rate?: number; + /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */ + bypass_rate?: number; + /** + * @description The default push protection setting for this pattern. + * @enum {string} + */ + default_setting?: "disabled" | "enabled"; + /** + * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise. + * @enum {string|null} + */ + enterprise_setting?: "not-set" | "disabled" | "enabled" | null; + /** + * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting. + * @enum {string} + */ + setting?: "not-set" | "disabled" | "enabled"; + }; + /** + * Secret scanning pattern configuration + * @description A collection of secret scanning patterns and their settings related to push protection. + */ + "secret-scanning-pattern-configuration": { + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Overrides for partner patterns. */ + provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + /** @description Overrides for custom patterns defined by the organization. */ + custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ @@ -26475,61 +29837,19 @@ export interface components { /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ readonly private_fork: components["schemas"]["simple-repository"] | null; }; - "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; - minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - total?: number; - }; - }; - "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; + /** + * Check immutable releases organization settings + * @description Check immutable releases settings for an organization. + */ + "immutable-releases-organization-settings": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */ + selected_repositories_url?: string; }; /** * Hosted compute network configuration @@ -26556,6 +29876,16 @@ export interface components { * @example 123ABC456DEF789 */ network_settings_ids?: string[]; + /** + * @description The unique identifier of each failover network settings in the configuration. + * @example 123ABC456DEF789 + */ + failover_network_settings_ids?: string[]; + /** + * @description Indicates whether the failover network resource is enabled. + * @example true + */ + failover_network_enabled?: boolean; /** * Format: date-time * @description The time at which the network configuration was created, in ISO 8601 format. @@ -26726,6 +30056,11 @@ export interface components { /** Format: date-time */ archived_at: string | null; }; + /** + * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. + * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com + */ + "ldap-dn": string; /** * Full Team * @description Groups of organization members that gives permissions on specified repositories. @@ -26798,163 +30133,22 @@ export interface components { */ updated_at: string; organization: components["schemas"]["team-organization"]; + ldap_dn?: components["schemas"]["ldap-dn"]; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** @example 0 */ - comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; - /** - * @description The unique sequence number of a team discussion. - * @example 42 - */ - number: number; - /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true - */ - pinned: boolean; - /** - * @description Whether or not this discussion should be restricted to team members and organization owners. - * @example true - */ - private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Team Discussion Comment - * @description A reply to a discussion within a team. - */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - body: string; - /** @example

Do you like apples?

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 + * @description The ownership type of the team + * @enum {string} */ - discussion_url: string; + type: "enterprise" | "organization"; /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + * @description Unique identifier of the organization to which this team belongs + * @example 37 */ - html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; + organization_id?: number; /** - * @description The unique sequence number of a team discussion comment. + * @description Unique identifier of the enterprise to which this team belongs * @example 42 */ - number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - updated_at: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - reaction: { - /** @example 1 */ - id: number; - /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z - */ - created_at: string; + enterprise_id?: number; }; /** * Team Membership @@ -26976,34 +30170,6 @@ export interface components { */ state: "active" | "pending"; }; - /** - * Team Project - * @description A team's access to a project. - */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; - permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; - }; /** * Team Repository * @description A team's access to a repository. @@ -27309,111 +30475,6 @@ export interface components { watchers: number; master_branch?: string; }; - /** - * Project Card - * @description Project cards represent a scope of work. - */ - "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - url: string; - /** - * Format: int64 - * @description The project card's ID - * @example 42 - */ - id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; - /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @example 2016-09-05T14:21:06Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:20:22Z - */ - updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - column_name?: string; - project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - }; - /** - * Project Column - * @description Project columns contain cards of work. - */ - "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - updated_at: string; - }; - /** - * Project Collaborator Permission - * @description Project Collaborator Permission - */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; - }; /** Rate Limit */ "rate-limit": { limit: number; @@ -27437,6 +30498,7 @@ export interface components { actions_runner_registration?: components["schemas"]["rate-limit"]; scim?: components["schemas"]["rate-limit"]; dependency_snapshots?: components["schemas"]["rate-limit"]; + dependency_sbom?: components["schemas"]["rate-limit"]; code_scanning_autofix?: components["schemas"]["rate-limit"]; }; rate: components["schemas"]["rate-limit"]; @@ -27472,6 +30534,11 @@ export interface components { expires_at: string | null; /** Format: date-time */ updated_at: string | null; + /** + * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null. + * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c + */ + digest?: string | null; workflow_run?: { /** @example 10 */ id?: number; @@ -27485,6 +30552,28 @@ export interface components { head_sha?: string; } | null; }; + /** + * Actions cache retention limit for a repository + * @description GitHub Actions cache retention policy for a repository. + */ + "actions-cache-retention-limit-for-repository": { + /** + * @description The maximum number of days to keep caches in this repository. + * @example 14 + */ + max_cache_retention_days?: number; + }; + /** + * Actions cache storage limit for a repository + * @description GitHub Actions cache storage policy for a repository. + */ + "actions-cache-storage-limit-for-repository": { + /** + * @description The maximum total cache size for this repository, in gigabytes. + * @example 10 + */ + max_cache_size_gb?: number; + }; /** * Repository actions caches * @description Repository actions caches @@ -27718,6 +30807,7 @@ export interface components { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; selected_actions_url?: components["schemas"]["selected-actions-url"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; "actions-workflow-access-to-repository": { /** @@ -27738,33 +30828,6 @@ export interface components { sha: string; ref?: string; }; - /** Pull Request Minimal */ - "pull-request-minimal": { - /** Format: int64 */ - id: number; - number: number; - url: string; - head: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - base: { - ref: string; - sha: string; - repo: { - /** Format: int64 */ - id: number; - url: string; - name: string; - }; - }; - }; /** * Simple Commit * @description A commit. @@ -28215,6 +31278,26 @@ export interface components { */ deleted_at?: string; }; + /** + * Workflow Run ID + * Format: int64 + * @description The ID of the workflow run. + */ + "workflow-run-id": number; + /** + * Workflow Dispatch Response + * @description Response containing the workflow run ID and URLs. + */ + "workflow-dispatch-response": { + workflow_run_id: components["schemas"]["workflow-run-id"]; + /** + * Format: uri + * @description The URL to the workflow run. + */ + run_url: string; + /** Format: uri */ + html_url: string; + }; /** * Workflow Usage * @description Workflow Usage @@ -28292,6 +31375,8 @@ export interface components { * @example true */ is_alphanumeric: boolean; + /** Format: date-time */ + updated_at?: string | null; }; /** * Check Dependabot security updates @@ -28418,21 +31503,7 @@ export interface components { site_admin?: boolean; user_view_type?: string; }[]; - teams: { - id?: number; - node_id?: string; - url?: string; - html_url?: string; - name?: string; - slug?: string; - description?: string | null; - privacy?: string; - notification_setting?: string; - permission?: string; - members_url?: string; - repositories_url?: string; - parent?: string | null; - }[]; + teams: components["schemas"]["team"][]; apps: { id?: number; slug?: string; @@ -28566,7 +31637,10 @@ export interface components { name?: string; /** @example "chris@ozmm.org" */ email?: string; - /** @example "2007-10-29T02:42:39.000-07:00" */ + /** + * Format: date-time + * @example "2007-10-29T02:42:39.000-07:00" + */ date?: string; } | null; /** Verification */ @@ -28575,7 +31649,7 @@ export interface components { reason: string; payload: string | null; signature: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** * Diff Entry @@ -28583,7 +31657,7 @@ export interface components { */ "diff-entry": { /** @example bbcd538c8e72b8c175046e27cc8f907076331401 */ - sha: string; + sha: string | null; /** @example file1.txt */ filename: string; /** @@ -29100,6 +32174,8 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule-summary"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; "code-scanning-alert-rule": { /** @description A unique identifier for the rule used to detect the alert. */ @@ -29143,12 +32219,18 @@ export interface components { rule: components["schemas"]["code-scanning-alert-rule"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; + dismissal_approved_by?: components["schemas"]["nullable-simple-user"]; + assignees?: components["schemas"]["simple-user"][]; }; /** * @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`. * @enum {string} */ "code-scanning-alert-set-state": "open" | "dismissed"; + /** @description If `true`, attempt to create an alert dismissal request. */ + "code-scanning-alert-create-request": boolean; + /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */ + "code-scanning-alert-assignees": string[]; /** * @description The status of an autofix. * @enum {string} @@ -29179,6 +32261,29 @@ export interface components { /** @description SHA of commit with autofix. */ sha?: string; }; + /** + * @description State of a code scanning alert instance. + * @enum {string|null} + */ + "code-scanning-alert-instance-state": "open" | "fixed" | null; + "code-scanning-alert-instance-list": { + ref?: components["schemas"]["code-scanning-ref"]; + analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"]; + environment?: components["schemas"]["code-scanning-alert-environment"]; + category?: components["schemas"]["code-scanning-analysis-category"]; + state?: components["schemas"]["code-scanning-alert-instance-state"]; + commit_sha?: string; + message?: { + text?: string; + }; + location?: components["schemas"]["code-scanning-alert-location"]; + html_url?: string; + /** + * @description Classifications that have been applied to the file that triggered the alert. + * For example identifying it as documentation, or a generated file. + */ + classifications?: components["schemas"]["code-scanning-alert-classification"][]; + }; /** * @description An identifier for the upload. * @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -29277,7 +32382,7 @@ export interface components { * @description The language targeted by the CodeQL query * @enum {string} */ - "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift"; + "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift"; /** * Repository Identifier * @description Repository Identifier @@ -29424,6 +32529,11 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** * Format: date-time * @description Timestamp of latest configuration update. @@ -29458,6 +32568,11 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; + /** + * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input. + * @enum {string} + */ + threat_model?: "remote" | "remote_and_local"; /** @description CodeQL languages to be analyzed. */ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[]; }; @@ -29857,180 +32972,38 @@ export interface components { reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Branch Short - * @description Branch Short - */ - "branch-short": { - name: string; - commit: { - sha: string; - url: string; - }; - protected: boolean; - }; - /** - * Link - * @description Hypermedia Link - */ - link: { - href: string; - }; - /** - * Auto merge - * @description The status of auto merging a pull request. - */ - "auto-merge": { - enabled_by: components["schemas"]["simple-user"]; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - /** @description Title for the merge commit message. */ - commit_title: string; - /** @description Commit message for the merge commit. */ - commit_message: string; - } | null; - /** - * Pull Request Simple - * @description Pull Request Simple + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - "pull-request-simple": { - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347 - */ - url: string; - /** - * Format: int64 - * @example 1 - */ + reaction: { + /** @example 1 */ id: number; - /** @example MDExOlB1bGxSZXF1ZXN0MQ== */ + /** @example MDg6UmVhY3Rpb24x */ node_id: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347 - */ - html_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.diff - */ - diff_url: string; - /** - * Format: uri - * @example https://github.com/octocat/Hello-World/pull/1347.patch - */ - patch_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - */ - commits_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - */ - review_comments_url: string; - /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */ - review_comment_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - */ - comments_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - */ - statuses_url: string; - /** @example 1347 */ - number: number; - /** @example open */ - state: string; - /** @example true */ - locked: boolean; - /** @example new-feature */ - title: string; user: components["schemas"]["nullable-simple-user"]; - /** @example Please pull these awesome changes */ - body: string | null; - labels: { - /** Format: int64 */ - id: number; - node_id: string; - url: string; - name: string; - description: string; - color: string; - default: boolean; - }[]; - milestone: components["schemas"]["nullable-milestone"]; - /** @example too heated */ - active_lock_reason?: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - created_at: string; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - updated_at: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * @description The reaction to use + * @example heart + * @enum {string} */ - closed_at: string | null; + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** * Format: date-time - * @example 2011-01-26T19:01:12Z + * @example 2016-05-20T20:09:31Z */ - merged_at: string | null; - /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */ - merge_commit_sha: string | null; - assignee: components["schemas"]["nullable-simple-user"]; - assignees?: components["schemas"]["simple-user"][] | null; - requested_reviewers?: components["schemas"]["simple-user"][] | null; - requested_teams?: components["schemas"]["team"][] | null; - head: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; - sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; - base: { - label: string; - ref: string; - repo: components["schemas"]["repository"]; + created_at: string; + }; + /** + * Branch Short + * @description Branch Short + */ + "branch-short": { + name: string; + commit: { sha: string; - user: components["schemas"]["nullable-simple-user"]; - }; - _links: { - comments: components["schemas"]["link"]; - commits: components["schemas"]["link"]; - statuses: components["schemas"]["link"]; - html: components["schemas"]["link"]; - issue: components["schemas"]["link"]; - review_comments: components["schemas"]["link"]; - review_comment: components["schemas"]["link"]; - self: components["schemas"]["link"]; + url: string; }; - author_association: components["schemas"]["author-association"]; - auto_merge: components["schemas"]["auto-merge"]; - /** - * @description Indicates whether or not the pull request is a draft. - * @example false - */ - draft?: boolean; + protected: boolean; }; /** Simple Commit Status */ "simple-commit-status": { @@ -30226,6 +33199,7 @@ export interface components { self: string; }; }[]; + encoding?: string; _links: { /** Format: uri */ git: string | null; @@ -30491,6 +33465,14 @@ export interface components { * @enum {string|null} */ readonly scope?: "development" | "runtime" | null; + /** + * @description The vulnerable dependency's relationship to your project. + * + * > [!NOTE] + * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + * @enum {string|null} + */ + readonly relationship?: "unknown" | "direct" | "transitive" | null; }; security_advisory: components["schemas"]["dependabot-alert-security-advisory"]; security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"]; @@ -30509,6 +33491,9 @@ export interface components { dismissed_comment: string | null; fixed_at: components["schemas"]["alert-fixed-at"]; auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"]; + dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"]; + /** @description The users assigned to this alert. */ + readonly assignees?: components["schemas"]["simple-user"][]; }; /** * Dependabot Secret @@ -31172,7 +34157,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -31242,7 +34227,7 @@ export interface components { "git-tree": { sha: string; /** Format: uri */ - url: string; + url?: string; truncated: boolean; /** * @description Objects specifying a tree structure @@ -31253,47 +34238,19 @@ export interface components { * "type": "blob", * "size": 30, * "sha": "44b4fc6d56897b048c772eb4087f854f46256132", - * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132", - * "properties": { - * "path": { - * "type": "string" - * }, - * "mode": { - * "type": "string" - * }, - * "type": { - * "type": "string" - * }, - * "size": { - * "type": "integer" - * }, - * "sha": { - * "type": "string" - * }, - * "url": { - * "type": "string" - * } - * }, - * "required": [ - * "path", - * "mode", - * "type", - * "sha", - * "url", - * "size" - * ] + * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132" * } * ] */ tree: { /** @example test/file.rb */ - path?: string; + path: string; /** @example 040000 */ - mode?: string; + mode: string; /** @example tree */ - type?: string; + type: string; /** @example 23f6827669e43831def8a7ad935069c8bd418261 */ - sha?: string; + sha: string; /** @example 12 */ size?: number; /** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */ @@ -31368,6 +34325,22 @@ export interface components { deliveries_url?: string; last_response: components["schemas"]["hook-response"]; }; + /** + * Check immutable releases + * @description Check immutable releases + */ + "check-immutable-releases": { + /** + * @description Whether immutable releases are enabled for the repository. + * @example true + */ + enabled: boolean; + /** + * @description Whether immutable releases are enforced by the repository owner. + * @example false + */ + enforced_by_owner: boolean; + }; /** * Import * @description A repository import from an external source. @@ -31470,7 +34443,7 @@ export interface components { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "reopened" | "not_planned" | null; + state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null; /** * @description Title of the issue * @example Widget creation fails in Safari on OS X 10.8 @@ -31530,11 +34503,20 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; repository?: components["schemas"]["repository"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; - author_association: components["schemas"]["author-association"]; + author_association?: components["schemas"]["author-association"]; reactions?: components["schemas"]["reaction-rollup"]; sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + /** + * Format: uri + * @description URL to get the parent issue of this issue, if it is a sub-issue + */ + parent_issue_url?: string | null; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; } | null; /** * Issue Event Label @@ -31930,46 +34912,6 @@ export interface components { * @description Issue Event for Issue */ "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"]; - /** - * Label - * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail). - */ - label: { - /** - * Format: int64 - * @description Unique identifier for the label. - * @example 208045946 - */ - id: number; - /** @example MDU6TGFiZWwyMDgwNDU5NDY= */ - node_id: string; - /** - * Format: uri - * @description URL for the label - * @example https://api.github.com/repositories/42/labels/bug - */ - url: string; - /** - * @description The name of the label. - * @example bug - */ - name: string; - /** - * @description Optional description of the label, such as its purpose. - * @example Something isn't working - */ - description: string | null; - /** - * @description 6-character hex code, without the leading #, identifying the color - * @example FFFFFF - */ - color: string; - /** - * @description Whether this label comes by default in a new repository. - * @example true - */ - default: boolean; - }; /** * Timeline Comment Event * @description Timeline Comment Event @@ -32014,6 +34956,7 @@ export interface components { author_association: components["schemas"]["author-association"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; reactions?: components["schemas"]["reaction-rollup"]; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** * Timeline Cross Referenced Event @@ -32113,7 +35056,7 @@ export interface components { reason: string; signature: string | null; payload: string | null; - verified_at?: string | null; + verified_at: string | null; }; /** Format: uri */ html_url: string; @@ -32159,6 +35102,8 @@ export interface components { }; /** Format: date-time */ submitted_at?: string; + /** Format: date-time */ + updated_at?: string | null; /** * @description A commit SHA for the review. * @example 54bb654c9e6025347f57900a4a5c2313a96b8035 @@ -32230,7 +35175,7 @@ export interface components { * @example 8 */ in_reply_to_id?: number; - user: components["schemas"]["simple-user"]; + user: components["schemas"]["nullable-simple-user"]; /** * @description The text of the comment. * @example We should probably include a check for null values here. @@ -32410,6 +35355,7 @@ export interface components { created_at: string; read_only: boolean; added_by?: string | null; + /** Format: date-time */ last_used?: string | null; enabled?: boolean; }; @@ -33093,93 +36039,11 @@ export interface components { * @example 2 */ original_start_line?: number | null; - }; - /** - * Release Asset - * @description Data related to a release. - */ - "release-asset": { - /** Format: uri */ - url: string; - /** Format: uri */ - browser_download_url: string; - id: number; - node_id: string; /** - * @description The file name of the asset. - * @example Team Environment - */ - name: string; - label: string | null; - /** - * @description State of the release asset. + * @description The level at which the comment is targeted, can be a diff line or a file. * @enum {string} */ - state: "uploaded" | "open"; - content_type: string; - size: number; - download_count: number; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - uploader: components["schemas"]["nullable-simple-user"]; - }; - /** - * Release - * @description A release. - */ - release: { - /** Format: uri */ - url: string; - /** Format: uri */ - html_url: string; - /** Format: uri */ - assets_url: string; - upload_url: string; - /** Format: uri */ - tarball_url: string | null; - /** Format: uri */ - zipball_url: string | null; - id: number; - node_id: string; - /** - * @description The name of the tag. - * @example v1.0.0 - */ - tag_name: string; - /** - * @description Specifies the commitish value that determines where the Git tag is created from. - * @example master - */ - target_commitish: string; - name: string | null; - body?: string | null; - /** - * @description true to create a draft (unpublished) release, false to create a published one. - * @example false - */ - draft: boolean; - /** - * @description Whether to identify the release as a prerelease or a full release. - * @example false - */ - prerelease: boolean; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - published_at: string | null; - author: components["schemas"]["simple-user"]; - assets: components["schemas"]["release-asset"][]; - body_html?: string; - body_text?: string; - mentions_count?: number; - /** - * Format: uri - * @description The URL of the release discussion. - */ - discussion_url?: string; - reactions?: components["schemas"]["reaction-rollup"]; + subject_type?: "line" | "file"; }; /** * Generated Release Notes Content @@ -33213,7 +36077,7 @@ export interface components { * Repository Rule * @description A repository rule with ruleset details. */ - "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]); + "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; created_at?: components["schemas"]["alert-created-at"]; @@ -33271,174 +36135,17 @@ export interface components { 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`. */ + /** @description A boolean value representing whether or not alert is base64 encoded */ + is_base64_encoded?: boolean | null; + first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"]; + /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */ + has_more_locations?: boolean; + assigned_to?: components["schemas"]["nullable-simple-user"]; + }; + /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */ "secret-scanning-alert-resolution-comment": string | null; - /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */ - "secret-scanning-location-commit": { - /** - * @description The file path in the repository - * @example /example/secrets.txt - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** @description The API URL to get the associated blob resource */ - blob_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - commit_sha: string; - /** @description The API URL to get the associated commit resource */ - commit_url: string; - }; - /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ - "secret-scanning-location-wiki-commit": { - /** - * @description The file path of the wiki page - * @example /example/Home.md - */ - path: string; - /** @description Line number at which the secret starts in the file */ - start_line: number; - /** @description Line number at which the secret ends in the file */ - end_line: number; - /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ - start_column: number; - /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ - end_column: number; - /** - * @description SHA-1 hash ID of the associated blob - * @example af5626b4a114abcb82d63db7c8082c3c4756e51b - */ - blob_sha: string; - /** - * @description The GitHub URL to get the associated wiki page - * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - page_url: string; - /** - * @description SHA-1 hash ID of the associated commit - * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_sha: string; - /** - * @description The GitHub URL to get the associated wiki commit - * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - */ - commit_url: string; - }; - /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ - "secret-scanning-location-issue-title": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_title_url: string; - }; - /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */ - "secret-scanning-location-issue-body": { - /** - * Format: uri - * @description The API URL to get the issue where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/1347 - */ - issue_body_url: string; - }; - /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */ - "secret-scanning-location-issue-comment": { - /** - * Format: uri - * @description The API URL to get the issue comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - issue_comment_url: string; - }; - /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ - "secret-scanning-location-discussion-title": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082 - */ - discussion_title_url: string; - }; - /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ - "secret-scanning-location-discussion-body": { - /** - * Format: uri - * @description The URL to the discussion where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussion-4566270 - */ - discussion_body_url: string; - }; - /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ - "secret-scanning-location-discussion-comment": { - /** - * Format: uri - * @description The API URL to get the discussion comment where the secret was detected. - * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 - */ - discussion_comment_url: string; - }; - /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ - "secret-scanning-location-pull-request-title": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_title_url: string; - }; - /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ - "secret-scanning-location-pull-request-body": { - /** - * Format: uri - * @description The API URL to get the pull request where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846 - */ - pull_request_body_url: string; - }; - /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ - "secret-scanning-location-pull-request-comment": { - /** - * Format: uri - * @description The API URL to get the pull request comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - */ - pull_request_comment_url: string; - }; - /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ - "secret-scanning-location-pull-request-review": { - /** - * Format: uri - * @description The API URL to get the pull request review where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - */ - pull_request_review_url: string; - }; - /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ - "secret-scanning-location-pull-request-review-comment": { - /** - * Format: uri - * @description The API URL to get the pull request review comment where the secret was detected. - * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - */ - pull_request_review_comment_url: string; - }; + /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */ + "secret-scanning-alert-assignee": string | null; "secret-scanning-location": { /** * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. @@ -33735,22 +36442,6 @@ export interface components { tarball_url: string; node_id: string; }; - /** - * Tag protection - * @description Tag protection - */ - "tag-protection": { - /** @example 2 */ - id?: number; - /** @example 2011-01-26T19:01:12Z */ - created_at?: string; - /** @example 2011-01-26T19:01:12Z */ - updated_at?: string; - /** @example true */ - enabled?: boolean; - /** @example v1.* */ - pattern: string; - }; /** * Topic * @description A topic aggregates entities that are related to a subject. @@ -33931,12 +36622,9 @@ export interface components { default?: boolean; description?: string | null; }[]; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; state: string; state_reason?: string | null; assignee: components["schemas"]["nullable-simple-user"]; @@ -33970,7 +36658,9 @@ export interface components { body_text?: string; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; performed_via_github_app?: components["schemas"]["nullable-integration"]; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; reactions?: components["schemas"]["reaction-rollup"]; }; /** @@ -34089,6 +36779,12 @@ export interface components { has_wiki: boolean; has_downloads: boolean; has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; @@ -34698,6 +37394,8 @@ export interface components { created_at: string; verified: boolean; read_only: boolean; + /** Format: date-time */ + last_used?: string | null; }; /** Marketplace Account */ "marketplace-account": { @@ -34770,45 +37468,6 @@ export interface components { starred_at: string; repo: components["schemas"]["repository"]; }; - /** - * Sigstore Bundle v0.1 - * @description Sigstore Bundle v0.1 - */ - "sigstore-bundle-0": { - mediaType?: string; - verificationMaterial?: { - x509CertificateChain?: { - certificates?: { - rawBytes?: string; - }[]; - }; - tlogEntries?: { - logIndex?: string; - logId?: { - keyId?: string; - }; - kindVersion?: { - kind?: string; - version?: string; - }; - integratedTime?: string; - inclusionPromise?: { - signedEntryTimestamp?: string; - }; - inclusionProof?: string | null; - canonicalizedBody?: string; - }[]; - timestampVerificationData?: string | null; - }; - dsseEnvelope?: { - payload?: string; - payloadType?: string; - signatures?: { - sig?: string; - keyid?: string; - }[]; - }; - }; /** * Hovercard * @description Hovercard @@ -34826,6 +37485,114 @@ export interface components { "key-simple": { id: number; key: string; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + last_used?: string | null; + }; + "billing-premium-request-usage-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The model for the usage report. */ + model?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Model name. */ + model: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; + }; + "billing-usage-report-user": { + usageItems?: { + /** @description Date of the usage line item. */ + date: string; + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Quantity of the usage line item. */ + quantity: number; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + /** @description Name of the repository. */ + repositoryName?: string; + }[]; + }; + "billing-usage-summary-report-user": { + timePeriod: { + /** @description The year for the usage report. */ + year: number; + /** @description The month for the usage report. */ + month?: number; + /** @description The day for the usage report. */ + day?: number; + }; + /** @description The unique identifier of the user. */ + user: string; + /** @description The name of the repository for the usage report. */ + repository?: string; + /** @description The product for the usage report. */ + product?: string; + /** @description The SKU for the usage report. */ + sku?: string; + usageItems: { + /** @description Product name. */ + product: string; + /** @description SKU name. */ + sku: string; + /** @description Unit type of the usage line item. */ + unitType: string; + /** @description Price per unit of the usage line item. */ + pricePerUnit: number; + /** @description Gross quantity of the usage line item. */ + grossQuantity: number; + /** @description Gross amount of the usage line item. */ + grossAmount: number; + /** @description Discount quantity of the usage line item. */ + discountQuantity: number; + /** @description Discount amount of the usage line item. */ + discountAmount: number; + /** @description Net quantity of the usage line item. */ + netQuantity: number; + /** @description Net amount of the usage line item. */ + netAmount: number; + }[]; }; /** * Enterprise @@ -35177,6 +37944,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -35535,7 +38313,7 @@ export interface components { * @description A check performed on the code of a given code change */ "check-run-with-simple-check-suite": { - app: components["schemas"]["nullable-integration"]; + app: components["schemas"]["integration"]; check_suite: components["schemas"]["simple-check-suite"]; /** * Format: date-time @@ -35634,6 +38412,81 @@ export interface components { /** Format: uri */ url: string; } | null; + /** + * Deployment + * @description A request for a specific ref(branch,sha,tag) to be deployed + */ + "nullable-deployment": { + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1 + */ + url: string; + /** + * Format: int64 + * @description Unique identifier of the deployment + * @example 42 + */ + id: number; + /** @example MDEwOkRlcGxveW1lbnQx */ + node_id: string; + /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */ + sha: string; + /** + * @description The ref to deploy. This can be a branch, tag, or sha. + * @example topic-branch + */ + ref: string; + /** + * @description Parameter to specify a task to execute + * @example deploy + */ + task: string; + payload: { + [key: string]: unknown; + } | string; + /** @example staging */ + original_environment?: string; + /** + * @description Name for the target deployment environment. + * @example production + */ + environment: string; + /** @example Deploy request from hubot */ + description: string | null; + creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + created_at: string; + /** + * Format: date-time + * @example 2012-07-20T01:19:13Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example/deployments/1/statuses + */ + statuses_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/example + */ + repository_url: string; + /** + * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false. + * @example true + */ + transient_environment?: boolean; + /** + * @description Specifies if the given environment is one that end-users directly interact with. Default: false. + * @example true + */ + production_environment?: boolean; + performed_via_github_app?: components["schemas"]["nullable-integration"]; + } | null; webhooks_approver: { avatar_url?: string; events_url?: string; @@ -35818,15 +38671,39 @@ export interface components { user_view_type?: string; } | null; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; + webhooks_comment: { + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: number | null; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + repository_url: string; + updated_at: string; /** User */ - answer_chosen_by: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35842,6 +38719,7 @@ export interface components { gravatar_id?: string; /** Format: uri */ html_url?: string; + /** Format: int64 */ id: number; login: string; name?: string; @@ -35863,37 +38741,78 @@ export interface components { url?: string; user_view_type?: string; } | null; - answer_html_url: string | null; + }; + /** Label */ + webhooks_label: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }; + /** @description An array of repository objects that the installation can access. */ + webhooks_repositories: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + webhooks_repositories_added: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** + * @description Describe whether all repositories have been selected or there's a selection involved + * @enum {string} + */ + webhooks_repository_selection: "all" | "selected"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + webhooks_issue_comment: { /** * AuthorAssociation * @description How the author is associated with the repository. * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue comment */ body: string; - category: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; /** Format: date-time */ created_at: string; + /** Format: uri */ html_url: string; + /** + * Format: int64 + * @description Unique identifier of the issue comment + */ id: number; - locked: boolean; + /** Format: uri */ + issue_url: string; node_id: string; - number: number; + performed_via_github_app: components["schemas"]["integration"]; /** Reactions */ - reactions?: { + reactions: { "+1": number; "-1": number; confused: number; @@ -35906,226 +38825,13 @@ export interface components { /** Format: uri */ url: string; }; - repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null; - timeline_url?: string; - title: string; /** Format: date-time */ updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - labels?: components["schemas"]["label"][]; - }; - webhooks_comment: { - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - repository_url: string; - updated_at: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - /** Label */ - webhooks_label: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }; - /** @description An array of repository objects that the installation can access. */ - webhooks_repositories: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were added to the installation. */ - webhooks_repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - webhooks_repository_selection: "all" | "selected"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - webhooks_issue_comment: { - /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} - */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** @description Contents of the issue comment */ - body: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - /** - * Format: int64 - * @description Unique identifier of the issue comment - */ - id: number; - /** Format: uri */ - issue_url: string; - node_id: string; - performed_via_github_app: components["schemas"]["integration"]; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; - /** Format: uri */ - url: string; - }; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue comment - */ - url: string; + /** + * Format: uri + * @description URL for the issue comment + */ + url: string; /** User */ user: { /** Format: uri */ @@ -36165,6 +38871,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; }; /** @description The changes to the comment. */ webhooks_changes: { @@ -36493,8 +39200,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -36532,12 +39237,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -36548,6 +39251,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -36987,8 +39691,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -37026,12 +39728,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -37042,6 +39742,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -37227,6 +39928,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -37242,6 +39958,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** * Merge Group @@ -37501,6 +40232,17 @@ export interface components { * @example true */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + * @example true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether the repository is archived. * @default false @@ -37846,6 +40588,20 @@ export interface components { /** Format: uri */ organization_url: string; role: string; + /** + * @description Whether the user has direct membership in the organization. + * @example true + */ + direct_membership?: boolean; + /** + * @description The slugs of the enterprise teams providing the user with indirect membership in the organization. + * A limit of 100 enterprise team slugs is returned. + * @example [ + * "ent:team-one", + * "ent:team-two" + * ] + */ + enterprise_teams_providing_indirect_membership?: string[]; state: string; /** Format: uri */ url: string; @@ -38109,42 +40865,6 @@ export interface components { /** Format: uri */ url: string; }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - "projects-v2": { - id: number; - node_id: string; - owner: components["schemas"]["simple-user"]; - creator: components["schemas"]["simple-user"]; - title: string; - description: string | null; - public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - updated_at: string; - number: number; - short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - deleted_at: string | null; - deleted_by: components["schemas"]["nullable-simple-user"]; - }; webhooks_project_changes: { archived_at?: { /** Format: date-time */ @@ -38153,35 +40873,36 @@ export interface components { to?: string | null; }; }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; /** * Projects v2 Item * @description An item belonging to a project */ "projects-v2-item": { + /** @description The unique identifier of the project item. */ id: number; + /** @description The node ID of the project item. */ node_id?: string; + /** @description The node ID of the project that contains this item. */ project_node_id?: string; + /** @description The node ID of the content represented by this item. */ content_node_id: string; content_type: components["schemas"]["projects-v2-item-content-type"]; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the item was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the item was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; /** * Format: date-time + * @description The time when the item was archived. * @example 2022-04-28T12:00:00Z */ archived_at: string | null; @@ -38191,9 +40912,13 @@ export interface components { * @description An option for a single select field */ "projects-v2-single-select-option": { + /** @description The unique identifier of the option. */ id: string; + /** @description The display name of the option. */ name: string; + /** @description The color associated with the option. */ color?: string | null; + /** @description A short description of the option. */ description?: string | null; }; /** @@ -38201,39 +40926,57 @@ export interface components { * @description An iteration setting for an iteration field */ "projects-v2-iteration-setting": { + /** @description The unique identifier of the iteration setting. */ id: string; + /** @description The iteration title. */ title: string; + /** @description The iteration title, rendered as HTML. */ + title_html?: string; + /** @description The duration of the iteration in days. */ duration?: number | null; + /** @description The start date of the iteration. */ start_date?: string | null; + /** @description Whether the iteration has been completed. */ + completed?: boolean; }; /** * Projects v2 Status Update * @description An status update belonging to a project */ "projects-v2-status-update": { + /** @description The unique identifier of the status update. */ id: number; + /** @description The node ID of the status update. */ node_id: string; + /** @description The node ID of the project that this status update belongs to. */ project_node_id?: string; creator?: components["schemas"]["simple-user"]; /** * Format: date-time + * @description The time when the status update was created. * @example 2022-04-28T12:00:00Z */ created_at: string; /** * Format: date-time + * @description The time when the status update was last updated. * @example 2022-04-28T12:00:00Z */ updated_at: string; - /** @enum {string|null} */ + /** + * @description The current status. + * @enum {string|null} + */ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null; /** * Format: date + * @description The start date of the period covered by the update. * @example 2022-04-28 */ start_date?: string; /** * Format: date + * @description The target date associated with the update. * @example 2022-04-28 */ target_date?: string; @@ -38589,6 +41332,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -38935,6 +41688,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -39670,6 +42433,8 @@ export interface components { state: string; /** Format: date-time */ submitted_at: string | null; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -39729,6 +42494,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -39819,6 +42585,8 @@ export interface components { body: string | null; /** Format: date-time */ created_at: string | null; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ discussion_url?: string; /** @description Whether the release is a draft or published */ @@ -39826,6 +42594,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -39877,6 +42647,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -39974,6 +42745,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @description Whether the release is identified as a prerelease or a full release. */ @@ -40000,6 +42773,8 @@ export interface components { tarball_url: string | null; /** @description Specifies the commitish value that determines where the Git tag is created from. */ target_commitish: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri-template */ upload_url: string; /** Format: uri */ @@ -40067,7 +42842,7 @@ export interface components { number: number; severity: string; /** @enum {string} */ - state: "open"; + state: "auto_dismissed" | "open"; }; /** * @description The reason for resolving the alert. @@ -40128,6 +42903,7 @@ export interface components { publicly_leaked?: boolean | null; /** @description Whether the detected secret was found in multiple repositories in the same organization or business. */ multi_repo?: boolean | null; + assigned_to?: components["schemas"]["nullable-simple-user"]; }; /** @description The details of the security advisory, including summary, description, and severity. */ webhooks_security_advisory: { @@ -40351,6 +43127,21 @@ export interface components { * @description URL for the team */ url: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; } | null; /** @description Permission that the team will have for its repositories */ permission?: string; @@ -40369,6 +43160,21 @@ export interface components { * @description URL for the team */ url?: string; + /** + * @description The ownership type of the team + * @enum {string} + */ + type?: "enterprise" | "organization"; + /** + * @description Unique identifier of the organization to which this team belongs + * @example 37 + */ + organization_id?: number; + /** + * @description Unique identifier of the enterprise to which this team belongs + * @example 42 + */ + enterprise_id?: number; }; /** branch protection configuration disabled event */ "webhook-branch-protection-configuration-disabled": { @@ -40469,6 +43275,7 @@ export interface components { action?: "completed"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40487,6 +43294,7 @@ export interface components { action?: "created"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40505,6 +43313,7 @@ export interface components { action: "requested_action"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; /** @description The action requested by the user. */ @@ -40528,6 +43337,7 @@ export interface components { action?: "rerequested"; check_run: components["schemas"]["check-run-with-simple-check-suite"]; installation?: components["schemas"]["simple-installation"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; @@ -40673,8 +43483,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -40857,12 +43665,18 @@ export interface components { /** @enum {string} */ administration?: "read" | "write"; /** @enum {string} */ + artifact_metadata?: "read" | "write"; + /** @enum {string} */ + attestations?: "read" | "write"; + /** @enum {string} */ checks?: "read" | "write"; /** @enum {string} */ content_references?: "read" | "write"; /** @enum {string} */ contents?: "read" | "write"; /** @enum {string} */ + copilot_requests?: "write"; + /** @enum {string} */ deployments?: "read" | "write"; /** @enum {string} */ discussions?: "read" | "write"; @@ -40877,8 +43691,12 @@ export interface components { /** @enum {string} */ members?: "read" | "write"; /** @enum {string} */ + merge_queues?: "read" | "write"; + /** @enum {string} */ metadata?: "read" | "write"; /** @enum {string} */ + models?: "read" | "write"; + /** @enum {string} */ organization_administration?: "read" | "write"; /** @enum {string} */ organization_hooks?: "read" | "write"; @@ -40917,8 +43735,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -41101,12 +43917,18 @@ export interface components { /** @enum {string} */ administration?: "read" | "write"; /** @enum {string} */ + artifact_metadata?: "read" | "write"; + /** @enum {string} */ + attestations?: "read" | "write"; + /** @enum {string} */ checks?: "read" | "write"; /** @enum {string} */ content_references?: "read" | "write"; /** @enum {string} */ contents?: "read" | "write"; /** @enum {string} */ + copilot_requests?: "write"; + /** @enum {string} */ deployments?: "read" | "write"; /** @enum {string} */ discussions?: "read" | "write"; @@ -41121,8 +43943,12 @@ export interface components { /** @enum {string} */ members?: "read" | "write"; /** @enum {string} */ + merge_queues?: "read" | "write"; + /** @enum {string} */ metadata?: "read" | "write"; /** @enum {string} */ + models?: "read" | "write"; + /** @enum {string} */ organization_administration?: "read" | "write"; /** @enum {string} */ organization_hooks?: "read" | "write"; @@ -41161,8 +43987,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -41278,6 +44102,7 @@ export interface components { action: "appeared_in_branch"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41408,6 +44233,7 @@ export interface components { action: "closed_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41530,6 +44356,44 @@ export interface components { }; /** Format: uri */ url: string; + /** User */ + dismissal_approved_by?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41626,6 +44490,8 @@ export interface components { updated_at?: string | null; /** Format: uri */ url: string; + dismissal_approved_by?: unknown; + assignees?: components["schemas"]["simple-user"][]; }; commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41641,6 +44507,7 @@ export interface components { action: "fixed"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41780,6 +44647,7 @@ export interface components { action: "reopened"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41798,6 +44666,7 @@ export interface components { * @description The GitHub URL of the alert resource. */ html_url: string; + instances_url?: string; /** Alert Instance */ most_recent_instance?: { /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ @@ -41857,9 +44726,11 @@ export interface components { /** @description The version of the tool used to detect the alert. */ version: string | null; }; + updated_at?: string | null; /** Format: uri */ url: string; - } | null; + dismissal_approved_by?: unknown; + }; /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ commit_oid: string | null; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -41876,6 +44747,7 @@ export interface components { action: "reopened_by_user"; /** @description The code scanning alert involved in the event. */ alert: { + assignees?: components["schemas"]["simple-user"][]; /** * Format: date-time * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` @@ -41957,6 +44829,135 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** code_scanning_alert updated_assignment event */ + "webhook-code-scanning-alert-updated-assignment": { + /** @enum {string} */ + action: "updated_assignment"; + /** @description The code scanning alert involved in the event. */ + alert: { + assignees?: components["schemas"]["simple-user"][]; + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed. + * @enum {string|null} + */ + state: "open" | "dismissed" | "fixed" | null; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + 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"]; + }; /** commit_comment created event */ "webhook-commit-comment-created": { /** @@ -42094,6 +45095,16 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** custom property promoted to business event */ + "webhook-custom-property-promoted-to-enterprise": { + /** @enum {string} */ + action: "promote_to_enterprise"; + definition: components["schemas"]["custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user"]; + }; /** custom property updated event */ "webhook-custom-property-updated": { /** @enum {string} */ @@ -42133,6 +45144,17 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** Dependabot alert assignees changed event */ + "webhook-dependabot-alert-assignees-changed": { + /** @enum {string} */ + action: "assignees_changed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** Dependabot alert auto-dismissed event */ "webhook-dependabot-alert-auto-dismissed": { /** @enum {string} */ @@ -42410,8 +45432,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -42731,12 +45751,16 @@ export interface components { environment?: string; /** @description The event that triggered the deployment protection rule. */ event?: string; + /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + sha?: string; + /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */ + ref?: string; /** * Format: uri * @description The URL to review the deployment protection rule. */ deployment_callback_url?: string; - deployment?: components["schemas"]["deployment"]; + deployment?: components["schemas"]["nullable-deployment"]; pull_requests?: components["schemas"]["pull-request"][]; repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -43915,8 +46939,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -44115,8 +47137,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45260,6 +48280,7 @@ export interface components { * @description URL for the issue comment */ url: string; + pin?: components["schemas"]["nullable-pinned-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -45619,8 +48640,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -45658,12 +48677,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -45674,6 +48689,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46163,8 +49179,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -46202,12 +49216,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46218,6 +49228,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46709,8 +49720,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -46748,12 +49757,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -46764,6 +49769,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -46929,31 +49935,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - assignee?: components["schemas"]["webhooks_user"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - issue: components["schemas"]["webhooks_issue"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user"]; - }; - /** issues closed event */ - "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "closed"; + /** issue_comment pinned event */ + "webhook-issue-comment-pinned": { + /** @enum {string} */ + action: "pinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -47155,7 +50144,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47240,7 +50229,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -47309,12 +50298,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47325,6 +50310,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -47373,20 +50359,71 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; + /** User */ + assignee: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; assignees?: (Record | null)[]; author_association?: string; body?: string | null; - closed_at: string | null; + closed_at?: string | null; comments?: number; comments_url?: string; created_at?: string; events_url?: string; html_url?: string; id?: number; - labels?: (Record | null)[]; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; labels_url?: string; - locked?: boolean; + locked: boolean; milestone?: Record | null; node_id?: string; number?: number; @@ -47404,8 +50441,11 @@ export interface components { url?: string; }; repository_url?: string; - /** @enum {string} */ - state: "closed" | "open"; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; timeline_url?: string; title?: string; updated_at?: string; @@ -47437,16 +50477,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues deleted event */ - "webhook-issues-deleted": { + /** issue_comment unpinned event */ + "webhook-issue-comment-unpinned": { /** @enum {string} */ - action: "deleted"; + action: "unpinned"; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */ issue: { /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; @@ -47483,7 +50521,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47520,9 +50558,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47607,7 +50646,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -47647,7 +50686,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -47801,12 +50840,8 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -47817,6 +50852,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -47858,31 +50894,15 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; - }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { - /** @enum {string} */ - action: "demilestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } & { + active_lock_reason?: string | null; /** User */ - assignee?: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47917,8 +50937,182 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; - assignees: ({ + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at?: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + labels_url?: string; + locked: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + 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"]; + }; + /** blocked by issue added event */ + "webhook-issue-dependencies-blocked-by-added": { + /** @enum {string} */ + action: "blocked_by_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocked by issue removed event */ + "webhook-issue-dependencies-blocked-by-removed": { + /** @enum {string} */ + action: "blocked_by_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + blocking_issue_repo?: components["schemas"]["repository"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue added event */ + "webhook-issue-dependencies-blocking-added": { + /** @enum {string} */ + action: "blocking_added"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** blocking issue removed event */ + "webhook-issue-dependencies-blocking-removed": { + /** @enum {string} */ + action: "blocking_removed"; + /** @description The ID of the blocked issue. */ + blocked_issue_id?: number; + blocked_issue?: components["schemas"]["issue"]; + blocked_issue_repo?: components["schemas"]["repository"]; + /** @description The ID of the blocking issue. */ + blocking_issue_id?: number; + blocking_issue?: components["schemas"]["issue"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues assigned event */ + "webhook-issues-assigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "assigned"; + assignee?: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; + /** issues closed event */ + "webhook-issues-closed": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47953,6 +51147,44 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -47976,7 +51208,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -47990,7 +51222,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -48077,7 +51309,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48192,8 +51424,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -48231,12 +51461,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48247,6 +51475,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48293,27 +51522,76 @@ export interface components { url?: string; user_view_type?: string; } | null; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + author_association?: string; + body?: string | null; + closed_at: string | null; + comments?: number; + comments_url?: string; + created_at?: string; + events_url?: string; + html_url?: string; + id?: number; + labels?: (Record | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + reactions?: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + url?: string; + }; + repository_url?: string; + /** @enum {string} */ + state: "closed" | "open"; + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + node_id?: string; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; + type?: string; + url?: string; + user_view_type?: string; + }; }; - milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues edited event */ - "webhook-issues-edited": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the issue. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - title?: { - /** @description The previous version of the title. */ - from: string; - }; - }; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -48356,7 +51634,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48393,9 +51671,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; + user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -48480,7 +51759,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; user_view_type?: string; @@ -48520,7 +51799,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48605,7 +51884,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write" | "admin"; + organization_projects?: "read" | "write"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -48635,8 +51914,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -48674,12 +51951,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -48690,6 +51965,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -48731,21 +52007,20 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** 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"]; }; - /** issues labeled event */ - "webhook-issues-labeled": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "labeled"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -48791,7 +52066,6 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -48851,7 +52125,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: { + labels?: ({ /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -48865,7 +52139,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -48952,7 +52226,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49067,8 +52341,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49106,12 +52378,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49122,6 +52392,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -49169,15 +52440,26 @@ export interface components { user_view_type?: string; } | null; }; - label?: components["schemas"]["webhooks_label"]; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues locked event */ - "webhook-issues-locked": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ - action: "locked"; + action: "edited"; + /** @description The changes to the issue. */ + changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + title?: { + /** @description The previous version of the title. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -49220,7 +52502,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -49257,10 +52539,9 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - user_view_type?: string; } | null)[]; /** * AuthorAssociation @@ -49284,7 +52565,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -49298,11 +52579,10 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; - /** @enum {boolean} */ - locked: true; + locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. @@ -49346,7 +52626,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; @@ -49386,7 +52666,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49471,7 +52751,7 @@ export interface components { /** @enum {string} */ organization_plan?: "read" | "write"; /** @enum {string} */ - organization_projects?: "read" | "write"; + organization_projects?: "read" | "write" | "admin"; /** @enum {string} */ organization_secrets?: "read" | "write"; /** @enum {string} */ @@ -49501,8 +52781,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49540,12 +52818,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49554,6 +52830,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -49597,20 +52874,21 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + 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"]; }; - /** issues milestoned event */ - "webhook-issues-milestoned": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "milestoned"; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @@ -49653,9 +52931,10 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + user_view_type?: string; } | null; assignees: ({ /** Format: uri */ @@ -49689,7 +52968,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null)[]; @@ -49715,7 +52994,7 @@ export interface components { html_url: string; /** Format: int64 */ id: number; - labels?: ({ + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -49729,7 +53008,7 @@ export interface components { * @description URL for the label */ url: string; - } | null)[]; + }[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -49816,7 +53095,7 @@ export interface components { created_at: string | null; description: string | null; /** @description The list of events for the GitHub app */ - events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -49931,8 +53210,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -49970,12 +53247,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -49984,6 +53259,7 @@ export interface components { state_reason?: string | null; /** Format: uri */ timeline_url?: string; + type?: components["schemas"]["issue-type"]; /** @description Title of the issue */ title: string; /** Format: date-time */ @@ -50027,31 +53303,158 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; user_view_type?: string; } | null; }; - milestone: components["schemas"]["webhooks_milestone"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; - /** issues opened event */ - "webhook-issues-opened": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "opened"; - changes?: { + action: "locked"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null)[]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - old_issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + /** @enum {boolean} */ + locked: true; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; /** User */ - assignee?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50088,7 +53491,738 @@ export interface components { url?: string; user_view_type?: string; } | null; - assignees: ({ + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + type?: components["schemas"]["issue-type"]; + /** @description Title of the issue */ + title: string; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues milestoned event */ + "webhook-issues-milestoned": { + /** @enum {string} */ + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + assignees: ({ + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null)[]; + /** + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} + */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue */ + body: string | null; + /** Format: date-time */ + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; + /** Format: date-time */ + created_at: string; + draft?: boolean; + /** Format: uri */ + events_url: string; + /** Format: uri */ + html_url: string; + /** Format: int64 */ + id: number; + labels?: ({ + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; + description: string | null; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; + /** + * @description The state of the milestone. + * @enum {string} + */ + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + node_id: string; + number: number; + /** + * App + * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. + */ + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; + description: string | null; + /** @description The list of events for the GitHub app */ + events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[]; + /** Format: uri */ + external_url: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ + name: string; + node_id: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { + /** @enum {string} */ + actions?: "read" | "write"; + /** @enum {string} */ + administration?: "read" | "write"; + /** @enum {string} */ + checks?: "read" | "write"; + /** @enum {string} */ + content_references?: "read" | "write"; + /** @enum {string} */ + contents?: "read" | "write"; + /** @enum {string} */ + deployments?: "read" | "write"; + /** @enum {string} */ + discussions?: "read" | "write"; + /** @enum {string} */ + emails?: "read" | "write"; + /** @enum {string} */ + environments?: "read" | "write"; + /** @enum {string} */ + issues?: "read" | "write"; + /** @enum {string} */ + keys?: "read" | "write"; + /** @enum {string} */ + members?: "read" | "write"; + /** @enum {string} */ + metadata?: "read" | "write"; + /** @enum {string} */ + organization_administration?: "read" | "write"; + /** @enum {string} */ + organization_hooks?: "read" | "write"; + /** @enum {string} */ + organization_packages?: "read" | "write"; + /** @enum {string} */ + organization_plan?: "read" | "write"; + /** @enum {string} */ + organization_projects?: "read" | "write" | "admin"; + /** @enum {string} */ + organization_secrets?: "read" | "write"; + /** @enum {string} */ + organization_self_hosted_runners?: "read" | "write"; + /** @enum {string} */ + organization_user_blocking?: "read" | "write"; + /** @enum {string} */ + packages?: "read" | "write"; + /** @enum {string} */ + pages?: "read" | "write"; + /** @enum {string} */ + pull_requests?: "read" | "write"; + /** @enum {string} */ + repository_hooks?: "read" | "write"; + /** @enum {string} */ + repository_projects?: "read" | "write"; + /** @enum {string} */ + secret_scanning_alerts?: "read" | "write"; + /** @enum {string} */ + secrets?: "read" | "write"; + /** @enum {string} */ + security_events?: "read" | "write"; + /** @enum {string} */ + security_scanning_alert?: "read" | "write"; + /** @enum {string} */ + single_file?: "read" | "write"; + /** @enum {string} */ + statuses?: "read" | "write"; + /** @enum {string} */ + vulnerability_alerts?: "read" | "write"; + /** @enum {string} */ + workflows?: "read" | "write"; + }; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { + /** Format: uri */ + diff_url?: string; + /** Format: uri */ + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** Reactions */ + reactions: { + "+1": number; + "-1": number; + confused: number; + eyes: number; + heart: number; + hooray: number; + laugh: number; + rocket: number; + total_count: number; + /** Format: uri */ + url: string; + }; + /** Format: uri */ + repository_url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; + type?: components["schemas"]["issue-type"]; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + 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"]; + }; + /** issues opened event */ + "webhook-issues-opened": { + /** @enum {string} */ + action: "opened"; + changes?: { + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + old_issue: { + /** @enum {string|null} */ + active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + assignees?: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50130,21 +54264,21 @@ export interface components { * @description How the author is associated with the repository. * @enum {string} */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; /** @description Contents of the issue */ - body: string | null; + body?: string | null; /** Format: date-time */ - closed_at: string | null; - comments: number; + closed_at?: string | null; + comments?: number; /** Format: uri */ - comments_url: string; + comments_url?: string; /** Format: date-time */ - created_at: string; + created_at?: string; draft?: boolean; /** Format: uri */ - events_url: string; + events_url?: string; /** Format: uri */ - html_url: string; + html_url?: string; /** Format: int64 */ id: number; labels?: { @@ -50163,13 +54297,13 @@ export interface components { url: string; }[]; /** Format: uri-template */ - labels_url: string; + labels_url?: string; locked?: boolean; /** * Milestone * @description A collection of related issues and pull requests. */ - milestone: { + milestone?: { /** Format: date-time */ closed_at: string | null; closed_issues: number; @@ -50237,7 +54371,7 @@ export interface components { /** Format: uri */ url: string; } | null; - node_id: string; + node_id?: string; number: number; /** * App @@ -50363,8 +54497,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -50387,7 +54519,7 @@ export interface components { url?: string; }; /** Reactions */ - reactions: { + reactions?: { "+1": number; "-1": number; confused: number; @@ -50401,13 +54533,10 @@ export interface components { url: string; }; /** Format: uri */ - repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + repository_url?: string; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -50417,16 +54546,17 @@ export interface components { /** Format: uri */ timeline_url?: string; /** @description Title of the issue */ - title: string; + title?: string; /** Format: date-time */ - updated_at: string; + updated_at?: string; /** * Format: uri * @description URL for the issue */ - url: string; + url?: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ - user: { + user?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50464,6 +54594,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; } | null; /** * Repository @@ -50557,6 +54688,16 @@ export interface components { git_url: string; /** @description Whether the repository has discussions enabled. */ has_discussions?: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; /** * @description Whether downloads are enabled. * @default true @@ -51035,8 +55176,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -51074,12 +55213,9 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51090,6 +55226,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -51097,6 +55234,7 @@ export interface components { * @description URL for the issue */ url: string; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; /** User */ user: { /** Format: uri */ @@ -51476,8 +55614,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -51515,12 +55651,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51577,6 +55711,7 @@ export interface components { url?: string; user_view_type?: string; } | null; + type?: components["schemas"]["issue-type"]; }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; @@ -51907,8 +56042,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -51946,12 +56079,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -51962,6 +56093,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52125,6 +56257,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -52267,6 +56409,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues typed event */ + "webhook-issues-typed": { + /** @enum {string} */ + action: "typed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** issues unassigned event */ "webhook-issues-unassigned": { /** @@ -52621,8 +56775,6 @@ export interface components { /** @enum {string} */ statuses?: "read" | "write"; /** @enum {string} */ - team_discussions?: "read" | "write"; - /** @enum {string} */ vulnerability_alerts?: "read" | "write"; /** @enum {string} */ workflows?: "read" | "write"; @@ -52660,12 +56812,10 @@ export interface components { }; /** Format: uri */ repository_url: string; - /** Sub-issues Summary */ - sub_issues_summary?: { - total: number; - completed: number; - percent_completed: number; - }; + pinned_comment?: components["schemas"]["nullable-issue-comment"]; + sub_issues_summary?: components["schemas"]["sub-issues-summary"]; + issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"]; + issue_field_values?: components["schemas"]["issue-field-value"][]; /** * @description State of the issue; either 'open' or 'closed' * @enum {string} @@ -52676,6 +56826,7 @@ export interface components { timeline_url?: string; /** @description Title of the issue */ title: string; + type?: components["schemas"]["issue-type"]; /** Format: date-time */ updated_at: string; /** @@ -52738,6 +56889,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** issues untyped event */ + "webhook-issues-untyped": { + /** @enum {string} */ + action: "untyped"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + type: components["schemas"]["issue-type"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user"]; + }; /** label created event */ "webhook-label-created": { /** @enum {string} */ @@ -53125,7 +57288,7 @@ export interface components { /** @enum {string} */ action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ hook: { active: boolean; config: { @@ -54852,352 +59015,372 @@ export interface components { * @default false */ has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** - * Format: int64 - * @description Unique identifier of the repository - */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash 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; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; - /** User */ - user: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; - /** Format: uri */ - html_url?: string; - /** Format: int64 */ - id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - user_view_type?: string; - } | null; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string | null; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** + * Format: int64 + * @description Unique identifier of the repository + */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; + /** User */ + owner: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash 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; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sha: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; + /** Format: uri */ + comments_url: string; + commits?: number; + /** Format: uri */ + commits_url: string; + /** Format: date-time */ + created_at: string; + deletions?: number; + /** Format: uri */ + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { + label: string | null; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + /** + * @description Whether pull requests are enabled. * @default true */ - has_downloads: boolean; + has_pull_requests: boolean; /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} */ - has_discussions: boolean; + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -56048,6 +60231,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; has_pages: boolean; /** * @description Whether projects are enabled. @@ -56405,6 +60598,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57267,6 +61470,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -57613,6 +61826,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -58508,6 +62731,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -58854,6 +63087,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -59748,6 +63991,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60094,6 +64347,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60956,6 +65219,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -61302,6 +65575,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62163,6 +66446,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -62509,6 +66802,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63562,6 +67865,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -63901,6 +68214,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -64708,6 +69031,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65047,6 +69380,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -65856,6 +70199,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -66195,6 +70548,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67002,6 +71365,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67341,6 +71714,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -67880,6 +72263,8 @@ export interface components { state: "dismissed" | "approved" | "changes_requested"; /** Format: date-time */ submitted_at: string; + /** Format: date-time */ + updated_at?: string | null; /** User */ user: { /** Format: uri */ @@ -69288,6 +73673,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69627,6 +74022,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70526,6 +74931,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -70872,6 +75287,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71790,6 +76215,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -72136,6 +76571,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73035,6 +77480,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -73381,6 +77836,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74295,6 +78760,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -74634,6 +79109,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75442,6 +79927,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -75742,6 +80237,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76354,6 +80859,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request_review_thread unresolved event */ "webhook-pull-request-review-thread-unresolved": { @@ -76656,6 +81163,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -76956,6 +81473,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -77568,6 +82095,8 @@ export interface components { }[]; node_id: string; }; + /** Format: date-time */ + updated_at?: string | null; }; /** pull_request synchronize event */ "webhook-pull-request-synchronize": { @@ -77874,6 +82403,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -78220,6 +82759,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79075,6 +83624,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -79421,6 +83980,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80283,6 +84852,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -80629,6 +85208,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81483,6 +86072,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -81829,6 +86428,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -82638,6 +87247,16 @@ export interface components { * @default false */ has_discussions: boolean; + /** + * @description Whether pull requests are enabled. + * @default true + */ + has_pull_requests: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -83144,6 +87763,10 @@ export interface components { /** @description The previous version of the name if the action was `edited`. */ from: string; }; + tag_name?: { + /** @description The previous version of the tag_name if the action was `edited`. */ + from: string; + }; make_latest?: { /** @description Whether this release was explicitly `edited` to be the latest. */ to: boolean; @@ -83181,6 +87804,7 @@ export interface components { name: string; node_id: string; size: number; + digest: string | null; /** * @description State of the release asset. * @enum {string} @@ -83278,6 +87902,8 @@ export interface components { /** Format: uri */ html_url: string; id: number; + /** @description Whether or not the release is immutable. */ + immutable: boolean; name: string | null; node_id: string; /** @@ -83309,6 +87935,8 @@ export interface components { target_commitish: string; /** Format: uri-template */ upload_url: string; + /** Format: date-time */ + updated_at: string | null; /** Format: uri */ url: string; /** Format: uri */ @@ -83826,6 +88454,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert assigned event */ + "webhook-secret-scanning-alert-assigned": { + /** @enum {string} */ + action: "assigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 created event */ "webhook-secret-scanning-alert-created": { /** @enum {string} */ @@ -83886,6 +88526,18 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user"]; }; + /** secret_scanning_alert unassigned event */ + "webhook-secret-scanning-alert-unassigned": { + /** @enum {string} */ + action: "unassigned"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + assignee?: components["schemas"]["simple-user"]; + 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 validated event */ "webhook-secret-scanning-alert-validated": { /** @enum {string} */ @@ -84215,7 +88867,7 @@ export interface components { reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending"; signature: string | null; verified: boolean; - verified_at?: string | null; + verified_at: string | null; }; }; /** User */ @@ -87338,6 +91990,334 @@ export interface components { display_title: string; }; }; + /** CreateEvent */ + "create-event": { + ref: string; + ref_type: string; + full_ref: string; + master_branch: string; + description?: string | null; + pusher_type: string; + }; + /** DeleteEvent */ + "delete-event": { + ref: string; + ref_type: string; + full_ref: string; + pusher_type: string; + }; + /** DiscussionEvent */ + "discussion-event": { + action: string; + discussion: components["schemas"]["discussion"]; + }; + /** IssuesEvent */ + "issues-event": { + action: string; + issue: components["schemas"]["issue"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** IssueCommentEvent */ + "issue-comment-event": { + action: string; + issue: components["schemas"]["issue"]; + comment: components["schemas"]["issue-comment"]; + }; + /** ForkEvent */ + "fork-event": { + action: string; + forkee: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + private?: boolean; + owner?: components["schemas"]["simple-user"]; + html_url?: string; + description?: string | null; + fork?: boolean; + url?: string; + forks_url?: string; + keys_url?: string; + collaborators_url?: string; + teams_url?: string; + hooks_url?: string; + issue_events_url?: string; + events_url?: string; + assignees_url?: string; + branches_url?: string; + tags_url?: string; + blobs_url?: string; + git_tags_url?: string; + git_refs_url?: string; + trees_url?: string; + statuses_url?: string; + languages_url?: string; + stargazers_url?: string; + contributors_url?: string; + subscribers_url?: string; + subscription_url?: string; + commits_url?: string; + git_commits_url?: string; + comments_url?: string; + issue_comment_url?: string; + contents_url?: string; + compare_url?: string; + merges_url?: string; + archive_url?: string; + downloads_url?: string; + issues_url?: string; + pulls_url?: string; + milestones_url?: string; + notifications_url?: string; + labels_url?: string; + releases_url?: string; + deployments_url?: string; + /** Format: date-time */ + created_at?: string | null; + /** Format: date-time */ + updated_at?: string | null; + /** Format: date-time */ + pushed_at?: string | null; + git_url?: string; + ssh_url?: string; + clone_url?: string; + svn_url?: string; + homepage?: string | null; + size?: number; + stargazers_count?: number; + watchers_count?: number; + language?: string | null; + has_issues?: boolean; + has_projects?: boolean; + has_downloads?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_discussions?: boolean; + has_pull_requests?: boolean; + /** + * @description The policy controlling who can create pull requests: all or collaborators_only. + * @enum {string} + */ + pull_request_creation_policy?: "all" | "collaborators_only"; + forks_count?: number; + mirror_url?: string | null; + archived?: boolean; + disabled?: boolean; + open_issues_count?: number; + license?: components["schemas"]["nullable-license-simple"]; + allow_forking?: boolean; + is_template?: boolean; + web_commit_signoff_required?: boolean; + topics?: string[]; + visibility?: string; + forks?: number; + open_issues?: number; + watchers?: number; + default_branch?: string; + public?: boolean; + }; + }; + /** GollumEvent */ + "gollum-event": { + pages: { + page_name?: string | null; + title?: string | null; + summary?: string | null; + action?: string; + sha?: string; + html_url?: string; + }[]; + }; + /** MemberEvent */ + "member-event": { + action: string; + member: components["schemas"]["simple-user"]; + }; + /** PublicEvent */ + "public-event": Record; + /** PushEvent */ + "push-event": { + repository_id: number; + push_id: number; + ref: string; + head: string; + before: string; + }; + /** PullRequestEvent */ + "pull-request-event": { + action: string; + number: number; + pull_request: components["schemas"]["pull-request-minimal"]; + assignee?: components["schemas"]["simple-user"]; + assignees?: components["schemas"]["simple-user"][]; + label?: components["schemas"]["label"]; + labels?: components["schemas"]["label"][]; + }; + /** PullRequestReviewCommentEvent */ + "pull-request-review-comment-event": { + action: string; + pull_request: components["schemas"]["pull-request-minimal"]; + comment: { + id: number; + node_id: string; + /** Format: uri */ + url: string; + pull_request_review_id: number | null; + diff_hunk: string; + path: string; + position: number | null; + original_position: number; + subject_type?: string | null; + commit_id: string; + /** User */ + user: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + /** Format: int64 */ + id?: number; + login?: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + user_view_type?: string; + } | null; + body: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + html_url: string; + /** Format: uri */ + pull_request_url: string; + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + original_commit_id: string; + /** Reactions */ + reactions: { + "+1"?: number; + "-1"?: number; + confused?: number; + eyes?: number; + heart?: number; + hooray?: number; + laugh?: number; + rocket?: number; + total_count?: number; + /** Format: uri */ + url?: string; + }; + in_reply_to_id?: number; + }; + }; + /** PullRequestReviewEvent */ + "pull-request-review-event": { + action: string; + review: { + id?: number; + node_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + body?: string; + commit_id?: string; + submitted_at?: string | null; + state?: string; + /** Format: uri */ + html_url?: string; + /** Format: uri */ + pull_request_url?: string; + _links?: { + html: { + href: string; + }; + pull_request: { + href: string; + }; + }; + updated_at?: string; + }; + pull_request: components["schemas"]["pull-request-minimal"]; + }; + /** CommitCommentEvent */ + "commit-comment-event": { + action: string; + comment: { + /** Format: uri */ + html_url?: string; + /** Format: uri */ + url?: string; + id?: number; + node_id?: string; + body?: string; + path?: string | null; + position?: number | null; + line?: number | null; + commit_id?: string; + user?: components["schemas"]["nullable-simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + }; + /** ReleaseEvent */ + "release-event": { + action: string; + release: components["schemas"]["release"] & { + is_short_description_html_truncated?: boolean; + short_description_html?: string; + }; + }; + /** WatchEvent */ + "watch-event": { + action: string; + }; }; responses: { /** @description Validation failed, or the endpoint has been spammed. */ @@ -87411,6 +92391,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + internal_error: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Conflict */ conflict: { headers: { @@ -87466,6 +92455,42 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting all budgets */ + get_all_budgets: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get_all_budgets"]; + }; + }; + /** @description Response when updating a budget */ + budget: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["get-budget"]; + }; + }; + /** @description Response when deleting a budget */ + "delete-budget": { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["delete-budget"]; + }; + }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_org: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-org"]; + }; + }; /** @description Billing usage report response for an organization */ billing_usage_report_org: { headers: { @@ -87475,13 +92500,13 @@ export interface components { "application/json": components["schemas"]["billing-usage-report"]; }; }; - /** @description Internal Error */ - internal_error: { + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_org: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": components["schemas"]["billing-usage-summary-report-org"]; }; }; /** @description Response */ @@ -87521,6 +92546,15 @@ export interface components { }; }; }; + /** @description Payload Too Large */ + too_large: { + headers: { + [name: string]: unknown; + }; + content: { + "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: { @@ -87537,8 +92571,15 @@ export interface components { }; content?: never; }; - /** @description Gone */ - gone: { + /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */ + enterprise_team_unsupported: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Temporary Redirect */ + temporary_redirect: { headers: { [name: string]: unknown; }; @@ -87546,8 +92587,8 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Temporary Redirect */ - temporary_redirect: { + /** @description Gone */ + gone: { headers: { [name: string]: unknown; }; @@ -87591,6 +92632,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response if analysis could not be processed */ + unprocessable_analysis: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Found */ found: { headers: { @@ -87607,7 +92657,16 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; - /** @description Response if GitHub Advanced Security is not enabled for this repository */ + /** @description Response if the configuration change cannot be made because the repository is not in the required state */ + code_scanning_invalid_state: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */ dependency_review_forbidden: { headers: { [name: string]: unknown; @@ -87634,6 +92693,33 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Response when getting a billing premium request usage report */ + billing_premium_request_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-premium-request-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage report */ + billing_usage_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-report-user"]; + }; + }; + /** @description Response when getting a billing usage summary */ + billing_usage_summary_report_user: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing-usage-summary-report-user"]; + }; + }; }; parameters: { /** @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)." */ @@ -87662,7 +92748,7 @@ export interface components { "assignment-id": number; /** @description The unique identifier of the classroom. */ "classroom-id": number; - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: string; /** @description The unique identifier of the code security configuration. */ "configuration-id": number; @@ -87695,6 +92781,17 @@ export interface components { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ "dependabot-alert-comma-separated-epss": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + "dependabot-alert-comma-separated-has": string | "patch"[]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + "dependabot-alert-comma-separated-assignees": string; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ "dependabot-alert-scope": "development" | "runtime"; /** @@ -87704,32 +92801,16 @@ export interface components { * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. */ "dependabot-alert-sort": "created" | "updated" | "epss_percentage"; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - "pagination-first": number; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - "pagination-last": number; - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - "secret-scanning-alert-state": "open" | "resolved"; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - "secret-scanning-alert-secret-type": string; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - "secret-scanning-alert-resolution": string; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - "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 version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": string; + /** @description The handle for the GitHub user account. */ + username: string; + /** @description The organization name. The name is not case sensitive. */ + org: string; + /** @description The slug of the team name. */ + "team-slug": string; + /** @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)." */ + "public-events-per-page": number; /** @description The unique identifier of the gist. */ "gist-id": string; /** @description The unique identifier of the comment. */ @@ -87756,16 +92837,30 @@ export interface components { "thread-id": number; /** @description An organization ID. Only return organizations with an ID greater than this ID. */ "since-org": number; - /** @description The organization name. The name is not case sensitive. */ - org: string; - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description The ID corresponding to the budget. */ + budget: string; + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ "billing-usage-report-year": number; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ - "billing-usage-report-month": number; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + "billing-usage-report-month-default": number; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ "billing-usage-report-day": number; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - "billing-usage-report-hour": number; + /** @description The user name to query usage for. The name is not case sensitive. */ + "billing-usage-report-user": string; + /** @description The model name to query usage for. The name is not case sensitive. */ + "billing-usage-report-model": string; + /** @description The product name to query usage for. The name is not case sensitive. */ + "billing-usage-report-product": string; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + "billing-usage-report-month": number; + /** @description The repository name to query for usage in the format owner/repository. */ + "billing-usage-report-repository": string; + /** @description The SKU to query for usage. */ + "billing-usage-report-sku": string; + /** @description Image definition ID of custom image */ + "actions-custom-image-definition-id": number; + /** @description Version of a custom image */ + "actions-custom-image-version": string; /** @description Unique identifier of the GitHub-hosted runner. */ "hosted-runner-id": number; /** @description The unique identifier of the repository. */ @@ -87784,12 +92879,31 @@ export interface components { "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; - /** @description The handle for the GitHub user account. */ - username: string; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + "subject-digest": string; /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ "tool-name": components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + "dependabot-alert-comma-separated-artifact-registry-urls": string; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + "dependabot-alert-comma-separated-artifact-registry": string; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + "dependabot-alert-comma-separated-runtime-risk": string; /** @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 */ @@ -87816,14 +92930,14 @@ export interface components { "api-insights-actor-name-substring": string; /** @description The unique identifier of the invitation. */ "invitation-id": number; + /** @description The unique identifier of the issue type. */ + "issue-type-id": number; /** @description The name of the codespace. */ "codespace-name": string; /** @description The unique identifier of the migration. */ "migration-id": number; /** @description repo_name parameter */ "repo-name": string; - /** @description The slug of the team name. */ - "team-slug": string; /** @description The unique identifier of the role. */ "role-id": number; /** @@ -87851,8 +92965,18 @@ export interface components { "personal-access-token-before": string; /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ "personal-access-token-after": string; + /** @description The ID of the token */ + "personal-access-token-token-id": string[]; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The project's number. */ + "project-number": number; + /** @description The unique identifier of the field. */ + "field-id": number; + /** @description The unique identifier of the project item. */ + "item-id": number; + /** @description The number that identifies the project view. */ + "view-number": number; /** @description The custom property name */ "custom-property-name": string; /** @@ -87868,12 +92992,12 @@ export interface components { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ "time-period": "hour" | "day" | "week" | "month"; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ "actor-name-in-query": string; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ "rule-suite-result": "pass" | "fail" | "bypass" | "all"; /** * @description The unique identifier of the rule suite result. @@ -87882,22 +93006,32 @@ export interface components { * for organizations. */ "rule-suite-id": number; + /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + "secret-scanning-alert-state": "open" | "resolved"; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + "secret-scanning-alert-secret-type": string; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + "secret-scanning-alert-resolution": string; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + "secret-scanning-alert-assignee": string; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + "secret-scanning-alert-sort": "created" | "updated"; /** @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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ "secret-scanning-pagination-before-org-repo": string; /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ "secret-scanning-pagination-after-org-repo": string; + /** @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 A boolean value representing whether or not to hide literal secrets in the results. */ + "secret-scanning-alert-hide-secret": boolean; /** @description Unique identifier of the hosted compute network configuration. */ "network-configuration-id": string; /** @description Unique identifier of the hosted compute network settings. */ "network-settings-id": string; - /** @description The number that identifies the discussion. */ - "discussion-number": number; - /** @description The number that identifies the comment. */ - "comment-number": number; - /** @description The unique identifier of the reaction. */ - "reaction-id": number; - /** @description The unique identifier of the project. */ - "project-id": number; /** @description The security feature to enable or disable. */ "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection"; /** @@ -87907,10 +93041,6 @@ export interface components { * `disable_all` means to disable the specified security feature for all repositories in the organization. */ "org-security-product-enablement": "enable_all" | "disable_all"; - /** @description The unique identifier of the card. */ - "card-id": number; - /** @description The unique identifier of the column. */ - "column-id": number; /** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */ "artifact-name": string; /** @description The unique identifier of the artifact. */ @@ -87967,6 +93097,8 @@ export interface components { "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 unique identifier of the reaction. */ + "reaction-id": number; /** @description The SHA of the commit. */ "commit-sha": string; /** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ @@ -88013,14 +93145,17 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; - /** @description The unique identifier of the tag protection. */ - "tag-protection-id": number; /** @description The time frame to display results for. */ per: "day" | "week"; /** @description A repository ID. Only return repositories with an ID greater than this ID. */ "since-repo": number; /** @description 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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + "issues-advanced-search": string; /** @description The unique identifier of the team. */ "team-id": number; /** @description ID of the Repository to filter on */ @@ -88037,6 +93172,8 @@ export interface components { "ssh-signing-key-id": number; /** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */ "sort-starred": "created" | "updated"; + /** @description The unique identifier of the user. */ + "user-id": string; }; requestBodies: never; headers: { @@ -88104,7 +93241,7 @@ export interface operations { * @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. * If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. * - * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` */ affects?: string | string[]; /** @@ -88928,12 +94065,134 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; - "codes-of-conduct/get-conduct-code": { + "codes-of-conduct/get-conduct-code": { + parameters: { + query?: never; + header?: never; + path: { + key: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["code-of-conduct"]; + }; + }; + 304: components["responses"]["not_modified"]; + 404: components["responses"]["not_found"]; + }; + }; + "credentials/revoke": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A list of credentials to be revoked, up to 1000 per request. */ + credentials: string[]; + }; + }; + }; + responses: { + 202: components["responses"]["accepted"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; + }; + }; + "emojis/get": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + [key: string]: string; + }; + }; + }; + 304: components["responses"]["not_modified"]; + }; + }; + "actions/get-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-enterprise": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-enterprise": { parameters: { query?: never; header?: never; path: { - key: string; + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; }; cookie?: never; }; @@ -88945,34 +94204,39 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-of-conduct"]; + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; }; }; - 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "emojis/get": { + "actions/set-actions-cache-storage-limit-for-enterprise": { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"]; + }; + }; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - [key: string]: string; - }; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; "code-security/get-configurations-for-enterprise": { @@ -88987,7 +94251,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89012,7 +94276,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89025,11 +94289,19 @@ export interface operations { /** @description A description of the code security configuration */ description: string; /** - * @description The enablement status of GitHub Advanced Security + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. * @default disabled * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @default enabled @@ -89062,6 +94334,7 @@ export interface operations { * @enum {string} */ dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; /** * @description The enablement status of code scanning default setup * @default disabled @@ -89069,6 +94342,17 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @default disabled @@ -89093,6 +94377,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @default disabled @@ -89128,7 +94430,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89151,7 +94453,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89179,7 +94481,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89200,7 +94502,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89215,10 +94517,18 @@ export interface operations { /** @description A description of the code security configuration */ description?: string; /** - * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings. + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. * @enum {string} */ - advanced_security?: "enabled" | "disabled"; + code_security?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of Dependency Graph * @enum {string} @@ -89250,6 +94560,18 @@ export interface operations { */ code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of secret scanning * @enum {string} @@ -89270,6 +94592,24 @@ export interface operations { * @enum {string} */ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @default disabled + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; /** * @description The enablement status of private vulnerability reporting * @enum {string} @@ -89304,7 +94644,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89315,7 +94655,7 @@ export interface operations { content: { "application/json": { /** - * @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` + * @description The type of repositories to attach the configuration to. * @enum {string} */ scope: "all" | "all_without_configurations"; @@ -89334,7 +94674,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89391,7 +94731,7 @@ export interface operations { }; header?: never; path: { - /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; /** @description The unique identifier of the code security configuration. */ configuration_id: components["parameters"]["configuration-id"]; @@ -89445,6 +94785,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -89460,24 +94811,12 @@ export interface operations { 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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89499,35 +94838,17 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; - "secret-scanning/list-alerts-for-enterprise": { + "enterprise-teams/list": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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 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 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"]; + /** @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 slug version of the enterprise name. You can also substitute this value with the enterprise id. */ + /** @description The slug version of the enterprise name. */ enterprise: components["parameters"]["enterprise"]; }; cookie?: never; @@ -89541,14 +94862,239 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": components["schemas"]["enterprise-team"][]; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-public-events": { + "enterprise-teams/create": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the team. */ + name: string; + /** @description A description of the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be set. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + }; + }; + "enterprise-team-memberships/list": { + 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 slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to add to the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully added team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The GitHub user handles to be removed from the team. */ + usernames: string[]; + }; + }; + }; + responses: { + /** @description Successfully removed team members. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; + }; + }; + }; + "enterprise-team-memberships/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description User is a member of the enterprise team. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully added team member */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["simple-user"]; + }; + }; + }; + }; + "enterprise-team-memberships/remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-team-organizations/get-assignments": { 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)." */ @@ -89557,6 +95103,290 @@ export interface operations { page?: components["parameters"]["page"]; }; header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description An array of organizations the team is assigned to */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to assign the team to. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully assigned the enterprise team to organizations. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"][]; + }; + }; + }; + }; + "enterprise-team-organizations/bulk-remove": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Organization slug to unassign the team from. */ + organization_slugs: string[]; + }; + }; + }; + responses: { + /** @description Successfully unassigned the enterprise team from organizations. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/get-assignment": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description The team is assigned to the organization */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + /** @description The team is not assigned to the organization */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-team-organizations/add": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully assigned the enterprise team to the organization. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["organization-simple"]; + }; + }; + }; + }; + "enterprise-team-organizations/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */ + "enterprise-team": components["parameters"]["enterprise-team"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Successfully unassigned the enterprise team from the organization. */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "enterprise-teams/get": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/delete": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "enterprise-teams/update": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The slug version of the enterprise name. */ + enterprise: components["parameters"]["enterprise"]; + /** @description The slug of the team name. */ + team_slug: components["parameters"]["team-slug"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description A new name for the team. */ + name?: string | null; + /** @description A new description for the team. */ + description?: string | null; + /** + * @description Retired: this field is no longer supported. + * Whether the enterprise team should be reflected in each organization. + * This value cannot be changed. + * @default disabled + * @enum {string} + */ + sync_to_organizations?: "all" | "disabled"; + /** + * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + * `all`: The team is assigned to all current and future organizations in the enterprise. + * @default disabled + * @enum {string} + */ + organization_selection_type?: "disabled" | "selected" | "all"; + /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */ + group_id?: string | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["enterprise-team"]; + }; + }; + 403: components["responses"]["forbidden"]; + }; + }; + "activity/list-public-events": { + 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"]["public-events-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?: never; cookie?: never; }; @@ -91000,17 +96830,425 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "actions/get-actions-cache-retention-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-retention-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-organization": { + 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": components["schemas"]["actions-cache-retention-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-organization": { + parameters: { + query?: never; + 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"]["actions-cache-storage-limit-for-organization"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-organization": { + 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": components["schemas"]["actions-cache-storage-limit-for-organization"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/repository-access-for-org": { + parameters: { + query?: { + /** @description The page number of results to fetch. */ + page?: number; + /** @description Number of results per page. */ + 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"]["dependabot-repository-access-details"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/update-repository-access-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 List of repository IDs to add. */ + repository_ids_to_add?: number[]; + /** @description List of repository IDs to remove. */ + repository_ids_to_remove?: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "dependabot/set-repository-access-default-level": { + 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 The default repository access level for Dependabot updates. + * @example internal + * @enum {string} + */ + default_level: "public" | "internal"; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "billing/get-all-budgets-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["get_all_budgets"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "billing/get-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/delete-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["delete-budget"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/update-budget-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID corresponding to the budget. */ + budget_id: components["parameters"]["budget"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert?: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients?: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** @description The name of the entity to apply the budget to */ + budget_entity_name?: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + responses: { + /** @description Budget updated successfully */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example Budget successfully updated. */ + message?: string; + budget?: { + /** @description ID of the budget. */ + id?: string; + /** + * Format: float + * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. + */ + budget_amount?: number; + /** @description Whether to prevent additional spending once the budget is exceeded */ + prevent_further_usage?: boolean; + budget_alerting?: { + /** @description Whether alerts are enabled for this budget */ + will_alert: boolean; + /** @description Array of user login names who will receive alerts */ + alert_recipients: string[]; + }; + /** + * @description The scope of the budget + * @enum {string} + */ + budget_scope?: "enterprise" | "organization" | "repository" | "cost_center"; + /** + * @description The name of the entity to apply the budget to + * @default + */ + budget_entity_name: string; + /** + * @description The type of pricing for the budget + * @enum {string} + */ + budget_type?: "ProductPricing" | "SkuPricing"; + /** @description A single product or SKU that will be covered in the budget */ + budget_product_sku?: string; + }; + }; + }; + }; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + /** @description Budget not found or feature not enabled */ + 404: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 422: components["responses"]["validation_failed"]; + /** @description Internal server error */ + 500: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; + "billing/get-github-billing-premium-request-usage-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The user name to query usage for. The name is not case sensitive. */ + user?: components["parameters"]["billing-usage-report-user"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "billing/get-github-billing-usage-report-org": { parameters: { query?: { - /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */ + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ year?: components["parameters"]["billing-usage-report-year"]; - /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */ + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ month?: components["parameters"]["billing-usage-report-month"]; - /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */ + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ day?: components["parameters"]["billing-usage-report-day"]; - /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */ - hour?: components["parameters"]["billing-usage-report-hour"]; }; header?: never; path: { @@ -91028,6 +97266,38 @@ export interface operations { 503: components["responses"]["service_unavailable"]; }; }; + "billing/get-github-billing-usage-summary-report-org": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_org"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "orgs/get": { parameters: { query?: never; @@ -91370,6 +97640,11 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** + * @description Whether this runner should be used to generate custom images. + * @default false + */ + image_gen?: boolean; }; }; }; @@ -91385,6 +97660,160 @@ export interface operations { }; }; }; + "actions/list-custom-images-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?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + images: components["schemas"]["actions-hosted-runner-custom-image"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image"]; + }; + }; + }; + }; + "actions/delete-custom-image-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-custom-image-versions-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @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; + image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][]; + }; + }; + }; + }; + }; + "actions/get-custom-image-version-for-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"]; + }; + }; + }; + }; + "actions/delete-custom-image-version-from-org": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Image definition ID of custom image */ + image_definition_id: components["parameters"]["actions-custom-image-definition-id"]; + /** @description Version of a custom image */ + version: components["parameters"]["actions-custom-image-version"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "actions/get-hosted-runners-github-owned-images-for-org": { parameters: { query?: never; @@ -91405,7 +97834,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -91431,7 +97860,7 @@ export interface operations { content: { "application/json": { total_count: number; - images: components["schemas"]["actions-hosted-runner-image"][]; + images: components["schemas"]["actions-hosted-runner-curated-image"][]; }; }; }; @@ -91586,6 +98015,10 @@ export interface operations { maximum_runners?: number; /** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */ enable_static_ip?: boolean; + /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */ + size?: string; + /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */ + image_id?: string; /** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */ image_version?: string | null; }; @@ -91693,6 +98126,7 @@ export interface operations { "application/json": { enabled_repositories: components["schemas"]["enabled-repositories"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -91706,6 +98140,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-organization": { + parameters: { + query?: never; + 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"]["actions-artifact-and-log-retention-response"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-organization": { + 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": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-organization": { + 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": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-organization": { + parameters: { + query?: never; + 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"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-organization": { + 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": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */ + 403: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { @@ -91859,6 +98459,184 @@ export interface operations { }; }; }; + "actions/get-self-hosted-runners-permissions-organization": { + parameters: { + query?: never; + 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"]["self-hosted-runners-settings"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-self-hosted-runners-permissions-organization": { + 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 The policy that controls whether self-hosted runners can be used in the organization + * @enum {string} + */ + enabled_repositories: "all" | "selected" | "none"; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/list-selected-repositories-self-hosted-runners-organization": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + total_count?: number; + repositories?: components["schemas"]["repository"][]; + }; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-selected-repositories-self-hosted-runners-organization": { + 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 IDs of repositories that can use repository-level self-hosted runners */ + selected_repository_ids: number[]; + }; + }; + }; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/enable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/disable-selected-repository-self-hosted-runners-organization": { + 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 repository. */ + repository_id: components["parameters"]["repository-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-github-actions-default-workflow-permissions-organization": { parameters: { query?: never; @@ -92441,6 +99219,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -92536,6 +99315,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-org": { @@ -92743,9 +99523,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} @@ -93220,154 +100000,467 @@ export interface operations { }; }; }; - "orgs/list-attestations": { + "orgs/create-artifact-deployment-record": { 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 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"]; + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** @description The hex encoded digest of the artifact. */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * @description The status of the artifact. Can be either deployed or decommissioned. + * @enum {string} + */ + status: "deployed" | "decommissioned"; + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The deployment cluster. */ + cluster?: string; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a cluster, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + */ + deployment_name: string; + /** @description The tags associated with the deployment. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact deployment record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; + }; + }; + }; + }; + "orgs/set-cluster-deployment-records": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ - subject_digest: string; + /** @description The cluster name. */ + cluster: string; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description The stage of the deployment. */ + logical_environment: string; + /** @description The physical region of the deployment. */ + physical_environment?: string; + /** @description The list of deployments to record. */ + deployments: { + /** + * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name parameter must also be identical across all entries. + */ + name: string; + /** + * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + * the name and version parameters must also be identical across all entries. + */ + digest: string; + /** + * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + * the version parameter must also be identical across all entries. + * @example 1.2.3 + */ + version?: string; + /** + * @description The deployment status of the artifact. + * @enum {string} + */ + status?: "deployed" | "decommissioned"; + /** + * @description The unique identifier for the deployment represented by the new record. To accommodate differing + * containers and namespaces within a record set, the following format is recommended: + * {namespaceName}-{deploymentName}-{containerName}. + * The deployment_name must be unique across all entries in the deployments array. + */ + deployment_name: string; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + /** @description Key-value pairs to tag the deployment record. */ + tags?: { + [key: string]: string; + }; + /** @description A list of runtime risks associated with the deployment. */ + runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[]; + }[]; + }; + }; + }; responses: { - /** @description Response */ + /** @description Deployment records created or updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { - attestations?: { - /** - * @description The attestation's Sigstore Bundle. - * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. - */ - bundle?: { - mediaType?: string; - verificationMaterial?: { - [key: string]: unknown; - }; - dsseEnvelope?: { - [key: string]: unknown; - }; - }; - repository_id?: number; - bundle_url?: string; - }[]; + /** @description The number of deployment records created */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; }; }; }; }; }; - "orgs/list-blocked-users": { + "orgs/create-artifact-storage-record": { 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"]; + 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 The name of the artifact. + * @example libfoo + */ + name: string; + /** + * @description The digest of the artifact (algorithm:hex-encoded-digest). + * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + */ + digest: string; + /** + * @description The artifact version. + * @example 1.2.3 + */ + version?: string; + /** + * Format: uri + * @description The URL where the artifact is stored. + * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3 + */ + artifact_url?: string; + /** + * Format: uri + * @description The path of the artifact. + * @example com/github/bar/libfoo-1.2.3 + */ + path?: string; + /** + * Format: uri + * @description The base URL of the artifact registry. + * @example https://reg.example.com/artifactory/ + */ + registry_url: string; + /** + * @description The repository name within the registry. + * @example bar + */ + repository?: string; + /** + * @description The status of the artifact (e.g., active, inactive). + * @default active + * @example active + * @enum {string} + */ + status?: "active" | "eol" | "deleted"; + /** + * @description The name of the GitHub repository associated with the artifact. This should be used + * when there are no provenance attestations available for the artifact. The repository + * must belong to the organization specified in the path parameter. + * + * If a provenance attestation is available for the artifact, the API will use + * the repository information from the attestation instead of this parameter. + * @example my-github-repo + */ + github_repository?: string; + }; + }; + }; + responses: { + /** @description Artifact metadata storage record stored successfully. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @example 1 */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string | null; + registry_url?: string; + repository?: string | null; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; + }; + }; + }; + "orgs/list-artifact-deployment-records": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */ + subject_digest: components["parameters"]["subject-digest"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description Successful response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": { + /** + * @description The number of deployment records for this digest and organization + * @example 3 + */ + total_count?: number; + deployment_records?: components["schemas"]["artifact-deployment-record"][]; + }; }; }; }; }; - "orgs/check-blocked-user": { + "orgs/list-artifact-storage-records": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** + * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. + * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + */ + subject_digest: string; }; cookie?: never; }; requestBody?: never; responses: { - /** @description If the user is blocked */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + /** + * @description The number of storage records for this digest and organization + * @example 3 + */ + total_count?: number; + storage_records?: { + id?: number; + name?: string; + digest?: string; + artifact_url?: string; + registry_url?: string; + repository?: string; + status?: string; + created_at?: string; + updated_at?: string; + }[]; + }; + }; }; - /** @description If the user is not blocked */ - 404: { + }; + }; + "orgs/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["basic-error"]; + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; }; }; }; }; - "orgs/block-user": { + "orgs/delete-attestations-bulk": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; content?: never; }; - 422: components["responses"]["validation_failed"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/unblock-user": { + "orgs/delete-attestations-by-subject-digest": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; }; cookie?: never; }; requestBody?: never; responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; /** @description Response */ 204: { headers: { @@ -93375,31 +100468,24 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "code-scanning/list-alerts-for-org": { + "orgs/list-attestation-repositories": { parameters: { query?: { - /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ - tool_name?: components["parameters"]["tool-name"]; - /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ - tool_guid?: components["parameters"]["tool-guid"]; + /** @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 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 page number of the results to fetch. For 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 If specified, only code scanning alerts with this state will be returned. */ - state?: components["schemas"]["code-scanning-alert-state-query"]; - /** @description The property by which to sort the results. */ - sort?: "created" | "updated"; - /** @description If specified, only code scanning alerts with this severity will be returned. */ - severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -93413,33 +100499,26 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; + "application/json": { + id?: number; + name?: string; + }[]; }; }; - 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "code-security/get-configurations-for-org": { + "orgs/delete-attestations-by-id": { parameters: { - query?: { - /** @description The target type of the code security configuration */ - target_type?: "global" | "all"; - /** @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?: number; - /** @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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Attestation ID */ + attestation_id: number; }; cookie?: never; }; @@ -93450,568 +100529,464 @@ export interface operations { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["code-security-configuration"][]; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "code-security/create-configuration": { + "orgs/list-attestations": { parameters: { - query?: never; + 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 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */ + subject_digest: string; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The name of the code security configuration. Must be unique within the organization. */ - name: string; - /** @description A description of the code security configuration */ - description: string; - /** - * @description The enablement status of GitHub Advanced Security - * @default disabled - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @default enabled - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @default disabled - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** - * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. - * @default false - */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @default disabled - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @default disabled - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @default disabled - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; - /** - * @description The enablement status of secret scanning - * @default disabled - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @default disabled - * @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; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + attestations?: { /** - * @description The type of the bypass reviewer - * @enum {string} + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. */ - reviewer_type: "TEAM" | "ROLE"; + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + } | null; + repository_id?: number; + bundle_url?: string; + initiator?: string; }[]; }; - /** - * @description The enablement status of secret scanning validity checks - * @default disabled - * @enum {string} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning non provider patterns - * @default disabled - * @enum {string} - */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of private vulnerability reporting - * @default disabled - * @enum {string} - */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; - /** - * @description The enforcement status for a security configuration - * @default enforced - * @enum {string} - */ - enforcement?: "enforced" | "unenforced"; }; }; }; + }; + "orgs/list-blocked-users": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { - /** @description Successfully created code security configuration */ - 201: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - "code-security/get-default-configurations": { + "orgs/check-blocked-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description If the user is blocked */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description If the user is not blocked */ + 404: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-default-configurations"]; + "application/json": components["schemas"]["basic-error"]; }; }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "code-security/detach-configuration": { + "orgs/block-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description An array of repository IDs to detach from configurations. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - "code-security/get-configuration": { + "orgs/unblock-user": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["code-security-configuration"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "code-security/delete-configuration": { + "campaigns/list-org-campaigns": { parameters: { - query?: never; + 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"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description If specified, only campaigns with this state will be returned. */ + state?: components["schemas"]["campaign-state"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated" | "ends_at" | "published"; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["campaign-summary"][]; + }; + }; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; + 503: components["responses"]["service_unavailable"]; }; }; - "code-security/update-configuration": { + "campaigns/create-campaign": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The name of the code security configuration. Must be unique within the organization. */ - name?: string; - /** @description A description of the code security configuration */ - description?: string; - /** - * @description The enablement status of GitHub Advanced Security - * @enum {string} - */ - advanced_security?: "enabled" | "disabled"; - /** - * @description The enablement status of Dependency Graph - * @enum {string} - */ - dependency_graph?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Automatic dependency submission - * @enum {string} - */ - dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; - /** @description Feature options for Automatic dependency submission */ - dependency_graph_autosubmit_action_options?: { - /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ - labeled_runners?: boolean; - }; - /** - * @description The enablement status of Dependabot alerts - * @enum {string} - */ - dependabot_alerts?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of Dependabot security updates - * @enum {string} - */ - dependabot_security_updates?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of code scanning default setup - * @enum {string} - */ - code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; - code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; - /** - * @description The enablement status of secret scanning - * @enum {string} - */ - secret_scanning?: "enabled" | "disabled" | "not_set"; - /** - * @description The enablement status of secret scanning push protection - * @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} - */ - secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** @description The name of the campaign */ + name: string; + /** @description A description for the campaign */ + description: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; /** - * @description The enablement status of secret scanning non-provider patterns - * @enum {string} + * Format: date-time + * @description The end date and time of the campaign. The date must be in the future. */ - secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + ends_at: string; /** - * @description The enablement status of private vulnerability reporting - * @enum {string} + * Format: uri + * @description The contact link of the campaign. Must be a URI. */ - private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + contact_link?: string | null; + /** @description The code scanning alerts to include in this campaign */ + code_scanning_alerts?: { + /** @description The repository id */ + repository_id: number; + /** @description The alert numbers */ + alert_numbers: number[]; + }[] | null; /** - * @description The enforcement status for a security configuration - * @enum {string} + * @description If true, will automatically generate issues for the campaign. The default is false. + * @default false */ - enforcement?: "enforced" | "unenforced"; - }; + generate_issues?: boolean; + } & (unknown | unknown); }; }; responses: { - /** @description Response when a configuration is updated */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration"]; + "application/json": components["schemas"]["campaign-summary"]; }; }; - /** @description Response when no new updates are made */ - 204: { + /** @description Bad Request */ + 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; - }; - }; - "code-security/attach-configuration": { - 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + 404: components["responses"]["not_found"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @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" | "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[]; + /** @description Too Many Requests */ + 429: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 202: components["responses"]["accepted"]; + 503: components["responses"]["service_unavailable"]; }; }; - "code-security/set-configuration-as-default": { + "campaigns/get-campaign-summary": { 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 code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Specify which types of repository this security configuration should be applied to by default. - * @enum {string} - */ - default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - }; - }; - }; + requestBody?: never; responses: { - /** @description Default successfully changed. */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - /** - * @description Specifies which types of repository this security configuration is applied to by default. - * @enum {string} - */ - default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; - configuration?: components["schemas"]["code-security-configuration"]; - }; + "application/json": components["schemas"]["campaign-summary"]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - }; - }; - "code-security/get-repositories-for-configuration": { - 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?: number; - /** @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 A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. - * - * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` - */ - status?: string; - }; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; - /** @description The unique identifier of the code security configuration. */ - configuration_id: components["parameters"]["configuration-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + /** @description Unprocessable Entity */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-security-configuration-repositories"][]; + "application/json": components["schemas"]["basic-error"]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/list-in-organization": { + "campaigns/delete-campaign": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description Deletion successful */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/set-codespaces-access": { + "campaigns/update-campaign": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The campaign number. */ + campaign_number: number; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description The name of the campaign */ + name?: string; + /** @description A description for the campaign */ + description?: string; + /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */ + managers?: string[]; + /** @description The slugs of the teams to set as the campaign managers. */ + team_managers?: string[]; /** - * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. - * @enum {string} + * Format: date-time + * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. */ - visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; - /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ - selected_usernames?: string[]; + ends_at?: string; + /** + * Format: uri + * @description The contact link of the campaign. Must be a URI. + */ + contact_link?: string | null; + state?: components["schemas"]["campaign-state"]; }; }; }; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["campaign-summary"]; + }; }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ + /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["basic-error"]; + }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + /** @description Unprocessable Entity */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/set-codespaces-access-users": { + "code-scanning/list-alerts-for-org": { parameters: { - query?: never; + query?: { + /** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */ + tool_name?: components["parameters"]["tool-name"]; + /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ + tool_guid?: components["parameters"]["tool-guid"]; + /** @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 page number of the results to fetch. For 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 If specified, only code scanning alerts with this state will be returned. */ + state?: components["schemas"]["code-scanning-alert-state-query"]; + /** @description The property by which to sort the results. */ + sort?: "created" | "updated"; + /** @description If specified, only code scanning alerts with this severity will be returned. */ + severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94019,38 +100994,34 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members whose codespaces be billed to the organization. */ - selected_usernames: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ - 400: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["code-scanning-organization-alert-items"][]; }; - content?: never; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; }; }; - "codespaces/delete-codespaces-access-users": { + "code-security/get-configurations-for-org": { parameters: { - query?: never; + query?: { + /** @description The target type of the code security configuration */ + target_type?: "global" | "all"; + /** @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?: number; + /** @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"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94058,43 +101029,24 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ - selected_usernames: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response when successfully modifying permissions. */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - 304: components["responses"]["not_modified"]; - /** @description Users are neither members nor collaborators of this organization. */ - 400: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["code-security-configuration"][]; }; - content?: never; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "codespaces/list-org-secrets": { + "code-security/create-configuration": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94102,55 +101054,177 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["codespaces-org-secret"][]; + requestBody: { + content: { + "application/json": { + /** @description The name of the code security configuration. Must be unique within the organization. */ + name: string; + /** @description A description of the code security configuration */ + description: string; + /** + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @default disabled + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependency Graph + * @default enabled + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @default disabled + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** + * @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. + * @default false + */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @default disabled + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @default disabled + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @default disabled + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning default setup + * @default disabled + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default not_set + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @default disabled + * @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 + * @enum {string} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non provider patterns + * @default disabled + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @default disabled + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @default disabled + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @default enforced + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; }; - }; - "codespaces/get-org-public-key": { - parameters: { - query?: never; - 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: { + /** @description Successfully created code security configuration */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespaces-public-key"]; + "application/json": components["schemas"]["code-security-configuration"]; }; }; }; }; - "codespaces/get-org-secret": { + "code-security/get-default-configurations": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -94159,154 +101233,250 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["codespaces-org-secret"]; + "application/json": components["schemas"]["code-security-default-configurations"]; }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "codespaces/create-or-update-org-secret": { + "code-security/detach-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ - encrypted_value?: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id?: string; - /** - * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. - * @enum {string} - */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */ selected_repository_ids?: number[]; }; }; }; responses: { - /** @description Response when creating a secret */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + 409: components["responses"]["conflict"]; }; }; - "codespaces/delete-org-secret": { + "code-security/get-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; }; + 304: components["responses"]["not_modified"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "codespaces/list-selected-repos-for-org-secret": { + "code-security/delete-configuration": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - repositories: components["schemas"]["minimal-repository"][]; - }; - }; - }; + 204: components["responses"]["no_content"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; - "codespaces/set-selected-repos-for-org-secret": { + "code-security/update-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids: number[]; + /** @description The name of the code security configuration. Must be unique within the organization. */ + name?: string; + /** @description A description of the code security configuration */ + description?: string; + /** + * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + * + * > [!WARNING] + * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + * @enum {string} + */ + advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection"; + /** + * @description The enablement status of GitHub Code Security features. + * @enum {string} + */ + code_security?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependency Graph + * @enum {string} + */ + dependency_graph?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Automatic dependency submission + * @enum {string} + */ + dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set"; + /** @description Feature options for Automatic dependency submission */ + dependency_graph_autosubmit_action_options?: { + /** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */ + labeled_runners?: boolean; + }; + /** + * @description The enablement status of Dependabot alerts + * @enum {string} + */ + dependabot_alerts?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot security updates + * @enum {string} + */ + dependabot_security_updates?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled. + * @enum {string} + */ + dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of code scanning default setup + * @enum {string} + */ + code_scanning_default_setup?: "enabled" | "disabled" | "not_set"; + code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"]; + code_scanning_options?: components["schemas"]["code-scanning-options"]; + /** + * @description The enablement status of code scanning delegated alert dismissal + * @default disabled + * @enum {string} + */ + code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of GitHub Secret Protection features. + * @enum {string} + */ + secret_protection?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning + * @enum {string} + */ + secret_scanning?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning push protection + * @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} + */ + secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning non-provider patterns + * @enum {string} + */ + secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of Copilot secret scanning + * @enum {string} + */ + secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning delegated alert dismissal + * @enum {string} + */ + secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of secret scanning extended metadata + * @enum {string} + */ + secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set"; + /** + * @description The enablement status of private vulnerability reporting + * @enum {string} + */ + private_vulnerability_reporting?: "enabled" | "disabled" | "not_set"; + /** + * @description The enforcement status for a security configuration + * @enum {string} + */ + enforcement?: "enforced" | "unenforced"; }; }; }; responses: { - /** @description Response */ - 204: { + /** @description Response when a configuration is updated */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["code-security-configuration"]; + }; }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type not set to selected */ - 409: { + /** @description Response when no new updates are made */ + 204: { headers: { [name: string]: unknown; }; @@ -94314,118 +101484,101 @@ export interface operations { }; }; }; - "codespaces/add-selected-repo-to-org-secret": { + "code-security/attach-configuration": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description No Content when repository was added to the selected list */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type is not set to selected */ - 409: { - headers: { - [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @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" | "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[]; }; - content?: never; }; - 422: components["responses"]["validation_failed"]; + }; + responses: { + 202: components["responses"]["accepted"]; }; }; - "codespaces/remove-selected-repo-from-org-secret": { + "code-security/set-configuration-as-default": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - repository_id: number; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response when repository was removed from the selected list */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description Conflict when visibility type not set to selected */ - 409: { - headers: { - [name: string]: unknown; + requestBody: { + content: { + "application/json": { + /** + * @description Specify which types of repository this security configuration should be applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; }; - content?: never; - }; - 422: components["responses"]["validation_failed"]; - }; - }; - "copilot/get-copilot-organization-details": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The organization name. The name is not case sensitive. */ - org: components["parameters"]["org"]; }; - cookie?: never; }; - requestBody?: never; responses: { - /** @description OK */ + /** @description Default successfully changed. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-organization-details"]; + "application/json": { + /** + * @description Specifies which types of repository this security configuration is applied to by default. + * @enum {string} + */ + default_for_new_repos?: "all" | "none" | "private_and_internal" | "public"; + configuration?: components["schemas"]["code-security-configuration"]; + }; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description There is a problem with your account's associated payment method. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 500: components["responses"]["internal_error"]; }; }; - "copilot/list-copilot-seats": { + "code-security/get-repositories-for-configuration": { 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?: number; + /** @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 A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. + * + * Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise` + */ + status?: string; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the code security configuration. */ + configuration_id: components["parameters"]["configuration-id"]; }; cookie?: never; }; @@ -94434,69 +101587,24 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": { - /** @description Total number of Copilot seats for the organization currently being billed. */ - total_seats?: number; - seats?: components["schemas"]["copilot-seat-details"][]; - }; + "application/json": components["schemas"]["code-security-configuration-repositories"][]; }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-seats-for-teams": { + "codespaces/list-in-organization": { 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 List of team names within the organization to which to grant access to GitHub Copilot. */ - selected_teams: string[]; - }; - }; - }; - responses: { - /** @description OK */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - seats_created: number; - }; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; + 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"]; }; - 500: components["responses"]["internal_error"]; - }; - }; - "copilot/cancel-copilot-seat-assignment-for-teams": { - parameters: { - query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94504,40 +101612,28 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The names of teams from which to revoke access to GitHub Copilot. */ - selected_teams: string[]; - }; - }; - }; + requestBody?: never; responses: { - /** @description OK */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { - seats_cancelled: number; + total_count: number; + codespaces: components["schemas"]["codespace"][]; }; }; }; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-seats-for-users": { + "codespaces/set-codespaces-access": { parameters: { query?: never; header?: never; @@ -94550,37 +101646,38 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ - selected_usernames: string[]; + /** + * @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. + * @enum {string} + */ + visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators"; + /** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */ + selected_usernames?: string[]; }; }; }; responses: { - /** @description OK */ - 201: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - seats_created: number; - }; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ - 422: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "copilot/cancel-copilot-seat-assignment-for-users": { + "codespaces/set-codespaces-access-users": { parameters: { query?: never; header?: never; @@ -94593,48 +101690,35 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ + /** @description The usernames of the organization members whose codespaces be billed to the organization. */ selected_usernames: string[]; }; }; }; responses: { - /** @description OK */ - 200: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - seats_cancelled: number; - }; - }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ - 422: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "copilot/copilot-metrics-for-organization": { + "codespaces/delete-codespaces-access-users": { 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; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -94642,147 +101726,36 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members whose codespaces should not be billed to the organization. */ + selected_usernames: string[]; }; }; - 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?: { - /** @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: { + /** @description Response when successfully modifying permissions. */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; - "dependabot/list-alerts-for-org": { - parameters: { - query?: { - /** - * @description A comma-separated list of states. If specified, only alerts with these states will be returned. - * - * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` - */ - state?: components["parameters"]["dependabot-alert-comma-separated-states"]; - /** - * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. - * - * Can be: `low`, `medium`, `high`, `critical` - */ - severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; - /** - * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - * - * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` - */ - ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; - /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ - package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; - /** - * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: - * - An exact number (`n`) - * - Comparators such as `>n`, `=n`, `<=n` - * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 - * - * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. - */ - epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; - /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ - scope?: components["parameters"]["dependabot-alert-scope"]; - /** - * @description The property by which to sort the results. - * `created` means when the alert was created. - * `updated` means when the alert's state last changed. - * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. - */ - sort?: components["parameters"]["dependabot-alert-sort"]; - /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; - /** @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"]; + content?: never; }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + 304: components["responses"]["not_modified"]; + /** @description Users are neither members nor collaborators of this organization. */ + 400: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["dependabot-alert-with-repository"][]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 400: components["responses"]["bad_request"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "dependabot/list-org-secrets": { + "codespaces/list-org-secrets": { 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)." */ @@ -94808,13 +101781,13 @@ export interface operations { content: { "application/json": { total_count: number; - secrets: components["schemas"]["organization-dependabot-secret"][]; + secrets: components["schemas"]["codespaces-org-secret"][]; }; }; }; }; }; - "dependabot/get-org-public-key": { + "codespaces/get-org-public-key": { parameters: { query?: never; header?: never; @@ -94832,12 +101805,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["dependabot-public-key"]; + "application/json": components["schemas"]["codespaces-public-key"]; }; }; }; }; - "dependabot/get-org-secret": { + "codespaces/get-org-secret": { parameters: { query?: never; header?: never; @@ -94854,15 +101827,16 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-dependabot-secret"]; + "application/json": components["schemas"]["codespaces-org-secret"]; }; }; }; }; - "dependabot/create-or-update-org-secret": { + "codespaces/create-or-update-org-secret": { parameters: { query?: never; header?: never; @@ -94877,17 +101851,17 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */ encrypted_value?: string; - /** @description ID of the key you used to encrypt the secret. */ + /** @description The ID of the key you used to encrypt the secret. */ key_id?: string; /** * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. * @enum {string} */ visibility: "all" | "private" | "selected"; - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ - selected_repository_ids?: string[]; + /** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: number[]; }; }; }; @@ -94908,9 +101882,11 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "dependabot/delete-org-secret": { + "codespaces/delete-org-secret": { parameters: { query?: never; header?: never; @@ -94931,9 +101907,10 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "dependabot/list-selected-repos-for-org-secret": { + "codespaces/list-selected-repos-for-org-secret": { 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)." */ @@ -94964,9 +101941,10 @@ export interface operations { }; }; }; + 404: components["responses"]["not_found"]; }; }; - "dependabot/set-selected-repos-for-org-secret": { + "codespaces/set-selected-repos-for-org-secret": { parameters: { query?: never; header?: never; @@ -94981,7 +101959,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ selected_repository_ids: number[]; }; }; @@ -94994,9 +101972,17 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + /** @description Conflict when visibility type not set to selected */ + 409: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "dependabot/add-selected-repo-to-org-secret": { + "codespaces/add-selected-repo-to-org-secret": { parameters: { query?: never; header?: never; @@ -95018,6 +102004,7 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type is not set to selected */ 409: { headers: { @@ -95025,9 +102012,10 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed"]; }; }; - "dependabot/remove-selected-repo-from-org-secret": { + "codespaces/remove-selected-repo-from-org-secret": { parameters: { query?: never; header?: never; @@ -95049,6 +102037,7 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; /** @description Conflict when visibility type not set to selected */ 409: { headers: { @@ -95056,9 +102045,10 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed"]; }; }; - "packages/list-docker-migration-conflicting-packages-for-organization": { + "copilot/get-copilot-organization-details": { parameters: { query?: never; header?: never; @@ -95070,84 +102060,35 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package"][]; + "application/json": components["schemas"]["copilot-organization-details"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - }; - }; - "activity/list-public-org-events": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["event"][]; - }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-failed-invitations": { + "copilot/list-copilot-seats": { 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["organization-invitation"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "orgs/list-webhooks": { - 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"]; + per_page?: number; }; header?: never; path: { @@ -95165,13 +102106,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"][]; + "application/json": { + /** @description Total number of Copilot seats for the organization currently being billed. */ + total_seats?: number; + seats?: components["schemas"]["copilot-seat-details"][]; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/create-webhook": { + "copilot/add-copilot-seats-for-teams": { parameters: { query?: never; header?: never; @@ -95184,342 +102132,250 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Must be passed as "web". */ - name: string; - /** @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"]; - /** @example "kdaigle" */ - username?: string; - /** @example "password" */ - password?: string; - }; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. - * @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; + /** @description List of team names within the organization to which to grant access to GitHub Copilot. */ + selected_teams: string[]; }; }; }; responses: { - /** @description Response */ + /** @description OK */ 201: { - headers: { - /** @example https://api.github.com/orgs/octocat/hooks/1 */ - Location?: string; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["org-hook"]; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "orgs/get-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 */ - 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_created: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - }; - }; - "orgs/delete-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: { + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { headers: { [name: string]: unknown; }; content?: never; }; - 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/update-webhook": { + "copilot/cancel-copilot-seat-assignment-for-teams": { 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?: { + 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; + /** @description The names of teams from which to revoke access to GitHub Copilot. */ + selected_teams: string[]; }; }; }; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-hook"]; + "application/json": { + seats_cancelled: number; + }; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 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: { + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["webhook-config"]; - }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/update-webhook-config-for-org": { + "copilot/add-copilot-seats-for-users": { 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?: { + 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"]; + /** @description The usernames of the organization members to be granted access to GitHub Copilot. */ + selected_usernames: string[]; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description OK */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": { + seats_created: number; + }; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/list-webhook-deliveries": { + "copilot/cancel-copilot-seat-assignment-for-users": { 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"]; - }; + 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; + requestBody: { + content: { + "application/json": { + /** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */ + selected_usernames: string[]; + }; + }; + }; responses: { - /** @description Response */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery-item"][]; + "application/json": { + seats_cancelled: number; + }; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "orgs/get-webhook-delivery": { + "copilot/copilot-content-exclusion-for-organization": { 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 */ + /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["hook-delivery"]; + "application/json": components["schemas"]["copilot-organization-content-exclusion-details"]; }; }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "orgs/redeliver-webhook-delivery": { + "copilot/set-copilot-content-exclusion-for-organization": { 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"]; + /** @description The content exclusion rules to set */ + requestBody: { + content: { + "application/json": { + [key: string]: (string | { + ifAnyMatch: string[]; + } | { + ifNoneMatch: string[]; + })[]; + }; }; - cookie?: never; }; - requestBody?: never; responses: { - /** @description Response */ - 204: { + /** @description Success */ + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": { + message?: string; + }; + }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 413: components["responses"]["too_large"]; + 422: components["responses"]["validation_failed_simple"]; + 500: components["responses"]["internal_error"]; }; }; - "api-insights/get-route-stats-by-actor": { + "copilot/copilot-metrics-for-organization": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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 100 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 results per page (max 100). For 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"]; - /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ - api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + /** @description The number of days of metrics to display per page (max 100). For 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 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; }; @@ -95531,28 +102387,89 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-route-stats"]; + "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"]; }; }; - "api-insights/get-subject-stats": { + "dependabot/list-alerts-for-org": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; + query?: { + /** + * @description A comma-separated list of states. If specified, only alerts with these states will be returned. + * + * Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` + */ + state?: components["parameters"]["dependabot-alert-comma-separated-states"]; + /** + * @description A comma-separated list of severities. If specified, only alerts with these severities will be returned. + * + * Can be: `low`, `medium`, `high`, `critical` + */ + severity?: components["parameters"]["dependabot-alert-comma-separated-severities"]; + /** + * @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. + * + * Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` + */ + ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"]; + /** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */ + package?: components["parameters"]["dependabot-alert-comma-separated-packages"]; + /** + * @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as: + * - An exact number (`n`) + * - Comparators such as `>n`, `=n`, `<=n` + * - A range like `n..n`, where `n` is a number from 0.0 to 1.0 + * + * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. + */ + epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */ + artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"]; + /** + * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + * + * Can be: `jfrog-artifactory` + */ + artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. + */ + has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; + /** + * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + * + * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + */ + runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"]; + /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ + scope?: components["parameters"]["dependabot-alert-scope"]; + /** + * @description The property by which to sort the results. + * `created` means when the alert was created. + * `updated` means when the alert's state last changed. + * `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage. + */ + sort?: components["parameters"]["dependabot-alert-sort"]; /** @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"]; - /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ - subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + /** @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 number of results per page (max 100). For 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: { @@ -95569,18 +102486,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-subject-stats"]; + "application/json": components["schemas"]["dependabot-alert-with-repository"][]; }; }; + 304: components["responses"]["not_modified"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "api-insights/get-summary-stats": { + "dependabot/list-org-secrets": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; + 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: { @@ -95594,28 +102516,25 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": { + total_count: number; + secrets: components["schemas"]["organization-dependabot-secret"][]; + }; }; }; }; }; - "api-insights/get-summary-stats-by-user": { + "dependabot/get-org-public-key": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; }; cookie?: never; }; @@ -95627,27 +102546,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["dependabot-public-key"]; }; }; }; }; - "api-insights/get-summary-stats-by-actor": { + "dependabot/get-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - max_timestamp?: components["parameters"]["api-insights-max-timestamp"]; - }; + query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -95659,91 +102571,96 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-summary-stats"]; + "application/json": components["schemas"]["organization-dependabot-secret"]; }; }; }; }; - "api-insights/get-time-stats": { + "dependabot/create-or-update-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */ + encrypted_value?: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids?: (number | string)[]; + }; + }; + }; responses: { - /** @description Response */ - 200: { + /** @description Response when creating a secret */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "api-insights/get-time-stats-by-user": { + "dependabot/delete-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-time-stats"]; - }; + content?: never; }; }; }; - "api-insights/get-time-stats-by-actor": { + "dependabot/list-selected-repos-for-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; + 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 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -95755,107 +102672,107 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["api-insights-time-stats"]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; }; }; - "api-insights/get-user-stats": { + "dependabot/set-selected-repos-for-org-secret": { parameters: { - query: { - /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - min_timestamp: components["parameters"]["api-insights-min-timestamp"]; - /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - 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"]; - /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ - actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the user to query for stats */ - user_id: components["parameters"]["api-insights-user-id"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */ + selected_repository_ids: number[]; + }; + }; + }; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["api-insights-user-stats"]; - }; + content?: never; }; }; }; - "apps/get-org-installation": { + "dependabot/add-selected-repo-to-org-secret": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description No Content when repository was added to the selected list */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["installation"]; + content?: never; + }; + /** @description Conflict when visibility type is not set to selected */ + 409: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "orgs/list-app-installations": { + "dependabot/remove-selected-repo-from-org-secret": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + repository_id: number; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { + /** @description Response when repository was removed from the selected list */ + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": { - total_count: number; - installations: components["schemas"]["installation"][]; - }; + content?: never; + }; + /** @description Conflict when visibility type not set to selected */ + 409: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "interactions/get-restrictions-for-org": { + "packages/list-docker-migration-conflicting-packages-for-organization": { parameters: { query?: never; header?: never; @@ -95873,14 +102790,21 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["interaction-limit-response"] | Record; + "application/json": components["schemas"]["package"][]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "interactions/set-restrictions-for-org": { + "activity/list-public-org-events": { parameters: { - query?: never; + 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. */ @@ -95888,11 +102812,7 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["interaction-limit"]; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -95900,15 +102820,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["interaction-limit-response"]; + "application/json": components["schemas"]["event"][]; }; }; - 422: components["responses"]["validation_failed"]; }; }; - "interactions/remove-restrictions-for-org": { + "orgs/list-failed-invitations": { parameters: { - query?: never; + 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. */ @@ -95919,25 +102843,25 @@ export interface operations { requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/list-pending-invitations": { + "orgs/list-webhooks": { 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 Filter invitations by their member role. */ - role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; - /** @description Filter invitations by their invitation source. */ - invitation_source?: "all" | "member" | "scim"; }; header?: never; path: { @@ -95955,13 +102879,13 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["org-hook"][]; }; }; 404: components["responses"]["not_found"]; }; }; - "orgs/create-invitation": { + "orgs/create-webhook": { parameters: { query?: never; header?: never; @@ -95971,25 +102895,34 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ - invitee_id?: number; - /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ - email?: string; + /** @description Must be passed as "web". */ + name: string; + /** @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"]; + /** @example "kdaigle" */ + username?: string; + /** @example "password" */ + password?: string; + }; /** - * @description The role for the new member. - * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. - * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. - * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. - * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. - * @default direct_member - * @enum {string} + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events. + * @default [ + * "push" + * ] */ - role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; - /** @description Specify IDs for the teams you want to invite new members to. */ - team_ids?: number[]; + events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; }; }; }; @@ -95997,131 +102930,130 @@ export interface operations { /** @description Response */ 201: { headers: { + /** @example https://api.github.com/orgs/octocat/hooks/1 */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"]; + "application/json": components["schemas"]["org-hook"]; }; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "orgs/cancel-invitation": { + "orgs/get-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 invitation. */ - invitation_id: components["parameters"]["invitation-id"]; + /** @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: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-hook"]; + }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-invitation-teams": { + "orgs/delete-webhook": { 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"]; - }; + 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 invitation. */ - invitation_id: components["parameters"]["invitation-id"]; + /** @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: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team"][]; - }; + content?: never; }; 404: components["responses"]["not_found"]; }; }; - "issues/list-for-org": { + "orgs/update-webhook": { parameters: { - query?: { - /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ - filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; - /** @description Indicates the state of the issues to return. */ - state?: "open" | "closed" | "all"; - /** @description A list of comma separated label names. Example: `bug,ui,@high` */ - labels?: components["parameters"]["labels"]; - /** @description What to sort results by. */ - sort?: "created" | "updated" | "comments"; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - since?: components["parameters"]["since"]; - /** @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"]; - }; + 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; + 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: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issue"][]; + "application/json": components["schemas"]["org-hook"]; }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-members": { + "orgs/get-webhook-config-for-org": { parameters: { - query?: { - /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */ - filter?: "2fa_disabled" | "all"; - /** @description Filter members returned by their role. */ - role?: "all" | "admin" | "member"; - /** @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"]; - }; + 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; }; @@ -96130,93 +103062,90 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["webhook-config"]; }; }; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/check-membership-for-user": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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 if requester is an organization member and user is a member */ - 204: { - headers: { - [name: string]: unknown; + 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"]; }; - content?: never; }; - /** @description Response if requester is not an organization member */ - 302: { + }; + responses: { + /** @description Response */ + 200: { headers: { - /** @example https://api.github.com/orgs/github/public_members/pezra */ - Location?: string; [name: string]: unknown; }; - content?: never; - }; - /** @description Not Found if requester is an organization member and user is not a member */ - 404: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["webhook-config"]; }; - content?: never; }; }; }; - "orgs/remove-member": { + "orgs/list-webhook-deliveries": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["hook-delivery-item"][]; + }; }; - 403: components["responses"]["forbidden"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "codespaces/get-codespaces-for-user-in-org": { + "orgs/get-webhook-delivery": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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; }; @@ -96228,120 +103157,121 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - codespaces: components["schemas"]["codespace"][]; - }; + "application/json": components["schemas"]["hook-delivery"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "codespaces/delete-from-organization": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + /** @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"]; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; + 400: components["responses"]["bad_request"]; + 422: components["responses"]["validation_failed"]; }; }; - "codespaces/stop-in-organization": { + "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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The name of the codespace. */ - codespace_name: components["parameters"]["codespace-name"]; + /** @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: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["codespace"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "copilot/get-copilot-seat-details-for-user": { + "api-insights/get-route-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */ + api_route_substring?: components["parameters"]["api-insights-api-route-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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 The user's GitHub Copilot seat details, including usage. */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-seat-details"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ - 422: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["api-insights-route-stats"]; }; - content?: never; }; - 500: components["responses"]["internal_error"]; }; }; - "orgs/get-membership-for-user": { + "api-insights/get-subject-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */ + subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; @@ -96353,39 +103283,27 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["api-insights-subject-stats"]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/set-membership-for-user": { + "api-insights/get-summary-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The role to give the user in the organization. Can be one of: - * * `admin` - The user will become an owner of the organization. - * * `member` - The user will become a non-owner member of the organization. - * @default member - * @enum {string} - */ - role?: "admin" | "member"; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -96393,52 +103311,57 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["org-membership"]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/remove-membership-for-user": { + "api-insights/get-summary-stats-by-user": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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-summary-stats"]; + }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "migrations/list-for-org": { + "api-insights/get-summary-stats-by-actor": { 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 Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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; }; @@ -96447,18 +103370,24 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"][]; + "application/json": components["schemas"]["api-insights-summary-stats"]; }; }; }; }; - "migrations/start-for-org": { + "api-insights/get-time-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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. */ @@ -96466,179 +103395,149 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description A list of arrays indicating which repositories should be migrated. */ - repositories: string[]; - /** - * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. - * @default false - * @example true - */ - lock_repositories?: boolean; - /** - * @description Indicates whether metadata should be excluded and only git source should be included for the migration. - * @default false - */ - exclude_metadata?: boolean; - /** - * @description Indicates whether the repository git data should be excluded from the migration. - * @default false - */ - exclude_git_data?: boolean; - /** - * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). - * @default false - * @example true - */ - exclude_attachments?: boolean; - /** - * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). - * @default false - * @example true - */ - exclude_releases?: boolean; - /** - * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. - * @default false - * @example true - */ - exclude_owner_projects?: boolean; - /** - * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). - * @default false - * @example true - */ - org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ - exclude?: "repositories"[]; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "migrations/get-status-for-org": { + "api-insights/get-time-stats-by-user": { parameters: { - query?: { - /** @description Exclude attributes from the API response to improve performance */ - exclude?: "repositories"[]; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 migration. */ - migration_id: components["parameters"]["migration-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 * `pending`, which means the migration hasn't started yet. - * * `exporting`, which means the migration is in progress. - * * `exported`, which means the migration finished successfully. - * * `failed`, which means the migration failed. - */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["migration"]; + "application/json": components["schemas"]["api-insights-time-stats"]; }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/download-archive-for-org": { + "api-insights/get-time-stats-by-actor": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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 migration. */ - migration_id: components["parameters"]["migration-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: { /** @description Response */ - 302: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["api-insights-time-stats"]; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/delete-archive-for-org": { + "api-insights/get-user-stats": { parameters: { - query?: never; + query: { + /** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + min_timestamp: components["parameters"]["api-insights-min-timestamp"]; + /** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + 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"]; + /** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */ + actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the migration. */ - migration_id: components["parameters"]["migration-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"]; }; }; - "migrations/unlock-repo-for-org": { + "apps/get-org-installation": { 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 migration. */ - migration_id: components["parameters"]["migration-id"]; - /** @description repo_name parameter */ - repo_name: components["parameters"]["repo-name"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["installation"]; + }; }; - 404: components["responses"]["not_found"]; }; }; - "migrations/list-repos-for-org": { + "orgs/list-app-installations": { 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)." */ @@ -96650,8 +103549,6 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the migration. */ - migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; @@ -96664,13 +103561,15 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + installations: components["schemas"]["installation"][]; + }; }; }; - 404: components["responses"]["not_found"]; }; }; - "orgs/list-org-roles": { + "interactions/get-restrictions-for-org": { parameters: { query?: never; header?: never; @@ -96682,58 +103581,52 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response - list of organization roles */ + /** @description Response */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - /** @description The total number of organization roles available to the organization. */ - total_count?: number; - /** @description The list of organization roles available to the organization. */ - roles?: components["schemas"]["organization-role"][]; - }; + "application/json": components["schemas"]["interaction-limit-response"] | Record; }; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/revoke-all-org-roles-team": { + "interactions/set-restrictions-for-org": { parameters: { query?: never; 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; + requestBody: { + content: { + "application/json": components["schemas"]["interaction-limit"]; + }; + }; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["interaction-limit-response"]; + }; }; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/assign-team-to-org-role": { + "interactions/remove-restrictions-for-org": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; @@ -96746,56 +103639,97 @@ export interface operations { }; content?: never; }; - /** @description Response if the organization, team or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; + }; + }; + "orgs/list-pending-invitations": { + 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 Filter invitations by their member role. */ + role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; + /** @description Filter invitations by their invitation source. */ + invitation_source?: "all" | "member" | "scim"; }; - /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ - 422: { + 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: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/revoke-org-role-team": { + "orgs/create-invitation": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */ + invitee_id?: number; + /** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */ + email?: string; + /** + * @description The role for the new member. + * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. + * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. + * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. + * @default direct_member + * @enum {string} + */ + role?: "admin" | "direct_member" | "billing_manager" | "reinstate"; + /** @description Specify IDs for the teams you want to invite new members to. */ + team_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ - 204: { + 201: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-invitation"]; + }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/revoke-all-org-roles-user": { + "orgs/cancel-invitation": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description The unique identifier of the invitation. */ + invitation_id: components["parameters"]["invitation-id"]; }; cookie?: never; }; @@ -96808,85 +103742,81 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/assign-user-to-org-role": { + "orgs/list-invitation-teams": { parameters: { - query?: never; + 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 The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; + /** @description The unique identifier of the invitation. */ + invitation_id: components["parameters"]["invitation-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization, user or role does not exist. */ - 404: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["team"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/revoke-org-role-user": { + "orgs/list-issue-types": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["issue-type"][]; + }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/get-org-role": { + "orgs/create-issue-type": { 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 role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["organization-create-issue-type"]; + }; + }; responses: { /** @description Response */ 200: { @@ -96894,61 +103824,86 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-role"]; + "application/json": components["schemas"]["issue-type"]; }; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/list-org-role-teams": { + "orgs/update-issue-type": { 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"]; - }; + 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 role. */ - role_id: components["parameters"]["role-id"]; + /** @description The unique identifier of the issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": components["schemas"]["organization-update-issue-type"]; + }; + }; responses: { - /** @description Response - List of assigned teams */ + /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-role-assignment"][]; + "application/json": components["schemas"]["issue-type"]; }; }; - /** @description Response if the organization or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; + }; + }; + "orgs/delete-issue-type": { + 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 issue type. */ + issue_type_id: components["parameters"]["issue-type-id"]; }; - /** @description Response if the organization roles feature is not enabled or validation failed. */ - 422: { + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/list-org-role-users": { + "issues/list-for-org": { parameters: { query?: { + /** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */ + filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all"; + /** @description Indicates the state of the issues to return. */ + state?: "open" | "closed" | "all"; + /** @description A list of comma separated label names. Example: `bug,ui,@high` */ + labels?: components["parameters"]["labels"]; + /** @description Can be the name of an issue type. */ + type?: string; + /** @description What to sort results by. */ + sort?: "created" | "updated" | "comments"; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + since?: components["parameters"]["since"]; /** @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)." */ @@ -96958,44 +103913,31 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The unique identifier of the role. */ - role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response - List of assigned users */ + /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["user-role-assignment"][]; - }; - }; - /** @description Response if the organization or role does not exist. */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Response if the organization roles feature is not enabled or validation failed. */ - 422: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["issue"][]; }; - content?: never; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/list-outside-collaborators": { + "orgs/list-members": { parameters: { query?: { - /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ - filter?: "2fa_disabled" | "all"; + /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; + /** @description Filter members returned by their role. */ + role?: "all" | "admin" | "member"; /** @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)." */ @@ -97020,9 +103962,10 @@ export interface operations { "application/json": components["schemas"]["simple-user"][]; }; }; + 422: components["responses"]["validation_failed"]; }; }; - "orgs/convert-member-to-outside-collaborator": { + "orgs/check-membership-for-user": { parameters: { query?: never; header?: never; @@ -97034,45 +103977,34 @@ export interface operations { }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. - * @default false - */ - async?: boolean; - }; - }; - }; + requestBody?: never; responses: { - /** @description User is getting converted asynchronously */ - 202: { + /** @description Response if requester is an organization member and user is a member */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": Record; - }; + content?: never; }; - /** @description User was converted */ - 204: { + /** @description Response if requester is not an organization member */ + 302: { headers: { + /** @example https://api.github.com/orgs/github/public_members/pezra */ + Location?: string; [name: string]: unknown; }; content?: never; }; - /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ - 403: { + /** @description Not Found if requester is an organization member and user is not a member */ + 404: { headers: { [name: string]: unknown; }; content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "orgs/remove-outside-collaborator": { + "orgs/remove-member": { parameters: { query?: never; header?: never; @@ -97093,41 +104025,23 @@ export interface operations { }; content?: never; }; - /** @description Unprocessable Entity if user is a member of the organization */ - 422: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; + 403: components["responses"]["forbidden"]; }; }; - "packages/list-packages-for-organization": { + "codespaces/get-codespaces-for-user-in-org": { parameters: { - query: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; - /** - * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. - * - * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. - * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." - */ - visibility?: components["parameters"]["package-visibility"]; - /** @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?: number; + 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?: number; + 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 The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97139,150 +104053,120 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package"][]; + "application/json": { + total_count: number; + codespaces: components["schemas"]["codespace"][]; + }; }; }; - 400: components["responses"]["package_es_list_error"]; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-package-for-organization": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; - /** @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"]["package"]; - }; - }; - }; - }; - "packages/delete-package-for-org": { + "codespaces/delete-from-organization": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The name of the codespace. */ + codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; + 202: components["responses"]["accepted"]; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/restore-package-for-org": { + "codespaces/stop-in-organization": { parameters: { - query?: { - /** @description package token */ - token?: string; - }; + query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The name of the codespace. */ + codespace_name: components["parameters"]["codespace-name"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["codespace"]; + }; }; + 304: components["responses"]["not_modified"]; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-all-package-versions-for-package-owned-by-org": { + "copilot/get-copilot-seat-details-for-user": { 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"]; - /** @description The state of the package, either active or deleted. */ - state?: "active" | "deleted"; - }; + query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description The user's GitHub Copilot seat details, including usage. */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package-version"][]; + "application/json": components["schemas"]["copilot-seat-details"]; }; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 500: components["responses"]["internal_error"]; }; }; - "packages/get-package-version-for-organization": { + "orgs/get-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97294,54 +104178,62 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["package-version"]; + "application/json": components["schemas"]["org-membership"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "packages/delete-package-version-for-org": { + "orgs/set-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** + * @description The role to give the user in the organization. Can be one of: + * * `admin` - The user will become an owner of the organization. + * * `member` - The user will become a non-owner member of the organization. + * @default member + * @enum {string} + */ + role?: "admin" | "member"; + }; + }; + }; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-membership"]; + }; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "packages/restore-package-version-for-org": { + "orgs/remove-membership-for-user": { parameters: { query?: never; header?: never; path: { - /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ - package_type: components["parameters"]["package-type"]; - /** @description The name of the package. */ - package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the package version. */ - package_version_id: components["parameters"]["package-version-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -97354,32 +104246,19 @@ export interface operations { }; content?: never; }; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "orgs/list-pat-grant-requests": { + "migrations/list-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 The property by which to sort the results. */ - sort?: components["parameters"]["personal-access-token-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description A list of owner usernames to use to filter the results. */ - owner?: components["parameters"]["personal-access-token-owner"]; - /** @description The name of the repository to use to filter the results. */ - repository?: components["parameters"]["personal-access-token-repository"]; - /** @description The permission to use to filter the results. */ - permission?: components["parameters"]["personal-access-token-permission"]; - /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_before?: components["parameters"]["personal-access-token-before"]; - /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; header?: never; path: { @@ -97397,16 +104276,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; + "application/json": components["schemas"]["migration"][]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/review-pat-grant-requests-in-bulk": { + "migrations/start-for-org": { parameters: { query?: never; header?: never; @@ -97419,203 +104294,176 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ - pat_request_ids?: number[]; + /** @description A list of arrays indicating which repositories should be migrated. */ + repositories: string[]; /** - * @description Action to apply to the requests. - * @enum {string} + * @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data. + * @default false + * @example true */ - action: "approve" | "deny"; - /** @description Reason for approving or denying the requests. Max 1024 characters. */ - reason?: string | null; - }; - }; - }; - responses: { - 202: components["responses"]["accepted"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; - }; - }; - "orgs/review-pat-grant-request": { - 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 request for access via fine-grained personal access token. */ - pat_request_id: number; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { + lock_repositories?: boolean; /** - * @description Action to apply to the request. - * @enum {string} + * @description Indicates whether metadata should be excluded and only git source should be included for the migration. + * @default false */ - action: "approve" | "deny"; - /** @description Reason for approving or denying the request. Max 1024 characters. */ - reason?: string | null; + exclude_metadata?: boolean; + /** + * @description Indicates whether the repository git data should be excluded from the migration. + * @default false + */ + exclude_git_data?: boolean; + /** + * @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size). + * @default false + * @example true + */ + exclude_attachments?: boolean; + /** + * @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size). + * @default false + * @example true + */ + exclude_releases?: boolean; + /** + * @description Indicates whether projects owned by the organization or users should be excluded. from the migration. + * @default false + * @example true + */ + exclude_owner_projects?: boolean; + /** + * @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags). + * @default false + * @example true + */ + org_metadata_only?: boolean; + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ + exclude?: "repositories"[]; }; }; }; responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["migration"]; + }; + }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grant-request-repositories": { + "migrations/get-status-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 Exclude attributes from the API response to improve performance */ + exclude?: "repositories"[]; }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the request for access via fine-grained personal access token. */ - pat_request_id: number; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** + * @description * `pending`, which means the migration hasn't started yet. + * * `exporting`, which means the migration is in progress. + * * `exported`, which means the migration finished successfully. + * * `failed`, which means the migration failed. + */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["migration"]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grants": { + "migrations/download-archive-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 The property by which to sort the results. */ - sort?: components["parameters"]["personal-access-token-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description A list of owner usernames to use to filter the results. */ - owner?: components["parameters"]["personal-access-token-owner"]; - /** @description The name of the repository to use to filter the results. */ - repository?: components["parameters"]["personal-access-token-repository"]; - /** @description The permission to use to filter the results. */ - permission?: components["parameters"]["personal-access-token-permission"]; - /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_before?: components["parameters"]["personal-access-token-before"]; - /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ - last_used_after?: components["parameters"]["personal-access-token-after"]; - }; + 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 migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 302: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["organization-programmatic-access-grant"][]; - }; + content?: never; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/update-pat-accesses": { + "migrations/delete-archive-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 migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Action to apply to the fine-grained personal access token. - * @enum {string} - */ - action: "revoke"; - /** @description The IDs of the fine-grained personal access tokens. */ - pat_ids: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 202: components["responses"]["accepted"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/update-pat-access": { + "migrations/unlock-repo-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 fine-grained personal access token. */ - pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; + /** @description repo_name parameter */ + repo_name: components["parameters"]["repo-name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description Action to apply to the fine-grained personal access token. - * @enum {string} - */ - action: "revoke"; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - 500: components["responses"]["internal_error"]; }; }; - "orgs/list-pat-grant-repositories": { + "migrations/list-repos-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)." */ @@ -97627,8 +104475,8 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the fine-grained personal access token. */ - pat_id: number; + /** @description The unique identifier of the migration. */ + migration_id: components["parameters"]["migration-id"]; }; cookie?: never; }; @@ -97644,19 +104492,12 @@ export interface operations { "application/json": components["schemas"]["minimal-repository"][]; }; }; - 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "private-registries/list-org-private-registries": { + "orgs/list-org-roles": { 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"]; - }; + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -97666,142 +104507,145 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description Response - list of organization roles */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { "application/json": { - total_count: number; - configurations: components["schemas"]["org-private-registry-configuration"][]; + /** @description The total number of organization roles available to the organization. */ + total_count?: number; + /** @description The list of organization roles available to the organization. */ + roles?: components["schemas"]["organization-role"][]; }; }; }; - 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "private-registries/create-org-private-registry": { + "orgs/revoke-all-org-roles-team": { parameters: { query?: never; 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: { - content: { - "application/json": { - /** - * @description The registry type. - * @enum {string} - */ - registry_type: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - encrypted_value: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id: string; - /** - * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. - * @enum {string} - */ - visibility: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + }; + }; + "orgs/assign-team-to-org-role": { + parameters: { + query?: never; + 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"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; + cookie?: never; }; + requestBody?: never; responses: { - /** @description The organization private registry configuration */ - 201: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + content?: never; + }; + /** @description Response if the organization, team or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "private-registries/get-org-public-key": { + "orgs/revoke-org-role-team": { parameters: { query?: never; 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"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": { - /** - * @description The identifier for the key. - * @example 012345678912345678 - */ - key_id: string; - /** - * @description The Base64 encoded public key. - * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - */ - key: string; - }; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "private-registries/get-org-private-registry": { + "orgs/revoke-all-org-roles-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description The specified private registry configuration for the organization */ - 200: { + /** @description Response */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-private-registry-configuration"]; - }; + content?: never; }; - 404: components["responses"]["not_found"]; }; }; - "private-registries/delete-org-private-registry": { + "orgs/assign-user-to-org-role": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; @@ -97814,63 +104658,77 @@ export interface operations { }; content?: never; }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; + /** @description Response if the organization, user or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "private-registries/update-org-private-registry": { + "orgs/revoke-org-role-user": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** - * @description The registry type. - * @enum {string} - */ - registry_type?: "maven_repository"; - /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ - username?: string | null; - /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ - encrypted_value?: string; - /** @description The ID of the key you used to encrypt the secret. */ - key_id?: string; - /** - * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. - * @enum {string} - */ - visibility?: "all" | "private" | "selected"; - /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ - selected_repository_ids?: number[]; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; + }; + "orgs/get-org-role": { + 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 role. */ + role_id: components["parameters"]["role-id"]; + }; + cookie?: never; + }; + requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["organization-role"]; + }; }; 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; - "projects/list-for-org": { + "orgs/list-org-role-teams": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; /** @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)." */ @@ -97880,64 +104738,94 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description Response - List of assigned teams */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["team-role-assignment"][]; }; }; - 422: components["responses"]["validation_failed_simple"]; + /** @description Response if the organization or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/create-for-org": { + "orgs/list-org-role-users": { parameters: { - query?: never; + 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 The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response */ - 201: { + /** @description Response - List of assigned users */ + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["user-role-assignment"][]; + }; + }; + /** @description Response if the organization or role does not exist. */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response if the organization roles feature is not enabled or validation failed. */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "orgs/get-all-custom-properties": { + "orgs/list-outside-collaborators": { parameters: { - query?: never; + query?: { + /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */ + filter?: "2fa_disabled" | "2fa_insecure" | "all"; + /** @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. */ @@ -97950,92 +104838,125 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties": { + "orgs/convert-member-to-outside-collaborator": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/json": { - /** @description The array of custom properties to create or update. */ - properties: components["schemas"]["custom-property"][]; + /** + * @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued. + * @default false + */ + async?: boolean; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description User is getting converted asynchronously */ + 202: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"][]; + "application/json": Record; }; }; - 403: components["responses"]["forbidden"]; + /** @description User was converted */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */ + 403: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 404: components["responses"]["not_found"]; }; }; - "orgs/get-custom-property": { + "orgs/remove-outside-collaborator": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Unprocessable Entity if user is a member of the organization */ + 422: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"]; + "application/json": { + message?: string; + documentation_url?: string; + }; }; }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-property": { + "packages/list-packages-for-organization": { parameters: { - query?: never; + query: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container"; + /** + * @description The selected visibility of the packages. This parameter is optional and only filters an existing result set. + * + * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. + * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + */ + visibility?: components["parameters"]["package-visibility"]; + /** @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?: number; + /** @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?: number; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": components["schemas"]["custom-property-set-payload"]; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -98043,44 +104964,50 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["custom-property"]; + "application/json": components["schemas"]["package"][]; }; }; + 400: components["responses"]["package_es_list_error"]; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "orgs/remove-custom-property": { + "packages/get-package-for-organization": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The custom property name */ - custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody?: never; responses: { - 204: components["responses"]["no_content"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["package"]; + }; + }; }; }; - "orgs/list-custom-properties-values-for-repos": { + "packages/delete-package-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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ - repository_query?: string; - }; + query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98089,62 +105016,64 @@ export interface operations { requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["org-repo-custom-property-values"][]; - }; + content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "orgs/create-or-update-custom-properties-values-for-repos": { + "packages/restore-package-for-org": { parameters: { - query?: never; + query?: { + /** @description package token */ + token?: string; + }; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The names of repositories that the custom property values will be applied to. */ - repository_names: string[]; - /** @description List of custom property names and associated values to apply to the repositories. */ - properties: components["schemas"]["custom-property-value"][]; - }; - }; - }; + requestBody?: never; responses: { - /** @description No Content when custom property values are successfully created or updated */ + /** @description Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "orgs/list-public-members": { + "packages/get-all-package-versions-for-package-owned-by-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 The number of results per page (max 100). For 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 state of the package, either active or deleted. */ + state?: "active" | "deleted"; }; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98155,54 +105084,59 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["package-version"][]; }; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/check-public-membership-for-user": { + "packages/get-package-version-for-organization": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response if user is a public member */ - 204: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description Not Found if user is not a public member */ - 404: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["package-version"]; }; - content?: never; }; }; }; - "orgs/set-public-membership-for-authenticated-user": { + "packages/delete-package-version-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; @@ -98215,18 +105149,24 @@ export interface operations { }; content?: never; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/remove-public-membership-for-authenticated-user": { + "packages/restore-package-version-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */ + package_type: components["parameters"]["package-type"]; + /** @description The name of the package. */ + package_name: components["parameters"]["package-name"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @description Unique identifier of the package version. */ + package_version_id: components["parameters"]["package-version-id"]; }; cookie?: never; }; @@ -98239,21 +105179,34 @@ export interface operations { }; content?: never; }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "repos/list-for-org": { + "orgs/list-pat-grant-requests": { parameters: { query?: { - /** @description Specifies the types of repositories you want returned. */ - type?: "all" | "public" | "private" | "forks" | "sources" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; /** @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 The property by which to sort the results. */ + sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ + owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ + repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ + permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; }; header?: never; path: { @@ -98271,12 +105224,16 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["organization-programmatic-access-grant-request"][]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "repos/create-in-org": { + "orgs/review-pat-grant-requests-in-bulk": { parameters: { query?: never; header?: never; @@ -98289,249 +105246,62 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The name of the repository. */ - name: string; - /** @description A short description of the repository. */ - description?: string; - /** @description A URL with more information about the repository. */ - homepage?: string; - /** - * @description Whether the repository is private. - * @default false - */ - private?: boolean; - /** - * @description The visibility of the repository. - * @enum {string} - */ - visibility?: "public" | "private"; - /** - * @description Either `true` to enable issues for this repository or `false` to disable them. - * @default true - */ - has_issues?: boolean; - /** - * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. - * @default true - */ - has_projects?: boolean; - /** - * @description Either `true` to enable the wiki for this repository or `false` to disable it. - * @default true - */ - has_wiki?: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - has_downloads?: boolean; - /** - * @description Either `true` to make this repo available as a template repository or `false` to prevent it. - * @default false - */ - is_template?: boolean; - /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ - team_id?: number; - /** - * @description Pass `true` to create an initial commit with empty README. - * @default false - */ - auto_init?: boolean; - /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ - gitignore_template?: string; - /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ - license_template?: string; - /** - * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. - * @default true - */ - allow_squash_merge?: boolean; - /** - * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. - * @default true - */ - allow_merge_commit?: boolean; - /** - * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. - * @default true - */ - allow_rebase_merge?: boolean; - /** - * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. - * @default false - */ - allow_auto_merge?: boolean; - /** - * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** - * @default false - */ - 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 is closing down. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default?: boolean; - /** - * @description Required when using `squash_merge_commit_message`. - * - * The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description Required when using `merge_commit_message`. - * - * The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */ + pat_request_ids?: number[]; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * @description Action to apply to the requests. * @enum {string} */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; + action: "approve" | "deny"; + /** @description Reason for approving or denying the requests. Max 1024 characters. */ + reason?: string | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - /** @example https://api.github.com/repos/octocat/Hello-World */ - Location?: string; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["full-repository"]; - }; - }; + 202: components["responses"]["accepted"]; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/get-org-rulesets": { - 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 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: { - /** @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"]["repository-ruleset"][]; - }; - }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/create-org-ruleset": { + "orgs/review-pat-grant-request": { 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 request for access via fine-grained personal access token. */ + pat_request_id: number; }; cookie?: never; }; - /** @description Request body */ requestBody: { content: { "application/json": { - /** @description The name of the ruleset. */ - name: string; /** - * @description The target of the ruleset - * @default branch + * @description Action to apply to the request. * @enum {string} */ - target?: "branch" | "tag" | "push" | "repository"; - enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions?: components["schemas"]["org-ruleset-conditions"]; - /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + action: "approve" | "deny"; + /** @description Reason for approving or denying the request. Max 1024 characters. */ + reason?: string | null; }; }; }; responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-rule-suites": { + "orgs/list-pat-grant-request-repositories": { parameters: { query?: { - /** @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?: components["parameters"]["ref-in-query"]; - /** @description The name of the repository to filter on. */ - repository_name?: components["parameters"]["repository-name-in-query"]; - /** - * @description The time period to filter by. - * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). - */ - time_period?: components["parameters"]["time-period"]; - /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ - actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ - rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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)." */ @@ -98541,6 +105311,8 @@ export interface operations { path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description Unique identifier of the request for access via fine-grained personal access token. */ + pat_request_id: number; }; cookie?: never; }; @@ -98549,30 +105321,46 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["rule-suites"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; - }; - }; - "repos/get-org-rule-suite": { - parameters: { - query?: never; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "orgs/list-pat-grants": { + 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 The property by which to sort the results. */ + sort?: components["parameters"]["personal-access-token-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description A list of owner usernames to use to filter the results. */ + owner?: components["parameters"]["personal-access-token-owner"]; + /** @description The name of the repository to use to filter the results. */ + repository?: components["parameters"]["personal-access-token-repository"]; + /** @description The permission to use to filter the results. */ + permission?: components["parameters"]["personal-access-token-permission"]; + /** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_before?: components["parameters"]["personal-access-token-before"]; + /** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ + last_used_after?: components["parameters"]["personal-access-token-after"]; + /** @description The ID of the token */ + token_id?: components["parameters"]["personal-access-token-token-id"]; + }; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** - * @description The unique identifier of the rule suite result. - * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) - * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) - * for organizations. - */ - rule_suite_id: components["parameters"]["rule-suite-id"]; }; cookie?: never; }; @@ -98581,141 +105369,122 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["rule-suite"]; + "application/json": components["schemas"]["organization-programmatic-access-grant"][]; }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/get-org-ruleset": { + "orgs/update-pat-accesses": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the ruleset. */ - ruleset_id: number; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; + requestBody: { + content: { + "application/json": { + /** + * @description Action to apply to the fine-grained personal access token. + * @enum {string} + */ + action: "revoke"; + /** @description The IDs of the fine-grained personal access tokens. */ + pat_ids: number[]; }; }; + }; + responses: { + 202: components["responses"]["accepted"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/update-org-ruleset": { + "orgs/update-pat-access": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The ID of the ruleset. */ - ruleset_id: number; + /** @description The unique identifier of the fine-grained personal access token. */ + pat_id: components["parameters"]["fine-grained-personal-access-token-id"]; }; cookie?: never; }; - /** @description Request body */ - requestBody?: { + requestBody: { content: { "application/json": { - /** @description The name of the ruleset. */ - name?: string; /** - * @description The target of the ruleset + * @description Action to apply to the fine-grained personal access token. * @enum {string} */ - target?: "branch" | "tag" | "push" | "repository"; - enforcement?: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; - conditions?: components["schemas"]["org-ruleset-conditions"]; - /** @description An array of rules within the ruleset. */ - rules?: components["schemas"]["repository-rule"][]; + action: "revoke"; }; }; }; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["repository-ruleset"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; - "repos/delete-org-ruleset": { + "orgs/list-pat-grant-repositories": { parameters: { - query?: never; + 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 The ID of the ruleset. */ - ruleset_id: number; + /** @description Unique identifier of the fine-grained personal access token. */ + pat_id: number; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; 500: components["responses"]["internal_error"]; }; }; - "secret-scanning/list-alerts-for-org": { + "private-registries/list-org-private-registries": { parameters: { query?: { - /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ - state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ - secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; - /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ - resolution?: components["parameters"]["secret-scanning-alert-resolution"]; - /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ - sort?: components["parameters"]["secret-scanning-alert-sort"]; - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ - before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; - /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ - 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"]; + /** @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: { @@ -98733,29 +105502,77 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-secret-scanning-alert"][]; + "application/json": { + total_count: number; + configurations: components["schemas"]["org-private-registry-configuration"][]; + }; }; }; + 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; - 503: components["responses"]["service_unavailable"]; }; }; - "security-advisories/list-org-repository-advisories": { + "private-registries/create-org-private-registry": { parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "published"; - /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ - per_page?: number; - /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ - state?: "triage" | "draft" | "published" | "closed"; + 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 The registry type. + * @enum {string} + */ + registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url: string; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; + responses: { + /** @description The organization private registry configuration */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"]; + }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "private-registries/get-org-public-key": { + parameters: { + query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ @@ -98768,48 +105585,62 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository-advisory"][]; + "application/json": { + /** + * @description The identifier for the key. + * @example 012345678912345678 + */ + key_id: string; + /** + * @description The Base64 encoded public key. + * @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + */ + key: string; + }; }; }; - 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; }; }; - "orgs/list-security-manager-teams": { + "private-registries/get-org-private-registry": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ + /** @description The specified private registry configuration for the organization */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-simple"][]; + "application/json": components["schemas"]["org-private-registry-configuration"]; }; }; + 404: components["responses"]["not_found"]; }; }; - "orgs/add-security-manager-team": { + "private-registries/delete-org-private-registry": { parameters: { query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; @@ -98822,21 +105653,56 @@ export interface operations { }; content?: never; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - "orgs/remove-security-manager-team": { + "private-registries/update-org-private-registry": { parameters: { query?: never; 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"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The registry type. + * @enum {string} + */ + registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry"; + /** + * Format: uri + * @description The URL of the private registry. + */ + url?: string; + /** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */ + username?: string | null; + /** + * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages. + * @default false + */ + replaces_base?: boolean; + /** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */ + encrypted_value?: string; + /** @description The ID of the key you used to encrypt the secret. */ + key_id?: string; + /** + * @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry. + * @enum {string} + */ + visibility?: "all" | "private" | "selected"; + /** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */ + selected_repository_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -98845,11 +105711,22 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "billing/get-github-actions-billing-org": { + "projects/list-for-org": { parameters: { - query?: never; + query?: { + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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. */ @@ -98862,19 +105739,25 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["projects-v2"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "billing/get-github-packages-billing-org": { + "projects/get-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98885,47 +105768,70 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["projects-v2"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "billing/get-shared-storage-billing-org": { + "projects/create-draft-item-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; - requestBody?: never; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; responses: { /** @description Response */ - 200: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/list-network-configurations-for-org": { + "projects/list-fields-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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98940,19 +105846,21 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - total_count: number; - network_configurations: components["schemas"]["network-configuration"][]; - }; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/create-network-configuration-for-org": { + "projects/add-field-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; }; @@ -98961,39 +105869,65 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + /** @description The ID of the IssueField to create the field for. */ + issue_field_id: number; + } | { + /** @description The name of the field. */ name: string; /** - * @description The hosted compute service to use for the network configuration. + * @description The field's data type. * @enum {string} */ - compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - network_settings_ids: string[]; + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; }; }; }; responses: { - /** @description Response */ + /** @description Response for adding a field to an organization-owned project. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-configuration"]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "hosted-compute/get-network-configuration-for-org": { + "projects/get-field-for-org": { parameters: { query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -99006,117 +105940,123 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-configuration"]; + "application/json": components["schemas"]["projects-v2-field"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/delete-network-configuration-from-org": { + "projects/list-items-for-org": { parameters: { - query?: never; + query?: { + /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description Unique identifier of the hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"][]; + }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "hosted-compute/update-network-configuration-for-org": { + "projects/add-item-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 hosted compute network configuration. */ - network_configuration_id: components["parameters"]["network-configuration-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ requestBody: { content: { "application/json": { - /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ - name?: string; /** - * @description The hosted compute service to use for the network configuration. + * @description The type of item to add to the project. Must be either Issue or PullRequest. * @enum {string} */ - compute_service?: "none" | "actions"; - /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */ - network_settings_ids?: string[]; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["network-configuration"]; - }; - }; - }; - }; - "hosted-compute/get-network-settings-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 hosted compute network settings. */ - network_settings_id: components["parameters"]["network-settings-id"]; + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); }; - cookie?: never; }; - requestBody?: never; responses: { /** @description Response */ - 200: { + 201: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["network-settings"]; + "application/json": components["schemas"]["projects-v2-item-simple"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "copilot/copilot-metrics-for-team": { + "projects/get-org-item": { 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; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; @@ -99125,161 +106065,189 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["copilot-usage-metrics-day"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; 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": { + "projects/delete-item-for-org": { 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; - }; + query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["copilot-usage-metrics"][]; - }; + content?: never; }; 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 500: components["responses"]["internal_error"]; }; }; - "teams/list": { + "projects/update-item-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"]; - }; + query?: never; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; }; cookie?: never; }; - requestBody?: never; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; responses: { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"]; }; }; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/create": { + "projects/create-view-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The name of the team. */ + /** + * @description The name of the view. + * @example Sprint Board + */ name: string; - /** @description The description of the team. */ - description?: string; - /** @description List GitHub IDs for organization members who will become team maintainers. */ - maintainers?: string[]; - /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ - repo_names?: string[]; /** - * @description The level of privacy this team should have. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * Default: `secret` - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * Default for child team: `closed` + * @description The layout of the view. + * @example board * @enum {string} */ - privacy?: "secret" | "closed"; + layout: "table" | "board" | "roadmap"; /** - * @description The notification setting the team has chosen. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * Default: `notifications_enabled` - * @enum {string} + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; + filter?: string; /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] */ - permission?: "pull" | "push"; - /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number; + visible_fields?: number[]; }; }; }; responses: { - /** @description Response */ + /** @description Response for creating a view in an organization-owned project. */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["projects-v2-view"]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; }; }; - "teams/get-by-name": { + "projects/list-view-items-for-org": { parameters: { - query?: never; + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @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"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -99288,127 +106256,85 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; }; }; - "teams/delete-in-org": { + "orgs/custom-properties-for-repos-get-organization-definitions": { parameters: { query?: never; 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 */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["custom-property"][]; + }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/update-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-definitions": { parameters: { query?: never; 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?: { + requestBody: { content: { "application/json": { - /** @description The name of the team. */ - name?: string; - /** @description The description of the team. */ - description?: string; - /** - * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: - * **For a non-nested team:** - * * `secret` - only visible to organization owners and members of this team. - * * `closed` - visible to all members of this organization. - * **For a parent or child team:** - * * `closed` - visible to all members of this organization. - * @enum {string} - */ - privacy?: "secret" | "closed"; - /** - * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: - * * `notifications_enabled` - team members receive notifications when the team is @mentioned. - * * `notifications_disabled` - no one receives notifications. - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. - * @default pull - * @enum {string} - */ - permission?: "pull" | "push" | "admin"; - /** @description The ID of a team to set as the parent team. */ - parent_team_id?: number | null; + /** @description The array of custom properties to create or update. */ + properties: components["schemas"]["custom-property"][]; }; }; }; responses: { - /** @description Response when the updated information already exists */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-full"]; - }; - }; /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-full"]; + "application/json": components["schemas"]["custom-property"][]; }; }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-in-org": { + "orgs/custom-properties-for-repos-get-organization-definition": { parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 Pinned discussions only filter */ - pinned?: string; - }; + query?: never; 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"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; @@ -99417,147 +106343,135 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"][]; + "application/json": components["schemas"]["custom-property"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/create-discussion-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-definition": { parameters: { query?: never; 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"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody: { content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; + "application/json": components["schemas"]["custom-property-set-payload"]; }; }; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion"]; + "application/json": components["schemas"]["custom-property"]; }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/get-discussion-in-org": { + "orgs/custom-properties-for-repos-delete-organization-definition": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The custom property name */ + custom_property_name: components["parameters"]["custom-property-name"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/delete-discussion-in-org": { + "orgs/custom-properties-for-repos-get-organization-values": { parameters: { - query?: never; + 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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ + repository_query?: string; + }; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/update-discussion-in-org": { + "orgs/custom-properties-for-repos-create-or-update-organization-values": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** @description The discussion post's title. */ - title?: string; - /** @description The discussion post's body text. */ - body?: string; + /** @description The names of repositories that the custom property values will be applied to. */ + repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; }; }; }; responses: { - /** @description Response */ - 200: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; + content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussion-comments-in-org": { + "orgs/list-public-members": { parameters: { query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; /** @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)." */ @@ -99567,10 +106481,6 @@ export interface operations { 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; }; cookie?: never; }; @@ -99583,87 +106493,74 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion-comment"][]; + "application/json": components["schemas"]["simple-user"][]; }; }; }; }; - "teams/create-discussion-comment-in-org": { + "orgs/check-public-membership-for-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; + requestBody?: never; responses: { - /** @description Response */ - 201: { + /** @description Response if user is a public member */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; + content?: never; + }; + /** @description Not Found if user is not a public member */ + 404: { + headers: { + [name: string]: unknown; }; + content?: never; }; }; }; - "teams/get-discussion-comment-in-org": { + "orgs/set-public-membership-for-authenticated-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; + content?: never; }; + 403: components["responses"]["forbidden"]; }; }; - "teams/delete-discussion-comment-in-org": { + "orgs/remove-public-membership-for-authenticated-user": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -99678,62 +106575,217 @@ export interface operations { }; }; }; - "teams/update-discussion-comment-in-org": { + "repos/list-for-org": { + parameters: { + query?: { + /** @description Specifies the types of repositories you want returned. */ + type?: "all" | "public" | "private" | "forks" | "sources" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["minimal-repository"][]; + }; + }; + }; + }; + "repos/create-in-org": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; requestBody: { content: { "application/json": { - /** @description The discussion comment's body text. */ - body: string; + /** @description The name of the repository. */ + name: string; + /** @description A short description of the repository. */ + description?: string; + /** @description A URL with more information about the repository. */ + homepage?: string; + /** + * @description Whether the repository is private. + * @default false + */ + private?: boolean; + /** + * @description The visibility of the repository. + * @enum {string} + */ + visibility?: "public" | "private"; + /** + * @description Either `true` to enable issues for this repository or `false` to disable them. + * @default true + */ + has_issues?: boolean; + /** + * @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error. + * @default true + */ + has_projects?: boolean; + /** + * @description Either `true` to enable the wiki for this repository or `false` to disable it. + * @default true + */ + has_wiki?: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + has_downloads?: boolean; + /** + * @description Either `true` to make this repo available as a template repository or `false` to prevent it. + * @default false + */ + is_template?: boolean; + /** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */ + team_id?: number; + /** + * @description Pass `true` to create an initial commit with empty README. + * @default false + */ + auto_init?: boolean; + /** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */ + gitignore_template?: string; + /** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */ + license_template?: string; + /** + * @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. + * @default true + */ + allow_squash_merge?: boolean; + /** + * @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. + * @default true + */ + allow_merge_commit?: boolean; + /** + * @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. + * @default true + */ + allow_rebase_merge?: boolean; + /** + * @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + * @default false + */ + allow_auto_merge?: boolean; + /** + * @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.** + * @default false + */ + 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 is closing down. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default?: boolean; + /** + * @description Required when using `squash_merge_commit_message`. + * + * The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description Required when using `merge_commit_message`. + * + * The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; }; }; responses: { /** @description Response */ - 200: { + 201: { headers: { + /** @example https://api.github.com/repos/octocat/Hello-World */ + Location?: string; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-discussion-comment"]; + "application/json": components["schemas"]["full-repository"]; }; }; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; }; }; - "reactions/list-for-team-discussion-comment-in-org": { + "repos/get-org-rulesets": { parameters: { query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; /** @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 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: { /** @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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; @@ -99742,110 +106794,147 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"][]; + "application/json": components["schemas"]["repository-ruleset"][]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/create-for-team-discussion-comment-in-org": { + "repos/create-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; }; cookie?: never; }; + /** @description Request body */ requestBody: { content: { "application/json": { + /** @description The name of the ruleset. */ + name: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. + * @description The target of the ruleset + * @default branch * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + target?: "branch" | "tag" | "push" | "repository"; + enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["org-rules"][]; }; }; }; responses: { - /** @description Response when the reaction type has already been added to this team discussion comment */ - 200: { + /** @description Response */ + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-org-rule-suites": { + parameters: { + query?: { + /** @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?: components["parameters"]["ref-in-query"]; + /** @description The name of the repository to filter on. */ + repository_name?: components["parameters"]["repository-name-in-query"]; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). + */ + time_period?: components["parameters"]["time-period"]; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ + actor_name?: components["parameters"]["actor-name-in-query"]; + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ + rule_suite_result?: components["parameters"]["rule-suite-result"]; + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["rule-suites"]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/delete-for-team-discussion-comment": { + "repos/get-org-rule-suite": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; + /** + * @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. + */ + rule_suite_id: components["parameters"]["rule-suite-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["rule-suite"]; + }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; - }; - "reactions/list-for-team-discussion-in-org": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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"]; - }; + }; + "repos/get-org-ruleset": { + parameters: { + query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -99854,37 +106943,45 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"][]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/create-for-team-discussion-in-org": { + "repos/update-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; - requestBody: { + /** @description Request body */ + requestBody?: { content: { "application/json": { + /** @description The name of the ruleset. */ + name?: string; /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. + * @description The target of the ruleset * @enum {string} */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + target?: "branch" | "tag" | "push" | "repository"; + enforcement?: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + conditions?: components["schemas"]["org-ruleset-conditions"]; + /** @description An array of rules within the ruleset. */ + rules?: components["schemas"]["org-rules"][]; }; }; }; @@ -99895,33 +106992,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; + "application/json": components["schemas"]["repository-ruleset"]; }; }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 500: components["responses"]["internal_error"]; }; }; - "reactions/delete-for-team-discussion": { + "repos/delete-org-ruleset": { parameters: { query?: never; 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"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The unique identifier of the reaction. */ - reaction_id: components["parameters"]["reaction-id"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -99934,9 +107021,11 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "teams/list-pending-invitations-in-org": { + "orgs/get-org-ruleset-history": { 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)." */ @@ -99948,8 +107037,8 @@ export interface operations { 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"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; }; cookie?: never; }; @@ -99958,31 +107047,81 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["organization-invitation"][]; + "application/json": components["schemas"]["ruleset-version"][]; }; }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; }; }; - "teams/list-members-in-org": { + "orgs/get-org-ruleset-version": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "secret-scanning/list-alerts-for-org": { parameters: { query?: { - /** @description Filters members returned by their role in the team. */ - role?: "member" | "maintainer" | "all"; - /** @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 Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ + state?: components["parameters"]["secret-scanning-alert-state"]; + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; + /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ + resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; + /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ + sort?: components["parameters"]["secret-scanning-alert-sort"]; + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; /** @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 A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ + before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; + /** @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 events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ + 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; 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; }; @@ -99995,22 +107134,20 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["organization-secret-scanning-alert"][]; }; }; + 404: components["responses"]["not_found"]; + 503: components["responses"]["service_unavailable"]; }; }; - "teams/get-membership-for-user-in-org": { + "secret-scanning/list-org-pattern-configs": { parameters: { query?: never; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; @@ -100022,41 +107159,48 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description if user has no team membership */ - 404: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["secret-scanning-pattern-configuration"]; }; - content?: never; }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "teams/add-or-update-membership-for-user-in-org": { + "secret-scanning/update-org-pattern-configs": { parameters: { query?: never; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { - /** - * @description The role that this user should have in the team. - * @default member - * @enum {string} - */ - role?: "member" | "maintainer"; + pattern_config_version?: components["schemas"]["secret-scanning-row-version"]; + /** @description Pattern settings for provider patterns. */ + provider_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "not-set" | "disabled" | "enabled"; + }[]; + /** @description Pattern settings for custom patterns. */ + custom_pattern_settings?: { + /** @description The ID of the pattern to configure. */ + token_type?: string; + custom_pattern_version?: components["schemas"]["secret-scanning-row-version"]; + /** + * @description Push protection setting to set for the pattern. + * @enum {string} + */ + push_protection_setting?: "disabled" | "enabled"; + }[]; }; }; }; @@ -100067,71 +107211,64 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-membership"]; - }; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Unprocessable Entity if you attempt to add an organization to a team */ - 422: { - headers: { - [name: string]: unknown; + "application/json": { + /** @description The updated pattern configuration version. */ + pattern_config_version?: string; + }; }; - content?: never; }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; }; }; - "teams/remove-membership-for-user-in-org": { + "security-advisories/list-org-repository-advisories": { parameters: { - query?: never; + query?: { + /** @description The direction to sort the results by. */ + direction?: components["parameters"]["direction"]; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "published"; + /** @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 number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */ + per_page?: number; + /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */ + state?: "triage" | "draft" | "published" | "closed"; + }; 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"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description Forbidden if team synchronization is set up */ - 403: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["repository-advisory"][]; }; - content?: never; }; + 400: components["responses"]["bad_request"]; + 404: components["responses"]["not_found"]; }; }; - "teams/list-projects-in-org": { + "orgs/list-security-manager-teams": { 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"]; - }; + query?: never; 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; }; @@ -100140,16 +107277,15 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team-project"][]; + "application/json": components["schemas"]["team-simple"][]; }; }; }; }; - "teams/check-permissions-for-project-in-org": { + "orgs/add-security-manager-team": { parameters: { query?: never; header?: never; @@ -100158,24 +107294,13 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { + 204: { headers: { [name: string]: unknown; }; @@ -100183,7 +107308,7 @@ export interface operations { }; }; }; - "teams/add-or-update-project-permissions-in-org": { + "orgs/remove-security-manager-team": { parameters: { query?: never; header?: never; @@ -100192,22 +107317,10 @@ export interface operations { org: components["parameters"]["org"]; /** @description The slug of the team name. */ team_slug: components["parameters"]["team-slug"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; + requestBody?: never; responses: { /** @description Response */ 204: { @@ -100216,35 +107329,55 @@ export interface operations { }; content?: never; }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { + }; + }; + "orgs/get-immutable-releases-settings": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Immutable releases settings response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message?: string; - documentation_url?: string; - }; + "application/json": components["schemas"]["immutable-releases-organization-settings"]; }; }; }; }; - "teams/remove-project-in-org": { + "orgs/set-immutable-releases-settings": { parameters: { query?: never; 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"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; }; cookie?: never; }; - requestBody?: never; + requestBody: { + content: { + "application/json": { + /** + * @description The policy that controls how immutable releases are enforced in the organization. + * @example all + * @enum {string} + */ + enforced_repositories: "all" | "none" | "selected"; + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids?: number[]; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -100255,20 +107388,18 @@ export interface operations { }; }; }; - "teams/list-repos-in-org": { + "orgs/get-immutable-releases-settings-repositories": { 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 The number of results per page (max 100). For 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 The slug of the team name. */ - team_slug: components["parameters"]["team-slug"]; }; cookie?: never; }; @@ -100277,82 +107408,58 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": { + total_count: number; + repositories: components["schemas"]["minimal-repository"][]; + }; }; }; }; }; - "teams/check-permissions-for-repo-in-org": { + "orgs/set-immutable-releases-settings-repositories": { parameters: { query?: never; 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"]; - /** @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"]; }; cookie?: never; }; - requestBody?: never; - responses: { - /** @description Alternative response with repository permissions */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-repository"]; + requestBody: { + content: { + "application/json": { + /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */ + selected_repository_ids: number[]; }; }; - /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ + }; + responses: { + /** @description Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - /** @description Not Found if team does not have permission for the repository */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; }; }; - "teams/add-or-update-repo-permissions-in-org": { + "orgs/enable-selected-repository-immutable-releases-organization": { parameters: { query?: never; 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"]; - /** @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 unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ - permission?: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 204: { @@ -100363,19 +107470,15 @@ export interface operations { }; }; }; - "teams/remove-repo-in-org": { + "orgs/disable-selected-repository-immutable-releases-organization": { parameters: { query?: never; 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"]; - /** @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 unique identifier of the repository. */ + repository_id: components["parameters"]["repository-id"]; }; cookie?: never; }; @@ -100390,7 +107493,7 @@ export interface operations { }; }; }; - "teams/list-child-in-org": { + "hosted-compute/list-network-configurations-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)." */ @@ -100402,80 +107505,72 @@ export interface operations { 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 if child teams exist */ + /** @description Response */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["team"][]; + "application/json": { + total_count: number; + network_configurations: components["schemas"]["network-configuration"][]; + }; }; }; }; }; - "orgs/enable-or-disable-security-product-on-all-org-repos": { + "hosted-compute/create-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { /** @description The organization name. The name is not case sensitive. */ org: components["parameters"]["org"]; - /** @description The security feature to enable or disable. */ - security_product: components["parameters"]["security-product"]; - /** - * @description The action to take. - * - * `enable_all` means to enable the specified security feature for all repositories in the organization. - * `disable_all` means to disable the specified security feature for all repositories in the organization. - */ - enablement: components["parameters"]["org-security-product-enablement"]; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name: string; /** - * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. - * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @description The hosted compute service to use for the network configuration. * @enum {string} */ - query_suite?: "default" | "extended"; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids: string[]; }; }; }; responses: { - /** @description Action started */ - 204: { + /** @description Response */ + 201: { headers: { [name: string]: unknown; }; - content?: never; - }; - /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ - 422: { - headers: { - [name: string]: unknown; + content: { + "application/json": components["schemas"]["network-configuration"]; }; - content?: never; }; }; }; - "projects/get-card": { + "hosted-compute/get-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -100484,25 +107579,24 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["network-configuration"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "projects/delete-card": { + "hosted-compute/delete-network-configuration-from-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; @@ -100515,154 +107609,35 @@ export interface operations { }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "projects/update-card": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The project card's note - * @example Update all gems - */ - note?: string | null; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project-card"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "projects/move-card": { + "hosted-compute/update-network-configuration-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the card. */ - card_id: components["parameters"]["card-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network configuration. */ + network_configuration_id: components["parameters"]["network-configuration-id"]; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */ + name?: string; /** - * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card. - * @example bottom - */ - position: string; - /** - * @description The unique identifier of the column the card should be moved to - * @example 42 + * @description The hosted compute service to use for the network configuration. + * @enum {string} */ - column_id?: number; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": Record; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - resource?: string; - field?: string; - }[]; - }; - }; - }; - 422: components["responses"]["validation_failed"]; - /** @description Response */ - 503: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - }[]; - }; + compute_service?: "none" | "actions"; + /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */ + network_settings_ids?: string[]; }; }; }; - }; - "projects/get-column": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; - }; - cookie?: never; - }; - requestBody?: never; responses: { /** @description Response */ 200: { @@ -100670,60 +107645,59 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"]; + "application/json": components["schemas"]["network-configuration"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; }; }; - "projects/delete-column": { + "hosted-compute/get-network-settings-for-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description Unique identifier of the hosted compute network settings. */ + network_settings_id: components["parameters"]["network-settings-id"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["network-settings"]; + }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; }; }; - "projects/update-column": { + "copilot/copilot-metrics-for-team": { parameters: { - query?: never; + 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 100 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 100). For 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 unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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: { - content: { - "application/json": { - /** - * @description Name of the project column - * @example Remaining tasks - */ - name: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ 200: { @@ -100731,19 +107705,18 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"]; + "application/json": components["schemas"]["copilot-usage-metrics-day"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["usage_metrics_api_disabled"]; + 500: components["responses"]["internal_error"]; }; }; - "projects/list-cards": { + "teams/list": { parameters: { query?: { - /** @description Filters the project cards that are returned by the card's state. */ - archived_state?: "all" | "archived" | "not_archived"; /** @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)." */ @@ -100751,8 +107724,8 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; @@ -100765,43 +107738,61 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"][]; + "application/json": components["schemas"]["team"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; }; }; - "projects/create-card": { + "teams/create": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; }; cookie?: never; }; requestBody: { content: { "application/json": { + /** @description The name of the team. */ + name: string; + /** @description The description of the team. */ + description?: string; + /** @description List GitHub usernames for organization members who will become team maintainers. */ + maintainers?: string[]; + /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */ + repo_names?: string[]; /** - * @description The project card's note - * @example Update all gems + * @description The level of privacy this team should have. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * Default: `secret` + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * Default for child team: `closed` + * @enum {string} */ - note: string | null; - } | { + privacy?: "secret" | "closed"; /** - * @description The unique identifier of the content associated with the card - * @example 42 + * @description The notification setting the team has chosen. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * Default: `notifications_enabled` + * @enum {string} */ - content_id: number; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The piece of content associated with the card - * @example PullRequest + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} */ - content_type: string; + permission?: "pull" | "push"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number; }; }; }; @@ -100812,84 +107803,148 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-card"]; + "application/json": components["schemas"]["team-full"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - /** @description Validation failed */ - 422: { + 422: components["responses"]["validation_failed"]; + }; + }; + "teams/get-by-name": { + parameters: { + query?: never; + 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"]["validation-error"] | components["schemas"]["validation-error-simple"]; + "application/json": components["schemas"]["team-full"]; }; }; + 404: components["responses"]["not_found"]; + }; + }; + "teams/delete-in-org": { + parameters: { + query?: never; + 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 */ - 503: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - code?: string; - message?: string; - documentation_url?: string; - errors?: { - code?: string; - message?: string; - }[]; - }; - }; + content?: never; }; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - "projects/move-column": { + "teams/update-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the column. */ - column_id: components["parameters"]["column-id"]; + /** @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: { + requestBody?: { content: { "application/json": { + /** @description The name of the team. */ + name?: string; + /** @description The description of the team. */ + description?: string; + /** + * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: + * **For a non-nested team:** + * * `secret` - only visible to organization owners and members of this team. + * * `closed` - visible to all members of this organization. + * **For a parent or child team:** + * * `closed` - visible to all members of this organization. + * @enum {string} + */ + privacy?: "secret" | "closed"; + /** + * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: + * * `notifications_enabled` - team members receive notifications when the team is @mentioned. + * * `notifications_disabled` - no one receives notifications. + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column. - * @example last + * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified. + * @default pull + * @enum {string} */ - position: string; + permission?: "pull" | "push" | "admin"; + /** @description The ID of a team to set as the parent team. */ + parent_team_id?: number | null; }; }; }; responses: { + /** @description Response when the updated information already exists */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-full"]; + }; + }; /** @description Response */ 201: { headers: { [name: string]: unknown; }; content: { - "application/json": Record; + "application/json": components["schemas"]["team-full"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; - "projects/get": { + "teams/list-pending-invitations-in-org": { parameters: { - query?: never; + 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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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; }; @@ -100898,62 +107953,94 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["organization-invitation"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; + 422: components["responses"]["enterprise_team_unsupported"]; }; }; - "projects/delete": { + "teams/list-members-in-org": { parameters: { - query?: never; + query?: { + /** @description Filters members returned by their role in the team. */ + role?: "member" | "maintainer" | "all"; + /** @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 unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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 Delete Success */ - 204: { + /** @description Response */ + 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["simple-user"][]; + }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ - 403: { + }; + }; + "teams/get-membership-for-user-in-org": { + parameters: { + query?: never; + 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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; + "application/json": components["schemas"]["team-membership"]; }; }; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; + /** @description if user has no team membership */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/update": { + "teams/add-or-update-membership-for-user-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; }; cookie?: never; }; @@ -100961,27 +108048,11 @@ export interface operations { content: { "application/json": { /** - * @description Name of the project - * @example Week One Sprint - */ - name?: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - /** - * @description State of the project; either 'open' or 'closed' - * @example open - */ - state?: string; - /** - * @description The baseline permission that all organization members have on this project + * @description The role that this user should have in the team. + * @default member * @enum {string} */ - organization_permission?: "read" | "write" | "admin" | "none"; - /** @description Whether or not this project can be seen by everyone. */ - private?: boolean; + role?: "member" | "maintainer"; }; }; }; @@ -100992,40 +108063,60 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"]; + "application/json": components["schemas"]["team-membership"]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - /** @description Forbidden */ + /** @description Forbidden if team synchronization is set up */ 403: { headers: { [name: string]: unknown; }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - errors?: string[]; - }; + content?: never; + }; + /** @description Unprocessable Entity if you attempt to add an organization to a team */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - /** @description Not Found if the authenticated user does not have access to the project */ - 404: { + }; + }; + "teams/remove-membership-for-user-in-org": { + parameters: { + query?: never; + 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"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Forbidden if team synchronization is set up */ + 403: { headers: { [name: string]: unknown; }; content?: never; }; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; }; }; - "projects/list-collaborators": { + "teams/list-repos-in-org": { parameters: { query?: { - /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ - affiliation?: "outside" | "direct" | "all"; /** @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)." */ @@ -101033,8 +108124,10 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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; }; @@ -101047,69 +108140,78 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["simple-user"][]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/add-collaborator": { + "teams/check-permissions-for-repo-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant the collaborator. - * @default write - * @example write - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - } | null; - }; - }; + requestBody?: never; responses: { - /** @description Response */ + /** @description Alternative response with repository permissions */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["team-repository"]; + }; + }; + /** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; + /** @description Not Found if team does not have permission for the repository */ + 404: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; - "projects/remove-collaborator": { + "teams/add-or-update-repo-permissions-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": { + /** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */ + permission?: string; + }; + }; + }; responses: { /** @description Response */ 204: { @@ -101118,44 +108220,36 @@ export interface operations { }; content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/get-permission-for-user": { + "teams/remove-repo-in-org": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - /** @description The handle for the GitHub user account. */ - username: components["parameters"]["username"]; + /** @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"]; + /** @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"]; }; cookie?: never; }; requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project-collaborator-permission"]; - }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "projects/list-columns": { + "teams/list-child-in-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)." */ @@ -101165,63 +108259,73 @@ export interface operations { }; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @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 */ + /** @description if child teams exist */ 200: { headers: { Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project-column"][]; + "application/json": components["schemas"]["team"][]; }; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; }; }; - "projects/create-column": { + "orgs/enable-or-disable-security-product-on-all-org-repos": { parameters: { query?: never; header?: never; path: { - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; + /** @description The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @description The security feature to enable or disable. */ + security_product: components["parameters"]["security-product"]; + /** + * @description The action to take. + * + * `enable_all` means to enable the specified security feature for all repositories in the organization. + * `disable_all` means to disable the specified security feature for all repositories in the organization. + */ + enablement: components["parameters"]["org-security-product-enablement"]; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/json": { /** - * @description Name of the project column - * @example Remaining tasks + * @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. + * If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied. + * @enum {string} */ - name: string; + query_suite?: "default" | "extended"; }; }; }; responses: { - /** @description Response */ - 201: { + /** @description Action started */ + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["project-column"]; + content?: never; + }; + /** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */ + 422: { + headers: { + [name: string]: unknown; }; + content?: never; }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; }; }; "rate-limit/get": { @@ -101312,6 +108416,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "repos/update": { @@ -101357,11 +108462,22 @@ export interface operations { * You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. */ security_and_analysis?: { - /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */ + /** + * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. + * For more information, see "[About GitHub Advanced + * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + * + * For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + */ advanced_security?: { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */ + code_security?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; /** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */ secret_scanning?: { /** @description Can be `enabled` or `disabled`. */ @@ -101382,6 +108498,36 @@ export interface operations { /** @description Can be `enabled` or `disabled`. */ status?: string; }; + /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */ + secret_scanning_delegated_alert_dismissal?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */ + secret_scanning_delegated_bypass?: { + /** @description Can be `enabled` or `disabled`. */ + status?: string; + }; + /** + * @description Feature options for secret scanning delegated bypass. + * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. + */ + secret_scanning_delegated_bypass_options?: { + /** + * @description The bypass reviewers for secret scanning delegated bypass. + * If you omit this field, the existing set of reviewers is unchanged. + */ + 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"; + }[]; + }; } | null; /** * @description Either `true` to enable issues for this repository or `false` to disable them. @@ -101629,6 +108775,120 @@ export interface operations { 410: components["responses"]["gone"]; }; }; + "actions/get-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-retention-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/get-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-actions-cache-storage-limit-for-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "actions/get-actions-cache-usage": { parameters: { query?: never; @@ -102014,6 +109274,7 @@ export interface operations { "application/json": { enabled: components["schemas"]["actions-enabled"]; allowed_actions?: components["schemas"]["allowed-actions"]; + sha_pinning_required?: components["schemas"]["sha-pinning-required"]; }; }; }; @@ -102079,6 +109340,172 @@ export interface operations { }; }; }; + "actions/get-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention-response"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-artifact-and-log-retention-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-artifact-and-log-retention"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-fork-pr-contributor-approval-permissions-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-contributor-approval"]; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "actions/get-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + "actions/set-private-repo-fork-pr-workflows-settings-repository": { + 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"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"]; + }; + }; + responses: { + /** @description Empty response for successful settings update */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "actions/get-allowed-actions-repository": { parameters: { query?: never; @@ -102283,6 +109710,7 @@ export interface operations { responses: { 201: components["responses"]["actions_runner_jitconfig"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed_simple"]; }; }; @@ -102386,6 +109814,7 @@ export interface operations { }; content?: never; }; + 422: components["responses"]["validation_failed_simple"]; }; }; "actions/list-labels-for-self-hosted-runner-for-repo": { @@ -103266,9 +110695,9 @@ export interface operations { content: { "application/json": { /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */ - encrypted_value?: string; + encrypted_value: string; /** @description ID of the key you used to encrypt the secret. */ - key_id?: string; + key_id: string; }; }; }; @@ -103575,15 +111004,26 @@ export interface operations { "application/json": { /** @description The git reference for the workflow. The reference can be a branch or tag name. */ ref: string; - /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ + /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */ inputs?: { [key: string]: unknown; }; + /** @description Whether the response should include the workflow run ID and URLs. */ + return_run_details?: boolean; }; }; }; responses: { - /** @description Response */ + /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["workflow-dispatch-response"]; + }; + }; + /** @description Empty response when `return_run_details` parameter is `false`. */ 204: { headers: { [name: string]: unknown; @@ -103874,6 +111314,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -103911,6 +111357,7 @@ export interface operations { }; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -105903,6 +113350,11 @@ export interface operations { state?: components["schemas"]["code-scanning-alert-state-query"]; /** @description If specified, only code scanning alerts with this severity will be returned. */ severity?: components["schemas"]["code-scanning-alert-severity"]; + /** + * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignees?: string; }; header?: never; path: { @@ -105978,10 +113430,12 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["code-scanning-alert-set-state"]; + state?: components["schemas"]["code-scanning-alert-set-state"]; dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"]; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - }; + create_request?: components["schemas"]["code-scanning-alert-create-request"]; + assignees?: components["schemas"]["code-scanning-alert-assignees"]; + } | unknown | unknown; }; }; responses: { @@ -105994,6 +113448,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-alert"]; }; }; + 400: components["responses"]["bad_request"]; 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 503: components["responses"]["service_unavailable"]; @@ -106150,7 +113605,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["code-scanning-alert-instance"][]; + "application/json": components["schemas"]["code-scanning-alert-instance-list"][]; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; @@ -106228,13 +113683,14 @@ export interface operations { }; content: { "application/json": components["schemas"]["code-scanning-analysis"]; - "application/json+sarif": { + "application/sarif+json": { [key: string]: unknown; }; }; }; 403: components["responses"]["code_scanning_forbidden_read"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["unprocessable_analysis"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -106538,6 +113994,7 @@ export interface operations { 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; + 422: components["responses"]["code_scanning_invalid_state"]; 503: components["responses"]["service_unavailable"]; }; }; @@ -107242,7 +114699,19 @@ export interface operations { content?: never; }; 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed"]; + /** + * @description Response when: + * - validation failed, or the endpoint has been spammed + * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + */ + 422: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["validation-error"]; + }; + }; }; }; "repos/remove-collaborator": { @@ -107984,7 +115453,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -108212,6 +115685,17 @@ export interface operations { * Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. */ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"]; + /** + * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + */ + has?: components["parameters"]["dependabot-alert-comma-separated-has"]; + /** + * @description Filter alerts by assignees. + * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + */ + assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"]; /** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */ scope?: components["parameters"]["dependabot-alert-scope"]; /** @@ -108223,32 +115707,12 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** - * @deprecated - * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead. - */ - page?: number; - /** - * @deprecated - * @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?: number; /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. - * This parameter must not be used in combination with `last`. - * Instead, use `per_page` in combination with `after` to fetch the first page of results. - */ - first?: components["parameters"]["pagination-first"]; - /** - * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result. - * This parameter must not be used in combination with `first`. - * Instead, use `per_page` in combination with `before` to fetch the last page of results. - */ - last?: components["parameters"]["pagination-last"]; + /** @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: { @@ -108339,7 +115803,7 @@ export interface operations { * A `dismissed_reason` must be provided when setting the state to `dismissed`. * @enum {string} */ - state: "dismissed" | "open"; + state?: "dismissed" | "open"; /** * @description **Required when `state` is `dismissed`.** A reason for dismissing the alert. * @enum {string} @@ -108347,7 +115811,13 @@ export interface operations { dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk"; /** @description An optional comment associated with dismissing the alert. */ dismissed_comment?: string; - }; + /** + * @description Usernames to assign to this Dependabot Alert. + * Pass one or more user logins to _replace_ the set of assignees on this alert. + * Send an empty array (`[]`) to clear all assignees from the alert. + */ + assignees?: string[]; + } | unknown | unknown; }; }; responses: { @@ -110179,7 +117649,13 @@ export interface operations { content?: never; }; 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; + /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; "git/update-ref": { @@ -110554,7 +118030,233 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/update-webhook": { + "repos/update-webhook": { + 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 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": { + config?: components["schemas"]["webhook-config"]; + /** + * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. + * @default [ + * "push" + * ] + */ + events?: string[]; + /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ + add_events?: string[]; + /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ + remove_events?: string[]; + /** + * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. + * @default true + */ + active?: boolean; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["hook"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/get-webhook-config-for-repo": { + 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 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"]; + }; + }; + }; + }; + "repos/update-webhook-config-for-repo": { + 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 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"]; + }; + }; + }; + }; + "repos/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 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 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"]; + }; + }; + "repos/get-webhook-delivery": { + 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 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"]; + }; + }; + "repos/redeliver-webhook-delivery": { + 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 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"]; + }; + }; + "repos/ping-webhook": { + 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 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"]; + }; + }; + "repos/test-push-webhook": { parameters: { query?: never; header?: never; @@ -110568,44 +118270,19 @@ export interface operations { }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - config?: components["schemas"]["webhook-config"]; - /** - * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. - * @default [ - * "push" - * ] - */ - events?: string[]; - /** @description Determines a list of events to be added to the list of events that the Hook triggers for. */ - add_events?: string[]; - /** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */ - remove_events?: string[]; - /** - * @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. - * @default true - */ - active?: boolean; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 200: { + 204: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["hook"]; - }; + content?: never; }; 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/get-webhook-config-for-repo": { + "repos/check-immutable-releases": { parameters: { query?: never; header?: never; @@ -110614,147 +118291,30 @@ export interface operations { 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 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 */ + /** @description Response if immutable releases are enabled */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["webhook-config"]; + "application/json": components["schemas"]["check-immutable-releases"]; }; }; - }; - }; - "repos/update-webhook-config-for-repo": { - 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 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"]; - }; - }; - }; - }; - "repos/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 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 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"]; - }; - }; - "repos/get-webhook-delivery": { - 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 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: { + /** @description Not Found if immutable releases are not enabled for the repository */ + 404: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["hook-delivery"]; - }; - }; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/redeliver-webhook-delivery": { - 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 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"]; + content?: never; }; - cookie?: never; - }; - requestBody?: never; - responses: { - 202: components["responses"]["accepted"]; - 400: components["responses"]["bad_request"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/ping-webhook": { + "repos/enable-immutable-releases": { parameters: { query?: never; header?: never; @@ -110763,24 +118323,16 @@ export interface operations { 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 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"]; + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; }; }; - "repos/test-push-webhook": { + "repos/disable-immutable-releases": { parameters: { query?: never; header?: never; @@ -110789,21 +118341,13 @@ export interface operations { 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 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"]; + 204: components["responses"]["no_content"]; + 409: components["responses"]["conflict"]; }; }; "migrations/get-import-status": { @@ -111302,6 +118846,8 @@ export interface operations { state?: "open" | "closed" | "all"; /** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */ assignee?: string; + /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */ + type?: string; /** @description The user that created the issue. */ creator?: string; /** @description A user that's mentioned in the issue. */ @@ -111376,6 +118922,11 @@ export interface operations { })[]; /** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._ + * @example Epic + */ + type?: string | null; }; }; }; @@ -111489,41 +119040,103 @@ export interface operations { }; content?: never; }; - }; - }; - "issues/update-comment": { - 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 unique identifier of the comment. */ - comment_id: components["parameters"]["comment-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The contents of the comment. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["issue-comment"]; - }; - }; - 422: components["responses"]["validation_failed"]; + }; + }; + "issues/update-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The contents of the comment. */ + body: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/pin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue-comment"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unpin-comment": { + 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 unique identifier of the comment. */ + comment_id: components["parameters"]["comment-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 503: components["responses"]["service_unavailable"]; }; }; "reactions/list-for-issue-comment": { @@ -111711,7 +119324,11 @@ export interface operations { }; cookie?: never; }; - requestBody?: never; + requestBody?: { + content: { + "application/json": unknown; + }; + }; responses: { /** @description Response */ 200: { @@ -111761,7 +119378,7 @@ export interface operations { * @example not_planned * @enum {string|null} */ - state_reason?: "completed" | "not_planned" | "reopened" | null; + state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null; milestone?: (string | number) | null; /** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */ labels?: (string | { @@ -111772,6 +119389,11 @@ export interface operations { })[]; /** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */ assignees?: string[]; + /** + * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped. + * @example Epic + */ + type?: string | null; }; }; }; @@ -111973,6 +119595,154 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + "issues/list-dependencies-blocked-by": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/add-blocked-by-dependency": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The id of the issue that blocks the current issue */ + issue_id: number; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */ + Location?: string; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/remove-dependency-blocked-by": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + /** @description The id of the blocking issue to remove as a dependency */ + issue_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 400: components["responses"]["bad_request"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/list-dependencies-blocking": { + 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 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issue"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; "issues/list-events": { parameters: { query?: { @@ -112104,15 +119874,11 @@ export interface operations { requestBody?: { content: { "application/json": { - /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ + /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */ labels?: string[]; } | string[] | { - labels?: { - name: string; - }[]; - } | { name: string; - }[] | string; + }[]; }; }; responses: { @@ -112154,12 +119920,113 @@ export interface operations { }; content?: never; }; - 301: components["responses"]["moved_permanently"]; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/remove-label": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + name: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["label"][]; + }; + }; + 301: components["responses"]["moved_permanently"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + }; + }; + "issues/lock": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/json": { + /** + * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: + * * `off-topic` + * * `too heated` + * * `resolved` + * * `spam` + * @enum {string} + */ + lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; + } | null; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 410: components["responses"]["gone"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "issues/unlock": { + 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 number that identifies the issue. */ + issue_number: components["parameters"]["issue-number"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; }; }; - "issues/remove-label": { + "issues/get-parent": { parameters: { query?: never; header?: never; @@ -112170,7 +120037,6 @@ export interface operations { repo: components["parameters"]["repo"]; /** @description The number that identifies the issue. */ issue_number: components["parameters"]["issue-number"]; - name: string; }; cookie?: never; }; @@ -112182,7 +120048,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["label"][]; + "application/json": components["schemas"]["issue"]; }; }; 301: components["responses"]["moved_permanently"]; @@ -112190,76 +120056,6 @@ export interface operations { 410: components["responses"]["gone"]; }; }; - "issues/lock": { - 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 number that identifies the issue. */ - issue_number: components["parameters"]["issue-number"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * * `off-topic` - * * `too heated` - * * `resolved` - * * `spam` - * @enum {string} - */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - } | null; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "issues/unlock": { - 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 number that identifies the issue. */ - issue_number: components["parameters"]["issue-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; "reactions/list-for-issue": { parameters: { query?: { @@ -112461,7 +120257,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */ + /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */ sub_issue_id: number; /** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */ replace_parent?: boolean; @@ -113781,84 +121577,7 @@ export interface operations { 422: components["responses"]["bad_request"]; }; }; - "projects/list-for-repo": { - parameters: { - query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; - /** @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 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"][]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "projects/create-for-repo": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the project. */ - name: string; - /** @description The description of the project. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - 410: components["responses"]["gone"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; - "repos/get-custom-properties-values": { + "repos/custom-properties-for-repos-get-repository-values": { parameters: { query?: never; header?: never; @@ -113885,7 +121604,7 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "repos/create-or-update-custom-properties-values": { + "repos/custom-properties-for-repos-create-or-update-repository-values": { parameters: { query?: never; header?: never; @@ -115954,6 +123673,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -115965,12 +123685,12 @@ export interface operations { /** * @description The time period to filter by. * - * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). */ time_period?: components["parameters"]["time-period"]; /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ actor_name?: components["parameters"]["actor-name-in-query"]; - /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; /** @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"]; @@ -116112,6 +123832,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; }; }; @@ -116142,15 +123863,82 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "repos/get-repo-ruleset-history": { + 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 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 ID of the ruleset. */ + ruleset_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version"][]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + "repos/get-repo-ruleset-version": { + 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 ID of the ruleset. */ + ruleset_id: number; + /** @description The ID of the version */ + version_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["ruleset-version-with-state"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "secret-scanning/list-alerts-for-repo": { parameters: { query?: { /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */ state?: components["parameters"]["secret-scanning-alert-state"]; - /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ + /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"]; /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */ resolution?: components["parameters"]["secret-scanning-alert-resolution"]; + /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */ + assignee?: components["parameters"]["secret-scanning-alert-assignee"]; /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */ sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ @@ -116169,6 +123957,8 @@ export interface operations { 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"]; + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; }; header?: never; path: { @@ -116202,7 +123992,10 @@ export interface operations { }; "secret-scanning/get-alert": { parameters: { - query?: never; + query?: { + /** @description A boolean value representing whether or not to hide literal secrets in the results. */ + hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"]; + }; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -116253,10 +124046,11 @@ export interface operations { requestBody: { content: { "application/json": { - state: components["schemas"]["secret-scanning-alert-state"]; + state?: components["schemas"]["secret-scanning-alert-state"]; resolution?: components["schemas"]["secret-scanning-alert-resolution"]; resolution_comment?: components["schemas"]["secret-scanning-alert-resolution-comment"]; - }; + assignee?: components["schemas"]["secret-scanning-alert-assignee"]; + } | unknown | unknown; }; }; responses: { @@ -116283,7 +124077,7 @@ export interface operations { }; content?: never; }; - /** @description State does not match the resolution or resolution comment */ + /** @description State does not match the resolution or resolution comment, or assignee does not have write access to the repository */ 422: { headers: { [name: string]: unknown; @@ -117025,94 +124819,6 @@ export interface operations { }; }; }; - "repos/list-tag-protection": { - 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"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag-protection"][]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/create-tag-protection": { - 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"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description An optional glob pattern to match against when enforcing tag protection. */ - pattern: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["tag-protection"]; - }; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; - "repos/delete-tag-protection": { - 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 unique identifier of the tag protection. */ - tag_protection_id: components["parameters"]["tag-protection-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 403: components["responses"]["forbidden"]; - 404: components["responses"]["not_found"]; - }; - }; "repos/download-tarball-archive": { parameters: { query?: never; @@ -117653,6 +125359,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 Set to `true` to use advanced search. + * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + */ + advanced_search?: components["parameters"]["issues-advanced-search"]; }; header?: never; path?: never; @@ -117944,447 +125655,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "teams/list-discussions-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"][]; - }; - }; - }; - }; - "teams/create-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title: string; - /** @description The discussion post's body text. */ - body: string; - /** - * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - * @default false - */ - private?: boolean; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/get-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/delete-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** @description The discussion post's title. */ - title?: string; - /** @description The discussion post's body text. */ - body?: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion"]; - }; - }; - }; - }; - "teams/list-discussion-comments-legacy": { - parameters: { - query?: { - /** @description The direction to sort the results by. */ - direction?: components["parameters"]["direction"]; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"][]; - }; - }; - }; - }; - "teams/create-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/get-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "teams/delete-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/update-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The discussion comment's body text. */ - body: string; - }; - }; - }; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-discussion-comment"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-comment-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-comment-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - /** @description The number that identifies the comment. */ - comment_number: components["parameters"]["comment-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; - "reactions/list-for-team-discussion-legacy": { - parameters: { - query?: { - /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ - content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"][]; - }; - }; - }; - }; - "reactions/create-for-team-discussion-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The number that identifies the discussion. */ - discussion_number: components["parameters"]["discussion-number"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion. - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["reaction"]; - }; - }; - }; - }; "teams/list-pending-invitations-legacy": { parameters: { query?: { @@ -118651,140 +125921,6 @@ export interface operations { }; }; }; - "teams/list-projects-legacy": { - 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 unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"][]; - }; - }; - 404: components["responses"]["not_found"]; - }; - }; - "teams/check-permissions-for-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["team-project"]; - }; - }; - /** @description Not Found if project is not managed by this team */ - 404: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "teams/add-or-update-project-permissions-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/json": { - /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - * @enum {string} - */ - permission?: "read" | "write" | "admin"; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - /** @description Forbidden if the project is not owned by the organization */ - 403: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - message?: string; - documentation_url?: string; - }; - }; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "teams/remove-project-legacy": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the team. */ - team_id: components["parameters"]["team-id"]; - /** @description The unique identifier of the project. */ - project_id: components["parameters"]["project-id"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; - }; - }; "teams/list-repos-legacy": { parameters: { query?: { @@ -121212,45 +128348,6 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; - "projects/create-for-authenticated-user": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** - * @description Name of the project - * @example Week One Sprint - */ - name: string; - /** - * @description Body of the project - * @example This project represents the sprint of the first week in January - */ - body?: string | null; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["project"]; - }; - }; - 304: components["responses"]["not_modified"]; - 401: components["responses"]["requires_authentication"]; - 403: components["responses"]["forbidden"]; - 422: components["responses"]["validation_failed_simple"]; - }; - }; "users/list-public-emails-for-authenticated-user": { parameters: { query?: { @@ -121317,6 +128414,7 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { @@ -121999,6 +129097,44 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "projects/create-draft-item-for-authenticated-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the draft item to create in the project. */ + requestBody: { + content: { + "application/json": { + /** @description The title of the draft issue item to create in the project. */ + title: string; + /** @description The body content of the draft issue item to create in the project. */ + body?: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; "users/list": { parameters: { query?: { @@ -122027,6 +129163,76 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "projects/create-view-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the user. */ + user_id: components["parameters"]["user-id"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The name of the view. + * @example Sprint Board + */ + name: string; + /** + * @description The layout of the view. + * @example board + * @enum {string} + */ + layout: "table" | "board" | "roadmap"; + /** + * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. + * @example is:issue is:open + */ + filter?: string; + /** + * @description `visible_fields` is not applicable to `roadmap` layout views. + * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + * @example [ + * 123, + * 456, + * 789 + * ] + */ + visible_fields?: number[]; + }; + }; + }; + responses: { + /** @description Response for creating a view in a user-owned project. */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-view"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + /** @description Service unavailable */ + 503: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; + }; + }; "users/get-by-username": { parameters: { query?: never; @@ -122051,6 +129257,173 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "users/list-attestations-bulk": { + 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 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"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests to fetch attestations for. */ + subject_digests: string[]; + /** + * @description Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Mapping of subject digest to bundles. */ + attestations_subject_digests?: { + [key: string]: { + /** @description The bundle of the attestation. */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; + repository_id?: number; + bundle_url?: string; + }[] | null; + }; + /** @description Information about the current page. */ + page_info?: { + /** @description Indicates whether there is a next page. */ + has_next?: boolean; + /** @description Indicates whether there is a previous page. */ + has_previous?: boolean; + /** @description The cursor to the next page. */ + next?: string; + /** @description The cursor to the previous page. */ + previous?: string; + }; + }; + }; + }; + }; + }; + "users/delete-attestations-bulk": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description List of subject digests associated with the artifact attestations to delete. */ + subject_digests: string[]; + } | { + /** @description List of unique IDs associated with the artifact attestations to delete. */ + attestation_ids: number[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-subject-digest": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Subject Digest */ + subject_digest: string; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + }; + }; + "users/delete-attestations-by-id": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description Attestation ID */ + attestation_id: number; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; "users/list-attestations": { parameters: { query?: { @@ -122060,6 +129433,12 @@ export interface operations { 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 Optional filter for fetching attestations with a given predicate type. + * This option accepts `provenance`, `sbom`, `release`, or freeform text + * for custom predicate types. + */ + predicate_type?: string; }; header?: never; path: { @@ -122080,9 +129459,22 @@ export interface operations { content: { "application/json": { attestations?: { - bundle?: components["schemas"]["sigstore-bundle-0"]; + /** + * @description The attestation's Sigstore Bundle. + * Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. + */ + bundle?: { + mediaType?: string; + verificationMaterial?: { + [key: string]: unknown; + }; + dsseEnvelope?: { + [key: string]: unknown; + }; + }; repository_id?: number; bundle_url?: string; + initiator?: string; }[]; }; }; @@ -122724,12 +130116,14 @@ export interface operations { "projects/list-for-user": { parameters: { query?: { - /** @description Indicates the state of the projects to return. */ - state?: "open" | "closed" | "all"; + /** @description Limit results to projects of the specified type. */ + q?: string; + /** @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 number of results per page (max 100). For 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: { @@ -122747,22 +130141,57 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["project"][]; + "application/json": components["schemas"]["projects-v2"][]; }; }; - 422: components["responses"]["validation_failed"]; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-events-for-user": { + "projects/get-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-fields-for-user": { 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 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"]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -122773,24 +130202,131 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-field"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "activity/list-received-public-events-for-user": { + "projects/add-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "text" | "number" | "date"; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "single_select"; + /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */ + single_select_options: components["schemas"]["projects-v2-field-single-select-option"][]; + } | { + /** @description The name of the field. */ + name: string; + /** + * @description The field's data type. + * @enum {string} + */ + data_type: "iteration"; + iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"]; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/get-field-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The unique identifier of the field. */ + field_id: components["parameters"]["field-id"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-field"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/list-items-for-user": { parameters: { query?: { + /** @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 number of results per page (max 100). For 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 Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */ + q?: string; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; }; header?: never; path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; }; @@ -122801,32 +130337,204 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["event"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; }; }; - "repos/list-for-user": { + "projects/add-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + }; + cookie?: never; + }; + /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */ + requestBody: { + content: { + "application/json": { + /** + * @description The type of item to add to the project. Must be either Issue or PullRequest. + * @enum {string} + */ + type: "Issue" | "PullRequest"; + /** @description The unique identifier of the issue or pull request to add to the project. */ + id?: number; + /** @description The repository owner login. */ + owner?: string; + /** @description The repository name. */ + repo?: string; + /** @description The issue or pull request number. */ + number?: number; + } & (unknown | unknown); + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-simple"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/get-user-item": { parameters: { query?: { - /** @description Limit results to repositories of the specified type. */ - type?: "all" | "owner" | "member"; - /** @description The property to sort the results by. */ - sort?: "created" | "updated" | "pushed" | "full_name"; - /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ - direction?: "asc" | "desc"; + /** + * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + * + * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + */ + fields?: string | string[]; + }; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/delete-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + }; + }; + "projects/update-item-for-user": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The project's number. */ + project_number: components["parameters"]["project-number"]; + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + /** @description The unique identifier of the project item. */ + item_id: components["parameters"]["item-id"]; + }; + cookie?: never; + }; + /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */ + requestBody: { + content: { + "application/json": { + /** @description A list of field updates to apply. */ + fields: { + /** @description The ID of the project field to update. */ + id: number; + /** + * @description The new value for the field: + * - For text, number, and date fields, provide the new value directly. + * - For single select and iteration fields, provide the ID of the option or iteration. + * - To clear the field, set this to null. + */ + value: (string | number) | null; + }[]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["projects-v2-item-with-content"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "projects/list-view-items-for-user": { + parameters: { + query?: { + /** + * @description Limit results to specific fields, by their IDs. If not specified, the + * title field will be returned. + * + * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + */ + fields?: string | string[]; + /** @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 number of results per page (max 100). For 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 project's number. */ + project_number: components["parameters"]["project-number"]; /** @description The handle for the GitHub user account. */ username: components["parameters"]["username"]; + /** @description The number that identifies the project view. */ + view_number: components["parameters"]["view-number"]; }; cookie?: never; }; @@ -122839,14 +130547,23 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["minimal-repository"][]; + "application/json": components["schemas"]["projects-v2-item-with-content"][]; }; }; + 304: components["responses"]["not_modified"]; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; }; }; - "billing/get-github-actions-billing-user": { + "activity/list-received-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -122862,14 +130579,19 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["actions-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-github-packages-billing-user": { + "activity/list-received-public-events-for-user": { parameters: { - query?: never; + 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 handle for the GitHub user account. */ @@ -122885,14 +130607,25 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["packages-billing-usage"]; + "application/json": components["schemas"]["event"][]; }; }; }; }; - "billing/get-shared-storage-billing-user": { + "repos/list-for-user": { parameters: { - query?: never; + query?: { + /** @description Limit results to repositories of the specified type. */ + type?: "all" | "owner" | "member"; + /** @description The property to sort the results by. */ + sort?: "created" | "updated" | "pushed" | "full_name"; + /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ + direction?: "asc" | "desc"; + /** @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 handle for the GitHub user account. */ @@ -122905,14 +130638,105 @@ export interface operations { /** @description Response */ 200: { headers: { + Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["combined-billing-usage"]; + "application/json": components["schemas"]["minimal-repository"][]; }; }; }; }; + "billing/get-github-billing-premium-request-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The model name to query usage for. The name is not case sensitive. */ + model?: components["parameters"]["billing-usage-report-model"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_premium_request_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; + "billing/get-github-billing-usage-summary-report-user": { + parameters: { + query?: { + /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */ + year?: components["parameters"]["billing-usage-report-year"]; + /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */ + month?: components["parameters"]["billing-usage-report-month-default"]; + /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */ + day?: components["parameters"]["billing-usage-report-day"]; + /** @description The repository name to query for usage in the format owner/repository. */ + repository?: components["parameters"]["billing-usage-report-repository"]; + /** @description The product name to query usage for. The name is not case sensitive. */ + product?: components["parameters"]["billing-usage-report-product"]; + /** @description The SKU to query for usage. */ + sku?: components["parameters"]["billing-usage-report-sku"]; + }; + header?: never; + path: { + /** @description The handle for the GitHub user account. */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["billing_usage_summary_report_user"]; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + 503: components["responses"]["service_unavailable"]; + }; + }; "users/list-social-accounts-for-user": { parameters: { query?: { @@ -123069,7 +130893,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": string; + "text/plain": string; }; }; }; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index fce72e63f..e9c62df54 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -44,7 +44,7 @@ tags: - name: licenses description: View various OSS licenses. - name: markdown - description: Render GitHub flavored markdown + description: Render GitHub flavored Markdown - name: merge-queue description: Interact with GitHub Merge Queues. - name: meta @@ -54,21 +54,19 @@ tags: - name: oidc description: Endpoints to manage GitHub OIDC configuration using the REST API. - name: orgs - description: Interact with GitHub Orgs. + description: Interact with organizations. - name: packages description: Manage packages for authenticated users and organizations. -- name: projects - description: Interact with GitHub Projects. - name: pulls description: Interact with GitHub Pull Requests. - name: rate-limit - description: Check your current rate limit status + description: Check your current rate limit status. - name: reactions description: Interact with reactions to various GitHub entities. - name: repos description: Interact with GitHub Repos. - name: search - description: Look for stuff on GitHub. + description: Search for specific items on GitHub. - name: secret-scanning description: Retrieve secret scanning alerts from a repository. - name: teams @@ -89,12 +87,22 @@ tags: description: Desktop specific endpoints. - name: enterprise-teams description: Endpoints to manage GitHub Enterprise Teams. +- name: enterprise-team-memberships + description: Endpoints to manage GitHub Enterprise Team memberships. +- name: enterprise-team-organizations + description: Endpoints to manage GitHub Enterprise Team organization assignments. - name: code-security description: Endpoints to manage Code security using the REST API. - name: private-registries description: Manage private registry configurations. - name: hosted-compute description: Manage hosted compute networking resources. +- name: credentials + description: Revoke compromised or leaked GitHub credentials. +- name: campaigns + description: Endpoints to manage campaigns via the REST API. +- name: projects + description: Endpoints to manage Projects using the REST API. servers: - url: https://api.github.com externalDocs: @@ -203,7 +211,7 @@ paths: If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified. If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages. - Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` + Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0` schema: oneOf: - type: string @@ -701,7 +709,7 @@ paths: delete: summary: Delete an installation for the authenticated app description: |- - Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. + Uninstalls a GitHub App on a user, organization, or enterprise account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint. You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: @@ -800,7 +808,7 @@ paths: put: summary: Suspend an app installation description: |- - Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. + Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account. You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. tags: @@ -1399,6 +1407,64 @@ paths: enabledForGitHubApps: true category: codes-of-conduct subcategory: codes-of-conduct + "/credentials/revoke": + post: + summary: Revoke a list of credentials + description: |- + Submit a list of credentials to be revoked. This endpoint is intended to revoke credentials the caller does not own and may have found exposed on GitHub.com or elsewhere. It can also be used for credentials associated with an old user account that you no longer have access to. Credential owners will be notified of the revocation. + + This endpoint currently accepts the following credential types: + - Personal access tokens (classic) + - Fine-grained personal access tokens + + Revoked credentials may impact users on GitHub Free, Pro, & Team and GitHub Enterprise Cloud, and GitHub Enterprise Cloud with Enterprise Managed Users. + GitHub cannot reactivate any credentials that have been revoked; new credentials will need to be generated. + + To prevent abuse, this API is limited to only 60 unauthenticated requests per hour and a max of 1000 tokens per API request. + + > [!NOTE] + > Any authenticated requests will return a 403. + tags: + - credentials + operationId: credentials/revoke + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/credentials/revoke#revoke-a-list-of-credentials + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + credentials: + type: array + description: A list of credentials to be revoked, up to 1000 per + request. + items: + type: string + minItems: 1 + maxItems: 1000 + required: + - credentials + examples: + default: + value: + credentials: + - ghp_1234567890abcdef1234567890abcdef12345678 + - ghp_abcdef1234567890abcdef1234567890abcdef12 + responses: + '202': + "$ref": "#/components/responses/accepted" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: credentials + subcategory: revoke "/emojis": get: summary: Get emojis @@ -1429,6 +1495,152 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an enterprise + description: |- + Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an enterprise + description: |- + Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an enterprise + description: |- + Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an enterprise + description: |- + Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this + enterprise may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/enterprises/{enterprise}/code-security/configurations": get: summary: Get code security configurations for an enterprise @@ -1511,11 +1723,24 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled + - code_security + - secret_protection default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -1557,6 +1782,8 @@ paths: - disabled - not_set default: disabled + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -1567,6 +1794,22 @@ paths: default: disabled code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -1600,6 +1843,31 @@ paths: - disabled - not_set default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -1755,11 +2023,23 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security. - Must be set to enabled if you want to enable any GHAS settings. + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. enum: - enabled - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -1805,6 +2085,24 @@ paths: - not_set code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -1834,6 +2132,31 @@ paths: - enabled - disabled - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set + default: disabled private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -1943,8 +2266,7 @@ paths: scope: type: string 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` + to. enum: - all - all_without_configurations @@ -2132,13 +2454,13 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -2166,36 +2488,20 @@ paths: previews: [] category: dependabot subcategory: alerts - "/enterprises/{enterprise}/secret-scanning/alerts": + "/enterprises/{enterprise}/teams": get: - summary: List secret scanning alerts for an enterprise - description: |- - Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - - Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). - - The authenticated user must be a member of the enterprise in order to use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. + summary: List enterprise teams + description: List all teams in the enterprise for the authenticated user tags: - - secret-scanning - operationId: secret-scanning/list-alerts-for-enterprise + - enterprise-teams + operationId: enterprise-teams/list externalDocs: description: API method documentation - url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#list-enterprise-teams parameters: - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/secret-scanning-alert-state" - - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - - "$ref": "#/components/parameters/secret-scanning-alert-resolution" - - "$ref": "#/components/parameters/secret-scanning-alert-sort" - - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/per-page" - - "$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" + - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -2204,22 +2510,659 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/organization-secret-scanning-alert" + "$ref": "#/components/schemas/enterprise-team" examples: default: - "$ref": "#/components/examples/organization-secret-scanning-alert-list" + "$ref": "#/components/examples/enterprise-teams-items" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + post: + summary: Create an enterprise team + description: To create an enterprise team, the authenticated user must be an + owner of the enterprise. + tags: + - enterprise-teams + operationId: enterprise-teams/create + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#create-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the team. + description: + nullable: true + type: string + description: A description of the team. + sync_to_organizations: + type: string + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be set. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint. + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + nullable: true + type: string + description: The ID of the IdP group to assign team membership with. + You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). + required: + - name + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-team" + examples: + default: + "$ref": "#/components/examples/enterprise-teams-item" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships": + get: + summary: List members in an enterprise team + description: Lists all team members in an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/list + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#list-members-in-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" headers: Link: "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/add": + post: + summary: Bulk add team members + description: Add multiple team members to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-add-team-members + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to add to the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully added team members. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/remove": + post: + summary: Bulk remove team members + description: Remove multiple team members from an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#bulk-remove-team-members + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - usernames + properties: + usernames: + type: array + description: The GitHub user handles to be removed from the team. + items: + type: string + description: The handle for the GitHub user account. + examples: + default: + value: + usernames: + - monalisa + - octocat + responses: + '200': + description: Successfully removed team members. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/memberships/{username}": + get: + summary: Get enterprise team membership + description: Returns whether the user is a member of the enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#get-enterprise-team-membership + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: User is a member of the enterprise team. + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + exampleKey1: + "$ref": "#/components/examples/simple-user" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + put: + summary: Add team member + description: Add a team member to an enterprise team. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#add-team-member + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Successfully added team member + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + exampleKey1: + "$ref": "#/components/examples/simple-user" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + delete: + summary: Remove team membership + description: Remove membership of a specific user from a particular team in + an enterprise. + tags: + - enterprise-team-memberships + operationId: enterprise-team-memberships/remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-members#remove-team-membership + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-members + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations": + get: + summary: Get organization assignments + description: Get all organizations assigned to an enterprise team + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignments + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: An array of organizations the team is assigned to + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/add": + post: + summary: Add organization assignments + description: Assign an enterprise team to multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to assign the team to. + items: + type: string + description: Organization slug to assign the team to + examples: + default: + value: + organization_slugs: + - github + responses: + '200': + description: Successfully assigned the enterprise team to organizations. + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/remove": + post: + summary: Remove organization assignments + description: Unassign an enterprise team from multiple organizations. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/bulk-remove + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#remove-organization-assignments + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - organization_slugs + properties: + organization_slugs: + type: array + description: Organization slug to unassign the team from. + items: + type: string + description: Organization slug to unassign the team from + examples: + default: + value: + organization_slugs: + - github + responses: + '204': + description: Successfully unassigned the enterprise team from organizations. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{enterprise-team}/organizations/{org}": + get: + summary: Get organization assignment + description: Check if an enterprise team is assigned to an organization + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/get-assignment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#get-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: The team is assigned to the organization + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" '404': - "$ref": "#/components/responses/not_found" - '503': - "$ref": "#/components/responses/service_unavailable" + description: The team is not assigned to the organization x-github: githubCloudOnly: false enabledForGitHubApps: false - category: secret-scanning - subcategory: secret-scanning + category: enterprise-teams + subcategory: enterprise-team-organizations + put: + summary: Add an organization assignment + description: Assign an enterprise team to an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/add + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '201': + description: Successfully assigned the enterprise team to the organization. + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + delete: + summary: Delete an organization assignment + description: Unassign an enterprise team from an organization. + tags: + - enterprise-team-organizations + operationId: enterprise-team-organizations/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#delete-an-organization-assignment + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-team" + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Successfully unassigned the enterprise team from the organization. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-team-organizations + "/enterprises/{enterprise}/teams/{team_slug}": + get: + summary: Get an enterprise team + description: Gets a team using the team's slug. To create the slug, GitHub replaces + special characters in the name string, changes all words to lowercase, and + replaces spaces with a `-` separator and adds the "ent:" prefix. For example, + "My TEam Näme" would become `ent:my-team-name`. + tags: + - enterprise-teams + operationId: enterprise-teams/get + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#get-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/team-slug" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-team" + examples: + default: + "$ref": "#/components/examples/enterprise-teams-item" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + patch: + summary: Update an enterprise team + description: To edit a team, the authenticated user must be an enterprise owner. + tags: + - enterprise-teams + operationId: enterprise-teams/update + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#update-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + nullable: true + type: string + description: A new name for the team. + description: + nullable: true + type: string + description: A new description for the team. + sync_to_organizations: + type: string + description: | + Retired: this field is no longer supported. + Whether the enterprise team should be reflected in each organization. + This value cannot be changed. + enum: + - all + - disabled + default: disabled + organization_selection_type: + type: string + description: | + Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`. + `disabled`: The team is not assigned to any organizations. This is the default when you create a new team. + `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments). + `all`: The team is assigned to all current and future organizations in the enterprise. + enum: + - disabled + - selected + - all + default: disabled + group_id: + nullable: true + type: string + description: The ID of the IdP group to assign team membership with. + The new IdP group will replace the existing one, or replace existing + direct members if the team isn't currently linked to an IdP group. + examples: + default: + value: + name: Justice League + description: A great team. + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-team" + examples: + default: + "$ref": "#/components/examples/enterprise-teams-item" + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams + delete: + summary: Delete an enterprise team + description: |- + To delete an enterprise team, the authenticated user must be an enterprise owner. + + If you are an enterprise owner, deleting an enterprise team will delete all of its IdP mappings as well. + tags: + - enterprise-teams + operationId: enterprise-teams/delete + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/enterprise-teams/enterprise-teams#delete-an-enterprise-team + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-teams + subcategory: enterprise-teams "/events": get: summary: List public events @@ -2233,7 +3176,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events parameters: - - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/public-events-per-page" - "$ref": "#/components/parameters/page" responses: '200': @@ -3254,7 +4197,8 @@ paths: repositories: type: array items: - "$ref": "#/components/schemas/repository" + allOf: + - "$ref": "#/components/schemas/repository" repository_selection: type: string example: selected @@ -3491,7 +4435,8 @@ paths: "/markdown": post: summary: Render a Markdown document - description: '' + description: Depending on what is rendered in the Markdown, you may need to + provide additional token scopes for labels, such as `issues:read` or `pull_requests:read`. operationId: markdown/render tags: - markdown @@ -4326,6 +5271,646 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/organizations/{org}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for an organization + description: |- + Gets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for an organization + description: |- + Sets GitHub Actions cache retention limit for an organization. All repositories under this + organization may not set a higher cache retention limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for an organization + description: |- + Gets GitHub Actions cache storage limit for an organization. All repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for an organization + description: |- + Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this + organization may not set a higher cache storage limit. + + OAuth tokens and personal access tokens (classic) need the `admin:organization` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-organization" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/organizations/{org}/dependabot/repository-access": + get: + summary: Lists the repositories Dependabot can access in an organization + description: |- + Lists repositories that organization admins have allowed Dependabot to access when updating dependencies. + > [!NOTE] + > This operation supports both server-to-server and user-to-server access. + Unauthorized users will not see the existence of this endpoint. + tags: + - dependabot + operationId: dependabot/repository-access-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#lists-the-repositories-dependabot-can-access-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: page + in: query + description: The page number of results to fetch. + required: false + schema: + type: integer + minimum: 1 + default: 1 + - name: per_page + in: query + description: Number of results per page. + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/dependabot-repository-access-details" + examples: + default: + "$ref": "#/components/examples/dependabot-repository-access-details" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + patch: + summary: Updates Dependabot's repository access list for an organization + description: |- + Updates repositories according to the list of repositories that organization admins have given Dependabot access to when they've updated dependencies. + + > [!NOTE] + > This operation supports both server-to-server and user-to-server access. + Unauthorized users will not see the existence of this endpoint. + + **Example request body:** + ```json + { + "repository_ids_to_add": [123, 456], + "repository_ids_to_remove": [789] + } + ``` + tags: + - dependabot + operationId: dependabot/update-repository-access-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#updates-dependabots-repository-access-list-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + repository_ids_to_add: + type: array + items: + type: integer + description: List of repository IDs to add. + repository_ids_to_remove: + type: array + items: + type: integer + description: List of repository IDs to remove. + example: + repository_ids_to_add: + - 123 + - 456 + repository_ids_to_remove: + - 789 + examples: + '204': + summary: Example with a 'succeeded' status. + add-example: + summary: Add repositories + value: + repository_ids_to_add: + - 123 + - 456 + remove-example: + summary: Remove repositories + value: + repository_ids_to_remove: + - 789 + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + "/organizations/{org}/dependabot/repository-access/default-level": + put: + summary: Set the default repository access level for Dependabot + description: |- + Sets the default level of repository access Dependabot will have while performing an update. Available values are: + - 'public' - Dependabot will only have access to public repositories, unless access is explicitly granted to non-public repositories. + - 'internal' - Dependabot will only have access to public and internal repositories, unless access is explicitly granted to private repositories. + + Unauthorized users will not see the existence of this endpoint. + + This operation supports both server-to-server and user-to-server access. + tags: + - dependabot + operationId: dependabot/set-repository-access-default-level + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/dependabot/repository-access#set-the-default-repository-access-level-for-dependabot + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot + updates. + enum: + - public + - internal + example: internal + required: + - default_level + examples: + '204': + summary: Example with a 'succeeded' status. + value: + default_level: public + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: repository-access + "/organizations/{org}/settings/billing/budgets": + get: + summary: Get all budgets for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets all budgets for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-all-budgets-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#get-all-budgets-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + "$ref": "#/components/responses/get_all_budgets" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + "/organizations/{org}/settings/billing/budgets/{budget_id}": + get: + summary: Get a budget by ID for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a budget by ID. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/get-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#get-a-budget-by-id-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + patch: + summary: Update a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Updates an existing budget for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/update-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#update-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered in the + budget + examples: + update-budget: + summary: Update budget example + value: + prevent_further_usage: false + budget_amount: 10 + budget_alerting: + will_alert: false + alert_recipients: [] + responses: + '200': + description: Budget updated successfully + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: Budget successfully updated. + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_amount: + type: number + format: float + description: The budget amount in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the + budget is exceeded + budget_alerting: + type: object + required: + - will_alert + - alert_recipients + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive + alerts + budget_scope: + type: string + description: The scope of the budget + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + default: '' + budget_type: + type: string + description: The type of pricing for the budget + enum: + - ProductPricing + - SkuPricing + budget_product_sku: + type: string + description: A single product or SKU that will be covered + in the budget + examples: + update-budget: + "$ref": "#/components/examples/update-budget" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + description: Budget not found or feature not enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + budget-not-found: + value: + message: Budget with ID 550e8400-e29b-41d4-a716-446655440000 not + found. + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + feature-not-enabled: + value: + message: Not Found + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + '422': + "$ref": "#/components/responses/validation_failed" + '500': + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + server-error: + value: + message: Unable to update budget. + documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: billing + subcategory: budgets + delete: + summary: Delete a budget for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Deletes a budget by ID for an organization. The authenticated user must be an organization admin or billing manager. + tags: + - billing + operationId: billing/delete-budget-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/budgets#delete-a-budget-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/budget" + responses: + '200': + "$ref": "#/components/responses/delete-budget" + '400': + "$ref": "#/components/responses/bad_request" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: budgets + "/organizations/{org}/settings/billing/premium_request/usage": + get: + summary: Get billing premium request usage report for an organization + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-premium-request-usage-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-user" + - "$ref": "#/components/parameters/billing-usage-report-model" + - "$ref": "#/components/parameters/billing-usage-report-product" + responses: + '200': + "$ref": "#/components/responses/billing_premium_request_usage_report_org" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage "/organizations/{org}/settings/billing/usage": get: summary: Get billing usage report for an organization @@ -4338,13 +5923,12 @@ paths: operationId: billing/get-github-billing-usage-report-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization + url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/billing-usage-report-year" - "$ref": "#/components/parameters/billing-usage-report-month" - "$ref": "#/components/parameters/billing-usage-report-day" - - "$ref": "#/components/parameters/billing-usage-report-hour" responses: '200': "$ref": "#/components/responses/billing_usage_report_org" @@ -4360,14 +5944,54 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: billing - subcategory: enhanced-billing + subcategory: usage + "/organizations/{org}/settings/billing/usage/summary": + get: + summary: Get billing usage summary for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. + tags: + - billing + operationId: billing/get-github-billing-usage-summary-report-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-repository" + - "$ref": "#/components/parameters/billing-usage-report-product" + - "$ref": "#/components/parameters/billing-usage-report-sku" + responses: + '200': + "$ref": "#/components/responses/billing_usage_summary_report_org" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: usage "/orgs/{org}": get: summary: Get an organization description: |- Gets information about an organization. - When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). To see the full details about an organization, the authenticated user must be an organization owner. @@ -4874,6 +6498,11 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + image_gen: + description: Whether this runner should be used to generate custom + images. + type: boolean + default: false required: - name - image @@ -4886,7 +6515,6 @@ paths: image: id: ubuntu-latest source: github - version: latest runner_group_id: 1 size: 4-core maximum_runners: 50 @@ -4906,6 +6534,197 @@ paths: githubCloudOnly: false category: actions subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom": + get: + summary: List custom images for an organization + description: |- + List custom images for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-images-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-custom-images-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - images + properties: + total_count: + type: integer + images: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}": + get: + summary: Get a custom image definition for GitHub Actions Hosted Runners + description: |- + Get a custom image definition for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-a-custom-image-definition-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete a custom image from the organization + description: |- + Delete a custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-a-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions": + get: + summary: List image versions of a custom image for an organization + description: |- + List image versions of a custom image for an organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/list-custom-image-versions-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#list-image-versions-of-a-custom-image-for-an-organization + parameters: + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - image_versions + properties: + total_count: + type: integer + image_versions: + type: array + items: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-versions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + "/orgs/{org}/actions/hosted-runners/images/custom/{image_definition_id}/versions/{version}": + get: + summary: Get an image version of a custom image for GitHub Actions Hosted Runners + description: |- + Get an image version of a custom image for GitHub Actions Hosted Runners. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/get-custom-image-version-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#get-an-image-version-of-a-custom-image-for-github-actions-hosted-runners + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-hosted-runner-custom-image-version" + examples: + default: + "$ref": "#/components/examples/actions-hosted-runner-custom-image-version" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners + delete: + summary: Delete an image version of custom image from the organization + description: |- + Delete an image version of custom image from the organization. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:org` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-custom-image-version-from-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/hosted-runners#delete-an-image-version-of-custom-image-from-the-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/actions-custom-image-definition-id" + - "$ref": "#/components/parameters/actions-custom-image-version" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: hosted-runners "/orgs/{org}/actions/hosted-runners/images/github-owned": get: summary: Get GitHub-owned images for GitHub-hosted runners in an organization @@ -4935,10 +6754,10 @@ paths: images: type: array items: - "$ref": "#/components/schemas/actions-hosted-runner-image" + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: - "$ref": "#/components/examples/actions-hosted-runner-image" + "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -4973,10 +6792,10 @@ paths: images: type: array items: - "$ref": "#/components/schemas/actions-hosted-runner-image" + "$ref": "#/components/schemas/actions-hosted-runner-curated-image" examples: default: - "$ref": "#/components/examples/actions-hosted-runner-image" + "$ref": "#/components/examples/actions-hosted-runner-curated-image" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -5162,6 +6981,15 @@ paths: public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` type: boolean + size: + description: The machine size of the runner. To list available sizes, + use `GET actions/hosted-runners/machine-sizes` + type: string + image_id: + description: The unique identifier of the runner image. To list + all available images, use `GET /actions/hosted-runners/images/github-owned` + or `GET /actions/hosted-runners/images/partner`. + type: string image_version: description: The version of the runner image to deploy. This is relevant only for runners using custom images. @@ -5174,7 +7002,6 @@ paths: runner_group_id: 1 maximum_runners: 50 enable_static_ip: false - image_version: 1.0.0 responses: '200': description: Response @@ -5346,6 +7173,8 @@ paths: "$ref": "#/components/schemas/enabled-repositories" allowed_actions: "$ref": "#/components/schemas/allowed-actions" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_repositories examples: @@ -5353,11 +7182,224 @@ paths: value: enabled_repositories: all allowed_actions: selected + sha_pinning_required: true x-github: enabledForGitHubApps: true githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/artifact-and-log-retention": + get: + summary: Get artifact and log retention settings for an organization + description: |- + Gets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" + examples: + response: + summary: Example response + value: + days: 90 + maximum_allowed_days: 365 + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set artifact and log retention settings for an organization + description: |- + Sets artifact and log retention settings for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-artifact-and-log-retention-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-artifact-and-log-retention" + examples: + application/json: + value: + days: 100 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-contributor-approval": + get: + summary: Get fork PR contributor approval permissions for an organization + description: |- + Gets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set fork PR contributor approval permissions for an organization + description: |- + Sets the fork PR contributor approval policy for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" + examples: + default: + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/fork-pr-workflows-private-repos": + get: + summary: Get private repo fork PR workflow settings for an organization + description: Gets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/get-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for an organization + description: Sets the settings for whether workflows from fork pull requests + can run on private repositories in an organization. + operationId: actions/set-private-repo-fork-pr-workflows-settings-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + responses: + '204': + description: Empty response for successful settings update + '403': + description: Forbidden - Fork PR workflow settings for private repositories + are managed by the enterprise owner + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/repositories": get: summary: List selected repositories enabled for GitHub Actions in an organization @@ -5552,6 +7594,246 @@ paths: githubCloudOnly: false category: actions subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners": + get: + summary: Get self-hosted runners settings for an organization + description: |- + Gets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/get-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/self-hosted-runners-settings" + examples: + response: + summary: Example response + value: + enabled_repositories: selected + selected_repositories_url: http://api.github.localhost/organizations/1/actions/permissions/self-hosted-runners/repositories + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set self-hosted runners settings for an organization + description: |- + Sets the settings for self-hosted runners for an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-self-hosted-runners-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-self-hosted-runners-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners + can be used in the organization + enum: + - all + - selected + - none + examples: + application/json: + value: + enabled_repositories: all + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories": + get: + summary: List repositories allowed to use self-hosted runners in an organization + description: |- + Lists repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/list-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#list-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/repository" + examples: + default: + "$ref": "#/components/examples/repository-paginated" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set repositories allowed to use self-hosted runners in an organization + description: |- + Sets repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/set-selected-repositories-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - selected_repository_ids + properties: + selected_repository_ids: + type: array + items: + type: integer + description: IDs of repositories that can use repository-level self-hosted + runners + examples: + application/json: + value: + selected_repository_ids: + - 1 + - 2 + - 3 + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/orgs/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}": + put: + summary: Add a repository to the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Adds a repository to the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/enable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions + delete: + summary: Remove a repository from the list of repositories allowed to use self-hosted + runners in an organization + description: |- + Removes a repository from the list of repositories that are allowed to use self-hosted runners in an organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope or the "Actions policies" fine-grained permission to use this endpoint. + operationId: actions/disable-selected-repository-self-hosted-runners-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: No content + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + enabledForGitHubApps: true + category: actions + subcategory: permissions "/orgs/{org}/actions/permissions/workflow": get: summary: Get default workflow permissions for an organization @@ -6359,6 +8641,8 @@ paths: "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6493,6 +8777,8 @@ paths: responses: '204': description: Response + '422': + "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -6864,6 +9150,8 @@ paths: items: type: integer required: + - encrypted_value + - key_id - visibility examples: default: @@ -7493,6 +9781,876 @@ paths: enabledForGitHubApps: true category: actions subcategory: variables + "/orgs/{org}/artifacts/metadata/deployment-record": + post: + summary: Create an artifact deployment record + description: |- + Create or update deployment records for an artifact associated + with an organization. + This endpoint allows you to record information about a specific + artifact, such as its name, digest, environments, cluster, and + deployment. + The deployment name has to be uniqe within a cluster (i.e a + combination of logical, physical environment and cluster) as it + identifies unique deployment. + Multiple requests for the same combination of logical, physical + environment, cluster and deployment name will only create one + record, successive request will update the existing record. + This allows for a stable tracking of a deployment where the actual + deployed artifact can change over time. + tags: + - orgs + operationId: orgs/create-artifact-deployment-record + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#create-an-artifact-deployment-record + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + minLength: 1 + maxLength: 256 + example: libfoo + digest: + type: string + description: The hex encoded digest of the artifact. + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + status: + type: string + description: The status of the artifact. Can be either deployed + or decommissioned. + enum: + - deployed + - decommissioned + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + cluster: + type: string + description: The deployment cluster. + maxLength: 128 + deployment_name: + type: string + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a cluster, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + maxLength: 256 + tags: + type: object + description: The tags associated with the deployment. + additionalProperties: + type: string + maxProperties: 5 + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: "^[A-Za-z0-9.\\-_]+$" + example: my-github-repo + required: + - name + - digest + - status + - logical_environment + - deployment_name + examples: + default: + value: + name: awesome-image + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + status: deployed + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: deployment-pod + tags: + data-access: sensitive + responses: + '200': + description: Artifact deployment record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + "$ref": "#/components/schemas/artifact-deployment-record" + examples: + default: + "$ref": "#/components/examples/artifact-deployment-record-list" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/metadata/deployment-record/cluster/{cluster}": + post: + summary: Set cluster deployment records + description: |- + Set deployment records for a given cluster. + If proposed records in the 'deployments' field have identical 'cluster', 'logical_environment', + 'physical_environment', and 'deployment_name' values as existing records, the existing records will be updated. + If no existing records match, new records will be created. + tags: + - orgs + operationId: orgs/set-cluster-deployment-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#set-cluster-deployment-records + parameters: + - "$ref": "#/components/parameters/org" + - name: cluster + in: path + description: The cluster name. + required: true + schema: + type: string + minLength: 1 + maxLength: 128 + pattern: "^[a-zA-Z0-9._-]+$" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + logical_environment: + type: string + description: The stage of the deployment. + minLength: 1 + maxLength: 128 + physical_environment: + type: string + description: The physical region of the deployment. + maxLength: 128 + deployments: + type: array + description: The list of deployments to record. + maxItems: 100 + items: + type: object + properties: + name: + type: string + description: | + The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + the name parameter must also be identical across all entries. + minLength: 1 + maxLength: 256 + digest: + type: string + description: | + The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values, + the name and version parameters must also be identical across all entries. + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + version: + type: string + description: | + The artifact version. Note that if multiple deployments have identical 'digest' parameter values, + the version parameter must also be identical across all entries. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + status: + type: string + description: The deployment status of the artifact. + enum: + - deployed + - decommissioned + deployment_name: + type: string + description: | + The unique identifier for the deployment represented by the new record. To accommodate differing + containers and namespaces within a record set, the following format is recommended: + {namespaceName}-{deploymentName}-{containerName}. + The deployment_name must be unique across all entries in the deployments array. + minLength: 1 + maxLength: 256 + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: "^[A-Za-z0-9.\\-_]+$" + example: my-github-repo + tags: + type: object + description: Key-value pairs to tag the deployment record. + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + required: + - name + - deployment_name + - digest + required: + - logical_environment + - deployments + examples: + default: + value: + logical_environment: prod + physical_environment: pacific-east + deployments: + - name: awesome-image + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + version: 2.1.0 + status: deployed + deployment_name: deployment-pod + tags: + runtime-risk: sensitive-data + responses: + '200': + description: 'Deployment records created or updated successfully. + + ' + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records created + type: integer + deployment_records: + type: array + items: + "$ref": "#/components/schemas/artifact-deployment-record" + examples: + default: + "$ref": "#/components/examples/artifact-deployment-record-list" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/metadata/storage-record": + post: + summary: Create artifact metadata storage record + description: |- + Create metadata storage records for artifacts associated with an organization. + This endpoint will create a new artifact storage record on behalf of any artifact matching the provided digest and + associated with a repository owned by the organization. + tags: + - orgs + operationId: orgs/create-artifact-storage-record + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#create-artifact-metadata-storage-record + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the artifact. + example: libfoo + minLength: 1 + maxLength: 256 + digest: + type: string + description: The digest of the artifact (algorithm:hex-encoded-digest). + example: sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0... + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + version: + type: string + description: The artifact version. + minLength: 1 + maxLength: 100 + x-multi-segment: true + example: 1.2.3 + artifact_url: + type: string + format: uri + pattern: "^https://" + description: The URL where the artifact is stored. + example: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + path: + type: string + format: uri + description: The path of the artifact. + example: com/github/bar/libfoo-1.2.3 + registry_url: + type: string + format: uri + pattern: "^https://" + description: The base URL of the artifact registry. + example: https://reg.example.com/artifactory/ + minLength: 1 + repository: + type: string + description: The repository name within the registry. + example: bar + status: + type: string + description: The status of the artifact (e.g., active, inactive). + example: active + enum: + - active + - eol + - deleted + default: active + github_repository: + type: string + description: |- + The name of the GitHub repository associated with the artifact. This should be used + when there are no provenance attestations available for the artifact. The repository + must belong to the organization specified in the path parameter. + + If a provenance attestation is available for the artifact, the API will use + the repository information from the attestation instead of this parameter. + minLength: 1 + maxLength: 100 + pattern: "^[A-Za-z0-9.\\-_]+$" + example: my-github-repo + required: + - name + - digest + - registry_url + examples: + default: + value: + name: libfoo + version: 1.2.3 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + responses: + '200': + description: Artifact metadata storage record stored successfully. + content: + application/json: + schema: + type: object + properties: + total_count: + type: integer + example: 1 + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + nullable: true + registry_url: + type: string + repository: + type: string + nullable: true + status: + type: string + created_at: + type: string + updated_at: + type: string + examples: + default: + value: + total_count: 1 + storage_records: + - name: libfoo + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/{subject_digest}/metadata/deployment-records": + get: + summary: List artifact deployment records + description: List deployment records for an artifact metadata associated with + an organization. + tags: + - orgs + operationId: orgs/list-artifact-deployment-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-deployment-records + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/subject-digest" + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of deployment records for this digest + and organization + example: 3 + type: integer + deployment_records: + type: array + items: + "$ref": "#/components/schemas/artifact-deployment-record" + examples: + default: + "$ref": "#/components/examples/artifact-deployment-record-list" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records": + get: + summary: List artifact storage records + description: |- + List a collection of artifact storage records with a given subject digest that are associated with repositories owned by an organization. + + The collection of storage records returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `content:read` permission is required. + tags: + - orgs + operationId: orgs/list-artifact-storage-records + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/artifact-metadata#list-artifact-storage-records + parameters: + - "$ref": "#/components/parameters/org" + - name: subject_digest + description: The parameter should be set to the attestation's subject's SHA256 + digest, in the form `sha256:HEX_DIGEST`. + in: path + required: true + example: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + schema: + type: string + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" + x-multi-segment: true + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of storage records for this digest and + organization + example: 3 + type: integer + storage_records: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + digest: + type: string + artifact_url: + type: string + registry_url: + type: string + repository: + type: string + status: + type: string + created_at: + type: string + updated_at: + type: string + examples: + default: + value: + storage_records: + - name: libfoo-1.2.3 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + artifact_url: https://reg.example.com/artifactory/bar/libfoo-1.2.3 + registry_url: https://reg.example.com/artifactory/ + repository: bar + status: active + created_at: '2023-10-01T12:00:00Z' + updated_at: '2023-10-01T12:00:00Z' + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: artifact-metadata + "/orgs/{org}/attestations/bulk-list": + post: + summary: List attestations by bulk subject digests + description: |- + List a collection of artifact attestations associated with any entry in a list of subject digests owned by an organization. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - orgs + operationId: orgs/list-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestations-by-bulk-subject-digests + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + required: + - subject_digests + examples: + default: + "$ref": "#/components/examples/bulk-subject-digest-body" + withPredicateType: + "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + nullable: true + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + "$ref": "#/components/examples/list-attestations-bulk" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/delete-request": + post: + summary: Delete attestations in bulk + description: Delete artifact attestations in bulk by either subject digests + or unique ID. + tags: + - orgs + operationId: orgs/delete-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-in-bulk + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + oneOf: + - properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests associated with the artifact + attestations to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - properties: + attestation_ids: + type: array + items: + type: integer + description: List of unique IDs associated with the artifact attestations + to delete. + minItems: 1 + maxItems: 1024 + required: + - attestation_ids + description: The request body must include either `subject_digests` + or `attestation_ids`, but not both. + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/digest/{subject_digest}": + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - orgs + operationId: orgs/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-subject-digest + parameters: + - "$ref": "#/components/parameters/org" + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations + "/orgs/{org}/attestations/{attestation_id}": + delete: + summary: Delete attestations by ID + description: Delete an artifact attestation by unique ID that is associated + with a repository owned by an org. + tags: + - orgs + operationId: orgs/delete-attestations-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/attestations#delete-attestations-by-id + parameters: + - "$ref": "#/components/parameters/org" + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: attestations "/orgs/{org}/attestations/{subject_digest}": get: summary: List attestations @@ -7507,7 +10665,7 @@ paths: operationId: orgs/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/rest/orgs/orgs#list-attestations + url: https://docs.github.com/rest/orgs/attestations#list-attestations parameters: - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/pagination-before" @@ -7521,6 +10679,15 @@ paths: schema: type: string x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -7535,6 +10702,7 @@ paths: type: object properties: bundle: + nullable: true type: object properties: mediaType: @@ -7554,6 +10722,8 @@ paths: type: integer bundle_url: type: string + initiator: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -7561,7 +10731,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: orgs - subcategory: orgs + subcategory: attestations "/orgs/{org}/blocks": get: summary: List users blocked by an organization @@ -7665,6 +10835,396 @@ paths: enabledForGitHubApps: true category: orgs subcategory: blocking + "/orgs/{org}/campaigns": + get: + summary: List campaigns for an organization + description: |- + Lists campaigns in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/list-org-campaigns + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#list-campaigns-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/direction" + - name: state + description: If specified, only campaigns with this state will be returned. + in: query + required: false + schema: + "$ref": "#/components/schemas/campaign-state" + - name: sort + description: The property by which to sort the results. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - ends_at + - published + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-org-items" + headers: + Link: + "$ref": "#/components/headers/link" + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + post: + summary: Create a campaign for an organization + description: |- + Create a campaign for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + + Fine-grained tokens must have the "Code scanning alerts" repository permissions (read) on all repositories included + in the campaign. + tags: + - campaigns + operationId: campaigns/create-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#create-a-campaign-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: The logins of the users to set as the campaign managers. + At this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + description: The login of each manager + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: The end date and time of the campaign. The date must + be in the future. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: string + format: uri + nullable: true + code_scanning_alerts: + description: The code scanning alerts to include in this campaign + type: array + minItems: 1 + items: + type: object + additionalProperties: false + properties: + repository_id: + type: integer + description: The repository id + alert_numbers: + type: array + description: The alert numbers + minItems: 1 + items: + type: integer + required: + - repository_id + - alert_numbers + nullable: true + generate_issues: + description: If true, will automatically generate issues for the + campaign. The default is false. + type: boolean + default: false + required: + - name + - description + - ends_at + oneOf: + - required: + - code_scanning_alerts + - required: + - secret_scanning_alerts + examples: + default: + value: + name: Critical CodeQL alerts + description: Address critical alerts before they are exploited to + prevent breaches, protect sensitive data, and mitigate financial + and reputational damage. + managers: + - octocat + ends_at: '2024-03-14T00:00:00Z' + code_scanning_alerts: + - repository_id: 1296269 + alert_numbers: + - 1 + - 2 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-summary" + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '429': + description: Too Many Requests + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + "/orgs/{org}/campaigns/{campaign_number}": + get: + summary: Get a campaign for an organization + description: |- + Gets a campaign for an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/get-campaign-summary + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#get-a-campaign-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-summary" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + patch: + summary: Update a campaign + description: |- + Updates a campaign in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/update-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#update-a-campaign + parameters: + - "$ref": "#/components/parameters/org" + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + name: + description: The name of the campaign + type: string + minLength: 1 + maxLength: 50 + description: + description: A description for the campaign + type: string + minLength: 1 + maxLength: 255 + managers: + description: The logins of the users to set as the campaign managers. + At this time, only a single manager can be supplied. + type: array + maxItems: 10 + items: + type: string + team_managers: + description: The slugs of the teams to set as the campaign managers. + type: array + maxItems: 10 + items: + description: The slug of each team + type: string + ends_at: + description: The end date and time of the campaign, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + contact_link: + description: The contact link of the campaign. Must be a URI. + type: string + format: uri + nullable: true + state: + "$ref": "#/components/schemas/campaign-state" + examples: + default: + value: + name: Critical CodeQL alerts + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/campaign-summary" + examples: + default: + "$ref": "#/components/examples/campaign-summary" + '400': + description: Bad Request + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Unprocessable Entity + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns + delete: + summary: Delete a campaign for an organization + description: |- + Deletes a campaign in an organization. + + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. + tags: + - campaigns + operationId: campaigns/delete-campaign + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/campaigns/campaigns#delete-a-campaign-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - name: campaign_number + description: The campaign number. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Deletion successful + '404': + "$ref": "#/components/responses/not_found" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: campaigns + subcategory: campaigns "/orgs/{org}/code-scanning/alerts": get: summary: List code scanning alerts for an organization @@ -7713,6 +11273,14 @@ paths: required: false schema: "$ref": "#/components/schemas/code-scanning-alert-severity" + - name: assignees + description: | + Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -7745,7 +11313,7 @@ paths: The authenticated user must be an administrator or security manager for the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-configurations-for-org @@ -7829,11 +11397,24 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. enum: - enabled - disabled + - code_security + - secret_protection default: disabled + code_security: + type: string + description: The enablement status of GitHub Code Security features. + enum: + - enabled + - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -7875,6 +11456,17 @@ paths: - disabled - not_set default: disabled + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set + default: disabled + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -7885,6 +11477,22 @@ paths: default: disabled code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: not_set + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -7951,6 +11559,29 @@ paths: - disabled - not_set default: disabled + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + default: disabled + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -8002,7 +11633,7 @@ paths: The authenticated user must be an administrator or security manager for the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-default-configurations @@ -8061,6 +11692,9 @@ paths: selected_repository_ids: type: array description: An array of repository IDs to detach from configurations. + Up to 250 IDs can be provided. + minItems: 1 + maxItems: 250 items: type: integer description: Unique identifier of the repository. @@ -8161,10 +11795,23 @@ paths: maxLength: 255 advanced_security: type: string - description: The enablement status of GitHub Advanced Security + description: | + The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features. + + > [!WARNING] + > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features. + enum: + - enabled + - disabled + - code_security + - secret_protection + code_security: + type: string + description: The enablement status of GitHub Code Security features. enum: - enabled - disabled + - not_set dependency_graph: type: string description: The enablement status of Dependency Graph @@ -8201,6 +11848,14 @@ paths: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + description: The enablement status of Dependabot delegated alert + dismissal. Requires Dependabot alerts to be enabled. + enum: + - enabled + - disabled + - not_set code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -8210,6 +11865,24 @@ paths: - not_set code_scanning_default_setup_options: "$ref": "#/components/schemas/code-scanning-default-setup-options" + code_scanning_options: + "$ref": "#/components/schemas/code-scanning-options" + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert + dismissal + enum: + - enabled + - disabled + - not_set + default: disabled + secret_protection: + type: string + description: The enablement status of GitHub Secret Protection features. + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -8271,6 +11944,28 @@ paths: - enabled - disabled - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated + alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -8492,7 +12187,7 @@ paths: The authenticated user must be an administrator or security manager for the organization to use this endpoint. - OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - code-security operationId: code-security/get-repositories-for-configuration @@ -9231,7 +12926,7 @@ paths: 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)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. tags: @@ -9617,110 +13312,177 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-user-management - "/orgs/{org}/copilot/metrics": + "/orgs/{org}/copilot/content_exclusion": get: - summary: Get Copilot metrics for an organization + summary: Get Copilot content exclusion rules 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. + > This endpoint is in public preview and is subject to change. - 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. + Gets information about an organization's Copilot content exclusion path rules. + To configure these settings, go to the organization's settings on GitHub. + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." - 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. + Organization owners can view details about Copilot content exclusion rules for the organization. - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. + OAuth app tokens and personal access tokens (classic) need either the `copilot` or `read:org` scopes to use this endpoint. + + > [!CAUTION] + > * At this time, the API does not support comments. This endpoint will not return any comments in the existing rules. + > * At this time, the API does not support duplicate keys. If your content exclusion configuration contains duplicate keys, the API will return only the last occurrence of that key. For example, if duplicate entries are present, only the final value will be included in the response. tags: - copilot - operationId: copilot/copilot-metrics-for-organization + operationId: copilot/copilot-content-exclusion-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#get-copilot-content-exclusion-rules-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 + description: OK content: application/json: schema: + "$ref": "#/components/schemas/copilot-organization-content-exclusion-details" + examples: + default: + "$ref": "#/components/examples/copilot-organization-content-exclusion-details" + '500': + "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-content-exclusion-management + put: + summary: Set Copilot content exclusion rules for an organization + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + Sets Copilot content exclusion path rules for an organization. + To configure these settings, go to the organization's settings on GitHub. + For more information, see "[Excluding content from GitHub Copilot](https://docs.github.com/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot#configuring-content-exclusions-for-your-organization)." + + Organization owners can set Copilot content exclusion rules for the organization. + + OAuth app tokens and personal access tokens (classic) need the `copilot` scope to use this endpoint. + + > [!CAUTION] + > * At this time, the API does not support comments. When using this endpoint, any existing comments in your rules will be deleted. + > * At this time, the API does not support duplicate keys. If you submit content exclusions through the API with duplicate keys, only the last occurrence will be saved. Earlier entries with the same key will be overwritten. + tags: + - copilot + operationId: copilot/set-copilot-content-exclusion-for-organization + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-content-exclusion-management#set-copilot-content-exclusion-rules-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + description: The content exclusion rules to set + required: true + content: + application/json: + schema: + type: object + additionalProperties: type: array items: - "$ref": "#/components/schemas/copilot-usage-metrics-day" + anyOf: + - type: string + description: The path to the file that will be excluded. + - type: object + properties: + ifAnyMatch: + type: array + items: + type: string + required: + - ifAnyMatch + additionalProperties: false + - type: object + properties: + ifNoneMatch: + type: array + items: + type: string + required: + - ifNoneMatch + additionalProperties: false + examples: + default: + summary: Example of content exclusion paths + value: + octo-repo: + - "/src/some-dir/kernel.rs" + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + properties: + message: + type: string examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-for-day" + value: + message: Content exclusion rules updated successfully. '500': "$ref": "#/components/responses/internal_error" + '401': + "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + '413': + "$ref": "#/components/responses/too_large" '422': - "$ref": "#/components/responses/usage_metrics_api_disabled" + "$ref": "#/components/responses/validation_failed_simple" x-github: - githubCloudOnly: false + githubCloudOnly: enabledForGitHubApps: true category: copilot - subcategory: copilot-metrics - "/orgs/{org}/copilot/usage": + subcategory: copilot-content-exclusion-management + "/orgs/{org}/copilot/metrics": get: - summary: Get a summary of Copilot usage for organization members + summary: Get Copilot metrics for an organization description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - See the response schema tab for detailed metrics definitions. + > [!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. Usage metrics are processed once per day for the previous day, + The response contains metrics for up to 100 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. - Organization owners, and owners and billing managers of the parent enterprise, can view Copilot usage metrics. + 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/usage-metrics-for-org + operationId: copilot/copilot-metrics-for-organization externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members + 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. + Maximum value is 100 days ago. in: query required: false schema: @@ -9735,12 +13497,12 @@ paths: 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)." + description: The number of days of metrics to display per page (max 100). + For 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 + default: 100 responses: '200': description: Response @@ -9749,23 +13511,23 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/copilot-usage-metrics" + "$ref": "#/components/schemas/copilot-usage-metrics-day" examples: default: - "$ref": "#/components/examples/copilot-usage-metrics-org" + "$ref": "#/components/examples/copilot-usage-metrics-for-day" '500': "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" '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-usage + subcategory: copilot-metrics "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization @@ -9788,13 +13550,16 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-ecosystems" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry-urls" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-artifact-registry" + - "$ref": "#/components/parameters/dependabot-alert-org-scope-comma-separated-has" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-runtime-risk" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" - "$ref": "#/components/parameters/per-page" responses: '200': @@ -9984,7 +13749,9 @@ paths: and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. items: - type: string + anyOf: + - type: integer + - type: string required: - visibility examples: @@ -9994,8 +13761,8 @@ paths: key_id: '012345678912345678' visibility: selected selected_repository_ids: - - '1296269' - - '1296280' + - 1296269 + - 1296280 responses: '201': description: Response when creating a secret @@ -11502,6 +15269,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: members + "/orgs/{org}/issue-types": + get: + summary: List issue types for an organization + description: Lists all issue types for an organization. OAuth app tokens and + personal access tokens (classic) need the read:org scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-issue-types + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue-type" + examples: + default: + "$ref": "#/components/examples/issue-type-items" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + post: + summary: Create issue type for an organization + description: |- + Create a new issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/create-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-create-issue-type" + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue-type" + examples: + default: + "$ref": "#/components/examples/issue-type" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + "/orgs/{org}/issue-types/{issue_type_id}": + put: + summary: Update issue type for an organization + description: |- + Updates an issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/update-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/issue-type-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-update-issue-type" + examples: + default: + value: + name: Epic + description: An issue type for a multi-week tracking of work + is_enabled: true + color: green + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue-type" + examples: + default: + "$ref": "#/components/examples/issue-type" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types + delete: + summary: Delete issue type for an organization + description: |- + Deletes an issue type for an organization. + + You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization). + + To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and + personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/delete-issue-type + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/issue-type-id" + responses: + '204': + description: Response + '422': + "$ref": "#/components/responses/validation_failed_simple" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: issue-types "/orgs/{org}/issues": get: summary: List organization issues assigned to the authenticated user @@ -11555,6 +15484,12 @@ paths: - all default: open - "$ref": "#/components/parameters/labels" + - name: type + description: Can be the name of an issue type. + in: query + required: false + schema: + type: string - name: sort description: What to sort results by. in: query @@ -11609,14 +15544,16 @@ paths: - name: filter description: Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) - enabled will be returned. This options is only available for organization - owners. + enabled will be returned. `2fa_insecure` means that only members with [insecure + 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + will be returned. These options are only available for organization owners. in: query required: false schema: type: string enum: - 2fa_disabled + - 2fa_insecure - all default: all - name: role @@ -11688,8 +15625,11 @@ paths: subcategory: members delete: summary: Remove an organization member - description: Removing a user from this list will remove them from all teams - and they will no longer have any access to the organization's repositories. + description: |- + Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories. + + > [!NOTE] + > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. tags: - orgs operationId: orgs/remove-member @@ -11849,7 +15789,7 @@ paths: 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)." + For more information about activity data, see [Metrics data properties for GitHub Copilot](https://docs.github.com/copilot/reference/metrics-data). Only organization owners can view Copilot seat assignment details for members of their organization. @@ -11994,6 +15934,9 @@ paths: In order to remove a user's membership with an organization, the authenticated user must be an organization owner. If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases. + + > [!NOTE] + > If a user has both direct membership in the organization as well as indirect membership via an enterprise team, only their direct membership will be removed. Their indirect membership via an enterprise team remains until the user is removed from the enterprise team. tags: - orgs operationId: orgs/remove-membership-for-user @@ -12690,13 +16633,16 @@ paths: - name: filter description: Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) - enabled will be returned. + enabled will be returned. `2fa_insecure` means that only outside collaborators + with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) + will be returned. in: query required: false schema: type: string enum: - 2fa_disabled + - 2fa_insecure - all default: all - "$ref": "#/components/parameters/per-page" @@ -13182,6 +17128,7 @@ paths: - "$ref": "#/components/parameters/personal-access-token-permission" - "$ref": "#/components/parameters/personal-access-token-before" - "$ref": "#/components/parameters/personal-access-token-after" + - "$ref": "#/components/parameters/personal-access-token-token-id" responses: '500': "$ref": "#/components/responses/internal_error" @@ -13422,6 +17369,7 @@ paths: - "$ref": "#/components/parameters/personal-access-token-permission" - "$ref": "#/components/parameters/personal-access-token-before" - "$ref": "#/components/parameters/personal-access-token-after" + - "$ref": "#/components/parameters/personal-access-token-token-id" responses: '500': "$ref": "#/components/responses/internal_error" @@ -13619,9 +17567,7 @@ paths: "/orgs/{org}/private-registries": get: summary: List private registries for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Lists all private registry configurations available at the organization-level without revealing their encrypted values. @@ -13671,9 +17617,7 @@ paths: subcategory: organization-configurations post: summary: Create a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." @@ -13698,12 +17642,39 @@ paths: type: string enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri username: description: The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. type: string nullable: true + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries @@ -13737,6 +17708,7 @@ paths: type: integer required: - registry_type + - url - encrypted_value - key_id - visibility @@ -13746,7 +17718,9 @@ paths: visibility value: registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ username: monalisa + replaces_base: true encrypted_value: c2VjcmV0 key_id: '012345678912345678' visibility: private @@ -13755,6 +17729,7 @@ paths: visibility value: registry_type: maven_repository + url: https://maven.pkg.github.com/organization/ username: monalisa encrypted_value: c2VjcmV0 key_id: '012345678912345678' @@ -13786,9 +17761,7 @@ paths: "/orgs/{org}/private-registries/public-key": get: summary: Get private registries public key for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets. @@ -13836,9 +17809,7 @@ paths: "/orgs/{org}/private-registries/{secret_name}": get: summary: Get a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Get the configuration of a single private registry defined for an organization, omitting its encrypted value. @@ -13871,9 +17842,7 @@ paths: subcategory: organization-configurations patch: summary: Update a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." @@ -13899,12 +17868,39 @@ paths: type: string enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + url: + description: The URL of the private registry. + type: string + format: uri username: description: The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. type: string nullable: true + replaces_base: + description: Whether this private registry should replace the base + registry (e.g., npmjs.org for npm, rubygems.org for rubygems). + When set to `true`, Dependabot will only use this registry and + will not fall back to the public registry. When set to `false` + (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false encrypted_value: description: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries @@ -13953,9 +17949,7 @@ paths: subcategory: organization-configurations delete: summary: Delete a private registry for an organization - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + description: |2- Delete a private registry configuration at the organization-level. @@ -13981,34 +17975,28 @@ paths: enabledForGitHubApps: true category: private-registries subcategory: organization-configurations - "/orgs/{org}/projects": + "/orgs/{org}/projectsV2": get: - summary: List organization projects - description: Lists the projects in an organization. Returns a `404 Not Found` - status if projects are disabled in the organization. If you do not have sufficient - privileges to perform this action, a `401 Unauthorized` or `410 Gone` status - is returned. + summary: List projects for organization + description: List all projects owned by a specific organization accessible by + the authenticated user. tags: - projects operationId: projects/list-for-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-organization-projects + url: https://docs.github.com/rest/projects/projects#list-projects-for-organization parameters: - "$ref": "#/components/parameters/org" - - name: state - description: Indicates the state of the projects to return. + - name: q + description: Limit results to projects of the specified type. in: query required: false schema: type: string - enum: - - open - - closed - - all - default: open + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -14017,79 +18005,879 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2" examples: default: - "$ref": "#/components/examples/project-items" + "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" - '422': - "$ref": "#/components/responses/validation_failed_simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects subcategory: projects + "/orgs/{org}/projectsV2/{project_number}": + get: + summary: Get project for organization + description: Get a specific organization-owned project. + tags: + - projects + operationId: projects/get-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2" + examples: + default: + "$ref": "#/components/examples/projects-v2" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/orgs/{org}/projectsV2/{project_number}/drafts": post: - summary: Create an organization project - description: Creates an organization project board. Returns a `410 Gone` status - if projects are disabled in the organization or if the organization does not - have existing classic projects. If you do not have sufficient privileges to - perform this action, a `401 Unauthorized` or `410 Gone` status is returned. + summary: Create draft item for organization owned project + description: Create draft issue item for the specified organization owned project. tags: - projects - operationId: projects/create-for-org + operationId: projects/create-draft-item-for-org externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/projects#create-an-organization-project + url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-organization-owned-project parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/project-number" requestBody: required: true + description: Details of the draft item to create in the project. content: application/json: schema: type: object properties: - name: + title: type: string - description: The name of the project. + description: The title of the draft issue item to create in the + project. body: type: string - description: The description of the project. + description: The body content of the draft issue item to create + in the project. required: - - name + - title examples: - default: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + draft_issue: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts + "/orgs/{org}/projectsV2/{project_number}/fields": + get: + summary: List project fields for organization + description: List all fields for a specific organization-owned project. + tags: + - projects + operationId: projects/list-fields-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#list-project-fields-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field-items" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + post: + summary: Add a field to an organization-owned project. + description: Add a field to an organization-owned project. + tags: + - projects + operationId: projects/add-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-a-field-to-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + issue_field_id: + type: integer + description: The ID of the IssueField to create the field for. + required: + - issue_field_id + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response for adding a field to an organization-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}": + get: + summary: Get project field for organization + description: Get a specific field for an organization-owned project. + tags: + - projects + operationId: projects/get-field-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#get-project-field-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/field-id" + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/orgs/{org}/projectsV2/{project_number}/items": + get: + summary: List items for an organization owned project + description: List all items for a specific organization-owned project accessible + by the authenticated user. + tags: + - projects + operationId: projects/list-items-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - name: q + description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + in: query + required: false + schema: + type: string + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + post: + summary: Add item to organization owned project + description: Add an issue or pull request item to the specified organization + owned project. + tags: + - projects + operationId: projects/add-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#add-item-to-organization-owned-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + description: Details of the item to add to the project. You can specify either + the unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + oneOf: + - required: + - id + - required: + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID value: - name: Organization Roadmap - body: High-level roadmap for the upcoming year. + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 responses: '201': description: Response content: application/json: schema: - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/orgs/{org}/projectsV2/{project_number}/items/{item_id}": + get: + summary: Get an item for an organization owned project + description: Get a specific item from an organization-owned project. + tags: + - projects + operationId: projects/get-org-item + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#get-an-item-for-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/item-id" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" examples: default: - "$ref": "#/components/examples/project-2" + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + patch: + summary: Update project item for organization + description: Update a specific item in an organization-owned project. + tags: + - projects + operationId: projects/update-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#update-project-item-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/item-id" + requestBody: + required: true + description: Field updates to apply to the project item. Only text, number, + date, single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: |- + The new value for the field: + - For text, number, and date fields, provide the new value directly. + - For single select and iteration fields, provide the ID of the option or iteration. + - To clear the field, set this to null. + nullable: true + oneOf: + - type: string + - type: number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + number_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + date_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + single_select_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + iteration_field: + "$ref": "#/components/examples/projects-v2-item-with-content" '401': "$ref": "#/components/responses/requires_authentication" '403': "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" '422': - "$ref": "#/components/responses/validation_failed_simple" + "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true category: projects - subcategory: projects + subcategory: items + delete: + summary: Delete project item for organization + description: Delete a specific item from an organization-owned project. + tags: + - projects + operationId: projects/delete-item-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#delete-project-item-for-organization + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/item-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/orgs/{org}/projectsV2/{project_number}/views": + post: + summary: Create a view for an organization-owned project + description: Create a new view in an organization-owned project. Views allow + you to customize how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/views#create-a-view-for-an-organization-owned-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + example: Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + example: board + filter: + type: string + description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + example: is:issue is:open + visible_fields: + type: array + description: |- + `visible_fields` is not applicable to `roadmap` layout views. + For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + items: + type: integer + example: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in an organization-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-view" + examples: + table_view: + summary: Response for creating a table view + value: + "$ref": "#/components/examples/projects-v2-view" + board_view: + summary: Response for creating a board view with filter + value: + "$ref": "#/components/examples/projects-v2-view" + roadmap_view: + summary: Response for creating a roadmap view + value: + "$ref": "#/components/examples/projects-v2-view" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + description: Service unavailable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: views + "/orgs/{org}/projectsV2/{project_number}/views/{view_number}/items": + get: + summary: List items for an organization project view + description: List items in an organization project with the saved view's filter + applied. + tags: + - projects + operationId: projects/list-view-items-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-an-organization-project-view + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/view-number" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the + title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items "/orgs/{org}/properties/schema": get: summary: Get all custom properties for an organization @@ -14098,7 +18886,7 @@ paths: Organization members can read these properties. tags: - orgs - operationId: orgs/get-all-custom-properties + operationId: orgs/custom-properties-for-repos-get-organization-definitions externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization @@ -14130,12 +18918,16 @@ paths: description: |- Creates new or updates existing custom properties defined for an organization in a batch. + If the property already exists, the existing property will be replaced with the new values. + Missing optional values will fall back to default values, previous values will be overwritten. + E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`. + To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs - operationId: orgs/create-or-update-custom-properties + operationId: orgs/custom-properties-for-repos-create-or-update-organization-definitions externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization @@ -14204,7 +18996,7 @@ paths: Organization members can read these properties. tags: - orgs - operationId: orgs/get-custom-property + operationId: orgs/custom-properties-for-repos-get-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization @@ -14240,7 +19032,7 @@ paths: - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs - operationId: orgs/create-or-update-custom-property + operationId: orgs/custom-properties-for-repos-create-or-update-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization @@ -14292,7 +19084,7 @@ paths: - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs - operationId: orgs/remove-custom-property + operationId: orgs/custom-properties-for-repos-delete-organization-definition externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization @@ -14319,7 +19111,7 @@ paths: Organization members can read these properties. tags: - orgs - operationId: orgs/list-custom-properties-values-for-repos + operationId: orgs/custom-properties-for-repos-get-organization-values externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories @@ -14378,7 +19170,7 @@ paths: - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. tags: - orgs - operationId: orgs/create-or-update-custom-properties-values-for-repos + operationId: orgs/custom-properties-for-repos-create-or-update-organization-values externalDocs: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-property-values-for-organization-repositories @@ -14902,7 +19694,7 @@ paths: type: array description: An array of rules within the ruleset. items: - "$ref": "#/components/schemas/repository-rule" + "$ref": "#/components/schemas/org-rules" required: - name - enforcement @@ -14947,6 +19739,8 @@ paths: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/orgs/{org}/rulesets/rule-suites": @@ -15118,7 +19912,7 @@ paths: description: An array of rules within the ruleset. type: array items: - "$ref": "#/components/schemas/repository-rule" + "$ref": "#/components/schemas/org-rules" examples: default: value: @@ -15160,6 +19954,8 @@ paths: "$ref": "#/components/examples/org-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" delete: @@ -15191,6 +19987,90 @@ paths: "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" + "/orgs/{org}/rulesets/{ruleset_id}/history": + get: + summary: Get organization ruleset history + description: Get the history of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-history + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ruleset-version" + examples: + default: + "$ref": "#/components/examples/ruleset-history" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules + "/orgs/{org}/rulesets/{ruleset_id}/history/{version_id}": + get: + summary: Get organization ruleset version + description: Get a version of an organization ruleset. + tags: + - orgs + operationId: orgs/get-org-ruleset-version + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/rules#get-organization-ruleset-version + parameters: + - "$ref": "#/components/parameters/org" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ruleset-version-with-state" + examples: + default: + "$ref": "#/components/examples/org-ruleset-version-with-state" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: rules "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization @@ -15211,6 +20091,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -15220,6 +20101,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response @@ -15244,6 +20126,137 @@ paths: enabledForGitHubApps: true category: secret-scanning subcategory: secret-scanning + "/orgs/{org}/secret-scanning/pattern-configurations": + get: + summary: List organization pattern configurations + description: |- + Lists the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `read:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/list-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/secret-scanning-pattern-configuration" + examples: + default: + "$ref": "#/components/examples/secret-scanning-pattern-configuration" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + patch: + summary: Update organization pattern configurations + description: |- + Updates the secret scanning pattern configurations for an organization. + + Personal access tokens (classic) need the `write:org` scope to use this endpoint. + tags: + - secret-scanning + operationId: secret-scanning/update-org-pattern-configs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/secret-scanning/push-protection#update-organization-pattern-configurations + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: secret-scanning + subcategory: push-protection + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_settings: + type: array + description: Pattern settings for provider patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - not-set + - disabled + - enabled + custom_pattern_settings: + type: array + description: Pattern settings for custom patterns. + items: + type: object + properties: + token_type: + type: string + description: The ID of the pattern to configure. + custom_pattern_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + push_protection_setting: + type: string + description: Push protection setting to set for the pattern. + enum: + - disabled + - enabled + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_settings: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + push_protection_setting: enabled + custom_pattern_settings: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + push_protection_setting: enabled + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + pattern_config_version: + type: string + description: The updated pattern configuration version. + examples: + default: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + '422': + "$ref": "#/components/responses/validation_failed" "/orgs/{org}/security-advisories": get: summary: List repository security advisories for an organization @@ -15343,7 +20356,7 @@ paths: "$ref": "#/components/schemas/team-simple" examples: default: - "$ref": "#/components/examples/team-items" + "$ref": "#/components/examples/team-simple-items" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15406,102 +20419,230 @@ paths: deprecationDate: '2024-12-01' removalDate: '2026-01-01' deprecated: true - "/orgs/{org}/settings/billing/actions": + "/orgs/{org}/settings/immutable-releases": get: - summary: Get GitHub Actions billing for an organization + summary: Get immutable releases settings for an organization description: |- - Gets the summary of the free and paid GitHub Actions minutes used. + Gets the immutable releases policy for repositories in an organization. - Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - - OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - operationId: billing/get-github-actions-billing-org + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - - billing + - orgs + operationId: orgs/get-immutable-releases-settings externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization + url: https://docs.github.com/rest/orgs/orgs#get-immutable-releases-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: '200': - description: Response + description: Immutable releases settings response content: application/json: schema: - "$ref": "#/components/schemas/actions-billing-usage" + "$ref": "#/components/schemas/immutable-releases-organization-settings" examples: default: - "$ref": "#/components/examples/actions-billing-usage" + value: + enforced_repositories: all x-github: githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: billing - "/orgs/{org}/settings/billing/packages": - get: - summary: Get GitHub Packages billing for an organization + enabledForGitHubApps: true + category: orgs + subcategory: orgs + put: + summary: Set immutable releases settings for an organization description: |- - Gets the free and paid storage used for GitHub Packages in gigabytes. + Sets the immutable releases policy for repositories in an organization. - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#set-immutable-releases-settings-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enforced_repositories: + type: string + description: The policy that controls how immutable releases are + enforced in the organization. + enum: + - all + - none + - selected + example: all + selected_repository_ids: + type: array + description: An array of repository ids for which immutable releases + enforcement should be applied. You can only provide a list of + repository ids when the `enforced_repositories` is set to `selected`. + You can add and remove individual repositories using the [Enable + a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + and [Disable a selected repository for immutable releases in an + organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + endpoints. + items: + type: integer + required: + - enforced_repositories + examples: + default: + value: + enforced_repositories: all + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/settings/immutable-releases/repositories": + get: + summary: List selected repositories for immutable releases enforcement + description: |- + List all of the repositories that have been selected for immutable releases enforcement in an organization. - OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - operationId: billing/get-github-packages-billing-org + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - - billing + - orgs + operationId: orgs/get-immutable-releases-settings-repositories externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization + url: https://docs.github.com/rest/orgs/orgs#list-selected-repositories-for-immutable-releases-enforcement parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" responses: '200': description: Response content: application/json: schema: - "$ref": "#/components/schemas/packages-billing-usage" + type: object + required: + - total_count + - repositories + properties: + total_count: + type: integer + repositories: + type: array + items: + "$ref": "#/components/schemas/minimal-repository" examples: default: - "$ref": "#/components/examples/packages-billing-usage" + "$ref": "#/components/examples/public-repository-paginated" x-github: githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: billing - "/orgs/{org}/settings/billing/shared-storage": - get: - summary: Get shared storage billing for an organization + enabledForGitHubApps: true + category: orgs + subcategory: orgs + put: + summary: Set selected repositories for immutable releases enforcement description: |- - Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + Replaces all repositories that have been selected for immutable releases enforcement in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/set-immutable-releases-settings-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#set-selected-repositories-for-immutable-releases-enforcement + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_repository_ids: + type: array + description: An array of repository ids for which immutable releases + enforcement should be applied. You can only provide a list of + repository ids when the `enforced_repositories` is set to `selected`. + You can add and remove individual repositories using the [Enable + a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) + and [Disable a selected repository for immutable releases in an + organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) + endpoints. + items: + type: integer + required: + - selected_repository_ids + examples: + default: + value: + selected_repository_ids: + - 64780797 + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/settings/immutable-releases/repositories/{repository_id}": + put: + summary: Enable a selected repository for immutable releases in an organization + description: |- + Adds a repository to the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. - OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. - operationId: billing/get-shared-storage-billing-org + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: orgs/enable-selected-repository-immutable-releases-organization tags: - - billing + - orgs externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization + url: https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization parameters: - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" responses: - '200': + '204': description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/combined-billing-usage" - examples: - default: - "$ref": "#/components/examples/combined-billing-usage" x-github: githubCloudOnly: false - enabledForGitHubApps: false - category: billing - subcategory: billing + enabledForGitHubApps: true + category: orgs + subcategory: orgs + delete: + summary: Disable a selected repository for immutable releases in an organization + description: |- + Removes a repository from the list of selected repositories that are enforced for immutable releases in an organization. To use this endpoint, the organization immutable releases policy for `enforced_repositories` must be configured to `selected`. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + operationId: orgs/disable-selected-repository-immutable-releases-organization + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/repository-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/settings/network-configurations": get: summary: List hosted compute network configurations for an organization @@ -15583,8 +20724,9 @@ paths: type: array minItems: 1 maxItems: 1 - description: The identifier of the network settings to use for the - network configuration. Exactly one network settings must be specified. + description: A list of identifiers of the network settings resources + to use for the network configuration. Exactly one resource identifier + must be specified in the list. items: type: string required: @@ -15683,8 +20825,9 @@ paths: type: array minItems: 0 maxItems: 1 - description: The identifier of the network settings to use for the - network configuration. Exactly one network settings must be specified. + description: A list of identifiers of the network settings resources + to use for the network configuration. Exactly one resource identifier + must be specified in the list. items: type: string examples: @@ -15775,7 +20918,7 @@ paths: > [!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, + The response contains metrics for up to 100 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. @@ -15795,7 +20938,7 @@ paths: - 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. + Maximum value is 100 days ago. in: query required: false schema: @@ -15810,12 +20953,12 @@ paths: 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)." + description: The number of days of metrics to display per page (max 100). + For 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 + default: 100 responses: '200': description: Response @@ -15841,85 +20984,6 @@ paths: 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 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. - See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot`, `read:org`, or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/usage-metrics-for-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-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" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-org" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/orgs/{org}/teams": get: summary: List teams @@ -15986,8 +21050,8 @@ paths: description: The description of the team. maintainers: type: array - description: List GitHub IDs for organization members who will become - team maintainers. + description: List GitHub usernames for organization members who + will become team maintainers. items: type: string repo_names: @@ -16213,767 +21277,13 @@ paths: responses: '204': description: Response + '422': + "$ref": "#/components/responses/enterprise_team_unsupported" x-github: githubCloudOnly: false enabledForGitHubApps: true category: teams subcategory: teams - "/orgs/{org}/teams/{team_slug}/discussions": - get: - summary: List discussions - description: |- - List all discussions on a team's page. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#list-discussions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - - name: pinned - in: query - required: false - description: Pinned discussions only filter - schema: - type: string - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - post: - summary: Create a discussion - description: |- - Creates a new discussion post on a team's page. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#create-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - private: - type: boolean - description: Private posts are only visible to team members, organization - owners, and team maintainers. Public posts are visible to all - members of the organization. Set to `true` to create a private - post. - default: false - required: - - title - - body - examples: - default: - value: - title: Our first team post - body: Hi! This is an area for us to collaborate as a team. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": - get: - summary: Get a discussion - description: |- - Get a specific discussion on a team's page. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#get-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - patch: - summary: Update a discussion - description: |- - Edits the title and body text of a discussion post. Only the parameters you provide are updated. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#update-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - examples: - default: - value: - title: Welcome to our first team post - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - delete: - summary: Delete a discussion - description: |- - Delete a discussion from a team's page. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#delete-a-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": - get: - summary: List discussion comments - description: |- - List all comments on a team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussion-comments-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - post: - summary: Create a discussion comment - description: |- - Creates a new comment on a team discussion. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like apples? - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": - get: - summary: Get a discussion comment - description: |- - Get a specific comment on a team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - patch: - summary: Update a discussion comment - description: |- - Edits the body text of a discussion comment. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like pineapples? - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - delete: - summary: Delete a discussion comment - description: |- - Deletes a comment on a team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: discussion-comments - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment - description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion comment - description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response when the reaction type has already been added to this - team discussion comment - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion comment reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion-comment - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion - description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions - post: - summary: Create reaction for a team discussion - description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - category: reactions - subcategory: reactions - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": - delete: - summary: Delete team discussion reaction - description: |- - > [!NOTE] - > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/delete-for-team-discussion - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/reaction-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: reactions - subcategory: reactions "/orgs/{org}/teams/{team_slug}/invitations": get: summary: List pending team invitations @@ -17008,6 +21318,8 @@ paths: headers: Link: "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/enterprise_team_unsupported" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17201,171 +21513,6 @@ paths: enabledForGitHubApps: true category: teams subcategory: members - "/orgs/{org}/teams/{team_slug}/projects": - get: - summary: List team projects - description: |- - Lists the organization projects for a team. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. - tags: - - teams - operationId: teams/list-projects-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": - get: - summary: Check team permissions for a project - description: |- - Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - tags: - - teams - operationId: teams/check-permissions-for-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - put: - summary: Add or update team project permissions - description: |- - 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. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - tags: - - teams - operationId: teams/add-or-update-project-permissions-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - nullable: true - examples: - default: - summary: Updates the permissions for the team to write for the project - value: - permission: write - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams - delete: - summary: Remove a project from a team - description: |- - 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. This endpoint removes the project from the team, but does not delete the project. - - > [!NOTE] - > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. - tags: - - teams - operationId: teams/remove-project-in-org - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team - parameters: - - "$ref": "#/components/parameters/org" - - "$ref": "#/components/parameters/team-slug" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: teams - subcategory: teams "/orgs/{org}/teams/{team_slug}/repos": get: summary: List team repositories @@ -17620,1217 +21767,258 @@ paths: deprecationDate: '2024-07-22' removalDate: '2025-07-22' deprecated: true - "/projects/columns/cards/{card_id}": + "/rate_limit": get: - summary: Get a project card - description: Gets information about a project card. + summary: Get rate limit status for the authenticated user + description: |- + > [!NOTE] + > Accessing this endpoint does not count against your REST API rate limit. + + Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: + * The `core` object provides your rate limit status for all non-search-related resources in the REST API. + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." + * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." + * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." + * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." + * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." + * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." + * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." + + > [!NOTE] + > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. tags: - - projects - operationId: projects/get-card + - rate-limit + operationId: rate-limit/get externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/cards#get-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" + url: https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user + parameters: [] responses: '200': description: Response content: application/json: schema: - "$ref": "#/components/schemas/project-card" + "$ref": "#/components/schemas/rate-limit-overview" examples: default: - "$ref": "#/components/examples/project-card" + "$ref": "#/components/examples/rate-limit-overview" + headers: + X-RateLimit-Limit: + "$ref": "#/components/headers/x-rate-limit-limit" + X-RateLimit-Remaining: + "$ref": "#/components/headers/x-rate-limit-remaining" + X-RateLimit-Reset: + "$ref": "#/components/headers/x-rate-limit-reset" '304': "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: projects - subcategory: cards - patch: - summary: Update an existing project card - description: '' + category: rate-limit + subcategory: rate-limit + "/repos/{owner}/{repo}": + get: + summary: Get a repository + description: |- + The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. + + > [!NOTE] + > - In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + > - To view merge-related settings, you must have the `contents:read` and `contents:write` permissions. tags: - - projects - operationId: projects/update-card + - repos + operationId: repos/get externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card + url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - "$ref": "#/components/parameters/card-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - archived: - description: Whether or not the card is archived - example: false - type: boolean - examples: - default: - summary: Change the note on the card - value: - note: Add payload for delete Project column + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" responses: '200': description: Response content: application/json: schema: - "$ref": "#/components/schemas/project-card" + "$ref": "#/components/schemas/full-repository" examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" + default-response: + "$ref": "#/components/examples/full-repository-default-response" '403': "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - delete: - summary: Delete a project card - description: Deletes a project card - tags: - - projects - operationId: projects/delete-card - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/cards#delete-a-project-card - parameters: - - "$ref": "#/components/parameters/card-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" '404': "$ref": "#/components/responses/not_found" + '301': + "$ref": "#/components/responses/moved_permanently" x-github: githubCloudOnly: false enabledForGitHubApps: true - category: projects - subcategory: cards - "/projects/columns/cards/{card_id}/moves": - post: - summary: Move a project card - description: '' + category: repos + subcategory: repos + patch: + summary: Update a repository + description: "**Note**: To edit a repository's topics, use the [Replace all + repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) + endpoint." tags: - - projects - operationId: projects/move-card + - repos + operationId: repos/update externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/cards#move-a-project-card + url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - "$ref": "#/components/parameters/card-id" + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" requestBody: - required: true + required: false content: application/json: schema: + type: object properties: - position: - description: 'The position of the card in a column. Can be one of: - `top`, `bottom`, or `after:` to place after the specified - card.' - example: bottom + name: type: string - pattern: "^(?:top|bottom|after:\\d+)$" - column_id: - description: The unique identifier of the column the card should - be moved to - example: 42 - type: integer - required: - - position - type: object - examples: - default: - summary: Move the card to the bottom of the column - value: - column_id: 42 - position: bottom - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: + description: The name of the repository. + description: + type: string + description: A short description of the repository. + homepage: + type: string + description: A URL with more information about the repository. + private: + type: boolean + description: "Either `true` to make the repository private or `false` + to make it public. Default: `false`. \n**Note**: You will get + a `422` error if the organization restricts [changing repository + visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) + to organization owners and a non-owner tries to change the value + of private." + default: false + visibility: + type: string + description: The visibility of the repository. + enum: + - public + - private + security_and_analysis: + type: object + description: |- + Specify which security and analysis features to enable or disable for the repository. + + To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: + `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. + + You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. + nullable: true + properties: + advanced_security: type: object + description: |- + Use the `status` property to enable or disable GitHub Advanced Security for this repository. + For more information, see "[About GitHub Advanced + Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. properties: - code: - type: string - message: + status: type: string - resource: + description: Can be `enabled` or `disabled`. + code_security: + type: object + description: Use the `status` property to enable or disable + GitHub Code Security for this repository. + properties: + status: type: string - field: + description: Can be `enabled` or `disabled`. + secret_scanning: + type: object + description: Use the `status` property to enable or disable + secret scanning for this repository. For more information, + see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." + properties: + status: type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: + description: Can be `enabled` or `disabled`. + secret_scanning_push_protection: type: object + description: Use the `status` property to enable or disable + secret scanning push protection for this repository. For more + information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." properties: - code: + status: type: string - message: - type: string - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - "/projects/columns/{column_id}": - get: - summary: Get a project column - description: Gets information about a project column. - tags: - - projects - operationId: projects/get-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#get-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - patch: - summary: Update an existing project column - description: '' - tags: - - projects - operationId: projects/update-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - summary: Rename the project column - value: - name: To Do - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - delete: - summary: Delete a project column - description: Deletes a project column. - tags: - - projects - operationId: projects/delete-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#delete-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - "/projects/columns/{column_id}/cards": - get: - summary: List project cards - description: Lists the project cards in a project. - tags: - - projects - operationId: projects/list-cards - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/cards#list-project-cards - parameters: - - "$ref": "#/components/parameters/column-id" - - name: archived_state - description: Filters the project cards that are returned by the card's state. - in: query - required: false - schema: - type: string - enum: - - all - - archived - - not_archived - default: not_archived - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card-items" - headers: - Link: - "$ref": "#/components/headers/link" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - post: - summary: Create a project card - description: '' - tags: - - projects - operationId: projects/create-card - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/cards#create-a-project-card - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - oneOf: - - type: object - properties: - note: - description: The project card's note - example: Update all gems - type: string - nullable: true - required: - - note - - type: object - properties: - content_id: - description: The unique identifier of the content associated with - the card - example: 42 - type: integer - content_type: - description: The piece of content associated with the card - example: PullRequest - type: string - required: - - content_id - - content_type - examples: - default: - summary: Create a new card - value: - note: Add payload for delete Project column - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-card" - examples: - default: - "$ref": "#/components/examples/project-card" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - description: Validation failed - content: - application/json: - schema: - oneOf: - - "$ref": "#/components/schemas/validation-error" - - "$ref": "#/components/schemas/validation-error-simple" - '503': - description: Response - content: - application/json: - schema: - type: object - properties: - code: - type: string - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: object - properties: - code: - type: string - message: - type: string - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: cards - "/projects/columns/{column_id}/moves": - post: - summary: Move a project column - description: '' - tags: - - projects - operationId: projects/move-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#move-a-project-column - parameters: - - "$ref": "#/components/parameters/column-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - position: - description: 'The position of the column in a project. Can be one - of: `first`, `last`, or `after:` to place after the - specified column.' - example: last - type: string - pattern: "^(?:first|last|after:\\d+)$" - required: - - position - type: object - examples: - default: - summary: Move the column to the end of the board - value: - position: last - responses: - '201': - description: Response - content: - application/json: - schema: - type: object - properties: {} - additionalProperties: false - examples: - default: - value: - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - "/projects/{project_id}": - get: - summary: Get a project - description: Gets a project by its `id`. Returns a `404 Not Found` status if - projects are disabled. If you do not have sufficient privileges to perform - this action, a `401 Unauthorized` or `410 Gone` status is returned. - tags: - - projects - operationId: projects/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#get-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - patch: - summary: Update a project - description: Updates a project board's information. Returns a `404 Not Found` - status if projects are disabled. If you do not have sufficient privileges - to perform this action, a `401 Unauthorized` or `410 Gone` status is returned. - operationId: projects/update - tags: - - projects - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#update-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - properties: - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - state: - description: State of the project; either 'open' or 'closed' - example: open - type: string - organization_permission: - description: The baseline permission that all organization members - have on this project - type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. - type: boolean - type: object - examples: - default: - summary: Change the name, state, and permissions for a project - value: - name: Week One Sprint - state: open - organization_permission: write - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '404': - description: Not Found if the authenticated user does not have access to - the project - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - delete: - summary: Delete a project - description: Deletes a project board. Returns a `404 Not Found` status if projects - are disabled. - operationId: projects/delete - tags: - - projects - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#delete-a-project - parameters: - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Delete Success - '304': - "$ref": "#/components/responses/not_modified" - '403': - description: Forbidden - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - errors: - type: array - items: - type: string - '401': - "$ref": "#/components/responses/requires_authentication" - '410': - "$ref": "#/components/responses/gone" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - "/projects/{project_id}/collaborators": - get: - summary: List project collaborators - description: Lists the collaborators for an organization project. For a project, - the list of collaborators includes outside collaborators, organization members - that are direct collaborators, organization members with access through team - memberships, organization members with access through default organization - permissions, and organization owners. You must be an organization owner or - a project `admin` to list collaborators. - tags: - - projects - operationId: projects/list-collaborators - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators - parameters: - - "$ref": "#/components/parameters/project-id" - - name: affiliation - description: Filters the collaborators by their affiliation. `outside` means - outside collaborators of a project that are not a member of the project's - organization. `direct` means collaborators with permissions to a project, - regardless of organization membership status. `all` means all collaborators - the authenticated user can see. - in: query - required: false - schema: - type: string - enum: - - outside - - direct - - all - default: all - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/simple-user" - examples: - default: - "$ref": "#/components/examples/simple-user-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - "/projects/{project_id}/collaborators/{username}": - put: - summary: Add project collaborator - description: Adds a collaborator to an organization project and sets their permission - level. You must be an organization owner or a project `admin` to add a collaborator. - tags: - - projects - operationId: projects/add-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - description: The permission to grant the collaborator. - enum: - - read - - write - - admin - default: write - example: write - type: string - nullable: true - examples: - default: - summary: Applying write permissions for the new collaborator - value: - permission: write - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - delete: - summary: Remove user as a collaborator - description: Removes a collaborator from an organization project. You must be - an organization owner or a project `admin` to remove a collaborator. - tags: - - projects - operationId: projects/remove-collaborator - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '204': - description: Response - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - "/projects/{project_id}/collaborators/{username}/permission": - get: - summary: Get project permission for a user - description: 'Returns the collaborator''s permission level for an organization - project. Possible values for the `permission` key: `admin`, `write`, `read`, - `none`. You must be an organization owner or a project `admin` to review a - user''s permission level.' - tags: - - projects - operationId: projects/get-permission-for-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/username" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-collaborator-permission" - examples: - default: - "$ref": "#/components/examples/project-collaborator-permission" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: collaborators - "/projects/{project_id}/columns": - get: - summary: List project columns - description: Lists the project columns in a project. - tags: - - projects - operationId: projects/list-columns - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#list-project-columns - parameters: - - "$ref": "#/components/parameters/project-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project-column" - examples: - default: - "$ref": "#/components/examples/project-column-items" - headers: - Link: - "$ref": "#/components/headers/link" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - post: - summary: Create a project column - description: Creates a new project column. - tags: - - projects - operationId: projects/create-column - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/columns#create-a-project-column - parameters: - - "$ref": "#/components/parameters/project-id" - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project column - example: Remaining tasks - type: string - required: - - name - type: object - examples: - default: - value: - name: Remaining tasks - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project-column" - examples: - default: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '422': - "$ref": "#/components/responses/validation_failed_simple" - '401': - "$ref": "#/components/responses/requires_authentication" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: columns - "/rate_limit": - get: - summary: Get rate limit status for the authenticated user - description: |- - > [!NOTE] - > Accessing this endpoint does not count against your REST API rate limit. - - Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: - * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." - * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." - * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." - * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." - * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." - * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." - * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." - * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." - - > [!NOTE] - > The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. - tags: - - rate-limit - operationId: rate-limit/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/rate-limit/rate-limit#get-rate-limit-status-for-the-authenticated-user - parameters: [] - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/rate-limit-overview" - examples: - default: - "$ref": "#/components/examples/rate-limit-overview" - headers: - X-RateLimit-Limit: - "$ref": "#/components/headers/x-rate-limit-limit" - X-RateLimit-Remaining: - "$ref": "#/components/headers/x-rate-limit-remaining" - X-RateLimit-Reset: - "$ref": "#/components/headers/x-rate-limit-reset" - '304': - "$ref": "#/components/responses/not_modified" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: rate-limit - subcategory: rate-limit - "/repos/{owner}/{repo}": - get: - summary: Get a repository - description: |- - The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. - - > [!NOTE] - > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - tags: - - repos - operationId: repos/get - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#get-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/full-repository" - examples: - default-response: - "$ref": "#/components/examples/full-repository-default-response" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '301': - "$ref": "#/components/responses/moved_permanently" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: repos - patch: - summary: Update a repository - description: "**Note**: To edit a repository's topics, use the [Replace all - repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) - endpoint." - tags: - - repos - operationId: repos/update - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/repos/repos#update-a-repository - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the repository. - description: - type: string - description: A short description of the repository. - homepage: - type: string - description: A URL with more information about the repository. - private: - type: boolean - description: "Either `true` to make the repository private or `false` - to make it public. Default: `false`. \n**Note**: You will get - a `422` error if the organization restricts [changing repository - visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) - to organization owners and a non-owner tries to change the value - of private." - default: false - visibility: - type: string - description: The visibility of the repository. - enum: - - public - - private - security_and_analysis: - type: object - description: |- - Specify which security and analysis features to enable or disable for the repository. - - To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." - - For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request: - `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. - - You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request. - nullable: true - properties: - advanced_security: - type: object - description: Use the `status` property to enable or disable - GitHub Advanced Security for this repository. For more information, - see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." - properties: - status: + 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: + secret_scanning_non_provider_patterns: type: object description: Use the `status` property to enable or disable - secret scanning for this repository. For more information, - see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." + 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)." properties: status: type: string description: Can be `enabled` or `disabled`. - secret_scanning_push_protection: + secret_scanning_delegated_alert_dismissal: type: object description: Use the `status` property to enable or disable - secret scanning push protection for this repository. For more - information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + secret scanning delegated alert dismissal for this repository. properties: status: type: string description: Can be `enabled` or `disabled`. - secret_scanning_ai_detection: + secret_scanning_delegated_bypass: 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)." + secret scanning delegated bypass for this repository. properties: status: type: string description: Can be `enabled` or `disabled`. - secret_scanning_non_provider_patterns: + secret_scanning_delegated_bypass_options: type: object - 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)." + description: |- + Feature options for secret scanning delegated bypass. + This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`. + You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request. properties: - status: - type: string - description: Can be `enabled` or `disabled`. + reviewers: + type: array + description: |- + The bypass reviewers for secret scanning delegated bypass. + If you omit this field, the existing set of reviewers is unchanged. + 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 has_issues: type: boolean description: Either `true` to enable issues for this repository @@ -19037,6 +22225,8 @@ paths: "$ref": "#/components/responses/temporary_redirect" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19184,6 +22374,156 @@ paths: enabledForGitHubApps: true category: actions subcategory: artifacts + "/repos/{owner}/{repo}/actions/cache/retention-limit": + get: + summary: Get GitHub Actions cache retention limit for a repository + description: |- + Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-retention-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache retention limit for a repository + description: |- + Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if + not manually removed or evicted due to size constraints. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-retention-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-retention-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-retention-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-retention-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + "/repos/{owner}/{repo}/actions/cache/storage-limit": + get: + summary: Get GitHub Actions cache storage limit for a repository + description: |- + Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-storage-limit" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + put: + summary: Set GitHub Actions cache storage limit for a repository + description: |- + Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be + stored before eviction occurs. + + OAuth tokens and personal access tokens (classic) need the `admin:repository` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-storage-limit-for-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/cache#set-github-actions-cache-storage-limit-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-storage-limit-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-storage-limit" + responses: + '204': + description: Response + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache "/repos/{owner}/{repo}/actions/cache/usage": get: summary: Get GitHub Actions cache usage for a repository @@ -19688,6 +23028,8 @@ paths: "$ref": "#/components/schemas/actions-enabled" allowed_actions: "$ref": "#/components/schemas/allowed-actions" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled examples: @@ -19695,6 +23037,7 @@ paths: value: enabled: true allowed_actions: selected + sha_pinning_required: true x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -19769,19 +23112,19 @@ paths: previews: [] category: actions subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/selected-actions": + "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention": get: - summary: Get allowed actions and reusable workflows for a repository + summary: Get artifact and log retention settings for a repository description: |- - Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + Gets artifact and log retention settings for a repository. - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/get-allowed-actions-repository + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-artifact-and-log-retention-settings-repository tags: - actions externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/rest/actions/permissions#get-artifact-and-log-retention-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -19791,62 +23134,68 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/selected-actions" + "$ref": "#/components/schemas/actions-artifact-and-log-retention-response" examples: default: - "$ref": "#/components/examples/selected-actions" + value: + days: 90 + maximum_allowed_days: 365 + '404': + "$ref": "#/components/responses/not_found" x-github: enabledForGitHubApps: true - githubCloudOnly: false category: actions subcategory: permissions put: - summary: Set allowed actions and reusable workflows for a repository + summary: Set artifact and log retention settings for a repository description: |- - Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + Sets artifact and log retention settings for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. - operationId: actions/set-allowed-actions-repository + operationId: actions/set-artifact-and-log-retention-settings-repository tags: - actions externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + url: https://docs.github.com/rest/actions/permissions#set-artifact-and-log-retention-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': - description: Response + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" requestBody: - required: false + required: true content: application/json: schema: - "$ref": "#/components/schemas/selected-actions" + "$ref": "#/components/schemas/actions-artifact-and-log-retention" examples: - selected_actions: - "$ref": "#/components/examples/selected-actions" + default: + summary: Set retention days + value: + days: 90 x-github: enabledForGitHubApps: true - githubCloudOnly: false category: actions subcategory: permissions - "/repos/{owner}/{repo}/actions/permissions/workflow": + "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval": get: - summary: Get default workflow permissions for a repository + summary: Get fork PR contributor approval permissions for a repository description: |- - Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, - as well as if GitHub Actions can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + Gets the fork PR contributor approval policy for a repository. - OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-fork-pr-contributor-approval-permissions-repository tags: - actions - operationId: actions/get-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository + url: https://docs.github.com/rest/actions/permissions#get-fork-pr-contributor-approval-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -19856,146 +23205,349 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/actions-get-default-workflow-permissions" + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: - "$ref": "#/components/examples/actions-default-workflow-permissions" + "$ref": "#/components/examples/actions-fork-pr-contributor-approval" + '404': + "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions put: - summary: Set default workflow permissions for a repository + summary: Set fork PR contributor approval permissions for a repository description: |- - Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions - can submit approving pull request reviews. - For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + Sets the fork PR contributor approval policy for a repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-fork-pr-contributor-approval-permissions-repository tags: - actions - operationId: actions/set-github-actions-default-workflow-permissions-repository externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository + url: https://docs.github.com/rest/actions/permissions#set-fork-pr-contributor-approval-permissions-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" responses: '204': - description: Success response - '409': - description: Conflict response when changing a setting is prevented by the - owning organization + description: Response + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" requestBody: required: true content: application/json: schema: - "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + "$ref": "#/components/schemas/actions-fork-pr-contributor-approval" examples: default: - "$ref": "#/components/examples/actions-default-workflow-permissions" + summary: Set approval policy to first time contributors + value: + approval_policy: first_time_contributors x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions subcategory: permissions - "/repos/{owner}/{repo}/actions/runners": + "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos": get: - summary: List self-hosted runners for a repository + summary: Get private repo fork PR workflow settings for a repository description: |- - Lists all self-hosted runners configured in a repository. - - Authenticated users must have admin access to the repository to use this endpoint. + Gets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-private-repo-fork-pr-workflows-settings-repository tags: - actions - operationId: actions/list-self-hosted-runners-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + url: https://docs.github.com/rest/actions/permissions#get-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - - name: name - description: The name of a self-hosted runner. - in: query - schema: - type: string - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$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: integer - runners: - type: array - items: - "$ref": "#/components/schemas/runner" + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos" examples: default: - "$ref": "#/components/examples/runner-paginated" - headers: - Link: - "$ref": "#/components/headers/link" + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/downloads": - get: - summary: List runner applications for a repository + subcategory: permissions + put: + summary: Set private repo fork PR workflow settings for a repository description: |- - Lists binaries for the runner application that you can download and run. - - Authenticated users must have admin access to the repository to use this endpoint. + Sets the settings for whether workflows from fork pull requests can run on a private repository. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-private-repo-fork-pr-workflows-settings-repository tags: - actions - operationId: actions/list-runner-applications-for-repo externalDocs: description: API method documentation - url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + url: https://docs.github.com/rest/actions/permissions#set-private-repo-fork-pr-workflow-settings-for-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-fork-pr-workflows-private-repos-request" + examples: + default: + "$ref": "#/components/examples/actions-fork-pr-workflows-private-repos" responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/runner-application" - examples: - default: - "$ref": "#/components/examples/runner-application-items" + '204': + description: Empty response for successful settings update + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" x-github: - githubCloudOnly: false enabledForGitHubApps: true category: actions - subcategory: self-hosted-runners - "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": - post: - summary: Create configuration for a just-in-time runner for a repository - description: |- - Generates a configuration that can be passed to the runner application at startup. - + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/selected-actions": + get: + summary: Get allowed actions and reusable workflows for a repository + description: |- + Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + put: + summary: Set allowed actions and reusable workflows for a repository + description: |- + Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + operationId: actions/set-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/permissions/workflow": + get: + summary: Get default workflow permissions for a repository + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, + as well as if GitHub Actions can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-get-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + put: + summary: Set default workflow permissions for a repository + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in a repository, and sets if GitHub Actions + can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-repository + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Success response + '409': + description: Conflict response when changing a setting is prevented by the + owning organization + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: permissions + "/repos/{owner}/{repo}/actions/runners": + get: + summary: List self-hosted runners for a repository + description: |- + Lists all self-hosted runners configured in a repository. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-self-hosted-runners-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$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: integer + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + "/repos/{owner}/{repo}/actions/runners/downloads": + get: + summary: List runner applications for a repository + description: |- + Lists binaries for the runner application that you can download and run. + + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-runner-applications-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/runner-application" + examples: + default: + "$ref": "#/components/examples/runner-application-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: self-hosted-runners + "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": + post: + summary: Create configuration for a just-in-time runner for a repository + description: |- + Generates a configuration that can be passed to the runner application at startup. + The authenticated user must have admin access to the repository. OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. @@ -20056,6 +23608,8 @@ paths: "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed_simple" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20194,6 +23748,8 @@ paths: responses: '204': description: Response + '422': + "$ref": "#/components/responses/validation_failed_simple" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21150,7 +24706,7 @@ paths: value: x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: actions subcategory: workflow-runs "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": @@ -21203,12 +24759,19 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": get: summary: Get workflow run usage - description: |- - Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + description: "> [!WARNING] \n> This endpoint is in the process of closing down. + Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints + closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" + for more information.\n\nGets the number of billable minutes and total run + time for a specific workflow run. Billable minutes only apply to workflows + in private repositories that use GitHub-hosted runners. Usage is listed for + each GitHub-hosted runner operating system in milliseconds. Any job re-runs + are also included in the usage. The usage does not include the multiplier + for macOS and Windows runners and is not rounded up to the nearest whole minute. + For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone + with read access to the repository can use this endpoint.\n\nOAuth app tokens + and personal access tokens (classic) need the `repo` scope to use this endpoint + with a private repository." tags: - actions operationId: actions/get-workflow-run-usage @@ -21387,6 +24950,9 @@ paths: key_id: type: string description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id examples: default: value: @@ -21769,7 +25335,17 @@ paths: - "$ref": "#/components/parameters/workflow-id" responses: '204': - description: Response + description: Empty response when `return_run_details` parameter is `false`. + '200': + description: Response including the workflow run ID and URLs when `return_run_details` + parameter is `true`. + content: + application/json: + schema: + "$ref": "#/components/schemas/workflow-dispatch-response" + examples: + default: + "$ref": "#/components/examples/workflow-dispatch-response" requestBody: required: true content: @@ -21784,11 +25360,15 @@ paths: inputs: type: object description: Input keys and values configured in the workflow file. - The maximum number of properties is 10. Any default properties + The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. additionalProperties: true - maxProperties: 10 + maxProperties: 25 + return_run_details: + type: boolean + description: Whether the response should include the workflow run + ID and URLs. required: - ref examples: @@ -21890,14 +25470,20 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": get: summary: Get workflow usage - description: |- - Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - - You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - - Anyone with read access to the repository can use this endpoint. - - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + description: "> [!WARNING] \n> This endpoint is in the process of closing down. + Refer to \"[Actions Get workflow usage and Get workflow run usage endpoints + closing down](https://github.blog/changelog/2025-02-02-actions-get-workflow-usage-and-get-workflow-run-usage-endpoints-closing-down/)\" + for more information.\n\nGets the number of billable minutes used by a specific + workflow during the current billing cycle. Billable minutes only apply to + workflows in private repositories that use GitHub-hosted runners. Usage is + listed for each GitHub-hosted runner operating system in milliseconds. Any + job re-runs are also included in the usage. The usage does not include the + multiplier for macOS and Windows runners and is not rounded up to the nearest + whole minute. For more information, see \"[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou + can replace `workflow_id` with the workflow file name. For example, you could + use `main.yaml`.\n\nAnyone with read access to the repository can use this + endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the + `repo` scope to use this endpoint with a private repository." tags: - actions operationId: actions/get-workflow-usage @@ -22103,7 +25689,7 @@ paths: operationId: repos/create-attestation externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#create-an-attestation + url: https://docs.github.com/rest/repos/attestations#create-an-attestation parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -22160,7 +25746,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: repos - subcategory: repos + subcategory: attestations "/repos/{owner}/{repo}/attestations/{subject_digest}": get: summary: List attestations @@ -22175,7 +25761,7 @@ paths: operationId: repos/list-attestations externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/repos#list-attestations + url: https://docs.github.com/rest/repos/attestations#list-attestations parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" @@ -22190,6 +25776,15 @@ paths: schema: type: string x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -22223,6 +25818,8 @@ paths: type: integer bundle_url: type: string + initiator: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -22230,7 +25827,7 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: repos - subcategory: repos + subcategory: attestations "/repos/{owner}/{repo}/autolinks": get: summary: Get all autolinks of a repository @@ -25099,11 +28696,9 @@ paths: post: summary: Rerequest a check run description: |- - Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. + Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, the `status` of the check suite it belongs to is reset to `queued` and the `conclusion` is cleared. The check run itself is not updated. GitHub apps recieving the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) with the `rerequested` action should then decide if the check run should be reset or updated and call the [update `check_run` endpoint](https://docs.github.com/rest/checks/runs#update-a-check-run) to update the check_run if desired. For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". - - OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/rerequest-run @@ -25366,10 +28961,10 @@ paths: "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": post: summary: Rerequest a check suite - description: |- - Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - - OAuth apps and personal access tokens (classic) cannot use this endpoint. + description: Triggers GitHub to rerequest an existing check suite, without pushing + new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) + event with the action `rerequested`. When a check suite is `rerequested`, + its `status` is reset to `queued` and the `conclusion` is cleared. tags: - checks operationId: checks/rerequest-suite @@ -25448,6 +29043,14 @@ paths: required: false schema: "$ref": "#/components/schemas/code-scanning-alert-severity" + - name: assignees + description: | + Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`). + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -25541,8 +29144,15 @@ paths: "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason" dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - required: - - state + create_request: + "$ref": "#/components/schemas/code-scanning-alert-create-request" + assignees: + "$ref": "#/components/schemas/code-scanning-alert-assignees" + anyOf: + - required: + - state + - required: + - assignees examples: default: value: @@ -25550,6 +29160,7 @@ paths: dismissed_reason: false positive dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library. + create_request: true responses: '200': description: Response @@ -25560,6 +29171,8 @@ paths: examples: default: "$ref": "#/components/examples/code-scanning-alert-dismissed" + '400': + "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/code_scanning_forbidden_write" '404': @@ -25671,7 +29284,7 @@ paths: description: |- Commits an autofix for a code scanning alert. - If an autofix is commited as a result of this request, then this endpoint will return a 201 Created response. + If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. tags: @@ -25747,7 +29360,7 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/code-scanning-alert-instance" + "$ref": "#/components/schemas/code-scanning-alert-instance-list" examples: default: "$ref": "#/components/examples/code-scanning-alert-instances" @@ -25889,7 +29502,7 @@ paths: examples: response: "$ref": "#/components/examples/code-scanning-analysis-default" - application/json+sarif: + application/sarif+json: schema: type: object additionalProperties: true @@ -25900,6 +29513,8 @@ paths: "$ref": "#/components/responses/code_scanning_forbidden_read" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/unprocessable_analysis" '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -26468,6 +30083,8 @@ paths: "$ref": "#/components/responses/not_found" '409': "$ref": "#/components/responses/code_scanning_conflict" + '422': + "$ref": "#/components/responses/code_scanning_invalid_state" '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -27265,7 +30882,7 @@ paths: Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: - codespaces operationId: codespaces/create-or-update-repo-secret @@ -27320,7 +30937,7 @@ paths: description: |- Deletes a development environment secret in a repository using the secret name. - OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin. tags: - codespaces operationId: codespaces/delete-repo-secret @@ -27344,12 +30961,12 @@ paths: summary: List repository collaborators description: |- For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. - Organization members with write, maintain, or admin privileges on the organization-owned repository can use this endpoint. + The `permissions` hash returned in the response contains the base role permissions of the collaborator. The `role_name` is the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. Team members will include the members of child teams. - The authenticated user must have push access to the repository to use this endpoint. - + The authenticated user must have write, maintain, or admin privileges on the repository to use this endpoint. For organization-owned repositories, the authenticated user needs to be a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos @@ -27446,11 +31063,13 @@ paths: put: summary: Add a repository collaborator description: |- - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." + Add a user to a repository with a specified level of access. If the repository is owned by an organization, this API does not add the user to the organization - a user that has repository access without being an organization member is called an "outside collaborator" (if they are not an Enterprise Managed User) or a "repository collaborator" if they are an Enterprise Managed User. These users are exempt from some organization policies - see "[Adding outside collaborators to repositories](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization)" to learn more about these collaborator types. + + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). - Adding an outside collaborator may be restricted by enterprise administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." + Adding an outside collaborator may be restricted by enterprise and organization administrators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)" and "[Setting permissions for adding outside collaborators](https://docs.github.com/organizations/managing-organization-settings/setting-permissions-for-adding-outside-collaborators)" for organization settings. - For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the permission being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: + For more information on permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". There are restrictions on which permissions can be granted to organization members when an organization base role is in place. In this case, the role being given must be equal to or higher than the org base permission. Otherwise, the request will fail with: ``` Cannot assign {member} permission of {role name} @@ -27460,6 +31079,8 @@ paths: The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). + For Enterprise Managed Users, this endpoint does not send invitations - these users are automatically added to organizations and repositories. Enterprise Managed Users can only be added to organizations and repositories within their enterprise. + **Updating an existing collaborator's permission level** The endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed. @@ -27514,7 +31135,14 @@ paths: - an organization member is added as an individual collaborator - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator '422': - "$ref": "#/components/responses/validation_failed" + description: |- + Response when: + - validation failed, or the endpoint has been spammed + - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts + content: + application/json: + schema: + "$ref": "#/components/schemas/validation-error" '403': "$ref": "#/components/responses/forbidden" x-github: @@ -27531,8 +31159,8 @@ paths: To use this endpoint, the authenticated user must either be an administrator of the repository or target themselves for removal. This endpoint also: - - Cancels any outstanding invitations - - Unasigns the user from any issues + - Cancels any outstanding invitations sent by the collaborator + - Unassigns the user from any issues - Removes access to organization projects if the user is not an organization member and is not a collaborator on any other organization repositories. - Unstars the repository - Updates access permissions to packages @@ -27574,13 +31202,15 @@ paths: get: summary: Get repository permissions for a user description: |- - Checks the repository permission of a collaborator. The possible repository - permissions are `admin`, `write`, `read`, and `none`. + Checks the repository permission and role of a collaborator. + + The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the + `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. + The `role_name` attribute provides the name of the assigned role, including custom roles. The + `permission` can also be used to determine which base level of access the collaborator has to the repository. - *Note*: The `permission` attribute provides the legacy base roles of `admin`, `write`, `read`, and `none`, where the - `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the - collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The - `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + The calculated permissions are the highest role assigned to the collaborator after considering all sources of grants, including: repo, teams, organization, and enterprise. + There is presently not a way to differentiate between an organization level grant and a repository level grant from this endpoint response. tags: - repos operationId: repos/get-collaborator-permission-level @@ -28196,7 +31826,7 @@ paths: get: summary: List pull requests associated with a commit description: |- - Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit. + Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, it will return merged and open pull requests associated with the commit. To list the open or merged pull requests associated with a branch, you can set the `commit_sha` parameter to the branch name. tags: @@ -28712,6 +32342,23 @@ paths: required: false schema: type: string + requestBody: + required: false + content: + application/json: + examples: + response-if-content-is-a-file-github-object: + summary: Content is a file using the object media type + response-if-content-is-a-directory-github-object: + summary: Content is a directory using the object media type + response-if-content-is-a-file: + summary: Content is a file + response-if-content-is-a-directory: + summary: Content is a directory + response-if-content-is-a-symlink: + summary: Content is a symlink + response-if-content-is-a-submodule: + summary: Content is a submodule responses: '200': description: Response @@ -28720,9 +32367,9 @@ paths: schema: "$ref": "#/components/schemas/content-tree" examples: - response-if-content-is-a-file: + response-if-content-is-a-file-github-object: "$ref": "#/components/examples/content-file-response-if-content-is-a-file" - response-if-content-is-a-directory: + response-if-content-is-a-directory-github-object: "$ref": "#/components/examples/content-file-response-if-content-is-a-directory-object" application/json: schema: @@ -29072,29 +32719,14 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-comma-separated-packages" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-manifests" - "$ref": "#/components/parameters/dependabot-alert-comma-separated-epss" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-has" + - "$ref": "#/components/parameters/dependabot-alert-comma-separated-assignees" - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - name: page - 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: - type: integer - default: 1 - - name: per_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)." - deprecated: true - in: query - schema: - type: integer - default: 30 - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - - "$ref": "#/components/parameters/pagination-first" - - "$ref": "#/components/parameters/pagination-last" + - "$ref": "#/components/parameters/per-page" responses: '200': description: Response @@ -29207,8 +32839,19 @@ paths: description: An optional comment associated with dismissing the alert. maxLength: 280 - required: - - state + assignees: + type: array + description: |- + Usernames to assign to this Dependabot Alert. + Pass one or more user logins to _replace_ the set of assignees on this alert. + Send an empty array (`[]`) to clear all assignees from the alert. + items: + type: string + anyOf: + - required: + - state + - required: + - assignees additionalProperties: false examples: default: @@ -30598,7 +34241,7 @@ paths: The authenticated user must have admin or owner permissions to the repository to use this endpoint. - For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules). OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: @@ -31899,7 +35542,8 @@ paths: '204': description: Response '422': - "$ref": "#/components/responses/validation_failed" + description: Validation failed, an attempt was made to delete the default + branch, or the endpoint has been spammed. '409': "$ref": "#/components/responses/conflict" x-github: @@ -32772,6 +36416,86 @@ paths: enabledForGitHubApps: true category: repos subcategory: webhooks + "/repos/{owner}/{repo}/immutable-releases": + get: + summary: Check if immutable releases are enabled for a repository + description: |- + Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being + enforced by the repository owner. The authenticated user must have admin read access to the repository. + tags: + - repos + operationId: repos/check-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-immutable-releases-are-enabled-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Response if immutable releases are enabled + content: + application/json: + schema: + "$ref": "#/components/schemas/check-immutable-releases" + examples: + default: + value: + enabled: true + enforced_by_owner: false + '404': + description: Not Found if immutable releases are not enabled for the repository + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + put: + summary: Enable immutable releases + description: Enables immutable releases for a repository. The authenticated + user must have admin access to the repository. + tags: + - repos + operationId: repos/enable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#enable-immutable-releases + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + delete: + summary: Disable immutable releases + description: Disables immutable releases for a repository. The authenticated + user must have admin access to the repository. + tags: + - repos + operationId: repos/disable-immutable-releases + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#disable-immutable-releases + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + "$ref": "#/components/responses/no_content" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos "/repos/{owner}/{repo}/import": get: summary: Get an import status @@ -33564,6 +37288,14 @@ paths: required: false schema: type: string + - name: type + description: Can be the name of an issue type. If the string `*` is passed, + issues with any type are accepted. If the string `none` is passed, issues + without type are returned. + in: query + required: false + schema: + type: string - name: creator description: The user that created the issue. in: query @@ -33698,6 +37430,13 @@ paths: are silently dropped otherwise._' items: type: string + type: + type: string + description: 'The name of the issue type to associate with this + issue. _NOTE: Only users with push access can set the type for + new issues. The type is silently dropped otherwise._' + nullable: true + example: Epic required: - title examples: @@ -33918,6 +37657,84 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/comments/{comment_id}/pin": + put: + summary: Pin an issue comment + description: |- + You can use the REST API to pin comments on issues. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/pin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#pin-an-issue-comment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/comment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue-comment" + examples: + default: + "$ref": "#/components/examples/issue-comment-pinned" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments + delete: + summary: Unpin an issue comment + description: You can use the REST API to unpin comments on issues. + tags: + - issues + operationId: issues/unpin-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/comments#unpin-an-issue-comment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/comment-id" + responses: + '204': + description: Response + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: comments "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": get: summary: List reactions for an issue comment @@ -34172,6 +37989,15 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/issue-number" + requestBody: + required: false + content: + application/json: + examples: + default: + summary: Get an issue + pinned_comment: + summary: Get an issue with a pinned comment responses: '200': description: Response @@ -34181,7 +38007,13 @@ paths: "$ref": "#/components/schemas/issue" examples: default: - "$ref": "#/components/examples/issue" + summary: Issue + value: + "$ref": "#/components/examples/issue" + pinned_comment: + summary: Issue with pinned comment + value: + "$ref": "#/components/examples/issue-with-pinned-comment" '301': "$ref": "#/components/responses/moved_permanently" '404': @@ -34249,6 +38081,7 @@ paths: enum: - completed - not_planned + - duplicate - reopened nullable: true description: The reason for the state change. Ignored unless `state` @@ -34294,6 +38127,14 @@ paths: push access to the repository, assignee changes are silently dropped. items: type: string + type: + type: string + description: The name of the issue type to associate with this issue + or use `null` to remove the current issue type. Only users with + push access can set the type for issues. Without push access to + the repository, type changes are silently dropped. + nullable: true + example: Epic examples: default: value: @@ -34589,6 +38430,237 @@ paths: enabledForGitHubApps: true category: issues subcategory: comments + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by": + get: + summary: List dependencies an issue is blocked by + description: |- + You can use the REST API to list the dependencies an issue is blocked by. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + post: + summary: Add a dependency an issue is blocked by + description: |- + You can use the REST API to add a 'blocked by' relationship to an issue. + + Creating content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/add-blocked-by-dependency + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#add-a-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + issue_id: + type: integer + description: The id of the issue that blocks the current issue + required: + - issue_id + examples: + default: + value: + issue_id: 1 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + headers: + Location: + example: https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by + schema: + type: string + '301': + "$ref": "#/components/responses/moved_permanently" + '403': + "$ref": "#/components/responses/forbidden" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}": + delete: + summary: Remove dependency an issue is blocked by + description: |- + You can use the REST API to remove a dependency that an issue is blocked by. + + Removing content too quickly using this endpoint may result in secondary rate limiting. + For more information, see [Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits) + and [Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api). + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass a specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/remove-dependency-blocked-by + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#remove-dependency-an-issue-is-blocked-by + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - name: issue_id + in: path + description: The id of the blocking issue to remove as a dependency + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '400': + "$ref": "#/components/responses/bad_request" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies + "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking": + get: + summary: List dependencies an issue is blocking + description: |- + You can use the REST API to list the dependencies an issue is blocking. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/list-dependencies-blocking + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/issue-dependencies#list-dependencies-an-issue-is-blocking + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue-items" + headers: + Link: + "$ref": "#/components/headers/link" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: issue-dependencies "/repos/{owner}/{repo}/issues/{issue_number}/events": get: summary: List issue events @@ -34671,8 +38743,7 @@ paths: subcategory: labels post: summary: Add labels to an issue - description: 'Adds labels to an issue. If you provide an empty array of labels, - all labels are removed from the issue. ' + description: Adds labels to an issue. tags: - issues operationId: issues/add-labels @@ -34695,31 +38766,16 @@ paths: type: array minItems: 1 description: The names of the labels to add to the issue's existing - labels. You can pass an empty array to remove all labels. Alternatively, - you can pass a single label as a `string` or an `array` of labels - directly, but GitHub recommends passing an object with the `labels` - key. You can also replace all of the labels for an issue. For - more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." + labels. You can also pass an `array` of labels directly, but + GitHub recommends passing an object with the `labels` key. To + replace all of the labels for an issue, use "[Set labels for + an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." items: type: string - type: array - minItems: 1 items: type: string - - type: object - properties: - labels: - type: array - minItems: 1 - items: - type: object - properties: - name: - type: string - required: - - name - type: array - minItems: 1 items: type: object properties: @@ -34727,7 +38783,6 @@ paths: type: string required: - name - - type: string examples: default: value: @@ -35001,6 +39056,49 @@ paths: enabledForGitHubApps: true category: issues subcategory: issues + "/repos/{owner}/{repo}/issues/{issue_number}/parent": + get: + summary: Get parent issue + description: |- + You can use the REST API to get the parent issue of a sub-issue. + + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). + + - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + tags: + - issues + operationId: issues/get-parent + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/issues/sub-issues#get-parent-issue + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/issue-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/issue" + examples: + default: + "$ref": "#/components/examples/issue" + '301': + "$ref": "#/components/responses/moved_permanently" + '404': + "$ref": "#/components/responses/not_found" + '410': + "$ref": "#/components/responses/gone" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: issues + subcategory: sub-issues "/repos/{owner}/{repo}/issues/{issue_number}/reactions": get: summary: List reactions for an issue @@ -35121,7 +39219,7 @@ paths: "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: reactions subcategory: reactions "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}": @@ -35221,11 +39319,11 @@ paths: description: |- You can use the REST API to list the sub-issues on an issue. - This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + This endpoint supports the following custom media types. For more information, see [Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types). - - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github.raw+json`**: Returns the raw Markdown body. Response will include `body`. This is the default if you do not pass any specific media type. + - **`application/vnd.github.text+json`**: Returns a text only representation of the Markdown body. Response will include `body_text`. + - **`application/vnd.github.html+json`**: Returns HTML rendered from the body's Markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - issues @@ -35298,7 +39396,7 @@ paths: sub_issue_id: type: integer description: The id of the sub-issue to add. The sub-issue must - belong to the same repository as the parent issue + belong to the same repository owner as the parent issue replace_parent: type: boolean description: Option that, when true, instructs the operation to @@ -36831,7 +40929,6 @@ paths: environment: github-pages pages_build_version: 4fd754f7e594640989b406850d0bc8f06a121251 oidc_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA - preview: false responses: '200': description: Response @@ -37052,125 +41149,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/projects": - get: - summary: List repository projects - description: Lists the projects in a repository. Returns a `404 Not Found` status - if projects are disabled in the repository. If you do not have sufficient - privileges to perform this action, a `401 Unauthorized` or `410 Gone` status - is returned. - tags: - - projects - operationId: projects/list-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-repository-projects - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - name: state - description: Indicates the state of the projects to return. - in: query - required: false - schema: - type: string - enum: - - open - - closed - - all - default: open - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-items-2" - headers: - Link: - "$ref": "#/components/headers/link" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects - post: - summary: Create a repository project - description: Creates a repository project board. Returns a `410 Gone` status - if projects are disabled in the repository or if the repository does not have - existing classic projects. If you do not have sufficient privileges to perform - this action, a `401 Unauthorized` or `410 Gone` status is returned. - tags: - - projects - operationId: projects/create-for-repo - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#create-a-repository-project - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the project. - body: - type: string - description: The description of the project. - required: - - name - examples: - default: - value: - name: Projects Documentation - body: Developer documentation project for the developer site. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project-3" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '410': - "$ref": "#/components/responses/gone" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects "/repos/{owner}/{repo}/properties/values": get: summary: Get all custom property values for a repository @@ -37179,7 +41157,7 @@ paths: Users with read access to the repository can use this endpoint. tags: - repos - operationId: repos/get-custom-properties-values + operationId: repos/custom-properties-for-repos-get-repository-values externalDocs: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository @@ -37216,7 +41194,7 @@ paths: Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. tags: - repos - operationId: repos/create-or-update-custom-properties-values + operationId: repos/custom-properties-for-repos-create-or-update-repository-values externalDocs: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository @@ -40334,6 +44312,8 @@ paths: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" "/repos/{owner}/{repo}/rulesets/rule-suites": @@ -40550,6 +44530,8 @@ paths: "$ref": "#/components/examples/repository-ruleset" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" '500': "$ref": "#/components/responses/internal_error" delete: @@ -40582,6 +44564,92 @@ paths: "$ref": "#/components/responses/not_found" '500': "$ref": "#/components/responses/internal_error" + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history": + get: + summary: Get repository ruleset history + description: Get the history of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-history + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-history + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ruleset-version" + examples: + default: + "$ref": "#/components/examples/ruleset-history" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules + "/repos/{owner}/{repo}/rulesets/{ruleset_id}/history/{version_id}": + get: + summary: Get repository ruleset version + description: Get a version of a repository ruleset. + tags: + - repos + operationId: repos/get-repo-ruleset-version + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/rules#get-repository-ruleset-version + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + - name: version_id + description: The ID of the version + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ruleset-version-with-state" + examples: + default: + "$ref": "#/components/examples/repository-ruleset-version-with-state" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: rules "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository @@ -40603,6 +44671,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-state" - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-assignee" - "$ref": "#/components/parameters/secret-scanning-alert-sort" - "$ref": "#/components/parameters/direction" - "$ref": "#/components/parameters/page" @@ -40612,6 +44681,7 @@ paths: - "$ref": "#/components/parameters/secret-scanning-alert-validity" - "$ref": "#/components/parameters/secret-scanning-alert-publicly-leaked" - "$ref": "#/components/parameters/secret-scanning-alert-multi-repo" + - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response @@ -40653,6 +44723,7 @@ paths: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - "$ref": "#/components/parameters/alert-number" + - "$ref": "#/components/parameters/secret-scanning-alert-hide-secret" responses: '200': description: Response @@ -40680,6 +44751,8 @@ paths: description: |- Updates the status of a secret scanning alert in an eligible repository. + You can also use this endpoint to assign or unassign an alert to a user who has write access to the repository. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. @@ -40706,13 +44779,26 @@ paths: "$ref": "#/components/schemas/secret-scanning-alert-resolution" resolution_comment: "$ref": "#/components/schemas/secret-scanning-alert-resolution-comment" - required: - - state + assignee: + "$ref": "#/components/schemas/secret-scanning-alert-assignee" + anyOf: + - required: + - state + - required: + - assignee examples: default: value: state: resolved resolution: false_positive + assign: + summary: Assign alert to a user + value: + assignee: octocat + unassign: + summary: Unassign alert + value: + assignee: responses: '200': description: Response @@ -40730,7 +44816,8 @@ paths: description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found '422': - description: State does not match the resolution or resolution comment + description: State does not match the resolution or resolution comment, + or assignee does not have write access to the repository '503': "$ref": "#/components/responses/service_unavailable" x-github: @@ -40852,6 +44939,9 @@ paths: description: |- Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included. + > [!NOTE] + > This endpoint requires [GitHub Advanced Security](https://docs.github.com/get-started/learning-about-github/about-github-advanced-security)." + OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. tags: - secret-scanning @@ -41832,139 +45922,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repos/{owner}/{repo}/tags/protection": - get: - summary: Closing down - List tag protection states for a repository - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. - - This returns the tag protection states of a repository. - - This information is only available to repository administrators. - tags: - - repos - operationId: repos/list-tag-protection - externalDocs: - description: API method documentation - 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" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/tag-protection" - examples: - default: - "$ref": "#/components/examples/tag-protection-items" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: tags - deprecationDate: '2024-05-29' - removalDate: '2024-08-30' - deprecated: true - post: - summary: Closing down - Create a tag protection state for a repository - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. - - This creates a tag protection state for a repository. - This endpoint is only available to repository administrators. - tags: - - repos - operationId: repos/create-tag-protection - externalDocs: - description: API method documentation - 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" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - pattern: - type: string - description: An optional glob pattern to match against when enforcing - tag protection. - required: - - pattern - examples: - default: - value: - pattern: v1.* - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/tag-protection" - examples: - default: - "$ref": "#/components/examples/tag-protection" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: tags - deprecationDate: '2024-05-29' - removalDate: '2024-08-30' - deprecated: true - "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": - delete: - summary: Closing down - Delete a tag protection state for a repository - description: |- - > [!WARNING] - > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. - - This deletes a tag protection state for a repository. - This endpoint is only available to repository administrators. - tags: - - repos - operationId: repos/delete-tag-protection - externalDocs: - description: API method documentation - 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" - - "$ref": "#/components/parameters/tag-protection-id" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: repos - subcategory: tags - deprecationDate: '2024-05-29' - removalDate: '2024-08-30' - deprecated: true "/repos/{owner}/{repo}/tarball/{ref}": get: summary: Download a repository archive (tar) @@ -42347,7 +46304,7 @@ paths: description: Not Found if repository is not enabled with vulnerability alerts x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: repos subcategory: repos put: @@ -42801,6 +46758,7 @@ paths: - "$ref": "#/components/parameters/order" - "$ref": "#/components/parameters/per-page" - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/issues-advanced-search" responses: '200': description: Response @@ -43317,706 +47275,6 @@ paths: category: teams subcategory: teams deprecated: true - "/teams/{team_id}/discussions": - get: - summary: List discussions (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - - List all discussions on a team's page. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - post: - summary: Create a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - - Creates a new discussion post on a team's page. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - private: - type: boolean - description: Private posts are only visible to team members, organization - owners, and team maintainers. Public posts are visible to all - members of the organization. Set to `true` to create a private - post. - default: false - required: - - title - - body - examples: - default: - value: - title: Our first team post - body: Hi! This is an area for us to collaborate as a team. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}": - get: - summary: Get a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - - Get a specific discussion on a team's page. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - patch: - summary: Update a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - - Edits the title and body text of a discussion post. Only the parameters you provide are updated. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - title: - type: string - description: The discussion post's title. - body: - type: string - description: The discussion post's body text. - examples: - default: - value: - title: Welcome to our first team post - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion" - examples: - default: - "$ref": "#/components/examples/team-discussion-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - delete: - summary: Delete a discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - - Delete a discussion from a team's page. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments": - get: - summary: List discussion comments (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - - List all comments on a team discussion. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/list-discussion-comments-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - post: - summary: Create a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - - Creates a new comment on a team discussion. - - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/create-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like apples? - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - triggersNotification: true - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": - get: - summary: Get a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - - Get a specific comment on a team discussion. - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/get-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - patch: - summary: Update a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - - Edits the body text of a discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/update-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - body: - type: string - description: The discussion comment's body text. - required: - - body - examples: - default: - value: - body: Do you like pineapples? - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-discussion-comment" - examples: - default: - "$ref": "#/components/examples/team-discussion-comment-2" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - delete: - summary: Delete a discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - - Deletes a comment on a team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - teams - operationId: teams/delete-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: discussion-comments - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": - get: - summary: List reactions for a team discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion comment. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion comment (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-comment-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - "$ref": "#/components/parameters/comment-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion comment. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - "/teams/{team_id}/discussions/{discussion_number}/reactions": - get: - summary: List reactions for a team discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/list-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - - name: content - description: Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). - Omit this parameter to list all reactions to a team discussion. - in: query - required: false - schema: - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction-items" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true - post: - summary: Create reaction for a team discussion (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). - - A response with an HTTP `200` status means that you already added the reaction type to this team discussion. - - OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. - tags: - - reactions - operationId: reactions/create-for-team-discussion-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/discussion-number" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - content: - type: string - description: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) - to add to the team discussion. - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - required: - - content - examples: - default: - value: - content: heart - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/reaction" - examples: - default: - "$ref": "#/components/examples/reaction" - x-github: - githubCloudOnly: false - enabledForGitHubApps: false - removalDate: '2021-02-21' - deprecationDate: '2020-02-26' - category: reactions - subcategory: reactions - deprecated: true "/teams/{team_id}/invitations": get: summary: List pending team invitations (Legacy) @@ -44368,188 +47626,6 @@ paths: category: teams subcategory: members deprecated: true - "/teams/{team_id}/projects": - get: - summary: List team projects (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. - - Lists the organization projects for a team. - tags: - - teams - operationId: teams/list-projects-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project-items" - headers: - Link: - "$ref": "#/components/headers/link" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - "/teams/{team_id}/projects/{project_id}": - get: - summary: Check team permissions for a project (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a 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: - - teams - operationId: teams/check-permissions-for-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/team-project" - examples: - default: - "$ref": "#/components/examples/team-project" - '404': - description: Not Found if project is not managed by this team - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - put: - summary: Add or update team project permissions (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team 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: - - teams - operationId: teams/add-or-update-project-permissions-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - requestBody: - required: false - content: - application/json: - schema: - type: object - properties: - permission: - type: string - description: 'The permission to grant to the team for this project. - Default: the team''s `permission` attribute will be used to determine - what permission to grant the team on this project. Note that, - if you choose not to pass any parameters, you''ll need to set - `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' - enum: - - read - - write - - admin - examples: - default: - summary: Example of setting permission to read - value: - permission: read - responses: - '204': - description: Response - '403': - description: Forbidden if the project is not owned by the organization - content: - application/json: - schema: - type: object - properties: - message: - type: string - documentation_url: - type: string - examples: - response-if-the-project-is-not-owned-by-the-organization: - value: - message: Must have admin rights to Repository. - documentation_url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true - delete: - summary: Remove a project from a team (Legacy) - description: |- - > [!WARNING] - > **Endpoint closing down notice:** This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a 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: - - teams - operationId: teams/remove-project-legacy - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy - parameters: - - "$ref": "#/components/parameters/team-id" - - "$ref": "#/components/parameters/project-id" - responses: - '204': - description: Response - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - removalDate: '2021-02-01' - deprecationDate: '2020-01-21' - category: teams - subcategory: teams - deprecated: true "/teams/{team_id}/repos": get: summary: List team repositories (Legacy) @@ -46738,7 +49814,8 @@ paths: repositories: type: array items: - "$ref": "#/components/schemas/repository" + allOf: + - "$ref": "#/components/schemas/repository" examples: default: "$ref": "#/components/examples/repository-paginated" @@ -47047,7 +50124,7 @@ paths: description: |- Adds a public SSH key to the authenticated user's GitHub account. - OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `write:public_key` scope to use this endpoint. operationId: users/create-public-ssh-key-for-authenticated-user tags: - users @@ -48078,68 +51155,6 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/user/projects": - post: - summary: Create a user project - description: Creates a user project board. Returns a `410 Gone` status if the - user does not have existing classic projects. If you do not have sufficient - privileges to perform this action, a `401 Unauthorized` or `410 Gone` status - is returned. - tags: - - projects - operationId: projects/create-for-authenticated-user - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/projects/projects#create-a-user-project - parameters: [] - requestBody: - required: true - content: - application/json: - schema: - properties: - name: - description: Name of the project - example: Week One Sprint - type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in - January - type: string - nullable: true - required: - - name - type: object - examples: - default: - summary: Create a new project - value: - name: My Projects - body: A board to manage my personal projects. - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/project" - examples: - default: - "$ref": "#/components/examples/project" - '304': - "$ref": "#/components/responses/not_modified" - '403': - "$ref": "#/components/responses/forbidden" - '401': - "$ref": "#/components/responses/requires_authentication" - '422': - "$ref": "#/components/responses/validation_failed_simple" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: projects - subcategory: projects "/user/public_emails": get: summary: List public email addresses for the authenticated user @@ -48274,6 +51289,9 @@ paths: examples: default: "$ref": "#/components/examples/repository-items-default-response" + headers: + Link: + "$ref": "#/components/headers/link" '422': "$ref": "#/components/responses/validation_failed" '304': @@ -49199,6 +52217,68 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/user/{user_id}/projectsV2/{project_number}/drafts": + post: + summary: Create draft item for user owned project + description: Create draft issue item for the specified user owned project. + tags: + - projects + operationId: projects/create-draft-item-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/drafts#create-draft-item-for-user-owned-project + parameters: + - "$ref": "#/components/parameters/user-id" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + description: Details of the draft item to create in the project. + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The title of the draft issue item to create in the + project. + body: + type: string + description: The body content of the draft issue item to create + in the project. + required: + - title + examples: + title: + summary: Example with Sample Draft Issue Title + value: + title: Sample Draft Issue Title + body: + summary: Example with Sample Draft Issue Title and Body + value: + title: Sample Draft Issue Title + body: This is the body content of the draft issue. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + draft_issue: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: drafts "/users": get: summary: List users @@ -49239,6 +52319,126 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/users/{user_id}/projectsV2/{project_number}/views": + post: + summary: Create a view for a user-owned project + description: Create a new view in a user-owned project. Views allow you to customize + how items in a project are displayed and filtered. + tags: + - projects + operationId: projects/create-view-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/views#create-a-view-for-a-user-owned-project + parameters: + - "$ref": "#/components/parameters/user-id" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the view. + example: Sprint Board + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + example: board + filter: + type: string + description: The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + example: is:issue is:open + visible_fields: + type: array + description: |- + `visible_fields` is not applicable to `roadmap` layout views. + For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used. + items: + type: integer + example: + - 123 + - 456 + - 789 + required: + - name + - layout + additionalProperties: false + examples: + table_view: + summary: Create a table view + value: + name: All Issues + layout: table + filter: is:issue + visible_fields: + - 123 + - 456 + - 789 + board_view: + summary: Create a board view with filter + value: + name: Sprint Board + layout: board + filter: is:issue is:open label:sprint + visible_fields: + - 123 + - 456 + - 789 + roadmap_view: + summary: Create a roadmap view + value: + name: Product Roadmap + layout: roadmap + responses: + '201': + description: Response for creating a view in a user-owned project. + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-view" + examples: + table_view: + summary: Response for creating a table view + value: + "$ref": "#/components/examples/projects-v2-view" + board_view: + summary: Response for creating a board view with filter + value: + "$ref": "#/components/examples/projects-v2-view" + roadmap_view: + summary: Response for creating a roadmap view + value: + "$ref": "#/components/examples/projects-v2-view" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + '503': + description: Service unavailable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: views "/users/{username}": get: summary: Get a user @@ -49284,6 +52484,243 @@ paths: enabledForGitHubApps: true category: users subcategory: users + "/users/{username}/attestations/bulk-list": + post: + summary: List attestations by bulk subject digests + description: |- + List a collection of artifact attestations associated with any entry in a list of subject digests owned by a user. + + The collection of attestations returned by this endpoint is filtered according to the authenticated user's permissions; if the authenticated user cannot read a repository, the attestations associated with that repository will not be included in the response. In addition, when using a fine-grained access token the `attestations:read` permission is required. + + **Please note:** in order to offer meaningful security benefits, an attestation's signature and timestamps **must** be cryptographically verified, and the identity of the attestation signer **must** be validated. Attestations can be verified using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). For more information, see [our guide on how to use artifact attestations to establish a build's provenance](https://docs.github.com/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds). + tags: + - users + operationId: users/list-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#list-attestations-by-bulk-subject-digests + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests to fetch attestations for. + minItems: 1 + maxItems: 1024 + predicate_type: + type: string + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + required: + - subject_digests + examples: + default: + "$ref": "#/components/examples/bulk-subject-digest-body" + withPredicateType: + "$ref": "#/components/examples/bulk-subject-digest-body-with-predicate-type" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + attestations_subject_digests: + type: object + additionalProperties: + nullable: true + type: array + items: + type: object + properties: + bundle: + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: The bundle of the attestation. + repository_id: + type: integer + bundle_url: + type: string + description: Mapping of subject digest to bundles. + page_info: + type: object + properties: + has_next: + type: boolean + description: Indicates whether there is a next page. + has_previous: + type: boolean + description: Indicates whether there is a previous page. + next: + type: string + description: The cursor to the next page. + previous: + type: string + description: The cursor to the previous page. + description: Information about the current page. + examples: + default: + "$ref": "#/components/examples/list-attestations-bulk" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + "/users/{username}/attestations/delete-request": + post: + summary: Delete attestations in bulk + description: Delete artifact attestations in bulk by either subject digests + or unique ID. + tags: + - users + operationId: users/delete-attestations-bulk + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-in-bulk + parameters: + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + oneOf: + - properties: + subject_digests: + type: array + items: + type: string + description: List of subject digests associated with the artifact + attestations to delete. + minItems: 1 + maxItems: 1024 + required: + - subject_digests + - properties: + attestation_ids: + type: array + items: + type: integer + description: List of unique IDs associated with the artifact attestations + to delete. + minItems: 1 + maxItems: 1024 + required: + - attestation_ids + description: The request body must include either `subject_digests` + or `attestation_ids`, but not both. + examples: + by-subject-digests: + summary: Delete by subject digests + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + by-attestation-ids: + summary: Delete by attestation IDs + value: + attestation_ids: + - 111 + - 222 + responses: + '200': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + "/users/{username}/attestations/digest/{subject_digest}": + delete: + summary: Delete attestations by subject digest + description: Delete an artifact attestation by subject digest. + tags: + - users + operationId: users/delete-attestations-by-subject-digest + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-by-subject-digest + parameters: + - "$ref": "#/components/parameters/username" + - name: subject_digest + description: Subject Digest + in: path + required: true + schema: + type: string + x-multi-segment: true + responses: + '200': + description: Response + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations + "/users/{username}/attestations/{attestation_id}": + delete: + summary: Delete attestations by ID + description: Delete an artifact attestation by unique ID that is associated + with a repository owned by a user. + tags: + - users + operationId: users/delete-attestations-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/users/attestations#delete-attestations-by-id + parameters: + - "$ref": "#/components/parameters/username" + - name: attestation_id + description: Attestation ID + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: attestations "/users/{username}/attestations/{subject_digest}": get: summary: List attestations @@ -49311,6 +52748,15 @@ paths: schema: type: string x-multi-segment: true + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, `release`, or freeform text + for custom predicate types. + in: query + required: false + schema: + type: string responses: '200': description: Response @@ -49325,14 +52771,30 @@ paths: type: object properties: bundle: - "$ref": "#/components/schemas/sigstore-bundle-0" + type: object + properties: + mediaType: + type: string + verificationMaterial: + type: object + properties: {} + additionalProperties: true + dsseEnvelope: + type: object + properties: {} + additionalProperties: true + description: |- + The attestation's Sigstore Bundle. + Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer bundle_url: type: string + initiator: + type: string examples: default: - value: + "$ref": "#/components/examples/list-attestations" '201': description: Response content: @@ -50125,31 +53587,28 @@ paths: enabledForGitHubApps: false category: packages subcategory: packages - "/users/{username}/projects": + "/users/{username}/projectsV2": get: - summary: List user projects - description: Lists projects for a user. + summary: List projects for user + description: List all projects owned by a specific user accessible by the authenticated + user. tags: - projects operationId: projects/list-for-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/projects/projects#list-user-projects + url: https://docs.github.com/rest/projects/projects#list-projects-for-user parameters: - "$ref": "#/components/parameters/username" - - name: state - description: Indicates the state of the projects to return. + - name: q + description: Limit results to projects of the specified type. in: query required: false schema: type: string - enum: - - open - - closed - - all - default: open + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -50158,20 +53617,687 @@ paths: schema: type: array items: - "$ref": "#/components/schemas/project" + "$ref": "#/components/schemas/projects-v2" examples: default: - "$ref": "#/components/examples/project-items-3" + "$ref": "#/components/examples/projects-v2" headers: Link: "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/users/{username}/projectsV2/{project_number}": + get: + summary: Get project for user + description: Get a specific user-owned project. + tags: + - projects + operationId: projects/get-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/projects#get-project-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2" + examples: + default: + "$ref": "#/components/examples/projects-v2" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/users/{username}/projectsV2/{project_number}/fields": + get: + summary: List project fields for user + description: List all fields for a specific user-owned project. + tags: + - projects + operationId: projects/list-fields-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#list-project-fields-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field-items" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + post: + summary: Add field to user owned project + description: Add a field to a specified user owned project. + tags: + - projects + operationId: projects/add-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#add-field-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - text + - number + - date + required: + - name + - data_type + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - single_select + single_select_options: + type: array + description: The options available for single select fields. At + least one option must be provided when creating a single select + field. + items: + "$ref": "#/components/schemas/projects-v2-field-single-select-option" + required: + - name + - data_type + - single_select_options + additionalProperties: false + - type: object + properties: + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - iteration + iteration_configuration: + "$ref": "#/components/schemas/projects-v2-field-iteration-configuration" + required: + - name + - data_type + - iteration_configuration + additionalProperties: false + examples: + text_field: + summary: Create a text field + value: + name: Team notes + data_type: text + number_field: + summary: Create a number field + value: + name: Story points + data_type: number + date_field: + summary: Create a date field + value: + name: Due date + data_type: date + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select-request" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration-request" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-field-text" + number_field: + "$ref": "#/components/examples/projects-v2-field-number" + date_field: + "$ref": "#/components/examples/projects-v2-field-date" + single_select_field: + "$ref": "#/components/examples/projects-v2-field-single-select" + iteration_field: + "$ref": "#/components/examples/projects-v2-field-iteration" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" '422': "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/users/{username}/projectsV2/{project_number}/fields/{field_id}": + get: + summary: Get project field for user + description: Get a specific field for a user-owned project. + tags: + - projects + operationId: projects/get-field-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/fields#get-project-field-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/field-id" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-field" + examples: + default: + "$ref": "#/components/examples/projects-v2-field" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: fields + "/users/{username}/projectsV2/{project_number}/items": + get: + summary: List items for a user owned project + description: List all items for a specific user-owned project accessible by + the authenticated user. + tags: + - projects + operationId: projects/list-items-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-a-user-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + - name: q + description: Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) + for more information. + in: query + required: false + schema: + type: string + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + post: + summary: Add item to user owned project + description: Add an issue or pull request item to the specified user owned project. + tags: + - projects + operationId: projects/add-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#add-item-to-user-owned-project + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/project-number" + requestBody: + required: true + description: Details of the item to add to the project. You can specify either + the unique ID or the repository owner, name, and issue/PR number. + content: + application/json: + schema: + type: object + additionalProperties: false + properties: + type: + type: string + enum: + - Issue + - PullRequest + description: The type of item to add to the project. Must be either + Issue or PullRequest. + id: + type: integer + description: The unique identifier of the issue or pull request + to add to the project. + owner: + type: string + description: The repository owner login. + repo: + type: string + description: The repository name. + number: + type: integer + description: The issue or pull request number. + required: + - type + oneOf: + - required: + - id + - required: + - owner + - repo + - number + examples: + issue_with_id: + summary: Add an issue using its unique ID + value: + type: Issue + id: 3 + pull_request_with_id: + summary: Add a pull request using its unique ID + value: + type: PullRequest + id: 3 + issue_with_nwo: + summary: Add an issue using repository owner, name, and issue number + value: + type: Issue + owner: octocat + repo: hello-world + number: 42 + pull_request_with_nwo: + summary: Add a pull request using repository owner, name, and PR number + value: + type: PullRequest + owner: octocat + repo: hello-world + number: 123 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-simple" + examples: + issue_with_id: + summary: Response for adding an issue using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_id: + summary: Response for adding a pull request using its unique ID + value: + "$ref": "#/components/examples/projects-v2-item-simple" + issue_with_nwo: + summary: Response for adding an issue using repository owner, name, + and issue number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + pull_request_with_nwo: + summary: Response for adding a pull request using repository owner, + name, and PR number + value: + "$ref": "#/components/examples/projects-v2-item-simple" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/users/{username}/projectsV2/{project_number}/items/{item_id}": + get: + summary: Get an item for a user owned project + description: Get a specific item from a user-owned project. + tags: + - projects + operationId: projects/get-user-item + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#get-an-item-for-a-user-owned-project + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/item-id" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the title field will be returned. + + Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789 + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + patch: + summary: Update project item for user + description: Update a specific item in a user-owned project. + tags: + - projects + operationId: projects/update-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#update-project-item-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/item-id" + requestBody: + required: true + description: Field updates to apply to the project item. Only text, number, + date, single select, and iteration fields are supported. + content: + application/json: + schema: + type: object + properties: + fields: + type: array + description: A list of field updates to apply. + items: + type: object + properties: + id: + type: integer + description: The ID of the project field to update. + value: + description: |- + The new value for the field: + - For text, number, and date fields, provide the new value directly. + - For single select and iteration fields, provide the ID of the option or iteration. + - To clear the field, set this to null. + nullable: true + oneOf: + - type: string + - type: number + required: + - id + - value + required: + - fields + examples: + text_field: + summary: Update a text field + value: + fields: + - id: 123 + value: Updated text value + number_field: + summary: Update a number field + value: + fields: + - id: 456 + value: 42.5 + date_field: + summary: Update a date field + value: + fields: + - id: 789 + value: '2023-10-05' + single_select_field: + summary: Update a single select field + value: + fields: + - id: 789 + value: 47fc9ee4 + iteration_field: + summary: Update an iteration field + value: + fields: + - id: 1011 + value: 866ee5b8 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + text_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + number_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + date_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + single_select_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + iteration_field: + "$ref": "#/components/examples/projects-v2-item-with-content" + '401': + "$ref": "#/components/responses/requires_authentication" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + delete: + summary: Delete project item for user + description: Delete a specific item from a user-owned project. + tags: + - projects + operationId: projects/delete-item-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#delete-project-item-for-user + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/item-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: items + "/users/{username}/projectsV2/{project_number}/views/{view_number}/items": + get: + summary: List items for a user project view + description: List items in a user project with the saved view's filter applied. + tags: + - projects + operationId: projects/list-view-items-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/projects/items#list-items-for-a-user-project-view + parameters: + - "$ref": "#/components/parameters/project-number" + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/view-number" + - name: fields + description: |- + Limit results to specific fields, by their IDs. If not specified, the + title field will be returned. + + Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789` + in: query + required: false + schema: + oneOf: + - type: string + - type: array + maxItems: 50 + items: + type: string + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/projects-v2-item-with-content" + examples: + default: + "$ref": "#/components/examples/projects-v2-item-with-content" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" x-github: githubCloudOnly: false enabledForGitHubApps: false category: projects - subcategory: projects + subcategory: items "/users/{username}/received_events": get: summary: List events received by the authenticated user @@ -50308,102 +54434,120 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/users/{username}/settings/billing/actions": + "/users/{username}/settings/billing/premium_request/usage": get: - summary: Get GitHub Actions billing for a user + summary: Get billing premium request usage report for a user description: |- - Gets the summary of the free and paid GitHub Actions minutes used. - - Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". + Gets a report of premium request usage for a user. - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - operationId: billing/get-github-actions-billing-user + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing + operationId: billing/get-github-billing-premium-request-usage-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user + url: https://docs.github.com/rest/billing/usage#get-billing-premium-request-usage-report-for-a-user parameters: - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-model" + - "$ref": "#/components/parameters/billing-usage-report-product" responses: '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-billing-usage" - examples: - default: - "$ref": "#/components/examples/actions-billing-usage" + "$ref": "#/components/responses/billing_premium_request_usage_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing - subcategory: billing - "/users/{username}/settings/billing/packages": + subcategory: usage + "/users/{username}/settings/billing/usage": get: - summary: Get GitHub Packages billing for a user + summary: Get billing usage report for a user description: |- - Gets the free and paid storage used for GitHub Packages in gigabytes. - - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + Gets a report of the total usage for a user. - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - operationId: billing/get-github-packages-billing-user + **Note:** This endpoint is only available to users with access to the enhanced billing platform. tags: - billing + operationId: billing/get-github-billing-usage-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user + url: https://docs.github.com/rest/billing/usage#get-billing-usage-report-for-a-user parameters: - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month" + - "$ref": "#/components/parameters/billing-usage-report-day" responses: '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/packages-billing-usage" - examples: - default: - "$ref": "#/components/examples/packages-billing-usage" + "$ref": "#/components/responses/billing_usage_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing - subcategory: billing - "/users/{username}/settings/billing/shared-storage": + subcategory: usage + "/users/{username}/settings/billing/usage/summary": get: - summary: Get shared storage billing for a user + summary: Get billing usage summary for a user description: |- - Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages. + > [!NOTE] + > This endpoint is in public preview and is subject to change. - Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." + Gets a summary report of usage for a user. - OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. - operationId: billing/get-shared-storage-billing-user + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing + operationId: billing/get-github-billing-usage-summary-report-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user + url: https://docs.github.com/rest/billing/usage#get-billing-usage-summary-for-a-user parameters: - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month-default" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-repository" + - "$ref": "#/components/parameters/billing-usage-report-product" + - "$ref": "#/components/parameters/billing-usage-report-sku" responses: '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/combined-billing-usage" - examples: - default: - "$ref": "#/components/examples/combined-billing-usage" + "$ref": "#/components/responses/billing_usage_summary_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing - subcategory: billing + subcategory: usage "/users/{username}/social_accounts": get: summary: List social accounts for a user @@ -50601,7 +54745,7 @@ paths: '200': description: Response content: - application/json: + text/plain: schema: type: string examples: @@ -51874,6 +56018,70 @@ x-webhooks: - repository - organization - app + code-scanning-alert-updated-assignment: + post: + summary: |- + This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/rest/code-scanning)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission. + description: The assignees list of a code scanning alert has been updated. + operationId: code-scanning-alert/updated-assignment + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert + 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-code-scanning-alert-updated-assignment" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: code_scanning_alert + supported-webhook-types: + - repository + - organization + - app commit-comment-created: post: summary: |- @@ -52139,7 +56347,7 @@ x-webhooks: - business - organization - app - custom-property-updated: + custom-property-promoted-to-enterprise: post: summary: |- This event occurs when there is activity relating to a custom property. @@ -52147,8 +56355,8 @@ x-webhooks: For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: A custom property was updated. - operationId: custom-property/updated + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: @@ -52192,7 +56400,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-updated" + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52205,18 +56413,18 @@ x-webhooks: - business - organization - app - custom-property-values-updated: + custom-property-updated: post: summary: |- - This event occurs when there is activity relating to custom property values for a repository. + This event occurs when there is activity relating to a custom property. - For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/rest/repos/custom-properties)" in the REST API documentation. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. - description: The custom property values of a repository were updated. - operationId: custom-property-values/updated + description: A custom property was updated. + operationId: custom-property/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property parameters: - name: User-Agent in: header @@ -52258,7 +56466,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-custom-property-values-updated" + "$ref": "#/components/schemas/webhook-custom-property-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52266,24 +56474,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: custom-property-values + subcategory: custom_property supported-webhook-types: - - repository + - business - organization - app - delete: + custom-property-values-updated: post: summary: |- - This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including - branch and tag deletions, use the [`push`](#push) webhook event. + This event occurs when there is activity relating to custom property values for a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties for a repository, see "[Custom properties](https://docs.github.com/rest/repos/custom-properties)" in the REST API documentation. - > [!NOTE] - > This event will not occur when more than three tags are deleted at once. - operationId: delete + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: The custom property values of a repository were updated. + operationId: custom-property-values/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values parameters: - name: User-Agent in: header @@ -52325,7 +56532,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-delete" + "$ref": "#/components/schemas/webhook-custom-property-values-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52333,27 +56540,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: delete + subcategory: custom-property-values supported-webhook-types: - repository - organization - app - dependabot-alert-auto-dismissed: + delete: post: summary: |- - This event occurs when there is activity relating to Dependabot alerts. - - For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including + branch and tag deletions, use the [`push`](#push) webhook event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. > [!NOTE] - > 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 + > This event will not occur when more than three tags are deleted at once. + operationId: delete externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete parameters: - name: User-Agent in: header @@ -52395,7 +56599,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" + "$ref": "#/components/schemas/webhook-delete" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52403,12 +56607,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: dependabot_alert + subcategory: delete supported-webhook-types: - repository - organization - app - dependabot-alert-auto-reopened: + dependabot-alert-assignees-changed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52416,13 +56620,8 @@ x-webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 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. - operationId: dependabot-alert/auto-reopened + description: The assignees for a Dependabot alert were updated. + operationId: dependabot-alert/assignees-changed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52438,7 +56637,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52466,7 +56665,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-assignees-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52479,7 +56678,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-created: + dependabot-alert-auto-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52487,13 +56686,9 @@ x-webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 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. - operationId: dependabot-alert/created + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52509,7 +56704,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52537,7 +56732,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52550,7 +56745,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-dismissed: + dependabot-alert-auto-reopened: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52558,11 +56753,10 @@ x-webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A Dependabot alert was manually closed. - operationId: dependabot-alert/dismissed + 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. + operationId: dependabot-alert/auto-reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52578,7 +56772,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52606,7 +56800,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" + "$ref": "#/components/schemas/webhook-dependabot-alert-auto-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52619,7 +56813,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-fixed: + dependabot-alert-created: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52627,11 +56821,10 @@ x-webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A manifest file change removed a vulnerability. - operationId: dependabot-alert/fixed + 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. + operationId: dependabot-alert/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52647,7 +56840,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52675,7 +56868,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" + "$ref": "#/components/schemas/webhook-dependabot-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52688,7 +56881,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-reintroduced: + dependabot-alert-dismissed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52696,12 +56889,8 @@ x-webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A manifest file change introduced a vulnerable dependency that - had previously been fixed. - operationId: dependabot-alert/reintroduced + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52717,7 +56906,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52745,7 +56934,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" + "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52758,7 +56947,7 @@ x-webhooks: - repository - organization - app - dependabot-alert-reopened: + dependabot-alert-fixed: post: summary: |- This event occurs when there is activity relating to Dependabot alerts. @@ -52766,11 +56955,8 @@ x-webhooks: For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. 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 public preview and subject to change. - description: A Dependabot alert was manually reopened. - operationId: dependabot-alert/reopened + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: @@ -52786,7 +56972,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52814,7 +57000,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" + "$ref": "#/components/schemas/webhook-dependabot-alert-fixed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52827,16 +57013,19 @@ x-webhooks: - repository - organization - app - deploy-key-created: + dependabot-alert-reintroduced: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to Dependabot alerts. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was created. - operationId: deploy-key/created + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -52850,7 +57039,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52878,7 +57067,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-created" + "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52886,21 +57075,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - deploy-key-deleted: + dependabot-alert-reopened: post: summary: |- - This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. + This event occurs when there is activity relating to Dependabot alerts. - To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deploy key was deleted. - operationId: deploy-key/deleted + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key + url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert parameters: - name: User-Agent in: header @@ -52914,7 +57105,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: dependabot_alert schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -52942,7 +57133,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deploy-key-deleted" + "$ref": "#/components/schemas/webhook-dependabot-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -52950,23 +57141,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deploy_key + subcategory: dependabot_alert supported-webhook-types: - repository - organization - app - deployment-created: + deploy-key-created: post: summary: |- - This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. - - For activity relating to deployment status, use the `deployment_status` event. + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment was created. - operationId: deployment/created + description: A deploy key was created. + operationId: deploy-key/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key parameters: - name: User-Agent in: header @@ -53008,7 +57197,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-deployment-created" + "$ref": "#/components/schemas/webhook-deploy-key-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -53016,21 +57205,151 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: deployment + subcategory: deploy_key supported-webhook-types: - repository - organization - app - deployment-protection-rule-requested: + deploy-key-deleted: post: summary: |- - This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments). + This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/rest/deploy-keys)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. - description: A deployment protection rule was requested for an environment. - operationId: deployment-protection-rule/requested + description: A deploy key was deleted. + operationId: deploy-key/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key + 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-deploy-key-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: deploy_key + supported-webhook-types: + - repository + - organization + - app + deployment-created: + post: + summary: |- + This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/rest/deployments/deployments)" in the REST API documentation. + + For activity relating to deployment status, use the `deployment_status` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment was created. + operationId: deployment/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment + 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-deployment-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: deployment + supported-webhook-types: + - repository + - organization + - app + deployment-protection-rule-requested: + post: + summary: |- + This event occurs when there is activity relating to deployment protection rules. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules)." For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments). + + To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission. + description: A deployment protection rule was requested for an environment. + operationId: deployment-protection-rule/requested + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule parameters: - name: User-Agent in: header @@ -55479,18 +59798,18 @@ x-webhooks: - repository - organization - app - issues-assigned: + issue-comment-pinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was assigned to a user. - operationId: issues/assigned + description: A comment on an issue was pinned. + operationId: issue-comment/pinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -55532,7 +59851,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-assigned" + "$ref": "#/components/schemas/webhook-issue-comment-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55540,23 +59859,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-closed: + issue-comment-unpinned: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/rest/issues/comments)" in the REST API documentation. - For activity relating to a comment on an issue, use the `issue_comment` event. + For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/rest/guides/working-with-comments)." To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was closed. - operationId: issues/closed + description: A comment on an issue was unpinned. + operationId: issue-comment/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment parameters: - name: User-Agent in: header @@ -55598,7 +59917,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-closed" + "$ref": "#/components/schemas/webhook-issue-comment-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55606,23 +59925,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue_comment supported-webhook-types: - repository - organization - app - issues-deleted: + issue-dependencies-blocked-by-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: An issue was deleted. - operationId: issues/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocked by another issue. + operationId: issue-dependencies/blocked-by-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55664,7 +59983,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-deleted" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55672,23 +59991,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-demilestoned: + issue-dependencies-blocked-by-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: An issue was removed from a milestone. - operationId: issues/demilestoned + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocked by relationship between an issue and another issue + was removed. + operationId: issue-dependencies/blocked-by-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55730,7 +60050,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-demilestoned" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55738,23 +60058,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-edited: + issue-dependencies-blocking-added: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: The title or body on an issue was edited. - operationId: issues/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: An issue was marked as blocking another issue. + operationId: issue-dependencies/blocking-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55796,7 +60116,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-edited" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55804,23 +60124,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-labeled: + issue-dependencies-blocking-removed: post: summary: |- - This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships. - For activity relating to a comment on an issue, use the `issue_comment` 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 "Issues" repository permission. - description: A label was added to an issue. - operationId: issues/labeled + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permissions. + description: The blocking relationship between an issue and another issue was + removed. + operationId: issue-dependencies/blocking-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue-dependencies parameters: - name: User-Agent in: header @@ -55862,7 +60183,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-labeled" + "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55870,12 +60191,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: issues + subcategory: issue-dependencies supported-webhook-types: - repository - organization - app - issues-locked: + issues-assigned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -55883,9 +60204,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/locked + description: An issue was assigned to a user. + operationId: issues/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -55929,7 +60249,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-locked" + "$ref": "#/components/schemas/webhook-issues-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -55942,7 +60262,7 @@ x-webhooks: - repository - organization - app - issues-milestoned: + issues-closed: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -55950,8 +60270,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was added to a milestone. - operationId: issues/milestoned + description: An issue was closed. + operationId: issues/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -55995,7 +60315,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-milestoned" + "$ref": "#/components/schemas/webhook-issues-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56008,7 +60328,7 @@ x-webhooks: - repository - organization - app - issues-opened: + issues-deleted: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56016,9 +60336,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was created. When a closed issue is reopened, the action - will be `reopened` instead. - operationId: issues/opened + description: An issue was deleted. + operationId: issues/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56062,7 +60381,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-opened" + "$ref": "#/components/schemas/webhook-issues-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56075,7 +60394,7 @@ x-webhooks: - repository - organization - app - issues-pinned: + issues-demilestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56083,9 +60402,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was pinned to a repository. For more information, see - "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/pinned + description: An issue was removed from a milestone. + operationId: issues/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56129,7 +60447,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-pinned" + "$ref": "#/components/schemas/webhook-issues-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56142,7 +60460,7 @@ x-webhooks: - repository - organization - app - issues-reopened: + issues-edited: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56150,8 +60468,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A closed issue was reopened. - operationId: issues/reopened + description: The title or body on an issue was edited. + operationId: issues/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56195,7 +60513,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-reopened" + "$ref": "#/components/schemas/webhook-issues-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56208,7 +60526,7 @@ x-webhooks: - repository - organization - app - issues-transferred: + issues-labeled: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56216,9 +60534,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was transferred to another repository. For more information, - see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." - operationId: issues/transferred + description: A label was added to an issue. + operationId: issues/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56262,7 +60579,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-transferred" + "$ref": "#/components/schemas/webhook-issues-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56275,7 +60592,7 @@ x-webhooks: - repository - organization - app - issues-unassigned: + issues-locked: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56283,8 +60600,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A user was unassigned from an issue. - operationId: issues/unassigned + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56328,7 +60646,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unassigned" + "$ref": "#/components/schemas/webhook-issues-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56341,7 +60659,7 @@ x-webhooks: - repository - organization - app - issues-unlabeled: + issues-milestoned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56349,8 +60667,8 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: A label was removed from an issue. - operationId: issues/unlabeled + description: An issue was added to a milestone. + operationId: issues/milestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56394,7 +60712,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlabeled" + "$ref": "#/components/schemas/webhook-issues-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56407,7 +60725,7 @@ x-webhooks: - repository - organization - app - issues-unlocked: + issues-opened: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56415,9 +60733,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: Conversation on an issue was locked. For more information, see - "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: issues/unlocked + description: An issue was created. When a closed issue is reopened, the action + will be `reopened` instead. + operationId: issues/opened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56461,7 +60779,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unlocked" + "$ref": "#/components/schemas/webhook-issues-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56474,7 +60792,7 @@ x-webhooks: - repository - organization - app - issues-unpinned: + issues-pinned: post: summary: |- This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. @@ -56482,9 +60800,9 @@ x-webhooks: For activity relating to a comment on an issue, use the `issue_comment` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. - description: An issue was unpinned from a repository. For more information, - see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." - operationId: issues/unpinned + description: An issue was pinned to a repository. For more information, see + "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: @@ -56528,7 +60846,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-issues-unpinned" + "$ref": "#/components/schemas/webhook-issues-pinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56541,18 +60859,18 @@ x-webhooks: - repository - organization - app - label-created: + issues-reopened: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was created. - operationId: label/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A closed issue was reopened. + operationId: issues/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56594,7 +60912,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-created" + "$ref": "#/components/schemas/webhook-issues-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56602,23 +60920,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-deleted: + issues-transferred: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label was deleted. - operationId: label/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was transferred to another repository. For more information, + see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56660,7 +60979,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-deleted" + "$ref": "#/components/schemas/webhook-issues-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56668,23 +60987,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - label-edited: + issues-typed: post: summary: |- - This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. - If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + For activity relating to a comment on an issue, use the `issue_comment` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: A label's name, description, or color was changed. - operationId: label/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was added to an issue. + operationId: issues/typed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#label + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56726,7 +61045,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-label-edited" + "$ref": "#/components/schemas/webhook-issues-typed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56734,24 +61053,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: label + subcategory: issues supported-webhook-types: - repository - organization - app - marketplace-purchase-cancelled: + issues-unassigned: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a GitHub Marketplace plan, and the last billing - cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/cancelled + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A user was unassigned from an issue. + operationId: issues/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56793,7 +61111,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" + "$ref": "#/components/schemas/webhook-issues-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56801,22 +61119,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-changed: + - repository + - organization + - app + issues-unlabeled: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone upgraded or downgraded a GitHub Marketplace plan, and the - last billing cycle has ended. The change will take effect on the account immediately. - operationId: marketplace-purchase/changed + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: A label was removed from an issue. + operationId: issues/unlabeled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56858,7 +61177,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" + "$ref": "#/components/schemas/webhook-issues-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56866,24 +61185,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-pending-change: + - repository + - organization + - app + issues-unlocked: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone downgraded or cancelled a GitHub Marketplace plan. The - new plan or cancellation will take effect at the end of the current billing - cycle. When the change takes effect, the `changed` or `cancelled` event will - be sent. - operationId: marketplace-purchase/pending-change + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: Conversation on an issue was locked. For more information, see + "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56925,7 +61244,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" + "$ref": "#/components/schemas/webhook-issues-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56933,23 +61252,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-pending-change-cancelled: + - repository + - organization + - app + issues-unpinned: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone cancelled a pending change to a GitHub Marketplace plan. - Pending changes include plan cancellations and downgrades that will take effect - at the end of a billing cycle. - operationId: marketplace-purchase/pending-change-cancelled + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue was unpinned from a repository. For more information, + see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -56991,7 +61311,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" + "$ref": "#/components/schemas/webhook-issues-unpinned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -56999,22 +61319,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - marketplace-purchase-purchased: + - repository + - organization + - app + issues-untyped: post: - summary: This event occurs when there is activity relating to a GitHub Marketplace - purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." - For information about the APIs to manage GitHub Marketplace listings, see - [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) - or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in - the REST API documentation. - description: Someone purchased a GitHub Marketplace plan. The change will take - effect on the account immediately. - operationId: marketplace-purchase/purchased + summary: |- + This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/rest/issues)" in the REST API documentation. + + For activity relating to a comment on an issue, use the `issue_comment` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission. + description: An issue type was removed from an issue. + operationId: issues/untyped externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase + url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues parameters: - name: User-Agent in: header @@ -57056,7 +61377,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" + "$ref": "#/components/schemas/webhook-issues-untyped" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57064,19 +61385,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: marketplace_purchase + subcategory: issues supported-webhook-types: - - marketplace - member-added: + - repository + - organization + - app + label-created: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A GitHub user accepted an invitation to a repository. - operationId: member/added + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was created. + operationId: label/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -57118,7 +61443,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-added" + "$ref": "#/components/schemas/webhook-label-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57126,22 +61451,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: label supported-webhook-types: - - business - repository - organization - app - member-edited: + label-deleted: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: Permissions were changed for a collaborator on a repository. - operationId: member/edited + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label was deleted. + operationId: label/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -57183,7 +61509,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-edited" + "$ref": "#/components/schemas/webhook-label-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57191,22 +61517,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: label supported-webhook-types: - - business - repository - organization - app - member-removed: + label-edited: post: summary: |- - This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#label) or "[Labels](https://docs.github.com/rest/issues/labels)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A collaborator was removed from a repository. - operationId: member/removed + If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A label's name, description, or color was changed. + operationId: label/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#member + url: https://docs.github.com/webhooks/webhook-events-and-payloads#label parameters: - name: User-Agent in: header @@ -57248,7 +61575,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-member-removed" + "$ref": "#/components/schemas/webhook-label-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57256,22 +61583,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: member + subcategory: label supported-webhook-types: - - business - repository - organization - app - membership-added: + marketplace-purchase-cancelled: post: - summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was added to a team. - operationId: membership/added + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a GitHub Marketplace plan, and the last billing + cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57313,7 +61642,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-added" + "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57321,21 +61650,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: marketplace_purchase supported-webhook-types: - - organization - - business - - app - membership-removed: + - marketplace + marketplace-purchase-changed: post: - summary: |- - This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization member was removed from a team. - operationId: membership/removed + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone upgraded or downgraded a GitHub Marketplace plan, and the + last billing cycle has ended. The change will take effect on the account immediately. + operationId: marketplace-purchase/changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57377,7 +61707,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-membership-removed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57385,26 +61715,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: membership + subcategory: marketplace_purchase supported-webhook-types: - - organization - - business - - app - merge-group-checks-requested: + - marketplace + marketplace-purchase-pending-change: post: - summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. - - When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. - operationId: merge-group/checks-requested - tags: - - merge-queue + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone downgraded or cancelled a GitHub Marketplace plan. The + new plan or cancellation will take effect at the end of the current billing + cycle. When the change takes effect, the `changed` or `cancelled` event will + be sent. + operationId: marketplace-purchase/pending-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57446,7 +61774,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-checks-requested" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57454,24 +61782,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: marketplace_purchase supported-webhook-types: - - app - merge-group-destroyed: + - marketplace + marketplace-purchase-pending-change-cancelled: post: - summary: |- - This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - - To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. - description: |- - The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. - - When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. - operationId: merge-group/destroyed - tags: - - merge-queue + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone cancelled a pending change to a GitHub Marketplace plan. + Pending changes include plan cancellations and downgrades that will take effect + at the end of a billing cycle. + operationId: marketplace-purchase/pending-change-cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57513,7 +61840,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-merge-group-destroyed" + "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57521,19 +61848,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: merge_group + subcategory: marketplace_purchase supported-webhook-types: - - app - meta-deleted: + - marketplace + marketplace-purchase-purchased: post: - summary: |- - This event occurs when there is activity relating to a webhook itself. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. - description: The webhook was deleted. - operationId: meta/deleted + summary: This event occurs when there is activity relating to a GitHub Marketplace + purchase. For more information, see "[GitHub Marketplace](https://docs.github.com/marketplace)." + For information about the APIs to manage GitHub Marketplace listings, see + [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#marketplacelisting) + or "[GitHub Marketplace](https://docs.github.com/rest/apps/marketplace)" in + the REST API documentation. + description: Someone purchased a GitHub Marketplace plan. The change will take + effect on the account immediately. + operationId: marketplace-purchase/purchased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta + url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase parameters: - name: User-Agent in: header @@ -57575,7 +61905,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-meta-deleted" + "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57583,25 +61913,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: meta + subcategory: marketplace_purchase supported-webhook-types: - marketplace - - business - - repository - - organization - - app - milestone-closed: + member-added: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was closed. - operationId: milestone/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A GitHub user accepted an invitation to a repository. + operationId: member/added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -57643,7 +61967,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-closed" + "$ref": "#/components/schemas/webhook-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57651,23 +61975,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: member supported-webhook-types: + - business - repository - organization - app - milestone-created: + member-edited: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was created. - operationId: milestone/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: Permissions were changed for a collaborator on a repository. + operationId: member/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -57709,7 +62032,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-created" + "$ref": "#/components/schemas/webhook-member-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57717,23 +62040,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: member supported-webhook-types: + - business - repository - organization - app - milestone-deleted: + member-removed: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/rest/collaborators/collaborators)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was deleted. - operationId: milestone/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A collaborator was removed from a repository. + operationId: member/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#member parameters: - name: User-Agent in: header @@ -57775,7 +62097,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-deleted" + "$ref": "#/components/schemas/webhook-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57783,23 +62105,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: member supported-webhook-types: + - business - repository - organization - app - milestone-edited: + membership-added: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was edited. - operationId: milestone/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was added to a team. + operationId: membership/added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -57841,7 +62162,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-edited" + "$ref": "#/components/schemas/webhook-membership-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57849,23 +62170,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: membership supported-webhook-types: - - repository - organization + - business - app - milestone-opened: + membership-removed: post: summary: |- - This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - - If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. + This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#team) or "[Team members](https://docs.github.com/rest/teams/members)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. - description: A milestone was opened. - operationId: milestone/opened + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization member was removed from a team. + operationId: membership/removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone + url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership parameters: - name: User-Agent in: header @@ -57907,7 +62226,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-milestone-opened" + "$ref": "#/components/schemas/webhook-membership-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57915,23 +62234,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: milestone + subcategory: membership supported-webhook-types: - - repository - organization + - business - app - org-block-blocked: + merge-group-checks-requested: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A user was blocked from the organization. - operationId: org-block/blocked + When you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses. + operationId: merge-group/checks-requested + tags: + - merge-queue externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -57973,7 +62295,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-blocked" + "$ref": "#/components/schemas/webhook-merge-group-checks-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -57981,23 +62303,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: org_block + subcategory: merge_group supported-webhook-types: - - organization - - business - app - org-block-unblocked: + merge-group-destroyed: post: summary: |- - This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. + This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "[Managing a merge queue](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue)." - If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission. + description: |- + The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. - description: A previously blocked user was unblocked from the organization. - operationId: org-block/unblocked + When you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used. + operationId: merge-group/destroyed + tags: + - merge-queue externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block + url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group parameters: - name: User-Agent in: header @@ -58039,7 +62362,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-org-block-unblocked" + "$ref": "#/components/schemas/webhook-merge-group-destroyed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58047,23 +62370,87 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: org_block + subcategory: merge_group supported-webhook-types: - - organization + - app + meta-deleted: + post: + summary: |- + This event occurs when there is activity relating to a webhook itself. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission. + description: The webhook was deleted. + operationId: meta/deleted + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta + 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-meta-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: meta + supported-webhook-types: + - marketplace - business + - repository + - organization - app - organization-deleted: + milestone-closed: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: An organization was deleted. - operationId: organization/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was closed. + operationId: milestone/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58105,7 +62492,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-deleted" + "$ref": "#/components/schemas/webhook-milestone-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58113,23 +62500,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-member-added: + milestone-created: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member accepted an invitation to join an organization. - operationId: organization/member-added + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was created. + operationId: milestone/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58171,7 +62558,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-member-added" + "$ref": "#/components/schemas/webhook-milestone-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58179,23 +62566,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-member-invited: + milestone-deleted: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member was invited to join the organization. - operationId: organization/member-invited + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was deleted. + operationId: milestone/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58237,7 +62624,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-member-invited" + "$ref": "#/components/schemas/webhook-milestone-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58245,23 +62632,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-member-removed: + milestone-edited: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A member was removed from the organization. - operationId: organization/member-removed + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was edited. + operationId: milestone/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58303,7 +62690,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-member-removed" + "$ref": "#/components/schemas/webhook-milestone-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58311,23 +62698,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - organization-renamed: + milestone-opened: post: summary: |- - This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. + This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/rest/issues/milestones)" in the REST API documentation. - If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name of an organization was changed. - operationId: organization/renamed + To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions. + description: A milestone was opened. + operationId: milestone/opened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization + url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone parameters: - name: User-Agent in: header @@ -58369,7 +62756,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-organization-renamed" + "$ref": "#/components/schemas/webhook-milestone-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58377,21 +62764,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: organization + subcategory: milestone supported-webhook-types: + - repository - organization - - business - app - package-published: + org-block-blocked: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - description: A package was published to a registry. - operationId: package/published + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A user was blocked from the organization. + operationId: org-block/blocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -58433,7 +62822,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-package-published" + "$ref": "#/components/schemas/webhook-org-block-blocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58441,21 +62830,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: package + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - package-updated: + org-block-unblocked: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see "[Blocking a user from your organization](https://docs.github.com/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization)." For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#userblockedevent) or "[Blocking users](https://docs.github.com/rest/orgs/blocking)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. - description: A previously published package was updated. - operationId: package/updated + If you want to receive an event when members are added or removed from an organization, use the `organization` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" organization permission. + description: A previously blocked user was unblocked from the organization. + operationId: org-block/unblocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block parameters: - name: User-Agent in: header @@ -58497,7 +62888,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-package-updated" + "$ref": "#/components/schemas/webhook-org-block-unblocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58505,20 +62896,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: package + subcategory: org_block supported-webhook-types: - - repository - organization + - business - app - page-build: + organization-deleted: post: summary: |- - This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/rest/pages)" in the REST API documentation. + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. - operationId: page-build + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: An organization was deleted. + operationId: organization/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header @@ -58560,7 +62954,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-page-build" + "$ref": "#/components/schemas/webhook-organization-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58568,43 +62962,37 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: page_build + subcategory: organization supported-webhook-types: - - repository - organization + - business - app - personal-access-token-request-approved: + organization-member-added: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A member accepted an invitation to join an organization. + operationId: organization/member-added externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58614,7 +63002,12 @@ x-webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58627,7 +63020,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" + "$ref": "#/components/schemas/webhook-organization-member-added" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58635,42 +63028,37 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - personal-access-token-request-cancelled: + organization-member-invited: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A member was invited to join the organization. + operationId: organization/member-invited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58680,7 +63068,12 @@ x-webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58693,7 +63086,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" + "$ref": "#/components/schemas/webhook-organization-member-invited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58701,41 +63094,37 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - personal-access-token-request-created: + organization-member-removed: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A member was removed from the organization. + operationId: organization/member-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58745,7 +63134,12 @@ x-webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58758,7 +63152,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-created" + "$ref": "#/components/schemas/webhook-organization-member-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58766,41 +63160,37 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - personal-access-token-request-denied: + organization-renamed: post: summary: |- - This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." + This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/rest/orgs)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: The name of an organization was changed. + operationId: organization/renamed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Id in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: 12312312 schema: type: string - name: X-Github-Event in: header - example: personal_access_token_request - schema: - type: string - - name: X-Github-Hook-Id - in: header - example: 12312312 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -58810,7 +63200,12 @@ x-webhooks: type: string - name: X-Github-Hook-Installation-Target-Type in: header - example: integration + 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 @@ -58823,7 +63218,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" + "$ref": "#/components/schemas/webhook-organization-renamed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58831,16 +63226,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: personal_access_token_request + subcategory: organization supported-webhook-types: + - organization + - business - app - ping: + package-published: post: - summary: This event occurs when you create a new webhook. The ping event is - a confirmation from GitHub that you configured the webhook correctly. - operationId: ping + summary: This event occurs when there is activity relating to GitHub Packages. + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." + For information about the APIs to manage GitHub Packages, see [the GraphQL + API documentation](https://docs.github.com/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + description: A package was published to a registry. + operationId: package/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping + url: https://docs.github.com/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -58882,45 +63283,29 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-ping" - examples: - default: - "$ref": "#/components/examples/ping" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-ping-form-encoded" - examples: - default: - "$ref": "#/components/examples/ping-form-encoded" + "$ref": "#/components/schemas/webhook-package-published" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: ping + subcategory: package supported-webhook-types: - repository - organization - - app - - business - - marketplace - project-card-converted: + package-updated: post: - summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note in a project (classic) was converted to an issue. - operationId: project-card/converted + summary: This event occurs when there is activity relating to GitHub Packages. + For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." + For information about the APIs to manage GitHub Packages, see [the GraphQL + API documentation](https://docs.github.com/graphql/reference/objects#package) + or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + description: A previously published package was updated. + operationId: package/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#package parameters: - name: User-Agent in: header @@ -58962,7 +63347,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-converted" + "$ref": "#/components/schemas/webhook-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -58970,25 +63355,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: package supported-webhook-types: - repository - organization - - app - project-card-created: + page-build: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/rest/pages)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card was added to a project (classic). - operationId: project-card/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission. + operationId: page-build externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build parameters: - name: User-Agent in: header @@ -59030,7 +63409,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-created" + "$ref": "#/components/schemas/webhook-page-build" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59038,54 +63417,50 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: page_build supported-webhook-types: - repository - organization - app - project-card-deleted: + personal-access-token-request-approved: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a project (classic) was deleted. - operationId: project-card/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was approved. + operationId: personal-access-token-request/approved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59098,7 +63473,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-deleted" + "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59106,54 +63481,50 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-card-edited: + - organization + personal-access-token-request-cancelled: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note on a project (classic) was edited. - operationId: project-card/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was cancelled by the + requester. + operationId: personal-access-token-request/cancelled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59166,7 +63537,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-edited" + "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59174,55 +63545,49 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-card-moved: + - organization + personal-access-token-request-created: post: summary: |- - This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a project (classic) was moved to another column or to - another position in its column. - operationId: project-card/moved + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was created. + operationId: personal-access-token-request/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59235,7 +63600,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-card-moved" + "$ref": "#/components/schemas/webhook-personal-access-token-request-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59243,54 +63608,49 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_card + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-closed: + - organization + personal-access-token-request-denied: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. + This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see "[Creating a personal access token](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Personal access token requests" organization permission. + description: A fine-grained personal access token request was denied. + operationId: personal-access-token-request/denied externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request parameters: - name: User-Agent in: header example: GitHub-Hookshot/123abc schema: type: string - - name: X-Github-Hook-Id + - name: X-GitHub-Delivery in: header - example: 12312312 + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 schema: type: string - name: X-Github-Event in: header - example: issues + example: personal_access_token_request schema: type: string - - name: X-Github-Hook-Installation-Target-Id + - name: X-Github-Hook-Id in: header - example: 123123 + example: 12312312 schema: type: string - - name: X-Github-Hook-Installation-Target-Type + - name: X-Github-Hook-Installation-Target-Id in: header - example: repository + example: 123123 schema: type: string - - name: X-GitHub-Delivery + - name: X-Github-Hook-Installation-Target-Type in: header - example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + example: integration schema: type: string - name: X-Hub-Signature-256 @@ -59303,7 +63663,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-closed" + "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59311,25 +63671,17 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: personal_access_token_request supported-webhook-types: - - repository - - organization - app - project-column-created: + - organization + ping: post: - summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - - This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a project (classic). - operationId: project-column/created + summary: This event occurs when you create a new webhook. The ping event is + a confirmation from GitHub that you configured the webhook correctly. + operationId: ping externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping parameters: - name: User-Agent in: header @@ -59371,33 +63723,45 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-created" + "$ref": "#/components/schemas/webhook-ping" + examples: + default: + "$ref": "#/components/examples/ping" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-ping-form-encoded" + examples: + default: + "$ref": "#/components/examples/ping-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: project_column + subcategory: ping supported-webhook-types: - repository - organization - app - project-column-deleted: + - business + - marketplace + project-card-converted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a project (classic). - operationId: project-column/deleted + description: A note in a project (classic) was converted to an issue. + operationId: project-card/converted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59439,7 +63803,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-deleted" + "$ref": "#/components/schemas/webhook-project-card-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59447,25 +63811,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project_card supported-webhook-types: - repository - organization - app - project-column-edited: + project-card-created: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a project (classic) was changed. - operationId: project-column/edited + description: A card was added to a project (classic). + operationId: project-card/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59507,7 +63871,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-edited" + "$ref": "#/components/schemas/webhook-project-card-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59515,25 +63879,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project_card supported-webhook-types: - repository - organization - app - project-column-moved: + project-card-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a project (classic). - operationId: project-column/moved + description: A card on a project (classic) was deleted. + operationId: project-card/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59575,7 +63939,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-column-moved" + "$ref": "#/components/schemas/webhook-project-card-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59583,25 +63947,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project_column + subcategory: project_card supported-webhook-types: - repository - organization - app - project-created: + project-card-edited: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was created. - operationId: project/created + description: A note on a project (classic) was edited. + operationId: project-card/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59643,7 +64007,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-created" + "$ref": "#/components/schemas/webhook-project-card-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59651,25 +64015,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_card supported-webhook-types: - repository - organization - app - project-deleted: + project-card-moved: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was deleted. - operationId: project/deleted + description: A card on a project (classic) was moved to another column or to + another position in its column. + operationId: project-card/moved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card parameters: - name: User-Agent in: header @@ -59711,7 +64076,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-deleted" + "$ref": "#/components/schemas/webhook-project-card-moved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59719,12 +64084,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_card supported-webhook-types: - repository - organization - app - project-edited: + project-closed: post: summary: |- This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. @@ -59734,8 +64099,8 @@ x-webhooks: This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a project (classic) was changed. - operationId: project/edited + description: A project (classic) was closed. + operationId: project/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: @@ -59779,7 +64144,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-edited" + "$ref": "#/components/schemas/webhook-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59792,20 +64157,20 @@ x-webhooks: - repository - organization - app - project-reopened: + project-column-created: post: summary: |- - This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A project (classic) was closed. - operationId: project/reopened + description: A column was added to a project (classic). + operationId: project-column/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#project + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -59847,7 +64212,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-project-reopened" + "$ref": "#/components/schemas/webhook-project-column-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59855,26 +64220,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: project + subcategory: project_column supported-webhook-types: - repository - organization - app - projects-v2-closed: + project-column-deleted: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was deleted from a project (classic). + operationId: project-column/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -59888,7 +64252,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -59916,33 +64280,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-closed" + "$ref": "#/components/schemas/webhook-project-column-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project_column supported-webhook-types: + - repository - organization - projects-v2-created: + - app + project-column-edited: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: The name of a column on a project (classic) was changed. + operationId: project-column/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -59956,7 +64320,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -59984,33 +64348,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-created" + "$ref": "#/components/schemas/webhook-project-column-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project_column supported-webhook-types: + - repository - organization - projects-v2-deleted: + - app + project-column-moved: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A column was moved to a new position on a project (classic). + operationId: project-column/moved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column parameters: - name: User-Agent in: header @@ -60024,7 +64388,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60052,34 +64416,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" + "$ref": "#/components/schemas/webhook-project-column-moved" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project_column supported-webhook-types: + - repository - organization - projects-v2-edited: + - app + project-created: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was created. + operationId: project/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60093,7 +64456,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60121,34 +64484,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-edited" + "$ref": "#/components/schemas/webhook-project-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-archived: + - app + project-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was deleted. + operationId: project/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60162,7 +64524,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60190,33 +64552,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-archived" + "$ref": "#/components/schemas/webhook-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-converted: + - app + project-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: The name or description of a project (classic) was changed. + operationId: project/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60230,7 +64592,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60258,33 +64620,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-converted" + "$ref": "#/components/schemas/webhook-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-created: + - app + project-reopened: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. - > [!NOTE] - > 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. + description: A project (classic) was closed. + operationId: project/reopened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#project parameters: - name: User-Agent in: header @@ -60298,7 +64660,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: issues schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60326,33 +64688,34 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-created" + "$ref": "#/components/schemas/webhook-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: project supported-webhook-types: + - repository - organization - projects-v2-item-deleted: + - app + projects-v2-closed: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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 + description: A project in the organization was closed. + operationId: projects-v2/closed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60366,7 +64729,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60394,7 +64757,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-project-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60403,26 +64766,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-edited: + projects-v2-created: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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. - operationId: projects-v2-item/edited + description: A project in the organization was created. + operationId: projects-v2/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60436,7 +64797,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60464,7 +64825,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-edited" + "$ref": "#/components/schemas/webhook-projects-v2-project-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60473,26 +64834,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-reordered: + projects-v2-deleted: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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. - operationId: projects-v2-item/reordered + description: A project in the organization was deleted. + operationId: projects-v2/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60506,7 +64865,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60534,7 +64893,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" + "$ref": "#/components/schemas/webhook-projects-v2-project-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60543,25 +64902,25 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-item-restored: + projects-v2-edited: post: summary: |- - This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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 + description: The title, description, or README of a project in the organization + was changed. + operationId: projects-v2/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -60575,7 +64934,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-item + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60603,7 +64962,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-item-restored" + "$ref": "#/components/schemas/webhook-projects-v2-project-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60612,24 +64971,25 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_item + subcategory: projects_v2 supported-webhook-types: - organization - projects-v2-reopened: + projects-v2-item-archived: post: summary: |- - This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. 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 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 + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60643,7 +65003,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2 + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60671,7 +65031,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" + "$ref": "#/components/schemas/webhook-projects-v2-item-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60680,24 +65040,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2 + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-status-update-created: + projects-v2-item-converted: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a project, use the `projects_v2` event. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was added to a project in the organization. - operationId: projects-v2-status-update/created + > 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60711,7 +65071,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60739,7 +65099,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" + "$ref": "#/components/schemas/webhook-projects-v2-item-converted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60748,24 +65108,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-status-update-deleted: + projects-v2-item-created: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a project, use the `projects_v2` event. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was removed from a project in the organization. - operationId: projects-v2-status-update/deleted + > 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60779,7 +65139,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60807,7 +65167,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" + "$ref": "#/components/schemas/webhook-projects-v2-item-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60816,24 +65176,24 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: projects_v2_item supported-webhook-types: - organization - projects-v2-status-update-edited: + projects-v2-item-deleted: post: summary: |- - This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity relating to a project, use the `projects_v2` event. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. > [!NOTE] - > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). - description: A status update was edited on a project in the organization. - operationId: projects-v2-status-update/edited + > 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60847,7 +65207,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: project-v2-status-update + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60875,7 +65235,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" + "$ref": "#/components/schemas/webhook-projects-v2-item-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60884,18 +65244,26 @@ x-webhooks: githubCloudOnly: false enabledForGitHubApps: true category: webhooks - subcategory: projects_v2_status_update + subcategory: projects_v2_item supported-webhook-types: - organization - public: + projects-v2-item-edited: post: summary: |- - This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - operationId: public + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. + + 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 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. + operationId: projects-v2-item/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#public + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60909,7 +65277,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -60937,31 +65305,35 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-public" + "$ref": "#/components/schemas/webhook-projects-v2-item-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: public + subcategory: projects_v2_item supported-webhook-types: - - repository - organization - - app - pull-request-assigned: + projects-v2-item-reordered: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was assigned to a user. - operationId: pull-request/assigned + 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 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. + operationId: projects-v2-item/reordered externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -60975,7 +65347,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61003,32 +65375,34 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-assigned" + "$ref": "#/components/schemas/webhook-projects-v2-item-reordered" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_item supported-webhook-types: - - repository - organization - - app - pull-request-auto-merge-disabled: + projects-v2-item-restored: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2item). - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was disabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-disabled + 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 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item parameters: - name: User-Agent in: header @@ -61042,7 +65416,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-item schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61070,32 +65444,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" + "$ref": "#/components/schemas/webhook-projects-v2-item-restored" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_item supported-webhook-types: - - repository - organization - - app - pull-request-auto-merge-enabled: + projects-v2-reopened: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#projectv2). - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Auto merge was enabled for a pull request. For more information, - see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." - operationId: pull-request/auto-merge-enabled + 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 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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2 parameters: - name: User-Agent in: header @@ -61109,7 +65484,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2 schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61137,33 +65512,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" + "$ref": "#/components/schemas/webhook-projects-v2-project-reopened" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2 supported-webhook-types: - - repository - organization - - app - pull-request-closed: + projects-v2-status-update-created: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity relating to a project, use the `projects_v2` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was closed. If `merged` is false in the webhook - payload, the pull request was closed with unmerged commits. If `merged` is - true in the webhook payload, the pull request was merged. - operationId: pull-request/closed + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. + + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was added to a project in the organization. + operationId: projects-v2-status-update/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -61177,7 +65552,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61205,98 +65580,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-closed" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-created" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_status_update supported-webhook-types: - - repository - organization - - app - pull-request-converted-to-draft: + projects-v2-status-update-deleted: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was converted to a draft. For more information, - see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/converted-to-draft - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - 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-pull-request-converted-to-draft" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-demilestoned: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + For activity relating to a project, use the `projects_v2` event. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from a milestone. - operationId: pull-request/demilestoned + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was removed from a project in the organization. + operationId: projects-v2-status-update/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -61310,7 +65620,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61338,98 +65648,33 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-demilestoned" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-deleted" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_status_update supported-webhook-types: - - repository - organization - - app - pull-request-dequeued: + projects-v2-status-update-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + This event occurs when there is activity relating to a status update on an organization-level project. For more information, see "[About Projects](https://docs.github.com/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was removed from the merge queue. - operationId: pull-request/dequeued - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request - 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-pull-request-dequeued" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request - supported-webhook-types: - - repository - - organization - - app - pull-request-edited: - post: - summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + For activity relating to a project, use the `projects_v2` event. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission. - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The title or body of a pull request was edited, or the base branch - of a pull request was changed. - operationId: pull-request/edited + > [!NOTE] + > To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405). + description: A status update was edited on a project in the organization. + operationId: projects-v2-status-update/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_status_update parameters: - name: User-Agent in: header @@ -61443,7 +65688,7 @@ x-webhooks: type: string - name: X-Github-Event in: header - example: issues + example: project-v2-status-update schema: type: string - name: X-Github-Hook-Installation-Target-Id @@ -61471,31 +65716,27 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-edited" + "$ref": "#/components/schemas/webhook-projects-v2-status-update-edited" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: pull_request + subcategory: projects_v2_status_update supported-webhook-types: - - repository - organization - - app - pull-request-enqueued: + public: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to the merge queue. - operationId: pull-request/enqueued + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + operationId: public externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#public parameters: - name: User-Agent in: header @@ -61537,7 +65778,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-enqueued" + "$ref": "#/components/schemas/webhook-public" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61545,12 +65786,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: public supported-webhook-types: - repository - organization - app - pull-request-labeled: + pull-request-assigned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61558,8 +65799,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was added to a pull request. - operationId: pull-request/labeled + description: A pull request was assigned to a user. + operationId: pull-request/assigned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61603,7 +65844,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-labeled" + "$ref": "#/components/schemas/webhook-pull-request-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61616,7 +65857,7 @@ x-webhooks: - repository - organization - app - pull-request-locked: + pull-request-auto-merge-disabled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61624,9 +65865,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was locked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/locked + description: Auto merge was disabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-disabled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61670,7 +65911,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-locked" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-disabled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61683,7 +65924,7 @@ x-webhooks: - repository - organization - app - pull-request-milestoned: + pull-request-auto-merge-enabled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61691,8 +65932,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was added to a milestone. - operationId: pull-request/milestoned + description: Auto merge was enabled for a pull request. For more information, + see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)." + operationId: pull-request/auto-merge-enabled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61736,7 +65978,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-milestoned" + "$ref": "#/components/schemas/webhook-pull-request-auto-merge-enabled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61749,7 +65991,7 @@ x-webhooks: - repository - organization - app - pull-request-opened: + pull-request-closed: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61757,8 +65999,10 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request was created - operationId: pull-request/opened + description: A pull request was closed. If `merged` is false in the webhook + payload, the pull request was closed with unmerged commits. If `merged` is + true in the webhook payload, the pull request was merged. + operationId: pull-request/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61802,7 +66046,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-opened" + "$ref": "#/components/schemas/webhook-pull-request-closed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61815,7 +66059,7 @@ x-webhooks: - repository - organization - app - pull-request-ready-for-review: + pull-request-converted-to-draft: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61823,9 +66067,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A draft pull request was marked as ready for review. For more information, + description: A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." - operationId: pull-request/ready-for-review + operationId: pull-request/converted-to-draft externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61869,7 +66113,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" + "$ref": "#/components/schemas/webhook-pull-request-converted-to-draft" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61882,7 +66126,7 @@ x-webhooks: - repository - organization - app - pull-request-reopened: + pull-request-demilestoned: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -61890,8 +66134,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously closed pull request was reopened. - operationId: pull-request/reopened + description: A pull request was removed from a milestone. + operationId: pull-request/demilestoned externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -61935,7 +66179,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-reopened" + "$ref": "#/components/schemas/webhook-pull-request-demilestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -61948,150 +66192,18 @@ x-webhooks: - repository - organization - app - pull-request-review-comment-created: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was created. - operationId: pull-request-review-comment/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - 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-pull-request-review-comment-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-deleted: - post: - summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. - - To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment on a pull request diff was deleted. - operationId: pull-request-review-comment/deleted - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment - 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-pull-request-review-comment-deleted" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: pull_request_review_comment - supported-webhook-types: - - repository - - organization - - app - pull-request-review-comment-edited: + pull-request-dequeued: post: summary: |- - This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The content of a comment on a pull request diff was changed. - operationId: pull-request-review-comment/edited + description: A pull request was removed from the merge queue. + operationId: pull-request/dequeued externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62133,7 +66245,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" + "$ref": "#/components/schemas/webhook-pull-request-dequeued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62141,23 +66253,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_comment + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-dismissed: + pull-request-edited: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was dismissed. - operationId: pull-request-review/dismissed + description: The title or body of a pull request was edited, or the base branch + of a pull request was changed. + operationId: pull-request/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62199,7 +66312,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" + "$ref": "#/components/schemas/webhook-pull-request-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62207,23 +66320,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-edited: + pull-request-enqueued: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: The body comment on a pull request review was edited. - operationId: pull-request-review/edited + description: A pull request was added to the merge queue. + operationId: pull-request/enqueued externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62265,7 +66378,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-edited" + "$ref": "#/components/schemas/webhook-pull-request-enqueued" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62273,12 +66386,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-request-removed: + pull-request-labeled: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62286,9 +66399,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A request for review by a person or team was removed from a pull - request. - operationId: pull-request/review-request-removed + description: A label was added to a pull request. + operationId: pull-request/labeled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62332,7 +66444,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" + "$ref": "#/components/schemas/webhook-pull-request-labeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62345,7 +66457,7 @@ x-webhooks: - repository - organization - app - pull-request-review-requested: + pull-request-locked: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62353,9 +66465,9 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Review by a person or team was requested for a pull request. For - more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." - operationId: pull-request/review-requested + description: Conversation on a pull request was locked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62399,7 +66511,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-requested" + "$ref": "#/components/schemas/webhook-pull-request-locked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62412,18 +66524,18 @@ x-webhooks: - repository - organization - app - pull-request-review-submitted: + pull-request-milestoned: post: summary: |- - This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A review on a pull request was submitted. - operationId: pull-request-review/submitted + description: A pull request was added to a milestone. + operationId: pull-request/milestoned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62465,7 +66577,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-submitted" + "$ref": "#/components/schemas/webhook-pull-request-milestoned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62473,23 +66585,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-thread-resolved: + pull-request-opened: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A comment thread on a pull request was marked as resolved. - operationId: pull-request-review-thread/resolved + description: A pull request was created + operationId: pull-request/opened externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62531,7 +66643,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" + "$ref": "#/components/schemas/webhook-pull-request-opened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62539,24 +66651,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-review-thread-unresolved: + pull-request-ready-for-review: post: summary: |- - This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A previously resolved comment thread on a pull request was marked - as unresolved. - operationId: pull-request-review-thread/unresolved + description: A draft pull request was marked as ready for review. For more information, + see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)." + operationId: pull-request/ready-for-review externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -62598,7 +66710,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" + "$ref": "#/components/schemas/webhook-pull-request-ready-for-review" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62606,12 +66718,12 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request_review_thread + subcategory: pull_request supported-webhook-types: - repository - organization - app - pull-request-synchronize: + pull-request-reopened: post: summary: |- This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. @@ -62619,10 +66731,8 @@ x-webhooks: For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A pull request's head branch was updated. For example, the head - branch was updated from the base branch or new commits were pushed to the - head branch. - operationId: pull-request/synchronize + description: A previously closed pull request was reopened. + operationId: pull-request/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: @@ -62666,7 +66776,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-synchronize" + "$ref": "#/components/schemas/webhook-pull-request-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62679,18 +66789,18 @@ x-webhooks: - repository - organization - app - pull-request-unassigned: + pull-request-review-comment-created: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A user was unassigned from a pull request. - operationId: pull-request/unassigned + description: A comment on a pull request diff was created. + operationId: pull-request-review-comment/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -62732,7 +66842,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unassigned" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62740,23 +66850,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-unlabeled: + pull-request-review-comment-deleted: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: A label was removed from a pull request. - operationId: pull-request/unlabeled + description: A comment on a pull request diff was deleted. + operationId: pull-request-review-comment/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -62798,7 +66908,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlabeled" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62806,24 +66916,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - pull-request-unlocked: + pull-request-review-comment-edited: post: summary: |- - This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request's diff. For more information, see "[Commenting on a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. - description: Conversation on a pull request was unlocked. For more information, - see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." - operationId: pull-request/unlocked + description: The content of a comment on a pull request diff was changed. + operationId: pull-request-review-comment/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment parameters: - name: User-Agent in: header @@ -62865,7 +66974,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-pull-request-unlocked" + "$ref": "#/components/schemas/webhook-pull-request-review-comment-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62873,25 +66982,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: pull_request + subcategory: pull_request_review_comment supported-webhook-types: - repository - organization - app - push: + pull-request-review-dismissed: post: summary: |- - This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, - when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch - and tag deletions, use the [`delete`](#delete) webhook event. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. - operationId: push + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was dismissed. + operationId: pull-request-review/dismissed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#push + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -62933,7 +67040,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-push" + "$ref": "#/components/schemas/webhook-pull-request-review-dismissed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -62941,24 +67048,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: push + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - registry-package-published: + pull-request-review-edited: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package was published to a registry. - operationId: registry-package/published + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: The body comment on a pull request review was edited. + operationId: pull-request-review/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -63000,7 +67106,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-published" + "$ref": "#/components/schemas/webhook-pull-request-review-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63008,24 +67114,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - registry-package-updated: + pull-request-review-request-removed: post: summary: |- - This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. - > [!NOTE] - > GitHub recommends that you use the newer `package` event instead. - description: A package that was previously published to a registry was updated. - operationId: registry-package/updated + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A request for review by a person or team was removed from a pull + request. + operationId: pull-request/review-request-removed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63067,7 +67173,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-registry-package-updated" + "$ref": "#/components/schemas/webhook-pull-request-review-request-removed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63075,22 +67181,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: registry_package + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-created: + pull-request-review-requested: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A draft was saved, or a release or pre-release was published without - previously being saved as a draft. - operationId: release/created + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Review by a person or team was requested for a pull request. For + more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." + operationId: pull-request/review-requested externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63132,7 +67240,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-created" + "$ref": "#/components/schemas/webhook-pull-request-review-requested" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63140,21 +67248,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-deleted: + pull-request-review-submitted: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/rest/pulls/reviews)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft release was deleted. - operationId: release/deleted + For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A review on a pull request was submitted. + operationId: pull-request-review/submitted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review parameters: - name: User-Agent in: header @@ -63196,7 +67306,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-deleted" + "$ref": "#/components/schemas/webhook-pull-request-review-submitted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63204,22 +67314,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request_review supported-webhook-types: - repository - organization - app - release-edited: + pull-request-review-thread-resolved: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The details of a release, pre-release, or draft release were edited. - For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." - operationId: release/edited + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A comment thread on a pull request was marked as resolved. + operationId: pull-request-review-thread/resolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -63261,7 +67372,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-edited" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63269,22 +67380,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - release-prereleased: + pull-request-review-thread-unresolved: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/rest/pulls/comments)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was created and identified as a pre-release. A pre-release - is a release that is not ready for production and may be unstable. - operationId: release/prereleased + For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A previously resolved comment thread on a pull request was marked + as unresolved. + operationId: pull-request-review-thread/unresolved externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread parameters: - name: User-Agent in: header @@ -63326,7 +67439,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-pull-request-review-thread-unresolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63334,21 +67447,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request_review_thread supported-webhook-types: - repository - organization - app - release-published: + pull-request-synchronize: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release, pre-release, or draft of a release was published. - operationId: release/published + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A pull request's head branch was updated. For example, the head + branch was updated from the base branch or new commits were pushed to the + head branch. + operationId: pull-request/synchronize externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63390,7 +67507,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-pull-request-synchronize" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63398,21 +67515,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-released: + pull-request-unassigned: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release was published, or a pre-release was changed to a release. - operationId: release/released + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A user was unassigned from a pull request. + operationId: pull-request/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63454,7 +67573,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-pull-request-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63462,21 +67581,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - release-unpublished: + pull-request-unlabeled: post: summary: |- - This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: A release or pre-release was unpublished. - operationId: release/unpublished + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: A label was removed from a pull request. + operationId: pull-request/unlabeled externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#release + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63518,7 +67639,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-pull-request-unlabeled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63526,21 +67647,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: release + subcategory: pull_request supported-webhook-types: - repository - organization - app - repository-advisory-published: + pull-request-unlocked: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/rest/pulls/pulls)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A repository security advisory was published. - operationId: repository-advisory/published + For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission. + description: Conversation on a pull request was unlocked. For more information, + see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request parameters: - name: User-Agent in: header @@ -63582,7 +67706,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-pull-request-unlocked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63590,21 +67714,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: pull_request supported-webhook-types: - repository - organization - app - repository-advisory-reported: + push: post: summary: |- - This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." + This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed, + when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch + and tag deletions, use the [`delete`](#delete) webhook event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. - description: A private vulnerability report was submitted. - operationId: repository-advisory/reported + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + + > [!NOTE] + > Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once. + operationId: push externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#push parameters: - name: User-Agent in: header @@ -63646,7 +67774,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-push" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63654,21 +67782,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_advisory + subcategory: push supported-webhook-types: - repository - organization - app - repository-archived: + registry-package-published: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" 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: A repository was archived. - operationId: repository/archived + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. + description: A package was published to a registry. + operationId: registry-package/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -63710,7 +67841,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-registry-package-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63718,22 +67849,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: registry_package supported-webhook-types: - - business - repository - organization - app - repository-created: + registry-package-updated: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#package) or "[Packages](https://docs.github.com/rest/packages)" 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: A repository was created. - operationId: repository/created + To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission. + + > [!NOTE] + > GitHub recommends that you use the newer `package` event instead. + description: A package that was previously published to a registry was updated. + operationId: registry-package/updated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package parameters: - name: User-Agent in: header @@ -63775,7 +67908,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-registry-package-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63783,23 +67916,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: registry_package supported-webhook-types: - - business - repository - organization - app - repository-deleted: + release-created: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: A repository was deleted. GitHub Apps and repository webhooks will - not receive this event. - operationId: repository/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A draft was saved, or a release or pre-release was published without + previously being saved as a draft. + operationId: release/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -63841,7 +67973,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-release-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63849,21 +67981,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-dispatch-sample.collected: + release-deleted: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: repository-dispatch/sample.collected + description: A release, pre-release, or draft release was deleted. + operationId: release/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -63905,7 +68037,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + "$ref": "#/components/schemas/webhook-release-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63913,20 +68045,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_dispatch + subcategory: release supported-webhook-types: + - repository + - organization - app - repository-edited: + release-edited: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The topics, default branch, description, or homepage of a repository - was changed. - operationId: repository/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: The details of a release, pre-release, or draft release were edited. + For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -63968,7 +68102,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-release-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -63976,20 +68110,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-import: + release-prereleased: post: - summary: This event occurs when a repository is imported to GitHub. For more - information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." - For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). - operationId: repository-import + summary: |- + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release was created and identified as a pre-release. A pre-release + is a release that is not ready for production and may be unstable. + operationId: release/prereleased externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64031,7 +68167,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-release-prereleased" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64039,20 +68175,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_import + subcategory: release supported-webhook-types: - repository - organization - repository-privatized: + - app + release-published: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The visibility of a repository was changed to `private`. - operationId: repository/privatized + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release, pre-release, or draft of a release was published. + operationId: release/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64094,7 +68231,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-release-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64102,22 +68239,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-publicized: + release-released: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The visibility of a repository was changed to `public`. - operationId: repository/publicized + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release was published, or a pre-release was changed to a release. + operationId: release/released externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64159,7 +68295,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-release-released" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64167,22 +68303,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-renamed: + release-unpublished: post: summary: |- - This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. + This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#release) or "[Releases](https://docs.github.com/rest/releases)" 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: The name of a repository was changed. - operationId: repository/renamed + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + description: A release or pre-release was unpublished. + operationId: release/unpublished externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository + url: https://docs.github.com/webhooks/webhook-events-and-payloads#release parameters: - name: User-Agent in: header @@ -64224,7 +68359,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-release-unpublished" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64232,24 +68367,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository + subcategory: release supported-webhook-types: - - business - repository - organization - app - repository-ruleset-created: + repository-advisory-published: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was created. - operationId: repository-ruleset/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A repository security advisory was published. + operationId: repository-advisory/published externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -64291,7 +68423,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64299,23 +68431,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - repository-ruleset-deleted: + repository-advisory-reported: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was deleted. - operationId: repository-ruleset/deleted + To subscribe to this event, a GitHub App must have at least read-level access for the "Repository security advisories" permission. + description: A private vulnerability report was submitted. + operationId: repository-advisory/reported externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory parameters: - name: User-Agent in: header @@ -64357,7 +68487,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64365,23 +68495,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository_advisory supported-webhook-types: - repository - organization - app - repository-ruleset-edited: + repository-archived: post: summary: |- - This event occurs when there is activity relating to repository rulesets. - For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." - For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. - description: A repository ruleset was edited. - operationId: repository-ruleset/edited + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A repository was archived. + operationId: repository/archived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64423,7 +68551,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-archived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64431,23 +68559,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_ruleset + subcategory: repository supported-webhook-types: + - business - repository - organization - app - repository-transferred: + repository-created: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" 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: Ownership of the repository was transferred to a user or organization - account. This event is only sent to the account where the ownership is transferred. - To receive the `repository.transferred` event, the new owner account must - have the GitHub App installed, and the App must be subscribed to "Repository" - events. - operationId: repository/transferred + description: A repository was created. + operationId: repository/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -64491,7 +68616,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64505,14 +68630,15 @@ x-webhooks: - repository - organization - app - repository-unarchived: + repository-deleted: post: summary: |- This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" 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: A previously archived repository was unarchived. - operationId: repository/unarchived + description: A repository was deleted. GitHub Apps and repository webhooks will + not receive this event. + operationId: repository/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: @@ -64556,7 +68682,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64570,17 +68696,15 @@ x-webhooks: - repository - organization - app - repository-vulnerability-alert-create: + repository-dispatch-sample.collected: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - > [!WARNING] - > **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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: repository-dispatch/sample.collected externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch parameters: - name: User-Agent in: header @@ -64622,7 +68746,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64630,21 +68754,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository_dispatch supported-webhook-types: - - repository - - organization - repository-vulnerability-alert-dismiss: + - app + repository-edited: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - > [!WARNING] - > **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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The topics, default branch, description, or homepage of a repository + was changed. + operationId: repository/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64686,7 +68809,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64694,22 +68817,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - repository-vulnerability-alert-reopen: + - app + repository-import: post: - summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. - - > [!WARNING] - > **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 + summary: This event occurs when a repository is imported to GitHub. For more + information, see "[Importing a repository with GitHub Importer](https://docs.github.com/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer)." + For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports). + operationId: repository-import externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import parameters: - name: User-Agent in: header @@ -64751,7 +68872,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-repository-import" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64759,21 +68880,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository_import supported-webhook-types: - repository - organization - repository-vulnerability-alert-resolve: + repository-privatized: post: summary: |- - This event occurs when there is activity relating to a security vulnerability alert in a repository. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - > [!WARNING] - > **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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `private`. + operationId: repository/privatized externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64815,7 +68935,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-repository-privatized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64823,22 +68943,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: repository_vulnerability_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - secret-scanning-alert-created: + - app + repository-publicized: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - 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 created. - operationId: secret-scanning-alert/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The visibility of a repository was changed to `public`. + operationId: repository/publicized externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64880,7 +69000,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-repository-publicized" responses: '200': description: Return a 200 status to indicate that the data was received @@ -64888,26 +69008,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - app - secret-scanning-alert-location-created: + repository-renamed: post: summary: |- - This event occurs when there is activity relating to the locations of a secret in 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 alerts, use the `secret_scanning_alert` event. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. - description: A new instance of a previously detected secret was detected in - a repository, and the location of the secret was added to the existing alert. - operationId: secret-scanning-alert-location/created + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: The name of a repository was changed. + operationId: repository/renamed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -64949,41 +69065,32 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created" - application/x-www-form-urlencoded: - schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - examples: - default: - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + "$ref": "#/components/schemas/webhook-repository-renamed" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false - enabledForGitHubApps: true category: webhooks - subcategory: secret_scanning_alert_location + subcategory: repository supported-webhook-types: + - business - repository - organization - app - secret-scanning-alert-publicly-leaked: + repository-ruleset-created: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - 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. - operationId: secret-scanning-alert/publicly-leaked + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was created. + operationId: repository-ruleset/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -65025,7 +69132,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65033,23 +69140,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository_ruleset supported-webhook-types: - repository - organization - app - secret-scanning-alert-reopened: + repository-ruleset-deleted: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was deleted. + operationId: repository-ruleset/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -65091,7 +69198,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65099,23 +69206,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository_ruleset supported-webhook-types: - repository - organization - app - secret-scanning-alert-resolved: + repository-ruleset-edited: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repository rulesets. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets)." + For more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/rest/repos/rules)" and "[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation." - 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission. + description: A repository ruleset was edited. + operationId: repository-ruleset/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset parameters: - name: User-Agent in: header @@ -65157,7 +69264,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65165,23 +69272,25 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository_ruleset supported-webhook-types: - repository - organization - app - secret-scanning-alert-validated: + repository-transferred: 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. - - For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - 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 + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Ownership of the repository was transferred to a user or organization + account. This event is only sent to the account where the ownership is transferred. + To receive the `repository.transferred` event, the new owner account must + have the GitHub App installed, and the App must be subscribed to "Repository" + events. + operationId: repository/transferred externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -65223,7 +69332,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" + "$ref": "#/components/schemas/webhook-repository-transferred" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65231,24 +69340,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_alert + subcategory: repository supported-webhook-types: + - business - repository - organization - app - secret-scanning-scan-completed: + repository-unarchived: post: summary: |- - This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - - Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates - to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/rest/repos)" in the REST API documentation. - 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 scan was completed. - operationId: secret-scanning-scan/completed + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: A previously archived repository was unarchived. + operationId: repository/unarchived externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository parameters: - name: User-Agent in: header @@ -65290,7 +69397,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" + "$ref": "#/components/schemas/webhook-repository-unarchived" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65298,21 +69405,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: secret_scanning_scan + subcategory: repository supported-webhook-types: + - business - repository - organization - app - security-advisory-published: + repository-vulnerability-alert-create: 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 security vulnerability alert in a repository. - 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 + > [!WARNING] + > **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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65354,7 +69463,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65362,19 +69471,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: repository_vulnerability_alert supported-webhook-types: - - app - security-advisory-updated: + - repository + - organization + repository-vulnerability-alert-dismiss: 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 security vulnerability alert in a repository. - 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 + > [!WARNING] + > **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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65416,7 +69527,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65424,19 +69535,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: repository_vulnerability_alert supported-webhook-types: - - app - security-advisory-withdrawn: + - repository + - organization + repository-vulnerability-alert-reopen: 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 security vulnerability alert in a repository. - 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 + > [!WARNING] + > **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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65478,7 +69592,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65486,18 +69600,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: repository_vulnerability_alert supported-webhook-types: - - app - security-and-analysis: + - repository + - organization + repository-vulnerability-alert-resolve: 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 security vulnerability alert in a repository. - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + > [!WARNING] + > **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: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert parameters: - name: User-Agent in: header @@ -65539,7 +69656,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65547,24 +69664,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: repository_vulnerability_alert supported-webhook-types: - repository - organization - - app - sponsorship-cancelled: + secret-scanning-alert-assigned: 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 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. - 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. + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + 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 assigned. + operationId: secret-scanning-alert/assigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65606,7 +69721,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65614,20 +69729,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-created: + - repository + - organization + - app + secret-scanning-alert-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). + 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. - 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 + 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 created. + operationId: secret-scanning-alert/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65669,7 +69787,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65677,21 +69795,26 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-edited: + - repository + - organization + - app + secret-scanning-alert-location-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). + This event occurs when there is activity relating to the locations of a secret in a secret scanning alert. - 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 + 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 alerts, use the `secret_scanning_alert` 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 new instance of a previously detected secret was detected in + a repository, and the location of the secret was added to the existing alert. + operationId: secret-scanning-alert-location/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location parameters: - name: User-Agent in: header @@ -65733,30 +69856,41 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created" + application/x-www-form-urlencoded: + schema: + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + examples: + default: + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" responses: '200': description: Return a 200 status to indicate that the data was received successfully x-github: githubCloudOnly: false + enabledForGitHubApps: true category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert_location supported-webhook-types: - - sponsors_listing - sponsorship-pending-cancellation: + - repository + - organization + - app + secret-scanning-alert-publicly-leaked: 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 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. - 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. + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + 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. + operationId: secret-scanning-alert/publicly-leaked externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65798,7 +69932,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65806,20 +69940,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-pending-tier-change: + - repository + - organization + - app + secret-scanning-alert-reopened: 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 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. - 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 + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65861,7 +69998,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65869,22 +70006,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - sponsorship-tier-changed: + - repository + - organization + - app + secret-scanning-alert-resolved: 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 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. - 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 + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65926,7 +70064,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65934,19 +70072,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: secret_scanning_alert supported-webhook-types: - - sponsors_listing - star-created: + - repository + - organization + - app + secret-scanning-alert-unassigned: 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 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. - 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 + 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 unassigned. + operationId: secret-scanning-alert/unassigned externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -65988,7 +70130,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" responses: '200': description: Return a 200 status to indicate that the data was received @@ -65996,21 +70138,23 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - star-deleted: + secret-scanning-alert-validated: 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 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. - 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 + 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#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -66052,7 +70196,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66060,20 +70204,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: secret_scanning_alert supported-webhook-types: - repository - organization - app - status: + secret-scanning-scan-completed: 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 secret scanning completes certain scans on a repository. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + Scans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates + to patterns from partners. For more information on custom patterns, see "[About custom patterns](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns)." + + 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 scan was completed. + operationId: secret-scanning-scan/completed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_scan parameters: - name: User-Agent in: header @@ -66115,7 +70263,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66123,23 +70271,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: secret_scanning_scan supported-webhook-types: - repository - organization - app - sub-issues-parent-issue-added: + security-advisory-published: 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 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 "Issues" repository permissions. - description: A parent issue was added to an issue. - operationId: sub-issues/parent-issue-added + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -66181,7 +70327,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66189,23 +70335,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sub-issues-parent-issue-removed: + security-advisory-updated: 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 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 "Issues" repository permissions. - description: A parent issue was removed from an issue. - operationId: sub-issues/parent-issue-removed + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -66247,7 +70389,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66255,23 +70397,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sub-issues-sub-issue-added: + security-advisory-withdrawn: 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 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 "Issues" repository permissions. - description: A sub-issue was added to an issue. - operationId: sub-issues/sub-issue-added + 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#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -66313,7 +70451,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66321,23 +70459,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sub-issues-sub-issue-removed: + security-and-analysis: 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 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)." - 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 + 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#sub-issues + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -66379,7 +70512,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66387,23 +70520,24 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sub-issues + subcategory: security_and_analysis supported-webhook-types: - repository - organization - app - team-add: + sponsorship-cancelled: 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 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). - For activity relating to teams, see the `teams` event. + 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. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add + 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#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66445,7 +70579,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66453,22 +70587,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - team-added-to-repository: + - sponsors_listing + sponsorship-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)." + 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 "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository + 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66510,7 +70642,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66518,22 +70650,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-created: + - sponsors_listing + sponsorship-edited: 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 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 "Members" organization permission. - description: A team was created. - operationId: team/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 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66575,7 +70706,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66583,22 +70714,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-deleted: + - sponsors_listing + sponsorship-pending-cancellation: 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 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 "Members" organization permission. - description: A team was deleted. - operationId: team/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 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66640,7 +70771,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66648,22 +70779,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-edited: + - sponsors_listing + sponsorship-pending-tier-change: 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 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 "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited + 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66705,7 +70834,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66713,22 +70842,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - team-removed-from-repository: + - sponsors_listing + sponsorship-tier-changed: 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 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 "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository + 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#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -66770,7 +70899,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66778,21 +70907,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: sponsorship supported-webhook-types: - - organization - - business - - app - watch-started: + - sponsors_listing + star-created: 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 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 "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -66834,7 +70961,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66842,22 +70969,21 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: watch + subcategory: star supported-webhook-types: - repository - organization - app - workflow-dispatch: + star-deleted: 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 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 "Contents" repository permission. - operationId: workflow-dispatch + 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#workflow_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -66899,7 +71025,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66907,23 +71033,20 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_dispatch + subcategory: star supported-webhook-types: + - repository + - organization - app - workflow-job-completed: + status: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + 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 "Actions" repository permission. - description: A job in a workflow run finished. This event occurs when a job - in a workflow is completed, regardless of whether the job was successful or - unsuccessful. - operationId: workflow-job/completed + 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#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -66965,7 +71088,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -66973,24 +71096,874 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: status supported-webhook-types: - - business - repository - organization - app - workflow-job-in-progress: + sub-issues-parent-issue-added: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when there is activity relating to sub-issues. - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` 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 "Actions" repository permission. - description: A job in a workflow run started processing on a runner. - operationId: workflow-job/in-progress + 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 externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sub-issues + 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-sub-issues-parent-issue-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + sub-issues-parent-issue-removed: + 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. + + 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#sub-issues + 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-sub-issues-parent-issue-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + sub-issues-sub-issue-added: + 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. + + 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#sub-issues + 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-sub-issues-sub-issue-added" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + sub-issues-sub-issue-removed: + 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. + + 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#sub-issues + 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-sub-issues-sub-issue-removed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sub-issues + supported-webhook-types: + - repository + - organization + - app + team-add: + 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)." + + 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. + operationId: team-add + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + 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-add" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: team_add + supported-webhook-types: + - repository + - organization + - app + 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: 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: + - 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-added-to-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 + 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 was created. + operationId: team/created + 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-created" + 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-deleted: + 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 was deleted. + operationId: team/deleted + 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-deleted" + 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-edited: + 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 + 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-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 + 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-workflow-dispatch" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_dispatch + supported-webhook-types: + - app + workflow-job-completed: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run finished. This event occurs when a job + in a workflow is completed, regardless of whether the job was successful or + unsuccessful. + operationId: workflow-job/completed + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + 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-workflow-job-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-job-in-progress: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run started processing on a runner. + operationId: workflow-job/in-progress + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job parameters: - name: User-Agent in: header @@ -68099,7 +73072,9 @@ components: issues: read deployments: write events: - description: The list of events for the GitHub app + description: The list of events for the GitHub app. Note that the `installation_target`, + `security_advisory`, and `meta` events are not included because they are + global events and not specific to an installation. example: - label - deployment @@ -68107,20 +73082,10 @@ components: items: type: string installations_count: - description: The number of installations associated with the GitHub app + description: The number of installations associated with the GitHub app. + Only returned when the integration is requesting details about itself. example: 5 type: integer - client_secret: - type: string - example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' - webhook_secret: - type: string - example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' - nullable: true - pem: - type: string - example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END - RSA PRIVATE KEY-----\n"' required: - id - node_id @@ -68179,6 +73144,7 @@ components: id: description: Unique identifier of the webhook delivery. type: integer + format: int64 example: 42 guid: description: Unique identifier for the event (shared with all deliveries @@ -68219,11 +73185,13 @@ components: description: The id of the GitHub App installation associated with this event. type: integer + format: int64 example: 123 nullable: true repository_id: description: The id of the repository associated with this event. type: integer + format: int64 example: 123 nullable: true throttled_at: @@ -68463,6 +73431,20 @@ components: enum: - read - write + artifact_metadata: + type: string + description: The level of permission to grant the access token to create + and retrieve build artifact metadata records. + enum: + - read + - write + attestations: + type: string + description: The level of permission to create and retrieve the access token + for repository attestations. + enum: + - read + - write checks: type: string description: The level of permission to grant the access token for checks @@ -68486,7 +73468,7 @@ components: - write dependabot_secrets: type: string - description: The leve of permission to grant the access token to manage + description: The level of permission to grant the access token to manage Dependabot secrets. enum: - read @@ -68498,6 +73480,13 @@ components: enum: - read - write + discussions: + type: string + description: The level of permission to grant the access token for discussions + and related comments and labels. + enum: + - read + - write environments: type: string description: The level of permission to grant the access token for managing @@ -68512,6 +73501,13 @@ components: enum: - read - write + merge_queues: + type: string + description: The level of permission to grant the access token to manage + the merge queues for a repository. + enum: + - read + - write metadata: type: string description: The level of permission to grant the access token to search @@ -68610,6 +73606,13 @@ components: GitHub Actions workflow files. enum: - write + custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for an organization, when allowed by the property. + enum: + - read + - write members: type: string description: The level of permission to grant the access token for organization @@ -68640,8 +73643,8 @@ components: - write organization_custom_properties: type: string - description: The level of permission to grant the access token for custom - property management. + description: The level of permission to grant the access token for repository + custom properties management at the organization level. enum: - read - write @@ -68731,13 +73734,6 @@ components: enum: - read - write - team_discussions: - type: string - description: The level of permission to grant the access token to manage - team discussions and related comments. - enum: - - read - - write email_addresses: type: string description: The level of permission to grant the access token to manage @@ -68786,6 +73782,14 @@ components: enum: - read - write + enterprise_custom_properties_for_organizations: + type: string + description: The level of permission to grant the access token for organization + custom properties management at the enterprise level. + enum: + - read + - write + - admin example: contents: read issues: read @@ -68927,6 +73931,9 @@ components: app_id: type: integer example: 1 + client_id: + type: string + example: Iv1.ab1112223334445c target_id: description: The ID of the user or organization this token is being scoped to. @@ -69291,6 +74298,19 @@ components: default: false type: boolean example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all archived: description: Whether the repository is archived. default: false @@ -69421,6 +74441,14 @@ components: anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string required: - archive_url - assignees_url @@ -70168,6 +75196,26 @@ components: - html_url - key - name + actions-cache-retention-limit-for-enterprise: + title: Actions cache retention limit for an enterprise + description: GitHub Actions cache retention policy for an enterprise. + type: object + properties: + max_cache_retention_days: + description: For repositories & organizations in an enterprise, the maximum + duration, in days, for which caches in a repository may be retained. + type: integer + example: 14 + actions-cache-storage-limit-for-enterprise: + title: Actions cache storage limit for an enterprise + description: GitHub Actions cache storage policy for an enterprise. + type: object + properties: + max_cache_size_gb: + description: For repositories & organizations in an enterprise, the maximum + size limit for the sum of all caches in a repository, in gigabytes. + type: integer + example: 10 code-security-configuration: type: object description: A code security configuration @@ -70195,6 +75243,8 @@ components: enum: - enabled - disabled + - code_security + - secret_protection dependency_graph: type: string description: The enablement status of Dependency Graph @@ -70231,6 +75281,23 @@ components: - enabled - disabled - not_set + dependabot_delegated_alert_dismissal: + type: string + nullable: true + description: The enablement status of Dependabot delegated alert dismissal + enum: + - enabled + - disabled + - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true + properties: + allow_advanced: + nullable: true + type: boolean + description: Whether to allow repos which use advanced setup code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -70256,6 +75323,13 @@ components: type: string description: The label of the runner to use for code scanning when runner_type is 'labeled'. + code_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of code scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set secret_scanning: type: string description: The enablement status of secret scanning @@ -70299,6 +75373,10 @@ components: enum: - TEAM - ROLE + security_configuration_id: + type: integer + description: The ID of the security configuration associated with + this bypass reviewer secret_scanning_validity_checks: type: string description: The enablement status of secret scanning validity checks @@ -70313,6 +75391,27 @@ components: - enabled - disabled - not_set + secret_scanning_generic_secrets: + type: string + description: The enablement status of Copilot secret scanning + enum: + - enabled + - disabled + - not_set + secret_scanning_delegated_alert_dismissal: + type: string + description: The enablement status of secret scanning delegated alert dismissal + enum: + - enabled + - disabled + - not_set + secret_scanning_extended_metadata: + type: string + description: The enablement status of secret scanning extended metadata + enum: + - enabled + - disabled + - not_set private_vulnerability_reporting: type: string description: The enablement status of private vulnerability reporting @@ -70340,6 +75439,15 @@ components: updated_at: type: string format: date-time + code-scanning-options: + type: object + description: Security Configuration feature options for code scanning + nullable: true + properties: + allow_advanced: + nullable: true + type: boolean + description: Whether to allow repos which use advanced setup code-scanning-default-setup-options: type: object description: Feature options for code scanning default setup @@ -70926,6 +76034,42 @@ components: format: date-time readOnly: true nullable: true + dependabot-alert-dismissal-request-simple: + title: Dependabot alert dismissal request + description: Information about an active dismissal request for this Dependabot + alert. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the dismissal request. + status: + type: string + description: The current status of the dismissal request. + enum: + - pending + - approved + - rejected + - cancelled + requester: + type: object + description: The user who requested the dismissal. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The login name of the user. + created_at: + type: string + format: date-time + description: The date and time when the dismissal request was created. + url: + type: string + format: uri + description: The API URL to get more information about this dismissal request. dependabot-alert-with-repository: type: object description: A Dependabot alert. @@ -70961,6 +76105,19 @@ components: enum: - development - runtime + relationship: + type: string + description: | + The vulnerable dependency's relationship to your project. + + > [!NOTE] + > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + readOnly: true + nullable: true + enum: + - unknown + - direct + - transitive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -70996,6 +76153,14 @@ components: "$ref": "#/components/schemas/alert-fixed-at" auto_dismissed_at: "$ref": "#/components/schemas/alert-auto-dismissed-at" + dismissal_request: + "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + "$ref": "#/components/schemas/simple-user" repository: "$ref": "#/components/schemas/simple-repository" required: @@ -71015,117 +76180,121 @@ components: - fixed_at - repository additionalProperties: false - nullable-alert-updated-at: - type: string - description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - format: date-time - readOnly: true - nullable: true - secret-scanning-alert-state: - description: Sets the state of the secret scanning alert. You must provide `resolution` - when you set the state to `resolved`. - type: string - enum: - - open - - resolved - secret-scanning-alert-resolution: - type: string - description: "**Required when the `state` is `resolved`.** The reason for resolving - the alert." - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - organization-secret-scanning-alert: + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members type: object properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - "$ref": "#/components/schemas/nullable-alert-updated-at" + id: + type: integer + format: int64 + name: + type: string + description: + type: string + slug: + type: string url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: type: string format: uri - description: The REST API URL of the code locations for this alert. - state: - "$ref": "#/components/schemas/secret-scanning-alert-state" - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - resolved_at: + sync_to_organizations: type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + description: 'Retired: this field will not be returned with GHEC enterprise + teams.' + example: disabled | all + organization_selection_type: + type: string + example: disabled | selected | all + group_id: nullable: true - resolved_by: - "$ref": "#/components/schemas/nullable-simple-user" - secret_type: type: string - description: The type of secret that secret scanning detected. - secret_type_display_name: + example: 62ab9291-fae2-468e-974b-7e45096d5021 + group_name: + nullable: true type: string - description: |- - User-friendly name for the detected secret, matching the `secret_type`. - For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." - secret: + description: 'Retired: this field will not be returned with GHEC enterprise + teams.' + example: Justice League + html_url: type: string - description: The secret that was detected. - repository: - "$ref": "#/components/schemas/simple-repository" - push_protection_bypassed: - type: boolean - description: Whether push protection was bypassed for the detected secret. - nullable: true - push_protection_bypassed_by: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypassed_at: + format: uri + example: https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: type: string format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - push_protection_bypass_request_reviewer: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypass_request_reviewer_comment: + updated_at: type: string - description: An optional comment when reviewing a push protection bypass. - nullable: true - push_protection_bypass_request_comment: + format: date-time + required: + - id + - url + - members_url + - name + - html_url + - slug + - created_at + - updated_at + - group_id + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: type: string - description: An optional comment when requesting a push protection bypass. - nullable: true - push_protection_bypass_request_html_url: + example: github + id: + type: integer + example: 1 + node_id: + type: string + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: type: string format: uri - description: The URL to a push protection bypass request. - nullable: true - resolution_comment: + example: https://api.github.com/orgs/github + repos_url: type: string - description: The comment that was optionally added when this alert was closed - nullable: true - validity: + format: uri + example: https://api.github.com/orgs/github/repos + events_url: type: string - description: The token status as of the latest validity check. - enum: - - 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. + 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 actor: title: Actor description: Actor @@ -71152,6 +76321,359 @@ components: - gravatar_id - url - avatar_url + label: + title: Label + description: Color-coded labels help you categorize and filter your issues (just + like labels in Gmail). + type: object + properties: + id: + description: Unique identifier for the label. + type: integer + format: int64 + example: 208045946 + node_id: + type: string + example: MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + example: https://api.github.com/repositories/42/labels/bug + type: string + format: uri + name: + description: The name of the label. + example: bug + type: string + description: + description: Optional description of the label, such as its purpose. + type: string + example: Something isn't working + nullable: true + color: + description: '6-character hex code, without the leading #, identifying the + color' + example: FFFFFF + type: string + default: + description: Whether this label comes by default in a new repository. + type: boolean + example: true + required: + - id + - node_id + - url + - name + - description + - color + - default + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: string + nullable: true + answer_chosen_at: + type: string + nullable: true + answer_chosen_by: + 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 + required: + - login + - id + answer_html_url: + type: string + nullable: true + 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 + category: + type: object + properties: + created_at: + type: string + format: date-time + description: + type: string + emoji: + type: string + id: + type: integer + is_answerable: + type: boolean + name: + type: string + node_id: + type: string + repository_id: + type: integer + slug: + type: string + updated_at: + type: string + required: + - id + - repository_id + - emoji + - name + - description + - created_at + - updated_at + - slug + - is_answerable + comments: + type: integer + created_at: + type: string + format: date-time + html_url: + type: string + id: + type: integer + locked: + type: boolean + node_id: + type: string + number: + type: integer + 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 + state: + type: string + description: |- + The current state of the discussion. + `converting` means that the discussion is being converted from an issue. + `transferring` means that the discussion is being transferred from another repository. + enum: + - open + - closed + - locked + - converting + - transferring + state_reason: + description: The reason for the current state + example: resolved + type: string + nullable: true + enum: + - resolved + - outdated + - duplicate + - reopened + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + 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 + 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 + - active_lock_reason + - body nullable-milestone: title: Milestone description: A collection of related issues and pull requests. @@ -71239,6 +76761,54 @@ components: - created_at - updated_at nullable: true + issue-type: + title: Issue Type + description: The type of issue. + type: object + nullable: true + properties: + id: + type: integer + description: The unique identifier of the issue type. + node_id: + type: string + description: The node identifier of the issue type. + name: + type: string + description: The name of the issue type. + description: + type: string + description: The description of the issue type. + nullable: true + color: + type: string + description: The color of the issue type. + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + created_at: + type: string + description: The time the issue type created. + format: date-time + updated_at: + type: string + description: The time the issue type last updated. + format: date-time + is_enabled: + type: boolean + description: The enabled state of the issue type. + required: + - id + - node_id + - name + - description nullable-integration: title: GitHub app description: GitHub apps are a new way to extend GitHub. They can be installed @@ -71310,7 +76880,9 @@ components: issues: read deployments: write events: - description: The list of events for the GitHub app + description: The list of events for the GitHub app. Note that the `installation_target`, + `security_advisory`, and `meta` events are not included because they are + global events and not specific to an installation. example: - label - deployment @@ -71318,20 +76890,10 @@ components: items: type: string installations_count: - description: The number of installations associated with the GitHub app + description: The number of installations associated with the GitHub app. + Only returned when the integration is requesting details about itself. example: 5 type: integer - client_secret: - type: string - example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' - webhook_secret: - type: string - example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' - nullable: true - pem: - type: string - example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END - RSA PRIVATE KEY-----\n"' required: - id - node_id @@ -71408,6 +76970,157 @@ components: - total - completed - percent_completed + nullable-pinned-issue-comment: + title: Pinned Issue Comment + description: Context around who pinned an issue comment and when it was pinned. + type: object + properties: + pinned_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + pinned_by: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - pinned_at + - pinned_by + nullable: true + nullable-issue-comment: + title: Issue Comment + description: Comments provide a way for people to collaborate on an issue. + type: object + properties: + id: + description: Unique identifier of the issue comment + example: 42 + type: integer + format: int64 + node_id: + type: string + url: + description: URL for the issue comment + example: https://api.github.com/repositories/42/issues/comments/1 + type: string + format: uri + body: + description: Contents of the issue comment + example: What version of Safari were you using when you observed this bug? + type: string + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + example: '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + pin: + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + required: + - id + - node_id + - html_url + - issue_url + - user + - url + - created_at + - updated_at + nullable: true + issue-dependencies-summary: + title: Issue Dependencies Summary + type: object + properties: + blocked_by: + type: integer + blocking: + type: integer + total_blocked_by: + type: integer + total_blocking: + type: integer + required: + - blocked_by + - blocking + - total_blocked_by + - total_blocking + issue-field-value: + title: Issue Field Value + description: A value assigned to an issue field + type: object + properties: + issue_field_id: + description: Unique identifier for the issue field. + type: integer + format: int64 + example: 1 + node_id: + type: string + example: IFT_GDKND + data_type: + description: The data type of the issue field + type: string + enum: + - text + - single_select + - number + - date + example: text + value: + description: The value of the issue field + anyOf: + - type: string + example: Sample text + - type: number + example: 42.5 + - type: integer + example: 1 + nullable: true + single_select_option: + description: Details about the selected option (only present for single_select + fields) + type: object + properties: + id: + description: Unique identifier for the option. + type: integer + format: int64 + example: 1 + name: + description: The name of the option + type: string + example: High + color: + description: The color of the option + type: string + example: red + required: + - id + - name + - color + nullable: true + required: + - issue_field_id + - node_id + - data_type + - value issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and @@ -71455,6 +77168,7 @@ components: - completed - reopened - not_planned + - duplicate title: description: Title of the issue example: Widget creation fails in Safari on OS X 10.8 @@ -71565,6 +77279,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" repository: "$ref": "#/components/schemas/repository" performed_via_github_app: @@ -71575,6 +77291,19 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" required: - assignee - closed_at @@ -71594,7 +77323,6 @@ components: - title - url - user - - author_association - created_at - updated_at issue-comment: @@ -71644,16 +77372,247 @@ components: "$ref": "#/components/schemas/nullable-integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + "$ref": "#/components/schemas/nullable-pinned-issue-comment" required: - id - node_id - html_url - issue_url - - author_association - user - url - created_at - updated_at + pull-request-minimal: + title: Pull Request Minimal + type: object + properties: + id: + type: integer + format: int64 + number: + type: integer + url: + type: string + head: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + base: + type: object + properties: + ref: + type: string + sha: + type: string + repo: + type: object + properties: + id: + type: integer + format: int64 + url: + type: string + name: + type: string + required: + - id + - url + - name + required: + - ref + - sha + - repo + required: + - id + - number + - url + - head + - base + release-asset: + title: Release Asset + description: Data related to a release. + type: object + properties: + url: + type: string + format: uri + browser_download_url: + type: string + format: uri + id: + type: integer + node_id: + type: string + name: + description: The file name of the asset. + type: string + example: Team Environment + label: + type: string + nullable: true + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + digest: + type: string + nullable: true + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - id + - name + - content_type + - size + - digest + - state + - url + - node_id + - download_count + - label + - uploader + - browser_download_url + - created_at + - updated_at + release: + title: Release + description: A release. + type: object + properties: + url: + type: string + format: uri + html_url: + type: string + format: uri + assets_url: + type: string + format: uri + upload_url: + type: string + tarball_url: + type: string + format: uri + nullable: true + zipball_url: + type: string + format: uri + nullable: true + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + example: v1.0.0 + type: string + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + example: master + type: string + name: + type: string + nullable: true + body: + type: string + nullable: true + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + example: false + type: boolean + prerelease: + description: Whether to identify the release as a prerelease or a full release. + example: false + type: boolean + immutable: + description: Whether or not the release is immutable. + example: false + type: boolean + created_at: + type: string + format: date-time + published_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + nullable: true + format: date-time + author: + "$ref": "#/components/schemas/simple-user" + assets: + type: array + items: + "$ref": "#/components/schemas/release-asset" + body_html: + type: string + body_text: + type: string + mentions_count: + type: integer + discussion_url: + description: The URL of the release discussion. + type: string + format: uri + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - assets_url + - upload_url + - tarball_url + - zipball_url + - created_at + - published_at + - draft + - id + - node_id + - author + - html_url + - name + - prerelease + - tag_name + - target_commitish + - assets + - url event: title: Event description: Event @@ -71683,32 +77642,23 @@ components: org: "$ref": "#/components/schemas/actor" payload: - type: object - properties: - action: - type: string - issue: - "$ref": "#/components/schemas/issue" - comment: - "$ref": "#/components/schemas/issue-comment" - pages: - type: array - items: - type: object - properties: - page_name: - type: string - title: - type: string - summary: - type: string - nullable: true - action: - type: string - sha: - type: string - html_url: - type: string + oneOf: + - "$ref": "#/components/schemas/create-event" + - "$ref": "#/components/schemas/delete-event" + - "$ref": "#/components/schemas/discussion-event" + - "$ref": "#/components/schemas/issues-event" + - "$ref": "#/components/schemas/issue-comment-event" + - "$ref": "#/components/schemas/fork-event" + - "$ref": "#/components/schemas/gollum-event" + - "$ref": "#/components/schemas/member-event" + - "$ref": "#/components/schemas/public-event" + - "$ref": "#/components/schemas/push-event" + - "$ref": "#/components/schemas/pull-request-event" + - "$ref": "#/components/schemas/pull-request-review-comment-event" + - "$ref": "#/components/schemas/pull-request-review-event" + - "$ref": "#/components/schemas/commit-comment-event" + - "$ref": "#/components/schemas/release-event" + - "$ref": "#/components/schemas/watch-event" public: type: boolean created_at: @@ -72809,6 +78759,18 @@ components: type: object properties: advanced_security: + description: | + Enable or disable GitHub Advanced Security for the repository. + + For standalone Code Scanning or Secret Protection products, this parameter cannot be used. + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + code_security: type: object properties: status: @@ -72859,6 +78821,43 @@ components: enum: - enabled - disabled + secret_scanning_delegated_alert_dismissal: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass: + type: object + properties: + status: + type: string + enum: + - enabled + - disabled + secret_scanning_delegated_bypass_options: + type: object + 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 minimal-repository: title: Minimal Repository description: Minimal Repository @@ -73065,6 +79064,15 @@ components: type: boolean has_discussions: type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: type: boolean disabled: @@ -73123,6 +79131,7 @@ components: type: string url: type: string + nullable: true node_id: type: string nullable: true @@ -73142,6 +79151,12 @@ components: example: false security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true required: - archive_url - assignees_url @@ -73274,64 +79289,553 @@ components: - reason - url - subscribed - organization-simple: - title: Organization Simple - description: A GitHub organization. + actions-cache-retention-limit-for-organization: + title: Actions cache retention limit for an organization + description: GitHub Actions cache retention policy for an organization. + type: object + properties: + max_cache_retention_days: + description: For repositories in this organization, the maximum duration, + in days, for which caches in a repository may be retained. + type: integer + example: 14 + actions-cache-storage-limit-for-organization: + title: Actions cache storage limit for an organization + description: GitHub Actions cache storage policy for an organization. + type: object + properties: + max_cache_size_gb: + description: For repositories in the organization, the maximum size limit + for the sum of all caches in a repository, in gigabytes. + type: integer + example: 10 + nullable-simple-repository: + title: Simple Repository + description: A GitHub repository. type: object properties: - login: - type: string - example: github id: type: integer - example: 1 + format: int64 + example: 1296269 + description: A unique identifier of the repository. node_id: type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + description: The GraphQL identifier of the repository. + name: + type: string + example: Hello-World + description: The name of the repository. + full_name: + type: string + example: octocat/Hello-World + description: The full, globally unique, name of the repository. + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: The URL to view the repository on GitHub.com. + description: + type: string + example: This your first repo! + nullable: true + description: The repository description. + fork: + type: boolean + description: Whether the repository is a fork. url: type: string format: uri - example: https://api.github.com/orgs/github - repos_url: + example: https://api.github.com/repos/octocat/Hello-World + description: The URL to get more information about the repository from the + GitHub API. + archive_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + description: A template for the API URL to download the repository as an + archive. + assignees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/assignees{/user} + description: A template for the API URL to list the available assignees + for issues in the repository. + blobs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + branches_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/branches{/branch} + description: A template for the API URL to get information about branches + in the repository. + collaborators_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + description: A template for the API URL to get information about collaborators + of the repository. + comments_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/comments{/number} + description: A template for the API URL to get information about comments + on the repository. + commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/commits{/sha} + description: A template for the API URL to get information about commits + on the repository. + compare_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + description: A template for the API URL to compare two commits or refs. + contents_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/contents/{+path} + description: A template for the API URL to get the contents of the repository. + contributors_url: type: string format: uri - example: https://api.github.com/orgs/github/repos + example: https://api.github.com/repos/octocat/Hello-World/contributors + description: A template for the API URL to list the contributors to the + repository. + deployments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/deployments + description: The API URL to list the deployments of the repository. + downloads_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/downloads + description: The API URL to list the downloads on the repository. events_url: type: string format: uri - example: https://api.github.com/orgs/github/events - hooks_url: + example: https://api.github.com/repos/octocat/Hello-World/events + description: The API URL to list the events of the repository. + forks_url: type: string - example: https://api.github.com/orgs/github/hooks + format: uri + example: https://api.github.com/repos/octocat/Hello-World/forks + description: The API URL to list the forks of the repository. + git_commits_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + description: A template for the API URL to get information about Git commits + of the repository. + git_refs_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + description: A template for the API URL to get information about Git refs + of the repository. + git_tags_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + description: A template for the API URL to get information about Git tags + of the repository. + issue_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + description: A template for the API URL to get information about issue comments + on the repository. + issue_events_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + description: A template for the API URL to get information about issue events + on the repository. issues_url: type: string - example: https://api.github.com/orgs/github/issues - members_url: + example: https://api.github.com/repos/octocat/Hello-World/issues{/number} + description: A template for the API URL to get information about issues + on the repository. + keys_url: type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: + example: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + description: A template for the API URL to get information about deploy + keys on the repository. + labels_url: type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: + example: https://api.github.com/repos/octocat/Hello-World/labels{/name} + description: A template for the API URL to get information about labels + of the repository. + languages_url: type: string - example: https://github.com/images/error/octocat_happy.gif - description: + format: uri + example: https://api.github.com/repos/octocat/Hello-World/languages + description: The API URL to get information about the languages of the repository. + merges_url: type: string - example: A great organization - nullable: true + format: uri + example: https://api.github.com/repos/octocat/Hello-World/merges + description: The API URL to merge branches in the repository. + milestones_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/milestones{/number} + description: A template for the API URL to get information about milestones + of the repository. + notifications_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + description: A template for the API URL to get information about notifications + on the repository. + pulls_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls{/number} + description: A template for the API URL to get information about pull requests + on the repository. + releases_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/releases{/id} + description: A template for the API URL to get information about releases + on the repository. + stargazers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/stargazers + description: The API URL to list the stargazers on the repository. + statuses_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + description: A template for the API URL to get information about statuses + of a commit. + subscribers_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscribers + description: The API URL to list the subscribers on the repository. + subscription_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/subscription + description: The API URL to subscribe to notifications for this repository. + tags_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/tags + description: The API URL to get information about tags on the repository. + teams_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/teams + description: The API URL to list the teams on the repository. + trees_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + hooks_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/hooks + description: The API URL to list the hooks on the repository. required: - - login - - url - - id - - node_id - - repos_url + - 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 - - members_url - - public_members_url - - avatar_url - - description + - 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 + nullable: true + dependabot-repository-access-details: + title: Dependabot Repository Access Details + description: Information about repositories that Dependabot is able to access + in an organization + type: object + properties: + default_level: + type: string + description: The default repository access level for Dependabot updates. + enum: + - public + - internal + example: internal + nullable: true + accessible_repositories: + type: array + items: + "$ref": "#/components/schemas/nullable-simple-repository" + additionalProperties: false + budget: + type: object + properties: + id: + type: string + description: The unique identifier for the budget + example: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: + type: string + description: The type of pricing for the budget + example: SkuPricing + enum: + - SkuPricing + - ProductPricing + budget_amount: + type: integer + description: The budget amount limit in whole dollars. For license-based + products, this represents the number of licenses. + prevent_further_usage: + type: boolean + description: The type of limit enforcement for the budget + example: true + budget_scope: + type: string + description: The scope of the budget (enterprise, organization, repository, + cost center) + example: enterprise + budget_entity_name: + type: string + description: The name of the entity for the budget (enterprise does not + require a name). + example: octocat/hello-world + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - will_alert + - alert_recipients + required: + - id + - budget_type + - budget_product_sku + - budget_scope + - budget_amount + - prevent_further_usage + - budget_alerting + get_all_budgets: + type: object + properties: + budgets: + type: array + items: + "$ref": "#/components/schemas/budget" + description: Array of budget objects for the enterprise + has_next_page: + type: boolean + description: Indicates if there are more pages of results available (maps + to hasNextPage from billing platform) + total_count: + type: integer + description: Total number of budgets matching the query + required: + - budgets + get-budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: octocat/hello-world + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + type: string + description: The type of pricing for the budget + example: ProductPricing + enum: + - ProductPricing + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - id + - budget_amount + - prevent_further_usage + - budget_product_sku + - budget_type + - budget_alerting + - budget_scope + - budget_entity_name + delete-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the deletion operation + id: + type: string + description: The ID of the deleted budget + required: + - message + - id + billing-premium-request-usage-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + user: + type: string + description: The name of the user for the usage report. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems billing-usage-report: type: object properties: @@ -73384,6 +79888,85 @@ components: - discountAmount - netAmount - organizationName + billing-usage-summary-report-org: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + organization: + type: string + description: The unique identifier of the organization. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - organization + - usageItems organization-full: title: Organization Full description: Organization Full @@ -73525,6 +80108,11 @@ components: default_repository_permission: type: string nullable: true + default_repository_branch: + type: string + example: main + nullable: true + description: The default branch for repositories created in this organization. members_can_create_repositories: type: boolean example: true @@ -73554,6 +80142,30 @@ components: members_can_create_private_pages: type: boolean example: true + members_can_delete_repositories: + type: boolean + example: true + members_can_change_repo_visibility: + type: boolean + example: true + members_can_invite_outside_collaborators: + type: boolean + example: true + members_can_delete_issues: + type: boolean + example: true + display_commenter_full_name_setting_enabled: + type: boolean + example: true + readers_can_create_discussions: + type: boolean + example: true + members_can_create_teams: + type: boolean + example: true + members_can_view_dependency_insights: + type: boolean + example: true members_can_fork_private_repositories: type: boolean example: false @@ -73742,7 +80354,6 @@ components: - size_gb - display_name - source - - version nullable: true actions-hosted-runner-machine-spec: title: Github-owned VM details. @@ -73845,6 +80456,9 @@ components: format: date-time example: '2022-10-09T23:39:01Z' nullable: true + image_gen: + type: boolean + description: Whether custom image generation is enabled for the hosted runners. required: - id - name @@ -73853,7 +80467,85 @@ components: - status - public_ip_enabled - platform - actions-hosted-runner-image: + actions-hosted-runner-custom-image: + title: GitHub-hosted runner custom image details + description: Provides details of a custom runner image + type: object + properties: + id: + description: The ID of the image. Use this ID for the `image` parameter + when creating a new larger runner. + type: integer + example: 1 + platform: + description: The operating system of the image. + type: string + example: linux-x64 + total_versions_size: + description: Total size of all the image versions in GB. + type: integer + example: 200 + name: + description: Display name for this image. + type: string + example: CustomImage + source: + description: The image provider. + type: string + example: custom + versions_count: + description: The number of image versions associated with the image. + type: integer + example: 4 + latest_version: + description: The latest image version associated with the image. + type: string + example: 1.3.0 + state: + description: The number of image versions associated with the image. + type: string + example: Ready + required: + - id + - platform + - name + - source + - versions_count + - total_versions_size + - latest_version + - state + actions-hosted-runner-custom-image-version: + title: GitHub-hosted runner custom image version details. + description: Provides details of a hosted runner custom image version + type: object + properties: + version: + description: The version of image. + type: string + example: 1.0.0 + state: + description: The state of image version. + type: string + example: Ready + size_gb: + description: Image version size in GB. + type: integer + example: 30 + created_on: + description: The creation date time of the image version. + type: string + example: '2024-11-09T23:39:01Z' + state_details: + description: The image version status details. + type: string + example: None + required: + - version + - state + - size_gb + - created_on + - state_details + actions-hosted-runner-curated-image: title: GitHub-hosted runner image details. description: Provides details of a hosted runner image type: object @@ -73951,6 +80643,9 @@ components: type: string description: The API URL to use to get or set the actions and reusable workflows that are allowed to run, when `allowed_actions` is set to `selected`. + sha-pinning-required: + type: boolean + description: Whether actions must be pinned to a full-length commit SHA. actions-organization-permissions: type: object properties: @@ -73965,8 +80660,88 @@ components: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled_repositories + actions-artifact-and-log-retention-response: + type: object + properties: + days: + type: integer + description: The number of days artifacts and logs are retained + maximum_allowed_days: + type: integer + description: The maximum number of days that can be configured + required: + - days + - maximum_allowed_days + actions-artifact-and-log-retention: + type: object + properties: + days: + type: integer + description: The number of days to retain artifacts and logs + required: + - days + actions-fork-pr-contributor-approval: + type: object + properties: + approval_policy: + type: string + enum: + - first_time_contributors_new_to_github + - first_time_contributors + - all_external_contributors + description: The policy that controls when fork PR workflows require approval + from a maintainer. + required: + - approval_policy + actions-fork-pr-workflows-private-repos: + type: object + required: + - run_workflows_from_fork_pull_requests + - send_write_tokens_to_workflows + - send_secrets_and_variables + - require_approval_for_fork_pr_workflows + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. + actions-fork-pr-workflows-private-repos-request: + type: object + required: + - run_workflows_from_fork_pull_requests + properties: + run_workflows_from_fork_pull_requests: + type: boolean + description: Whether workflows triggered by pull requests from forks are + allowed to run on private repositories. + send_write_tokens_to_workflows: + type: boolean + description: Whether GitHub Actions can create pull requests or submit approving + pull request reviews from a workflow triggered by a fork pull request. + send_secrets_and_variables: + type: boolean + description: Whether to make secrets and variables available to workflows + triggered by pull requests from forks. + require_approval_for_fork_pr_workflows: + type: boolean + description: Whether workflows triggered by pull requests from forks require + approval from a repository administrator to run. selected-actions: type: object properties: @@ -73988,6 +80763,23 @@ components: > The `patterns_allowed` setting only applies to public repositories. items: type: string + self-hosted-runners-settings: + type: object + required: + - enabled_repositories + properties: + enabled_repositories: + type: string + description: The policy that controls whether self-hosted runners can be + used by repositories in the organization + enum: + - all + - selected + - none + selected_repositories_url: + type: string + description: The URL to the endpoint for managing selected repositories + for self-hosted runners in the organization actions-default-workflow-permissions: type: string description: The default workflow permissions granted to the GITHUB_TOKEN when @@ -74098,11 +80890,11 @@ components: type: object properties: id: - description: The id of the runner. + description: The ID of the runner. type: integer example: 5 runner_group_id: - description: The id of the runner group. + description: The ID of the runner group. type: integer example: 1 name: @@ -74123,6 +80915,8 @@ components: type: array items: "$ref": "#/components/schemas/runner-label" + ephemeral: + type: boolean required: - id - name @@ -74293,6 +81087,312 @@ components: - created_at - updated_at - visibility + artifact-deployment-record: + title: Artifact Deployment Record + description: Artifact Metadata Deployment Record + type: object + properties: + id: + type: integer + digest: + type: string + logical_environment: + type: string + physical_environment: + type: string + cluster: + type: string + deployment_name: + type: string + tags: + type: object + additionalProperties: + type: string + runtime_risks: + type: array + description: A list of runtime risks associated with the deployment. + maxItems: 4 + uniqueItems: true + items: + type: string + enum: + - critical-resource + - internet-exposed + - lateral-movement + - sensitive-data + created_at: + type: string + updated_at: + type: string + attestation_id: + type: integer + description: The ID of the provenance attestation associated with the deployment + record. + nullable: true + campaign-state: + title: Campaign state + description: Indicates whether a campaign is open or closed + type: string + enum: + - open + - closed + campaign-alert-type: + title: Campaign alert type + description: Indicates the alert type of a campaign + type: string + enum: + - code_scanning + - secret_scanning + nullable-team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + example: 1 + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + example: https://api.github.com/organizations/1/team/1 + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + example: Justice League + description: + description: Description of the team + type: string + nullable: true + example: A great team. + permission: + description: Permission that the team will have for its repositories + type: string + example: admin + privacy: + description: The level of privacy this team should have + type: string + example: closed + notification_setting: + description: The notification setting the team has set + type: string + example: notifications_enabled + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + slug: + type: string + example: justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + example: uid=example,ou=users,dc=github,dc=com + type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - type + nullable: true + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: string + nullable: true + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 + parent: + "$ref": "#/components/schemas/nullable-team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - type + campaign-summary: + title: Campaign summary + description: The campaign metadata and alert stats. + type: object + properties: + number: + type: integer + description: The number of the newly created campaign + created_at: + type: string + format: date-time + description: The date and time the campaign was created, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + updated_at: + type: string + format: date-time + description: The date and time the campaign was last updated, in ISO 8601 + format':' YYYY-MM-DDTHH:MM:SSZ. + name: + type: string + description: The campaign name + description: + type: string + description: The campaign description + managers: + description: The campaign managers + type: array + items: + "$ref": "#/components/schemas/simple-user" + team_managers: + description: The campaign team managers + type: array + items: + "$ref": "#/components/schemas/team" + published_at: + description: The date and time the campaign was published, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + ends_at: + description: The date and time the campaign has ended, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. + type: string + format: date-time + closed_at: + description: The date and time the campaign was closed, in ISO 8601 format':' + YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open. + type: string + format: date-time + nullable: true + state: + "$ref": "#/components/schemas/campaign-state" + contact_link: + description: The contact link of the campaign. + type: string + format: uri + nullable: true + alert_stats: + type: object + additionalProperties: false + properties: + open_count: + type: integer + description: The number of open alerts + closed_count: + type: integer + description: The number of closed alerts + in_progress_count: + type: integer + description: The number of in-progress alerts + required: + - open_count + - closed_count + - in_progress_count + required: + - number + - created_at + - updated_at + - description + - managers + - ends_at + - state + - contact_link code-scanning-analysis-tool-name: type: string description: The name of the tool used to generate the code scanning analysis. @@ -74518,6 +81618,12 @@ components: "$ref": "#/components/schemas/code-scanning-alert-instance" repository: "$ref": "#/components/schemas/simple-repository" + dismissal_approved_by: + "$ref": "#/components/schemas/nullable-simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -74870,8 +81976,8 @@ components: required: - key_id - key - copilot-seat-breakdown: - title: Copilot Business Seat Breakdown + copilot-organization-seat-breakdown: + title: Copilot Seat Breakdown description: The breakdown of Copilot Business seats for the organization. type: object properties: @@ -74888,8 +81994,8 @@ components: of the current billing cycle. pending_invitation: type: integer - description: The number of seats that have been assigned to users that have - not yet accepted an invitation to this organization. + description: The number of users who have been invited to receive a Copilot + seat through this organization. active_this_cycle: type: integer description: The number of seats that have used Copilot during the current @@ -74905,36 +82011,35 @@ components: type: object properties: seat_breakdown: - "$ref": "#/components/schemas/copilot-seat-breakdown" + "$ref": "#/components/schemas/copilot-organization-seat-breakdown" public_code_suggestions: type: string - description: The organization policy for allowing or disallowing Copilot - to make suggestions that match public code. + description: The organization policy for allowing or blocking suggestions + matching public code (duplication detection filter). enum: - allow - block - unconfigured - - unknown ide_chat: type: string - description: The organization policy for allowing or disallowing organization - members to use Copilot Chat within their editor. + description: The organization policy for allowing or disallowing Copilot + Chat in the IDE. enum: - enabled - disabled - unconfigured platform_chat: type: string - description: The organization policy for allowing or disallowing organization - members to use Copilot features within github.com. + description: The organization policy for allowing or disallowing Copilot + features on GitHub.com. enum: - enabled - disabled - unconfigured cli: type: string - description: The organization policy for allowing or disallowing organization - members to use Copilot within their CLI. + description: The organization policy for allowing or disallowing Copilot + CLI. enum: - enabled - disabled @@ -74954,7 +82059,6 @@ components: enum: - business - enterprise - - unknown required: - seat_breakdown - public_code_suggestions @@ -75019,191 +82123,6 @@ components: - avatar_url - description nullable: true - nullable-team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - example: 1 - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - example: https://api.github.com/organizations/1/team/1 - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - example: Justice League - description: - description: Description of the team - type: string - nullable: true - example: A great team. - permission: - description: Permission that the team will have for its repositories - type: string - example: admin - privacy: - description: The level of privacy this team should have - type: string - example: closed - notification_setting: - description: The notification setting the team has set - type: string - example: notifications_enabled - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - slug: - type: string - example: justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com - type: string - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - nullable: true - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: string - nullable: true - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - "$ref": "#/components/schemas/nullable-team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - enterprise-team: - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - example: disabled | all - group_id: - nullable: true - type: string - example: 62ab9291-fae2-468e-974b-7e45096d5021 - group_name: - nullable: true - type: string - example: Justice League - html_url: - type: string - format: uri - example: https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at copilot-seat-details: title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, @@ -75211,7 +82130,7 @@ components: type: object properties: assignee: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" organization: "$ref": "#/components/schemas/nullable-organization-simple" assigning_team: @@ -75240,6 +82159,12 @@ components: nullable: true description: Last editor that was used by the user for a GitHub Copilot completion. + last_authenticated_at: + type: string + format: date-time + nullable: true + description: Timestamp of the last time the user authenticated with GitHub + Copilot, in ISO 8601 format. created_at: type: string format: date-time @@ -75262,9 +82187,17 @@ components: - enterprise - unknown required: - - assignee - created_at additionalProperties: false + copilot-organization-content-exclusion-details: + title: Copilot Organization Content Exclusion Details + description: List all Copilot Content Exclusion rules for an organization. + type: object + additionalProperties: + type: array + items: + type: string + description: The path to the file that will be excluded. copilot-ide-code-completions: type: object description: Usage metrics for Copilot editor code completions in the IDE. @@ -75399,8 +82332,8 @@ components: properties: name: type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. + description: Name of the model used for Copilot Chat. If the + default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. @@ -75428,7 +82361,7 @@ components: for the given editor. copilot-dotcom-chat: type: object - description: Usage metrics for Copilot Chat in github.com + description: Usage metrics for Copilot Chat in GitHub.com nullable: true additionalProperties: true properties: @@ -75444,8 +82377,8 @@ components: properties: name: type: string - description: Name of the model used for Copilot code completion suggestions. - If the default model is used will appear as 'default'. + description: Name of the model used for Copilot Chat. If the default + model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. @@ -75493,8 +82426,8 @@ components: properties: name: type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. + description: Name of the model used for Copilot pull request + summaries. If the default model is used will appear as 'default'. is_custom_model: type: boolean description: Indicates whether a model is custom or default. @@ -75546,89 +82479,6 @@ components: required: - date additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, in `YYYY-MM-DD` - format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions shown - to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions accepted - by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested by - Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot code completion - suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code suggested by - Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response pairs) - sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot Chat - in the IDE during the day specified. - breakdown: - type: array - description: Breakdown of Copilot code completions usage by language and - editor - nullable: true - items: - type: object - description: Breakdown of Copilot usage by editor for this language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions were shown - to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were shown to - users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to users in the - editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted by users in - the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by Copilot in the - editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users in the - editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot completion - suggestions in the editor specified during the day specified. - required: - - day - - breakdown - additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -75882,6 +82732,15 @@ components: type: boolean has_discussions: type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: type: boolean disabled: @@ -75940,6 +82799,7 @@ components: type: string url: type: string + nullable: true node_id: type: string nullable: true @@ -75959,6 +82819,12 @@ components: example: false security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true required: - archive_url - assignees_url @@ -76340,6 +83206,66 @@ components: "$ref": "#/components/schemas/interaction-expiry" required: - limit + organization-create-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization + level. + type: boolean + description: + description: Description of the issue type. + type: string + nullable: true + color: + description: Color for the issue type. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + required: + - name + - is_enabled + organization-update-issue-type: + type: object + properties: + name: + description: Name of the issue type. + type: string + is_enabled: + description: Whether or not the issue type is enabled at the organization + level. + type: boolean + description: + description: Description of the issue type. + type: string + nullable: true + color: + description: Color for the issue type. + type: string + enum: + - gray + - blue + - green + - yellow + - orange + - red + - pink + - purple + nullable: true + required: + - name + - is_enabled org-membership: title: Org Membership description: Org Membership @@ -76365,6 +83291,21 @@ components: - admin - member - billing_manager + direct_membership: + type: boolean + description: Whether the user has direct membership in the organization. + example: true + enterprise_teams_providing_indirect_membership: + type: array + description: |- + The slugs of the enterprise teams providing the user with indirect membership in the organization. + A limit of 100 enterprise team slugs is returned. + maxItems: 100 + items: + type: string + example: + - ent:team-one + - ent:team-two organization_url: type: string format: uri @@ -76589,6 +83530,20 @@ components: format: uri parent: "$ref": "#/components/schemas/nullable-team-simple" + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 required: - id - node_id @@ -76600,6 +83555,7 @@ components: - html_url - repositories_url - slug + - type - parent team-simple: title: Team Simple @@ -76658,6 +83614,20 @@ components: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 required: - id - node_id @@ -76669,6 +83639,7 @@ components: - html_url - repositories_url - slug + - type user-role-assignment: title: A Role Assignment for a User description: The Relationship a User has with a role. @@ -77038,12 +84009,38 @@ components: description: The registry type. enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + url: + description: The URL of the private registry. type: string + format: uri username: description: The username to use when authenticating with the private registry. example: monalisa type: string nullable: true + replaces_base: + description: Whether this private registry replaces the base registry (e.g., + npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot + will only use this registry and will not fall back to the public registry. + When `false` (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false visibility: description: Which type of organization repositories have access to the private registry. @@ -77077,11 +84074,37 @@ components: description: The registry type. enum: - maven_repository + - nuget_feed + - goproxy_server + - npm_registry + - rubygems_server + - cargo_registry + - composer_repository + - docker_registry + - git_source + - helm_registry + - hex_organization + - hex_repository + - pub_repository + - python_index + - terraform_registry + type: string + url: + description: The URL of the private registry. type: string + format: uri username: description: The username to use when authenticating with the private registry. example: monalisa type: string + replaces_base: + description: Whether this private registry replaces the base registry (e.g., + npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot + will only use this registry and will not fall back to the public registry. + When `false` (default), Dependabot will use this registry for scoped packages + but may fall back to the public registry for other packages. + type: boolean + default: false visibility: description: Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by @@ -77109,86 +84132,873 @@ components: - visibility - created_at - updated_at - project: - title: Project - description: Projects are a way to organize columns and cards of work. + nullable-projects-v2-status-update: + title: Projects v2 Status Update + description: An status update belonging to a project type: object properties: - owner_url: + id: + type: number + description: The unique identifier of the status update. + node_id: type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test + description: The node ID of the status update. + project_node_id: + type: string + description: The node ID of the project that this status update belongs + to. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the status update was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the status update was last updated. + status: + type: string + enum: + - INACTIVE + - ON_TRACK + - AT_RISK + - OFF_TRACK + - COMPLETE + nullable: true + description: The current status. + start_date: + type: string + format: date + example: '2022-04-28' + description: The start date of the period covered by the update. + target_date: + type: string + format: date + example: '2022-04-28' + description: The target date associated with the update. + body: + description: Body of the status update + example: The project is off to a great start! + type: string + nullable: true + required: + - id + - node_id + - created_at + - updated_at + nullable: true + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + description: The unique identifier of the project. + node_id: + type: string + description: The node ID of the project. + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: The project title. + description: + type: string + nullable: true + description: A short description of the project. + public: + type: boolean + description: Whether the project is visible to anyone with access to the + owner. + closed_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the project was closed. + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the project was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the project was last updated. + number: + type: integer + description: The project number. + short_description: + type: string + nullable: true + description: A concise summary of the project. + deleted_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the project was deleted. + deleted_by: + "$ref": "#/components/schemas/nullable-simple-user" + state: + type: string + enum: + - open + - closed + description: The current state of the project. + latest_status_update: + "$ref": "#/components/schemas/nullable-projects-v2-status-update" + is_template: + type: boolean + description: Whether this project is a template + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + link: + title: Link + description: Hypermedia Link + type: object + properties: + href: + type: string + required: + - href + auto-merge: + title: Auto merge + description: The status of auto merging a pull request. + type: object + properties: + enabled_by: + "$ref": "#/components/schemas/simple-user" + merge_method: + type: string + description: The merge method to use. + enum: + - merge + - squash + - rebase + commit_title: + type: string + description: Title for the merge commit message. + commit_message: + type: string + description: Commit message for the merge commit. + required: + - enabled_by + - merge_method + - commit_title + - commit_message + nullable: true + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: url: type: string format: uri - example: https://api.github.com/projects/1002604 + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + example: 1 + node_id: + type: string + example: MDExOlB1bGxSZXF1ZXN0MQ== html_url: type: string format: uri - example: https://github.com/api-playground/projects-test/projects/12 - columns_url: + example: https://github.com/octocat/Hello-World/pull/1347 + diff_url: type: string format: uri - example: https://api.github.com/projects/1002604/columns - id: - type: integer - example: 1002604 - node_id: + example: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: type: string - example: MDc6UHJvamVjdDEwMDI2MDQ= - name: - description: Name of the project - example: Week One Sprint + format: uri + example: https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: type: string - body: - description: Body of the project - example: This project represents the sprint of the first week in January + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: type: string - nullable: true + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e number: type: integer - example: 1 + example: 1347 state: - description: State of the project; either 'open' or 'closed' + type: string example: open + locked: + type: boolean + example: true + title: type: string - creator: + example: new-feature + user: "$ref": "#/components/schemas/nullable-simple-user" + body: + type: string + example: Please pull these awesome changes + nullable: true + labels: + type: array + items: + type: object + properties: + id: + type: integer + format: int64 + node_id: + type: string + url: + type: string + name: + type: string + description: + type: string + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + "$ref": "#/components/schemas/nullable-milestone" + active_lock_reason: + type: string + example: too heated + nullable: true created_at: type: string format: date-time - example: '2011-04-10T20:09:31Z' + example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time - example: '2014-03-03T18:58:10Z' - organization_permission: - description: The baseline permission that all organization members have - on this project. Only present if owner is an organization. + example: '2011-01-26T19:01:12Z' + closed_at: type: string - enum: - - read - - write - - admin - - none - private: - description: Whether or not this project can be seen by everyone. Only present - if owner is an organization. + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merged_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + merge_commit_sha: + type: string + example: e5bd3914e2e596debea16f433f57875b5b90bcd6 + nullable: true + assignee: + "$ref": "#/components/schemas/nullable-simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + nullable: true + requested_reviewers: + type: array + items: + "$ref": "#/components/schemas/simple-user" + nullable: true + requested_teams: + type: array + items: + "$ref": "#/components/schemas/team" + nullable: true + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - label + - ref + - repo + - sha + - user + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - label + - ref + - repo + - sha + - user + _links: + type: object + properties: + comments: + "$ref": "#/components/schemas/link" + commits: + "$ref": "#/components/schemas/link" + statuses: + "$ref": "#/components/schemas/link" + html: + "$ref": "#/components/schemas/link" + issue: + "$ref": "#/components/schemas/link" + review_comments: + "$ref": "#/components/schemas/link" + review_comment: + "$ref": "#/components/schemas/link" + self: + "$ref": "#/components/schemas/link" + required: + - comments + - commits + - statuses + - html + - issue + - review_comments + - review_comment + - self + author_association: + "$ref": "#/components/schemas/author-association" + auto_merge: + "$ref": "#/components/schemas/auto-merge" + draft: + description: Indicates whether or not the pull request is a draft. + example: false type: boolean required: + - _links + - assignee + - labels + - base + - body + - closed_at + - comments_url + - commits_url + - created_at + - diff_url + - head + - html_url - id - node_id + - issue_url + - merge_commit_sha + - merged_at + - milestone - number - - name - - body + - patch_url + - review_comment_url + - review_comments_url + - statuses_url - state + - locked + - title + - updated_at - url + - user + - author_association + - auto_merge + projects-v2-draft-issue: + title: Draft Issue + description: A draft issue in a project + type: object + properties: + id: + type: number + description: The ID of the draft issue + node_id: + type: string + description: The node ID of the draft issue + title: + type: string + description: The title of the draft issue + body: + type: string + description: The body content of the draft issue + nullable: true + user: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + description: The time the draft issue was created + updated_at: + type: string + format: date-time + description: The time the draft issue was last updated + required: + - id + - node_id + - title + - user + - created_at + - updated_at + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-item-simple: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + content: + oneOf: + - "$ref": "#/components/schemas/issue" + - "$ref": "#/components/schemas/pull-request-simple" + - "$ref": "#/components/schemas/projects-v2-draft-issue" + description: The content represented by the item. + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the item was archived. + project_url: + type: string + format: uri + description: The URL of the project this item belongs to. + item_url: + type: string + format: uri + description: The URL of the item in the project. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-single-select-options: + title: Projects v2 Single Select Option + description: An option for a single select field + type: object + properties: + id: + type: string + description: The unique identifier of the option. + name: + type: object + description: The display name of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: + type: object + description: The description of the option, in raw text and HTML formats. + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + color: + type: string + description: The color associated with the option. + required: + - id + - name + - description + - color + projects-v2-iteration-settings: + title: Projects v2 Iteration Setting + description: An iteration setting for an iteration field + type: object + properties: + id: + type: string + description: The unique identifier of the iteration setting. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + title: + type: object + properties: + raw: + type: string + html: + type: string + required: + - raw + - html + description: The iteration title, in raw text and HTML formats. + completed: + type: boolean + description: Whether the iteration has been completed. + required: + - id + - start_date + - duration + - title + - completed + projects-v2-field: + title: Projects v2 Field + description: A field inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the field. + node_id: + type: string + description: The node ID of the field. + project_url: + type: string + description: The API URL of the project that contains the field. + example: https://api.github.com/projects/1 + name: + type: string + description: The name of the field. + data_type: + type: string + description: The field's data type. + enum: + - assignees + - linked_pull_requests + - reviewers + - labels + - milestone + - repository + - title + - text + - single_select + - number + - date + - iteration + - issue_type + - parent_issue + - sub_issues_progress + options: + type: array + description: The options available for single select fields. + items: + "$ref": "#/components/schemas/projects-v2-single-select-options" + configuration: + type: object + description: Configuration for iteration fields. + properties: + start_day: + type: integer + description: The day of the week when the iteration starts. + duration: + type: integer + description: The duration of the iteration in days. + iterations: + type: array + items: + "$ref": "#/components/schemas/projects-v2-iteration-settings" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the field was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the field was last updated. + required: + - id + - name + - data_type + - created_at + - updated_at + - project_url + projects-v2-field-single-select-option: + type: object + properties: + name: + type: string + description: The display name of the option. + color: + type: string + description: The color associated with the option. + enum: + - BLUE + - GRAY + - GREEN + - ORANGE + - PINK + - PURPLE + - RED + - YELLOW + description: + type: string + description: The description of the option. + additionalProperties: false + projects-v2-field-iteration-configuration: + type: object + description: The configuration for iteration fields. + properties: + start_date: + type: string + format: date + description: The start date of the first iteration. + duration: + type: integer + description: The default duration for iterations in days. Individual iterations + can override this value. + iterations: + type: array + description: Zero or more iterations for the field. + items: + type: object + additionalProperties: false + properties: + title: + type: string + description: The title of the iteration. + start_date: + type: string + format: date + description: The start date of the iteration. + duration: + type: integer + description: The duration of the iteration in days. + projects-v2-item-with-content: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + description: The unique identifier of the project item. + node_id: + type: string + description: The node ID of the project item. + project_url: + type: string + format: uri + example: https://api.github.com/users/monalisa/2/projectsV2/3 + description: The API URL of the project that contains this item. + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + content: + type: object + additionalProperties: true + nullable: true + description: The content of the item, which varies by content type. + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + description: The time when the item was archived. + item_url: + type: string + format: uri + example: https://api.github.com/users/monalisa/2/projectsV2/items/3 + nullable: true + description: The API URL of this item. + fields: + type: array + items: + type: object + additionalProperties: true + description: The fields and values associated with this item. + required: + - id + - content_type + - created_at + - updated_at + - archived_at + projects-v2-view: + title: Projects v2 View + description: A view inside a projects v2 project + type: object + properties: + id: + type: integer + description: The unique identifier of the view. + number: + type: integer + description: The number of the view within the project. + name: + type: string + description: The name of the view. + layout: + type: string + description: The layout of the view. + enum: + - table + - board + - roadmap + node_id: + type: string + description: The node ID of the view. + project_url: + type: string + description: The API URL of the project that contains the view. + example: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: + type: string + format: uri + description: The web URL of the view. + example: https://github.com/orgs/octocat/projects/1/views/1 + creator: + allOf: + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the view was created. + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + description: The time when the view was last updated. + filter: + type: string + nullable: true + description: The filter query for the view. + example: is:issue is:open + visible_fields: + type: array + description: The list of field IDs that are visible in the view. + items: + type: integer + sort_by: + type: array + description: The sorting configuration for the view. Each element is a tuple + of [field_id, direction] where direction is "asc" or "desc". + items: + type: array + minItems: 2 + maxItems: 2 + items: + oneOf: + - type: integer + - type: string + group_by: + type: array + description: The list of field IDs used for horizontal grouping. + items: + type: integer + vertical_group_by: + type: array + description: The list of field IDs used for vertical grouping (board layout). + items: + type: integer + required: + - id + - number + - name + - layout + - node_id + - project_url - html_url - - owner_url - creator - - columns_url - created_at - updated_at + - visible_fields + - sort_by + - group_by + - vertical_group_by custom-property: title: Organization Custom Property description: Custom property defined on an organization @@ -77217,6 +85027,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property required: type: boolean @@ -77237,8 +85048,6 @@ components: type: array items: type: string - maxLength: 75 - maxItems: 200 nullable: true description: |- An ordered list of the allowed values of the property. @@ -77251,6 +85060,9 @@ components: - org_and_repo_actors example: org_actors description: Who can edit the values of the property + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory required: - property_name - value_type @@ -77267,6 +85079,7 @@ components: - single_select - multi_select - true_false + - url description: The type of the value for the property required: type: boolean @@ -77287,12 +85100,21 @@ components: type: array items: type: string - maxLength: 75 - maxItems: 200 nullable: true description: |- An ordered list of the allowed values of the property. The property can have up to 200 allowed values. + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property + require_explicit_values: + type: boolean + description: Whether setting properties values is mandatory required: - value_type custom-property-value: @@ -77605,6 +85427,19 @@ components: default: false type: boolean example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all archived: description: Whether the repository is archived. default: false @@ -77735,6 +85570,14 @@ components: anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository + code_search_index_status: + type: object + description: The status of the code search index for this repository + properties: + lexical_search_ok: + type: boolean + lexical_commit_sha: + type: string required: - archive_url - assignees_url @@ -78067,6 +85910,17 @@ components: has_discussions: type: boolean example: true + has_pull_requests: + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only + example: all archived: type: boolean disabled: @@ -78316,8 +86170,9 @@ components: actor_id: type: integer nullable: true - description: The ID of the actor that can bypass a ruleset. If `actor_type` - is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, + description: The ID of the actor that can bypass a ruleset. Required for + `Integration`, `RepositoryRole`, and `Team` actor types. If `actor_type` + is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. actor_type: @@ -78334,10 +86189,13 @@ components: 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. + is only applicable to branch rulesets. When `bypass_mode` is `exempt`, + rules will not be run for that actor and a bypass audit entry will not + be created. enum: - always - pull_request + - exempt default: always repository-ruleset-conditions: title: Repository ruleset conditions for ref names @@ -78632,6 +86490,22 @@ components: type: string enum: - required_signatures + repository-rule-params-reviewer: + title: Reviewer + description: A required reviewing team + type: object + properties: + id: + type: integer + description: ID of the reviewer which must review changes to matching files. + type: + type: string + description: The type of the reviewer + enum: + - Team + required: + - id + - type repository-rule-params-required-reviewer-configuration: title: RequiredReviewerConfiguration description: A reviewing team, and file patterns describing which files they @@ -78641,8 +86515,8 @@ components: 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. + files must be approved by the specified team. File patterns use fnmatch + syntax. items: type: string minimum_approvals: @@ -78650,13 +86524,12 @@ components: 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. + reviewer: + "$ref": "#/components/schemas/repository-rule-params-reviewer" required: - file_patterns - minimum_approvals - - reviewer_id + - reviewer repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -78674,11 +86547,14 @@ components: properties: allowed_merge_methods: type: array - description: When merging pull requests, you can allow any combination - of merge commits, squashing, or rebasing. At least one option must - be enabled. + description: Array of allowed merge methods. Allowed values include + `merge`, `squash`, and `rebase`. At least one option must be enabled. items: type: string + enum: + - merge + - squash + - rebase dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -78701,6 +86577,15 @@ components: type: boolean description: All conversations on code must be resolved before a pull request can be merged. + required_reviewers: + type: array + description: |- + > [!NOTE] + > `required_reviewers` is in beta and subject to change. + + A collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review. + items: + "$ref": "#/components/schemas/repository-rule-params-required-reviewer-configuration" required: - dismiss_stale_reviews_on_push - require_code_owner_review @@ -78781,7 +86666,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78815,7 +86700,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78849,7 +86734,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78883,7 +86768,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78917,7 +86802,7 @@ components: properties: name: type: string - description: How this rule will appear to users. + description: How this rule appears when configuring it. negate: type: boolean description: If true, the rule will fail if the pattern matches. @@ -78935,6 +86820,98 @@ components: required: - operator - pattern + repository-rule-file-path-restriction: + title: file_path_restriction + description: Prevent commits that include changes in specified file and folder + paths from being pushed to the commit graph. This includes absolute paths + that contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed to + the commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: Prevent commits that include file paths that exceed the specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: Prevent commits with individual files that exceed the specified + limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size repository-rule-params-restricted-commits: title: RestrictedCommits description: Restricted commit @@ -79052,6 +87029,44 @@ components: "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" required: - code_scanning_tools + repository-rule-copilot-code-review: + title: copilot_code_review + description: Request Copilot code review for new pull requests automatically + if the author has access to Copilot code review and their premium requests + quota has not reached the limit. + type: object + required: + - type + properties: + type: + type: string + enum: + - copilot_code_review + parameters: + type: object + properties: + review_draft_pull_requests: + type: boolean + description: Copilot automatically reviews draft pull requests before + they are marked as ready for review. + review_on_push: + type: boolean + description: Copilot automatically reviews each new push to the pull + request. + repository-rule-params-copilot-code-review-analysis-tool: + title: CopilotCodeReviewAnalysisTool + description: A tool that must provide code review results for this rule to pass. + type: object + properties: + name: + type: string + description: The name of a code review analysis tool + enum: + - CodeQL + - ESLint + - PMD + required: + - name repository-rule: title: Repository Rule type: object @@ -79072,95 +87087,13 @@ components: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - - title: file_path_restriction - description: Prevent commits that include changes in specified file paths - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_paths - - title: max_file_path_length - description: Prevent commits that include file paths that exceed a specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths - minimum: 1 - maximum: 256 - required: - - max_file_path_length - - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - title: max_file_size - description: Prevent commits that exceed a specified file size limit from - being pushed to the commit. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" repository-ruleset: title: Repository ruleset type: object @@ -79211,6 +87144,7 @@ components: - always - pull_requests_only - never + - exempt node_id: type: string _links: @@ -79244,6 +87178,32 @@ components: updated_at: type: string format: date-time + org-rules: + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - "$ref": "#/components/schemas/repository-rule-creation" + - "$ref": "#/components/schemas/repository-rule-update" + - "$ref": "#/components/schemas/repository-rule-deletion" + - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-required-deployments" + - "$ref": "#/components/schemas/repository-rule-required-signatures" + - "$ref": "#/components/schemas/repository-rule-pull-request" + - "$ref": "#/components/schemas/repository-rule-required-status-checks" + - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" rule-suites: title: Rule Suites description: Response @@ -79296,6 +87256,59 @@ components: description: The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + rule-suite-pull-request: + title: Pull request rule suite metadata + description: Metadata for a pull request rule evaluation result. + type: object + properties: + pull_request: + type: object + description: The pull request associated with the rule evaluation. + properties: + id: + type: integer + description: The unique identifier of the pull request. + number: + type: integer + description: The number of the pull request. + user: + type: object + description: The user who created the pull request. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The handle for the GitHub user account. + type: + type: string + description: The type of the user. + reviews: + type: array + description: The reviews associated with the pull request. + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the review. + user: + type: object + description: The user who submitted the review. + properties: + id: + type: integer + description: The unique identifier of the user. + login: + type: string + description: The handle for the GitHub user account. + type: + type: string + description: The type of the user. + state: + type: string + description: The state of the review. rule-suite: title: Rule Suite description: Response @@ -79314,10 +87327,10 @@ components: nullable: true before_sha: type: string - description: The first commit sha before the push evaluation. + description: The previous commit SHA of the ref. after_sha: type: string - description: The last commit sha in the push evaluation. + description: The new commit SHA of the ref. ref: type: string description: The ref name that the evaluation ran on. @@ -79391,6 +87404,504 @@ components: nullable: true description: The detailed failure message for the rule. Null if the rule passed. + ruleset-version: + title: Ruleset version + type: object + description: The historical version of a ruleset + required: + - version_id + - actor + - updated_at + properties: + version_id: + type: integer + description: The ID of the previous version of the ruleset + actor: + type: object + description: The actor who updated the ruleset + properties: + id: + type: integer + type: + type: string + updated_at: + type: string + format: date-time + ruleset-version-with-state: + allOf: + - "$ref": "#/components/schemas/ruleset-version" + - type: object + required: + - state + properties: + state: + type: object + description: The state of the ruleset version + nullable-alert-updated-at: + type: string + description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + nullable: true + secret-scanning-alert-state: + description: Sets the state of the secret scanning alert. You must provide `resolution` + when you set the state to `resolved`. + type: string + enum: + - open + - resolved + secret-scanning-alert-resolution: + type: string + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + secret-scanning-location-commit: + description: Represents a 'commit' secret scanning location type. This location + type shows that a secret was detected inside a commit to a repository. + type: object + properties: + path: + type: string + description: The file path in the repository + example: "/example/secrets.txt" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8BIT ASCII + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8BIT ASCII + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: + type: string + description: The API URL to get the associated blob resource + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_url + - commit_sha + - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url + secret-scanning-location-issue-title: + description: Represents an 'issue_title' secret scanning location type. This + location type shows that a secret was detected in the title of an issue. + type: object + properties: + issue_title_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_title_url + secret-scanning-location-issue-body: + description: Represents an 'issue_body' secret scanning location type. This + location type shows that a secret was detected in the body of an issue. + type: object + properties: + issue_body_url: + type: string + format: uri + description: The API URL to get the issue where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/1347 + required: + - issue_body_url + secret-scanning-location-issue-comment: + description: Represents an 'issue_comment' secret scanning location type. This + location type shows that a secret was detected in a comment on an issue. + type: object + properties: + issue_comment_url: + type: string + format: uri + description: The API URL to get the issue comment where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + format: uri + description: The API URL to get the pull request where the secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + nullable-secret-scanning-first-detected-location: + description: 'Details on the location where the token was initially detected. + This can be a commit, wiki commit, issue, discussion, pull request. + + ' + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" + - "$ref": "#/components/schemas/secret-scanning-location-issue-title" + - "$ref": "#/components/schemas/secret-scanning-location-issue-body" + - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" + nullable: true + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + "$ref": "#/components/schemas/nullable-alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + state: + "$ref": "#/components/schemas/secret-scanning-alert-state" + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + secret_type: + type: string + description: The type of secret that secret scanning detected. + secret_type_display_name: + type: string + description: |- + User-friendly name for the detected secret, matching the `secret_type`. + For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + push_protection_bypass_request_reviewer: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypass_request_reviewer_comment: + type: string + description: An optional comment when reviewing a push protection bypass. + nullable: true + push_protection_bypass_request_comment: + type: string + description: An optional comment when requesting a push protection bypass. + nullable: true + push_protection_bypass_request_html_url: + type: string + format: uri + description: The URL to a push protection bypass request. + nullable: true + resolution_comment: + type: string + description: The comment that was optionally added when this alert was closed + nullable: true + validity: + type: string + description: The token status as of the latest validity check. + enum: + - 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 + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + "$ref": "#/components/schemas/nullable-simple-user" + secret-scanning-row-version: + type: string + description: The version of the entity. This is used to confirm you're updating + the current version of the entity and mitigate unintentionally overriding + someone else's update. + nullable: true + secret-scanning-pattern-override: + type: object + properties: + token_type: + type: string + description: The ID of the pattern. + custom_pattern_version: + type: string + description: The version of this pattern if it's a custom pattern. + nullable: true + slug: + type: string + description: The slug of the pattern. + display_name: + type: string + description: The user-friendly name for the pattern. + alert_total: + type: integer + description: The total number of alerts generated by this pattern. + alert_total_percentage: + type: integer + description: The percentage of all alerts that this pattern represents, + rounded to the nearest integer. + false_positives: + type: integer + description: The number of false positive alerts generated by this pattern. + false_positive_rate: + type: integer + description: The percentage of alerts from this pattern that are false positives, + rounded to the nearest integer. + bypass_rate: + type: integer + description: The percentage of blocks for this pattern that were bypassed, + rounded to the nearest integer. + default_setting: + type: string + description: The default push protection setting for this pattern. + enum: + - disabled + - enabled + enterprise_setting: + type: string + description: The push protection setting for this pattern set at the enterprise + level. Only present for partner patterns when the organization has a parent + enterprise. + enum: + - not-set + - disabled + - enabled + nullable: true + setting: + type: string + description: The current push protection setting for this pattern. If this + is `not-set`, then it inherits either the enterprise setting if it exists + or the default setting. + enum: + - not-set + - disabled + - enabled + secret-scanning-pattern-configuration: + title: Secret scanning pattern configuration + description: A collection of secret scanning patterns and their settings related + to push protection. + type: object + properties: + pattern_config_version: + "$ref": "#/components/schemas/secret-scanning-row-version" + provider_pattern_overrides: + type: array + description: Overrides for partner patterns. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" + custom_pattern_overrides: + type: array + description: Overrides for custom patterns defined by the organization. + items: + "$ref": "#/components/schemas/secret-scanning-pattern-override" repository-advisory-vulnerability: description: A product affected by the vulnerability detailed in a repository security advisory. @@ -79688,104 +88199,27 @@ components: - collaborating_teams - private_fork additionalProperties: false - actions-billing-usage: + immutable-releases-organization-settings: + title: Check immutable releases organization settings + description: Check immutable releases settings for an organization. type: object properties: - total_minutes_used: - type: integer - description: The sum of the free and paid GitHub Actions minutes used. - total_paid_minutes_used: - type: integer - description: The total paid GitHub Actions minutes used. - included_minutes: - type: integer - description: The amount of free GitHub Actions minutes available. - minutes_used_breakdown: - type: object - properties: - UBUNTU: - type: integer - description: Total minutes used on Ubuntu runner machines. - MACOS: - type: integer - description: Total minutes used on macOS runner machines. - WINDOWS: - type: integer - description: Total minutes used on Windows runner machines. - ubuntu_4_core: - type: integer - description: Total minutes used on Ubuntu 4 core runner machines. - ubuntu_8_core: - type: integer - description: Total minutes used on Ubuntu 8 core runner machines. - ubuntu_16_core: - type: integer - description: Total minutes used on Ubuntu 16 core runner machines. - ubuntu_32_core: - type: integer - description: Total minutes used on Ubuntu 32 core runner machines. - ubuntu_64_core: - type: integer - description: Total minutes used on Ubuntu 64 core runner machines. - windows_4_core: - type: integer - description: Total minutes used on Windows 4 core runner machines. - windows_8_core: - type: integer - description: Total minutes used on Windows 8 core runner machines. - windows_16_core: - type: integer - description: Total minutes used on Windows 16 core runner machines. - windows_32_core: - type: integer - description: Total minutes used on Windows 32 core runner machines. - windows_64_core: - type: integer - description: Total minutes used on Windows 64 core runner machines. - macos_12_core: - type: integer - description: Total minutes used on macOS 12 core runner machines. - total: - type: integer - description: Total minutes used on all runner machines. - required: - - total_minutes_used - - total_paid_minutes_used - - included_minutes - - minutes_used_breakdown - packages-billing-usage: - type: object - properties: - total_gigabytes_bandwidth_used: - type: integer - description: Sum of the free and paid storage space (GB) for GitHuub Packages. - total_paid_gigabytes_bandwidth_used: - type: integer - description: Total paid storage space (GB) for GitHuub Packages. - included_gigabytes_bandwidth: - type: integer - description: Free storage space (GB) for GitHub Packages. - required: - - total_gigabytes_bandwidth_used - - total_paid_gigabytes_bandwidth_used - - included_gigabytes_bandwidth - combined-billing-usage: - type: object - properties: - days_left_in_billing_cycle: - type: integer - description: Numbers of days left in billing cycle. - estimated_paid_storage_for_month: - type: integer - description: Estimated storage space (GB) used in billing cycle. - estimated_storage_for_month: - type: integer - description: Estimated sum of free and paid storage space (GB) used in billing - cycle. + enforced_repositories: + type: string + description: The policy that controls how immutable releases are enforced + in the organization. + enum: + - all + - none + - selected + example: all + selected_repositories_url: + type: string + description: The API URL to use to get or set the selected repositories + for immutable releases enforcement, when `enforced_repositories` is set + to `selected`. required: - - days_left_in_billing_cycle - - estimated_paid_storage_for_month - - estimated_storage_for_month + - enforced_repositories network-configuration: title: Hosted compute network configuration description: A hosted compute network configuration. @@ -79812,6 +88246,17 @@ components: items: type: string example: 123ABC456DEF789 + failover_network_settings_ids: + description: The unique identifier of each failover network settings in + the configuration. + type: array + items: + type: string + example: 123ABC456DEF789 + failover_network_enabled: + description: Indicates whether the failover network resource is enabled. + type: boolean + example: true created_on: description: The time at which the network configuration was created, in ISO 8601 format. @@ -80063,6 +88508,11 @@ components: - created_at - updated_at - archived_at + ldap-dn: + type: string + description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) + (DN) of the LDAP entry to map to a team. + example: cn=Enterprise Ops,ou=teams,dc=github,dc=com team-full: title: Full Team description: Groups of organization members that gives permissions on specified @@ -80140,9 +88590,21 @@ components: organization: "$ref": "#/components/schemas/team-organization" ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - example: uid=example,ou=users,dc=github,dc=com + "$ref": "#/components/schemas/ldap-dn" + type: + description: The ownership type of the team type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 required: - id - node_id @@ -80154,206 +88616,12 @@ components: - html_url - repositories_url - slug + - type - created_at - updated_at - members_count - repos_count - organization - team-discussion: - title: Team Discussion - description: A team discussion is a persistent record of a free-form conversation - within a team. - type: object - properties: - author: - "$ref": "#/components/schemas/nullable-simple-user" - body: - description: The main text of the discussion. - example: Please suggest improvements to our workflow in comments. - type: string - body_html: - type: string - example: "

Hi! This is an area for us to collaborate as a team

" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - example: 0307116bbf7ced493b8d8a346c650b71 - type: string - comments_count: - type: integer - example: 0 - comments_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments - created_at: - type: string - format: date-time - example: '2018-01-25T18:56:31Z' - last_edited_at: - type: string - format: date-time - nullable: true - html_url: - type: string - format: uri - example: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - example: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - example: 42 - type: integer - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - example: true - type: boolean - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - example: true - type: boolean - team_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - example: How can we improve our workflow? - type: string - updated_at: - type: string - format: date-time - example: '2018-01-25T18:56:31Z' - url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - author - - body - - body_html - - body_version - - comments_count - - comments_url - - created_at - - last_edited_at - - html_url - - pinned - - private - - node_id - - number - - team_url - - title - - updated_at - - url - team-discussion-comment: - title: Team Discussion Comment - description: A reply to a discussion within a team. - type: object - properties: - author: - "$ref": "#/components/schemas/nullable-simple-user" - body: - description: The main text of the comment. - example: I agree with this suggestion. - type: string - body_html: - type: string - example: "

Do you like apples?

" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - example: 0307116bbf7ced493b8d8a346c650b71 - type: string - created_at: - type: string - format: date-time - example: '2018-01-15T23:53:58Z' - last_edited_at: - type: string - format: date-time - nullable: true - discussion_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2403582/discussions/1 - html_url: - type: string - format: uri - example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: - type: string - example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: - description: The unique sequence number of a team discussion comment. - example: 42 - type: integer - updated_at: - type: string - format: date-time - example: '2018-01-15T23:53:58Z' - url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - author - - body - - body_html - - body_version - - created_at - - last_edited_at - - discussion_url - - html_url - - node_id - - number - - updated_at - - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - "$ref": "#/components/schemas/nullable-simple-user" - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at team-membership: title: Team Membership description: Team Membership @@ -80380,74 +88648,6 @@ components: - role - state - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions team-repository: title: Team Repository description: A team's access to a repository. @@ -80856,124 +89056,6 @@ components: - watchers_count - created_at - updated_at - project-card: - title: Project Card - description: Project cards represent a scope of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 - type: integer - format: int64 - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column - nullable: true - creator: - "$ref": "#/components/schemas/nullable-simple-user" - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: - type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. - type: object - properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:22:28Z' - required: - - id - - node_id - - url - - project_url - - cards_url - - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission - type: object - properties: - permission: - type: string - user: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - permission - - user rate-limit: title: Rate Limit type: object @@ -81019,6 +89101,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -81069,6 +89153,13 @@ components: type: string format: date-time nullable: true + digest: + type: string + description: The SHA256 digest of the artifact. This field will only be + populated on artifacts uploaded with upload-artifact v4 or newer. For + older versions, this field will be null. + nullable: true + example: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: type: object nullable: true @@ -81099,6 +89190,24 @@ components: - created_at - expires_at - updated_at + actions-cache-retention-limit-for-repository: + title: Actions cache retention limit for a repository + description: GitHub Actions cache retention policy for a repository. + type: object + properties: + max_cache_retention_days: + description: The maximum number of days to keep caches in this repository. + type: integer + example: 14 + actions-cache-storage-limit-for-repository: + title: Actions cache storage limit for a repository + description: GitHub Actions cache storage policy for a repository. + type: object + properties: + max_cache_size_gb: + description: The maximum total cache size for this repository, in gigabytes. + type: integer + example: 10 actions-cache-list: title: Repository actions caches description: Repository actions caches @@ -81409,6 +89518,8 @@ components: "$ref": "#/components/schemas/allowed-actions" selected_actions_url: "$ref": "#/components/schemas/selected-actions-url" + sha_pinning_required: + "$ref": "#/components/schemas/sha-pinning-required" required: - enabled actions-workflow-access-to-repository: @@ -81441,73 +89552,6 @@ components: required: - path - sha - pull-request-minimal: - title: Pull Request Minimal - type: object - properties: - id: - type: integer - format: int64 - number: - type: integer - url: - type: string - head: - type: object - properties: - ref: - type: string - sha: - type: string - repo: - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - name: - type: string - required: - - id - - url - - name - required: - - ref - - sha - - repo - base: - type: object - properties: - ref: - type: string - sha: - type: string - repo: - type: object - properties: - id: - type: integer - format: int64 - url: - type: string - name: - type: string - required: - - id - - url - - name - required: - - ref - - sha - - repo - required: - - id - - number - - url - - head - - base nullable-simple-commit: title: Simple Commit description: A commit. @@ -82127,6 +90171,29 @@ components: - badge_url - created_at - updated_at + workflow-run-id: + title: Workflow Run ID + description: The ID of the workflow run. + type: integer + format: int64 + workflow-dispatch-response: + title: Workflow Dispatch Response + description: Response containing the workflow run ID and URLs. + type: object + properties: + workflow_run_id: + "$ref": "#/components/schemas/workflow-run-id" + run_url: + type: string + format: uri + description: The URL to the workflow run. + html_url: + type: string + format: uri + required: + - workflow_run_id + - run_url + - html_url workflow-usage: title: Workflow Usage description: Workflow Usage @@ -82224,6 +90291,10 @@ components: If false, this autolink reference only matches numeric characters. example: true type: boolean + updated_at: + type: string + nullable: true + format: date-time required: - id - key_prefix @@ -82433,36 +90504,7 @@ components: teams: type: array items: - type: object - properties: - id: - type: integer - node_id: - type: string - url: - type: string - html_url: - type: string - name: - type: string - slug: - type: string - description: - type: string - nullable: true - privacy: - type: string - notification_setting: - type: string - permission: - type: string - members_url: - type: string - repositories_url: - type: string - parent: - type: string - nullable: true + "$ref": "#/components/schemas/team" apps: type: array items: @@ -82694,6 +90736,7 @@ components: example: '"chris@ozmm.org"' date: type: string + format: date-time example: '"2007-10-29T02:42:39.000-07:00"' nullable: true verification: @@ -82718,6 +90761,7 @@ components: - reason - payload - signature + - verified_at diff-entry: title: Diff Entry description: Diff Entry @@ -82725,6 +90769,7 @@ components: properties: sha: type: string + nullable: true example: bbcd538c8e72b8c175046e27cc8f907076331401 filename: type: string @@ -83614,6 +91659,12 @@ components: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" + dismissal_approved_by: + "$ref": "#/components/schemas/nullable-simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -83709,6 +91760,12 @@ components: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: "$ref": "#/components/schemas/code-scanning-alert-instance" + dismissal_approved_by: + "$ref": "#/components/schemas/nullable-simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -83729,6 +91786,15 @@ components: enum: - open - dismissed + code-scanning-alert-create-request: + type: boolean + description: If `true`, attempt to create an alert dismissal request. + code-scanning-alert-assignees: + description: The list of users to assign to the code scanning alert. An empty + array unassigns all previous assignees from the alert. + type: array + items: + type: string code-scanning-autofix-status: type: string description: The status of an autofix. @@ -83783,6 +91849,44 @@ components: sha: type: string description: SHA of commit with autofix. + code-scanning-alert-instance-state: + type: string + description: State of a code scanning alert instance. + nullable: true + enum: + - open + - fixed + code-scanning-alert-instance-list: + type: object + properties: + ref: + "$ref": "#/components/schemas/code-scanning-ref" + analysis_key: + "$ref": "#/components/schemas/code-scanning-analysis-analysis-key" + environment: + "$ref": "#/components/schemas/code-scanning-alert-environment" + category: + "$ref": "#/components/schemas/code-scanning-analysis-category" + state: + "$ref": "#/components/schemas/code-scanning-alert-instance-state" + commit_sha: + type: string + message: + type: object + properties: + text: + type: string + location: + "$ref": "#/components/schemas/code-scanning-alert-location" + html_url: + type: string + classifications: + type: array + description: |- + Classifications that have been applied to the file that triggered the alert. + For example identifying it as documentation, or a generated file. + items: + "$ref": "#/components/schemas/code-scanning-alert-classification" code-scanning-analysis-sarif-id: type: string description: An identifier for the upload. @@ -83939,6 +92043,7 @@ components: type: string description: The language targeted by the CodeQL query enum: + - actions - cpp - csharp - go @@ -83946,6 +92051,7 @@ components: - javascript - python - ruby + - rust - swift code-scanning-variant-analysis-repository: title: Repository Identifier @@ -84207,6 +92313,15 @@ components: enum: - default - extended + threat_model: + description: Threat model to be used for code scanning analysis. Use `remote` + to analyze only network sources and `remote_and_local` to include local + sources like filesystem access, command-line arguments, database reads, + environment variable and standard input. + type: string + enum: + - remote + - remote_and_local updated_at: description: Timestamp of latest configuration update. nullable: true @@ -84246,6 +92361,15 @@ components: enum: - default - extended + threat_model: + description: Threat model to be used for code scanning analysis. Use `remote` + to analyze only network sources and `remote_and_local` to include local + sources like filesystem access, command-line arguments, database reads, + environment variable and standard input. + type: string + enum: + - remote + - remote_and_local languages: description: CodeQL languages to be analyzed. type: array @@ -84838,312 +92962,66 @@ components: - author_association - created_at - updated_at - branch-short: - title: Branch Short - description: Branch Short - type: object - properties: - name: - type: string - commit: - type: object - properties: - sha: - type: string - url: - type: string - required: - - sha - - url - protected: - type: boolean - required: - - name - - commit - - protected - link: - title: Link - description: Hypermedia Link - type: object - properties: - href: - type: string - required: - - href - auto-merge: - title: Auto merge - description: The status of auto merging a pull request. - type: object - properties: - enabled_by: - "$ref": "#/components/schemas/simple-user" - merge_method: - type: string - description: The merge method to use. - enum: - - merge - - squash - - rebase - commit_title: - type: string - description: Title for the merge commit message. - commit_message: - type: string - description: Commit message for the merge commit. - required: - - enabled_by - - merge_method - - commit_title - - commit_message - nullable: true - pull-request-simple: - title: Pull Request Simple - description: Pull Request Simple + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. type: object properties: - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer - format: int64 example: 1 node_id: type: string - example: MDExOlB1bGxSZXF1ZXN0MQ== - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347 - diff_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347.diff - patch_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World/pull/1347.patch - issue_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - commits_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits - review_comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments - review_comment_url: - type: string - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} - comments_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments - statuses_url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e - number: - type: integer - example: 1347 - state: - type: string - example: open - locked: - type: boolean - example: true - title: - type: string - example: new-feature + example: MDg6UmVhY3Rpb24x user: "$ref": "#/components/schemas/nullable-simple-user" - body: - type: string - example: Please pull these awesome changes - nullable: true - labels: - type: array - items: - type: object - properties: - id: - type: integer - format: int64 - node_id: - type: string - url: - type: string - name: - type: string - description: - type: string - color: - type: string - default: - type: boolean - required: - - id - - node_id - - url - - name - - description - - color - - default - milestone: - "$ref": "#/components/schemas/nullable-milestone" - active_lock_reason: + content: + description: The reaction to use + example: heart type: string - example: too heated - nullable: true + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes created_at: type: string format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - closed_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - merged_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - merge_commit_sha: + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + branch-short: + title: Branch Short + description: Branch Short + type: object + properties: + name: type: string - example: e5bd3914e2e596debea16f433f57875b5b90bcd6 - nullable: true - assignee: - "$ref": "#/components/schemas/nullable-simple-user" - assignees: - type: array - items: - "$ref": "#/components/schemas/simple-user" - nullable: true - requested_reviewers: - type: array - items: - "$ref": "#/components/schemas/simple-user" - nullable: true - requested_teams: - type: array - items: - "$ref": "#/components/schemas/team" - nullable: true - head: + commit: type: object properties: - label: - type: string - ref: - type: string - repo: - "$ref": "#/components/schemas/repository" sha: type: string - user: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - label - - ref - - repo - - sha - - user - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - "$ref": "#/components/schemas/repository" - sha: + url: type: string - user: - "$ref": "#/components/schemas/nullable-simple-user" required: - - label - - ref - - repo - sha - - user - _links: - type: object - properties: - comments: - "$ref": "#/components/schemas/link" - commits: - "$ref": "#/components/schemas/link" - statuses: - "$ref": "#/components/schemas/link" - html: - "$ref": "#/components/schemas/link" - issue: - "$ref": "#/components/schemas/link" - review_comments: - "$ref": "#/components/schemas/link" - review_comment: - "$ref": "#/components/schemas/link" - self: - "$ref": "#/components/schemas/link" - required: - - comments - - commits - - statuses - - html - - issue - - review_comments - - review_comment - - self - author_association: - "$ref": "#/components/schemas/author-association" - auto_merge: - "$ref": "#/components/schemas/auto-merge" - draft: - description: Indicates whether or not the pull request is a draft. - example: false + - url + protected: type: boolean required: - - _links - - assignee - - labels - - base - - body - - closed_at - - comments_url - - commits_url - - created_at - - diff_url - - head - - html_url - - id - - node_id - - issue_url - - merge_commit_sha - - merged_at - - milestone - - number - - patch_url - - review_comment_url - - review_comments_url - - statuses_url - - state - - locked - - title - - updated_at - - url - - user - - author_association - - auto_merge + - name + - commit + - protected simple-commit-status: title: Simple Commit Status type: object @@ -85516,6 +93394,8 @@ components: - size - type - url + encoding: + type: string _links: type: object properties: @@ -86044,6 +93924,19 @@ components: enum: - development - runtime + relationship: + type: string + description: | + The vulnerable dependency's relationship to your project. + + > [!NOTE] + > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems. + readOnly: true + nullable: true + enum: + - unknown + - direct + - transitive security_advisory: "$ref": "#/components/schemas/dependabot-alert-security-advisory" security_vulnerability: @@ -86079,6 +93972,14 @@ components: "$ref": "#/components/schemas/alert-fixed-at" auto_dismissed_at: "$ref": "#/components/schemas/alert-auto-dismissed-at" + dismissal_request: + "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" + assignees: + type: array + description: The users assigned to this alert. + readOnly: true + items: + "$ref": "#/components/schemas/simple-user" required: - number - state @@ -87019,6 +94920,7 @@ components: - reason - signature - payload + - verified_at html_url: type: string format: uri @@ -87146,6 +95048,11 @@ components: type: array items: type: object + required: + - path + - mode + - type + - sha properties: path: type: string @@ -87172,29 +95079,8 @@ components: size: 30 sha: 44b4fc6d56897b048c772eb4087f854f46256132 url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 - properties: - path: - type: string - mode: - type: string - type: - type: string - size: - type: integer - sha: - type: string - url: - type: string - required: - - path - - mode - - type - - sha - - url - - size required: - sha - - url - tree - truncated hook-response: @@ -87283,6 +95169,22 @@ components: - updated_at - last_response - test_url + check-immutable-releases: + title: Check immutable releases + description: Check immutable releases + type: object + properties: + enabled: + type: boolean + example: true + description: Whether immutable releases are enabled for the repository. + enforced_by_owner: + type: boolean + example: false + description: Whether immutable releases are enforced by the repository owner. + required: + - enabled + - enforced_by_owner import: title: Import description: A repository import from an external source. @@ -87475,6 +95377,7 @@ components: - completed - reopened - not_planned + - duplicate title: description: Title of the issue example: Widget creation fails in Safari on OS X 10.8 @@ -87585,6 +95488,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" repository: "$ref": "#/components/schemas/repository" performed_via_github_app: @@ -87595,6 +95500,19 @@ components: "$ref": "#/components/schemas/reaction-rollup" sub_issues_summary: "$ref": "#/components/schemas/sub-issues-summary" + parent_issue_url: + description: URL to get the parent issue of this issue, if it is a sub-issue + type: string + format: uri + nullable: true + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" required: - assignee - closed_at @@ -87614,7 +95532,6 @@ components: - title - url - user - - author_association - created_at - updated_at nullable: true @@ -88500,51 +96417,6 @@ components: - "$ref": "#/components/schemas/moved-column-in-project-issue-event" - "$ref": "#/components/schemas/removed-from-project-issue-event" - "$ref": "#/components/schemas/converted-note-to-issue-issue-event" - label: - title: Label - description: Color-coded labels help you categorize and filter your issues (just - like labels in Gmail). - type: object - properties: - id: - description: Unique identifier for the label. - type: integer - format: int64 - example: 208045946 - node_id: - type: string - example: MDU6TGFiZWwyMDgwNDU5NDY= - url: - description: URL for the label - example: https://api.github.com/repositories/42/labels/bug - type: string - format: uri - name: - description: The name of the label. - example: bug - type: string - description: - description: Optional description of the label, such as its purpose. - type: string - example: Something isn't working - nullable: true - color: - description: '6-character hex code, without the leading #, identifying the - color' - example: FFFFFF - type: string - default: - description: Whether this label comes by default in a new repository. - type: boolean - example: true - required: - - id - - node_id - - url - - name - - description - - color - - default timeline-comment-event: title: Timeline Comment Event description: Timeline Comment Event @@ -88595,6 +96467,8 @@ components: "$ref": "#/components/schemas/nullable-integration" reactions: "$ref": "#/components/schemas/reaction-rollup" + pin: + "$ref": "#/components/schemas/nullable-pinned-issue-comment" required: - event - actor @@ -88749,6 +96623,7 @@ components: - reason - signature - payload + - verified_at html_url: type: string format: uri @@ -88818,6 +96693,10 @@ components: submitted_at: type: string format: date-time + updated_at: + type: string + nullable: true + format: date-time commit_id: description: A commit SHA for the review. example: 54bb654c9e6025347f57900a4a5c2313a96b8035 @@ -88896,7 +96775,7 @@ components: example: 8 type: integer user: - "$ref": "#/components/schemas/simple-user" + "$ref": "#/components/schemas/nullable-simple-user" body: description: The text of the comment. example: We should probably include a check for null values here. @@ -89215,8 +97094,9 @@ components: type: string nullable: true last_used: - type: string nullable: true + type: string + format: date-time enabled: type: boolean required: @@ -90325,6 +98205,13 @@ components: example: 2 type: integer nullable: true + subject_type: + description: The level at which the comment is targeted, can be a diff line + or a file. + type: string + enum: + - line + - file required: - id - node_id @@ -90344,157 +98231,6 @@ components: - author_association - created_at - updated_at - release-asset: - title: Release Asset - description: Data related to a release. - type: object - properties: - url: - type: string - format: uri - browser_download_url: - type: string - format: uri - id: - type: integer - node_id: - type: string - name: - description: The file name of the asset. - type: string - example: Team Environment - label: - type: string - nullable: true - state: - description: State of the release asset. - type: string - enum: - - uploaded - - open - content_type: - type: string - size: - type: integer - download_count: - type: integer - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - uploader: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - id - - name - - content_type - - size - - state - - url - - node_id - - download_count - - label - - uploader - - browser_download_url - - created_at - - updated_at - release: - title: Release - description: A release. - type: object - properties: - url: - type: string - format: uri - html_url: - type: string - format: uri - assets_url: - type: string - format: uri - upload_url: - type: string - tarball_url: - type: string - format: uri - nullable: true - zipball_url: - type: string - format: uri - nullable: true - id: - type: integer - node_id: - type: string - tag_name: - description: The name of the tag. - example: v1.0.0 - type: string - target_commitish: - description: Specifies the commitish value that determines where the Git - tag is created from. - example: master - type: string - name: - type: string - nullable: true - body: - type: string - nullable: true - draft: - description: true to create a draft (unpublished) release, false to create - a published one. - example: false - type: boolean - prerelease: - description: Whether to identify the release as a prerelease or a full release. - example: false - type: boolean - created_at: - type: string - format: date-time - published_at: - type: string - format: date-time - nullable: true - author: - "$ref": "#/components/schemas/simple-user" - assets: - type: array - items: - "$ref": "#/components/schemas/release-asset" - body_html: - type: string - body_text: - type: string - mentions_count: - type: integer - discussion_url: - description: The URL of the release discussion. - type: string - format: uri - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - assets_url - - upload_url - - tarball_url - - zipball_url - - created_at - - published_at - - draft - - id - - node_id - - author - - html_url - - name - - prerelease - - tag_name - - target_commitish - - assets - - url release-notes-content: title: Generated Release Notes Content description: Generated name and body describing a release @@ -90578,12 +98314,27 @@ components: - allOf: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object properties: @@ -90670,249 +98421,29 @@ components: description: Whether the detected secret was found in multiple repositories under the same organization or enterprise. nullable: true + is_base64_encoded: + type: boolean + description: A boolean value representing whether or not alert is base64 + encoded + nullable: true + first_location_detected: + "$ref": "#/components/schemas/nullable-secret-scanning-first-detected-location" + has_more_locations: + type: boolean + description: A boolean value representing whether or not the token in the + alert was detected in more than one location. + assigned_to: + "$ref": "#/components/schemas/nullable-simple-user" 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`. + description: An optional comment when closing or reopening an alert. Cannot + be updated or deleted. + type: string + nullable: true + secret-scanning-alert-assignee: + description: The username of the user to assign to the alert. Set to `null` + to unassign the alert. type: string nullable: true - secret-scanning-location-commit: - description: Represents a 'commit' secret scanning location type. This location - type shows that a secret was detected inside a commit to a repository. - type: object - properties: - path: - type: string - description: The file path in the repository - example: "/example/secrets.txt" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8BIT ASCII - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8BIT ASCII - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - blob_url: - type: string - description: The API URL to get the associated blob resource - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - commit_url: - type: string - description: The API URL to get the associated commit resource - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - blob_url - - commit_sha - - commit_url - secret-scanning-location-wiki-commit: - description: Represents a 'wiki_commit' secret scanning location type. This - location type shows that a secret was detected inside a commit to a repository - wiki. - type: object - properties: - path: - type: string - description: The file path of the wiki page - example: "/example/Home.md" - start_line: - type: number - description: Line number at which the secret starts in the file - end_line: - type: number - description: Line number at which the secret ends in the file - start_column: - type: number - description: The column at which the secret starts within the start line - when the file is interpreted as 8-bit ASCII. - end_column: - type: number - description: The column at which the secret ends within the end line when - the file is interpreted as 8-bit ASCII. - blob_sha: - type: string - description: SHA-1 hash ID of the associated blob - example: af5626b4a114abcb82d63db7c8082c3c4756e51b - page_url: - type: string - description: The GitHub URL to get the associated wiki page - example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_sha: - type: string - description: SHA-1 hash ID of the associated commit - example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 - commit_url: - type: string - description: The GitHub URL to get the associated wiki commit - example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - required: - - path - - start_line - - end_line - - start_column - - end_column - - blob_sha - - page_url - - commit_sha - - commit_url - secret-scanning-location-issue-title: - description: Represents an 'issue_title' secret scanning location type. This - location type shows that a secret was detected in the title of an issue. - type: object - properties: - issue_title_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_title_url - secret-scanning-location-issue-body: - description: Represents an 'issue_body' secret scanning location type. This - location type shows that a secret was detected in the body of an issue. - type: object - properties: - issue_body_url: - type: string - format: uri - description: The API URL to get the issue where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/1347 - required: - - issue_body_url - secret-scanning-location-issue-comment: - description: Represents an 'issue_comment' secret scanning location type. This - location type shows that a secret was detected in a comment on an issue. - type: object - properties: - issue_comment_url: - type: string - format: uri - description: The API URL to get the issue comment where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - issue_comment_url - secret-scanning-location-discussion-title: - description: Represents a 'discussion_title' secret scanning location type. - This location type shows that a secret was detected in the title of a discussion. - type: object - properties: - discussion_title_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082 - required: - - discussion_title_url - secret-scanning-location-discussion-body: - description: Represents a 'discussion_body' secret scanning location type. This - location type shows that a secret was detected in the body of a discussion. - type: object - properties: - discussion_body_url: - type: string - format: uri - description: The URL to the discussion where the secret was detected. - example: https://github.com/community/community/discussions/39082#discussion-4566270 - required: - - discussion_body_url - secret-scanning-location-discussion-comment: - description: Represents a 'discussion_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a discussion. - type: object - properties: - discussion_comment_url: - type: string - format: uri - description: The API URL to get the discussion comment where the secret - was detected. - example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 - required: - - discussion_comment_url - secret-scanning-location-pull-request-title: - description: Represents a 'pull_request_title' secret scanning location type. - This location type shows that a secret was detected in the title of a pull - request. - type: object - properties: - pull_request_title_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_title_url - secret-scanning-location-pull-request-body: - description: Represents a 'pull_request_body' secret scanning location type. - This location type shows that a secret was detected in the body of a pull - request. - type: object - properties: - pull_request_body_url: - type: string - format: uri - description: The API URL to get the pull request where the secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846 - required: - - pull_request_body_url - secret-scanning-location-pull-request-comment: - description: Represents a 'pull_request_comment' secret scanning location type. - This location type shows that a secret was detected in a comment on a pull - request. - type: object - properties: - pull_request_comment_url: - type: string - format: uri - description: The API URL to get the pull request comment where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 - required: - - pull_request_comment_url - secret-scanning-location-pull-request-review: - description: Represents a 'pull_request_review' secret scanning location type. - This location type shows that a secret was detected in a review on a pull - request. - type: object - properties: - pull_request_review_url: - type: string - format: uri - description: The API URL to get the pull request review where the secret - was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 - required: - - pull_request_review_url - secret-scanning-location-pull-request-review-comment: - description: Represents a 'pull_request_review_comment' secret scanning location - type. This location type shows that a secret was detected in a review comment - on a pull request. - type: object - properties: - pull_request_review_comment_url: - type: string - format: uri - description: The API URL to get the pull request review comment where the - secret was detected. - example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 - required: - - pull_request_review_comment_url secret-scanning-location: type: object properties: @@ -91473,28 +99004,6 @@ components: - commit - zipball_url - tarball_url - tag-protection: - title: Tag protection - description: Tag protection - type: object - properties: - id: - type: integer - example: 2 - created_at: - type: string - example: '2011-01-26T19:01:12Z' - updated_at: - type: string - example: '2011-01-26T19:01:12Z' - enabled: - type: boolean - example: true - pattern: - type: string - example: v1.* - required: - - pattern topic: title: Topic description: A topic aggregates entities that are related to a subject. @@ -91837,19 +99346,13 @@ components: type: string nullable: true sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: type: string state_reason: @@ -91918,8 +99421,12 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" performed_via_github_app: "$ref": "#/components/schemas/nullable-integration" + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" reactions: "$ref": "#/components/schemas/reaction-rollup" required: @@ -92159,6 +99666,15 @@ components: type: boolean has_discussions: type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: type: boolean disabled: @@ -93174,6 +100690,10 @@ components: type: boolean read_only: type: boolean + last_used: + nullable: true + type: string + format: date-time required: - key - id @@ -93298,76 +100818,6 @@ components: required: - starred_at - repo - sigstore-bundle-0: - title: Sigstore Bundle v0.1 - description: Sigstore Bundle v0.1 - type: object - properties: - mediaType: - type: string - verificationMaterial: - type: object - properties: - x509CertificateChain: - type: object - properties: - certificates: - type: array - items: - type: object - properties: - rawBytes: - type: string - tlogEntries: - type: array - items: - type: object - properties: - logIndex: - type: string - logId: - type: object - properties: - keyId: - type: string - kindVersion: - type: object - properties: - kind: - type: string - version: - type: string - integratedTime: - type: string - inclusionPromise: - type: object - properties: - signedEntryTimestamp: - type: string - inclusionProof: - type: string - nullable: true - canonicalizedBody: - type: string - timestampVerificationData: - type: string - nullable: true - dsseEnvelope: - type: object - properties: - payload: - type: string - payloadType: - type: string - signatures: - type: array - items: - type: object - properties: - sig: - type: string - keyid: - type: string hovercard: title: Hovercard description: Hovercard @@ -93396,9 +100846,223 @@ components: type: integer key: type: string + created_at: + type: string + format: date-time + last_used: + nullable: true + type: string + format: date-time required: - key - id + billing-premium-request-usage-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + product: + type: string + description: The product for the usage report. + model: + type: string + description: The model for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + model: + type: string + description: Model name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - model + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems + billing-usage-report-user: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount + billing-usage-summary-report-user: + type: object + properties: + timePeriod: + type: object + properties: + year: + type: integer + description: The year for the usage report. + month: + type: integer + description: The month for the usage report. + day: + type: integer + description: The day for the usage report. + required: + - year + user: + type: string + description: The unique identifier of the user. + repository: + type: string + description: The name of the repository for the usage report. + product: + type: string + description: The product for the usage report. + sku: + type: string + description: The SKU for the usage report. + usageItems: + type: array + items: + type: object + properties: + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossQuantity: + type: number + description: Gross quantity of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountQuantity: + type: number + description: Discount quantity of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netQuantity: + type: number + description: Net quantity of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + required: + - product + - sku + - unitType + - pricePerUnit + - grossQuantity + - grossAmount + - discountQuantity + - discountAmount + - netQuantity + - netAmount + required: + - timePeriod + - user + - usageItems enterprise-webhooks: title: Enterprise description: |- @@ -93812,6 +101476,18 @@ components: default: false type: boolean example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: description: Whether the repository is archived. default: false @@ -94501,7 +102177,7 @@ components: type: object properties: app: - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: @@ -94706,6 +102382,96 @@ components: - state - updated_at - url + nullable-deployment: + title: Deployment + description: A request for a specific ref(branch,sha,tag) to be deployed + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + example: 42 + node_id: + type: string + example: MDEwOkRlcGxveW1lbnQx + sha: + type: string + example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + example: topic-branch + type: string + task: + description: Parameter to specify a task to execute + example: deploy + type: string + payload: + oneOf: + - type: object + additionalProperties: true + - type: string + original_environment: + type: string + example: staging + environment: + description: Name for the target deployment environment. + example: production + type: string + description: + type: string + example: Deploy request from hubot + nullable: true + creator: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + example: '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + example: https://api.github.com/repos/octocat/example + transient_environment: + description: 'Specifies if the given environment is will no longer exist + at some point in the future. Default: false.' + example: true + type: boolean + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + example: true + type: boolean + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + nullable: true webhooks_approver: type: object properties: @@ -95078,315 +102844,6 @@ components: - created_at - updated_at - body - discussion: - title: Discussion - description: A Discussion in a repository. - type: object - properties: - active_lock_reason: - type: string - nullable: true - answer_chosen_at: - type: string - nullable: true - answer_chosen_by: - 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 - required: - - login - - id - answer_html_url: - type: string - nullable: true - 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 - category: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer - created_at: - type: string - format: date-time - html_url: - type: string - id: - type: integer - locked: - type: boolean - node_id: - type: string - number: - type: integer - 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 - state: - type: string - description: |- - The current state of the discussion. - `converting` means that the discussion is being converted from an issue. - `transferring` means that the discussion is being transferred from another repository. - enum: - - open - - closed - - locked - - converting - - transferring - state_reason: - description: The reason for the current state - example: resolved - type: string - nullable: true - enum: - - resolved - - outdated - - duplicate - - reopened - timeline_url: - type: string - title: - type: string - updated_at: - type: string - format: date-time - 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 - 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: @@ -95786,6 +103243,8 @@ components: required: - login - id + pin: + "$ref": "#/components/schemas/nullable-pinned-issue-comment" required: - url - html_url @@ -96509,11 +103968,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -96599,20 +104053,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -96628,6 +104078,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -97558,11 +105010,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -97648,20 +105095,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -97677,6 +105120,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -98082,6 +105527,22 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team + belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team + belongs + example: 42 required: - name - id @@ -98095,6 +105556,7 @@ components: - members_url - repositories_url - permission + - type permission: description: Permission that the team will have for its repositories type: string @@ -98118,6 +105580,20 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 required: - name - id @@ -98423,6 +105899,18 @@ components: default: false type: boolean example: true + has_pull_requests: + description: Whether pull requests are enabled. + default: true + type: boolean + example: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all or + collaborators_only.' + type: string + enum: + - all + - collaborators_only archived: description: Whether the repository is archived. default: false @@ -99044,6 +106532,21 @@ components: format: uri role: type: string + direct_membership: + type: boolean + description: Whether the user has direct membership in the organization. + example: true + enterprise_teams_providing_indirect_membership: + type: array + description: |- + The slugs of the enterprise teams providing the user with indirect membership in the organization. + A limit of 100 enterprise team slugs is returned. + maxItems: 100 + items: + type: string + example: + - ent:team-one + - ent:team-two state: type: string url: @@ -99549,66 +107052,6 @@ components: - name - created_at - updated_at - projects-v2: - title: Projects v2 Project - description: A projects v2 project - type: object - properties: - id: - type: number - node_id: - type: string - owner: - "$ref": "#/components/schemas/simple-user" - creator: - "$ref": "#/components/schemas/simple-user" - title: - type: string - description: - type: string - nullable: true - public: - type: boolean - closed_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - created_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - number: - type: integer - short_description: - type: string - nullable: true - deleted_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - deleted_by: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - id - - node_id - - owner - - creator - - title - - description - - public - - closed_at - - created_at - - updated_at - - number - - short_description - - deleted_at - - deleted_by webhooks_project_changes: type: object properties: @@ -99623,14 +107066,6 @@ components: type: string nullable: true format: date-time - projects-v2-item-content-type: - title: Projects v2 Item Content Type - description: The type of content tracked in a project item - type: string - enum: - - Issue - - PullRequest - - DraftIssue projects-v2-item: title: Projects v2 Item description: An item belonging to a project @@ -99638,12 +107073,16 @@ components: properties: id: type: number + description: The unique identifier of the project item. node_id: type: string + description: The node ID of the project item. project_node_id: type: string + description: The node ID of the project that contains this item. content_node_id: type: string + description: The node ID of the content represented by this item. content_type: "$ref": "#/components/schemas/projects-v2-item-content-type" creator: @@ -99652,15 +107091,18 @@ components: type: string format: date-time example: '2022-04-28T12:00:00Z' + description: The time when the item was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' + description: The time when the item was last updated. archived_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true + description: The time when the item was archived. required: - id - content_node_id @@ -99675,14 +107117,18 @@ components: properties: id: type: string + description: The unique identifier of the option. name: type: string + description: The display name of the option. color: type: string nullable: true + description: The color associated with the option. description: type: string nullable: true + description: A short description of the option. required: - id - name @@ -99693,14 +107139,24 @@ components: properties: id: type: string + description: The unique identifier of the iteration setting. title: type: string + description: The iteration title. + title_html: + type: string + description: The iteration title, rendered as HTML. duration: type: number nullable: true + description: The duration of the iteration in days. start_date: type: string nullable: true + description: The start date of the iteration. + completed: + type: boolean + description: Whether the iteration has been completed. required: - id - title @@ -99711,20 +107167,26 @@ components: properties: id: type: number + description: The unique identifier of the status update. node_id: type: string + description: The node ID of the status update. project_node_id: type: string + description: The node ID of the project that this status update belongs + to. creator: "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' + description: The time when the status update was created. updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' + description: The time when the status update was last updated. status: type: string enum: @@ -99734,14 +107196,17 @@ components: - OFF_TRACK - COMPLETE nullable: true + description: The current status. start_date: type: string format: date example: '2022-04-28' + description: The start date of the period covered by the update. target_date: type: string format: date example: '2022-04-28' + description: The target date associated with the update. body: description: Body of the status update example: The project is off to a great start! @@ -100307,6 +107772,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -100930,6 +108406,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -102408,6 +109895,10 @@ components: type: string nullable: true format: date-time + updated_at: + type: string + nullable: true + format: date-time user: title: User type: object @@ -102528,6 +110019,9 @@ components: type: string size: type: integer + digest: + type: string + nullable: true state: description: State of the release asset. type: string @@ -102614,6 +110108,7 @@ components: - name - label - state + - digest - content_type - size - download_count @@ -102698,6 +110193,10 @@ components: type: string nullable: true format: date-time + updated_at: + type: string + nullable: true + format: date-time discussion_url: type: string format: uri @@ -102709,6 +110208,9 @@ components: format: uri id: type: integer + immutable: + description: Whether or not the release is immutable. + type: boolean name: type: string nullable: true @@ -102792,10 +110294,12 @@ components: - draft - author - prerelease + - immutable - created_at - published_at - assets - tarball_url + - updated_at - zipball_url - body webhooks_release_1: @@ -102815,10 +110319,12 @@ components: - name - node_id - prerelease + - immutable - published_at - tag_name - tarball_url - target_commitish + - updated_at - upload_url - url - zipball_url @@ -102839,6 +110345,7 @@ components: - state - content_type - size + - digest - download_count - created_at - updated_at @@ -102866,6 +110373,9 @@ components: type: string size: type: integer + digest: + type: string + nullable: true state: description: State of the release asset. type: string @@ -103034,6 +110544,9 @@ components: format: uri id: type: integer + immutable: + description: Whether or not the release is immutable. + type: boolean name: type: string nullable: true @@ -103094,6 +110607,10 @@ components: description: Specifies the commitish value that determines where the Git tag is created from. type: string + updated_at: + type: string + nullable: true + format: date-time upload_url: type: string format: uri-template @@ -103224,6 +110741,7 @@ components: state: type: string enum: + - auto_dismissed - open secret-scanning-alert-resolution-webhook: type: string @@ -103317,6 +110835,8 @@ components: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true + assigned_to: + "$ref": "#/components/schemas/nullable-simple-user" webhooks_security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -103777,6 +111297,22 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team + belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team + belongs + example: 42 required: - name - id @@ -103790,6 +111326,7 @@ components: - members_url - repositories_url - permission + - type permission: description: Permission that the team will have for its repositories type: string @@ -103815,6 +111352,20 @@ components: description: URL for the team type: string format: uri + type: + description: The ownership type of the team + type: string + enum: + - enterprise + - organization + organization_id: + type: integer + description: Unique identifier of the organization to which this team belongs + example: 37 + enterprise_id: + type: integer + description: Unique identifier of the enterprise to which this team belongs + example: 42 required: - name - id @@ -104055,6 +111606,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104088,6 +111641,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104121,6 +111676,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104163,6 +111720,8 @@ components: "$ref": "#/components/schemas/check-run-with-simple-check-suite" installation: "$ref": "#/components/schemas/simple-installation" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104527,11 +112086,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -104980,6 +112534,16 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write + attestations: + type: string + enum: + - read + - write checks: type: string enum: @@ -104995,6 +112559,10 @@ components: enum: - read - write + copilot_requests: + type: string + enum: + - write deployments: type: string enum: @@ -105030,11 +112598,21 @@ components: enum: - read - write + merge_queues: + type: string + enum: + - read + - write metadata: type: string enum: - read - write + models: + type: string + enum: + - read + - write organization_administration: type: string enum: @@ -105132,11 +112710,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -105578,6 +113151,16 @@ components: enum: - read - write + artifact_metadata: + type: string + enum: + - read + - write + attestations: + type: string + enum: + - read + - write checks: type: string enum: @@ -105593,6 +113176,10 @@ components: enum: - read - write + copilot_requests: + type: string + enum: + - write deployments: type: string enum: @@ -105628,11 +113215,21 @@ components: enum: - read - write + merge_queues: + type: string + enum: + - read + - write metadata: type: string enum: - read - write + models: + type: string + enum: + - read + - write organization_administration: type: string enum: @@ -105730,11 +113327,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -106000,6 +113592,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -106257,6 +113853,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -106485,6 +114085,75 @@ components: url: type: string format: uri + dismissal_approved_by: + 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 + required: + - login + - id required: - number - created_at @@ -106694,6 +114363,12 @@ components: url: type: string format: uri + dismissal_approved_by: + nullable: true + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" required: - number - created_at @@ -106738,6 +114413,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107015,8 +114694,11 @@ components: alert: description: The code scanning alert involved in the event. type: object - nullable: true properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107045,6 +114727,8 @@ components: description: The GitHub URL of the alert resource. type: string format: uri + instances_url: + type: string most_recent_instance: title: Alert Instance type: object @@ -107176,9 +114860,14 @@ components: required: - name - version + updated_at: + type: string + nullable: true url: type: string format: uri + dismissal_approved_by: + nullable: true required: - number - created_at @@ -107231,6 +114920,10 @@ components: description: The code scanning alert involved in the event. type: object properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" created_at: description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`' @@ -107401,6 +115094,261 @@ components: - commit_oid - repository - sender + webhook-code-scanning-alert-updated-assignment: + title: code_scanning_alert updated_assignment event + type: object + properties: + action: + type: string + enum: + - updated_assignment + alert: + description: The code scanning alert involved in the event. + type: object + properties: + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: + 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 + required: + - login + - id + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - null + fixed_at: + description: 'The time that the alert was fixed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - null + required: + - id + - severity + - description + state: + description: State of a code scanning alert. Events for alerts found + outside the default branch will return a `null` value until they are + dismissed or fixed. + nullable: true + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + 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 + - sender webhook-commit-comment-created: title: commit_comment created event type: object @@ -107685,6 +115633,27 @@ components: required: - action - definition + webhook-custom-property-promoted-to-enterprise: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: + "$ref": "#/components/schemas/custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition webhook-custom-property-updated: title: custom property updated event type: object @@ -107770,6 +115739,31 @@ components: - pusher_type - repository - sender + webhook-dependabot-alert-assignees-changed: + title: Dependabot alert assignees changed event + type: object + properties: + action: + type: string + enum: + - assignees_changed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - alert + - repository + - sender webhook-dependabot-alert-auto-dismissed: title: Dependabot alert auto-dismissed event type: object @@ -108415,11 +116409,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -109114,12 +117103,21 @@ components: event: description: The event that triggered the deployment protection rule. type: string + sha: + description: The commit SHA that triggered the workflow. Always populated + from the check suite, regardless of whether a deployment is created. + type: string + ref: + description: The ref (branch or tag) that triggered the workflow. Always + populated from the check suite, regardless of whether a deployment is + created. + type: string deployment_callback_url: description: The URL to review the deployment protection rule. type: string format: uri deployment: - "$ref": "#/components/schemas/deployment" + "$ref": "#/components/schemas/nullable-deployment" pull_requests: type: array items: @@ -111692,490 +119690,480 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: - created_at: - type: string - 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 - required: - - login - - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - title: App - description: GitHub apps are a new way to extend GitHub. They can be - installed directly on organizations and user accounts and granted - access to specific repositories. They come with granular permissions - and built-in webhooks. GitHub apps are first class actors within GitHub. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - branch_protection_rule - - check_run - - check_suite - - code_scanning_alert - - commit_comment - - content_reference - - create - - delete - - deployment - - deployment_review - - deployment_status - - deploy_key - - discussion - - discussion_comment - - fork - - gollum - - issues - - issue_comment - - label - - member - - membership - - milestone - - organization - - org_block - - page_build - - project - - project_card - - project_column - - public - - pull_request - - pull_request_review - - pull_request_review_comment - - push - - registry_package - - release - - repository - - repository_dispatch - - secret_scanning_alert - - star - - status - - team - - team_add - - watch - - workflow_dispatch - - workflow_run - - pull_request_review_thread - - merge_queue_entry - - workflow_job - - merge_group - - secret_scanning_alert_location - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - 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 - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + 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 + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can be + installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within GitHub. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - pull_request_review_thread + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + 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 + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: type: string enum: - read @@ -113908,784 +121896,3120 @@ components: type: boolean downloads_url: type: string - events_url: + events_url: + type: string + fork: + type: boolean + enum: + - true + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_pages: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + homepage: + type: string + nullable: true + hooks_url: + type: string + html_url: + type: string + id: + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + language: + nullable: true + languages_url: + type: string + license: + type: object + nullable: true + merges_url: + type: string + milestones_url: + type: string + mirror_url: + nullable: true + name: + type: string + node_id: + type: string + notifications_url: + type: string + open_issues: + type: integer + open_issues_count: + type: integer + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + public: + type: boolean + pulls_url: + type: string + pushed_at: + type: string + releases_url: + type: string + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + svn_url: + type: string + tags_url: + type: string + teams_url: + type: string + topics: + type: array + items: + nullable: true + trees_url: + type: string + updated_at: + type: string + url: + type: string + visibility: + type: string + watchers: + type: integer + watchers_count: + type: integer + 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: + - forkee + - repository + - sender + webhook-github-app-authorization-revoked: + title: github_app_authorization revoked event + type: object + properties: + action: + type: string + enum: + - revoked + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - sender + webhook-gollum: + title: gollum event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pages: + description: The pages that were updated. + type: array + items: + type: object + properties: + action: + description: The action that was performed on the page. Can be `created` + or `edited`. + type: string + enum: + - created + - edited + html_url: + description: Points to the HTML wiki page. + type: string + format: uri + page_name: + description: The name of the page. + type: string + sha: + description: The latest commit SHA of the page. + type: string + summary: + type: string + nullable: true + title: + description: The current page title. + type: string + required: + - page_name + - title + - summary + - action + - sha + - html_url + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - pages + - repository + - sender + webhook-installation-created: + title: installation created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-deleted: + title: installation deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-new-permissions-accepted: + title: installation new_permissions_accepted event + type: object + properties: + action: + type: string + enum: + - new_permissions_accepted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-repositories-added: + title: installation_repositories added event + type: object + properties: + action: + type: string + enum: + - added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-repositories-removed: + title: installation_repositories removed event + type: object + properties: + action: + type: string + enum: + - removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-suspend: + title: installation suspend event + type: object + properties: + action: + type: string + enum: + - suspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-installation-target-renamed: + type: object + properties: + account: + type: object + properties: + archived_at: + type: string + nullable: true + avatar_url: + type: string + created_at: + type: string + description: + nullable: true + events_url: + type: string + followers: + type: integer + followers_url: + type: string + following: + type: integer + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + has_organization_projects: + type: boolean + has_repository_projects: + type: boolean + hooks_url: + type: string + html_url: + type: string + id: + type: integer + is_verified: + type: boolean + issues_url: + type: string + login: + type: string + members_url: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + public_gists: + type: integer + public_members_url: + type: string + public_repos: + type: integer + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + slug: + type: string + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + updated_at: + type: string + url: + type: string + website_url: + nullable: true + user_view_type: + type: string + required: + - id + - node_id + - avatar_url + - html_url + action: + type: string + enum: + - renamed + changes: + type: object + properties: + login: + type: object + properties: + from: + type: string + required: + - from + slug: + type: object + properties: + from: + type: string + required: + - from + 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" + target_type: + type: string + required: + - action + - target_type + - account + - changes + - installation + webhook-installation-unsuspend: + title: installation unsuspend event + type: object + properties: + action: + type: string + enum: + - unsuspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - installation + - sender + webhook-issue-comment-created: + title: issue_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + 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: + description: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + "$ref": "#/components/schemas/nullable-integration" + 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 + updated_at: + type: string + format: date-time + url: + description: URL for the issue comment + type: string + format: uri + pin: + "$ref": "#/components/schemas/nullable-pinned-issue-comment" + 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 + required: + - login + - id + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + - reminder + - pull_request_review_thread + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + 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 + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + 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 + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + type: + "$ref": "#/components/schemas/issue-type" + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: string + nullable: true + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + type: object + nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: object + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + 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 + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-deleted: + title: issue_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - null + assignee: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: + type: array + items: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + 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: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: App + description: GitHub apps are a new way to extend GitHub. They can + be installed directly on organizations and user accounts and granted + access to specific repositories. They come with granular permissions + and built-in webhooks. GitHub apps are first class actors within + GitHub. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - branch_protection_rule + - check_run + - check_suite + - code_scanning_alert + - commit_comment + - content_reference + - create + - delete + - deployment + - deployment_review + - deployment_status + - deploy_key + - discussion + - discussion_comment + - fork + - gollum + - issues + - issue_comment + - label + - member + - membership + - milestone + - organization + - org_block + - page_build + - project + - project_card + - project_column + - public + - pull_request + - pull_request_review + - pull_request_review_comment + - push + - registry_package + - release + - repository + - repository_dispatch + - secret_scanning_alert + - star + - status + - team + - team_add + - watch + - workflow_dispatch + - workflow_run + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + 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 + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + 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 + format: uri + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + state: + description: State of the issue; either 'open' or 'closed' type: string - fork: - type: boolean enum: - - true - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_pages: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - homepage: + - open + - closed + state_reason: type: string nullable: true - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: + timeline_url: type: string - keys_url: + format: uri + title: + description: Title of the issue type: string - labels_url: + type: + "$ref": "#/components/schemas/issue-type" + updated_at: type: string - language: - nullable: true - languages_url: + format: date-time + url: + description: URL for the issue type: string - license: + format: uri + user: + title: User type: object nullable: true - merges_url: - type: string - milestones_url: + 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 + - Mannequin + url: + type: string + format: uri + user_view_type: + type: string + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: type: string - mirror_url: nullable: true - name: - type: string - node_id: - type: string - notifications_url: - type: string - open_issues: - type: integer - open_issues_count: - type: integer - owner: + assignee: + 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 + - Mannequin url: type: string - private: - type: boolean - public: - type: boolean - pulls_url: - type: string - pushed_at: - type: string - releases_url: - type: string - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - svn_url: - type: string - tags_url: - type: string - teams_url: - type: string - topics: + format: uri + user_view_type: + type: string + required: + - login + - id + assignees: type: array items: + type: object nullable: true - trees_url: - type: string - updated_at: + author_association: type: string - url: + body: type: string - visibility: + nullable: true + closed_at: type: string - watchers: - type: integer - watchers_count: + nullable: true + comments: type: integer - 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: - - forkee - - repository - - sender - webhook-github-app-authorization-revoked: - title: github_app_authorization revoked event - type: object - properties: - action: - type: string - enum: - - revoked - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - sender - webhook-gollum: - title: gollum event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pages: - description: The pages that were updated. - type: array - items: - type: object - properties: - action: - description: The action that was performed on the page. Can be `created` - or `edited`. + comments_url: type: string - enum: - - created - - edited - html_url: - description: Points to the HTML wiki page. + created_at: type: string - format: uri - page_name: - description: The name of the page. + events_url: type: string - sha: - description: The latest commit SHA of the page. + html_url: type: string - summary: + id: + type: integer + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: type: string + locked: + type: boolean + milestone: + type: object nullable: true - title: - description: The current page title. - type: string - required: - - page_name - - title - - summary - - action - - sha - - html_url - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - pages - - repository - - sender - webhook-installation-created: - title: installation created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - "$ref": "#/components/schemas/webhooks_user" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-installation-deleted: - title: installation deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-installation-new-permissions-accepted: - title: installation new_permissions_accepted event - type: object - properties: - action: - type: string - enum: - - new_permissions_accepted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-installation-repositories-added: - title: installation_repositories added event - type: object - properties: - action: - type: string - enum: - - added - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - "$ref": "#/components/schemas/webhooks_repositories_added" - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: + node_id: type: string - id: - description: Unique identifier of the repository + number: type: integer - name: - description: The name of the repository. + performed_via_github_app: + type: object + nullable: true + 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 + repository_url: type: string - node_id: + state: + description: State of the issue; either 'open' or 'closed' type: string - private: - description: Whether the repository is private or public. - type: boolean - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - "$ref": "#/components/schemas/webhooks_repository_selection" - requester: - "$ref": "#/components/schemas/webhooks_user" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-repositories-removed: - title: installation_repositories removed event - type: object - properties: - action: - type: string - enum: - - removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - "$ref": "#/components/schemas/webhooks_repositories_added" - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: + enum: + - open + - closed + timeline_url: type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. + title: type: string - node_id: + updated_at: type: string - private: - description: Whether the repository is private or public. - type: boolean + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + format: int64 + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + user_view_type: + type: string required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - "$ref": "#/components/schemas/webhooks_repository_selection" - requester: - "$ref": "#/components/schemas/webhooks_user" - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-suspend: - title: installation suspend event - type: object - properties: - action: - type: string - enum: - - suspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" + - labels + - state + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" repository: "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true sender: "$ref": "#/components/schemas/simple-user" required: - action - - installation + - issue + - comment + - repository - sender - webhook-installation-target-renamed: + webhook-issue-comment-edited: + title: issue_comment edited event type: object properties: - account: - type: object - properties: - archived_at: - type: string - nullable: true - avatar_url: - type: string - created_at: - type: string - description: - nullable: true - events_url: - type: string - followers: - type: integer - followers_url: - type: string - following: - type: integer - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - has_organization_projects: - type: boolean - has_repository_projects: - type: boolean - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_verified: - type: boolean - issues_url: - type: string - login: - type: string - members_url: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - public_gists: - type: integer - public_members_url: - type: string - public_repos: - type: integer - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - slug: - type: string - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - updated_at: - type: string - url: - type: string - website_url: - nullable: true - user_view_type: - type: string - required: - - id - - node_id - - avatar_url - - html_url action: type: string enum: - - renamed + - edited changes: - type: object - properties: - login: - type: object - properties: - from: - type: string - required: - - from - slug: - type: object - properties: - from: - type: string - required: - - from - 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" - target_type: - type: string - required: - - action - - target_type - - account - - changes - - installation - webhook-installation-unsuspend: - title: installation unsuspend event - type: object - properties: - action: - type: string - enum: - - unsuspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - "$ref": "#/components/schemas/webhooks_repositories" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user" - required: - - action - - installation - - sender - webhook-issue-comment-created: - title: issue_comment created event - type: object - properties: - action: - type: string - enum: - - created + "$ref": "#/components/schemas/webhooks_changes" comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - 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: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - "$ref": "#/components/schemas/nullable-integration" - 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 - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - 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 - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -115362,7 +125686,6 @@ components: enum: - read - write - - admin secret_scanning_alerts: type: string enum: @@ -115393,11 +125716,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -115484,19 +125802,9 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -115512,6 +125820,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -115852,18 +126162,19 @@ components: "$ref": "#/components/schemas/simple-user" required: - action + - changes - issue - comment - repository - sender - webhook-issue-comment-deleted: - title: issue_comment deleted event + webhook-issue-comment-pinned: + title: issue_comment pinned event type: object properties: action: type: string enum: - - deleted + - pinned comment: "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: @@ -116660,19 +126971,9 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -116688,6 +126989,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -117034,16 +127337,14 @@ components: - comment - repository - sender - webhook-issue-comment-edited: - title: issue_comment edited event + webhook-issue-comment-unpinned: + title: issue_comment unpinned event type: object properties: action: type: string enum: - - edited - changes: - "$ref": "#/components/schemas/webhooks_changes" + - unpinned comment: "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: @@ -117500,8 +127801,6 @@ components: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: string nullable: true @@ -117681,7 +127980,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -117843,19 +128141,9 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" state: description: State of the issue; either 'open' or 'closed' type: string @@ -117871,6 +128159,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -118198,6 +128488,8 @@ components: type: string url: type: string + user_view_type: + type: string required: - labels - state @@ -118211,11 +128503,142 @@ components: "$ref": "#/components/schemas/simple-user" required: - action - - changes - issue - comment - repository - sender + webhook-issue-dependencies-blocked-by-added: + title: blocked by issue added event + type: object + properties: + action: + type: string + enum: + - blocked_by_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + 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 + - organization + - repository + - sender + webhook-issue-dependencies-blocked-by-removed: + title: blocked by issue removed event + type: object + properties: + action: + type: string + enum: + - blocked_by_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + blocking_issue_repo: + "$ref": "#/components/schemas/repository" + 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 + - organization + - repository + - sender + webhook-issue-dependencies-blocking-added: + title: blocking issue added event + type: object + properties: + action: + type: string + enum: + - blocking_added + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + 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 + - organization + - repository + - sender + webhook-issue-dependencies-blocking-removed: + title: blocking issue removed event + type: object + properties: + action: + type: string + enum: + - blocking_removed + blocked_issue_id: + description: The ID of the blocked issue. + type: number + blocked_issue: + "$ref": "#/components/schemas/issue" + blocked_issue_repo: + "$ref": "#/components/schemas/repository" + blocking_issue_id: + description: The ID of the blocking issue. + type: number + blocking_issue: + "$ref": "#/components/schemas/issue" + 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 + - organization + - repository + - sender webhook-issues-assigned: title: issues assigned event type: object @@ -118960,11 +129383,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -119050,20 +129468,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -119079,6 +129493,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -119487,6 +129903,8 @@ components: url: type: string format: uri + user_view_type: + type: string required: - login - id @@ -120028,11 +130446,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -120118,20 +130531,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -120147,6 +130556,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -120994,11 +131405,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -121074,20 +131480,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -121103,6 +131505,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -121923,11 +132327,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122013,20 +132412,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -122039,6 +132434,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string @@ -122864,11 +133261,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -122954,20 +133346,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -122980,6 +133368,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string @@ -123838,11 +134228,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -123918,20 +134303,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -123944,6 +134325,8 @@ components: timeline_url: type: string format: uri + type: + "$ref": "#/components/schemas/issue-type" title: description: Title of the issue type: string @@ -124771,11 +135154,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -124851,20 +135229,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -124880,6 +135254,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -125676,11 +136052,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -125767,19 +136138,13 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -125802,6 +136167,8 @@ components: description: URL for the issue type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" user: title: User type: object @@ -125872,28 +136239,11 @@ components: required: - login - id + type: + "$ref": "#/components/schemas/issue-type" required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - id - - node_id - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions old_repository: title: Repository description: A git repository @@ -126017,6 +136367,17 @@ components: has_discussions: description: Whether the repository has discussions enabled. type: boolean + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only has_downloads: description: Whether downloads are enabled. type: boolean @@ -127060,11 +137421,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -127151,19 +137507,13 @@ components: type: string format: uri sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -127179,6 +137529,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -127186,6 +137538,8 @@ components: description: URL for the issue type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" user: title: User type: object @@ -128054,11 +138408,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -128134,20 +138483,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -128241,6 +138586,8 @@ components: format: uri user_view_type: type: string + type: + "$ref": "#/components/schemas/issue-type" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -128956,11 +139303,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -129046,20 +139388,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -129075,6 +139413,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -129316,6 +139656,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -129660,6 +140011,34 @@ components: - issue - repository - sender + webhook-issues-typed: + title: issues typed event + type: object + properties: + action: + type: string + enum: + - typed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + type: + "$ref": "#/components/schemas/issue-type" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - type + - repository + - sender webhook-issues-unassigned: title: issues unassigned event type: object @@ -130455,11 +140834,6 @@ components: enum: - read - write - team_discussions: - type: string - enum: - - read - - write vulnerability_alerts: type: string enum: @@ -130535,20 +140909,16 @@ components: repository_url: type: string format: uri + pinned_comment: + "$ref": "#/components/schemas/nullable-issue-comment" sub_issues_summary: - title: Sub-issues Summary - type: object - properties: - total: - type: integer - completed: - type: integer - percent_completed: - type: integer - required: - - total - - completed - - percent_completed + "$ref": "#/components/schemas/sub-issues-summary" + issue_dependencies_summary: + "$ref": "#/components/schemas/issue-dependencies-summary" + issue_field_values: + type: array + items: + "$ref": "#/components/schemas/issue-field-value" state: description: State of the issue; either 'open' or 'closed' type: string @@ -130564,6 +140934,8 @@ components: title: description: Title of the issue type: string + type: + "$ref": "#/components/schemas/issue-type" updated_at: type: string format: date-time @@ -130677,6 +141049,34 @@ components: - issue - repository - sender + webhook-issues-untyped: + title: issues untyped event + type: object + properties: + action: + type: string + enum: + - untyped + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + type: + "$ref": "#/components/schemas/issue-type" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - issue + - type + - repository + - sender webhook-label-created: title: label created event type: object @@ -131553,7 +141953,7 @@ components: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" hook: - description: 'The modified webhook. This will contain different keys based + description: 'The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace.' type: object @@ -131582,6 +141982,7 @@ components: created_at: type: string events: + description: '' type: array items: type: string @@ -135222,6 +145623,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -135848,6 +146260,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -137502,6 +147925,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only has_pages: type: boolean has_projects: @@ -138136,6 +148570,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -139801,6 +150246,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -140425,6 +150881,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -142172,6 +152639,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -142796,6 +153274,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -144535,6 +155024,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -145159,6 +155659,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -146816,6 +157327,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -147442,6 +157964,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -149107,6 +159640,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -149733,6 +160277,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -151787,6 +162342,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -152401,6 +162967,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -153967,6 +164544,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -154581,6 +165169,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -156141,6 +166740,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -156755,6 +167365,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -158314,6 +168935,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -158928,6 +169560,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -160055,6 +170698,10 @@ components: submitted_at: type: string format: date-time + updated_at: + type: string + format: date-time + nullable: true user: title: User type: object @@ -162735,6 +173382,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -163350,6 +174008,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -165091,6 +175760,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -165715,6 +176395,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -167500,6 +178191,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -168124,6 +178826,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -169861,6 +180574,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -170485,6 +181209,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -172237,6 +182972,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -172852,6 +183598,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -174422,6 +185179,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -174987,6 +185755,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -176294,6 +187073,10 @@ components: required: - node_id - comments + updated_at: + type: string + nullable: true + format: date-time required: - action - thread @@ -176798,6 +187581,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -177361,6 +188155,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -178655,6 +189460,10 @@ components: required: - node_id - comments + updated_at: + type: string + nullable: true + format: date-time required: - action - thread @@ -179170,6 +189979,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -179794,6 +190614,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -181455,6 +192286,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -182081,6 +192923,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -183748,6 +194601,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -184374,6 +195238,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -186027,6 +196902,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -186652,6 +197538,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: + all or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -188183,6 +199080,17 @@ components: description: Whether discussions are enabled. type: boolean default: false + has_pull_requests: + description: Whether pull requests are enabled. + type: boolean + default: true + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all + or collaborators_only.' + type: string + enum: + - all + - collaborators_only homepage: type: string nullable: true @@ -189499,6 +200407,15 @@ components: type: string required: - from + tag_name: + type: object + properties: + from: + description: The previous version of the tag_name if the action + was `edited`. + type: string + required: + - from make_latest: type: object properties: @@ -189553,6 +200470,7 @@ components: - draft - html_url - id + - immutable - name - node_id - prerelease @@ -189560,6 +200478,7 @@ components: - tag_name - tarball_url - target_commitish + - updated_at - upload_url - url - zipball_url @@ -189578,6 +200497,7 @@ components: - name - label - state + - digest - content_type - size - download_count @@ -189607,6 +200527,9 @@ components: type: string size: type: integer + digest: + type: string + nullable: true state: description: State of the release asset. type: string @@ -189775,6 +200698,9 @@ components: format: uri id: type: integer + immutable: + description: Whether or not the release is immutable. + type: boolean name: type: string nullable: true @@ -189840,6 +200766,10 @@ components: upload_url: type: string format: uri-template + updated_at: + type: string + nullable: true + format: date-time url: type: string format: uri @@ -190933,6 +201863,32 @@ components: - alert - repository - sender + webhook-secret-scanning-alert-assigned: + title: secret_scanning_alert assigned event + type: object + properties: + action: + type: string + enum: + - assigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + 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-created: title: secret_scanning_alert created event type: object @@ -191064,6 +202020,32 @@ components: - action - alert - repository + webhook-secret-scanning-alert-unassigned: + title: secret_scanning_alert unassigned event + type: object + properties: + action: + type: string + enum: + - unassigned + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + assignee: + "$ref": "#/components/schemas/simple-user" + 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-validated: title: secret_scanning_alert validated event type: object @@ -191811,6 +202793,7 @@ components: - reason - signature - payload + - verified_at required: - author - committer @@ -198254,63 +209237,761 @@ components: format: uri user_view_type: type: string - required: - - login - - id + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + format: uri + display_title: + type: string + required: + - artifacts_url + - cancel_url + - check_suite_url + - check_suite_id + - check_suite_node_id + - conclusion + - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha + - html_url + - id + - jobs_url + - logs_url + - node_id + - name + - path + - pull_requests + - repository + - rerun_url + - run_number + - status + - updated_at + - url + - workflow_id + - workflow_url + - run_attempt + - run_started_at + - previous_attempt_url + - actor + - triggering_actor + - display_title + required: + - action + - repository + - sender + - workflow + - workflow_run + create-event: + title: CreateEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + master_branch: + type: string + description: + type: string + nullable: true + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - master_branch + - pusher_type + delete-event: + title: DeleteEvent + type: object + properties: + ref: + type: string + ref_type: + type: string + full_ref: + type: string + pusher_type: + type: string + required: + - ref + - ref_type + - full_ref + - pusher_type + discussion-event: + title: DiscussionEvent + type: object + properties: + action: + type: string + discussion: + "$ref": "#/components/schemas/discussion" + required: + - action + - discussion + issues-event: + title: IssuesEvent + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + assignee: + "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + label: + "$ref": "#/components/schemas/label" + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - action + - issue + issue-comment-event: + title: IssueCommentEvent + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + required: + - action + - issue + - comment + fork-event: + title: ForkEvent + type: object + properties: + action: + type: string + forkee: + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + full_name: + type: string + private: + type: boolean + owner: + "$ref": "#/components/schemas/simple-user" + html_url: + type: string + description: + type: string + nullable: true + fork: + type: boolean + url: + type: string + forks_url: + type: string + keys_url: + type: string + collaborators_url: + type: string + teams_url: + type: string + hooks_url: + type: string + issue_events_url: + type: string + events_url: + type: string + assignees_url: + type: string + branches_url: + type: string + tags_url: + type: string + blobs_url: + type: string + git_tags_url: + type: string + git_refs_url: + type: string + trees_url: + type: string + statuses_url: + type: string + languages_url: + type: string + stargazers_url: + type: string + contributors_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + commits_url: + type: string + git_commits_url: + type: string + comments_url: + type: string + issue_comment_url: + type: string + contents_url: + type: string + compare_url: + type: string + merges_url: + type: string + archive_url: + type: string + downloads_url: + type: string + issues_url: + type: string + pulls_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + labels_url: + type: string + releases_url: + type: string + deployments_url: + type: string + created_at: + type: string + format: date-time + nullable: true + updated_at: + type: string + format: date-time + nullable: true + pushed_at: + type: string + format: date-time + nullable: true + git_url: + type: string + ssh_url: + type: string + clone_url: + type: string + svn_url: + type: string + homepage: + type: string + nullable: true + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: string + nullable: true + has_issues: + type: boolean + has_projects: + type: boolean + has_downloads: + type: boolean + has_wiki: + type: boolean + has_pages: + type: boolean + has_discussions: + type: boolean + has_pull_requests: + type: boolean + pull_request_creation_policy: + description: 'The policy controlling who can create pull requests: all + or collaborators_only.' + type: string + enum: + - all + - collaborators_only + forks_count: + type: integer + mirror_url: + type: string + nullable: true + archived: + type: boolean + disabled: + type: boolean + open_issues_count: + type: integer + license: + "$ref": "#/components/schemas/nullable-license-simple" + allow_forking: + type: boolean + is_template: + type: boolean + web_commit_signoff_required: + type: boolean + topics: + type: array + items: + type: string + visibility: + type: string + forks: + type: integer + open_issues: + type: integer + watchers: + type: integer + default_branch: + type: string + public: + type: boolean + required: + - action + - forkee + gollum-event: + title: GollumEvent + type: object + properties: + pages: + type: array + items: + type: object + properties: + page_name: + type: string + nullable: true + title: + type: string + nullable: true + summary: + type: string + nullable: true + action: + type: string + sha: + type: string + html_url: + type: string + required: + - pages + member-event: + title: MemberEvent + type: object + properties: + action: + type: string + member: + "$ref": "#/components/schemas/simple-user" + required: + - action + - member + public-event: + title: PublicEvent + type: object + push-event: + title: PushEvent + type: object + properties: + repository_id: + type: integer + push_id: + type: integer + ref: + type: string + head: + type: string + before: + type: string + required: + - repository_id + - push_id + - ref + - head + - before + pull-request-event: + title: PullRequestEvent + type: object + properties: + action: + type: string + number: + type: integer + pull_request: + "$ref": "#/components/schemas/pull-request-minimal" + assignee: + "$ref": "#/components/schemas/simple-user" + assignees: + type: array + items: + "$ref": "#/components/schemas/simple-user" + label: + "$ref": "#/components/schemas/label" + labels: + type: array + items: + "$ref": "#/components/schemas/label" + required: + - action + - number + - pull_request + pull-request-review-comment-event: + title: PullRequestReviewCommentEvent + type: object + properties: + action: + type: string + pull_request: + "$ref": "#/components/schemas/pull-request-minimal" + comment: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + format: uri + pull_request_review_id: + type: integer + nullable: true + diff_hunk: + type: string + path: + type: string + position: + type: integer + nullable: true + original_position: + type: integer + subject_type: + type: string + nullable: true + commit_id: + 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 + body: + type: string + created_at: + type: string + format: date-time updated_at: type: string format: date-time - url: + html_url: type: string format: uri - workflow_id: - type: integer - workflow_url: + pull_request_url: type: string format: uri - display_title: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + original_commit_id: type: string + 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 + in_reply_to_id: + type: integer required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url + - url + - pull_request_review_id - id - - jobs_url - - logs_url - node_id - - name + - diff_hunk - path - - pull_requests - - repository - - rerun_url - - run_number - - status + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - display_title + - html_url + - pull_request_url + - _links + - reactions + required: + - action + - comment + - pull_request + pull-request-review-event: + title: PullRequestReviewEvent + type: object + properties: + action: + type: string + review: + type: object + properties: + id: + type: integer + node_id: + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + body: + type: string + commit_id: + type: string + submitted_at: + type: string + nullable: true + state: + type: string + html_url: + type: string + format: uri + pull_request_url: + type: string + format: uri + _links: + type: object + properties: + html: + type: object + properties: + href: + type: string + required: + - href + pull_request: + type: object + properties: + href: + type: string + required: + - href + required: + - html + - pull_request + updated_at: + type: string + pull_request: + "$ref": "#/components/schemas/pull-request-minimal" + required: + - action + - review + - pull_request + commit-comment-event: + title: CommitCommentEvent + type: object + properties: + action: + type: string + comment: + type: object + properties: + html_url: + type: string + format: uri + url: + type: string + format: uri + id: + type: integer + node_id: + type: string + body: + type: string + path: + type: string + nullable: true + position: + type: integer + nullable: true + line: + type: integer + nullable: true + commit_id: + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - action + - comment + release-event: + title: ReleaseEvent + type: object + properties: + action: + type: string + release: + allOf: + - "$ref": "#/components/schemas/release" + - type: object + properties: + is_short_description_html_truncated: + type: boolean + short_description_html: + type: string + required: + - action + - release + watch-event: + title: WatchEvent + type: object + properties: + action: + type: string required: - action - - repository - - sender - - workflow - - workflow_run examples: root: value: @@ -199617,6 +211298,7 @@ components: cookie: https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8 cool: https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8 cop: https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8 + copilot: https://github.githubassets.com/images/icons/emoji/copilot.png?v8 copyright: https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8 corn: https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8 costa_rica: https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8 @@ -201104,6 +212786,12 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 + actions-cache-retention-limit: + value: + max_cache_retention_days: 80 + actions-cache-storage-limit: + value: + max_cache_size_gb: 150 enterprise-code-security-configuration-list: value: - id: 17 @@ -201172,11 +212860,14 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/enterprises/octo-enterprise/code-security/configurations/1325 @@ -201202,6 +212893,8 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_delegated_bypass: enabled @@ -201236,6 +212929,8 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_delegated_bypass: disabled @@ -201263,11 +212958,16 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -201444,6 +213144,25 @@ components: dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: + assignees: + - 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 repository: id: 217723378 node_id: MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg= @@ -201591,6 +213310,7 @@ components: dismissed_reason: dismissed_comment: fixed_at: + assignees: [] repository: id: 664700648 node_id: MDEwOlJlcG9zaXRvcnk2NjQ3MDA2NDg= @@ -201656,238 +213376,98 @@ components: tags_url: https://api.github.com/repos/octo-org/hello-world/tags teams_url: https://api.github.com/repos/octo-org/hello-world/teams trees_url: https://api.github.com/repos/octo-org/hello-world/git/trees{/sha} - organization-secret-scanning-alert-list: + enterprise-teams-items: value: - - number: 2 - created_at: '2020-11-06T18:48:51Z' - url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 - html_url: https://github.com/owner/private-repo/security/secret-scanning/2 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations - state: resolved - resolution: false_positive - resolved_at: '2020-11-07T02:47:13Z' - resolved_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - secret_type: adafruit_io_key - secret_type_display_name: Adafruit IO Key - secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX - 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} - 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} - 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} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - login: monalisa - id: 2 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/2? - gravatar_id: '' - url: https://api.github.com/users/monalisa - html_url: https://github.com/monalisa - followers_url: https://api.github.com/users/monalisa/followers - following_url: https://api.github.com/users/monalisa/following{/other_user} - gists_url: https://api.github.com/users/monalisa/gists{/gist_id} - starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/monalisa/subscriptions - organizations_url: https://api.github.com/users/monalisa/orgs - repos_url: https://api.github.com/users/monalisa/repos - events_url: https://api.github.com/users/monalisa/events{/privacy} - received_events_url: https://api.github.com/users/monalisa/received_events - type: User - site_admin: true - push_protection_bypassed: true - push_protection_bypassed_at: '2020-11-06T21:48:51Z' - push_protection_bypass_request_reviewer: - login: octocat - id: 3 - node_id: MDQ6VXNlcjI= - avatar_url: https://alambic.github.com/avatars/u/3? - 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: true - push_protection_bypass_request_reviewer_comment: Example response - push_protection_bypass_request_comment: Example comment - push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 - 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 - html_url: https://github.com/owner/repo/security/secret-scanning/1 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations - state: open - resolution: - resolved_at: - resolved_by: - secret_type: mailchimp_api_key - secret_type_display_name: Mailchimp API Key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - 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} - 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} - 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} - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - push_protection_bypassed_by: - push_protection_bypassed: false - push_protection_bypassed_at: - push_protection_bypass_request_reviewer: - push_protection_bypass_request_reviewer_comment: - push_protection_bypass_request_comment: - push_protection_bypass_request_html_url: - resolution_comment: - validity: unknown - publicly_leaked: false - multi_repo: false + - id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + enterprise-teams-item: + value: + id: 1 + name: Justice League + description: A great team. + slug: justice-league + url: https://api.github.com/enterprises/dc/teams/justice-league + group_id: 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: https://github.com/enterprises/dc/teams/justice-league + members_url: https://api.github.com/enterprises/dc/teams/justice-league/members{/member} + created_at: '2019-01-26T19:01:12Z' + updated_at: '2019-01-26T19:14:43Z' + simple-user-items: + value: + - 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 + simple-user: + value: + 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 + organization-simple: + value: + login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + organization-simple-items: + value: + - login: github + id: 1 + node_id: MDEyOk9yZ2FuaXphdGlvbjE= + url: https://api.github.com/orgs/github + repos_url: https://api.github.com/orgs/github/repos + events_url: https://api.github.com/orgs/github/events + hooks_url: https://api.github.com/orgs/github/hooks + issues_url: https://api.github.com/orgs/github/issues + members_url: https://api.github.com/orgs/github/members{/member} + public_members_url: https://api.github.com/orgs/github/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization public-events-items: value: - id: '22249084947' @@ -201921,20 +213501,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-07T07:50:26Z' feed: @@ -202575,6 +214146,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -202767,7 +214339,6 @@ components: push: false pull: true allow_rebase_merge: true - template_repository: temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false @@ -203051,20 +214622,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22237752260' @@ -203074,7 +214636,7 @@ components: login: octocat display_login: octocat gravatar_id: '' - url: https://api.github.com/users/rrubenich + url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 @@ -203281,20 +214843,165 @@ components: ~~~~~~==~==~~~==~==~~~~~~ ~~~~~~==~==~==~==~~~~~~ :~==~==~==~==~~ - organization-simple-items: + dependabot-repository-access-details: value: - - login: github - id: 1 - node_id: MDEyOk9yZ2FuaXphdGlvbjE= - url: https://api.github.com/orgs/github - repos_url: https://api.github.com/orgs/github/repos - events_url: https://api.github.com/orgs/github/events - hooks_url: https://api.github.com/orgs/github/hooks - issues_url: https://api.github.com/orgs/github/issues - members_url: https://api.github.com/orgs/github/members{/member} - public_members_url: https://api.github.com/orgs/github/public_members{/member} - avatar_url: https://github.com/images/error/octocat_happy.gif - description: A great organization + default_level: public + accessible_repositories: + - id: 123456 + node_id: MDEwOlJlcG9zaXRvcnkxMjM0NTY= + name: example-repo + full_name: octocat/example-repo + owner: + name: octocat + email: octo@github.com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://avatars.githubusercontent.com/u/1?v=4 + gravatar_id: 1 + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat/example-repo + 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 + starred_at: '"2020-07-09T00:17:55Z"' + user_view_type: default + private: false + html_url: https://github.com/octocat/example-repo + description: This is an example repository. + fork: false + url: https://api.github.com/repos/octocat/example-repo + archive_url: https://api.github.com/repos/octocat/example-repo/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/example-repo/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/example-repo/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/example-repo/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/example-repo/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/example-repo/comments{/number} + commits_url: https://api.github.com/repos/octocat/example-repo/commits{/sha} + compare_url: https://api.github.com/repos/octocat/example-repo/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/example-repo/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/example-repo/contributors + deployments_url: https://api.github.com/repos/octocat/example-repo/deployments + downloads_url: https://api.github.com/repos/octocat/example-repo/downloads + events_url: https://api.github.com/repos/octocat/example-repo/events + forks_url: https://api.github.com/repos/octocat/example-repo/forks + git_commits_url: https://api.github.com/repos/octocat/example-repo/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/example-repo/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/example-repo/git/tags{/sha} + issue_comment_url: https://api.github.com/repos/octocat/example-repo/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/example-repo/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/example-repo/issues{/number} + keys_url: https://api.github.com/repos/octocat/example-repo/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/example-repo/labels{/name} + languages_url: https://api.github.com/repos/octocat/example-repo/languages + merges_url: https://api.github.com/repos/octocat/example-repo/merges + milestones_url: https://api.github.com/repos/octocat/example-repo/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/example-repo/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/example-repo/pulls{/number} + releases_url: https://api.github.com/repos/octocat/example-repo/releases{/id} + stargazers_url: https://api.github.com/repos/octocat/example-repo/stargazers + statuses_url: https://api.github.com/repos/octocat/example-repo/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/example-repo/subscribers + subscription_url: https://api.github.com/repos/octocat/example-repo/subscription + tags_url: https://api.github.com/repos/octocat/example-repo/tags + teams_url: https://api.github.com/repos/octocat/example-repo/teams + trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha} + hooks_url: https://api.github.com/repos/octocat/example-repo/hooks + get_all_budgets: + value: + budgets: + - id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_skus: + - actions + budget_scope: enterprise + budget_amount: 1000.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - enterprise-admin + - billing-manager + - id: f47ac10b-58cc-4372-a567-0e02b2c3d479 + budget_type: SkuPricing + budget_product_skus: + - actions_linux + budget_scope: organization + budget_amount: 500.0 + prevent_further_usage: false + budget_alerting: + will_alert: true + alert_recipients: + - org-owner + - id: 6ba7b810-9dad-11d1-80b4-00c04fd430c8 + budget_type: ProductPricing + budget_product_skus: + - packages + budget_scope: cost_center + budget_amount: 250.0 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] + get-budget: + value: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + update-budget: + value: + message: Budget successfully updated. + budget: + id: 2066deda-923f-43f9-88d2-62395a28c0cdd + budget_type: ProductPricing + budget_product_sku: actions_linux + budget_scope: repository + budget_entity_name: org-name/example-repo-name + budget_amount: 0.0 + prevent_further_usage: true + budget_alerting: + will_alert: true + alert_recipients: + - mona + - lisa + delete-budget: + value: + message: Budget successfully deleted. + budget_id: 2c1feb79-3947-4dc8-a16e-80cbd732cc0b + billing-premium-request-usage-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 100 + netAmount: 4.0 billing-usage-report: value: usageItems: @@ -203309,6 +215016,22 @@ components: netAmount: 0.8 organizationName: GitHub repositoryName: github/example + billing-usage-summary-report-org: + value: + timePeriod: + year: 2025 + organization: GitHub + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 1000 + netAmount: 8.0 organization-full: value: login: github @@ -203352,6 +215075,7 @@ components: filled_seats: 4 seats: 5 default_repository_permission: read + default_repository_branch: main members_can_create_repositories: true two_factor_requirement_enabled: true members_allowed_repository_creation_type: all @@ -203361,6 +215085,14 @@ components: members_can_create_pages: true members_can_create_public_pages: true members_can_create_private_pages: true + members_can_delete_repositories: true + members_can_change_repo_visibility: true + members_can_invite_outside_collaborators: true + members_can_delete_issues: false + display_commenter_full_name_setting_enabled: false + readers_can_create_discussions: true + members_can_create_teams: true + members_can_view_dependency_insights: true members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' @@ -203450,7 +215182,35 @@ components: prefix: 20.80.208.150 length: 31 last_active_on: '2022-10-09T23:39:01Z' - actions-hosted-runner-image: + actions-hosted-runner-custom-image-versions: + value: + total_count: 2 + image_versions: + - version: 1.1.0 + size_gb: 75 + state: Ready + created_on: '2024-11-09T23:39:01Z' + - version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-custom-image: + value: + id: 1 + platform: linux-x64 + name: CustomImage + source: custom + versions_count: 4 + total_versions_size: 200 + latest_version: 1.3.0 + state: Ready + actions-hosted-runner-custom-image-version: + value: + version: 1.0.0 + size_gb: 75 + state: Ready + created_on: '2024-11-08T20:39:01Z' + actions-hosted-runner-curated-image: value: id: ubuntu-20.04 platform: linux-x64 @@ -203478,6 +215238,16 @@ components: enabled_repositories: all allowed_actions: selected selected_actions_url: https://api.github.com/organizations/42/actions/permissions/selected-actions + sha_pinning_required: true + actions-fork-pr-contributor-approval: + value: + approval_policy: first_time_contributors + actions-fork-pr-workflows-private-repos: + value: + run_workflows_from_fork_pull_requests: true + send_write_tokens_to_workflows: false + send_secrets_and_variables: false + require_approval_for_fork_pr_workflows: true repository-paginated: value: total_count: 1 @@ -203923,6 +215693,7 @@ components: os: linux status: online busy: true + ephemeral: false labels: - id: 5 name: self-hosted @@ -203938,6 +215709,7 @@ components: os: macos status: offline busy: false + ephemeral: false labels: - id: 5 name: self-hosted @@ -204010,6 +215782,7 @@ components: os: macos status: online busy: true + ephemeral: false labels: - id: 5 name: self-hosted @@ -204178,6 +215951,130 @@ components: updated_at: '2020-01-10T14:59:22Z' visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories + artifact-deployment-record-list: + value: + total_count: 1 + deployment_records: + - id: 123 + digest: sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72 + logical_environment: prod + physical_environment: pacific-east + cluster: moda-1 + deployment_name: prod-deployment + tags: + data: sensitive + created: '2011-01-26T19:14:43Z' + updated_at: '2011-01-26T19:14:43Z' + attestation_id: 456 + bulk-subject-digest-body: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + bulk-subject-digest-body-with-predicate-type: + value: + subject_digests: + - sha256:abc123 + - sha512:def456 + predicateType: provenance + list-attestations-bulk: + value: + attestations_subject_digests: + - sha256:abc: + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + - bundle: + mediaType: application/vnd.dev.sigstore.bundle.v0.3+json + verificationMaterial: + tlogEntries: + - logIndex: '97913980' + logId: + keyId: wNI9atQGlz+VWfO6LRygH4QUfY/8W4RFwiT5i5WRgB0= + kindVersion: + kind: dsse + version: 0.0.1 + integratedTime: '1716998992' + inclusionPromise: + signedEntryTimestamp: MEYCIQCeEsQAy+qXtULkh52wbnHrkt2R2JQ05P9STK/xmdpQ2AIhANiG5Gw6cQiMnwvUz1+9UKtG/vlC8dduq07wsFOViwSL + inclusionProof: + logIndex: '93750549' + rootHash: KgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60= + treeSize: '93750551' + hashes: + - 8LI21mzwxnUSo0fuZeFsUrz2ujZ4QAL+oGeTG+5toZg= + - nCb369rcIytNhGwWoqBv+eV49X3ZKpo/HJGKm9V+dck= + - hnNQ9mUdSwYCfdV21pd87NucrdRRNZATowlaRR1hJ4A= + - MBhhK33vlD4Tq/JKgAaXUI4VjmosWKe6+7RNpQ2ncNM= + - XKWUE3stvGV1OHsIGiCGfn047Ok6uD4mFkh7BaicaEc= + - Tgve40VPFfuei+0nhupdGpfPPR+hPpZjxgTiDT8WNoY= + - wV+S/7tLtYGzkLaSb6UDqexNyhMvumHK/RpTNvEZuLU= + - uwaWufty6sn6XqO1Tb9M3Vz6sBKPu0HT36mStxJNd7s= + - jUfeMOXQP0XF1JAnCEETVbfRKMUwCzrVUzYi8vnDMVs= + - xQKjzJAwwdlQG/YUYBKPXxbCmhMYKo1wnv+6vDuKWhQ= + - cX3Agx+hP66t1ZLbX/yHbfjU46/3m/VAmWyG/fhxAVc= + - sjohk/3DQIfXTgf/5XpwtdF7yNbrf8YykOMHr1CyBYQ= + - 98enzMaC+x5oCMvIZQA5z8vu2apDMCFvE/935NfuPw8= + checkpoint: + envelope: rekor.sigstore.dev - 2605736670972794746\n93750551\nKgKiXoOl8rM5d4y6Xlbm2QLftvj/FYvTs6z7dJlNO60=\n\n— + rekor.sigstore.dev wNI9ajBEAiBkLzdjY8A9HReU7rmtjwZ+JpSuYtEr9SmvSwUIW7FBjgIgKo+vhkW3tqc+gc8fw9gza3xLoncA8a+MTaJYCaLGA9c=\n + canonicalizedBody: eyJhcGlWZXJzaW9uIjoiMC4wLjEiLCJraW5kIjoiZHNzZSIsInNwZWMiOnsiZW52ZWxvcGVIYXNoIjp7ImFsZ29yaXRobSI6InNoYTI1NiIsInZhbHVlIjoiM2I1YzkwNDk5MGFiYzE4NjI1ZWE3Njg4MzE1OGEwZmI4MTEwMjM4MGJkNjQwZjI5OWJlMzYwZWVkOTMxNjYwYiJ9LCJwYXlsb2FkSGFzaCI6eyJhbGdvcml0aG0iOiJzaGEyNTYiLCJ2YWx1ZSI6IjM4ZGNlZDJjMzE1MGU2OTQxMDViYjZiNDNjYjY3NzBiZTYzZDdhNGM4NjNiMTc2YTkwMmU1MGQ5ZTAyN2ZiMjMifSwic2lnbmF0dXJlcyI6W3sic2lnbmF0dXJlIjoiTUVRQ0lFR0lHQW03Z1pWTExwc3JQY2puZEVqaXVjdEUyL2M5K2o5S0d2YXp6M3JsQWlBZDZPMTZUNWhrelJNM0liUlB6bSt4VDQwbU5RWnhlZmQ3bGFEUDZ4MlhMUT09IiwidmVyaWZpZXIiOiJMUzB0TFMxQ1JVZEpUaUJEUlZKVVNVWkpRMEZVUlMwdExTMHRDazFKU1VkcVZFTkRRbWhUWjBGM1NVSkJaMGxWVjFsNGNVdHpjazFUTTFOMmJEVkphalZQUkdaQ1owMUtUeTlKZDBObldVbExiMXBKZW1vd1JVRjNUWGNLVG5wRlZrMUNUVWRCTVZWRlEyaE5UV015Ykc1ak0xSjJZMjFWZFZwSFZqSk5ValIzU0VGWlJGWlJVVVJGZUZaNllWZGtlbVJIT1hsYVV6RndZbTVTYkFwamJURnNXa2RzYUdSSFZYZElhR05PVFdwUmQwNVVTVFZOVkZsM1QxUlZlVmRvWTA1TmFsRjNUbFJKTlUxVVdYaFBWRlY1VjJwQlFVMUdhM2RGZDFsSUNrdHZXa2w2YWpCRFFWRlpTVXR2V2tsNmFqQkVRVkZqUkZGblFVVmtiV2RvVGs1M00yNVZMMHQxWlZGbmMzQkhTRmMzWjJnNVdFeEVMMWRrU1RoWlRVSUtLekJ3TUZZMGJ6RnJTRzgyWTAweGMwUktaM0pEWjFCUlZYcDRjSFZaZFc4cmVIZFFTSGxzTDJ0RWVXWXpSVXhxYTJGUFEwSlVUWGRuWjFWMlRVRTBSd3BCTVZWa1JIZEZRaTkzVVVWQmQwbElaMFJCVkVKblRsWklVMVZGUkVSQlMwSm5aM0pDWjBWR1FsRmpSRUY2UVdSQ1owNVdTRkUwUlVablVWVnhaa05RQ25aWVMwRjJVelJEWkdoUk1taGlXbGRLVTA5RmRsWnZkMGgzV1VSV1VqQnFRa0puZDBadlFWVXpPVkJ3ZWpGWmEwVmFZalZ4VG1wd1MwWlhhWGhwTkZrS1drUTRkMWRuV1VSV1VqQlNRVkZJTDBKR1FYZFViMXBOWVVoU01HTklUVFpNZVRsdVlWaFNiMlJYU1hWWk1qbDBUREpPYzJGVE9XcGlSMnQyVEcxa2NBcGtSMmd4V1drNU0ySXpTbkphYlhoMlpETk5kbHBIVm5kaVJ6azFZbGRXZFdSRE5UVmlWM2hCWTIxV2JXTjVPVzlhVjBaclkzazVNR051Vm5WaGVrRTFDa0puYjNKQ1owVkZRVmxQTDAxQlJVSkNRM1J2WkVoU2QyTjZiM1pNTTFKMllUSldkVXh0Um1wa1IyeDJZbTVOZFZveWJEQmhTRlpwWkZoT2JHTnRUbllLWW01U2JHSnVVWFZaTWpsMFRVSTRSME5wYzBkQlVWRkNaemM0ZDBGUlNVVkZXR1IyWTIxMGJXSkhPVE5ZTWxKd1l6TkNhR1JIVG05TlJGbEhRMmx6UndwQlVWRkNaemM0ZDBGUlRVVkxSMXBvV2xkWmVWcEhVbXRQUkVacFRVUmplazVxWXpCUFJGRjRUVEpGTTFsNldUQk9iVTVyVFVkS2JWbDZTVEpaZWtGM0NsbFVRWGRIUVZsTFMzZFpRa0pCUjBSMmVrRkNRa0ZSUzFKSFZuZGlSemsxWWxkV2RXUkVRVlpDWjI5eVFtZEZSVUZaVHk5TlFVVkdRa0ZrYW1KSGEzWUtXVEo0Y0UxQ05FZERhWE5IUVZGUlFtYzNPSGRCVVZsRlJVaEtiRnB1VFhaaFIxWm9Xa2hOZG1SSVNqRmliWE4zVDNkWlMwdDNXVUpDUVVkRWRucEJRZ3BEUVZGMFJFTjBiMlJJVW5kamVtOTJURE5TZG1FeVZuVk1iVVpxWkVkc2RtSnVUWFZhTW13d1lVaFdhV1JZVG14amJVNTJZbTVTYkdKdVVYVlpNamwwQ2sxR2QwZERhWE5IUVZGUlFtYzNPSGRCVVd0RlZHZDRUV0ZJVWpCalNFMDJUSGs1Ym1GWVVtOWtWMGwxV1RJNWRFd3lUbk5oVXpscVlrZHJka3h0WkhBS1pFZG9NVmxwT1ROaU0wcHlXbTE0ZG1RelRYWmFSMVozWWtjNU5XSlhWblZrUXpVMVlsZDRRV050Vm0xamVUbHZXbGRHYTJONU9UQmpibFoxWVhwQk5BcENaMjl5UW1kRlJVRlpUeTlOUVVWTFFrTnZUVXRIV21oYVYxbDVXa2RTYTA5RVJtbE5SR042VG1wak1FOUVVWGhOTWtVeldYcFpNRTV0VG10TlIwcHRDbGw2U1RKWmVrRjNXVlJCZDBoUldVdExkMWxDUWtGSFJIWjZRVUpEZDFGUVJFRXhibUZZVW05a1YwbDBZVWM1ZW1SSFZtdE5RMjlIUTJselIwRlJVVUlLWnpjNGQwRlJkMFZJUVhkaFlVaFNNR05JVFRaTWVUbHVZVmhTYjJSWFNYVlpNamwwVERKT2MyRlRPV3BpUjJ0M1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWdwRVVWRnhSRU5vYlZsWFZtMU5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBGSENrTnBjMGRCVVZGQ1p6YzRkMEZSTkVWRlozZFJZMjFXYldONU9XOWFWMFpyWTNrNU1HTnVWblZoZWtGYVFtZHZja0puUlVWQldVOHZUVUZGVUVKQmMwMEtRMVJKZUUxcVdYaE5la0V3VDFSQmJVSm5iM0pDWjBWRlFWbFBMMDFCUlZGQ1FtZE5SbTFvTUdSSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhZ3BpUjJ0M1IwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWUlVVdEVRV2N4VDFSamQwNUVZM2hOVkVKalFtZHZja0puUlVWQldVOHZUVUZGVTBKRk5FMVVSMmd3Q21SSVFucFBhVGgyV2pKc01HRklWbWxNYlU1MllsTTVhbUpIYTNaWk1uaHdUSGsxYm1GWVVtOWtWMGwyWkRJNWVXRXlXbk5pTTJSNlRESlNiR05IZUhZS1pWY3hiR0p1VVhWbFZ6RnpVVWhLYkZwdVRYWmhSMVpvV2toTmRtUklTakZpYlhOM1QwRlpTMHQzV1VKQ1FVZEVkbnBCUWtWM1VYRkVRMmh0V1ZkV2JRcE5iVkpyV2tSbmVGbHFRVE5OZWxrelRrUm5NRTFVVG1oT01rMHlUa1JhYWxwRVFtbGFiVTE1VG0xTmQwMUhSWGROUTBWSFEybHpSMEZSVVVKbk56aDNDa0ZTVVVWRmQzZFNaREk1ZVdFeVduTmlNMlJtV2tkc2VtTkhSakJaTW1kM1ZGRlpTMHQzV1VKQ1FVZEVkbnBCUWtaUlVTOUVSREZ2WkVoU2QyTjZiM1lLVERKa2NHUkhhREZaYVRWcVlqSXdkbGt5ZUhCTU1rNXpZVk01YUZrelVuQmlNalY2VEROS01XSnVUWFpQVkVrMFQxUkJNMDVVWXpGTmFUbG9aRWhTYkFwaVdFSXdZM2s0ZUUxQ1dVZERhWE5IUVZGUlFtYzNPSGRCVWxsRlEwRjNSMk5JVm1saVIyeHFUVWxIVEVKbmIzSkNaMFZGUVdSYU5VRm5VVU5DU0RCRkNtVjNRalZCU0dOQk0xUXdkMkZ6WWtoRlZFcHFSMUkwWTIxWFl6TkJjVXBMV0hKcVpWQkxNeTlvTkhCNVowTTRjRGR2TkVGQlFVZFFlRkl4ZW1KblFVRUtRa0ZOUVZORVFrZEJhVVZCS3pobmJGRkplRTlCYUZoQ1FVOVRObE1yT0ZweGQwcGpaSGQzVTNJdlZGZHBhSE16WkV4eFZrRjJiME5KVVVSaWVUbG9NUXBKWTNWRVJYSXJlbk5YYVV3NFVIYzFRMU5VZEd0c2RFbzBNakZ6UlRneFZuWjFOa0Z3VkVGTFFtZG5jV2hyYWs5UVVWRkVRWGRPYmtGRVFtdEJha0VyQ2tSSU4xQXJhR2cwVmtoWFprTlhXSFJ5UzFSdlFrdDFZa0pyUzNCbVYwTlpVWGhxV0UweWRsWXZibEJ4WWxwR1dVOVdXazlpWlRaQlRuSm5lV1J2V1VNS1RVWlZUV0l6ZUhwelJrNVJXWFp6UlZsUGFUSkxibkoyUmpCMFoyOXdiVmhIVm05NmJsb3JjUzh5UVVsRVZ6bEdNVVUzV1RaWk1EWXhaVzkxUVZsa1NBcFhkejA5Q2kwdExTMHRSVTVFSUVORlVsUkpSa2xEUVZSRkxTMHRMUzBLIn1dfX0= + timestampVerificationData: {} + certificate: + rawBytes: MIIGjTCCBhSgAwIBAgIUWYxqKsrMS3Svl5Ij5ODfBgMJO/IwCgYIKoZIzj0EAwMwNzEVMBMGA1UEChMMc2lnc3RvcmUuZGV2MR4wHAYDVQQDExVzaWdzdG9yZS1pbnRlcm1lZGlhdGUwHhcNMjQwNTI5MTYwOTUyWhcNMjQwNTI5MTYxOTUyWjAAMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEdmghNNw3nU/KueQgspGHW7gh9XLD/WdI8YMB+0p0V4o1kHo6cM1sDJgrCgPQUzxpuYuo+xwPHyl/kDyf3ELjkaOCBTMwggUvMA4GA1UdDwEB/wQEAwIHgDATBgNVHSUEDDAKBggrBgEFBQcDAzAdBgNVHQ4EFgQUqfCPvXKAvS4CdhQ2hbZWJSOEvVowHwYDVR0jBBgwFoAU39Ppz1YkEZb5qNjpKFWixi4YZD8wWgYDVR0RAQH/BFAwToZMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA5BgorBgEEAYO/MAEBBCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMB8GCisGAQQBg78wAQIEEXdvcmtmbG93X2Rpc3BhdGNoMDYGCisGAQQBg78wAQMEKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwGAYKKwYBBAGDvzABBAQKRGVwbG95bWVudDAVBgorBgEEAYO/MAEFBAdjbGkvY2xpMB4GCisGAQQBg78wAQYEEHJlZnMvaGVhZHMvdHJ1bmswOwYKKwYBBAGDvzABCAQtDCtodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tMFwGCisGAQQBg78wAQkETgxMaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWxAcmVmcy9oZWFkcy90cnVuazA4BgorBgEEAYO/MAEKBCoMKGZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAwHQYKKwYBBAGDvzABCwQPDA1naXRodWItaG9zdGVkMCoGCisGAQQBg78wAQwEHAwaaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkwOAYKKwYBBAGDvzABDQQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCAGCisGAQQBg78wAQ4EEgwQcmVmcy9oZWFkcy90cnVuazAZBgorBgEEAYO/MAEPBAsMCTIxMjYxMzA0OTAmBgorBgEEAYO/MAEQBBgMFmh0dHBzOi8vZ2l0aHViLmNvbS9jbGkwGAYKKwYBBAGDvzABEQQKDAg1OTcwNDcxMTBcBgorBgEEAYO/MAESBE4MTGh0dHBzOi8vZ2l0aHViLmNvbS9jbGkvY2xpLy5naXRodWIvd29ya2Zsb3dzL2RlcGxveW1lbnQueW1sQHJlZnMvaGVhZHMvdHJ1bmswOAYKKwYBBAGDvzABEwQqDChmYWVmMmRkZDgxYjA3MzY3NDg0MTNhN2M2NDZjZDBiZmMyNmMwMGEwMCEGCisGAQQBg78wARQEEwwRd29ya2Zsb3dfZGlzcGF0Y2gwTQYKKwYBBAGDvzABFQQ/DD1odHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaS9hY3Rpb25zL3J1bnMvOTI4OTA3NTc1Mi9hdHRlbXB0cy8xMBYGCisGAQQBg78wARYECAwGcHVibGljMIGLBgorBgEEAdZ5AgQCBH0EewB5AHcA3T0wasbHETJjGR4cmWc3AqJKXrjePK3/h4pygC8p7o4AAAGPxR1zbgAABAMASDBGAiEA+8glQIxOAhXBAOS6S+8ZqwJcdwwSr/TWihs3dLqVAvoCIQDby9h1IcuDEr+zsWiL8Pw5CSTtkltJ421sE81Vvu6ApTAKBggqhkjOPQQDAwNnADBkAjA+DH7P+hh4VHWfCWXtrKToBKubBkKpfWCYQxjXM2vV/nPqbZFYOVZObe6ANrgydoYCMFUMb3xzsFNQYvsEYOi2KnrvF0tgopmXGVoznZ+q/2AIDW9F1E7Y6Y061eouAYdHWw== + dsseEnvelope: + payload: eyJfdHlwZSI6Imh0dHBzOi8vaW4tdG90by5pby9TdGF0ZW1lbnQvdjEiLCJzdWJqZWN0IjpbeyJuYW1lIjoiZ2hfMi41MC4wX3dpbmRvd3NfYXJtNjQuemlwIiwiZGlnZXN0Ijp7InNoYTI1NiI6IjhhYWQxMjBiNDE2Mzg2YjQyNjllZjYyYzhmZGViY2FkMzFhNzA4NDcyOTc4MTdhMTQ5ZGFmOTI3ZWRjODU1NDgifX1dLCJwcmVkaWNhdGVUeXBlIjoiaHR0cHM6Ly9zbHNhLmRldi9wcm92ZW5hbmNlL3YxIiwicHJlZGljYXRlIjp7ImJ1aWxkRGVmaW5pdGlvbiI6eyJidWlsZFR5cGUiOiJodHRwczovL3Nsc2EtZnJhbWV3b3JrLmdpdGh1Yi5pby9naXRodWItYWN0aW9ucy1idWlsZHR5cGVzL3dvcmtmbG93L3YxIiwiZXh0ZXJuYWxQYXJhbWV0ZXJzIjp7IndvcmtmbG93Ijp7InJlZiI6InJlZnMvaGVhZHMvdHJ1bmsiLCJyZXBvc2l0b3J5IjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkiLCJwYXRoIjoiLmdpdGh1Yi93b3JrZmxvd3MvZGVwbG95bWVudC55bWwifX0sImludGVybmFsUGFyYW1ldGVycyI6eyJnaXRodWIiOnsiZXZlbnRfbmFtZSI6IndvcmtmbG93X2Rpc3BhdGNoIiwicmVwb3NpdG9yeV9pZCI6IjIxMjYxMzA0OSIsInJlcG9zaXRvcnlfb3duZXJfaWQiOiI1OTcwNDcxMSJ9fSwicmVzb2x2ZWREZXBlbmRlbmNpZXMiOlt7InVyaSI6ImdpdCtodHRwczovL2dpdGh1Yi5jb20vY2xpL2NsaUByZWZzL2hlYWRzL3RydW5rIiwiZGlnZXN0Ijp7ImdpdENvbW1pdCI6ImZhZWYyZGRkODFiMDczNjc0ODQxM2E3YzY0NmNkMGJmYzI2YzAwYTAifX1dfSwicnVuRGV0YWlscyI6eyJidWlsZGVyIjp7ImlkIjoiaHR0cHM6Ly9naXRodWIuY29tL2FjdGlvbnMvcnVubmVyL2dpdGh1Yi1ob3N0ZWQifSwibWV0YWRhdGEiOnsiaW52b2NhdGlvbklkIjoiaHR0cHM6Ly9naXRodWIuY29tL2NsaS9jbGkvYWN0aW9ucy9ydW5zLzkyODkwNzU3NTIvYXR0ZW1wdHMvMSJ9fX19 + payloadType: application/vnd.in-toto+json + signatures: + - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== + repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: @@ -204269,26 +216166,103 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 - simple-user-items: + campaign-org-items: value: - - 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 + - number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: Address critical alerts before they are exploited to prevent + breaches, protect sensitive data, and mitigate financial and reputational + damage. + managers: + - 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 + ends_at: '2024-03-14T12:29:18Z' + closed_at: + state: open + - number: 4 + created_at: '2024-03-30T12:29:18Z' + updated_at: '2024-03-30T12:29:18Z' + name: Mitre top 10 KEV + description: Remediate the MITRE Top 10 KEV (Known Exploited Vulnerabilities) + to enhance security by addressing vulnerabilities actively exploited by + attackers. This reduces risk, prevents breaches and can help protect sensitive + data. + managers: + - 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 + ends_at: '2024-04-30T12:29:18Z' + closed_at: + state: open + campaign-summary: + value: + number: 3 + created_at: '2024-02-14T12:29:18Z' + updated_at: '2024-02-14T12:29:18Z' + name: Critical CodeQL alert + description: Address critical alerts before they are exploited to prevent + breaches, protect sensitive data, and mitigate financial and reputational + damage. + managers: + - 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 + published_at: '2024-02-14T12:29:18Z' + ends_at: '2024-03-14T12:29:18Z' + closed_at: + state: open + alert_stats: + open_count: 10 + closed_count: 3 + in_progress_count: 3 code-scanning-organization-alert-items: value: - number: 4 @@ -204532,6 +216506,7 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: enabled secret_scanning: enabled secret_scanning_push_protection: enabled secret_scanning_delegated_bypass: enabled @@ -204542,6 +216517,7 @@ components: reviewer_type: TEAM secret_scanning_validity_checks: enabled secret_scanning_non_provider_patterns: enabled + secret_scanning_delegated_alert_dismissal: not_set private_vulnerability_reporting: enabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/17 @@ -204561,11 +216537,13 @@ components: dependabot_alerts: enabled dependabot_security_updates: enabled code_scanning_default_setup: enabled + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: enabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1326 @@ -204589,11 +216567,16 @@ components: code_scanning_default_setup_options: runner_type: not_set runner_label: + code_scanning_options: + allow_advanced: false + code_scanning_delegated_alert_dismissal: disabled secret_scanning: disabled secret_scanning_push_protection: disabled secret_scanning_delegated_bypass: disabled secret_scanning_validity_checks: disabled secret_scanning_non_provider_patterns: disabled + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -205055,6 +217038,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 + last_authenticated_at: '2021-10-14T00:53:32-06:00' plan_type: business assignee: login: octocat @@ -205094,6 +217078,7 @@ components: pending_cancellation_date: '2021-11-01' last_activity_at: '2021-10-13T00:53:32-06:00' last_activity_editor: vscode/1.77.3/copilot/1.86.82 + last_authenticated_at: '2021-10-14T00:53:32-06:00' assignee: login: octokitten id: 1 @@ -205113,6 +217098,10 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: false + copilot-organization-content-exclusion-details: + value: + octo-repo: + - "/src/some-dir/kernel.rs" copilot-usage-metrics-for-day: value: - date: '2024-06-24' @@ -205212,70 +217201,6 @@ components: custom_model_training_date: '2024-02-01' total_pr_summaries_created: 10 total_engaged_users: 4 - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -205381,6 +217306,12 @@ components: action: started public: true created_at: '2022-06-08T23:29:25Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? - id: '22249084964' type: PushEvent actor: @@ -205393,24 +217324,21 @@ components: repo: id: 1296269 name: octo-org/octo-repo - url: https://api.github.com/repos/octo-org/oct-repo + url: https://api.github.com/repos/octo-org/octo-repo payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? organization-invitation-items: value: - id: 1 @@ -205506,7 +217434,6 @@ components: - 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' @@ -205691,6 +217618,28 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: + issue-type-items: + value: + - id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + - id: 411 + node_id: IT_kwDNAd3NAZs + name: Bug + description: An unexpected problem or behavior + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' + issue-type: + value: + id: 410 + node_id: IT_kwDNAd3NAZo + name: Task + description: A specific piece of work + created_at: '2024-12-11T14:39:09Z' + updated_at: '2024-12-11T14:39:09Z' codespace: value: id: 1 @@ -205839,6 +217788,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 + last_authenticated_at: '2021-10-14T00:53:32-06:00' plan_type: business assignee: login: octocat @@ -205880,6 +217830,10 @@ components: state: active role: admin organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -206472,6 +218426,8 @@ components: status: disabled secret_scanning_non_provider_patterns: status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled organization-role-list: value: total_count: 2 @@ -206724,18 +218680,119 @@ components: value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - project-items: + projects-v2: value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 + id: 2 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + 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 + creator: + 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 + title: My Projects + description: A board to manage my personal projects. + public: true + closed_at: + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + number: 2 + short_description: + deleted_at: + deleted_by: state: open + latest_status_update: + id: 3 + node_id: PVTSU_lAECAQM + creator: + login: hubot + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://github.com/images/error/hubot_happy.gif + gravatar_id: '' + url: https://api.github.com/users/hubot + html_url: https://github.com/hubot + followers_url: https://api.github.com/users/hubot/followers + following_url: https://api.github.com/users/hubot/following{/other_user} + gists_url: https://api.github.com/users/hubot/gists{/gist_id} + starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/hubot/subscriptions + organizations_url: https://api.github.com/users/hubot/orgs + repos_url: https://api.github.com/users/hubot/repos + events_url: https://api.github.com/users/hubot/events{/privacy} + received_events_url: https://api.github.com/users/hubot/received_events + type: User + site_admin: false + body: DONE + start_date: '2025-07-23' + target_date: '2025-07-26' + status: COMPLETE + created_at: '2025-07-11T16:19:28Z' + updated_at: '2025-07-11T16:19:28Z' + is_template: true + projects-v2-item-simple: + value: + id: 17 + node_id: PVTI_lADOANN5s84ACbL0zgBueEI + content: + id: 38 + node_id: I_kwDOANN5s85FtLts + title: Example Draft Issue + body: This is a draft issue in the project. + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + user: + 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 + content_type: DraftIssue creator: login: octocat id: 1 @@ -206755,22 +218812,972 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: true - project-2: + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + archived_at: + project_url: https://api.github.com/users/octocat/projectsV2/1 + item_url: https://api.github.com/users/octocat/projectsV2/items/17 + projects-v2-field-items: value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. + - id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + - id: 67891 + node_id: PVTF_lADOABCD9876543210 + name: Status + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_4 + name: + html: Todo + raw: Todo + color: GRAY + description: + html: Items to be worked on + raw: Items to be worked on + - id: option_5 + name: + html: In Progress + raw: In Progress + color: BLUE + description: + html: Items currently being worked on + raw: Items currently being worked on + - id: option_6 + name: + html: Done + raw: Done + color: GREEN + description: + html: Completed items + raw: Completed items + created_at: '2022-04-29T10:30:00Z' + updated_at: '2022-04-29T10:30:00Z' + - id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + - id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + - id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + - id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field-single-select-request: + summary: Create a single select field + value: + name: Priority + data_type: single_select + single_select_options: + - name: + raw: Low + html: Low + color: GREEN + description: + raw: Low priority items + html: Low priority items + - name: + raw: Medium + html: Medium + color: YELLOW + description: + raw: Medium priority items + html: Medium priority items + - name: + raw: High + html: High + color: RED + description: + raw: High priority items + html: High priority items + projects-v2-field-iteration-request: + summary: Create an iteration field + value: + name: Sprint + data_type: iteration + iteration_configuration: + start_day: 1 + duration: 14 + iterations: + - title: + raw: Sprint 1 + html: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - title: + raw: Sprint 2 + html: Sprint 2 + start_date: '2022-07-15' + duration: 14 + projects-v2-field-text: + value: + id: 24680 + node_id: PVTF_lADOABCD2468024680 + name: Team notes + data_type: text + project_url: https://api.github.com/projects/67890 + created_at: '2022-05-15T08:00:00Z' + updated_at: '2022-05-15T08:00:00Z' + projects-v2-field-number: + value: + id: 13579 + node_id: PVTF_lADOABCD1357913579 + name: Story points + data_type: number + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-01T14:30:00Z' + updated_at: '2022-06-01T14:30:00Z' + projects-v2-field-date: + value: + id: 98765 + node_id: PVTF_lADOABCD9876598765 + name: Due date + data_type: date + project_url: https://api.github.com/projects/67890 + created_at: '2022-06-10T09:15:00Z' + updated_at: '2022-06-10T09:15:00Z' + projects-v2-field-single-select: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-field-iteration: + value: + id: 11223 + node_id: PVTF_lADOABCD1122311223 + name: Sprint + data_type: iteration + project_url: https://api.github.com/projects/67890 + configuration: + duration: 14 + start_day: 1 + iterations: + - id: iter_1 + title: + html: Sprint 1 + raw: Sprint 1 + start_date: '2022-07-01' + duration: 14 + - id: iter_2 + title: + html: Sprint 2 + raw: Sprint 2 + start_date: '2022-07-15' + duration: 14 + created_at: '2022-06-20T16:45:00Z' + updated_at: '2022-06-20T16:45:00Z' + projects-v2-field: + value: + id: 12345 + node_id: PVTF_lADOABCD1234567890 + name: Priority + data_type: single_select + project_url: https://api.github.com/projects/67890 + options: + - id: option_1 + name: + html: Low + raw: Low + color: GREEN + description: + html: Low priority items + raw: Low priority items + - id: option_2 + name: + html: Medium + raw: Medium + color: YELLOW + description: + html: Medium priority items + raw: Medium priority items + - id: option_3 + name: + html: High + raw: High + color: RED + description: + html: High priority items + raw: High priority items + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + projects-v2-item-with-content: + value: + id: 13 + node_id: PVTI_lAAFAQ0 + project_url: https://api.github.com/orgs/github/projectsV2/1 + content: + url: https://api.github.com/repos/github/Hello-World/pulls/6 + id: 10 + node_id: PR_kwABCg + html_url: https://github.com/github/Hello-World/pull/6 + diff_url: https://github.com/github/Hello-World/pull/6.diff + patch_url: https://github.com/github/Hello-World/pull/6.patch + issue_url: https://api.github.com/repos/github/Hello-World/issues/6 + number: 6 + state: open + locked: false + title: Issue title + user: + login: monalisa + id: 161 + node_id: U_kgDMoQ + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + pinned_comment: + body: Issue body + created_at: '2025-08-01T18:44:50Z' + updated_at: '2025-08-06T19:25:18Z' + closed_at: + merged_at: + merge_commit_sha: 98e25bad5878e54d22e5338cbc905dd2deedfa34 + assignee: + login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + assignees: + - login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + requested_reviewers: + - login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + requested_teams: [] + labels: + - id: 19 + node_id: LA_kwABEw + url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: "fun size \U0001F36B" + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: "\U0001F692 wontfix" + color: 5891ce + default: false + description: This will not be worked on + milestone: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: + closed_at: + draft: false + commits_url: https://api.github.com/repos/github/Hello-World/pulls/6/commits + review_comments_url: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment_url: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + comments_url: https://api.github.com/repos/github/Hello-World/issues/6/comments + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + head: + label: github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f + ref: branch-2ee3da8fde8a1adfe6d0809a1a414e4f + sha: a3258d3434ecb2058b2784c8eb8610c2e9937a0d + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: + archived: false + disabled: false + open_issues_count: 3 + license: + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + base: + label: github:branch-0f4ceb14cbe39e4786ffbabb776da599 + ref: branch-0f4ceb14cbe39e4786ffbabb776da599 + sha: 9a9f5a8d77bdc2540412900d3c930fe36a82b5ed + user: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + repo: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + created_at: '2025-08-01T18:44:14Z' + updated_at: '2025-08-01T18:48:38Z' + pushed_at: '2025-08-01T18:44:50Z' + git_url: git://github.localhost/github/Hello-World.git + ssh_url: ssh://git@localhost:3035/github/Hello-World.git + clone_url: https://github.com/github/Hello-World.git + svn_url: https://github.com/github/Hello-World + homepage: + size: 6 + stargazers_count: 0 + watchers_count: 0 + language: + has_issues: true + has_projects: true + has_downloads: true + has_wiki: true + has_pages: false + has_discussions: false + forks_count: 0 + mirror_url: + archived: false + disabled: false + open_issues_count: 3 + license: + allow_forking: true + is_template: false + web_commit_signoff_required: false + topics: [] + visibility: public + forks: 0 + open_issues: 3 + watchers: 0 + default_branch: main + _links: + self: + href: https://api.github.com/repos/github/Hello-World/pulls/6 + html: + href: https://github.com/github/Hello-World/pull/6 + issue: + href: https://api.github.com/repos/github/Hello-World/issues/6 + comments: + href: https://api.github.com/repos/github/Hello-World/issues/6/comments + review_comments: + href: https://api.github.com/repos/github/Hello-World/pulls/6/comments + review_comment: + href: https://api.github.com/repos/github/Hello-World/pulls/comments{/number} + commits: + href: https://api.github.com/repos/github/Hello-World/pulls/6/commits + statuses: + href: https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d + author_association: MEMBER + auto_merge: + active_lock_reason: + content_type: PullRequest + creator: + login: monalisa + id: 2 + node_id: U_kgAC + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + user_view_type: public + site_admin: false + created_at: '2025-08-01T18:44:51Z' + updated_at: '2025-08-06T19:25:18Z' + archived_at: + item_url: https://api.github.com/orgs/github/projectsV2/1/items/13 + fields: + - id: 1 + name: Title + type: title + value: + raw: It seemed to me that any civilization that had so far lost its head + as to need to include a set of detailed instructions for use in a packet + of toothpicks, was no longer a civilization in which I could live and + stay sane. + html: It seemed to me that any civilization that had so far lost its head + as to need to include a set of detailed instructions for use in a packet + of toothpicks, was no longer a civilization in which I could live and + stay sane. + number: 6 + url: https://github.com/5/1/pull/6 + issue_id: 12 + state: open + state_reason: + is_draft: false + - id: 2 + name: Assignees + type: assignees + value: + - login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + - id: 3 + name: Status + type: single_select + value: + id: '98236657' + name: + raw: Done + html: Done + color: PURPLE + description: + raw: This has been completed + html: This has been completed + - id: 4 + name: Labels + type: labels + value: + - id: 19 + node_id: LA_kwABEw + url: 'https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:' + name: 'bug :bug:' + color: efe24f + default: false + description: Something isn't working + - id: 26 + node_id: LA_kwABGg + url: https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB + name: "fun size \U0001F36B" + color: f29c24 + default: false + description: Extra attention is needed + - id: 33 + node_id: LA_kwABIQ + url: https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix + name: "\U0001F692 wontfix" + color: 5891ce + default: false + description: This will not be worked on + - id: 5 + name: Linked pull requests + type: linked_pull_requests + value: [] + - id: 6 + name: Milestone + type: milestone + value: + url: https://api.github.com/repos/github/Hello-World/milestones/1 + html_url: https://github.com/github/Hello-World/milestone/1 + labels_url: https://api.github.com/repos/github/Hello-World/milestones/1/labels + id: 1 + node_id: MI_kwABAQ + number: 1 + title: Open milestone + description: + creator: + login: octocat + id: 175 + node_id: U_kgDMrw + 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 + user_view_type: public + site_admin: false + open_issues: 2 + closed_issues: 1 + state: open + created_at: '2025-08-01T18:44:30Z' + updated_at: '2025-08-06T19:14:15Z' + due_on: + closed_at: + - id: 7 + name: Repository + type: repository + value: + id: 1 + node_id: R_kgAB + name: Hello-World + full_name: github/Hello-World + private: false + owner: + login: github + id: 5 + node_id: O_kgAF + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/github + html_url: https://github.com/github + followers_url: https://api.github.com/users/github/followers + following_url: https://api.github.com/users/github/following{/other_user} + gists_url: https://api.github.com/users/github/gists{/gist_id} + starred_url: https://api.github.com/users/github/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/github/subscriptions + organizations_url: https://api.github.com/users/github/orgs + repos_url: https://api.github.com/users/github/repos + events_url: https://api.github.com/users/github/events{/privacy} + received_events_url: https://api.github.com/users/github/received_events + type: Organization + user_view_type: public + site_admin: false + html_url: https://github.com/github/Hello-World + description: + fork: false + url: https://api.github.com/repos/github/Hello-World + forks_url: https://api.github.com/repos/github/Hello-World/forks + keys_url: https://api.github.com/repos/github/Hello-World/keys{/key_id} + collaborators_url: https://api.github.com/repos/github/Hello-World/collaborators{/collaborator} + teams_url: https://api.github.com/repos/github/Hello-World/teams + hooks_url: https://api.github.com/repos/github/Hello-World/hooks + issue_events_url: https://api.github.com/repos/github/Hello-World/issues/events{/number} + events_url: https://api.github.com/repos/github/Hello-World/events + assignees_url: https://api.github.com/repos/github/Hello-World/assignees{/user} + branches_url: https://api.github.com/repos/github/Hello-World/branches{/branch} + tags_url: https://api.github.com/repos/github/Hello-World/tags + blobs_url: https://api.github.com/repos/github/Hello-World/git/blobs{/sha} + git_tags_url: https://api.github.com/repos/github/Hello-World/git/tags{/sha} + git_refs_url: https://api.github.com/repos/github/Hello-World/git/refs{/sha} + trees_url: https://api.github.com/repos/github/Hello-World/git/trees{/sha} + statuses_url: https://api.github.com/repos/github/Hello-World/statuses/{sha} + languages_url: https://api.github.com/repos/github/Hello-World/languages + stargazers_url: https://api.github.com/repos/github/Hello-World/stargazers + contributors_url: https://api.github.com/repos/github/Hello-World/contributors + subscribers_url: https://api.github.com/repos/github/Hello-World/subscribers + subscription_url: https://api.github.com/repos/github/Hello-World/subscription + commits_url: https://api.github.com/repos/github/Hello-World/commits{/sha} + git_commits_url: https://api.github.com/repos/github/Hello-World/git/commits{/sha} + comments_url: https://api.github.com/repos/github/Hello-World/comments{/number} + issue_comment_url: https://api.github.com/repos/github/Hello-World/issues/comments{/number} + contents_url: https://api.github.com/repos/github/Hello-World/contents/{+path} + compare_url: https://api.github.com/repos/github/Hello-World/compare/{base}...{head} + merges_url: https://api.github.com/repos/github/Hello-World/merges + archive_url: https://api.github.com/repos/github/Hello-World/{archive_format}{/ref} + downloads_url: https://api.github.com/repos/github/Hello-World/downloads + issues_url: https://api.github.com/repos/github/Hello-World/issues{/number} + pulls_url: https://api.github.com/repos/github/Hello-World/pulls{/number} + milestones_url: https://api.github.com/repos/github/Hello-World/milestones{/number} + notifications_url: https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating} + labels_url: https://api.github.com/repos/github/Hello-World/labels{/name} + releases_url: https://api.github.com/repos/github/Hello-World/releases{/id} + deployments_url: https://api.github.com/repos/github/Hello-World/deployments + - id: 8 + name: Type + type: issue_type + value: + - id: 9 + name: Reviewers + type: reviewers + value: + - type: ReviewRequest + status: pending + reviewer: + avatarUrl: https://github.com/images/error/octocat_happy.gif + id: 2 + login: monalisa + url: https://github.com/monalisa + name: monalisa + type: User + - id: 10 + name: Parent issue + type: parent_issue + value: + - id: 11 + name: Sub-issues progress + type: sub_issues_progress + value: + projects-v2-view: + value: + id: 1 number: 1 - state: open + name: Sprint Board + layout: board + node_id: PVTV_lADOANN5s84ACbL0zgBueEI + project_url: https://api.github.com/orgs/octocat/projectsV2/1 + html_url: https://github.com/orgs/octocat/projects/1/views/1 creator: login: octocat id: 1 @@ -206790,8 +219797,22 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' + created_at: '2022-04-28T12:00:00Z' + updated_at: '2022-04-28T12:00:00Z' + filter: is:issue is:open + visible_fields: + - 123 + - 456 + - 789 + sort_by: + - - 123 + - asc + - - 456 + - desc + group_by: + - 123 + vertical_group_by: + - 456 custom-properties: value: - property_name: environment @@ -206805,6 +219826,7 @@ components: - production - development values_editable_by: org_actors + require_explicit_values: true - property_name: service url: https://api.github.com/orgs/github/properties/schema/service source_type: organization @@ -207464,6 +220486,262 @@ components: enforcement: evaluate result: fail rule_type: commit_message_pattern + ruleset-history: + value: + - version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + - version_id: 2 + actor: + id: 2 + type: User + updated_at: '2024-09-23T16:29:47Z' + - version_id: 1 + actor: + id: 1 + type: User + updated_at: '2024-08-23T16:29:47Z' + org-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 21 + name: super cool ruleset + target: branch + source_type: Organization + source: my-org + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + repository_name: + include: + - important_repository + - another_important_repository + exclude: + - unimportant_repository + protected: true + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github + organization-secret-scanning-alert-list: + value: + - number: 2 + created_at: '2020-11-06T18:48:51Z' + url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2 + html_url: https://github.com/owner/private-repo/security/secret-scanning/2 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations + state: resolved + resolution: false_positive + resolved_at: '2020-11-07T02:47:13Z' + resolved_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + secret_type: adafruit_io_key + secret_type_display_name: Adafruit IO Key + secret: aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX + 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} + 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} + 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} + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + push_protection_bypassed_by: + login: monalisa + id: 2 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/2? + gravatar_id: '' + url: https://api.github.com/users/monalisa + html_url: https://github.com/monalisa + followers_url: https://api.github.com/users/monalisa/followers + following_url: https://api.github.com/users/monalisa/following{/other_user} + gists_url: https://api.github.com/users/monalisa/gists{/gist_id} + starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/monalisa/subscriptions + organizations_url: https://api.github.com/users/monalisa/orgs + repos_url: https://api.github.com/users/monalisa/repos + events_url: https://api.github.com/users/monalisa/events{/privacy} + received_events_url: https://api.github.com/users/monalisa/received_events + type: User + site_admin: true + push_protection_bypassed: true + push_protection_bypassed_at: '2020-11-06T21:48:51Z' + push_protection_bypass_request_reviewer: + login: octocat + id: 3 + node_id: MDQ6VXNlcjI= + avatar_url: https://alambic.github.com/avatars/u/3? + 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: true + push_protection_bypass_request_reviewer_comment: Example response + push_protection_bypass_request_comment: Example comment + push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 + resolution_comment: Example comment + validity: active + publicly_leaked: false + multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + 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 + secret-scanning-pattern-configuration: + value: + pattern_config_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + provider_pattern_overrides: + - token_type: GITHUB_PERSONAL_ACCESS_TOKEN + slug: github_personal_access_token_legacy_v2 + display_name: GitHub Personal Access Token (Legacy v2) + alert_total: 15 + alert_total_percentage: 36 + false_positives: 2 + false_positive_rate: 13 + bypass_rate: 13 + default_setting: enabled + setting: enabled + enterprise_setting: enabled + custom_pattern_overrides: + - token_type: cp_2 + custom_pattern_version: 0ujsswThIGTUYm2K8FjOOfXtY1K + slug: custom-api-key + display_name: Custom API Key + alert_total: 15 + alert_total_percentage: 36 + false_positives: 3 + false_positive_rate: 20 + bypass_rate: 20 + default_setting: disabled + setting: enabled list-repository-advisories: value: - ghsa_id: GHSA-abcd-1234-efgh @@ -207823,25 +221101,22 @@ components: tags_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/tags teams_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/teams trees_url: https://api.github.com/repos/octo-org/octo-repo-ghsa-1234-5678-9012/git/trees{/sha} - actions-billing-usage: - value: - total_minutes_used: 305 - total_paid_minutes_used: 0 - included_minutes: 3000 - minutes_used_breakdown: - UBUNTU: 205 - MACOS: 10 - WINDOWS: 90 - packages-billing-usage: + team-simple-items: value: - total_gigabytes_bandwidth_used: 50 - total_paid_gigabytes_bandwidth_used: 40 - included_gigabytes_bandwidth: 10 - combined-billing-usage: - value: - days_left_in_billing_cycle: 20 - estimated_paid_storage_for_month: 15 - estimated_storage_for_month: 40 + - id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/organizations/1/team/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: https://api.github.com/organizations/1/team/1/repos + type: organization + organization_id: 1 network-configurations-paginated: value: total_count: 2 @@ -207924,329 +221199,6 @@ components: created_at: '2008-01-14T04:33:35Z' updated_at: '2017-08-17T12:37:15Z' type: Organization - team-discussion-items: - value: - - author: - 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 - body: Hi! This is an area for us to collaborate as a team. - body_html: "

Hi! This is an area for us to collaborate as a team

" - body_version: 0d495416a700fb06133c612575d92bfb - comments_count: 0 - comments_url: https://api.github.com/teams/2343027/discussions/1/comments - created_at: '2018-01-25T18:56:31Z' - last_edited_at: - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: 1 - pinned: false - private: false - team_url: https://api.github.com/teams/2343027 - title: Our first team post - updated_at: '2018-01-25T18:56:31Z' - url: https://api.github.com/teams/2343027/discussions/1 - reactions: - url: https://api.github.com/teams/2343027/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion: - value: - author: - 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 - body: Hi! This is an area for us to collaborate as a team. - body_html: "

Hi! This is an area for us to collaborate as a team

" - body_version: 0d495416a700fb06133c612575d92bfb - comments_count: 0 - comments_url: https://api.github.com/teams/2343027/discussions/1/comments - created_at: '2018-01-25T18:56:31Z' - last_edited_at: - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: 1 - pinned: false - private: false - team_url: https://api.github.com/teams/2343027 - title: Our first team post - updated_at: '2018-01-25T18:56:31Z' - url: https://api.github.com/teams/2343027/discussions/1 - reactions: - url: https://api.github.com/teams/2343027/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-2: - value: - author: - 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 - body: Hi! This is an area for us to collaborate as a team. - body_html: "

Hi! This is an area for us to collaborate as a team

" - body_version: 0d495416a700fb06133c612575d92bfb - comments_count: 1 - comments_url: https://api.github.com/teams/2343027/discussions/1/comments - created_at: '2018-01-25T18:56:31Z' - last_edited_at: '2018-01-26T18:22:20Z' - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: 1 - pinned: false - private: false - team_url: https://api.github.com/teams/2343027 - title: Welcome to our first team post - updated_at: '2018-01-26T18:22:20Z' - url: https://api.github.com/teams/2343027/discussions/1 - reactions: - url: https://api.github.com/teams/2343027/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-comment-items: - value: - - author: - 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 - body: Do you like apples? - body_html: "

Do you like apples?

" - body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 - created_at: '2018-01-15T23:53:58Z' - last_edited_at: - discussion_url: https://api.github.com/teams/2403582/discussions/1 - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: 1 - updated_at: '2018-01-15T23:53:58Z' - url: https://api.github.com/teams/2403582/discussions/1/comments/1 - reactions: - url: https://api.github.com/teams/2403582/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-comment: - value: - author: - 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 - body: Do you like apples? - body_html: "

Do you like apples?

" - body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 - created_at: '2018-01-15T23:53:58Z' - last_edited_at: - discussion_url: https://api.github.com/teams/2403582/discussions/1 - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: 1 - updated_at: '2018-01-15T23:53:58Z' - url: https://api.github.com/teams/2403582/discussions/1/comments/1 - reactions: - url: https://api.github.com/teams/2403582/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - team-discussion-comment-2: - value: - author: - 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 - body: Do you like pineapples? - body_html: "

Do you like pineapples?

" - body_version: e6907b24d9c93cc0c5024a7af5888116 - created_at: '2018-01-15T23:53:58Z' - last_edited_at: '2018-01-26T18:22:20Z' - discussion_url: https://api.github.com/teams/2403582/discussions/1 - html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: 1 - updated_at: '2018-01-26T18:22:20Z' - url: https://api.github.com/teams/2403582/discussions/1/comments/1 - reactions: - url: https://api.github.com/teams/2403582/discussions/1/reactions - total_count: 5 - "+1": 3 - "-1": 1 - laugh: 0 - confused: 0 - heart: 1 - hooray: 0 - eyes: 1 - rocket: 1 - reaction-items: - value: - - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' - reaction: - value: - id: 1 - node_id: MDg6UmVhY3Rpb24x - user: - 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 - content: heart - created_at: '2016-05-20T20:09:31Z' team-membership-response-if-user-is-a-team-maintainer: summary: Response if user is a team maintainer value: @@ -208259,84 +221211,6 @@ components: url: https://api.github.com/teams/1/memberships/octocat role: member state: pending - team-project-items: - value: - - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false - team-project: - value: - owner_url: https://api.github.com/orgs/octocat - url: https://api.github.com/projects/1002605 - html_url: https://github.com/orgs/api-playground/projects/1 - columns_url: https://api.github.com/projects/1002605/columns - id: 1002605 - node_id: MDc6UHJvamVjdDEwMDI2MDU= - name: Organization Roadmap - body: High-level roadmap for the upcoming year. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-11T20:09:31Z' - updated_at: '2014-03-04T18:58:10Z' - organization_permission: write - private: false - permissions: - read: true - write: true - admin: false team-repository-alternative-response-with-repository-permissions: value: id: 1296269 @@ -208485,143 +221359,6 @@ components: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core - project-card: - value: - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - 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 - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - project-column: - value: - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' - project-card-items: - value: - - url: https://api.github.com/projects/columns/cards/1478 - id: 1478 - node_id: MDExOlByb2plY3RDYXJkMTQ3OA== - note: Add payload for delete Project column - creator: - 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 - created_at: '2016-09-05T14:21:06Z' - updated_at: '2016-09-05T14:20:22Z' - archived: false - column_url: https://api.github.com/projects/columns/367 - content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: https://api.github.com/projects/120 - project-3: - value: - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' - project-collaborator-permission: - value: - permission: admin - user: - 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 - project-column-items: - value: - - url: https://api.github.com/projects/columns/367 - project_url: https://api.github.com/projects/120 - cards_url: https://api.github.com/projects/columns/367/cards - id: 367 - node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= - name: To Do - created_at: '2016-09-05T14:18:44Z' - updated_at: '2016-09-05T14:22:28Z' rate-limit-overview: value: resources: @@ -209182,6 +221919,10 @@ components: status: disabled secret_scanning_non_provider_patterns: status: disabled + secret_scanning_delegated_bypass: + status: disabled + secret_scanning_delegated_alert_dismissal: + status: disabled artifact-paginated: value: total_count: 2 @@ -209196,6 +221937,7 @@ components: created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: id: 2332938 repository_id: 1296269 @@ -209212,6 +221954,7 @@ components: created_at: '2020-01-10T14:59:22Z' expires_at: '2020-03-21T14:59:22Z' updated_at: '2020-02-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: id: 2332942 repository_id: 1296269 @@ -209230,6 +221973,7 @@ components: created_at: '2020-01-10T14:59:22Z' expires_at: '2020-01-21T14:59:22Z' updated_at: '2020-01-21T14:59:22Z' + digest: sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c workflow_run: id: 2332938 repository_id: 1296269 @@ -209371,6 +222115,7 @@ components: enabled: true allowed_actions: selected selected_actions_url: https://api.github.com/repositories/42/actions/permissions/selected-actions + sha_pinning_required: true actions-workflow-access-to-repository: value: access_level: organization @@ -210088,6 +222833,11 @@ components: url: https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335 html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335 badge_url: https://github.com/octo-org/octo-repo/workflows/CI/badge.svg + workflow-dispatch-response: + value: + workflow_run_id: 1 + run_url: https://api.github.com/repos/octo-org/octo-repo/actions/runs/1 + html_url: https://github.com/octo-org/octo-repo/actions/runs/1 workflow-usage: value: billable: @@ -211899,7 +224649,6 @@ components: environment: '' category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" state: open - fixed_at: commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930 message: text: This path depends on a user-provided value. @@ -211916,7 +224665,6 @@ components: environment: '' category: ".github/workflows/codeql-analysis.yml:CodeQL-Build" state: fixed - fixed_at: '2020-02-14T12:29:18Z' commit_sha: b09da05606e27f463a2b49287684b4ae777092f2 message: text: This suffix check is missing a length comparison to correctly handle @@ -211989,7 +224737,7 @@ components: deletable: true warning: '' code-scanning-analysis-sarif: - summary: application/json+sarif response + summary: application/sarif+json response value: runs: - tool: @@ -212200,7 +224948,7 @@ components: created_at: '2022-09-12T12:14:32Z' updated_at: '2022-09-12T12:14:32Z' completed_at: '2022-09-12T13:15:33Z' - status: completed + status: succeeded actions_workflow_run_id: 3453588 scanned_repositories: - repository: @@ -212216,12 +224964,10 @@ components: repository_count: 2 repositories: - id: 1 - node_id: MDQ6VXNlcjE= name: octo-repo1 full_name: octo-org/octo-repo1 private: false - id: 2 - node_id: MDQ6VXNlcjE= name: octo-repo2 full_name: octo-org/octo-repo2 private: false @@ -212235,12 +224981,10 @@ components: repository_count: 2 repositories: - id: 7 - node_id: MDQ6VXNlcjE= name: octo-repo7 full_name: octo-org/octo-repo7 private: false - id: 8 - node_id: MDQ6VXNlcjE= name: octo-repo8 full_name: octo-org/octo-repo8 private: false @@ -212248,12 +224992,10 @@ components: repository_count: 2 repositories: - id: 9 - node_id: MDQ6VXNlcjE= name: octo-repo9 full_name: octo-org/octo-repo9 private: false - id: 10 - node_id: MDQ6VXNlcjE= name: octo-repo10 full_name: octo-org/octo-repo10 private: false @@ -212338,11 +225080,13 @@ components: - ruby - python query_suite: default + threat_model: remote updated_at: '2023-01-19T11:21:34Z' schedule: weekly code-scanning-default-setup-update: value: state: configured + threat_model: remote_and_local code-scanning-default-setup-update-response: value: run_id: 42 @@ -212373,11 +225117,14 @@ components: dependabot_alerts: enabled dependabot_security_updates: not_set code_scanning_default_setup: disabled + code_scanning_delegated_alert_dismissal: 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 + secret_scanning_generic_secrets: disabled + secret_scanning_delegated_alert_dismissal: disabled private_vulnerability_reporting: disabled enforcement: enforced url: https://api.github.com/orgs/octo-org/code-security/configurations/1325 @@ -213000,6 +225747,56 @@ components: site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' + reaction-items: + value: + - id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' + reaction: + value: + id: 1 + node_id: MDg6UmVhY3Rpb24x + user: + 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 + content: heart + created_at: '2016-05-20T20:09:31Z' commit-items: value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -214564,6 +227361,25 @@ components: dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: + assignees: + - 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 - number: 1 state: open dependency: @@ -214646,6 +227462,7 @@ components: dismissed_reason: dismissed_comment: fixed_at: + assignees: [] dependabot-alert-open: value: number: 1 @@ -214733,6 +227550,25 @@ components: dismissed_reason: dismissed_comment: fixed_at: + assignees: + - 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 dependabot-alert-dismissed: value: number: 2 @@ -214832,6 +227668,7 @@ components: dismissed_reason: tolerable_risk dismissed_comment: This alert is accurate but we use a sanitizer. fixed_at: + assignees: [] dependabot-secret-paginated: value: total_count: 2 @@ -215305,20 +228142,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22237752260' @@ -216045,6 +228873,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -216191,6 +229020,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -216364,6 +229194,58 @@ components: updated_at: '2011-04-14T16:00:49Z' issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR + pin: + issue-comment-pinned: + value: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + 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 + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + 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 issue-event-items: value: - id: 1 @@ -216424,6 +229306,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -216578,6 +229461,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false + pinned_comment: labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -216693,7 +229577,6 @@ components: metadata: read contents: read issues: write - single_file: write events: - push - pull_request @@ -216708,6 +229591,202 @@ components: updated_at: '2011-04-22T13:33:48Z' author_association: COLLABORATOR state_reason: completed + issue-with-pinned-comment: + value: + id: 1 + node_id: MDU6SXNzdWUx + url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + repository_url: https://api.github.com/repos/octocat/Hello-World + labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} + comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events + html_url: https://github.com/octocat/Hello-World/issues/1347 + number: 1347 + state: open + title: Found a bug + body: I'm having a problem with this. + user: + 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 + pinned_comment: + id: 1 + node_id: MDEyOklzc3VlQ29tbWVudDE= + url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 + html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 + body: Me too + user: + 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 + pin: + pinned_at: '2021-01-01T00:00:00Z' + pinned_by: + 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 + created_at: '2011-04-14T16:00:49Z' + updated_at: '2011-04-14T16:00:49Z' + issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + author_association: COLLABORATOR + labels: + - id: 208045946 + node_id: MDU6TGFiZWwyMDgwNDU5NDY= + url: https://api.github.com/repos/octocat/Hello-World/labels/bug + name: bug + description: Something isn't working + color: f29513 + default: true + assignee: + 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 + assignees: + - 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 + milestone: + url: https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: 1002604 + node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== + number: 1 + state: open + title: v1.0 + description: Tracking milestone for version 1.0 + creator: + 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 + open_issues: 4 + closed_issues: 8 + created_at: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + closed_at: '2013-02-12T13:22:01Z' + due_on: '2012-10-09T23:39:01Z' + locked: true + active_lock_reason: too heated + comments: 1 + pull_request: + url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 + html_url: https://github.com/octocat/Hello-World/pull/1347 + diff_url: https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: https://github.com/octocat/Hello-World/pull/1347.patch + closed_at: + created_at: '2011-04-22T13:33:48Z' + updated_at: '2011-04-22T13:33:48Z' + closed_by: + 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 + author_association: COLLABORATOR + state_reason: completed issue-event-for-issue-items: value: - id: 1 @@ -217235,39 +230314,6 @@ components: https_error: is_https_eligible: true caa_error: - project-items-2: - value: - - owner_url: https://api.github.com/repos/api-playground/projects-test - url: https://api.github.com/projects/1002604 - html_url: https://github.com/api-playground/projects-test/projects/1 - columns_url: https://api.github.com/projects/1002604/columns - id: 1002604 - node_id: MDc6UHJvamVjdDEwMDI2MDQ= - name: Projects Documentation - body: Developer documentation project for the developer site. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' custom-property-values: value: - property_name: environment @@ -219281,6 +232327,7 @@ components: body: Description of the release draft: false prerelease: false + immutable: false created_at: '2013-02-27T19:35:32Z' published_at: '2013-02-27T19:35:32Z' author: @@ -219312,6 +232359,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -219351,6 +232399,7 @@ components: body: Description of the release draft: false prerelease: false + immutable: false created_at: '2013-02-27T19:35:32Z' published_at: '2013-02-27T19:35:32Z' author: @@ -219382,6 +232431,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -219415,6 +232465,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -219452,6 +232503,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -219485,6 +232537,7 @@ components: state: uploaded content_type: application/zip size: 1024 + digest: sha256:2151b604e3429bff440b9fbc03eb3617bc2603cda96c95b9bb05277f9ddba255 download_count: 42 created_at: '2013-02-27T19:35:32Z' updated_at: '2013-02-27T19:35:32Z' @@ -219583,6 +232636,36 @@ components: href: https://github.com/monalisa/my-repo/rules/42 created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' + repository-ruleset-version-with-state: + value: + version_id: 3 + actor: + id: 1 + type: User + updated_at: '2024-10-23T16:29:47Z' + state: + id: 42 + name: super cool ruleset + target: branch + source_type: Repository + source: monalisa/my-repo + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + ref_name: + include: + - refs/heads/main + - refs/heads/master + exclude: + - refs/heads/dev* + rules: + - type: commit_author_email_pattern + parameters: + operator: contains + pattern: github secret-scanning-alert-list: value: - number: 2 @@ -219662,29 +232745,37 @@ components: 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 - html_url: https://github.com/owner/repo/security/secret-scanning/1 - locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations - state: open - resolution: - resolved_at: - resolved_by: - secret_type: mailchimp_api_key - secret_type_display_name: Mailchimp API Key - secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 - push_protection_bypassed_by: - push_protection_bypassed: false - push_protection_bypassed_at: - push_protection_bypass_request_reviewer: - push_protection_bypass_request_reviewer_comment: - push_protection_bypass_request_comment: - push_protection_bypass_request_html_url: - resolution_comment: - validity: unknown - publicly_leaked: false - multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true + assigned_to: + 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 secret-scanning-alert-open: value: number: 42 @@ -219753,6 +232844,25 @@ components: validity: unknown publicly_leaked: false multi_repo: false + assigned_to: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://alambic.github.com/avatars/u/1? + 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 secret-scanning-location-list: value: - type: commit @@ -220445,13 +233555,6 @@ components: zipball_url: https://github.com/octocat/Hello-World/zipball/v0.1 tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= - tag-protection-items: - value: - - id: 2 - pattern: v1.* - tag-protection: - value: - enabled: true topic: value: names: @@ -222557,6 +235660,8 @@ components: state: active role: admin organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: [] organization: login: github id: 1 @@ -222593,6 +235698,10 @@ components: state: pending role: admin organization_url: https://api.github.com/orgs/invitocat + direct_membership: false + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -222631,6 +235740,10 @@ components: state: pending role: admin organization_url: https://api.github.com/orgs/invitocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -222669,6 +235782,10 @@ components: state: active role: admin organization_url: https://api.github.com/orgs/octocat + direct_membership: true + enterprise_teams_providing_indirect_membership: + - ent:justice-league + - ent:security-managers organization: login: github id: 1 @@ -223286,39 +236403,6 @@ components: container: tags: - 1.13.6 - project: - value: - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' repository-items-default-response: summary: Default response value: @@ -223445,21 +236529,18 @@ components: url: https://twitter.com/github ssh-signing-key-items: value: - - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 - id: 2 - url: https://api.github.com/user/keys/2 + - id: 2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' - - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 - id: 3 - url: https://api.github.com/user/keys/3 + - id: 3 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' ssh-signing-key: value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 - url: https://api.github.com/user/keys/2 + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' starred-repository-items-alternative-response-with-star-creation-timestamps: @@ -223740,20 +236821,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: false created_at: '2022-06-07T07:50:26Z' user-org-events-items: @@ -223769,25 +236841,22 @@ components: avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: false created_at: '2022-06-09T12:47:28Z' + org: + id: 9919 + login: octo-org + gravatar_id: '' + url: https://api.github.com/orgs/octo-org + avatar_url: https://avatars.githubusercontent.com/u/9919? - id: '22196946742' type: CreateEvent actor: @@ -223799,11 +236868,12 @@ components: avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 - name: octocat/Hello-World - url: https://api.github.com/repos/octocat/Hello-World + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/octo-repo payload: - ref: + ref: master ref_type: repository + full_ref: refs/heads/master master_branch: master description: pusher_type: user @@ -223811,9 +236881,9 @@ components: created_at: '2022-06-07T07:50:26Z' org: id: 9919 - login: github + login: octo-org gravatar_id: '' - url: https://api.github.com/orgs/github + url: https://api.github.com/orgs/octo-org avatar_url: https://avatars.githubusercontent.com/u/9919? user-public-events-items: value: @@ -223848,20 +236918,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-08T23:29:25Z' hovercard: @@ -223920,39 +236981,6 @@ components: html_url: https://github.com/octocat/octo-name-repo/packages/40201?version=0.2.0 metadata: package_type: rubygems - project-items-3: - value: - - owner_url: https://api.github.com/users/octocat - url: https://api.github.com/projects/1002603 - html_url: https://github.com/users/octocat/projects/1 - columns_url: https://api.github.com/projects/1002603/columns - id: 1002603 - node_id: MDc6UHJvamVjdDEwMDI2MDM= - name: My Projects - body: A board to manage my personal projects. - number: 1 - state: open - creator: - 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 - created_at: '2011-04-10T20:09:31Z' - updated_at: '2014-03-03T18:58:10Z' user-received-events-items: value: - id: '22249084964' @@ -223969,20 +236997,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22196946742' @@ -223999,19 +237018,14 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: - ref: + ref: master ref_type: repository + full_ref: refs/heads/master master_branch: master description: pusher_type: user public: false created_at: '2022-06-07T07:50:26Z' - org: - id: 9919 - login: github - gravatar_id: '' - url: https://api.github.com/orgs/github - avatar_url: https://avatars.githubusercontent.com/u/9919? user-received-public-events-items: value: - id: '22249084964' @@ -224028,20 +237042,11 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: + repository_id: 1296269 push_id: 10115855396 - size: 1 - distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd - commits: - - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 - author: - email: octocat@github.com - name: Monalisa Octocat - message: commit - distinct: true - url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22196946742' @@ -224058,19 +237063,60 @@ components: name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: - ref: + ref: master ref_type: repository + full_ref: refs/heads/master master_branch: master description: pusher_type: user public: false created_at: '2022-06-07T07:50:26Z' - org: - id: 9919 - login: github - gravatar_id: '' - url: https://api.github.com/orgs/github - avatar_url: https://avatars.githubusercontent.com/u/9919? + billing-premium-request-usage-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Copilot + sku: Copilot Premium Request + model: GPT-5 + unitType: requests + pricePerUnit: 0.04 + grossQuantity: 100 + grossAmount: 4.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 100 + netAmount: 4.0 + billing-usage-report-user: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + repositoryName: user/example + billing-usage-summary-report-user: + value: + timePeriod: + year: 2025 + user: monalisa + usageItems: + - product: Actions + sku: actions_linux + unitType: minutes + pricePerUnit: 0.008 + grossQuantity: 1000 + grossAmount: 8.0 + discountQuantity: 0 + discountAmount: 0.0 + netQuantity: 1000 + netAmount: 8.0 check-run-completed: value: action: completed @@ -224179,7 +237225,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -224230,7 +237275,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -224474,7 +237518,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -224525,7 +237568,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -224757,7 +237799,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -224808,7 +237849,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -225065,7 +238105,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' @@ -225116,7 +238155,6 @@ components: repository_hooks: write repository_projects: write statuses: write - team_discussions: write vulnerability_alerts: read events: [] pull_requests: @@ -225655,8 +238693,7 @@ components: type: integer enterprise: name: enterprise - description: The slug version of the enterprise name. You can also substitute - this value with the enterprise id. + description: The slug version of the enterprise name. in: path required: true schema: @@ -225714,6 +238751,29 @@ components: Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned. schema: type: string + dependabot-alert-comma-separated-has: + name: has + in: query + description: |- + Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + dependabot-alert-comma-separated-assignees: + name: assignee + in: query + description: |- + Filter alerts by assignees. + Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users. + Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees. + schema: + type: string dependabot-alert-scope: name: scope in: query @@ -225739,100 +238799,43 @@ components: - updated - epss_percentage default: created - pagination-first: - name: first - description: |- - **Deprecated**. The number of results per page (max 100), starting from the first matching result. - This parameter must not be used in combination with `last`. - Instead, use `per_page` in combination with `after` to fetch the first page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - default: 30 - pagination-last: - name: last - description: |- - **Deprecated**. The number of results per page (max 100), starting from the last matching result. - This parameter must not be used in combination with `first`. - Instead, use `per_page` in combination with `before` to fetch the last page of results. - in: query - required: false - schema: - type: integer - minimum: 1 - maximum: 100 - secret-scanning-alert-state: - name: state - in: query - description: Set to `open` or `resolved` to only list secret scanning alerts - in a specific state. - required: false - schema: - type: string - enum: - - open - - resolved - secret-scanning-alert-secret-type: - name: secret_type - in: query - description: A comma-separated list of secret types to return. All default secret - patterns are returned. To return experimental patterns, pass the token name(s) - in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" - for a complete list of secret types. - required: false + enterprise-team: + name: enterprise-team + description: The slug version of the enterprise team name. You can also substitute + this value with the enterprise team id. + in: path + required: true schema: type: string - secret-scanning-alert-resolution: - name: resolution - in: query - description: A comma-separated list of resolutions. Only secret scanning alerts - with one of these resolutions are listed. Valid resolutions are `false_positive`, - `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. - required: false + username: + name: username + description: The handle for the GitHub user account. + in: path + required: true schema: type: string - secret-scanning-alert-sort: - name: sort - description: The property to sort the results by. `created` means when the alert - was created. `updated` means when the alert was updated or resolved. - in: query - required: false + org: + name: org + description: The organization name. The name is not case sensitive. + in: path + required: true schema: type: string - enum: - - created - - updated - default: created - secret-scanning-alert-validity: - name: validity - in: query - 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`. - required: false + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true 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 + public-events-per-page: + name: per_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)." 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 + type: integer + default: 15 gist-id: name: gist_id description: The unique identifier of the gist. @@ -225939,9 +238942,9 @@ components: required: false schema: type: integer - org: - name: org - description: The organization name. The name is not case sensitive. + budget: + name: budget_id + description: The ID corresponding to the budget. in: path required: true schema: @@ -225950,15 +238953,16 @@ components: name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, - `2024`. Default value is the current year. + `2025`. Default value is the current year. in: query required: false schema: type: integer - billing-usage-report-month: + billing-usage-report-month-default: name: month description: If specified, only return results for a single month. The value - of `month` is an integer between `1` and `12`. + of `month` is an integer between `1` and `12`. Default value is the current + month. If no year is specified the default `year` is used. in: query required: false schema: @@ -225966,19 +238970,71 @@ components: billing-usage-report-day: name: day description: If specified, only return results for a single day. The value of - `day` is an integer between `1` and `31`. + `day` is an integer between `1` and `31`. If no `year` or `month` is specified, + the default `year` and `month` are used. + in: query + required: false + schema: + type: integer + billing-usage-report-user: + name: user + description: The user name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-model: + name: model + description: The model name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-product: + name: product + description: The product name to query usage for. The name is not case sensitive. + in: query + required: false + schema: + type: string + billing-usage-report-month: + name: month + description: If specified, only return results for a single month. The value + of `month` is an integer between `1` and `12`. If no year is specified the + default `year` is used. in: query required: false schema: type: integer - billing-usage-report-hour: - name: hour - description: If specified, only return results for a single hour. The value - of `hour` is an integer between `0` and `23`. + billing-usage-report-repository: + name: repository + description: The repository name to query for usage in the format owner/repository. + in: query + required: false + schema: + type: string + billing-usage-report-sku: + name: sku + description: The SKU to query for usage. in: query required: false + schema: + type: string + actions-custom-image-definition-id: + name: image_definition_id + description: Image definition ID of custom image + in: path + required: true schema: type: integer + actions-custom-image-version: + name: version + description: Version of a custom image + in: path + required: true + schema: + type: string + pattern: "^\\d+\\.\\d+\\.\\d+$" hosted-runner-id: name: hosted_runner_id description: Unique identifier of the GitHub-hosted runner. @@ -226043,13 +239099,16 @@ components: required: true schema: type: string - username: - name: username - description: The handle for the GitHub user account. + subject-digest: + name: subject_digest + description: The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. in: path required: true schema: type: string + minLength: 71 + maxLength: 71 + pattern: "^sha256:[a-f0-9]{64}$" tool-name: name: tool_name description: The name of a code scanning tool. Only results by this tool will @@ -226069,6 +239128,47 @@ components: required: false schema: "$ref": "#/components/schemas/code-scanning-analysis-tool-guid" + dependabot-alert-comma-separated-artifact-registry-urls: + name: artifact_registry_url + in: query + description: A comma-separated list of artifact registry URLs. If specified, + only alerts for repositories with storage records matching these URLs will + be returned. + schema: + type: string + dependabot-alert-comma-separated-artifact-registry: + name: artifact_registry + in: query + description: |- + A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned. + + Can be: `jfrog-artifactory` + schema: + type: string + dependabot-alert-org-scope-comma-separated-has: + name: has + in: query + description: |- + Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned. + Multiple `has` filters can be passed to filter for alerts that have all of the values. + schema: + oneOf: + - type: string + - type: array + items: + type: string + enum: + - patch + - deployment + dependabot-alert-comma-separated-runtime-risk: + name: runtime_risk + in: query + description: |- + A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned. + + Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement` + schema: + type: string hook-id: name: hook_id description: The unique identifier of the hook. You can find this value in the @@ -226193,6 +239293,13 @@ components: required: true schema: type: integer + issue-type-id: + name: issue_type_id + description: The unique identifier of the issue type. + in: path + required: true + schema: + type: integer codespace-name: name: codespace_name in: path @@ -226214,13 +239321,6 @@ components: required: true schema: type: string - team-slug: - name: team_slug - description: The slug of the team name. - in: path - required: true - schema: - type: string role-id: name: role_id description: The unique identifier of the role. @@ -226332,6 +239432,17 @@ components: schema: type: string format: date-time + personal-access-token-token-id: + name: token_id + description: The ID of the token + in: query + required: false + schema: + type: array + maxItems: 50 + items: + type: string + example: token_id[]=1,token_id[]=2 fine-grained-personal-access-token-id: name: pat_id description: The unique identifier of the fine-grained personal access token. @@ -226339,6 +239450,34 @@ components: required: true schema: type: integer + project-number: + name: project_number + description: The project's number. + in: path + required: true + schema: + type: integer + field-id: + name: field_id + description: The unique identifier of the field. + in: path + required: true + schema: + type: integer + item-id: + name: item_id + description: The unique identifier of the project item. + in: path + required: true + schema: + type: integer + view-number: + name: view_number + description: The number that identifies the project view. + in: path + required: true + schema: + type: integer custom-property-name: name: custom_property_name description: The custom property name @@ -226378,7 +239517,7 @@ components: description: |- The time period to filter by. - For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours). in: query required: false schema: @@ -226398,8 +239537,8 @@ components: type: string rule-suite-result: name: rule_suite_result - description: The rule results to filter on. When specified, only suites with - this result will be returned. + description: The rule suite results to filter on. When specified, only suites + with this result will be returned. in: query schema: type: string @@ -226420,6 +239559,67 @@ components: required: true schema: type: integer + secret-scanning-alert-state: + name: state + in: query + description: Set to `open` or `resolved` to only list secret scanning alerts + in a specific state. + required: false + schema: + type: string + enum: + - open + - resolved + secret-scanning-alert-secret-type: + name: secret_type + in: query + description: A comma-separated list of secret types to return. All default secret + patterns are returned. To return generic patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" + for a complete list of secret types. + required: false + schema: + type: string + secret-scanning-alert-resolution: + name: resolution + in: query + description: A comma-separated list of resolutions. Only secret scanning alerts + with one of these resolutions are listed. Valid resolutions are `false_positive`, + `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. + required: false + schema: + type: string + secret-scanning-alert-assignee: + name: assignee + in: query + description: Filters alerts by assignee. Use `*` to get all assigned alerts, + `none` to get all unassigned alerts, or a GitHub username to get alerts assigned + to a specific user. + required: false + schema: + type: string + examples: + assigned-to-user: + value: octocat + summary: Filter for alerts assigned to the user "octocat" + all-assigned: + value: "*" + summary: Filter for all assigned alerts + all-unassigned: + value: none + summary: Filter for all unassigned alerts + secret-scanning-alert-sort: + name: sort + description: The property to sort the results by. `created` means when the alert + was created. `updated` means when the alert was updated or resolved. + in: query + required: false + schema: + type: string + enum: + - created + - updated + default: created secret-scanning-pagination-before-org-repo: name: 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). @@ -226438,6 +239638,42 @@ components: required: false schema: type: string + secret-scanning-alert-validity: + name: validity + in: query + 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`. + 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 + secret-scanning-alert-hide-secret: + name: hide_secret + in: query + description: A boolean value representing whether or not to hide literal secrets + in the results. + required: false + schema: + type: boolean + default: false network-configuration-id: name: network_configuration_id description: Unique identifier of the hosted compute network configuration. @@ -226452,34 +239688,6 @@ components: required: true schema: type: string - discussion-number: - name: discussion_number - description: The number that identifies the discussion. - in: path - required: true - schema: - type: integer - comment-number: - name: comment_number - description: The number that identifies the comment. - in: path - required: true - schema: - type: integer - reaction-id: - name: reaction_id - description: The unique identifier of the reaction. - in: path - required: true - schema: - type: integer - project-id: - name: project_id - description: The unique identifier of the project. - in: path - required: true - schema: - type: integer security-product: name: security_product in: path @@ -226509,20 +239717,6 @@ components: enum: - enable_all - disable_all - card-id: - name: card_id - description: The unique identifier of the card. - in: path - required: true - schema: - type: integer - column-id: - name: column_id - description: The unique identifier of the column. - in: path - required: true - schema: - type: integer artifact-name: name: name description: The name field of an artifact. When specified, only artifacts with @@ -226768,6 +239962,13 @@ components: required: true schema: "$ref": "#/components/schemas/alert-number" + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer commit-sha: name: commit_sha description: The SHA of the commit. @@ -226917,13 +240118,6 @@ components: required: true schema: type: integer - tag-protection-id: - name: tag_protection_id - description: The unique identifier of the tag protection. - in: path - required: true - schema: - type: integer per: name: per description: The time frame to display results for. @@ -226956,6 +240150,15 @@ components: - desc - asc default: desc + issues-advanced-search: + name: advanced_search + description: |- + Set to `true` to use advanced search. + Example: `http://api.github.com/search/issues?q={query}&advanced_search=true` + in: query + required: false + schema: + type: string team-id: name: team_id description: The unique identifier of the team. @@ -227022,6 +240225,13 @@ components: - created - updated default: created + user-id: + name: user_id + description: The unique identifier of the user. + in: path + required: true + schema: + type: string responses: validation_failed_simple: description: Validation failed, or the endpoint has been spammed. @@ -227073,6 +240283,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" conflict: description: Conflict content: @@ -227121,6 +240337,42 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + get_all_budgets: + description: Response when getting all budgets + content: + application/json: + schema: + "$ref": "#/components/schemas/get_all_budgets" + examples: + default: + "$ref": "#/components/examples/get_all_budgets" + budget: + description: Response when updating a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/get-budget" + examples: + default: + "$ref": "#/components/examples/get-budget" + delete-budget: + description: Response when deleting a budget + content: + application/json: + schema: + "$ref": "#/components/schemas/delete-budget" + examples: + default: + "$ref": "#/components/examples/delete-budget" + billing_premium_request_usage_report_org: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-premium-request-usage-report-org" + examples: + default: + "$ref": "#/components/examples/billing-premium-request-usage-report-org" billing_usage_report_org: description: Billing usage report response for an organization content: @@ -227130,12 +240382,15 @@ components: examples: default: "$ref": "#/components/examples/billing-usage-report" - internal_error: - description: Internal Error + billing_usage_summary_report_org: + description: Response when getting a billing usage summary content: application/json: schema: - "$ref": "#/components/schemas/basic-error" + "$ref": "#/components/schemas/billing-usage-summary-report-org" + examples: + default: + "$ref": "#/components/examples/billing-usage-summary-report-org" actions_runner_jitconfig: description: Response content: @@ -227192,6 +240447,12 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" + too_large: + description: Payload Too Large + content: + 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. @@ -227202,14 +240463,17 @@ components: package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. - gone: - description: Gone + enterprise_team_unsupported: + description: Unprocessable entity if you attempt to modify an enterprise team + at the organization level. + temporary_redirect: + description: Temporary Redirect content: application/json: schema: "$ref": "#/components/schemas/basic-error" - temporary_redirect: - description: Temporary Redirect + gone: + description: Gone content: application/json: schema: @@ -227243,6 +240507,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + unprocessable_analysis: + description: Response if analysis could not be processed + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" found: description: Found code_scanning_conflict: @@ -227252,8 +240522,16 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + code_scanning_invalid_state: + description: Response if the configuration change cannot be made because the + repository is not in the required state + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" dependency_review_forbidden: - description: Response if GitHub Advanced Security is not enabled for this repository + description: Response for a private repository when GitHub Advanced Security + is not enabled, or if used against a fork content: application/json: schema: @@ -227270,6 +240548,33 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + billing_premium_request_usage_report_user: + description: Response when getting a billing premium request usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-premium-request-usage-report-user" + examples: + default: + "$ref": "#/components/examples/billing-premium-request-usage-report-user" + billing_usage_report_user: + description: Response when getting a billing usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-report-user" + examples: + default: + "$ref": "#/components/examples/billing-usage-report-user" + billing_usage_summary_report_user: + description: Response when getting a billing usage summary + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-summary-report-user" + examples: + default: + "$ref": "#/components/examples/billing-usage-summary-report-user" headers: link: example: ; rel="next", ; diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index 934a34ee5..a72fc00cc 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -128,7 +128,7 @@ export interface paths { * *

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.

+ *

Live-mode accounts that have access to the standard dashboard and Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. All other Live-mode 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.

*/ @@ -721,6 +721,32 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/balance_settings": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve balance settings + * @description

Retrieves balance settings for a given connected account. + * Related guide: Making API calls for connected accounts

+ */ + get: operations["GetBalanceSettings"]; + put?: never; + /** + * Update balance settings + * @description

Updates balance settings for a given connected account. + * Related guide: Making API calls for connected accounts

+ */ + post: operations["PostBalanceSettings"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/balance_transactions": { parameters: { query?: never; @@ -1458,8 +1484,8 @@ export interface paths { get: operations["GetCheckoutSessions"]; put?: never; /** - * Create a Session - * @description

Creates a Session object.

+ * Create a Checkout Session + * @description

Creates a Checkout Session object.

*/ post: operations["PostCheckoutSessions"]; delete?: never; @@ -1476,14 +1502,16 @@ export interface paths { cookie?: never; }; /** - * Retrieve a Session - * @description

Retrieves a Session object.

+ * Retrieve a Checkout Session + * @description

Retrieves a Checkout Session object.

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

Updates a Session object.

+ * Update a Checkout Session + * @description

Updates a Checkout Session object.

+ * + *

Related guide: Dynamically update a Checkout Session

*/ post: operations["PostCheckoutSessionsSession"]; delete?: never; @@ -1502,10 +1530,10 @@ export interface paths { get?: never; put?: never; /** - * Expire a Session - * @description

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

+ * Expire a Checkout Session + * @description

A Checkout 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 Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.

*/ post: operations["PostCheckoutSessionsSessionExpire"]; delete?: never; @@ -1816,20 +1844,19 @@ export interface paths { put?: never; /** * 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:

+ * @description

Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero. + * This amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:

* *
    - *
  • Refund: create a new refund (using refund_amount) or link an existing refund (using refund).
    • + *
  • Refunds: create a new refund (using refund_amount) or link existing refunds (using refunds).
    • *
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their next invoice when it’s finalized.
    • *
  • Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out_of_band_amount).
    • *
* - *

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

+ *

The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.

* - *

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.

+ *

You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount, + * post_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.

*/ post: operations["PostCreditNotes"]; delete?: never; @@ -2024,7 +2051,7 @@ export interface paths { put?: never; /** * 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.

+ * @description

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided are left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (such as 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 is retried. This retry doesn’t count as an automatic retry, and doesn’t affect the next regularly scheduled payment for the invoice. Changing the default_source for a customer doesn’t trigger this behavior.

* *

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

*/ @@ -2801,7 +2828,9 @@ export interface paths { }; /** * 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.

+ * @description

[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API instead.

+ * + *

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; @@ -2821,7 +2850,9 @@ export interface paths { }; /** * Retrieve an exchange rate - * @description

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

+ * @description

[Deprecated] The ExchangeRate APIs are deprecated. Please use the FX Quotes API instead.

+ * + *

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

*/ get: operations["GetExchangeRatesRateId"]; put?: never; @@ -2832,6 +2863,32 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/external_accounts/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * @description

Updates the metadata, account holder name, account holder type of a bank account belonging to + * a connected account and optionally sets it as the default for its currency. Other bank account + * details are not editable by design.

+ * + *

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

+ * + *

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

+ */ + post: operations["PostExternalAccountsId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/file_links": { parameters: { query?: never; @@ -3037,7 +3094,7 @@ export interface paths { put?: never; /** * Subscribe to data refreshes for an Account - * @description

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

+ * @description

Subscribes to periodic refreshes of data associated with a Financial Connections Account. When the account status is active, data is typically refreshed once a day.

*/ post: operations["PostFinancialConnectionsAccountsAccountSubscribe"]; delete?: never; @@ -3350,6 +3407,46 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoice_payments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List all payments for an invoice + * @description

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

+ */ + get: operations["GetInvoicePayments"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/invoice_payments/{invoice_payment}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve an InvoicePayment + * @description

Retrieves the invoice payment with the given ID.

+ */ + get: operations["GetInvoicePaymentsInvoicePayment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoice_rendering_templates": { parameters: { query?: never; @@ -3497,7 +3594,7 @@ export interface paths { put?: never; /** * 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.

+ * @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; @@ -3517,11 +3614,13 @@ export interface paths { put?: never; /** * 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.

+ * @description

At any time, you can preview the upcoming invoice for a subscription or subscription schedule. 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 also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that 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.

* - *

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.

+ *

The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.

+ * + *

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.

* *

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

*/ @@ -3555,52 +3654,6 @@ export interface paths { patch?: never; trace?: never; }; - "/v1/invoices/upcoming": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * 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

- */ - get: operations["GetInvoicesUpcoming"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v1/invoices/upcoming/lines": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * 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; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/v1/invoices/{invoice}": { parameters: { query?: never; @@ -3654,6 +3707,35 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoices/{invoice}/attach_payment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Attach a payment to an Invoice + * @description

Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.

+ * + *

For the PaymentIntent, when the PaymentIntent’s status changes to succeeded, the payment is credited + * to the invoice, increasing its amount_paid. When the invoice is fully paid, the + * invoice’s status becomes paid.

+ * + *

If the PaymentIntent’s status is already succeeded when it’s attached, it’s + * credited to the invoice immediately.

+ * + *

See: Partial payments to learn more.

+ */ + post: operations["PostInvoicesInvoiceAttachPayment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoices/{invoice}/finalize": { parameters: { query?: never; @@ -4453,6 +4535,46 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/payment_attempt_records": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List Payment Attempt Records + * @description

List all the Payment Attempt Records attached to the specified Payment Record.

+ */ + get: operations["GetPaymentAttemptRecords"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_attempt_records/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve a Payment Attempt Record + * @description

Retrieves a Payment Attempt Record with the given ID

+ */ + get: operations["GetPaymentAttemptRecordsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/payment_intents": { parameters: { query?: never; @@ -4543,6 +4665,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/payment_intents/{intent}/amount_details_line_items": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List all PaymentIntent LineItems + * @description

Lists all LineItems of a given PaymentIntent.

+ */ + get: operations["GetPaymentIntentsIntentAmountDetailsLineItems"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/payment_intents/{intent}/apply_customer_balance": { parameters: { query?: never; @@ -4624,27 +4766,32 @@ export interface paths { * 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 + * a payment.

+ * + *

If the selected payment method requires additional authentication steps, the * PaymentIntent will transition to the requires_action status and * suggest additional actions via next_action. If payment fails, * the PaymentIntent transitions to the requires_payment_method status or the * canceled status if the confirmation limit is reached. If * payment succeeds, the PaymentIntent will transition to the succeeded - * status (or requires_capture, if capture_method is set to manual). - * If the confirmation_method is automatic, payment may be attempted + * status (or requires_capture, if capture_method is set to manual).

+ * + *

If the confirmation_method is automatic, payment may be attempted * using our client SDKs * and the PaymentIntent’s client_secret. * After next_actions are handled by the client, no additional - * confirmation is required to complete the payment. - * If the confirmation_method is manual, all payment attempts must be - * initiated using a secret key. - * If any actions are required for the payment, the PaymentIntent will + * confirmation is required to complete the payment.

+ * + *

If the confirmation_method is manual, all payment attempts must be + * initiated using a secret key.

+ * + *

If any actions are required for the payment, the PaymentIntent will * return to the requires_confirmation state * after those actions are completed. Your server needs to then * explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. - * There is a variable upper limit on how many times a PaymentIntent can be confirmed. + * 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.

*/ @@ -4893,10 +5040,10 @@ export interface paths { put?: never; /** * 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.

+ * @description

Some payment methods might require additional steps to register 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 or Embedded Checkout 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.

+ *

To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.

* *

Related guides: Payment method domains.

*/ @@ -4916,7 +5063,7 @@ export interface paths { }; /** * 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.

+ * @description

Returns a list of all PaymentMethods.

*/ get: operations["GetPaymentMethods"]; put?: never; @@ -4948,7 +5095,7 @@ export interface paths { put?: never; /** * Update a PaymentMethod - * @description

Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.

+ * @description

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

*/ post: operations["PostPaymentMethodsPaymentMethod"]; delete?: never; @@ -5009,6 +5156,173 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/payment_records/report_payment": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report a payment + * @description

Report a new Payment Record. You may report a Payment Record as it is + * initialized and later report updates through the other report_* methods, or report Payment + * Records in a terminal state directly, through this method.

+ */ + post: operations["PostPaymentRecordsReportPayment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve a Payment Record + * @description

Retrieves a Payment Record with the given ID

+ */ + get: operations["GetPaymentRecordsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}/report_payment_attempt": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report a payment attempt + * @description

Report a new payment attempt on the specified Payment Record. A new payment + * attempt can only be specified if all other payment attempts are canceled or failed.

+ */ + post: operations["PostPaymentRecordsIdReportPaymentAttempt"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}/report_payment_attempt_canceled": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report payment attempt canceled + * @description

Report that the most recent payment attempt on the specified Payment Record + * was canceled.

+ */ + post: operations["PostPaymentRecordsIdReportPaymentAttemptCanceled"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}/report_payment_attempt_failed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report payment attempt failed + * @description

Report that the most recent payment attempt on the specified Payment Record + * failed or errored.

+ */ + post: operations["PostPaymentRecordsIdReportPaymentAttemptFailed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}/report_payment_attempt_guaranteed": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report payment attempt guaranteed + * @description

Report that the most recent payment attempt on the specified Payment Record + * was guaranteed.

+ */ + post: operations["PostPaymentRecordsIdReportPaymentAttemptGuaranteed"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}/report_payment_attempt_informational": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report payment attempt informational + * @description

Report informational updates on the specified Payment Record.

+ */ + post: operations["PostPaymentRecordsIdReportPaymentAttemptInformational"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/payment_records/{id}/report_refund": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Report a refund + * @description

Report that the most recent payment attempt on the specified Payment Record + * was refunded.

+ */ + post: operations["PostPaymentRecordsIdReportRefund"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/payouts": { parameters: { query?: never; @@ -5092,7 +5406,7 @@ export interface paths { put?: never; /** * 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.

+ * @description

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US and Canadian 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.

*/ @@ -5170,7 +5484,7 @@ export interface paths { put?: never; /** * Create a price - * @description

Creates a new price for an existing product. The price can be recurring or one-time.

+ * @description

Creates a new Price for an existing Product. The Price can be recurring or one-time.

*/ post: operations["PostPrices"]; delete?: never; @@ -5364,7 +5678,7 @@ export interface paths { put?: never; /** * 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.

+ * @description

A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.

*/ post: operations["PostPromotionCodes"]; delete?: never; @@ -5607,6 +5921,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/radar/payment_evaluations": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a Payment Evaluation + * @description

Request a Radar API fraud risk score from Stripe for a payment before sending it for external processor authorization.

+ */ + post: operations["PostRadarPaymentEvaluations"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/radar/value_list_items": { parameters: { query?: never; @@ -6131,6 +6465,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/sigma/saved_queries/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Update an existing Sigma Query + * @description

Update an existing Sigma query that previously exists

+ */ + post: operations["PostSigmaSavedQueriesId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/sigma/scheduled_query_runs": { parameters: { query?: never; @@ -6343,54 +6697,6 @@ export interface paths { patch?: never; trace?: never; }; - "/v1/subscription_items/{subscription_item}/usage_record_summaries": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * 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.

- */ - get: operations["GetSubscriptionItemsSubscriptionItemUsageRecordSummaries"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/v1/subscription_items/{subscription_item}/usage_records": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - get?: never; - put?: never; - /** - * 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.

- */ - post: operations["PostSubscriptionItemsSubscriptionItemUsageRecords"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; "/v1/subscription_schedules": { parameters: { query?: never; @@ -6574,7 +6880,7 @@ export interface paths { * 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.

* - *

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.

+ *

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 if invoice_now and prorate are both set to true.

* *

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.

*/ @@ -6604,6 +6910,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/subscriptions/{subscription}/migrate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Migrate a subscription + * @description

Upgrade the billing_mode of an existing subscription.

+ */ + post: operations["PostSubscriptionsSubscriptionMigrate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/subscriptions/{subscription}/resume": { parameters: { query?: never; @@ -6615,7 +6941,7 @@ export interface paths { put?: never; /** * 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.

+ * @description

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. If no resumption invoice is generated, the subscription becomes active immediately. If a resumption invoice is generated, the subscription remains paused until the invoice is paid or marked uncollectible. If the invoice is not paid by the expiration date, it is voided and the subscription remains paused.

*/ post: operations["PostSubscriptionsSubscriptionResume"]; delete?: never; @@ -6624,6 +6950,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/tax/associations/find": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Find a Tax Association + * @description

Finds a tax association object by PaymentIntent id.

+ */ + get: operations["GetTaxAssociationsFind"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/tax/calculations": { parameters: { query?: never; @@ -7099,6 +7445,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/terminal/onboarding_links": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create an Onboarding Link + * @description

Creates a new OnboardingLink object that contains a redirect_url used for onboarding onto Tap to Pay on iPhone.

+ */ + post: operations["PostTerminalOnboardingLinks"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/terminal/readers": { parameters: { query?: never; @@ -7162,7 +7528,7 @@ export interface paths { put?: never; /** * Cancel the current reader action - * @description

Cancels the current reader action.

+ * @description

Cancels the current reader action. See Programmatic Cancellation for more details.

*/ post: operations["PostTerminalReadersReaderCancelAction"]; delete?: never; @@ -7171,6 +7537,66 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/terminal/readers/{reader}/collect_inputs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Collect inputs using a Reader + * @description

Initiates an input collection flow on a Reader to display input forms and collect information from your customers.

+ */ + post: operations["PostTerminalReadersReaderCollectInputs"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/terminal/readers/{reader}/collect_payment_method": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Hand off a PaymentIntent to a Reader and collect card details + * @description

Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See Collecting a Payment method for more details.

+ */ + post: operations["PostTerminalReadersReaderCollectPaymentMethod"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/terminal/readers/{reader}/confirm_payment_intent": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Confirm a PaymentIntent on the Reader + * @description

Finalizes a payment on a Reader. See Confirming a Payment for more details.

+ */ + post: operations["PostTerminalReadersReaderConfirmPaymentIntent"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/terminal/readers/{reader}/process_payment_intent": { parameters: { query?: never; @@ -7182,7 +7608,7 @@ export interface paths { put?: never; /** * Hand-off a PaymentIntent to a Reader - * @description

Initiates a payment flow on a Reader.

+ * @description

Initiates a payment flow on a Reader. See process the payment for more details.

*/ post: operations["PostTerminalReadersReaderProcessPaymentIntent"]; delete?: never; @@ -7202,7 +7628,7 @@ export interface paths { put?: never; /** * Hand-off a SetupIntent to a Reader - * @description

Initiates a setup intent flow on a Reader.

+ * @description

Initiates a SetupIntent flow on a Reader. See Save directly without charging for more details.

*/ post: operations["PostTerminalReadersReaderProcessSetupIntent"]; delete?: never; @@ -7222,7 +7648,7 @@ export interface paths { put?: never; /** * Refund a Charge or a PaymentIntent in-person - * @description

Initiates a refund on a Reader

+ * @description

Initiates an in-person refund on a Reader. See Refund an Interac Payment for more details.

*/ post: operations["PostTerminalReadersReaderRefundPayment"]; delete?: never; @@ -7242,7 +7668,7 @@ export interface paths { put?: never; /** * Set reader display - * @description

Sets reader display to show cart details.

+ * @description

Sets the reader display to show cart details.

*/ post: operations["PostTerminalReadersReaderSetReaderDisplay"]; delete?: never; @@ -7251,6 +7677,29 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/terminal/refunds": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a refund using a Terminal-supported device. + * @description

Internal endpoint for terminal use to create a refund for a card_present charge. + * This endpoint only supports card_present payment method types (excludes interac_present).

+ * + *

You can optionally refund only part of a charge.

+ */ + post: operations["PostTerminalRefunds"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/confirmation_tokens": { parameters: { query?: never; @@ -7601,7 +8050,7 @@ export interface paths { get?: never; put?: never; /** - * Create a test-mode settleemnt + * Create a test-mode settlement * @description

Allows the user to create an Issuing settlement.

*/ post: operations["PostTestHelpersIssuingSettlements"]; @@ -7611,6 +8060,26 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/settlements/{settlement}/complete": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Complete a test-mode settlement + * @description

Allows the user to mark an Issuing settlement as complete.

+ */ + post: operations["PostTestHelpersIssuingSettlementsSettlementComplete"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/transactions/create_force_capture": { parameters: { query?: never; @@ -7711,6 +8180,46 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Simulate a successful input collection + * @description

Use this endpoint to trigger a successful input collection on a simulated reader.

+ */ + post: operations["PostTestHelpersTerminalReadersReaderSucceedInputCollection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Simulate an input collection timeout + * @description

Use this endpoint to complete an input collection with a timeout error on a simulated reader.

+ */ + post: operations["PostTestHelpersTerminalReadersReaderTimeoutInputCollection"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/test_clocks": { parameters: { query?: never; @@ -8355,7 +8864,7 @@ export interface paths { put?: never; /** * Create a FinancialAccount - * @description

Creates a new FinancialAccount. For now, each connected account can only have one FinancialAccount.

+ * @description

Creates a new FinancialAccount. Each connected account can have up to three FinancialAccounts by default.

*/ post: operations["PostTreasuryFinancialAccounts"]; delete?: never; @@ -8859,7 +9368,7 @@ export interface components { /** @description Business information about the account. */ business_profile?: components["schemas"]["account_business_profile"] | null; /** - * @description The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + * @description The business type. * @enum {string|null} */ business_type?: "company" | "government_entity" | "individual" | "non_profit" | null; @@ -8904,7 +9413,7 @@ export interface components { /** @description Unique identifier for the object. */ id: string; individual?: components["schemas"]["person"]; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -8963,6 +9472,8 @@ export interface components { estimated_worker_count?: number | null; /** @description [The merchant category code for the account](/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ mcc?: string | null; + /** @description Whether the business is a minority-owned, women-owned, and/or LGBTQI+ -owned business. */ + minority_owned_business_designation?: ("lgbtqi_owned_business" | "minority_owned_business" | "none_of_these_apply" | "prefer_not_to_answer" | "women_owned_business")[] | null; monthly_estimated_revenue?: components["schemas"]["account_monthly_estimated_revenue"]; /** @description The customer-facing business name. */ name?: string | null; @@ -9026,6 +9537,11 @@ export interface components { * @enum {string} */ bank_transfer_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the Billie capability of the account, or whether the account can directly process Billie payments. + * @enum {string} + */ + billie_payments?: "active" | "inactive" | "pending"; /** * @description The status of the blik payments capability of the account, or whether the account can directly process blik charges. * @enum {string} @@ -9056,6 +9572,11 @@ export interface components { * @enum {string} */ cashapp_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the Crypto capability of the account, or whether the account can directly process Crypto payments. + * @enum {string} + */ + crypto_payments?: "active" | "inactive" | "pending"; /** * @description The status of the EPS payments capability of the account, or whether the account can directly process EPS charges. * @enum {string} @@ -9131,6 +9652,11 @@ export interface components { * @enum {string} */ link_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the MB WAY payments capability of the account, or whether the account can directly process MB WAY charges. + * @enum {string} + */ + mb_way_payments?: "active" | "inactive" | "pending"; /** * @description The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges. * @enum {string} @@ -9151,6 +9677,11 @@ export interface components { * @enum {string} */ naver_pay_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the New Zealand BECS Direct Debit payments capability of the account, or whether the account can directly process New Zealand BECS Direct Debit charges. + * @enum {string} + */ + nz_bank_account_becs_debit_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} @@ -9176,6 +9707,16 @@ export interface components { * @enum {string} */ paynow_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the PayTo capability of the account, or whether the account can directly process PayTo charges. + * @enum {string} + */ + payto_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the pix payments capability of the account, or whether the account can directly process pix charges. + * @enum {string} + */ + pix_payments?: "active" | "inactive" | "pending"; /** * @description The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges. * @enum {string} @@ -9191,6 +9732,11 @@ export interface components { * @enum {string} */ samsung_pay_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the Satispay capability of the account, or whether the account can directly process Satispay payments. + * @enum {string} + */ + satispay_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} @@ -9254,52 +9800,52 @@ export interface components { }; /** AccountCapabilityFutureRequirements */ account_capability_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** @description Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields. */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning. */ current_deadline?: number | null; - /** @description Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ + /** @description Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due: string[]; /** * @description This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account. * @enum {string|null} */ disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors: components["schemas"]["account_requirements_error"][]; /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ eventually_due: string[]; - /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /** @description Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. */ past_due: string[]; - /** @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. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. */ pending_verification: string[]; }; /** AccountCapabilityRequirements */ account_capability_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** @description Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields. */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time - * @description Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected. + * @description The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested. */ current_deadline?: number | null; - /** @description Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ + /** @description Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled. */ currently_due: string[]; /** - * @description Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). + * @description Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification). * @enum {string|null} */ disabled_reason?: "other" | "paused.inactivity" | "pending.onboarding" | "pending.review" | "platform_disabled" | "platform_paused" | "rejected.inactivity" | "rejected.other" | "rejected.unsupported_business" | "requirements.fields_needed" | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors: components["schemas"]["account_requirements_error"][]; /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ eventually_due: string[]; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account. */ + /** @description Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account. */ past_due: string[]; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. */ pending_verification: string[]; }; /** AccountCardIssuingSettings */ @@ -9332,45 +9878,50 @@ export interface components { }; /** AccountFutureRequirements */ account_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** @description Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time * @description Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning. */ 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. */ + /** @description Fields that need to be resolved to keep the account enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. */ currently_due?: 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. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors?: components["schemas"]["account_requirements_error"][] | null; /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well. */ eventually_due?: string[] | null; - /** @description Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /** @description Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`. */ past_due?: string[] | null; - /** @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. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another 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. */ + /** @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://docs.stripe.com/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. */ default_account_tax_ids?: (string | components["schemas"]["tax_id"])[] | null; + /** + * @description Whether to save the payment method after a payment is completed for a one-time invoice or a subscription invoice when the customer already has a default payment method on the hosted invoice page. + * @enum {string|null} + */ + hosted_payment_method_save?: "always" | "never" | "offer" | null; }; /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access * Stripe-hosted applications, such as Connect Onboarding. * - * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding) + * Related guide: [Connect Onboarding](https://docs.stripe.com/connect/custom/hosted-onboarding) */ account_link: { /** @@ -9409,10 +9960,6 @@ export interface components { statement_descriptor_kana?: string | null; /** @description The Kanji variation of `statement_descriptor` used for charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ statement_descriptor_kanji?: string | null; - /** @description The Kana variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ - statement_descriptor_prefix_kana?: string | null; - /** @description The Kanji variation of `statement_descriptor_prefix` used for card charges in Japan. Japanese statement descriptors have [special requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). */ - statement_descriptor_prefix_kanji?: string | null; }; /** AccountPayoutSettings */ account_payout_settings: { @@ -9424,34 +9971,34 @@ export interface components { }; /** AccountRequirements */ account_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** @description Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; /** * Format: unix-time * @description Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected. */ 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. */ + /** @description Fields that need to be resolved to keep the account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. */ currently_due?: 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). + * @description If the account is disabled, this enum describes why. [Learn more about handling verification issues](https://docs.stripe.com/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. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors?: components["schemas"]["account_requirements_error"][] | null; /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set. */ eventually_due?: string[] | null; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account. */ + /** @description Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the account. */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. */ pending_verification?: string[] | null; }; /** AccountRequirementsAlternative */ account_requirements_alternative: { - /** @description Fields that can be provided to satisfy all fields in `original_fields_due`. */ + /** @description Fields that can be provided to resolve all fields in `original_fields_due`. */ alternative_fields_due: string[]; - /** @description Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`. */ + /** @description Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. */ original_fields_due: string[]; }; /** AccountRequirementsError */ @@ -9460,7 +10007,7 @@ export interface components { * @description The code for the type of error. * @enum {string} */ - code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations" | "verification_requires_additional_proof_of_registration" | "verification_supportability"; + code: "external_request" | "information_missing" | "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_signator" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "unsupported_business_type" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_authorizer_authority" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_legal_entity_structure_mismatch" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_rejected_ownership_exemption_reason" | "verification_requires_additional_memorandum_of_associations" | "verification_requires_additional_proof_of_registration" | "verification_supportability"; /** @description An informative message that indicates the error type and provides additional details about the error. */ reason: string; /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ @@ -9479,7 +10026,7 @@ export interface components { * to your user. Do not save AccountSessions to your database as they expire relatively * quickly, and cannot be used more than once. * - * Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) + * Related guide: [Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components) */ account_session: { /** @description The ID of the account the AccountSession was created for */ @@ -9489,7 +10036,7 @@ export interface components { * * The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret. * - * Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. + * Refer to our docs to [setup Connect embedded components](https://docs.stripe.com/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. */ client_secret: string; components: components["schemas"]["connect_embedded_account_session_create_components"]; @@ -9549,7 +10096,7 @@ export interface components { /** AccountUnificationAccountController */ account_unification_account_controller: { fees?: components["schemas"]["account_unification_account_controller_fees"]; - /** @description `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. */ + /** @description `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. */ is_controller?: boolean; losses?: components["schemas"]["account_unification_account_controller_losses"]; /** @@ -9594,15 +10141,20 @@ export interface components { 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). */ + /** @description Address line 1, such as the street, PO Box, or company name. */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** @description Address line 2, such as the apartment, suite, unit, or building. */ line2?: string | null; /** @description ZIP or postal code. */ postal_code?: string | null; - /** @description State, county, province, or region. */ + /** @description State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ state?: string | null; }; + /** alma_installments */ + alma_installments: { + /** @description The number of installments. */ + count: number; + }; /** amazon_pay_underlying_payment_method_funding_details */ amazon_pay_underlying_payment_method_funding_details: { card?: components["schemas"]["payment_method_details_passthrough_card"]; @@ -9614,21 +10166,21 @@ export interface components { }; /** APIErrors */ api_errors: { - /** @description For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines) if they provide one. */ + /** @description For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. */ advice_code?: string; /** @description For card errors, the ID of the failed charge. */ charge?: string; - /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported. */ + /** @description For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.stripe.com/error-codes) reported. */ code?: string; - /** @description For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one. */ + /** @description For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. */ decline_code?: string; - /** @description A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported. */ + /** @description A URL to more information about the [error code](https://docs.stripe.com/error-codes) reported. */ doc_url?: string; /** @description A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. */ message?: string; /** @description For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error. */ network_advice_code?: string; - /** @description For card errors resulting from a card issuer decline, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + /** @description For payments declined by the network, an alphanumeric code which indicates the reason the payment failed. */ network_decline_code?: string; /** @description If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field. */ param?: string; @@ -9639,7 +10191,7 @@ export interface components { /** @description A URL to the request log entry in your dashboard. */ request_log_url?: string; setup_intent?: components["schemas"]["setup_intent"]; - /** @description The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source. */ + /** @description The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. */ source?: components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]; /** * @description The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error` @@ -9744,7 +10296,7 @@ export interface components { * * A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions. * - * Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects) + * Related guide: [Store data between page reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects) */ "apps.secret": { /** @@ -9781,10 +10333,12 @@ export interface components { * @enum {string|null} */ disabled_reason?: "finalization_requires_location_inputs" | "finalization_system_error" | null; - /** @description Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ + /** @description Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. */ enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ liability?: components["schemas"]["connect_account_reference"] | null; + /** @description The tax provider powering automatic tax. */ + provider?: string | null; /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} @@ -9796,17 +10350,12 @@ export interface components { * @description This is an object representing your Stripe balance. You can retrieve it to see * the balance currently on your Stripe account. * - * You can also retrieve the balance history, which contains a list of - * [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance - * (charges, payouts, and so forth). + * The top-level `available` and `pending` comprise your "payments balance." * - * The available and pending amounts for each currency are broken down further by - * payment source types. - * - * Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances) + * Related guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances) */ balance: { - /** @description Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. */ + /** @description Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property. */ available: components["schemas"]["balance_amount"][]; /** @description Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */ connect_reserved?: components["schemas"]["balance_amount"][]; @@ -9822,6 +10371,7 @@ export interface components { object: "balance"; /** @description Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. */ pending: components["schemas"]["balance_amount"][]; + refund_and_dispute_prefunding?: components["schemas"]["balance_detail_ungated"]; }; /** BalanceAmount */ balance_amount: { @@ -9836,11 +10386,11 @@ export interface components { }; /** BalanceAmountBySourceType */ balance_amount_by_source_type: { - /** @description Amount for bank account. */ + /** @description Amount coming from [legacy US ACH payments](https://docs.stripe.com/ach-deprecated). */ bank_account?: number; - /** @description Amount for card. */ + /** @description Amount coming from most payment methods, including cards as well as [non-legacy bank debits](https://docs.stripe.com/payments/bank-debits). */ card?: number; - /** @description Amount for FPX. */ + /** @description Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a Malaysian payment method. */ fpx?: number; }; /** BalanceAmountNet */ @@ -9861,6 +10411,13 @@ export interface components { /** @description Funds that are available for use. */ available: components["schemas"]["balance_amount"][]; }; + /** BalanceDetailUngated */ + balance_detail_ungated: { + /** @description Funds that are available for use. */ + available: components["schemas"]["balance_amount"][]; + /** @description Funds that are pending */ + pending: components["schemas"]["balance_amount"][]; + }; /** BalanceNetAvailable */ balance_net_available: { /** @description Net balance amount, subtracting fees from platform-set pricing. */ @@ -9869,12 +10426,67 @@ export interface components { destination: string; source_types?: components["schemas"]["balance_amount_by_source_type"]; }; + /** + * BalanceSettingsResourceBalanceSettings + * @description Options for customizing account balances and payout settings for a Stripe platform’s connected accounts. + */ + balance_settings: { + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "balance_settings"; + payments: components["schemas"]["balance_settings_resource_payments"]; + }; + /** BalanceSettingsResourcePayments */ + balance_settings_resource_payments: { + /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. */ + debit_negative_balances?: boolean | null; + /** @description Settings specific to the account's payouts. */ + payouts?: components["schemas"]["balance_settings_resource_payouts"] | null; + settlement_timing: components["schemas"]["balance_settings_resource_settlement_timing"]; + }; + /** BalanceSettingsResourcePayoutSchedule */ + balance_settings_resource_payout_schedule: { + /** + * @description How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`. + * @enum {string|null} + */ + interval?: "daily" | "manual" | "monthly" | "weekly" | null; + /** @description The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. */ + monthly_payout_days?: number[]; + /** @description The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly. */ + weekly_payout_days?: ("friday" | "monday" | "thursday" | "tuesday" | "wednesday")[]; + }; + /** BalanceSettingsResourcePayouts */ + balance_settings_resource_payouts: { + /** @description The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts). */ + minimum_balance_by_currency?: { + [key: string]: number; + } | null; + /** @description Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details. */ + schedule?: components["schemas"]["balance_settings_resource_payout_schedule"] | null; + /** @description The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. */ + statement_descriptor?: string | null; + /** + * @description Whether the funds in this account can be paid out. + * @enum {string} + */ + status: "disabled" | "enabled"; + }; + /** BalanceSettingsResourceSettlementTiming */ + balance_settings_resource_settlement_timing: { + /** @description The number of days charge funds are held before becoming available. */ + delay_days: number; + /** @description The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account. */ + delay_days_override?: number; + }; /** * BalanceTransaction * @description Balance transactions represent funds moving through your Stripe account. * Stripe creates them for every type of transaction that enters or leaves your Stripe account balance. * - * Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types) + * Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types) */ balance_transaction: { /** @description Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. */ @@ -9884,6 +10496,11 @@ export interface components { * @description The date that the transaction's net funds become available in the Stripe balance. */ available_on: number; + /** + * @description The balance that this transaction impacts. + * @enum {string} + */ + balance_type: "issuing" | "payments" | "refund_and_dispute_prefunding" | "risk_reserved"; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -9918,10 +10535,10 @@ export interface components { /** @description The transaction's net funds status in the Stripe balance, which are either `available` or `pending`. */ status: string; /** - * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. + * @description Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. * @enum {string} */ - type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_outbound" | "obligation_reversal_inbound" | "payment" | "payment_failure_refund" | "payment_network_reserve_hold" | "payment_network_reserve_release" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "payout_minimum_balance_hold" | "payout_minimum_balance_release" | "refund" | "refund_failure" | "reserve_transaction" | "reserved_funds" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; + type: "adjustment" | "advance" | "advance_funding" | "anticipation_repayment" | "application_fee" | "application_fee_refund" | "charge" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_outbound" | "obligation_reversal_inbound" | "payment" | "payment_failure_refund" | "payment_network_reserve_hold" | "payment_network_reserve_release" | "payment_refund" | "payment_reversal" | "payment_unreconciled" | "payout" | "payout_cancel" | "payout_failure" | "payout_minimum_balance_hold" | "payout_minimum_balance_release" | "refund" | "refund_failure" | "reserve_hold" | "reserve_release" | "reserve_transaction" | "reserved_funds" | "stripe_balance_payment_debit" | "stripe_balance_payment_debit_reversal" | "stripe_fee" | "stripe_fx_fee" | "tax_fee" | "topup" | "topup_reversal" | "transfer" | "transfer_cancel" | "transfer_failure" | "transfer_refund"; }; /** * BankAccount @@ -9934,7 +10551,7 @@ export interface components { * Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) */ bank_account: { - /** @description The ID of the account that the bank account is associated with. */ + /** @description The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. */ account?: (string | components["schemas"]["account"]) | null; /** @description The name of the person or business that owns the bank account. */ account_holder_name?: string | null; @@ -9959,13 +10576,13 @@ export interface components { default_for_currency?: boolean | null; /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ fingerprint?: string | null; - /** @description Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. */ + /** @description Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. */ future_requirements?: components["schemas"]["external_account_requirements"] | null; /** @description Unique identifier for the object. */ id: string; /** @description The last four digits of the bank account number. */ last4: 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -9979,18 +10596,39 @@ export interface components { /** @description The routing transit number for the bank account. */ routing_number?: string | null; /** - * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. + * @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. * - * For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. + * For external accounts, possible values are `new`, `errored`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. */ status: string; }; + /** BankConnectionsResourceAccountNumberDetails */ + bank_connections_resource_account_number_details: { + /** + * Format: unix-time + * @description When the account number is expected to expire, if applicable. + */ + expected_expiry_date?: number | null; + /** + * @description The type of account number associated with the account. + * @enum {string} + */ + identifier_type: "account_number" | "tokenized_account_number"; + /** + * @description Whether the account number is currently active and usable for transactions. + * @enum {string} + */ + status: "deactivated" | "transactable"; + /** @description The payment networks that the account number can be used for. */ + supported_networks: "ach"[]; + }; /** BankConnectionsResourceAccountholder */ bank_connections_resource_accountholder: { - /** @description The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`. */ + /** @description The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`. */ account?: string | components["schemas"]["account"]; - /** @description ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`. */ + /** @description The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`. */ customer?: string | components["schemas"]["customer"]; + customer_account?: string; /** * @description Type of account holder that this account belongs to. * @enum {string} @@ -10150,7 +10788,7 @@ export interface components { status?: "active" | "archived" | "inactive" | null; /** @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). */ + /** @description Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter). */ usage_threshold?: components["schemas"]["thresholds_resource_usage_threshold_config"] | null; }; /** @@ -10162,6 +10800,8 @@ export interface components { balances: components["schemas"]["credit_balance"][]; /** @description The customer the balance is for. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description The account the balance is for. */ + customer_account?: string | null; /** @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; /** @@ -10229,6 +10869,8 @@ export interface components { created: number; /** @description ID of the customer receiving the billing credits. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description ID of the account representing the customer receiving the billing credits */ + customer_account?: string | null; /** * Format: unix-time * @description The time when the billing credits become effective-when they're eligible for use. @@ -10243,7 +10885,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -10254,6 +10896,8 @@ export interface components { * @enum {string} */ object: "billing.credit_grant"; + /** @description The priority for applying this credit grant. The highest priority is 0 and the lowest is 100. */ + priority?: number | null; /** @description ID of the test clock this credit grant belongs to. */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; /** @@ -10286,7 +10930,7 @@ export interface components { /** @description The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ event_name: string; /** - * @description The time window to pre-aggregate meter events for, if any. + * @description The time window which meter events have been pre-aggregated for, if any. * @enum {string|null} */ event_time_window?: "day" | "hour" | null; @@ -10333,7 +10977,7 @@ export interface components { * @enum {string} */ object: "billing.meter_event"; - /** @description The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ + /** @description The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes). */ payload: { [key: string]: string; }; @@ -10374,6 +11018,8 @@ export interface components { * BillingMeterEventSummary * @description A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much * usage was accrued by a customer for that period. + * + * Note: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage. */ "billing.meter_event_summary": { /** @description Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`. */ @@ -10400,6 +11046,155 @@ export interface components { */ start_time: number; }; + /** BillingBillResourceInvoiceItemParentsInvoiceItemParent */ + billing_bill_resource_invoice_item_parents_invoice_item_parent: { + /** @description Details about the subscription that generated this invoice item */ + subscription_details?: components["schemas"]["billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent"] | null; + /** + * @description The type of parent that generated this invoice item + * @enum {string} + */ + type: "subscription_details"; + }; + /** BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent */ + billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent: { + /** @description The subscription that generated this invoice item */ + subscription: string; + /** @description The subscription item that generated this invoice item */ + subscription_item?: string; + }; + /** BillingBillResourceInvoicingLinesCommonCreditedItems */ + billing_bill_resource_invoicing_lines_common_credited_items: { + /** @description Invoice containing the credited invoice line items */ + invoice: string; + /** @description Credited invoice line items */ + invoice_line_items: string[]; + }; + /** BillingBillResourceInvoicingLinesCommonProrationDetails */ + billing_bill_resource_invoicing_lines_common_proration_details: { + /** @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. */ + credited_items?: components["schemas"]["billing_bill_resource_invoicing_lines_common_credited_items"] | null; + }; + /** BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent */ + billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent: { + /** @description The invoice item that generated this line item */ + invoice_item: string; + /** @description Whether this is a proration */ + proration: boolean; + /** @description Additional details for proration line items */ + proration_details?: components["schemas"]["billing_bill_resource_invoicing_lines_common_proration_details"] | null; + /** @description The subscription that the invoice item belongs to */ + subscription?: string | null; + }; + /** BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent */ + billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent: { + /** @description Details about the invoice item that generated this line item */ + invoice_item_details?: components["schemas"]["billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent"] | null; + /** @description Details about the subscription item that generated this line item */ + subscription_item_details?: components["schemas"]["billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent"] | null; + /** + * @description The type of parent that generated this line item + * @enum {string} + */ + type: "invoice_item_details" | "subscription_item_details"; + }; + /** BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent */ + billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent: { + /** @description The invoice item that generated this line item */ + invoice_item?: string | null; + /** @description Whether this is a proration */ + proration: boolean; + /** @description Additional details for proration line items */ + proration_details?: components["schemas"]["billing_bill_resource_invoicing_lines_common_proration_details"] | null; + /** @description The subscription that the subscription item belongs to */ + subscription?: string | null; + /** @description The subscription item that generated this line item */ + subscription_item: string; + }; + /** BillingBillResourceInvoicingParentsInvoiceParent */ + billing_bill_resource_invoicing_parents_invoice_parent: { + /** @description Details about the quote that generated this invoice */ + quote_details?: components["schemas"]["billing_bill_resource_invoicing_parents_invoice_quote_parent"] | null; + /** @description Details about the subscription that generated this invoice */ + subscription_details?: components["schemas"]["billing_bill_resource_invoicing_parents_invoice_subscription_parent"] | null; + /** + * @description The type of parent that generated this invoice + * @enum {string} + */ + type: "quote_details" | "subscription_details"; + }; + /** BillingBillResourceInvoicingParentsInvoiceQuoteParent */ + billing_bill_resource_invoicing_parents_invoice_quote_parent: { + /** @description The quote that generated this invoice */ + quote: string; + }; + /** BillingBillResourceInvoicingParentsInvoiceSubscriptionParent */ + billing_bill_resource_invoicing_parents_invoice_subscription_parent: { + /** + * @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. + * *Note: This attribute is populated only for invoices created on or after June 29, 2023.* + */ + metadata?: { + [key: string]: string; + } | null; + /** @description The subscription that generated this invoice */ + subscription: string | components["schemas"]["subscription"]; + /** + * Format: unix-time + * @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. + */ + subscription_proration_date?: number; + }; + /** BillingBillResourceInvoicingPricingPricing */ + billing_bill_resource_invoicing_pricing_pricing: { + price_details?: components["schemas"]["billing_bill_resource_invoicing_pricing_pricing_price_details"]; + /** + * @description The type of the pricing details. + * @enum {string} + */ + type: "price_details"; + /** + * Format: decimal + * @description The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places. + */ + unit_amount_decimal?: string | null; + }; + /** BillingBillResourceInvoicingPricingPricingPriceDetails */ + billing_bill_resource_invoicing_pricing_pricing_price_details: { + /** @description The ID of the price this item is associated with. */ + price: string | components["schemas"]["price"]; + /** @description The ID of the product this item is associated with. */ + product: string; + }; + /** BillingBillResourceInvoicingTaxesTax */ + billing_bill_resource_invoicing_taxes_tax: { + /** @description The amount of the tax, in cents (or local equivalent). */ + amount: number; + /** + * @description Whether this tax is inclusive or exclusive. + * @enum {string} + */ + tax_behavior: "exclusive" | "inclusive"; + /** @description Additional details about the tax rate. Only present when `type` is `tax_rate_details`. */ + tax_rate_details?: components["schemas"]["billing_bill_resource_invoicing_taxes_tax_rate_details"] | null; + /** + * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. + * @enum {string} + */ + taxability_reason: "customer_exempt" | "not_available" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; + /** @description The amount on which tax is calculated, in cents (or local equivalent). */ + taxable_amount?: number | null; + /** + * @description The type of tax information. + * @enum {string} + */ + type: "tax_rate_details"; + }; + /** BillingBillResourceInvoicingTaxesTaxRateDetails */ + billing_bill_resource_invoicing_taxes_tax_rate_details: { + /** @description ID of the tax rate */ + tax_rate: string; + }; /** BillingClocksResourceStatusDetailsAdvancingStatusDetails */ billing_clocks_resource_status_details_advancing_status_details: { /** @@ -10426,6 +11221,11 @@ export interface components { billing_credit_grants_resource_applicability_config: { scope: components["schemas"]["billing_credit_grants_resource_scope"]; }; + /** BillingCreditGrantsResourceApplicablePrice */ + billing_credit_grants_resource_applicable_price: { + /** @description Unique identifier for the object. */ + id?: string | null; + }; /** BillingCreditGrantsResourceBalanceCredit */ billing_credit_grants_resource_balance_credit: { amount: components["schemas"]["billing_credit_grants_resource_amount"]; @@ -10472,10 +11272,12 @@ export interface components { /** BillingCreditGrantsResourceScope */ billing_credit_grants_resource_scope: { /** - * @description The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. + * @description The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`. * @enum {string} */ - price_type: "metered"; + price_type?: "metered"; + /** @description The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`. */ + prices?: components["schemas"]["billing_credit_grants_resource_applicable_price"][]; }; /** billing_details */ billing_details: { @@ -10487,6 +11289,8 @@ export interface components { name?: string | null; /** @description Billing phone number (including extension). */ phone?: string | null; + /** @description Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. */ + tax_id?: string | null; }; /** BillingMeterResourceAggregationSettings */ billing_meter_resource_aggregation_settings: { @@ -10494,7 +11298,7 @@ export interface components { * @description Specifies how events are aggregated. * @enum {string} */ - formula: "count" | "sum"; + formula: "count" | "last" | "sum"; }; /** BillingMeterResourceBillingMeterEventAdjustmentCancel */ billing_meter_resource_billing_meter_event_adjustment_cancel: { @@ -10526,7 +11330,7 @@ export interface components { }; /** * PortalConfiguration - * @description A portal configuration describes the functionality and behavior of a portal session. + * @description A portal configuration describes the functionality and behavior you embed in a portal session. Related guide: [Configure the customer portal](/customer-management/configure-portal). */ "billing_portal.configuration": { /** @description Whether the configuration is active and can be used to create portal sessions. */ @@ -10539,7 +11343,7 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ default_return_url?: string | null; features: components["schemas"]["portal_features"]; /** @description Unique identifier for the object. */ @@ -10549,10 +11353,12 @@ export interface components { /** @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; login_page: components["schemas"]["portal_login_page"]; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 The name of the configuration. */ + name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -10591,7 +11397,9 @@ export interface components { created: number; /** @description The ID of the customer for this session. */ customer: string; - /** @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. */ + /** @description The ID of the account for this session. */ + customer_account?: string | null; + /** @description Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. */ flow?: components["schemas"]["portal_flows_flow"] | null; /** @description Unique identifier for the object. */ id: string; @@ -10607,7 +11415,7 @@ export interface components { * @enum {string} */ object: "billing_portal.session"; - /** @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + /** @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ on_behalf_of?: string | null; /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ return_url?: string | null; @@ -10633,7 +11441,7 @@ export interface components { * AccountCapability * @description This is an object representing a capability for a Stripe account. * - * Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities) + * Related guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities) */ capability: { /** @description The account for which the capability enables functionality. */ @@ -10658,7 +11466,7 @@ export interface components { * @description The status of the capability. * @enum {string} */ - status: "active" | "disabled" | "inactive" | "pending" | "unrequested"; + status: "active" | "inactive" | "pending" | "unrequested"; }; /** * Card @@ -10666,10 +11474,9 @@ export interface components { * later. You can also store multiple debit cards on a recipient in order to * transfer to those cards later. * - * Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards) + * Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards) */ card: { - /** @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. */ account?: (string | components["schemas"]["account"]) | null; /** @description City/District/Suburb/Town/Village. */ address_city?: string | null; @@ -10694,13 +11501,13 @@ export interface components { allow_redisplay?: "always" | "limited" | "unspecified" | null; /** @description A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout. */ available_payout_methods?: ("instant" | "standard")[] | null; - /** @description Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ + /** @description Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. */ brand: string; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; /** * Format: currency - * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. + * @description Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`. */ currency?: string | null; /** @description The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead. */ @@ -10729,7 +11536,7 @@ export interface components { iin?: string; /** @description The last four digits of the card. */ last4: 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -10773,12 +11580,14 @@ export interface components { * @description A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account. */ cash_balance: { - /** @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ available?: { [key: string]: number; } | null; /** @description The ID of the customer whose cash balance this object represents. */ customer: string; + /** @description The ID of an Account representing a customer whose cash balance this object represents. */ + customer_account?: string | null; /** @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; /** @@ -10791,12 +11600,11 @@ export interface components { /** * Charge * @description The `Charge` object represents a single attempt to move money into your Stripe account. - * PaymentIntent confirmation is the most common way to create Charges, but transferring - * money to a different Stripe account through Connect also creates Charges. + * PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. * Some legacy payment flows create Charges directly, which is not recommended for new integrations. */ charge: { - /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ amount: number; /** @description Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). */ amount_captured: number; @@ -10804,9 +11612,9 @@ export interface components { amount_refunded: number; /** @description ID of the Connect application that created the charge. */ application?: (string | components["schemas"]["application"]) | null; - /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /** @description The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ + /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. */ application_fee_amount?: number | null; /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -10833,7 +11641,7 @@ export interface components { disputed: boolean; /** @description ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. */ failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes). */ + /** @description Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes). */ failure_code?: string | null; /** @description Message to user further explaining reason for charge failure if available. */ failure_message?: string | null; @@ -10841,11 +11649,9 @@ export interface components { fraud_details?: components["schemas"]["charge_fraud_details"] | null; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice this charge is for if one exists. */ - invoice?: (string | components["schemas"]["invoice"]) | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -10854,9 +11660,9 @@ export interface components { * @enum {string} */ object: "charge"; - /** @description The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /** @description The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details. */ + /** @description Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details. */ outcome?: components["schemas"]["charge_outcome"] | null; /** @description `true` if the charge succeeded, or was successfully authorized for later capture. */ paid: boolean; @@ -10866,6 +11672,7 @@ export interface components { payment_method?: string | null; /** @description Details about the payment method at the time of the transaction. */ payment_method_details?: components["schemas"]["payment_method_details"] | null; + presentment_details?: components["schemas"]["payment_flows_payment_intent_presentment_details"]; radar_options?: components["schemas"]["radar_radar_options"]; /** @description This is the email address that the receipt for this charge was sent to. */ receipt_email?: string | null; @@ -10913,9 +11720,9 @@ export interface components { status: "failed" | "pending" | "succeeded"; /** @description ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). */ transfer?: string | components["schemas"]["transfer"]; - /** @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. */ + /** @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ transfer_data?: components["schemas"]["charge_transfer_data"] | null; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. */ transfer_group?: string | null; }; /** ChargeFraudDetails */ @@ -10928,17 +11735,17 @@ export interface components { /** ChargeOutcome */ charge_outcome: { /** - * @description An enumerated value providing a more detailed explanation on [how to proceed with an error](https://stripe.com/docs/declines#retrying-issuer-declines). + * @description An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines). * @enum {string|null} */ advice_code?: "confirm_card_data" | "do_not_try_again" | "try_again_later" | null; /** @description For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. */ network_advice_code?: string | null; - /** @description For charges declined by the network, a brand specific 2, 3, or 4 digit code which indicates the reason the authorization failed. */ + /** @description For charges declined by the network, an alphanumeric code which indicates the reason the charge failed. */ network_decline_code?: string | null; - /** @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ + /** @description Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. */ network_status?: string | null; - /** @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details. */ + /** @description An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details. */ reason?: string | null; /** @description Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. */ risk_level?: string; @@ -10948,7 +11755,7 @@ export interface components { rule?: string | components["schemas"]["rule"]; /** @description A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. */ seller_message?: string | null; - /** @description Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details. */ + /** @description Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details. */ type: string; }; /** ChargeTransferData */ @@ -10961,19 +11768,19 @@ export interface components { /** * Session * @description A Checkout Session represents your customer's session as they pay for - * one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout) - * or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a + * one-time purchases or subscriptions through [Checkout](https://docs.stripe.com/payments/checkout) + * or [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a * new Session each time your customer attempts to pay. * * Once payment is successful, the Checkout Session will contain a reference - * to the [Customer](https://stripe.com/docs/api/customers), and either the successful - * [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active - * [Subscription](https://stripe.com/docs/api/subscriptions). + * to the [Customer](https://docs.stripe.com/api/customers), and either the successful + * [PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active + * [Subscription](https://docs.stripe.com/api/subscriptions). * * You can create a Checkout Session on your server and redirect to its URL * to begin Checkout. * - * Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart) + * Related guide: [Checkout quickstart](https://docs.stripe.com/checkout/quickstart) */ "checkout.session": { /** @description Settings for price localization with [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing). */ @@ -10992,6 +11799,7 @@ export interface components { * @enum {string|null} */ billing_address_collection?: "auto" | "required" | null; + branding_settings?: components["schemas"]["payment_pages_checkout_session_branding_settings"]; /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. */ cancel_url?: string | null; /** @@ -11000,8 +11808,13 @@ export interface components { * Session with your internal systems. */ client_reference_id?: string | null; - /** @description Client secret to be used when initializing Stripe.js embedded checkout. */ + /** + * @description The client secret of your Checkout Session. Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. For `ui_mode: embedded`, the client secret is to be used when initializing Stripe.js embedded checkout. + * For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end. + */ client_secret?: string | null; + /** @description Information about the customer collected within the Checkout Session. */ + collected_information?: components["schemas"]["payment_pages_checkout_session_collected_information"] | null; /** @description Results of `consent_collection` for this session. */ consent?: components["schemas"]["payment_pages_checkout_session_consent"] | null; /** @description When set, provides configuration for the Checkout Session to gather active consent from customers. */ @@ -11016,9 +11829,9 @@ export interface components { * @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 | null; - /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions */ + /** @description Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) sessions created before 2025-03-31. */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; - /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. */ custom_fields: components["schemas"]["payment_pages_checkout_session_custom_fields"][]; custom_text: components["schemas"]["payment_pages_checkout_session_custom_text"]; /** @@ -11029,6 +11842,8 @@ export interface components { * the Session was created. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The ID of the account for this Session. */ + customer_account?: string | null; /** * @description Configure whether a Checkout Session creates a Customer when the Checkout Session completes. * @enum {string|null} @@ -11046,6 +11861,8 @@ export interface components { customer_email?: string | null; /** @description List of coupons and promotion codes attached to the Checkout Session. */ discounts?: components["schemas"]["payment_pages_checkout_session_discount"][] | null; + /** @description A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). */ + excluded_payment_method_types?: string[]; /** * Format: unix-time * @description The timestamp at which the Checkout Session will expire. @@ -11081,7 +11898,7 @@ export interface components { * @enum {string|null} */ locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-GB" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW" | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -11090,12 +11907,20 @@ export interface components { * @enum {string} */ mode: "payment" | "setup" | "subscription"; + name_collection?: components["schemas"]["payment_pages_checkout_session_name_collection"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "checkout.session"; - /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /** @description The optional items presented to the customer at checkout. */ + optional_items?: components["schemas"]["payment_pages_checkout_session_optional_item"][] | null; + /** + * @description Where the user is coming from. This informs the optimizations that are applied to the session. + * @enum {string|null} + */ + origin_context?: "mobile_app" | "web" | null; + /** @description The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; /** @description The ID of the Payment Link that created this Session. */ payment_link?: (string | components["schemas"]["payment_link"]) | null; @@ -11119,26 +11944,31 @@ export interface components { * @enum {string} */ payment_status: "no_payment_required" | "paid" | "unpaid"; + /** + * @description This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. + * + * For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`. + */ + permissions?: components["schemas"]["payment_pages_checkout_session_permissions"] | null; phone_number_collection?: components["schemas"]["payment_pages_checkout_session_phone_number_collection"]; + presentment_details?: components["schemas"]["payment_flows_payment_intent_presentment_details"]; /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ recovered_from?: string | null; /** - * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; - /** @description Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. */ + /** @description Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: custom`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. */ return_url?: string; /** @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. */ saved_payment_method_options?: components["schemas"]["payment_pages_checkout_session_saved_payment_method_options"] | null; - /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead. */ + /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. */ setup_intent?: (string | components["schemas"]["setup_intent"]) | null; /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ shipping_address_collection?: components["schemas"]["payment_pages_checkout_session_shipping_address_collection"] | null; /** @description The details of the customer cost of shipping, including the customer chosen ShippingRate. */ shipping_cost?: components["schemas"]["payment_pages_checkout_session_shipping_cost"] | null; - /** @description Shipping information for this Checkout Session. */ - shipping_details?: components["schemas"]["shipping"] | null; /** @description The shipping rate options applied to this Session. */ shipping_options: components["schemas"]["payment_pages_checkout_session_shipping_option"][]; /** @@ -11153,7 +11983,7 @@ export interface components { * @enum {string|null} */ submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe" | null; - /** @description The ID of the subscription for Checkout Sessions in `subscription` mode. */ + /** @description The ID of the [Subscription](https://docs.stripe.com/api/subscriptions) 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 @@ -11167,12 +11997,14 @@ export interface components { * @description The UI mode of the Session. Defaults to `hosted`. * @enum {string|null} */ - ui_mode?: "embedded" | "hosted" | null; + ui_mode?: "custom" | "embedded" | "hosted" | null; /** - * @description The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` + * @description The URL to the Checkout Session. Applies to Checkout Sessions with `ui_mode: hosted`. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` * This value is only present when the session is active. */ url?: string | null; + /** @description Wallet-specific configuration for this Checkout Session. */ + wallet_options?: components["schemas"]["checkout_session_wallet_options"] | null; }; /** CheckoutAcssDebitMandateOptions */ checkout_acss_debit_mandate_options: { @@ -11212,6 +12044,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; /** * @description Bank account verification method. * @enum {string} @@ -11220,6 +12054,11 @@ export interface components { }; /** CheckoutAffirmPaymentMethodOptions */ checkout_affirm_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. * @@ -11234,6 +12073,11 @@ export interface components { }; /** CheckoutAfterpayClearpayPaymentMethodOptions */ checkout_afterpay_clearpay_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. * @@ -11260,8 +12104,21 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutAlmaPaymentMethodOptions */ + checkout_alma_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** CheckoutAmazonPayPaymentMethodOptions */ checkout_amazon_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. * @@ -11287,6 +12144,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; }; /** CheckoutBacsDebitPaymentMethodOptions */ checkout_bacs_debit_payment_method_options: { @@ -11302,6 +12161,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; }; /** CheckoutBancontactPaymentMethodOptions */ checkout_bancontact_payment_method_options: { @@ -11317,6 +12178,14 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutBilliePaymentMethodOptions */ + checkout_billie_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** CheckoutBoletoPaymentMethodOptions */ checkout_boleto_payment_method_options: { /** @description The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. */ @@ -11340,6 +12209,11 @@ export interface components { }; /** CheckoutCardPaymentMethodOptions */ checkout_card_payment_method_options: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; installments?: components["schemas"]["checkout_card_installments_options"]; /** * @description Request ability to [capture beyond the standard authorization validity window](/payments/extended-authorization) for this CheckoutSession. @@ -11362,10 +12236,11 @@ export interface components { */ 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. + * @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://docs.stripe.com/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://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string} */ request_three_d_secure: "any" | "automatic" | "challenge"; + restrictions?: components["schemas"]["payment_pages_private_card_payment_method_options_resource_restrictions"]; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -11384,6 +12259,11 @@ export interface components { }; /** CheckoutCashappPaymentMethodOptions */ checkout_cashapp_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. * @@ -11522,6 +12402,11 @@ export interface components { }; /** CheckoutKlarnaPaymentMethodOptions */ checkout_klarna_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. * @@ -11571,6 +12456,11 @@ export interface components { }; /** CheckoutLinkPaymentMethodOptions */ checkout_link_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. * @@ -11583,8 +12473,21 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** CheckoutLinkWalletOptions */ + checkout_link_wallet_options: { + /** + * @description Describes whether Checkout should display Link. Defaults to `auto`. + * @enum {string} + */ + display?: "auto" | "never"; + }; /** CheckoutMobilepayPaymentMethodOptions */ checkout_mobilepay_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. * @@ -11618,6 +12521,17 @@ export interface components { * @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"; }; /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { @@ -11704,13 +12618,49 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** CheckoutPaytoPaymentMethodOptions */ + checkout_payto_payment_method_options: { + mandate_options?: components["schemas"]["mandate_options_payto"]; + /** + * @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"; + }; /** CheckoutPixPaymentMethodOptions */ checkout_pix_payment_method_options: { + /** + * @description Determines if the amount includes the IOF tax. + * @enum {string} + */ + amount_includes_iof?: "always" | "never"; /** @description The number of seconds after which Pix payment will expire. */ expires_after_seconds?: number | null; + /** + * @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"; }; /** CheckoutRevolutPayPaymentMethodOptions */ checkout_revolut_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. * @@ -11731,6 +12681,14 @@ export interface components { */ capture_method?: "manual"; }; + /** CheckoutSatispayPaymentMethodOptions */ + checkout_satispay_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"]; @@ -11745,6 +12703,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; }; /** CheckoutSessionPaymentMethodOptions */ checkout_session_payment_method_options: { @@ -11752,10 +12712,12 @@ export interface components { affirm?: components["schemas"]["checkout_affirm_payment_method_options"]; afterpay_clearpay?: components["schemas"]["checkout_afterpay_clearpay_payment_method_options"]; alipay?: components["schemas"]["checkout_alipay_payment_method_options"]; + alma?: components["schemas"]["checkout_alma_payment_method_options"]; amazon_pay?: components["schemas"]["checkout_amazon_pay_payment_method_options"]; au_becs_debit?: components["schemas"]["checkout_au_becs_debit_payment_method_options"]; bacs_debit?: components["schemas"]["checkout_bacs_debit_payment_method_options"]; bancontact?: components["schemas"]["checkout_bancontact_payment_method_options"]; + billie?: components["schemas"]["checkout_billie_payment_method_options"]; boleto?: components["schemas"]["checkout_boleto_payment_method_options"]; card?: components["schemas"]["checkout_card_payment_method_options"]; cashapp?: components["schemas"]["checkout_cashapp_payment_method_options"]; @@ -11778,14 +12740,21 @@ export interface components { payco?: components["schemas"]["checkout_payco_payment_method_options"]; paynow?: components["schemas"]["checkout_paynow_payment_method_options"]; paypal?: components["schemas"]["checkout_paypal_payment_method_options"]; + payto?: components["schemas"]["checkout_payto_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"]; + satispay?: components["schemas"]["checkout_satispay_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"]; + twint?: components["schemas"]["checkout_twint_payment_method_options"]; us_bank_account?: components["schemas"]["checkout_us_bank_account_payment_method_options"]; }; + /** CheckoutSessionWalletOptions */ + checkout_session_wallet_options: { + link?: components["schemas"]["checkout_link_wallet_options"]; + }; /** CheckoutSofortPaymentMethodOptions */ checkout_sofort_payment_method_options: { /** @@ -11805,9 +12774,23 @@ export interface components { /** @description The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. */ reference?: string | null; }; + /** CheckoutTwintPaymentMethodOptions */ + checkout_twint_payment_method_options: { + /** + * @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"; + }; /** CheckoutUsBankAccountPaymentMethodOptions */ checkout_us_bank_account_payment_method_options: { - financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; + financial_connections?: components["schemas"]["linked_account_options_common"]; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -11819,6 +12802,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; /** * @description Bank account verification method. * @enum {string} @@ -11880,7 +12865,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -12025,8 +13010,8 @@ export interface components { * is successful, values present on the ConfirmationToken are written onto the Intent. * * To learn more about how to use ConfirmationToken, visit the related guides: - * - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server) - * - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation). + * - [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server) + * - [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation). */ confirmation_token: { /** @@ -12061,7 +13046,7 @@ export interface components { /** * @description Indicates that you intend to make future payments with this ConfirmationToken's payment method. * - * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. + * The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. * @enum {string|null} */ setup_future_usage?: "off_session" | "on_session" | null; @@ -12114,6 +13099,14 @@ export interface components { confirmation_tokens_resource_payment_method_options_resource_card: { /** @description The `cvc_update` Token collected from the Payment Element. */ cvc_token?: string | null; + installments?: components["schemas"]["confirmation_tokens_resource_payment_method_options_resource_card_resource_installment"]; + }; + /** + * ConfirmationTokensResourcePaymentMethodOptionsResourceCardResourceInstallment + * @description Installment configuration for payments. + */ + confirmation_tokens_resource_payment_method_options_resource_card_resource_installment: { + plan?: components["schemas"]["payment_method_details_card_installments_plan"]; }; /** * ConfirmationTokensResourcePaymentMethodPreview @@ -12134,14 +13127,17 @@ export interface components { au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; bancontact?: components["schemas"]["payment_method_bancontact"]; + billie?: components["schemas"]["payment_method_billie"]; billing_details: components["schemas"]["billing_details"]; blik?: components["schemas"]["payment_method_blik"]; boleto?: components["schemas"]["payment_method_boleto"]; card?: components["schemas"]["payment_method_card"]; card_present?: components["schemas"]["payment_method_card_present"]; cashapp?: components["schemas"]["payment_method_cashapp"]; + crypto?: components["schemas"]["payment_method_crypto"]; /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ customer?: (string | components["schemas"]["customer"]) | null; + customer_account?: string | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; fpx?: components["schemas"]["payment_method_fpx"]; @@ -12154,19 +13150,23 @@ export interface components { konbini?: components["schemas"]["payment_method_konbini"]; kr_card?: components["schemas"]["payment_method_kr_card"]; link?: components["schemas"]["payment_method_link"]; + mb_way?: components["schemas"]["payment_method_mb_way"]; mobilepay?: components["schemas"]["payment_method_mobilepay"]; multibanco?: components["schemas"]["payment_method_multibanco"]; naver_pay?: components["schemas"]["payment_method_naver_pay"]; + nz_bank_account?: components["schemas"]["payment_method_nz_bank_account"]; oxxo?: components["schemas"]["payment_method_oxxo"]; p24?: components["schemas"]["payment_method_p24"]; pay_by_bank?: components["schemas"]["payment_method_pay_by_bank"]; payco?: components["schemas"]["payment_method_payco"]; paynow?: components["schemas"]["payment_method_paynow"]; paypal?: components["schemas"]["payment_method_paypal"]; + payto?: components["schemas"]["payment_method_payto"]; 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"]; + satispay?: components["schemas"]["payment_method_satispay"]; sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; sofort?: components["schemas"]["payment_method_sofort"]; swish?: components["schemas"]["payment_method_swish"]; @@ -12175,7 +13175,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" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "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"]; @@ -12227,25 +13227,29 @@ export interface components { }; /** ConnectEmbeddedAccountFeaturesClaim */ connect_embedded_account_features_claim: { - /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + /** @description Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`. */ 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`. */ + /** @description Whether external account collection is enabled. 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 `true`. */ external_account_collection: boolean; }; /** ConnectEmbeddedAccountSessionCreateComponents */ connect_embedded_account_session_create_components: { account_management: components["schemas"]["connect_embedded_account_config_claim"]; account_onboarding: components["schemas"]["connect_embedded_account_config_claim"]; - balances: components["schemas"]["connect_embedded_payouts_config_claim"]; + balances: components["schemas"]["connect_embedded_payouts_config"]; + disputes_list: components["schemas"]["connect_embedded_disputes_list_config"]; documents: components["schemas"]["connect_embedded_base_config_claim"]; financial_account: components["schemas"]["connect_embedded_financial_account_config_claim"]; financial_account_transactions: components["schemas"]["connect_embedded_financial_account_transactions_config_claim"]; + instant_payouts_promotion: components["schemas"]["connect_embedded_instant_payouts_promotion_config"]; issuing_card: components["schemas"]["connect_embedded_issuing_card_config_claim"]; issuing_cards_list: components["schemas"]["connect_embedded_issuing_cards_list_config_claim"]; notification_banner: components["schemas"]["connect_embedded_account_config_claim"]; payment_details: components["schemas"]["connect_embedded_payments_config_claim"]; + payment_disputes: components["schemas"]["connect_embedded_payment_disputes_config"]; payments: components["schemas"]["connect_embedded_payments_config_claim"]; - payouts: components["schemas"]["connect_embedded_payouts_config_claim"]; + payout_details: components["schemas"]["connect_embedded_base_config_claim"]; + payouts: components["schemas"]["connect_embedded_payouts_config"]; payouts_list: components["schemas"]["connect_embedded_base_config_claim"]; tax_registrations: components["schemas"]["connect_embedded_base_config_claim"]; tax_settings: components["schemas"]["connect_embedded_base_config_claim"]; @@ -12258,6 +13262,23 @@ export interface components { }; /** ConnectEmbeddedBaseFeatures */ connect_embedded_base_features: Record; + /** ConnectEmbeddedDisputesListConfig */ + connect_embedded_disputes_list_config: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_disputes_list_features"]; + }; + /** ConnectEmbeddedDisputesListFeatures */ + connect_embedded_disputes_list_features: { + /** @description Whether to allow capturing and cancelling payment intents. This is `true` by default. */ + capture_payments: boolean; + /** @description Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default. */ + destination_on_behalf_of_charge_management: boolean; + /** @description Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default. */ + dispute_management: boolean; + /** @description Whether sending refunds is enabled. This is `true` by default. */ + refund_management: boolean; + }; /** ConnectEmbeddedFinancialAccountConfigClaim */ connect_embedded_financial_account_config_claim: { /** @description Whether the embedded component is enabled. */ @@ -12266,9 +13287,9 @@ export interface components { }; /** ConnectEmbeddedFinancialAccountFeatures */ connect_embedded_financial_account_features: { - /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + /** @description Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`. */ disable_stripe_user_authentication: boolean; - /** @description Whether to allow external accounts to be linked for money transfer. */ + /** @description Whether external account collection is enabled. 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 `true`. */ external_account_collection: boolean; /** @description Whether to allow sending money. */ send_money: boolean; @@ -12286,6 +13307,21 @@ export interface components { /** @description Whether to allow card spend dispute management features. */ card_spend_dispute_management: boolean; }; + /** ConnectEmbeddedInstantPayoutsPromotionConfig */ + connect_embedded_instant_payouts_promotion_config: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_instant_payouts_promotion_features"]; + }; + /** ConnectEmbeddedInstantPayoutsPromotionFeatures */ + connect_embedded_instant_payouts_promotion_features: { + /** @description Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`. */ + disable_stripe_user_authentication: boolean; + /** @description Whether external account collection is enabled. 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 `true`. */ + external_account_collection: boolean; + /** @description Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise. */ + instant_payouts: boolean; + }; /** ConnectEmbeddedIssuingCardConfigClaim */ connect_embedded_issuing_card_config_claim: { /** @description Whether the embedded component is enabled. */ @@ -12317,11 +13353,26 @@ export interface components { card_spend_dispute_management: boolean; /** @description Whether to allow cardholder management features. */ cardholder_management: boolean; - /** @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. */ + /** @description Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`. */ disable_stripe_user_authentication: boolean; /** @description Whether to allow spend control management features. */ spend_control_management: boolean; }; + /** ConnectEmbeddedPaymentDisputesConfig */ + connect_embedded_payment_disputes_config: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_payment_disputes_features"]; + }; + /** ConnectEmbeddedPaymentDisputesFeatures */ + connect_embedded_payment_disputes_features: { + /** @description Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default. */ + destination_on_behalf_of_charge_management: boolean; + /** @description Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default. */ + dispute_management: boolean; + /** @description Whether sending refunds is enabled. This is `true` by default. */ + refund_management: boolean; + }; /** ConnectEmbeddedPaymentsConfigClaim */ connect_embedded_payments_config_claim: { /** @description Whether the embedded component is enabled. */ @@ -12332,30 +13383,30 @@ export interface components { connect_embedded_payments_features: { /** @description Whether to allow capturing and cancelling payment intents. This is `true` by default. */ capture_payments: boolean; - /** @description Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. */ + /** @description Whether connected accounts can manage destination charges that are created on behalf of them. This is `false` by default. */ destination_on_behalf_of_charge_management: boolean; - /** @description Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. */ + /** @description Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default. */ dispute_management: boolean; - /** @description Whether to allow sending refunds. This is `true` by default. */ + /** @description Whether sending refunds is enabled. This is `true` by default. */ refund_management: boolean; }; - /** ConnectEmbeddedPayoutsConfigClaim */ - connect_embedded_payouts_config_claim: { + /** ConnectEmbeddedPayoutsConfig */ + connect_embedded_payouts_config: { /** @description Whether the embedded component is enabled. */ enabled: boolean; features: components["schemas"]["connect_embedded_payouts_features"]; }; /** ConnectEmbeddedPayoutsFeatures */ connect_embedded_payouts_features: { - /** @description Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don’t set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false. */ + /** @description Whether Stripe user authentication is disabled. This value can only be `true` for accounts where `controller.requirement_collection` is `application` for the account. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to `true` and `disable_stripe_user_authentication` defaults to `false`. */ disable_stripe_user_authentication: boolean; - /** @description Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + /** @description Whether to allow payout schedule to be changed. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`. */ 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 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`. */ + /** @description Whether external account collection is enabled. 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 `true`. */ external_account_collection: boolean; - /** @description Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + /** @description Whether to allow creation of instant payouts. The default value is `enabled` when Stripe is responsible for negative account balances, and `use_dashboard_rules` otherwise. */ instant_payouts: boolean; - /** @description Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + /** @description Whether to allow creation of standard payouts. Defaults to `true` when `controller.losses.payments` is set to `stripe` for the account, otherwise `false`. */ standard_payouts: boolean; }; /** @@ -12404,8 +13455,8 @@ export interface components { /** * Coupon * @description A coupon contains information about a percent-off or amount-off discount you - * might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices), - * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents). + * might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices), + * [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](https://api.stripe.com#create_charge) or [payment intents](https://docs.stripe.com/api/payment_intents). */ coupon: { /** @description Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer. */ @@ -12426,7 +13477,7 @@ export interface components { [key: string]: components["schemas"]["coupon_currency_option"]; }; /** - * @description One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount. + * @description One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount. * @enum {string} */ duration: "forever" | "once" | "repeating"; @@ -12438,7 +13489,7 @@ export interface components { livemode: boolean; /** @description Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid. */ max_redemptions?: number | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -12480,7 +13531,7 @@ export interface components { * CreditNote * @description Issue a credit note to adjust an invoice's amount after the invoice is finalized. * - * Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes) + * Related guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes) */ credit_note: { /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax. */ @@ -12499,6 +13550,8 @@ export interface components { currency: string; /** @description ID of the customer. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description ID of the account representing the customer. */ + customer_account?: string | null; /** @description Customer balance transaction related to this credit note. */ customer_balance_transaction?: (string | components["schemas"]["customer_balance_transaction"]) | null; /** @description The integer amount in cents (or local equivalent) representing the total amount of discount that was credited. */ @@ -12535,7 +13588,7 @@ export interface components { livemode: boolean; /** @description Customer-facing text that appears on the credit note PDF. */ memo?: string | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -12550,6 +13603,10 @@ export interface components { out_of_band_amount?: number | null; /** @description The link to download the PDF of the credit note. */ pdf: string; + /** @description The amount of the credit note that was refunded to the customer, credited to the customer's balance, credited outside of Stripe, or any combination thereof. */ + post_payment_amount: number; + /** @description The amount of the credit note by which the invoice's `amount_remaining` and `amount_due` were reduced. */ + pre_payment_amount: number; /** @description The pretax credit amounts (ex: discount, credit grants, etc) for all line items. */ pretax_credit_amounts: components["schemas"]["credit_notes_pretax_credit_amount"][]; /** @@ -12557,12 +13614,12 @@ export interface components { * @enum {string|null} */ reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory" | null; - /** @description Refund related to this credit note. */ - refund?: (string | components["schemas"]["refund"]) | null; + /** @description Refunds related to this credit note. */ + refunds: components["schemas"]["credit_note_refund"][]; /** @description The details of the cost of shipping, including the ShippingRate applied to the invoice. */ shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; /** - * @description Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + * @description Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding). * @enum {string} */ status: "issued" | "void"; @@ -12570,17 +13627,17 @@ export interface components { subtotal: number; /** @description The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts. */ subtotal_excluding_tax?: number | null; - /** @description The aggregate amounts calculated per tax rate for all line items. */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount. */ total: number; /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts. */ total_excluding_tax?: number | null; + /** @description The aggregate tax information for all line items. */ + total_taxes?: components["schemas"]["billing_bill_resource_invoicing_taxes_tax"][] | null; /** * @description Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid. * @enum {string} */ - type: "post_payment" | "pre_payment"; + type: "mixed" | "post_payment" | "pre_payment"; /** * Format: unix-time * @description The time that the credit note was voided. @@ -12594,8 +13651,6 @@ export interface components { credit_note_line_item: { /** @description The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts. */ amount: number; - /** @description The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts. */ - amount_excluding_tax?: number | null; /** @description Description of the item being credited. */ description?: string | null; /** @description The integer amount in cents (or local equivalent) representing the discount being credited for this line item. */ @@ -12617,10 +13672,10 @@ export interface components { 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 */ - tax_amounts: components["schemas"]["credit_note_tax_amount"][]; /** @description The tax rates which apply to the line item. */ tax_rates: components["schemas"]["tax_rate"][]; + /** @description The tax information of the line item. */ + taxes?: components["schemas"]["billing_bill_resource_invoicing_taxes_tax"][] | null; /** * @description The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice. * @enum {string} @@ -12633,27 +13688,27 @@ export interface components { * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. */ unit_amount_decimal?: string | null; - /** - * Format: decimal - * @description The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts. - */ - unit_amount_excluding_tax?: string | null; }; - /** CreditNoteTaxAmount */ - credit_note_tax_amount: { - /** @description The amount, in cents (or local equivalent), of the tax. */ - amount: number; - /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; - /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: string | components["schemas"]["tax_rate"]; + /** CreditNoteRefund */ + credit_note_refund: { + /** @description Amount of the refund that applies to this credit note, in cents (or local equivalent). */ + amount_refunded: number; + /** @description The PaymentRecord refund details associated with this credit note refund. */ + payment_record_refund?: components["schemas"]["credit_notes_payment_record_refund"] | null; + /** @description ID of the refund. */ + refund: string | components["schemas"]["refund"]; /** - * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. + * @description Type of the refund, one of `refund` or `payment_record_refund`. * @enum {string|null} */ - taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ - taxable_amount?: number | null; + type?: "payment_record_refund" | "refund" | null; + }; + /** CreditNotesPaymentRecordRefund */ + credit_notes_payment_record_refund: { + /** @description ID of the payment record. */ + payment_record: string; + /** @description ID of the refund group. */ + refund_group: string; }; /** CreditNotesPretaxCreditAmount */ credit_notes_pretax_credit_amount: { @@ -12674,7 +13729,7 @@ export interface components { /** @description When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. */ custom_unit_amount?: components["schemas"]["custom_unit_amount"] | null; /** - * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + * @description Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; @@ -12688,6 +13743,13 @@ export interface components { */ unit_amount_decimal?: string | null; }; + /** custom_logo */ + custom_logo: { + /** @description Content type of the Dashboard-only CustomPaymentMethodType logo. */ + content_type?: string | null; + /** @description URL of the Dashboard-only CustomPaymentMethodType logo. */ + url: string; + }; /** CustomUnitAmount */ custom_unit_amount: { /** @description The maximum unit amount the customer can specify for this item. */ @@ -12699,14 +13761,16 @@ export interface components { }; /** * Customer - * @description This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information, + * @description This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information, * and track payments that belong to the same customer. */ customer: { /** @description The customer's address. */ address?: components["schemas"]["address"] | null; - /** @description The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. */ + /** @description The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). */ balance?: number; + /** @description The customer's business name. */ + business_name?: string; /** @description The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is "cash_balance". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically. */ cash_balance?: components["schemas"]["cash_balance"] | null; /** @@ -12716,16 +13780,18 @@ export interface components { created: number; /** @description Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes. */ currency?: string | null; + /** @description The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter. */ + customer_account?: string | null; /** * @description ID of the default payment source for the customer. * - * If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. + * If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** * @description Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`. * - * If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`. + * If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. * * If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`. */ @@ -12738,6 +13804,8 @@ export interface components { email?: string | null; /** @description Unique identifier for the object. */ id: string; + /** @description The customer's individual name. */ + individual_name?: string; /** @description The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes. */ invoice_credit_balance?: { [key: string]: number; @@ -12747,7 +13815,7 @@ export interface components { invoice_settings?: components["schemas"]["invoice_setting_customer_setting"]; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -12853,14 +13921,14 @@ export interface components { }; /** CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft */ customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft: { - /** @description The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. */ + /** @description The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. */ balance_transaction: string | components["schemas"]["balance_transaction"]; - /** @description The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. */ + /** @description The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. */ linked_transaction: string | components["schemas"]["customer_cash_balance_transaction"]; }; /** CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction */ customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction: { - /** @description The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to. */ + /** @description The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to. */ payment_intent: string | components["schemas"]["payment_intent"]; }; /** CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction */ @@ -12920,31 +13988,33 @@ export interface components { }; /** CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction */ customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction: { - /** @description The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance. */ + /** @description The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance. */ refund: string | components["schemas"]["refund"]; }; /** CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance */ customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance: { - /** @description The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. */ + /** @description The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. */ balance_transaction: string | components["schemas"]["balance_transaction"]; }; /** CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction */ customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction: { - /** @description The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from. */ + /** @description The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from. */ payment_intent: string | components["schemas"]["payment_intent"]; }; /** * CustomerBalanceTransaction - * @description Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value, + * @description Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value, * which denotes a debit or credit that's automatically applied to their next invoice upon finalization. - * You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update), + * You may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update), * or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`. * - * Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance) + * Related guide: [Customer balance](https://docs.stripe.com/billing/customer/balance) */ customer_balance_transaction: { /** @description The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`. */ amount: number; + /** @description The ID of the checkout session (if any) that created the transaction. */ + checkout_session?: (string | components["schemas"]["checkout.session"]) | null; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -12959,6 +14029,8 @@ export interface components { currency: string; /** @description The ID of the customer the transaction belongs to. */ customer: string | components["schemas"]["customer"]; + /** @description The ID of an Account representing a customer that the transaction belongs to. */ + customer_account?: string | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; /** @description The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice. */ @@ -12969,7 +14041,7 @@ export interface components { invoice?: (string | components["schemas"]["invoice"]) | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -12979,10 +14051,10 @@ export interface components { */ object: "customer_balance_transaction"; /** - * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types. + * @description Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types. * @enum {string} */ - type: "adjustment" | "applied_to_invoice" | "credit_note" | "initial" | "invoice_overpaid" | "invoice_too_large" | "invoice_too_small" | "migration" | "unapplied_from_invoice" | "unspent_receiver_credit"; + type: "adjustment" | "applied_to_invoice" | "checkout_session_subscription_payment" | "checkout_session_subscription_payment_canceled" | "credit_note" | "initial" | "invoice_overpaid" | "invoice_too_large" | "invoice_too_small" | "migration" | "unapplied_from_invoice" | "unspent_receiver_credit"; }; /** * CustomerCashBalanceTransaction @@ -13003,14 +14075,16 @@ export interface components { currency: string; /** @description The customer whose available cash balance changed as a result of this transaction. */ customer: string | components["schemas"]["customer"]; - /** @description The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The ID of an Account representing a customer whose available cash balance changed as a result of this transaction. */ + customer_account?: string | null; + /** @description The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ ending_balance: number; funded?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_funded_transaction"]; /** @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 The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. */ + /** @description The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. */ net_amount: number; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -13020,7 +14094,7 @@ export interface components { refunded_from_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"]; transferred_to_balance?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"]; /** - * @description The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. + * @description The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types. * @enum {string} */ type: "adjusted_for_overdraft" | "applied_to_payment" | "funded" | "funding_reversed" | "refunded_from_payment" | "return_canceled" | "return_initiated" | "transferred_to_balance" | "unapplied_from_payment"; @@ -13050,6 +14124,8 @@ export interface components { created: number; /** @description The Customer the Customer Session was created for. */ customer: string | components["schemas"]["customer"]; + /** @description The Account that the Customer Session was created for. */ + customer_account?: string | null; /** * Format: unix-time * @description The timestamp at which this Customer Session will expire. @@ -13069,6 +14145,8 @@ export interface components { */ customer_session_resource_components: { buy_button: components["schemas"]["customer_session_resource_components_resource_buy_button"]; + customer_sheet: components["schemas"]["customer_session_resource_components_resource_customer_sheet"]; + mobile_payment_element: components["schemas"]["customer_session_resource_components_resource_mobile_payment_element"]; payment_element: components["schemas"]["customer_session_resource_components_resource_payment_element"]; pricing_table: components["schemas"]["customer_session_resource_components_resource_pricing_table"]; }; @@ -13080,6 +14158,83 @@ export interface components { /** @description Whether the buy button is enabled. */ enabled: boolean; }; + /** + * CustomerSessionResourceComponentsResourceCustomerSheet + * @description This hash contains whether the customer sheet is enabled and the features it supports. + */ + customer_session_resource_components_resource_customer_sheet: { + /** @description Whether the customer sheet is enabled. */ + enabled: boolean; + /** @description This hash defines whether the customer sheet supports certain features. */ + features?: components["schemas"]["customer_session_resource_components_resource_customer_sheet_resource_features"] | null; + }; + /** + * CustomerSessionResourceComponentsResourceCustomerSheetResourceFeatures + * @description This hash contains the features the customer sheet supports. + */ + customer_session_resource_components_resource_customer_sheet_resource_features: { + /** + * @description A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list. + * + * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"]. + */ + payment_method_allow_redisplay_filters?: ("always" | "limited" | "unspecified")[] | null; + /** + * @description Controls whether the customer sheet displays the option to remove a saved payment method." + * + * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods). + * @enum {string|null} + */ + payment_method_remove?: "disabled" | "enabled" | null; + }; + /** + * CustomerSessionResourceComponentsResourceMobilePaymentElement + * @description This hash contains whether the mobile payment element is enabled and the features it supports. + */ + customer_session_resource_components_resource_mobile_payment_element: { + /** @description Whether the mobile payment element is enabled. */ + enabled: boolean; + /** @description This hash defines whether the mobile payment element supports certain features. */ + features?: components["schemas"]["customer_session_resource_components_resource_mobile_payment_element_resource_features"] | null; + }; + /** + * CustomerSessionResourceComponentsResourceMobilePaymentElementResourceFeatures + * @description This hash contains the features the mobile payment element supports. + */ + customer_session_resource_components_resource_mobile_payment_element_resource_features: { + /** + * @description A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list. + * + * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"]. + */ + payment_method_allow_redisplay_filters?: ("always" | "limited" | "unspecified")[] | null; + /** + * @description Controls whether or not the mobile payment element shows saved payment methods. + * @enum {string|null} + */ + payment_method_redisplay?: "disabled" | "enabled" | null; + /** + * @description Controls whether the mobile payment element displays the option to remove a saved payment method." + * + * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods). + * @enum {string|null} + */ + payment_method_remove?: "disabled" | "enabled" | null; + /** + * @description Controls whether the mobile payment element displays a checkbox offering to save a new payment method. + * + * If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`. + * @enum {string|null} + */ + payment_method_save?: "disabled" | "enabled" | null; + /** + * @description Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: "always", "limited", or "unspecified". + * + * If not specified, defaults to `nil` (no override value). + * @enum {string|null} + */ + payment_method_save_allow_redisplay_override?: "always" | "limited" | "unspecified" | null; + }; /** * CustomerSessionResourceComponentsResourcePaymentElement * @description This hash contains whether the Payment Element is enabled and the features it supports. @@ -13106,7 +14261,7 @@ export interface components { * @enum {string} */ payment_method_redisplay: "disabled" | "enabled"; - /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. */ + /** @description Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`. */ payment_method_redisplay_limit?: number | null; /** * @description Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`. @@ -13147,19 +14302,24 @@ export interface components { automatic_tax: "failed" | "not_collecting" | "supported" | "unrecognized_location"; /** @description A recent IP address of the customer used for tax reporting and tax location inference. */ ip_address?: string | null; - /** @description The customer's location as identified by Stripe Tax. */ + /** @description The identified tax location of the customer. */ location?: components["schemas"]["customer_tax_location"] | null; + /** + * @description The tax calculation provider used for location resolution. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). + * @enum {string} + */ + provider: "anrok" | "avalara" | "sphere" | "stripe"; }; /** CustomerTaxLocation */ customer_tax_location: { - /** @description The customer's country as identified by Stripe Tax. */ + /** @description The identified tax country of the customer. */ country: string; /** * @description The data source used to infer the customer's location. * @enum {string} */ source: "billing_address" | "ip_address" | "payment_method" | "shipping_destination"; - /** @description The customer's state, county, province, or region as identified by Stripe Tax. */ + /** @description The identified tax state, county, province, or region of the customer. */ state?: string | null; }; /** DeletedAccount */ @@ -13277,9 +14437,10 @@ export interface components { deleted_discount: { /** @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ checkout_session?: string | null; - coupon: components["schemas"]["coupon"]; /** @description The ID of the customer associated with this discount. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The ID of the account representing the customer associated with this discount. */ + customer_account?: string | null; /** * @description Always true for a deleted object * @enum {boolean} @@ -13298,6 +14459,7 @@ export interface components { object: "discount"; /** @description The promotion code applied to create this discount. */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; + source: components["schemas"]["discount_source"]; /** * Format: unix-time * @description Date that the coupon was applied. @@ -13514,6 +14676,11 @@ export interface components { * @enum {boolean} */ deleted: true; + /** + * @description Device type of the reader. + * @enum {string} + */ + device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_stripe_s700" | "simulated_stripe_s710" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "stripe_s710" | "verifone_P400"; /** @description Unique identifier for the object. */ id: string; /** @@ -13521,6 +14688,8 @@ export interface components { * @enum {string} */ object: "terminal.reader"; + /** @description Serial number of the reader. */ + serial_number: string; }; /** DeletedTestClock */ "deleted_test_helpers.test_clock": { @@ -13556,17 +14725,18 @@ export interface components { destination_details_unimplemented: Record; /** * Discount - * @description A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). + * @description A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes). * It contains information about when the discount began, when it will end, and what it is applied to. * - * Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + * Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) */ discount: { /** @description The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode. */ checkout_session?: string | null; - coupon: components["schemas"]["coupon"]; /** @description The ID of the customer associated with this discount. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The ID of the account representing the customer associated with this discount. */ + customer_account?: string | null; /** * Format: unix-time * @description If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null. @@ -13585,6 +14755,7 @@ export interface components { object: "discount"; /** @description The promotion code applied to create this discount. */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; + source: components["schemas"]["discount_source"]; /** * Format: unix-time * @description Date that the coupon was applied. @@ -13595,6 +14766,16 @@ export interface components { /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ subscription_item?: string | null; }; + /** DiscountSource */ + discount_source: { + /** @description The coupon that was redeemed to create this discount. */ + coupon?: (string | components["schemas"]["coupon"]) | null; + /** + * @description The source type of the discount. + * @enum {string} + */ + type: "coupon"; + }; /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { /** @description The amount, in cents (or local equivalent), of the discount. */ @@ -13602,8 +14783,8 @@ export interface components { /** @description The discount that was applied to get this discount amount. */ discount: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; }; - /** DiscountsResourceStackableDiscount */ - discounts_resource_stackable_discount: { + /** DiscountsResourceStackableDiscountWithDiscountEnd */ + discounts_resource_stackable_discount_with_discount_end: { /** @description ID of the coupon to create a new discount for. */ coupon?: (string | components["schemas"]["coupon"]) | null; /** @description ID of an existing discount on the object (or one of its ancestors) to reuse. */ @@ -13617,7 +14798,7 @@ export interface components { * When this happens, you have the opportunity to respond to the dispute with * evidence that shows that the charge is legitimate. * - * Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) + * Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) */ dispute: { /** @description Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed). */ @@ -13637,7 +14818,7 @@ export interface components { */ currency: string; /** @description List of eligibility types that are included in `enhanced_evidence`. */ - enhanced_eligibility_types: "visa_compelling_evidence_3"[]; + enhanced_eligibility_types: ("visa_compelling_evidence_3" | "visa_compliance")[]; evidence: components["schemas"]["dispute_evidence"]; evidence_details: components["schemas"]["dispute_evidence_details"]; /** @description Unique identifier for the object. */ @@ -13646,7 +14827,7 @@ export interface components { is_charge_refundable: boolean; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -13658,13 +14839,13 @@ export interface components { /** @description ID of the PaymentIntent that's disputed. */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; payment_method_details?: components["schemas"]["dispute_payment_method_details"]; - /** @description Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories). */ + /** @description Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories). */ reason: string; /** - * @description Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`. + * @description The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`. * @enum {string} */ - status: "lost" | "needs_response" | "under_review" | "warning_closed" | "warning_needs_response" | "warning_under_review" | "won"; + status: "lost" | "needs_response" | "prevented" | "under_review" | "warning_closed" | "warning_needs_response" | "warning_under_review" | "won"; }; /** DisputeEnhancedEligibility */ dispute_enhanced_eligibility: { @@ -13801,18 +14982,20 @@ export interface components { }; /** DisputePaymentMethodDetailsCard */ dispute_payment_method_details_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `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. * @enum {string} */ - case_type: "chargeback" | "inquiry"; + case_type: "block" | "chargeback" | "compliance" | "inquiry" | "resolution"; /** @description The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network. */ network_reason_code?: string | null; }; /** DisputePaymentMethodDetailsKlarna */ dispute_payment_method_details_klarna: { + /** @description Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason */ + chargeback_loss_reason_code?: string; /** @description The reason for the dispute as defined by Klarna */ reason_code?: string | null; }; @@ -13829,13 +15012,13 @@ export interface components { 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). */ + /** @description Address line 1, such as the street, PO Box, or company name. */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** @description Address line 2, such as the apartment, suite, unit, or building. */ line2?: string | null; /** @description ZIP or postal code. */ postal_code?: string | null; - /** @description State, county, province, or region. */ + /** @description State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ state?: string | null; }; /** DisputeVisaCompellingEvidence3DisputedTransaction */ @@ -13894,7 +15077,7 @@ export interface components { * @description An active entitlement describes access to a feature for a customer. */ "entitlements.active_entitlement": { - /** @description The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to. */ + /** @description The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to. */ feature: string | components["schemas"]["entitlements.feature"]; /** @description Unique identifier for the object. */ id: string; @@ -13964,42 +15147,32 @@ export interface components { }; /** * NotificationEvent - * @description Events are our way of letting you know when something interesting happens in - * your account. When an interesting event occurs, we create a new `Event` - * object. For example, when a charge succeeds, we create a `charge.succeeded` - * event, and when an invoice payment attempt fails, we create an - * `invoice.payment_failed` event. Certain API requests might create multiple - * events. For example, if you create a new subscription for a - * customer, you receive both a `customer.subscription.created` event and a - * `charge.succeeded` event. + * @description Snapshot events allow you to track and react to activity in your Stripe integration. When + * the state of another API resource changes, Stripe creates an `Event` object that contains + * all the relevant information associated with that action, including the affected API + * resource. For example, a successful payment triggers a `charge.succeeded` event, which + * contains the `Charge` in the event's data property. Some actions trigger multiple events. + * For example, if you create a new subscription for a customer, it triggers both a + * `customer.subscription.created` event and a `charge.succeeded` event. * - * Events occur when the state of another API resource changes. The event's data - * field embeds the resource's state at the time of the change. For - * example, a `charge.succeeded` event contains a charge, and an - * `invoice.payment_failed` event contains an invoice. + * Configure an event destination in your account to listen for events that represent actions + * your integration needs to respond to. Additionally, you can retrieve an individual event or + * a list of events from the API. * - * As with other API resources, you can use endpoints to retrieve an - * [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events) - * from the API. We also have a separate - * [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the - * `Event` objects directly to an endpoint on your server. You can manage - * webhooks in your - * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how - * to [listen for events](https://docs.stripe.com/webhooks) - * so that your integration can automatically trigger reactions. + * [Connect](https://docs.stripe.com/connect) platforms can also receive event notifications + * that occur in their connected accounts. These events include an account attribute that + * identifies the relevant connected account. * - * When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications - * that occur in connected accounts. For these events, there's an - * additional `account` attribute in the received `Event` object. - * - * We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) + * You can access events through the [Retrieve Event API](https://docs.stripe.com/api/events#retrieve_event) * for 30 days. */ event: { /** @description The connected account that originates the event. */ account?: string; - /** @description The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014. */ + /** @description The Stripe API version used to render `data` when the event was created. The contents of `data` never change, so this value remains static regardless of the API version currently in use. This property is populated only for events created on or after October 31, 2014. */ api_version?: string | null; + /** @description Authentication context needed to fetch the event or related object. */ + context?: string; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -14024,19 +15197,21 @@ export interface components { }; /** * ExchangeRate - * @description `ExchangeRate` objects allow you to determine the rates that Stripe is currently + * @description [Deprecated] The `ExchangeRate` APIs are deprecated. Please use the [FX Quotes API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) instead. + * + * `ExchangeRate` objects allow you to determine the rates that Stripe is currently * using to convert from one currency to another. Since this number is variable * throughout the day, there are various reasons why you might want to know the current * rate (for example, to dynamically price an item for a user with a default * payment in a foreign currency). * - * Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details. + * Please refer to our [Exchange Rates API](https://docs.stripe.com/fx-rates) guide for more details. * * *[Note: this integration path is supported but no longer recommended]* Additionally, * you can guarantee that a charge is made with an exchange rate that you expect is * current. To do so, you must pass in the exchange_rate to charges endpoints. If the * value is no longer up to date, the charge won't go through. Please refer to our - * [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details. + * [Using with charges](https://docs.stripe.com/exchange-rates) guide for more details. * * ----- * @@ -14068,13 +15243,13 @@ export interface components { external_account: components["schemas"]["bank_account"] | components["schemas"]["card"]; /** ExternalAccountRequirements */ external_account_requirements: { - /** @description Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /** @description Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. */ currently_due?: string[] | null; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors?: components["schemas"]["account_requirements_error"][] | null; - /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. */ + /** @description Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account. */ past_due?: string[] | null; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. */ pending_verification?: string[] | null; }; /** Fee */ @@ -14099,7 +15274,7 @@ export interface components { * has previously been created but not yet refunded. Funds will be refunded to * the Stripe account from which the fee was originally collected. * - * Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) + * Related guide: [Refunding application fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) */ fee_refund: { /** @description Amount, in cents (or local equivalent). */ @@ -14120,7 +15295,7 @@ export interface components { fee: string | components["schemas"]["application_fee"]; /** @description Unique identifier for the object. */ id: 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -14133,12 +15308,12 @@ export interface components { /** * File * @description This object represents files hosted on Stripe's servers. You can upload - * files with the [create file](https://stripe.com/docs/api#create_file) request + * files with the [create file](https://api.stripe.com#create_file) request * (for example, when uploading dispute evidence). Stripe also * creates files independently (for example, the results of a [Sigma scheduled * query](#scheduled_queries)). * - * Related guide: [File upload guide](https://stripe.com/docs/file-upload) + * Related guide: [File upload guide](https://docs.stripe.com/file-upload) */ file: { /** @@ -14157,7 +15332,7 @@ export interface components { id: string; /** * FileResourceFileLinkList - * @description A list of [file links](https://stripe.com/docs/api#file_links) that point at this file. + * @description A list of [file links](https://api.stripe.com#file_links) that point at this file. */ links?: { /** @description Details about each object. */ @@ -14178,10 +15353,10 @@ export interface components { */ object: "file"; /** - * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. + * @description The [purpose](https://docs.stripe.com/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" | "financial_account_statement" | "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" | "platform_terms_of_service" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_android_apk" | "terminal_reader_splashscreen" | "terminal_wifi_certificate" | "terminal_wifi_private_key"; /** @description The size of the file object in bytes. */ size: number; /** @description A suitable title for the document. */ @@ -14216,7 +15391,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -14235,6 +15410,8 @@ export interface components { "financial_connections.account": { /** @description The account holder that this account belongs to. */ account_holder?: components["schemas"]["bank_connections_resource_accountholder"] | null; + /** @description Details about the account numbers. */ + account_numbers?: components["schemas"]["bank_connections_resource_account_number_details"][] | null; /** @description The most recent information about the account's balance. */ balance?: components["schemas"]["bank_connections_resource_balance"] | null; /** @description The state of the most recent attempt to refresh the account balance. */ @@ -14295,7 +15472,7 @@ export interface components { subcategory: "checking" | "credit_card" | "line_of_credit" | "mortgage" | "other" | "savings"; /** @description The list of data refresh subscriptions requested on this account. */ subscriptions?: "transactions"[] | null; - /** @description The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. */ + /** @description The [PaymentMethod type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. */ supported_payment_method_types: ("link" | "us_bank_account")[]; /** @description The state of the most recent attempt to refresh the account transactions. */ transaction_refresh?: components["schemas"]["bank_connections_resource_transaction_refresh"] | null; @@ -14388,7 +15565,7 @@ export interface components { url: string; }; /** @description A value that will be passed to the client to launch the authentication flow. */ - client_secret: string; + client_secret?: string | null; filters?: components["schemas"]["bank_connections_resource_link_account_session_filters"]; /** @description Unique identifier for the object. */ id: string; @@ -14551,7 +15728,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -14575,11 +15752,11 @@ export interface components { }; /** * CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions - * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is + * @description Each customer has a [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is * automatically applied to future invoices and payments using the `customer_balance` payment method. * Customers can fund this balance by initiating a bank transfer to any account in the * `financial_addresses` field. - * Related guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) + * Related guide: [Customer balance funding instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions) */ funding_instructions: { bank_transfer: components["schemas"]["funding_instructions_bank_transfer"]; @@ -14806,7 +15983,7 @@ export interface components { error?: components["schemas"]["gelato_document_report_error"] | null; /** @description Expiration date of the document. */ expiration_date?: components["schemas"]["gelato_data_document_report_expiration_date"] | null; - /** @description Array of [File](https://stripe.com/docs/api/files) ids containing images for this document. */ + /** @description Array of [File](https://docs.stripe.com/api/files) ids containing images for this document. */ files?: string[] | null; /** @description First name as it appears in the document. */ first_name?: string | null; @@ -14818,6 +15995,11 @@ export interface components { last_name?: string | null; /** @description Document ID number. */ number?: string | null; + /** + * @description Sex of the person in the document. + * @enum {string|null} + */ + sex?: "[redacted]" | "female" | "male" | "unknown" | null; /** * @description Status of this `document` check. * @enum {string} @@ -14828,6 +16010,10 @@ export interface components { * @enum {string|null} */ type?: "driving_license" | "id_card" | "passport" | null; + /** @description Place of birth as it appears in the document. */ + unparsed_place_of_birth?: string | null; + /** @description Sex as it appears in the document. */ + unparsed_sex?: string | null; }; /** GelatoDocumentReportError */ gelato_document_report_error: { @@ -14932,15 +16118,22 @@ export interface components { /** @description Phone number of user being verified */ phone?: string; }; + /** GelatoRelatedPerson */ + gelato_related_person: { + /** @description Token referencing the associated Account of the related Person resource. */ + account: string; + /** @description Token referencing the related Person resource. */ + person: string; + }; /** GelatoReportDocumentOptions */ gelato_report_document_options: { /** @description Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. */ allowed_types?: ("driving_license" | "id_card" | "passport")[]; - /** @description Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. */ + /** @description Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. */ require_id_number?: boolean; /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ require_live_capture?: boolean; - /** @description Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). */ + /** @description Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie). */ require_matching_selfie?: boolean; }; /** GelatoReportIdNumberOptions */ @@ -14950,11 +16143,11 @@ export interface components { * @description Result from a selfie check */ gelato_selfie_report: { - /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check. */ + /** @description ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check. */ document?: string | null; /** @description Details on the verification error. Present when status is `unverified`. */ error?: components["schemas"]["gelato_selfie_report_error"] | null; - /** @description ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check. */ + /** @description ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check. */ selfie?: string | null; /** * @description Status of this `selfie` check. @@ -14976,11 +16169,11 @@ export interface components { gelato_session_document_options: { /** @description Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. */ allowed_types?: ("driving_license" | "id_card" | "passport")[]; - /** @description Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. */ + /** @description Collect an ID number and perform an [ID number check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. */ require_id_number?: boolean; /** @description Disable image uploads, identity document images have to be captured using the device’s camera. */ require_live_capture?: boolean; - /** @description Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). */ + /** @description Capture a face image and perform a [selfie check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://docs.stripe.com/identity/selfie). */ require_matching_selfie?: boolean; }; /** GelatoSessionEmailOptions */ @@ -15003,6 +16196,19 @@ export interface components { /** @description A message that explains the reason for verification or user-session failure. */ reason?: string | null; }; + /** GelatoSessionMatchingOptions */ + gelato_session_matching_options: { + /** + * @description Strictness of the DOB matching policy to apply. + * @enum {string} + */ + dob?: "none" | "similar"; + /** + * @description Strictness of the name matching policy to apply. + * @enum {string} + */ + name?: "none" | "similar"; + }; /** GelatoSessionPhoneOptions */ gelato_session_phone_options: { /** @description Request one time password verification of `provided_details.phone`. */ @@ -15018,6 +16224,7 @@ export interface components { document?: components["schemas"]["gelato_session_document_options"]; email?: components["schemas"]["gelato_session_email_options"]; id_number?: components["schemas"]["gelato_session_id_number_options"]; + matching?: components["schemas"]["gelato_session_matching_options"]; phone?: components["schemas"]["gelato_session_phone_options"]; }; /** GelatoVerifiedOutputs */ @@ -15041,6 +16248,15 @@ export interface components { last_name?: string | null; /** @description The user's verified phone number */ phone?: string | null; + /** + * @description The user's verified sex. + * @enum {string|null} + */ + sex?: "[redacted]" | "female" | "male" | "unknown" | null; + /** @description The user's verified place of birth as it appears in the document. */ + unparsed_place_of_birth?: string | null; + /** @description The user's verified sex as it appears in the document. */ + unparsed_sex?: string | null; }; /** * GelatoVerificationReport @@ -15050,11 +16266,11 @@ export interface components { * appropriate sub-resource: `document`, `id_number`, `selfie`. * * Each VerificationReport contains a copy of any data collected by the user as well as - * reference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files) + * reference IDs which can be used to access collected images through the [FileUpload](https://docs.stripe.com/api/files) * API. To configure and create VerificationReports, use the - * [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API. + * [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API. * - * Related guide: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). + * Related guide: [Accessing verification results](https://docs.stripe.com/identity/verification-sessions#results). */ "identity.verification_report": { /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ @@ -15101,12 +16317,12 @@ export interface components { * the verification flow. The VerificationSession contains the user's verified data after * verification checks are complete. * - * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) + * Related guide: [The Verification Sessions API](https://docs.stripe.com/identity/verification-sessions) */ "identity.verification_session": { /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ client_reference_id?: string | null; - /** @description The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. */ + /** @description The short-lived client secret used by Stripe.js to [show a verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more. */ client_secret?: string | null; /** * Format: unix-time @@ -15117,11 +16333,11 @@ export interface components { id: string; /** @description If present, this property tells you the last error encountered when processing the verification. */ last_error?: components["schemas"]["gelato_session_last_error"] | null; - /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results) */ + /** @description ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://docs.stripe.com/identity/verification-sessions#results) */ last_verification_report?: (string | components["schemas"]["identity.verification_report"]) | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -15136,19 +16352,22 @@ export interface components { provided_details?: components["schemas"]["gelato_provided_details"] | null; /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ redaction?: components["schemas"]["verification_session_redaction"] | null; - /** @description Token referencing a Customer resource. */ + /** @description Customer ID */ related_customer?: string | null; + /** @description The ID of the Account representing a customer. */ + related_customer_account?: string | null; + related_person?: components["schemas"]["gelato_related_person"]; /** - * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). + * @description Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work). * @enum {string} */ status: "canceled" | "processing" | "requires_input" | "verified"; /** - * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + * @description The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. * @enum {string} */ 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. */ + /** @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://docs.stripe.com/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. */ verification_flow?: string; @@ -15186,13 +16405,357 @@ export interface components { /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; /** - * @description The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. + * @description The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach"; /** @description Routing number of the bank account. */ routing_number?: string | null; }; + /** + * InsightsResourcesPaymentEvaluationAddress + * @description Address data. + */ + insights_resources_payment_evaluation_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, such as the street, PO Box, or company name. */ + line1?: string | null; + /** @description Address line 2, such as the apartment, suite, unit, or building. */ + line2?: string | null; + /** @description ZIP or postal code. */ + postal_code?: string | null; + /** @description State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ + state?: string | null; + }; + /** + * InsightsResourcesPaymentEvaluationBillingDetails + * @description Billing details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_billing_details: { + address: components["schemas"]["insights_resources_payment_evaluation_address"]; + /** @description Email address. */ + email?: string | null; + /** @description Full name. */ + name?: string | null; + /** @description Billing phone number (including extension). */ + phone?: string | null; + }; + /** + * InsightsResourcesPaymentEvaluationClientDeviceMetadata + * @description Client device metadata attached to this payment evaluation. + */ + insights_resources_payment_evaluation_client_device_metadata: { + /** @description ID for the Radar Session associated with the payment evaluation. A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. */ + radar_session: string; + }; + /** + * InsightsResourcesPaymentEvaluationCustomerDetails + * @description Customer details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_customer_details: { + /** @description The ID of the customer associated with the payment evaluation. */ + customer?: string | null; + /** @description The ID of the Account representing the customer associated with the payment evaluation. */ + customer_account?: string | null; + /** @description The customer's email address. */ + email?: string | null; + /** @description The customer's full name or business name. */ + name?: string | null; + /** @description The customer's phone number. */ + phone?: string | null; + }; + /** + * InsightsResourcesPaymentEvaluationDisputeOpened + * @description Dispute opened event details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_dispute_opened: { + /** @description Amount to dispute for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency). */ + amount: number; + /** + * Format: 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). + */ + currency: string; + /** + * @description Reason given by cardholder for dispute. + * @enum {string} + */ + reason: "account_not_available" | "credit_not_processed" | "customer_initiated" | "duplicate" | "fraudulent" | "general" | "noncompliant" | "product_not_received" | "product_unacceptable" | "subscription_canceled" | "unrecognized"; + }; + /** + * InsightsResourcesPaymentEvaluationEarlyFraudWarningReceived + * @description Early Fraud Warning Received event details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_early_fraud_warning_received: { + /** + * @description The type of fraud labeled by the issuer. + * @enum {string} + */ + fraud_type: "made_with_lost_card" | "made_with_stolen_card" | "other" | "unauthorized_use_of_card"; + }; + /** + * InsightsResourcesPaymentEvaluationEvent + * @description Event reported for this payment evaluation. + */ + insights_resources_payment_evaluation_event: { + dispute_opened?: components["schemas"]["insights_resources_payment_evaluation_dispute_opened"]; + early_fraud_warning_received?: components["schemas"]["insights_resources_payment_evaluation_early_fraud_warning_received"]; + /** + * Format: unix-time + * @description Timestamp when the event occurred. + */ + occurred_at: number; + refunded?: components["schemas"]["insights_resources_payment_evaluation_refunded"]; + /** + * @description Indicates the type of event attached to the payment evaluation. + * @enum {string} + */ + type: "dispute_opened" | "early_fraud_warning_received" | "refunded" | "user_intervention_raised" | "user_intervention_resolved"; + user_intervention_raised?: components["schemas"]["insights_resources_payment_evaluation_user_intervention_raised"]; + user_intervention_resolved?: components["schemas"]["insights_resources_payment_evaluation_user_intervention_resolved"]; + }; + /** + * InsightsResourcesPaymentEvaluationInsights + * @description Collection of scores and insights for this payment evaluation. + */ + insights_resources_payment_evaluation_insights: { + /** + * Format: unix-time + * @description The timestamp when the evaluation was performed. + */ + evaluated_at: number; + fraudulent_dispute: components["schemas"]["insights_resources_payment_evaluation_scorer"]; + }; + /** + * InsightsResourcesPaymentEvaluationMerchantBlocked + * @description Details of a merchant_blocked outcome attached to this payment evaluation. + */ + insights_resources_payment_evaluation_merchant_blocked: { + /** + * @description The reason the payment was blocked by the merchant. + * @enum {string} + */ + reason: "authentication_required" | "blocked_for_fraud" | "invalid_payment" | "other"; + }; + /** + * InsightsResourcesPaymentEvaluationMoneyMovementCard + * @description Money Movement card details attached to this payment. + */ + insights_resources_payment_evaluation_money_movement_card: { + /** + * @description Describes the presence of the customer during the payment. + * @enum {string|null} + */ + customer_presence?: "off_session" | "on_session" | null; + /** + * @description Describes the type of payment. + * @enum {string|null} + */ + payment_type?: "one_off" | "recurring" | "setup_one_off" | "setup_recurring" | null; + }; + /** + * InsightsResourcesPaymentEvaluationMoneyMovementDetails + * @description Money Movement details attached to this payment. + */ + insights_resources_payment_evaluation_money_movement_details: { + /** @description Describes card money movement details for the payment evaluation. */ + card?: components["schemas"]["insights_resources_payment_evaluation_money_movement_card"] | null; + /** + * @description Describes the type of money movement. Currently only `card` is supported. + * @enum {string} + */ + money_movement_type: "card"; + }; + /** + * InsightsResourcesPaymentEvaluationOutcome + * @description Outcome details for this payment evaluation. + */ + insights_resources_payment_evaluation_outcome: { + merchant_blocked?: components["schemas"]["insights_resources_payment_evaluation_merchant_blocked"]; + /** @description The PaymentIntent ID associated with the payment evaluation. */ + payment_intent_id?: string; + rejected?: components["schemas"]["insights_resources_payment_evaluation_rejected"]; + succeeded?: components["schemas"]["insights_resources_payment_evaluation_succeeded"]; + /** + * @description Indicates the outcome of the payment evaluation. + * @enum {string} + */ + type: "failed" | "merchant_blocked" | "rejected" | "succeeded"; + }; + /** + * InsightsResourcesPaymentEvaluationPaymentDetails + * @description Payment details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_payment_details: { + /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + amount: number; + /** + * Format: 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). + */ + currency: string; + /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + description?: string | null; + /** @description Details about the payment's customer presence and type. */ + money_movement_details?: components["schemas"]["insights_resources_payment_evaluation_money_movement_details"] | null; + /** @description Details about the payment method used for the payment. */ + payment_method_details?: components["schemas"]["insights_resources_payment_evaluation_payment_method_details"] | null; + /** @description Shipping details for the payment evaluation. */ + shipping_details?: components["schemas"]["insights_resources_payment_evaluation_shipping"] | null; + /** @description Payment statement descriptor. */ + statement_descriptor?: string | null; + }; + /** + * InsightsResourcesPaymentEvaluationPaymentMethodDetails + * @description Payment method details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_payment_method_details: { + /** @description Billing information associated with the payment evaluation. */ + billing_details?: components["schemas"]["insights_resources_payment_evaluation_billing_details"] | null; + /** @description The payment method used in this payment evaluation. */ + payment_method: string | components["schemas"]["payment_method"]; + }; + /** + * InsightsResourcesPaymentEvaluationRefunded + * @description Refunded Event details attached to this payment evaluation. + */ + insights_resources_payment_evaluation_refunded: { + /** @description Amount refunded for this payment. A positive integer representing how much to charge in [the smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (for example, 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a zero-decimal currency). */ + amount: number; + /** + * Format: 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). + */ + currency: string; + /** + * @description Indicates the reason for the refund. + * @enum {string} + */ + reason: "duplicate" | "fraudulent" | "other" | "requested_by_customer"; + }; + /** + * InsightsResourcesPaymentEvaluationRejected + * @description Details of an rejected outcome attached to this payment evaluation. + */ + insights_resources_payment_evaluation_rejected: { + card?: components["schemas"]["insights_resources_payment_evaluation_rejected_card"]; + }; + /** + * InsightsResourcesPaymentEvaluationRejectedCard + * @description Details of an rejected card outcome attached to this payment evaluation. + */ + insights_resources_payment_evaluation_rejected_card: { + /** + * @description Result of the address line 1 check. + * @enum {string} + */ + address_line1_check: "fail" | "pass" | "unavailable" | "unchecked"; + /** + * @description Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address. + * @enum {string} + */ + address_postal_code_check: "fail" | "pass" | "unavailable" | "unchecked"; + /** + * @description Result of the CVC check. + * @enum {string} + */ + cvc_check: "fail" | "pass" | "unavailable" | "unchecked"; + /** + * @description Card issuer's reason for the network decline. + * @enum {string} + */ + reason: "authentication_failed" | "do_not_honor" | "expired" | "incorrect_cvc" | "incorrect_number" | "incorrect_postal_code" | "insufficient_funds" | "invalid_account" | "lost_card" | "other" | "processing_error" | "reported_stolen" | "try_again_later"; + }; + /** + * InsightsResourcesPaymentEvaluationScorer + * @description Scores, insights and recommended action for one scorer for this PaymentEvaluation. + */ + insights_resources_payment_evaluation_scorer: { + /** + * @description Recommended action based on the risk score. Possible values are `block` and `continue`. + * @enum {string} + */ + recommended_action: "block" | "continue"; + /** @description Stripe Radar’s evaluation of the risk level of the payment. Possible values for evaluated payments are between 0 and 100, with higher scores indicating higher risk. */ + risk_score: number; + }; + /** + * InsightsResourcesPaymentEvaluationShipping + * @description Shipping details attached to this payment. + */ + insights_resources_payment_evaluation_shipping: { + address: components["schemas"]["insights_resources_payment_evaluation_address"]; + /** @description Shipping name. */ + name?: string | null; + /** @description Shipping phone number. */ + phone?: string | null; + }; + /** + * InsightsResourcesPaymentEvaluationSucceeded + * @description Details of a succeeded outcome attached to this payment evaluation. + */ + insights_resources_payment_evaluation_succeeded: { + card?: components["schemas"]["insights_resources_payment_evaluation_succeeded_card"]; + }; + /** + * InsightsResourcesPaymentEvaluationSucceededCard + * @description Details of an succeeded card outcome attached to this payment evaluation. + */ + insights_resources_payment_evaluation_succeeded_card: { + /** + * @description Result of the address line 1 check. + * @enum {string} + */ + address_line1_check: "fail" | "pass" | "unavailable" | "unchecked"; + /** + * @description Indicates whether the cardholder provided a postal code and if it matched the cardholder’s billing address. + * @enum {string} + */ + address_postal_code_check: "fail" | "pass" | "unavailable" | "unchecked"; + /** + * @description Result of the CVC check. + * @enum {string} + */ + cvc_check: "fail" | "pass" | "unavailable" | "unchecked"; + }; + /** + * InsightsResourcesPaymentEvaluationUserInterventionRaised + * @description User intervention raised event details attached to this payment evaluation + */ + insights_resources_payment_evaluation_user_intervention_raised: { + custom?: components["schemas"]["insights_resources_payment_evaluation_user_intervention_raised_custom"]; + /** @description Unique identifier for the user intervention event. */ + key: string; + /** + * @description Type of user intervention raised. + * @enum {string} + */ + type: "3ds" | "captcha" | "custom"; + }; + /** + * InsightsResourcesPaymentEvaluationUserInterventionRaisedCustom + * @description User intervention raised custom event details attached to this payment evaluation + */ + insights_resources_payment_evaluation_user_intervention_raised_custom: { + /** @description Custom type of user intervention raised. The string must use a snake case description for the type of intervention performed. */ + type: string; + }; + /** + * InsightsResourcesPaymentEvaluationUserInterventionResolved + * @description User Intervention Resolved Event details attached to this payment evaluation + */ + insights_resources_payment_evaluation_user_intervention_resolved: { + /** @description Unique ID of this intervention. Use this to provide the result. */ + key: string; + /** + * @description Result of the intervention if it has been completed. + * @enum {string|null} + */ + outcome?: "abandoned" | "failed" | "passed" | null; + }; /** internal_card */ internal_card: { /** @description Brand of the card used in the transaction */ @@ -15211,13 +16774,13 @@ export interface components { * @description Invoices are statements of amounts owed by a customer, and are either * generated one-off, or generated periodically from a subscription. * - * They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments + * They contain [invoice items](https://api.stripe.com#invoiceitems), and proration adjustments * that may be caused by subscription upgrades/downgrades (if necessary). * * If your invoice is configured to be billed through automatic charges, * Stripe automatically finalizes your invoice and attempts payment. Note * that finalizing the invoice, - * [when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does + * [when automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does * not happen immediately as the invoice is created. Stripe waits * until one hour after the last webhook was successfully sent (or the last * webhook timed out after failing). If you (and the platforms you may have @@ -15237,9 +16800,9 @@ export interface components { * customer's credit balance which is applied to the next invoice. * * More details on the customer's credit balance are - * [here](https://stripe.com/docs/billing/customer/balance). + * [here](https://docs.stripe.com/billing/customer/balance). * - * Related guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending) + * Related guide: [Send invoices to customers](https://docs.stripe.com/billing/invoices/sending) */ invoice: { /** @description The country of the business associated with this invoice, most often the business creating the invoice. */ @@ -15250,6 +16813,8 @@ export interface components { account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; /** @description Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. */ amount_due: number; + /** @description Amount that was overpaid on the invoice. The amount overpaid is credited to the customer's credit balance. */ + amount_overpaid: number; /** @description The amount, in cents (or local equivalent), that was paid. */ amount_paid: number; /** @description The difference between amount_due and amount_paid, in cents (or local equivalent). */ @@ -15258,14 +16823,12 @@ export interface components { amount_shipping: number; /** @description ID of the Connect Application that created the invoice. */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; - /** @description The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid. */ - application_fee_amount?: number | null; /** @description Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained. */ attempt_count: number; /** @description Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users. */ attempted: boolean; - /** @description Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ - auto_advance?: boolean; + /** @description Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ + auto_advance: boolean; automatic_tax: components["schemas"]["automatic_tax"]; /** * Format: unix-time @@ -15281,17 +16844,17 @@ export interface components { * * `subscription_cycle`: A subscription advanced into a new period. * * `subscription_threshold`: A subscription reached a billing threshold. * * `subscription_update`: A subscription was updated. - * * `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint. + * * `upcoming`: Reserved for upcoming invoices created through the Create Preview Invoice API or when an `invoice.upcoming` event is generated for an upcoming invoice on a subscription. * @enum {string|null} */ billing_reason?: "automatic_pending_invoice_item_invoice" | "manual" | "quote_accept" | "subscription" | "subscription_create" | "subscription_cycle" | "subscription_threshold" | "subscription_update" | "upcoming" | null; - /** @description ID of the latest charge generated for this invoice, if any. */ - charge?: (string | components["schemas"]["charge"]) | null; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. * @enum {string} */ collection_method: "charge_automatically" | "send_invoice"; + /** @description The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization. */ + confirmation_secret?: components["schemas"]["invoices_resource_confirmation_secret"] | null; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -15304,8 +16867,10 @@ export interface components { currency: string; /** @description Custom fields displayed on the invoice. */ custom_fields?: components["schemas"]["invoice_setting_custom_field"][] | null; - /** @description The ID of the customer who will be billed. */ - customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The ID of the customer to bill. */ + customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description The ID of the account representing the customer to bill. */ + customer_account?: string | null; /** @description The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated. */ customer_address?: components["schemas"]["address"] | null; /** @description The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated. */ @@ -15331,8 +16896,6 @@ export interface components { default_tax_rates: components["schemas"]["tax_rate"][]; /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ description?: string | null; - /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ - discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"])[]; /** @@ -15349,12 +16912,12 @@ export interface components { ending_balance?: number | null; /** @description Footer displayed on the invoice. */ footer?: string | null; - /** @description Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. */ + /** @description Details of the invoice that was cloned. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details. */ from_invoice?: components["schemas"]["invoices_resource_from_invoice"] | null; /** @description The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. */ hosted_invoice_url?: string | null; - /** @description Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. */ - id?: string; + /** @description Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`. */ + id: string; /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ invoice_pdf?: string | null; issuer: components["schemas"]["connect_account_reference"]; @@ -15381,7 +16944,7 @@ export interface components { }; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -15397,15 +16960,28 @@ export interface components { * @enum {string} */ object: "invoice"; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance. */ - paid: boolean; - /** @description Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe. */ - paid_out_of_band: boolean; - /** @description The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent. */ - payment_intent?: (string | components["schemas"]["payment_intent"]) | null; + /** @description The parent that generated this invoice */ + parent?: components["schemas"]["billing_bill_resource_invoicing_parents_invoice_parent"] | null; payment_settings: components["schemas"]["invoices_payment_settings"]; + /** + * InvoicesPaymentsListInvoicePayments + * @description Payments for this invoice. Use [invoice payment](/api/invoice-payment) to get more details. + */ + payments?: { + /** @description Details about each object. */ + data: components["schemas"]["invoice_payment"][]; + /** @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; + }; /** * Format: unix-time * @description End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. @@ -15420,8 +16996,6 @@ export interface components { post_payment_credit_notes_amount: number; /** @description Total amount of all pre-payment credit notes issued for this invoice. */ pre_payment_credit_notes_amount: number; - /** @description The quote this invoice was generated from. */ - quote?: (string | components["schemas"]["quote"]) | null; /** @description This is the transaction number that appears on email receipts sent for this invoice. */ receipt_number?: string | null; /** @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ @@ -15435,23 +17009,15 @@ export interface components { /** @description Extra information about an invoice for the customer's credit card statement. */ statement_descriptor?: string | null; /** - * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + * @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) * @enum {string|null} */ status?: "draft" | "open" | "paid" | "uncollectible" | "void" | null; status_transitions: components["schemas"]["invoices_resource_status_transitions"]; - /** @description The subscription that this invoice was prepared for, if any. */ - subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description Details about the subscription that created this invoice. */ - subscription_details?: components["schemas"]["subscription_details_data"] | null; - /** @description Only set for upcoming invoices that preview prorations. The time used to calculate prorations. */ - subscription_proration_date?: number; /** @description Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated */ subtotal: number; /** @description The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated */ subtotal_excluding_tax?: number | null; - /** @description The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice. */ - tax?: number | null; /** @description ID of the test clock this invoice belongs to. */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; threshold_reason?: components["schemas"]["invoice_threshold_reason"]; @@ -15463,13 +17029,11 @@ export interface components { 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. */ - transfer_data?: components["schemas"]["invoice_transfer_data"] | null; + /** @description The aggregate tax information of all line items. */ + total_taxes?: components["schemas"]["billing_bill_resource_invoicing_taxes_tax"][] | null; /** * Format: unix-time - * @description Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. + * @description Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. */ webhooks_delivered_at?: number | null; }; @@ -15510,6 +17074,62 @@ export interface components { /** @description A description of the mandate or subscription that is meant to be displayed to the customer. */ description?: string | null; }; + /** invoice_mandate_options_payto */ + invoice_mandate_options_payto: { + /** @description The maximum amount that can be collected in a single invoice. If you don't specify a maximum, then there is no limit. */ + amount?: number | null; + /** + * @description Only `maximum` is supported. + * @enum {string|null} + */ + amount_type?: "fixed" | "maximum" | null; + /** + * @description The purpose for which payments are made. Has a default value based on your merchant category code. + * @enum {string|null} + */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility" | null; + }; + /** + * InvoicesInvoicePayment + * @description Invoice Payments represent payments made against invoices. Invoice Payments can + * be accessed in two ways: + * 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#invoice) resource. + * 2. By using the Invoice Payment retrieve and list endpoints. + * + * Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices. + * This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and + * monitor the allocation details of the payments. + */ + invoice_payment: { + /** @description Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent’s `amount_received` is not sufficient to pay all of the invoices that it is attached to. */ + amount_paid?: number | null; + /** @description Amount intended to be paid toward this invoice, in cents (or local equivalent) */ + amount_requested: number; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + 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 Unique identifier for the object. */ + id: string; + /** @description The invoice that was paid. */ + invoice: string | components["schemas"]["invoice"] | components["schemas"]["deleted_invoice"]; + /** @description Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s `amount_remaining`. The PaymentIntent associated with the default payment can’t be edited or canceled directly. */ + is_default: boolean; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "invoice_payment"; + payment: components["schemas"]["invoices_payments_invoice_payment_associated_payment"]; + /** @description The status of the payment, one of `open`, `paid`, or `canceled`. */ + status: string; + status_transitions: components["schemas"]["invoices_payments_invoice_payment_status_transitions"]; + }; /** invoice_payment_method_options_acss_debit */ invoice_payment_method_options_acss_debit: { mandate_options?: components["schemas"]["invoice_payment_method_options_acss_debit_mandate_options"]; @@ -15539,7 +17159,7 @@ export interface components { invoice_payment_method_options_card: { installments?: components["schemas"]["invoice_installments_card"]; /** - * @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. + * @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://docs.stripe.com/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://docs.stripe.com/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} */ request_three_d_secure?: "any" | "automatic" | "challenge" | null; @@ -15562,13 +17182,17 @@ export interface components { /** invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer */ invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer: { /** - * @description The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + * @description The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. * @enum {string} */ country: "BE" | "DE" | "ES" | "FR" | "IE" | "NL"; }; /** invoice_payment_method_options_konbini */ invoice_payment_method_options_konbini: Record; + /** invoice_payment_method_options_payto */ + invoice_payment_method_options_payto: { + mandate_options?: components["schemas"]["invoice_mandate_options_payto"]; + }; /** invoice_payment_method_options_sepa_debit */ invoice_payment_method_options_sepa_debit: Record; /** invoice_payment_method_options_us_bank_account */ @@ -15616,7 +17240,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -15635,6 +17259,13 @@ export interface components { /** @description Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering */ version: number; }; + /** invoice_setting_checkout_rendering_options */ + invoice_setting_checkout_rendering_options: { + /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + amount_tax_display?: string | null; + /** @description ID of the invoice rendering template to be used for the generated invoice. */ + template?: string | null; + }; /** InvoiceSettingCustomField */ invoice_setting_custom_field: { /** @description The name of the custom field. */ @@ -15666,11 +17297,6 @@ export interface components { days_until_due?: number | null; issuer: components["schemas"]["connect_account_reference"]; }; - /** InvoiceSettingRenderingOptions */ - invoice_setting_rendering_options: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ - amount_tax_display?: string | null; - }; /** InvoiceSettingSubscriptionSchedulePhaseSetting */ invoice_setting_subscription_schedule_phase_setting: { /** @description The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. */ @@ -15688,22 +17314,6 @@ export interface components { days_until_due?: number | null; issuer: components["schemas"]["connect_account_reference"]; }; - /** InvoiceTaxAmount */ - invoice_tax_amount: { - /** @description The amount, in cents (or local equivalent), of the tax. */ - amount: number; - /** @description Whether this tax amount is inclusive or exclusive. */ - inclusive: boolean; - /** @description The tax rate that was applied to get this tax amount. */ - tax_rate: string | components["schemas"]["tax_rate"]; - /** - * @description The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported. - * @enum {string|null} - */ - taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated" | null; - /** @description The amount on which tax is calculated, in cents (or local equivalent). */ - taxable_amount?: number | null; - }; /** InvoiceThresholdReason */ invoice_threshold_reason: { /** @description The total invoice amount threshold boundary if it triggered the threshold invoice. */ @@ -15711,26 +17321,16 @@ export interface components { /** @description Indicates which line items triggered a threshold invoice. */ item_reasons: components["schemas"]["invoice_item_threshold_reason"][]; }; - /** InvoiceTransferData */ - invoice_transfer_data: { - /** @description The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination. */ - amount?: number | null; - /** @description The account where funds from the payment will be transferred to upon payment success. */ - destination: string | components["schemas"]["account"]; - }; /** * InvoiceItem - * @description Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an - * invoice by creating or updating it with an `invoice` field, at which point it will be included as - * [an invoice line item](https://stripe.com/docs/api/invoices/line_item) within - * [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines). + * @description Invoice Items represent the component lines of an [invoice](https://docs.stripe.com/api/invoices). When you create an invoice item with an `invoice` field, it is attached to the specified invoice and included as [an invoice line item](https://docs.stripe.com/api/invoices/line_item) within [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines). * * Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined - * with a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge - * or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges + * with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge + * or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges * (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals. * - * Related guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). + * Related guides: [Integrate with the Invoicing API](https://docs.stripe.com/invoicing/integration), [Subscription Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items). */ invoiceitem: { /** @description Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`. */ @@ -15740,8 +17340,10 @@ export interface components { * @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 The ID of the customer who will be billed when this invoice item is billed. */ + /** @description The ID of the customer to bill for this invoice item. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description The ID of the account to bill for this invoice item. */ + customer_account?: string | null; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -15759,37 +17361,31 @@ export interface components { invoice?: (string | components["schemas"]["invoice"]) | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 The amount after discounts, but before credits and taxes. This field is `null` for `discountable=true` items. */ + net_amount?: number; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} */ object: "invoiceitem"; + /** @description The parent that generated this invoice item. */ + parent?: components["schemas"]["billing_bill_resource_invoice_item_parents_invoice_item_parent"] | null; period: components["schemas"]["invoice_line_item_period"]; - /** @description The price of the invoice item. */ - price?: components["schemas"]["price"] | null; + /** @description The pricing information of the invoice item. */ + pricing?: components["schemas"]["billing_bill_resource_invoicing_pricing_pricing"] | null; /** @description Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. */ proration: boolean; + proration_details?: components["schemas"]["proration_details"]; /** @description Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. */ quantity: number; - /** @description The subscription that this invoice item has been created for, if any. */ - subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description The subscription item that this invoice item has been created for, if any. */ - subscription_item?: string; /** @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. */ tax_rates?: components["schemas"]["tax_rate"][] | null; /** @description ID of the test clock this invoice item belongs to. */ test_clock?: (string | components["schemas"]["test_helpers.test_clock"]) | null; - /** @description Unit amount (in the `currency` specified) of the invoice item. */ - unit_amount?: number | null; - /** - * Format: decimal - * @description Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. - */ - unit_amount_decimal?: string | null; }; /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { @@ -15803,6 +17399,8 @@ export interface components { customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; /** @description If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; + /** @description If paying by `payto`, this sub-hash contains details about the PayTo payment method options to pass to the invoice’s PaymentIntent. */ + payto?: components["schemas"]["invoice_payment_method_options_payto"] | null; /** @description If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. */ sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; /** @description If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. */ @@ -15815,7 +17413,41 @@ 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" | "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; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; + }; + /** InvoicesPaymentsInvoicePaymentAssociatedPayment */ + invoices_payments_invoice_payment_associated_payment: { + /** @description ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead. */ + charge?: string | components["schemas"]["charge"]; + /** @description ID of the PaymentIntent associated with this payment when `type` is `payment_intent`. Note: This property is only populated for invoices finalized on or after March 15th, 2019. */ + payment_intent?: string | components["schemas"]["payment_intent"]; + /** @description ID of the PaymentRecord associated with this payment when `type` is `payment_record`. */ + payment_record?: string | components["schemas"]["payment_record"]; + /** + * @description Type of payment object associated with this invoice payment. + * @enum {string} + */ + type: "charge" | "payment_intent" | "payment_record"; + }; + /** InvoicesPaymentsInvoicePaymentStatusTransitions */ + invoices_payments_invoice_payment_status_transitions: { + /** + * Format: unix-time + * @description The time that the payment was canceled. + */ + canceled_at?: number | null; + /** + * Format: unix-time + * @description The time that the payment succeeded. + */ + paid_at?: number | null; + }; + /** InvoicesResourceConfirmationSecret */ + invoices_resource_confirmation_secret: { + /** @description The client_secret of the payment that Stripe creates for the invoice after finalization. */ + client_secret: string; + /** @description The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization */ + type: string; }; /** InvoicesResourceFromInvoice */ invoices_resource_from_invoice: { @@ -15838,25 +17470,13 @@ 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`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` + * @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`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value?: string | null; }; - /** InvoicesResourceLineItemsCreditedItems */ - invoices_resource_line_items_credited_items: { - /** @description Invoice containing the credited invoice line items */ - invoice: string; - /** @description Credited invoice line items */ - invoice_line_items: string[]; - }; - /** InvoicesResourceLineItemsProrationDetails */ - invoices_resource_line_items_proration_details: { - /** @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. */ @@ -15909,16 +17529,16 @@ export interface components { }; /** * IssuingAuthorization - * @description When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization` - * object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the + * @description When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` + * object is created. [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the * purchase to be completed successfully. * - * Related guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + * Related guide: [Issued card authorizations](https://docs.stripe.com/issuing/purchases/authorizations) */ "issuing.authorization": { /** @description The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different. */ amount: number; - /** @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). */ + /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_details?: components["schemas"]["issuing_authorization_amount_details"] | null; /** @description Whether the authorization has been approved. */ approved: boolean; @@ -15960,7 +17580,7 @@ export interface components { */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -15979,12 +17599,12 @@ export interface components { * @description The current status of the authorization in its lifecycle. * @enum {string} */ - status: "closed" | "pending" | "reversed"; - /** @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. */ + status: "closed" | "expired" | "pending" | "reversed"; + /** @description [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. */ token?: (string | components["schemas"]["issuing.token"]) | null; - /** @description List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization. */ + /** @description List of [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. */ transactions: components["schemas"]["issuing.transaction"][]; - /** @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). */ + /** @description [Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://docs.stripe.com/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. */ @@ -15994,7 +17614,7 @@ export interface components { }; /** * IssuingCard - * @description You can [create physical or virtual cards](https://stripe.com/docs/issuing) that are issued to cardholders. + * @description You can [create physical or virtual cards](https://docs.stripe.com/issuing) that are issued to cardholders. */ "issuing.card": { /** @description The brand of the card. */ @@ -16015,7 +17635,7 @@ export interface components { * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK. */ currency: string; - /** @description The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ + /** @description The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ cvc?: string; /** @description The expiration month of the card. */ exp_month: number; @@ -16027,13 +17647,15 @@ export interface components { id: string; /** @description The last 4 digits of the card number. */ last4: string; + /** @description Stripe’s assessment of whether this card’s details have been compromised. If this property isn't null, cancel and reissue the card to prevent fraudulent activity risk. */ + latest_fraud_warning?: components["schemas"]["issuing_card_fraud_warning"] | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ + /** @description The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. */ number?: string; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -16051,6 +17673,8 @@ export interface components { * @enum {string|null} */ replacement_reason?: "damaged" | "expired" | "lost" | "stolen" | null; + /** @description Text separate from cardholder name, printed on the card. */ + second_line?: string | null; /** @description Where and how the card will be shipped. */ shipping?: components["schemas"]["issuing_card_shipping"] | null; spending_controls: components["schemas"]["issuing_card_authorization_controls"]; @@ -16069,9 +17693,9 @@ export interface components { }; /** * IssuingCardholder - * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards. + * @description An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://docs.stripe.com/issuing) cards. * - * Related guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder) + * Related guide: [How to create a cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) */ "issuing.cardholder": { billing: components["schemas"]["issuing_cardholder_address"]; @@ -16090,7 +17714,7 @@ export interface components { individual?: components["schemas"]["issuing_cardholder_individual"] | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -16101,15 +17725,15 @@ export interface components { * @enum {string} */ object: "issuing.cardholder"; - /** @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ + /** @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ phone_number?: string | null; /** * @description The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - * This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + * This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. */ preferred_locales?: ("de" | "en" | "es" | "fr" | "it")[] | null; requirements: components["schemas"]["issuing_cardholder_requirements"]; - /** @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. */ + /** @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. */ spending_controls?: components["schemas"]["issuing_cardholder_authorization_controls"] | null; /** * @description Specifies whether to permit authorizations on this cardholder's cards. @@ -16117,19 +17741,19 @@ export interface components { */ status: "active" | "blocked" | "inactive"; /** - * @description One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. + * @description One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. * @enum {string} */ type: "company" | "individual"; }; /** * IssuingDispute - * @description As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. + * @description As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. * - * Related guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes) + * Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes) */ "issuing.dispute": { - /** @description Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ + /** @description Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). */ amount: number; /** @description List of balance transactions associated with the dispute. */ balance_transactions?: components["schemas"]["balance_transaction"][] | null; @@ -16153,7 +17777,7 @@ export interface components { * @enum {string} */ loss_reason?: "cardholder_authentication_issuer_liability" | "eci5_token_transaction_with_tavv" | "excess_disputes_in_timeframe" | "has_not_met_the_minimum_dispute_amount_requirements" | "invalid_duplicate_dispute" | "invalid_incorrect_amount_dispute" | "invalid_no_authorization" | "invalid_use_of_disputes" | "merchandise_delivered_or_shipped" | "merchandise_or_service_as_described" | "not_cancelled" | "other" | "refund_issued" | "submitted_beyond_allowable_time_limit" | "transaction_3ds_required" | "transaction_approved_after_prior_fraud_dispute" | "transaction_authorized" | "transaction_electronically_read" | "transaction_qualifies_for_visa_easy_payment_service" | "transaction_unattended"; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -16169,7 +17793,7 @@ export interface components { status: "expired" | "lost" | "submitted" | "unsubmitted" | "won"; /** @description The transaction being disputed. */ transaction: string | components["schemas"]["issuing.transaction"]; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ + /** @description [Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ treasury?: components["schemas"]["issuing_dispute_treasury"] | null; }; /** @@ -16192,7 +17816,7 @@ export interface components { livemode: boolean; /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ lookup_key?: string | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -16243,7 +17867,7 @@ export interface components { }; /** * IssuingSettlement - * @description When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. + * @description When a non-stripe BIN is used, any use of an [issued card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. */ "issuing.settlement": { /** @description The Bank Identification Number reflecting this settlement record. */ @@ -16266,22 +17890,22 @@ export interface components { /** @description Unique identifier for the object. */ id: string; /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees: number; + interchange_fees_amount: number; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 The total net amount required to settle with the network. */ - net_total: number; + net_total_amount: number; /** * @description The card network for this settlement report. One of ["visa", "maestro"] * @enum {string} */ network: "maestro" | "visa"; /** @description The total amount of fees owed to the network. */ - network_fees: number; + network_fees_amount: number; /** @description The Settlement Identification Number assigned by the network. */ network_settlement_identifier: string; /** @@ -16296,14 +17920,14 @@ export interface components { * @enum {string} */ status: "complete" | "pending"; + /** @description The total transaction amount reflected in this settlement. */ + transaction_amount: number; /** @description The total number of transactions reflected in this settlement. */ transaction_count: number; - /** @description The total transaction amount reflected in this settlement. */ - transaction_volume: number; }; /** * IssuingNetworkToken - * @description An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe. + * @description An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe. */ "issuing.token": { /** @description Card associated with this token. */ @@ -16350,20 +17974,20 @@ export interface components { }; /** * IssuingTransaction - * @description Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving + * @description Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving * your Stripe account, such as a completed purchase or refund, is represented by an Issuing * `Transaction` object. * - * Related guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions) + * Related guide: [Issued card transactions](https://docs.stripe.com/issuing/purchases/transactions) */ "issuing.transaction": { - /** @description The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; - /** @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). */ + /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_details?: components["schemas"]["issuing_transaction_amount_details"] | null; /** @description The `Authorization` object that led to this transaction. */ authorization?: (string | components["schemas"]["issuing.authorization"]) | null; - /** @description ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction. */ + /** @description ID of the [balance transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction. */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; /** @description The card used to make this transaction. */ card: string | components["schemas"]["issuing.card"]; @@ -16385,7 +18009,7 @@ 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 The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ + /** @description The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. */ merchant_amount: number; /** * Format: currency @@ -16393,7 +18017,7 @@ export interface components { */ merchant_currency: string; merchant_data: components["schemas"]["issuing_authorization_merchant_data"]; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -16406,9 +18030,9 @@ export interface components { object: "issuing.transaction"; /** @description Additional purchase information that is optionally provided by the merchant. */ purchase_details?: components["schemas"]["issuing_transaction_purchase_details"] | null; - /** @description [Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. */ + /** @description [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. */ token?: (string | components["schemas"]["issuing.token"]) | null; - /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ + /** @description [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ treasury?: components["schemas"]["issuing_transaction_treasury"] | null; /** * @description The nature of the transaction. @@ -16556,7 +18180,7 @@ export interface components { }; /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { - /** @description A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values. */ + /** @description A categorization of the seller's type of business. See our [merchant categories guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. */ category: string; /** @description The merchant category code for the seller’s business */ category_code: string; @@ -16590,18 +18214,18 @@ export interface components { }; /** IssuingAuthorizationPendingRequest */ issuing_authorization_pending_request: { - /** @description The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; - /** @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). */ + /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_details?: components["schemas"]["issuing_authorization_amount_details"] | null; /** * Format: 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). */ currency: string; - /** @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. */ + /** @description If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ is_amount_controllable: boolean; - /** @description The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ merchant_amount: number; /** * Format: currency @@ -16613,9 +18237,9 @@ export interface components { }; /** IssuingAuthorizationRequest */ issuing_authorization_request: { - /** @description The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. */ + /** @description The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. */ amount: number; - /** @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). */ + /** @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_details?: components["schemas"]["issuing_authorization_amount_details"] | null; /** @description Whether this request was approved. */ approved: boolean; @@ -16628,7 +18252,7 @@ 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 The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ merchant_amount: number; /** @description The currency that was collected by the merchant and presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */ merchant_currency: string; @@ -16638,7 +18262,7 @@ export interface components { * @description When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome. * @enum {string} */ - reason: "account_disabled" | "card_active" | "card_canceled" | "card_expired" | "card_inactive" | "cardholder_blocked" | "cardholder_inactive" | "cardholder_verification_required" | "insecure_authorization_method" | "insufficient_funds" | "not_allowed" | "pin_blocked" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; + reason: "account_disabled" | "card_active" | "card_canceled" | "card_expired" | "card_inactive" | "cardholder_blocked" | "cardholder_inactive" | "cardholder_verification_required" | "insecure_authorization_method" | "insufficient_funds" | "network_fallback" | "not_allowed" | "pin_blocked" | "spending_controls" | "suspected_fraud" | "verification_failed" | "webhook_approved" | "webhook_declined" | "webhook_error" | "webhook_timeout"; /** @description If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field. */ reason_message?: string | null; /** @@ -16657,11 +18281,11 @@ export interface components { }; /** IssuingAuthorizationTreasury */ issuing_authorization_treasury: { - /** @description The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization */ + /** @description The array of [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization */ received_credits: string[]; - /** @description The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization */ + /** @description The array of [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization */ received_debits: string[]; - /** @description The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization */ + /** @description The Treasury [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization */ transaction?: string | null; }; /** IssuingAuthorizationVerificationData */ @@ -16705,11 +18329,11 @@ export interface components { }; /** IssuingCardAuthorizationControls */ issuing_card_authorization_controls: { - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /** @description Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ allowed_merchant_countries?: string[] | null; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /** @description Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ blocked_merchant_countries?: string[] | null; @@ -16721,6 +18345,19 @@ export interface components { */ spending_limits_currency?: string | null; }; + /** IssuingCardFraudWarning */ + issuing_card_fraud_warning: { + /** + * Format: unix-time + * @description Timestamp of the most recent fraud warning. + */ + started_at?: number | null; + /** + * @description The type of fraud warning that most recently took place on this card. This field updates with every new fraud warning, so the value changes over time. If populated, cancel and reissue the card. + * @enum {string|null} + */ + type?: "card_testing_exposure" | "fraud_dispute_filed" | "third_party_reported" | "user_indicated_fraud" | null; + }; /** IssuingCardGooglePay */ issuing_card_google_pay: { /** @description Google Pay Eligibility */ @@ -16796,9 +18433,9 @@ export interface components { }; /** IssuingCardSpendingLimit */ issuing_card_spending_limit: { - /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /** @description Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** * @description Interval (or event) to which the amount applies. @@ -16819,11 +18456,11 @@ export interface components { }; /** IssuingCardholderAuthorizationControls */ issuing_cardholder_authorization_controls: { - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ + /** @description Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ allowed_merchant_countries?: string[] | null; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ + /** @description Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ blocked_merchant_countries?: string[] | null; @@ -16847,9 +18484,9 @@ export interface components { }; /** IssuingCardholderIdDocument */ issuing_cardholder_id_document: { - /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** @description The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. */ back?: (string | components["schemas"]["file"]) | null; - /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** @description The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. */ front?: (string | components["schemas"]["file"]) | null; }; /** IssuingCardholderIndividual */ @@ -16886,9 +18523,9 @@ export interface components { }; /** IssuingCardholderSpendingLimit */ issuing_cardholder_spending_limit: { - /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; - /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ + /** @description Array of strings containing [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. */ categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; /** * @description Interval (or event) to which the amount applies. @@ -17074,9 +18711,9 @@ export interface components { }; /** IssuingDisputeTreasury */ issuing_dispute_treasury: { - /** @description The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute */ + /** @description The Treasury [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute */ debit_reversal?: string | null; - /** @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed. */ + /** @description The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed. */ received_debit: string; }; /** IssuingNetworkTokenAddress */ @@ -17369,9 +19006,9 @@ export interface components { }; /** IssuingTransactionTreasury */ issuing_transaction_treasury: { - /** @description The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund */ + /** @description The Treasury [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund */ received_credit?: string | null; - /** @description The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture */ + /** @description The Treasury [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture */ received_debit?: string | null; }; /** @@ -17379,6 +19016,7 @@ export interface components { * @description A line item. */ item: { + adjustable_quantity?: components["schemas"]["line_items_adjustable_quantity"] | null; /** @description Total discount amount applied. If no discounts were applied, defaults to 0. */ amount_discount: number; /** @description Total before any discounts or taxes are applied. */ @@ -17398,6 +19036,10 @@ export interface components { discounts?: components["schemas"]["line_items_discount_amount"][]; /** @description Unique identifier for the object. */ id: string; + /** @description Set of [key-value pairs](https://docs.stripe.com/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} @@ -17427,32 +19069,38 @@ export interface components { address_kana?: components["schemas"]["legal_entity_japan_address"] | null; /** @description The Kanji variation of the company's primary address (Japan only). */ address_kanji?: components["schemas"]["legal_entity_japan_address"] | null; - /** @description Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). */ + /** @description Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided). */ directors_provided?: boolean; /** @description This hash is used to attest that the director information provided to Stripe is both current and correct. */ directorship_declaration?: components["schemas"]["legal_entity_directorship_declaration"] | null; - /** @description Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. */ + /** @description Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. */ executives_provided?: boolean; /** @description The export license ID number of the company, also referred as Import Export Code (India only). */ export_license_id?: string; /** @description The purpose code to use for export transactions (India only). */ export_purpose_code?: string; - /** @description The company's legal name. */ + /** @description The company's legal name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ name?: string | null; - /** @description The Kana variation of the company's legal name (Japan only). */ + /** @description The Kana variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ name_kana?: string | null; - /** @description The Kanji variation of the company's legal name (Japan only). */ + /** @description The Kanji variation of the company's legal name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ name_kanji?: string | null; - /** @description Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). */ + /** @description Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together). */ owners_provided?: boolean; /** @description This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct. */ ownership_declaration?: components["schemas"]["legal_entity_ubo_declaration"] | null; - /** @enum {string} */ + /** + * @description This value is used to determine if a business is exempt from providing ultimate beneficial owners. See [this support article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) and [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) for more details. + * @enum {string} + */ ownership_exemption_reason?: "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; /** @description The company's phone number (used for verification). */ phone?: string | null; + registration_date?: components["schemas"]["legal_entity_registration_date"]; + /** @description This hash is used to attest that the representative is authorized to act as the representative of their legal entity. */ + representative_declaration?: components["schemas"]["legal_entity_representative_declaration"] | null; /** - * @description The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. + * @description The category identifying the legal structure of the company or legal entity. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. See [Business structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. * @enum {string} */ structure?: "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; @@ -17471,13 +19119,13 @@ export interface components { }; /** LegalEntityCompanyVerificationDocument */ legal_entity_company_verification_document: { - /** @description The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /** @description The back of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file). */ back?: (string | components["schemas"]["file"]) | null; /** @description A user-displayable string describing the verification state of this document. */ details?: string | null; /** @description One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document. */ details_code?: string | null; - /** @description The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`. */ + /** @description The front of a document returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `additional_verification`. Note that `additional_verification` files are [not downloadable](/file-upload#uploading-a-file). */ front?: (string | components["schemas"]["file"]) | null; }; /** LegalEntityDirectorshipDeclaration */ @@ -17527,20 +19175,41 @@ export interface components { /** @description One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person. */ details_code?: string | null; document?: components["schemas"]["legal_entity_person_verification_document"]; - /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. */ + /** @description The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`. Please refer [guide](https://docs.stripe.com/connect/handling-api-verification) to handle verification updates. */ status: string; }; /** LegalEntityPersonVerificationDocument */ legal_entity_person_verification_document: { - /** @description The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** @description The back of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. */ back?: (string | components["schemas"]["file"]) | null; /** @description A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say "Identity document is too unclear to read". */ details?: string | null; /** @description One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document. */ details_code?: string | null; - /** @description The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`. */ + /** @description The front of an ID returned by a [file upload](https://api.stripe.com#create_file) with a `purpose` value of `identity_document`. */ front?: (string | components["schemas"]["file"]) | null; }; + /** LegalEntityRegistrationDate */ + legal_entity_registration_date: { + /** @description The day of registration, between 1 and 31. */ + day?: number | null; + /** @description The month of registration, between 1 and 12. */ + month?: number | null; + /** @description The four-digit year of registration. */ + year?: number | null; + }; + /** LegalEntityRepresentativeDeclaration */ + legal_entity_representative_declaration: { + /** + * Format: unix-time + * @description The Unix timestamp marking when the representative declaration attestation was made. + */ + date?: number | null; + /** @description The IP address from which the representative declaration attestation was made. */ + ip?: string | null; + /** @description The user-agent string from the browser where the representative declaration attestation was made. */ + user_agent?: string | null; + }; /** LegalEntityUBODeclaration */ legal_entity_ubo_declaration: { /** @@ -17555,15 +19224,13 @@ export interface components { }; /** * InvoiceLineItem - * @description Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice. + * @description Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice. * - * Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items). + * Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items). */ line_item: { /** @description The amount, in cents (or local equivalent). */ amount: number; - /** @description The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts. */ - amount_excluding_tax?: number | null; /** * Format: 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). @@ -17581,11 +19248,9 @@ export interface components { id: string; /** @description The ID of the invoice that contains this line item. */ invoice?: string | null; - /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ - invoice_item?: string | components["schemas"]["invoiceitem"]; /** @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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. */ metadata: { [key: string]: string; }; @@ -17594,35 +19259,26 @@ export interface components { * @enum {string} */ object: "line_item"; + /** @description The parent that generated this line item. */ + parent?: components["schemas"]["billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent"] | null; 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. */ - proration: boolean; - /** @description Additional details for proration line items */ - proration_details?: components["schemas"]["invoices_resource_line_items_proration_details"] | null; + /** @description The pricing information of the line item. */ + pricing?: components["schemas"]["billing_bill_resource_invoicing_pricing_pricing"] | null; /** @description The quantity of the subscription, if the line item is a subscription or a proration. */ quantity?: number | null; - /** @description The subscription that the invoice item pertains to, if any. */ subscription?: (string | components["schemas"]["subscription"]) | null; - /** @description The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription. */ - subscription_item?: string | components["schemas"]["subscription_item"]; - /** @description The amount of tax calculated per tax rate for this line item */ - tax_amounts: components["schemas"]["invoice_tax_amount"][]; - /** @description The tax rates which apply to the line item. */ - tax_rates: components["schemas"]["tax_rate"][]; - /** - * @description A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`. - * @enum {string} - */ - type: "invoiceitem" | "subscription"; - /** - * Format: decimal - * @description The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts. - */ - unit_amount_excluding_tax?: string | null; + /** @description The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes. */ + subtotal: number; + /** @description The tax information of the line item. */ + taxes?: components["schemas"]["billing_bill_resource_invoicing_taxes_tax"][] | null; + }; + /** LineItemsAdjustableQuantity */ + line_items_adjustable_quantity: { + enabled: boolean; + maximum?: number | null; + minimum?: number | null; }; /** LineItemsDiscountAmount */ line_items_discount_amount: { @@ -17643,9 +19299,9 @@ export interface components { /** @description The amount on which tax is calculated, in cents (or local equivalent). */ taxable_amount?: number | null; }; - /** linked_account_options_us_bank_account */ - linked_account_options_us_bank_account: { - filters?: components["schemas"]["payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters"]; + /** linked_account_options_common */ + linked_account_options_common: { + filters?: components["schemas"]["payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters"]; /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description Data features requested to be retrieved upon account creation. */ @@ -17655,7 +19311,8 @@ export interface components { }; /** * LoginLink - * @description Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard. + * @description Login Links are single-use URLs that takes an Express account to the login page for their Stripe dashboard. + * A Login Link differs from an [Account Link](https://docs.stripe.com/api/account_links) in that it takes the user directly to their [Express dashboard for the specified account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link) */ login_link: { /** @@ -17730,6 +19387,8 @@ export interface components { }; /** mandate_bacs_debit */ mandate_bacs_debit: { + /** @description The display name for the account on this mandate. */ + display_name?: string | null; /** * @description The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`. * @enum {string} @@ -17742,6 +19401,8 @@ export interface components { * @enum {string|null} */ revocation_reason?: "account_closed" | "bank_account_restricted" | "bank_ownership_changed" | "could_not_process" | "debit_not_authorized" | null; + /** @description The service user number for the account on this mandate. */ + service_user_number?: string | null; /** @description The URL that will contain the mandate that the customer has signed. */ url: string; }; @@ -17749,12 +19410,44 @@ export interface components { mandate_cashapp: Record; /** mandate_kakao_pay */ mandate_kakao_pay: Record; + /** mandate_klarna */ + mandate_klarna: Record; /** mandate_kr_card */ mandate_kr_card: Record; /** mandate_link */ mandate_link: Record; /** mandate_multi_use */ mandate_multi_use: Record; + /** mandate_naver_pay */ + mandate_naver_pay: Record; + /** mandate_nz_bank_account */ + mandate_nz_bank_account: Record; + /** mandate_options_payto */ + mandate_options_payto: { + /** @description Amount that will be collected. It is required when `amount_type` is `fixed`. */ + amount?: number | null; + /** + * @description The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. + * @enum {string|null} + */ + amount_type?: "fixed" | "maximum" | null; + /** @description Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. */ + end_date?: string | null; + /** + * @description The periodicity at which payments will be collected. Defaults to `adhoc`. + * @enum {string|null} + */ + payment_schedule?: "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly" | null; + /** @description The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. */ + payments_per_period?: number | null; + /** + * @description The purpose for which payments are made. Has a default value based on your merchant category code. + * @enum {string|null} + */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility" | null; + /** @description Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. */ + start_date?: string | null; + }; /** mandate_payment_method_details */ mandate_payment_method_details: { acss_debit?: components["schemas"]["mandate_acss_debit"]; @@ -17764,9 +19457,13 @@ export interface components { card?: components["schemas"]["card_mandate_payment_method_details"]; cashapp?: components["schemas"]["mandate_cashapp"]; kakao_pay?: components["schemas"]["mandate_kakao_pay"]; + klarna?: components["schemas"]["mandate_klarna"]; kr_card?: components["schemas"]["mandate_kr_card"]; link?: components["schemas"]["mandate_link"]; + naver_pay?: components["schemas"]["mandate_naver_pay"]; + nz_bank_account?: components["schemas"]["mandate_nz_bank_account"]; paypal?: components["schemas"]["mandate_paypal"]; + payto?: components["schemas"]["mandate_payto"]; revolut_pay?: components["schemas"]["mandate_revolut_pay"]; sepa_debit?: components["schemas"]["mandate_sepa_debit"]; /** @description This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. */ @@ -17780,6 +19477,32 @@ export interface components { /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ payer_id?: string | null; }; + /** mandate_payto */ + mandate_payto: { + /** @description Amount that will be collected. It is required when `amount_type` is `fixed`. */ + amount?: number | null; + /** + * @description The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. + * @enum {string} + */ + amount_type: "fixed" | "maximum"; + /** @description Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. */ + end_date?: string | null; + /** + * @description The periodicity at which payments will be collected. Defaults to `adhoc`. + * @enum {string} + */ + payment_schedule: "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + /** @description The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. */ + payments_per_period?: number | null; + /** + * @description The purpose for which payments are made. Has a default value based on your merchant category code. + * @enum {string|null} + */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility" | null; + /** @description Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. */ + start_date?: string | null; + }; /** mandate_revolut_pay */ mandate_revolut_pay: Record; /** mandate_sepa_debit */ @@ -17809,14 +19532,14 @@ export interface components { }; /** networks */ networks: { - /** @description All available networks for the card. */ + /** @description All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). */ available: string[]; /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ preferred?: string | null; }; /** NotificationEventData */ notification_event_data: { - /** @description Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key. */ + /** @description Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://api.stripe.com#invoice_object) as the value of the object key. */ object: Record; /** @description Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements. */ previous_attributes?: Record; @@ -17879,7 +19602,7 @@ export interface components { /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; /** - * @description The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. + * @description The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach" | "us_domestic_wire"; @@ -17928,7 +19651,7 @@ export interface components { /** @description ID of the mandate used to make this payment. */ mandate?: string | components["schemas"]["mandate"]; /** - * @description The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. + * @description The network rails used. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach" | "us_domestic_wire"; @@ -17946,8 +19669,91 @@ export interface components { /** @description Width, in inches. */ width: number; }; + /** + * PaymentAttemptRecord + * @description A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe. + * Each payment attempt tries to collect a fixed amount of money from a fixed customer and payment + * method. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record + * can have guaranteed funds. + */ + payment_attempt_record: { + amount: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_authorized: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_canceled: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_failed: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_guaranteed: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_refunded: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_requested: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + /** @description ID of the Connect application that created the PaymentAttemptRecord. */ + application?: string | null; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Customer information for this payment. */ + customer_details?: components["schemas"]["payments_primitives_payment_records_resource_customer_details"] | null; + /** + * @description Indicates whether the customer was present in your checkout flow during this payment. + * @enum {string|null} + */ + customer_presence?: "off_session" | "on_session" | null; + /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + description?: string | 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://docs.stripe.com/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 String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "payment_attempt_record"; + /** @description Information about the Payment Method debited for this payment. */ + payment_method_details?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_details"] | null; + /** @description ID of the Payment Record this Payment Attempt Record belongs to. */ + payment_record?: string | null; + processor_details: components["schemas"]["payments_primitives_payment_records_resource_processor_details"]; + /** + * @description Indicates who reported the payment. + * @enum {string} + */ + reported_by: "self" | "stripe"; + /** @description Shipping information for this payment. */ + shipping_details?: components["schemas"]["payments_primitives_payment_records_resource_shipping_details"] | null; + }; /** PaymentFlowsAmountDetails */ payment_flows_amount_details: { + /** + * @description The total discount applied on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. + * + * This field is mutually exclusive with the `amount_details[line_items][#][discount_amount]` field. + */ + discount_amount?: number; + error?: components["schemas"]["payment_flows_amount_details_resource_error"]; + /** + * PaymentFlowsAmountDetailsResourceLineItemsList + * @description A list of line items, each containing information about a product in the PaymentIntent. There is a maximum of 200 line items. + */ + line_items?: { + /** @description Details about each object. */ + data: components["schemas"]["payment_intent_amount_details_line_item"][]; + /** @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; + }; + shipping?: components["schemas"]["payment_flows_amount_details_resource_shipping"]; + tax?: components["schemas"]["payment_flows_amount_details_resource_tax"]; tip?: components["schemas"]["payment_flows_amount_details_client_resource_tip"]; }; /** PaymentFlowsAmountDetailsClient */ @@ -17959,12 +19765,56 @@ export interface components { /** @description Portion of the amount that corresponds to a tip. */ amount?: number; }; + /** PaymentFlowsAmountDetailsResourceError */ + payment_flows_amount_details_resource_error: { + /** + * @description The code of the error that occurred when validating the current amount details. + * @enum {string|null} + */ + code?: "amount_details_amount_mismatch" | "amount_details_tax_shipping_discount_greater_than_amount" | null; + /** @description A message providing more details about the error. */ + message?: string | null; + }; + /** PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions */ + payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options: { + card?: components["schemas"]["payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options"]; + card_present?: components["schemas"]["payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options"]; + klarna?: components["schemas"]["payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options"]; + paypal?: components["schemas"]["payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options"]; + }; + /** PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourceTax */ + payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax: { + /** + * @description The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + * + * This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. + */ + total_tax_amount: number; + }; + /** PaymentFlowsAmountDetailsResourceShipping */ + payment_flows_amount_details_resource_shipping: { + /** @description If a physical good is being shipped, the cost of shipping represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than or equal to 0. */ + amount?: number | null; + /** @description If a physical good is being shipped, the postal code of where it is being shipped from. At most 10 alphanumeric characters long, hyphens are allowed. */ + from_postal_code?: string | null; + /** @description If a physical good is being shipped, the postal code of where it is being shipped to. At most 10 alphanumeric characters long, hyphens are allowed. */ + to_postal_code?: string | null; + }; + /** PaymentFlowsAmountDetailsResourceTax */ + payment_flows_amount_details_resource_tax: { + /** + * @description The total amount of tax on the transaction represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L2 rates. An integer greater than or equal to 0. + * + * This field is mutually exclusive with the `amount_details[line_items][#][tax][total_tax_amount]` field. + */ + total_tax_amount?: number | null; + }; /** PaymentFlowsAutomaticPaymentMethodsPaymentIntent */ payment_flows_automatic_payment_methods_payment_intent: { /** * @description Controls whether this PaymentIntent will accept redirect-based payment methods. * - * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. + * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. * @enum {string} */ allow_redirects?: "always" | "never"; @@ -17976,7 +19826,7 @@ export interface components { /** * @description Controls whether this SetupIntent will accept redirect-based payment methods. * - * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. + * Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. * @enum {string} */ allow_redirects?: "always" | "never"; @@ -17988,6 +19838,43 @@ export interface components { enabled: boolean; plan?: components["schemas"]["payment_method_details_card_installments_plan"]; }; + /** PaymentFlowsPaymentDetails */ + payment_flows_payment_details: { + /** + * @description A unique value to identify the customer. This field is available only for card payments. + * + * This field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. + */ + customer_reference?: string | null; + /** + * @description A unique value assigned by the business to identify the transaction. Required for L2 and L3 rates. + * + * Required when the Payment Method Types array contains `card`, including when [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) is set to `true`. + * + * For Cards, this field is truncated to 25 alphanumeric characters, excluding spaces, before being sent to card networks. For Klarna, this field is truncated to 255 characters and is visible to customers when they view the order in the Klarna app. + */ + order_reference?: string | null; + }; + /** PaymentFlowsPaymentIntentAsyncWorkflows */ + payment_flows_payment_intent_async_workflows: { + inputs?: components["schemas"]["payment_flows_payment_intent_async_workflows_resource_inputs"]; + }; + /** PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputs */ + payment_flows_payment_intent_async_workflows_resource_inputs: { + tax?: components["schemas"]["payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax"]; + }; + /** PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputsResourceTax */ + payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax: { + /** @description The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) id */ + calculation: string; + }; + /** PaymentFlowsPaymentIntentPresentmentDetails */ + payment_flows_payment_intent_presentment_details: { + /** @description Amount intended to be collected by this payment, denominated in `presentment_currency`. */ + presentment_amount: number; + /** @description Currency presented to the customer during payment. */ + presentment_currency: string; + }; /** PaymentFlowsPrivatePaymentMethodsAlipay */ payment_flows_private_payment_methods_alipay: Record; /** PaymentFlowsPrivatePaymentMethodsAlipayDetails */ @@ -18033,6 +19920,14 @@ export interface components { */ status: "available" | "unavailable"; }; + /** PaymentFlowsPrivatePaymentMethodsCardPaymentIntentAmountDetailsLineItemPaymentMethodOptions */ + payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options: { + commodity_code?: string | null; + }; + /** PaymentFlowsPrivatePaymentMethodsCardPresentAmountDetailsLineItemPaymentMethodOptions */ + payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options: { + commodity_code?: string | null; + }; /** PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet */ payment_flows_private_payment_methods_card_present_common_wallet: { /** @@ -18041,6 +19936,11 @@ export interface components { */ type: "apple_pay" | "google_pay" | "samsung_pay" | "unknown"; }; + /** PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters */ + payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters: { + /** @description The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`. */ + account_subcategories?: ("checking" | "savings")[]; + }; /** PaymentFlowsPrivatePaymentMethodsKakaoPayPaymentMethodOptions */ payment_flows_private_payment_methods_kakao_pay_payment_method_options: { /** @@ -18069,6 +19969,13 @@ export interface components { /** @description The four-digit year of birth. */ year?: number | null; }; + /** PaymentFlowsPrivatePaymentMethodsKlarnaPaymentIntentAmountDetailsLineItemPaymentMethodOptions */ + payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options: { + image_url?: string | null; + product_url?: string | null; + reference?: string | null; + subscription_reference?: string | null; + }; /** PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions */ payment_flows_private_payment_methods_naver_pay_payment_method_options: { /** @@ -18076,6 +19983,17 @@ export interface components { * @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"; }; /** PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions */ payment_flows_private_payment_methods_payco_payment_method_options: { @@ -18085,6 +20003,18 @@ export interface components { */ capture_method?: "manual"; }; + /** PaymentFlowsPrivatePaymentMethodsPaypalAmountDetailsLineItemPaymentMethodOptions */ + payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options: { + /** + * @description Type of the line item. + * @enum {string} + */ + category?: "digital_goods" | "donation" | "physical_goods"; + /** @description Description of the line item. */ + description?: string; + /** @description The Stripe account ID of the connected account that sells the item. This is only needed when using [Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers). */ + sold_by?: string; + }; /** PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions */ payment_flows_private_payment_methods_samsung_pay_payment_method_options: { /** @@ -18093,11 +20023,6 @@ export interface components { */ 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`. */ - account_subcategories?: ("checking" | "savings")[]; - }; /** * PaymentIntent * @description A PaymentIntent guides you through the process of collecting a payment from your customer. @@ -18106,15 +20031,15 @@ export interface components { * see the history of payment attempts for a particular session. * * A PaymentIntent transitions through - * [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses) + * [multiple statuses](/payments/paymentintents/lifecycle) * throughout its lifetime as it interfaces with Stripe.js to perform * authentication flows and ultimately creates at most one successful charge. * - * Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents) + * Related guide: [Payment Intents API](https://docs.stripe.com/payments/payment-intents) */ payment_intent: { - /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ - amount: number; + /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + amount?: number; /** @description Amount that can be captured from this PaymentIntent. */ amount_capturable?: number; amount_details?: components["schemas"]["payment_flows_amount_details"] | components["schemas"]["payment_flows_amount_details_client"]; @@ -18122,7 +20047,7 @@ export interface components { amount_received?: number; /** @description ID of the Connect application that created the PaymentIntent. */ application?: (string | components["schemas"]["application"]) | null; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ application_fee_amount?: number | null; /** @description Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods) */ automatic_payment_methods?: components["schemas"]["payment_flows_automatic_payment_methods_payment_intent"] | null; @@ -18132,28 +20057,28 @@ export interface components { */ canceled_at?: number | null; /** - * @description Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`). + * @description Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, `automatic`, or `expired`). * @enum {string|null} */ - cancellation_reason?: "abandoned" | "automatic" | "duplicate" | "failed_invoice" | "fraudulent" | "requested_by_customer" | "void_invoice" | null; + cancellation_reason?: "abandoned" | "automatic" | "duplicate" | "expired" | "failed_invoice" | "fraudulent" | "requested_by_customer" | "void_invoice" | null; /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} */ - capture_method: "automatic" | "automatic_async" | "manual"; + capture_method?: "automatic" | "automatic_async" | "manual"; /** * @description The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. * * The client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret. * - * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. + * Refer to our docs to [accept a payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. */ client_secret?: string | null; /** * @description Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. * @enum {string} */ - confirmation_method: "automatic" | "manual"; + confirmation_method?: "automatic" | "manual"; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -18163,28 +20088,37 @@ export interface components { * Format: 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). */ - currency: string; + currency?: string; /** * @description ID of the Customer this PaymentIntent belongs to, if one exists. * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** + * @description ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + * + * Payment methods attached to other Accounts cannot be used with this PaymentIntent. + * + * If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. + */ + customer_account?: string | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; + /** @description The list of payment method types to exclude from use with this payment. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; + hooks?: components["schemas"]["payment_flows_payment_intent_async_workflows"]; /** @description Unique identifier for the object. */ id: string; - /** @description ID of the invoice that created this PaymentIntent, if it exists. */ - invoice?: (string | components["schemas"]["invoice"]) | null; /** @description The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason. */ last_payment_error?: components["schemas"]["api_errors"] | null; - /** @description ID of the latest [Charge object](https://stripe.com/docs/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. */ + /** @description ID of the latest [Charge object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. */ latest_charge?: (string | components["schemas"]["charge"]) | null; /** @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. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). */ metadata?: { [key: string]: string; }; @@ -18195,16 +20129,21 @@ export interface components { * @enum {string} */ object: "payment_intent"; - /** @description The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details. */ + /** + * @description You can specify the settlement merchant as the + * connected account using the `on_behalf_of` attribute on the charge. See the PaymentIntents [use case for connected accounts](/payments/connected-accounts) for details. + */ on_behalf_of?: (string | components["schemas"]["account"]) | null; + payment_details?: components["schemas"]["payment_flows_payment_details"]; /** @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](https://stripe.com/docs/api/payment_method_configurations) used for this PaymentIntent. */ + /** @description Information about the [payment method configuration](https://docs.stripe.com/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; - /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */ - payment_method_types: string[]; + /** @description The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. A comprehensive list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ + payment_method_types?: string[]; + presentment_details?: components["schemas"]["payment_flows_payment_intent_presentment_details"]; /** @description If present, this property tells you about the processing state of the payment. */ processing?: components["schemas"]["payment_intent_processing"] | null; /** @description Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ @@ -18233,15 +20172,49 @@ export interface components { /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string | null; /** - * @description Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses). + * @description Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://docs.stripe.com/payments/intents#intent-statuses). * @enum {string} */ status: "canceled" | "processing" | "requires_action" | "requires_capture" | "requires_confirmation" | "requires_payment_method" | "succeeded"; - /** @description The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** @description The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ transfer_data?: components["schemas"]["transfer_data"] | null; - /** @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). */ + /** @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). */ transfer_group?: string | null; }; + /** PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItem */ + payment_intent_amount_details_line_item: { + /** + * @description The discount applied on this line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). An integer greater than 0. + * + * This field is mutually exclusive with the `amount_details[discount_amount]` field. + */ + discount_amount?: number | null; + /** @description Unique identifier for the object. */ + id: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "payment_intent_amount_details_line_item"; + /** @description Payment method-specific information for line items. */ + payment_method_options?: components["schemas"]["payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options"] | null; + /** @description The product code of the line item, such as an SKU. Required for L3 rates. At most 12 characters long. */ + product_code?: string | null; + /** + * @description The product name of the line item. Required for L3 rates. At most 1024 characters long. + * + * For Cards, this field is truncated to 26 alphanumeric characters before being sent to the card networks. For PayPal, this field is truncated to 127 characters. + */ + product_name: string; + /** @description The quantity of items. Required for L3 rates. An integer greater than 0. */ + quantity: number; + /** @description Contains information about the tax on the item. */ + tax?: components["schemas"]["payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax"] | null; + /** @description The unit cost of the line item represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Required for L3 rates. An integer greater than or equal to 0. */ + unit_cost: number; + /** @description A unit of measure for the line item, such as gallons, feet, meters, etc. Required for L3 rates. At most 12 alphanumeric characters long. */ + unit_of_measure?: string | null; + }; /** PaymentIntentCardProcessing */ payment_intent_card_processing: { customer_notification?: components["schemas"]["payment_intent_processing_customer_notification"]; @@ -18261,7 +20234,7 @@ export interface components { promptpay_display_qr_code?: components["schemas"]["payment_intent_next_action_promptpay_display_qr_code"]; redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; swish_handle_redirect_or_display_qr_code?: components["schemas"]["payment_intent_next_action_swish_handle_redirect_or_display_qr_code"]; - /** @description Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ + /** @description Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ type: string; /** @description When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. */ use_stripe_sdk?: Record; @@ -18540,11 +20513,13 @@ export interface components { 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"]; bancontact?: components["schemas"]["payment_method_options_bancontact"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + billie?: components["schemas"]["payment_method_options_billie"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; blik?: components["schemas"]["payment_intent_payment_method_options_blik"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; boleto?: components["schemas"]["payment_method_options_boleto"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; card?: components["schemas"]["payment_intent_payment_method_options_card"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; card_present?: components["schemas"]["payment_method_options_card_present"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; cashapp?: components["schemas"]["payment_method_options_cashapp"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + crypto?: components["schemas"]["payment_method_options_crypto"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; customer_balance?: components["schemas"]["payment_method_options_customer_balance"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; eps?: components["schemas"]["payment_intent_payment_method_options_eps"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; fpx?: components["schemas"]["payment_method_options_fpx"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -18557,19 +20532,23 @@ export interface components { 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"]; + mb_way?: components["schemas"]["payment_method_options_mb_way"] | 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"]; + nz_bank_account?: components["schemas"]["payment_intent_payment_method_options_nz_bank_account"] | 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"]; pay_by_bank?: components["schemas"]["payment_method_options_pay_by_bank"] | 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"]; + payto?: components["schemas"]["payment_intent_payment_method_options_payto"] | 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"]; + satispay?: components["schemas"]["payment_method_options_satispay"] | 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"]; @@ -18592,6 +20571,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; /** * @description Bank account verification method. * @enum {string} @@ -18611,6 +20592,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; }; /** payment_intent_payment_method_options_bacs_debit */ payment_intent_payment_method_options_bacs_debit: { @@ -18626,6 +20609,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; }; /** payment_intent_payment_method_options_blik */ payment_intent_payment_method_options_blik: { @@ -18649,9 +20634,9 @@ export interface components { */ capture_method?: "manual"; /** - * @description Installment details for this payment (Mexico only). + * @description Installment details for this payment. * - * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + * For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). */ installments?: components["schemas"]["payment_method_options_card_installments"] | null; /** @description Configuration options for setting up an eMandate for cards issued in India. */ @@ -18662,27 +20647,27 @@ export interface components { */ 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. + * @description Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. * @enum {string} */ request_extended_authorization?: "if_available" | "never"; /** - * @description Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + * @description Request ability to [increment the authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. * @enum {string} */ request_incremental_authorization?: "if_available" | "never"; /** - * @description Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent. + * @description Request ability to make [multiple captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. * @enum {string} */ request_multicapture?: "if_available" | "never"; /** - * @description Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent. + * @description Request ability to [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. * @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. + * @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://docs.stripe.com/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://docs.stripe.com/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} */ request_three_d_secure?: "any" | "automatic" | "challenge" | null; @@ -18759,6 +20744,30 @@ export interface components { /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ reference_prefix?: string; }; + /** payment_intent_payment_method_options_mandate_options_payto */ + payment_intent_payment_method_options_mandate_options_payto: { + /** @description Amount that will be collected. It is required when `amount_type` is `fixed`. */ + amount?: number | null; + /** + * @description The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. + * @enum {string|null} + */ + amount_type?: "fixed" | "maximum" | null; + /** @description Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. */ + end_date?: string | null; + /** + * @description The periodicity at which payments will be collected. Defaults to `adhoc`. + * @enum {string|null} + */ + payment_schedule?: "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly" | null; + /** @description The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. */ + payments_per_period?: number | null; + /** + * @description The purpose for which payments are made. Has a default value based on your merchant category code. + * @enum {string|null} + */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility" | null; + }; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ payment_intent_payment_method_options_mandate_options_sepa_debit: { /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ @@ -18783,6 +20792,37 @@ export interface components { */ setup_future_usage?: "none"; }; + /** payment_intent_payment_method_options_nz_bank_account */ + payment_intent_payment_method_options_nz_bank_account: { + /** + * @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" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; + }; + /** payment_intent_payment_method_options_payto */ + payment_intent_payment_method_options_payto: { + mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_payto"]; + /** + * @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_intent_payment_method_options_sepa_debit */ payment_intent_payment_method_options_sepa_debit: { mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; @@ -18797,6 +20837,8 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; }; /** payment_intent_payment_method_options_swish */ payment_intent_payment_method_options_swish: { @@ -18816,13 +20858,8 @@ export interface components { }; /** payment_intent_payment_method_options_us_bank_account */ payment_intent_payment_method_options_us_bank_account: { - financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; + financial_connections?: components["schemas"]["linked_account_options_common"]; mandate_options?: components["schemas"]["payment_method_options_us_bank_account_mandate_options"]; - /** - * @description Preferred transaction settlement speed - * @enum {string} - */ - preferred_settlement_speed?: "fastest" | "standard"; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -18834,6 +20871,13 @@ export interface components { * @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + /** @description Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now. */ + target_date?: string; + /** + * @description The purpose of the transaction. + * @enum {string} + */ + transaction_purpose?: "goods" | "other" | "services" | "unspecified"; /** * @description Bank account verification method. * @enum {string} @@ -18867,7 +20911,8 @@ export interface components { */ capture_method?: "manual" | "manual_preferred"; installments?: components["schemas"]["payment_flows_installment_options"]; - /** @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_payto"]; + /** @description Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. */ request_incremental_authorization_support?: boolean; /** @description When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). */ require_cvc_recollection?: boolean; @@ -18893,9 +20938,9 @@ export interface components { * PaymentLink * @description A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times. * - * When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links. + * When a customer opens a payment link it will open a new [checkout session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links. * - * Related guide: [Payment Links API](https://stripe.com/docs/payment-links) + * Related guide: [Payment Links API](https://docs.stripe.com/payment-links) */ payment_link: { /** @description Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated. */ @@ -18922,7 +20967,7 @@ export interface components { * @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 Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. */ custom_fields: components["schemas"]["payment_links_resource_custom_fields"][]; custom_text: components["schemas"]["payment_links_resource_custom_text"]; /** @@ -18955,10 +21000,11 @@ export interface components { }; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; + name_collection?: components["schemas"]["payment_links_resource_name_collection"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -18966,6 +21012,8 @@ export interface components { object: "payment_link"; /** @description The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; + /** @description The optional items presented to the customer at checkout. */ + optional_items?: components["schemas"]["payment_links_resource_optional_item"][] | null; /** @description Indicates the parameters to be passed to PaymentIntent creation during checkout. */ payment_intent_data?: components["schemas"]["payment_links_resource_payment_intent_data"] | null; /** @@ -18974,7 +21022,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" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mb_way" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "satispay" | "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; @@ -19012,6 +21060,13 @@ export interface components { /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ liability?: components["schemas"]["connect_account_reference"] | null; }; + /** PaymentLinksResourceBusinessName */ + payment_links_resource_business_name: { + /** @description Indicates whether business name collection is enabled for the payment link. */ + enabled: boolean; + /** @description Whether the customer is required to complete the field before checking out. Defaults to `false`. */ + optional: boolean; + }; /** PaymentLinksResourceCompletedSessions */ payment_links_resource_completed_sessions: { /** @description The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met. */ @@ -19062,6 +21117,8 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsDropdown */ payment_links_resource_custom_fields_dropdown: { + /** @description The value that pre-fills on the payment page. */ + default_value?: string | null; /** @description The options available for the customer to select. Up to 200 options allowed. */ options: components["schemas"]["payment_links_resource_custom_fields_dropdown_option"][]; }; @@ -19084,6 +21141,8 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsNumeric */ payment_links_resource_custom_fields_numeric: { + /** @description The value that pre-fills the field on the payment page. */ + default_value?: string | null; /** @description The maximum character length constraint for the customer's input. */ maximum_length?: number | null; /** @description The minimum character length requirement for the customer's input. */ @@ -19091,6 +21150,8 @@ export interface components { }; /** PaymentLinksResourceCustomFieldsText */ payment_links_resource_custom_fields_text: { + /** @description The value that pre-fills the field on the payment page. */ + default_value?: string | null; /** @description The maximum character length constraint for the customer's input. */ maximum_length?: number | null; /** @description The minimum character length requirement for the customer's input. */ @@ -19109,9 +21170,16 @@ export interface components { }; /** PaymentLinksResourceCustomTextPosition */ payment_links_resource_custom_text_position: { - /** @description Text may be up to 1200 characters in length. */ + /** @description Text can be up to 1200 characters in length. */ message: string; }; + /** PaymentLinksResourceIndividualName */ + payment_links_resource_individual_name: { + /** @description Indicates whether individual name collection is enabled for the payment link. */ + enabled: boolean; + /** @description Whether the customer is required to complete the field before checking out. Defaults to `false`. */ + optional: boolean; + }; /** PaymentLinksResourceInvoiceCreation */ payment_links_resource_invoice_creation: { /** @description Enable creating an invoice on successful payment. */ @@ -19131,12 +21199,32 @@ export interface components { footer?: string | null; /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ issuer?: components["schemas"]["connect_account_reference"] | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Options for invoice PDF rendering. */ - rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; + rendering_options?: components["schemas"]["invoice_setting_checkout_rendering_options"] | null; + }; + /** PaymentLinksResourceNameCollection */ + payment_links_resource_name_collection: { + business?: components["schemas"]["payment_links_resource_business_name"]; + individual?: components["schemas"]["payment_links_resource_individual_name"]; + }; + /** PaymentLinksResourceOptionalItem */ + payment_links_resource_optional_item: { + adjustable_quantity?: components["schemas"]["payment_links_resource_optional_item_adjustable_quantity"] | null; + price: string; + quantity: number; + }; + /** PaymentLinksResourceOptionalItemAdjustableQuantity */ + payment_links_resource_optional_item_adjustable_quantity: { + /** @description Set to true if the quantity can be adjusted to any non-negative integer. */ + enabled: boolean; + /** @description The maximum quantity of this item the customer can purchase. By default this value is 99. */ + maximum?: number | null; + /** @description The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0. */ + minimum?: number | null; }; /** PaymentLinksResourcePaymentIntentData */ payment_links_resource_payment_intent_data: { @@ -19147,7 +21235,7 @@ export interface components { capture_method?: "automatic" | "automatic_async" | "manual" | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. */ metadata: { [key: string]: string; }; @@ -19160,7 +21248,7 @@ export interface components { statement_descriptor?: string | null; /** @description For a card payment, information about the charge that appears on the customer's statement when this payment succeeds in creating a charge. Concatenated with the account's statement descriptor prefix to form the complete statement descriptor. */ statement_descriptor_suffix?: string | null; - /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. */ transfer_group?: string | null; }; /** PaymentLinksResourcePaymentMethodReuseAgreement */ @@ -19199,7 +21287,7 @@ export interface components { /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; invoice_settings: components["schemas"]["payment_links_resource_subscription_data_invoice_settings"]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. */ metadata: { [key: string]: string; }; @@ -19229,10 +21317,10 @@ export interface components { /** * PaymentMethod * @description PaymentMethod objects represent your customer's payment instruments. - * You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to + * You can use them with [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to * Customer objects to store instrument details for future payments. * - * Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + * Related guides: [Payment Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). */ payment_method: { acss_debit?: components["schemas"]["payment_method_acss_debit"]; @@ -19249,6 +21337,7 @@ export interface components { au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; bancontact?: components["schemas"]["payment_method_bancontact"]; + billie?: components["schemas"]["payment_method_billie"]; billing_details: components["schemas"]["billing_details"]; blik?: components["schemas"]["payment_method_blik"]; boleto?: components["schemas"]["payment_method_boleto"]; @@ -19260,8 +21349,11 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; + crypto?: components["schemas"]["payment_method_crypto"]; + custom?: components["schemas"]["payment_method_custom"]; /** @description The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer. */ customer?: (string | components["schemas"]["customer"]) | null; + customer_account?: string | null; customer_balance?: components["schemas"]["payment_method_customer_balance"]; eps?: components["schemas"]["payment_method_eps"]; fpx?: components["schemas"]["payment_method_fpx"]; @@ -19278,13 +21370,15 @@ export interface components { 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; - /** @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. */ + mb_way?: components["schemas"]["payment_method_mb_way"]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; mobilepay?: components["schemas"]["payment_method_mobilepay"]; multibanco?: components["schemas"]["payment_method_multibanco"]; naver_pay?: components["schemas"]["payment_method_naver_pay"]; + nz_bank_account?: components["schemas"]["payment_method_nz_bank_account"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -19296,11 +21390,13 @@ export interface components { payco?: components["schemas"]["payment_method_payco"]; paynow?: components["schemas"]["payment_method_paynow"]; paypal?: components["schemas"]["payment_method_paypal"]; + payto?: components["schemas"]["payment_method_payto"]; 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"]; + satispay?: components["schemas"]["payment_method_satispay"]; sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; sofort?: components["schemas"]["payment_method_sofort"]; swish?: components["schemas"]["payment_method_swish"]; @@ -19309,7 +21405,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" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "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"]; @@ -19355,6 +21451,8 @@ export interface components { }; /** payment_method_bancontact */ payment_method_bancontact: Record; + /** payment_method_billie */ + payment_method_billie: Record; /** payment_method_blik */ payment_method_blik: Record; /** payment_method_boleto */ @@ -19364,7 +21462,7 @@ export interface components { }; /** payment_method_card */ payment_method_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `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; @@ -19420,7 +21518,7 @@ export interface components { }; /** payment_method_card_present */ payment_method_card_present: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `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; @@ -19450,7 +21548,7 @@ export interface components { networks?: components["schemas"]["payment_method_card_present_networks"] | null; /** @description Details about payment methods collected offline. */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** @description The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. */ preferred_locales?: string[] | null; /** * @description How card details were read in this transaction. @@ -19461,7 +21559,7 @@ export interface components { }; /** payment_method_card_present_networks */ payment_method_card_present_networks: { - /** @description All available networks for the card. */ + /** @description All networks available for selection via [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). */ available: string[]; /** @description The preferred network for the card. */ preferred?: string | null; @@ -19554,7 +21652,7 @@ export interface components { * PaymentMethodConfigResourcePaymentMethodConfiguration * @description PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios. * - * There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges): + * There are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://docs.stripe.com/connect/charges): * * **Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect. * @@ -19563,9 +21661,9 @@ export interface components { * Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. * * Related guides: - * - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) - * - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) - * - [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations) + * - [Payment Method Configurations API](https://docs.stripe.com/connect/payment-method-configurations) + * - [Multiple configurations on dynamic payment methods](https://docs.stripe.com/payments/multiple-payment-method-configs) + * - [Multiple configurations for your Connect accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations) */ payment_method_configuration: { acss_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19582,11 +21680,13 @@ export interface components { au_becs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; bacs_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; bancontact?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + billie?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; blik?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; boleto?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; card?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; cartes_bancaires?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; cashapp?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + crypto?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; customer_balance?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; eps?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; fpx?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19599,15 +21699,20 @@ export interface components { /** @description The default configuration is used whenever a payment method configuration is not specified. */ is_default: boolean; jcb?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + kakao_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; klarna?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; konbini?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + kr_card?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; link?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; + mb_way?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; mobilepay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; multibanco?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description The configuration's name. */ name: string; + naver_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + nz_bank_account?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -19618,10 +21723,15 @@ export interface components { /** @description For child configs, the configuration's parent configuration. */ parent?: string | null; pay_by_bank?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + payco?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paynow?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paypal?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + payto?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + pix?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; promptpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; revolut_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + samsung_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + satispay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; sepa_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; sofort?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; swish?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -19630,6 +21740,17 @@ export interface components { wechat_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; zip?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; }; + /** payment_method_crypto */ + payment_method_crypto: Record; + /** payment_method_custom */ + payment_method_custom: { + /** @description Display name of the Dashboard-only CustomPaymentMethodType. */ + display_name?: string | null; + /** @description Contains information about the Dashboard-only CustomPaymentMethodType logo. */ + logo?: components["schemas"]["custom_logo"] | null; + /** @description ID of the Dashboard-only CustomPaymentMethodType. Not expandable. */ + type: string; + }; /** payment_method_customer_balance */ payment_method_customer_balance: Record; /** payment_method_details */ @@ -19645,11 +21766,13 @@ export interface components { au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; bancontact?: components["schemas"]["payment_method_details_bancontact"]; + billie?: components["schemas"]["payment_method_details_billie"]; blik?: components["schemas"]["payment_method_details_blik"]; boleto?: components["schemas"]["payment_method_details_boleto"]; card?: components["schemas"]["payment_method_details_card"]; card_present?: components["schemas"]["payment_method_details_card_present"]; cashapp?: components["schemas"]["payment_method_details_cashapp"]; + crypto?: components["schemas"]["payment_method_details_crypto"]; customer_balance?: components["schemas"]["payment_method_details_customer_balance"]; eps?: components["schemas"]["payment_method_details_eps"]; fpx?: components["schemas"]["payment_method_details_fpx"]; @@ -19662,26 +21785,30 @@ export interface components { konbini?: components["schemas"]["payment_method_details_konbini"]; kr_card?: components["schemas"]["payment_method_details_kr_card"]; link?: components["schemas"]["payment_method_details_link"]; + mb_way?: components["schemas"]["payment_method_details_mb_way"]; mobilepay?: components["schemas"]["payment_method_details_mobilepay"]; multibanco?: components["schemas"]["payment_method_details_multibanco"]; naver_pay?: components["schemas"]["payment_method_details_naver_pay"]; + nz_bank_account?: components["schemas"]["payment_method_details_nz_bank_account"]; oxxo?: components["schemas"]["payment_method_details_oxxo"]; p24?: components["schemas"]["payment_method_details_p24"]; pay_by_bank?: components["schemas"]["payment_method_details_pay_by_bank"]; payco?: components["schemas"]["payment_method_details_payco"]; paynow?: components["schemas"]["payment_method_details_paynow"]; paypal?: components["schemas"]["payment_method_details_paypal"]; + payto?: components["schemas"]["payment_method_details_payto"]; 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"]; + satispay?: components["schemas"]["payment_method_details_satispay"]; 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"]; swish?: components["schemas"]["payment_method_details_swish"]; twint?: components["schemas"]["payment_method_details_twint"]; /** - * @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. + * @description The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ @@ -19724,6 +21851,8 @@ export interface components { payment_method_details_acss_debit: { /** @description Name of the bank associated with the bank account. */ bank_name?: string | null; + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ fingerprint?: string | null; /** @description Institution number of the bank account */ @@ -19737,6 +21866,10 @@ export interface components { }; /** payment_method_details_affirm */ payment_method_details_affirm: { + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; /** @description The Affirm transaction ID associated with this payment. */ transaction_id?: string | null; }; @@ -19748,15 +21881,23 @@ export interface components { reference?: string | null; }; /** payment_method_details_alma */ - payment_method_details_alma: Record; + payment_method_details_alma: { + installments?: components["schemas"]["alma_installments"]; + /** @description The Alma transaction ID associated with this payment. */ + transaction_id?: string | null; + }; /** payment_method_details_amazon_pay */ payment_method_details_amazon_pay: { funding?: components["schemas"]["amazon_pay_underlying_payment_method_funding_details"]; + /** @description The Amazon Pay transaction ID associated with this payment. */ + transaction_id?: string | null; }; /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ bsb_number?: string | null; + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ fingerprint?: string | null; /** @description Last four digits of the bank account number. */ @@ -19766,6 +21907,8 @@ export interface components { }; /** payment_method_details_bacs_debit */ payment_method_details_bacs_debit: { + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ fingerprint?: string | null; /** @description Last four digits of the bank account number. */ @@ -19801,6 +21944,11 @@ export interface components { */ verified_name?: string | null; }; + /** payment_method_details_billie */ + payment_method_details_billie: { + /** @description The Billie transaction ID associated with this payment. */ + transaction_id?: string | null; + }; /** payment_method_details_blik */ payment_method_details_blik: { /** @description A unique and immutable identifier assigned by BLIK to every buyer. */ @@ -19817,7 +21965,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`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. */ brand?: string | null; /** * Format: unix-time @@ -19843,9 +21991,9 @@ export interface components { funding?: string | null; incremental_authorization?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"]; /** - * @description Installment details for this payment (Mexico only). + * @description Installment details for this payment. * - * For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments). + * For more information, see the [installments integration guide](https://docs.stripe.com/payments/installments). */ installments?: components["schemas"]["payment_method_details_card_installments"] | null; /** @description The last four digits of the card. */ @@ -19857,7 +22005,7 @@ export interface components { 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; - /** @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. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ network_transaction_id?: string | null; overcapture?: components["schemas"]["payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"]; /** @@ -19895,10 +22043,10 @@ export interface components { */ interval?: "month" | null; /** - * @description Type of installment plan, one of `fixed_count`. + * @description Type of installment plan, one of `fixed_count`, `bonus`, or `revolving`. * @enum {string} */ - type: "fixed_count"; + type: "bonus" | "fixed_count" | "revolving"; }; /** payment_method_details_card_network_token */ payment_method_details_card_network_token: { @@ -19909,7 +22057,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`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `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; @@ -19940,27 +22088,31 @@ export interface components { funding?: string | null; /** @description ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod. */ generated_card?: string | null; - /** @description Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). */ + /** @description Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). */ incremental_authorization_supported: boolean; /** @description The name of the card's issuing bank. */ issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; /** @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. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ network_transaction_id?: string | null; /** @description Details about payments collected offline. */ offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; /** @description Defines whether the authorized amount can be over-captured or not */ overcapture_supported: boolean; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** @description The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. */ preferred_locales?: string[] | null; /** * @description How card details were read in this transaction. * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ receipt?: components["schemas"]["payment_method_details_card_present_receipt"] | null; wallet?: components["schemas"]["payment_flows_private_payment_methods_card_present_common_wallet"]; @@ -19985,9 +22137,9 @@ export interface components { * @enum {string} */ account_type?: "checking" | "credit" | "prepaid" | "unknown"; - /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /** @description The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. */ application_cryptogram?: string | null; - /** @description Mnenomic of the Application Identifier. */ + /** @description The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip. */ application_preferred_name?: string | null; /** @description Identifier for this transaction. */ authorization_code?: string | null; @@ -19995,11 +22147,11 @@ export interface components { authorization_response_code?: string | null; /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ cardholder_verification_method?: string | null; - /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /** @description Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. */ dedicated_file_name?: string | null; - /** @description The outcome of a series of EMV functions performed by the card reader. */ + /** @description A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95. */ terminal_verification_results?: string | null; - /** @description An indication of various EMV functions performed during the transaction. */ + /** @description An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. */ transaction_status_information?: string | null; }; /** payment_method_details_card_wallet */ @@ -20057,6 +22209,25 @@ export interface components { buyer_id?: string | null; /** @description A public identifier for buyers using Cash App. */ cashtag?: string | null; + /** @description A unique and immutable identifier of payments assigned by Cash App */ + transaction_id?: string | null; + }; + /** payment_method_details_crypto */ + payment_method_details_crypto: { + /** @description The wallet address of the customer. */ + buyer_address?: string; + /** + * @description The blockchain network that the transaction was sent on. + * @enum {string} + */ + network?: "base" | "ethereum" | "polygon" | "solana"; + /** + * @description The token currency that the transaction was sent with. + * @enum {string} + */ + token_currency?: "usdc" | "usdg" | "usdp"; + /** @description The blockchain transaction hash of the crypto payment. */ + transaction_hash?: string; }; /** payment_method_details_customer_balance */ payment_method_details_customer_balance: Record; @@ -20107,21 +22278,23 @@ export interface components { /** payment_method_details_ideal */ payment_method_details_ideal: { /** - * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * @description The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ - bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; + bic?: "ABNANL2A" | "ADYBNL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "BUUTNL2A" | "FNOMNL22" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MLLENL2A" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; /** @description Last four characters of the IBAN. */ iban_last4?: string | null; + /** @description Unique transaction ID generated by iDEAL. */ + transaction_id?: string | null; /** * @description Owner's verified full name. Values are verified or provided by iDEAL directly * (if supported) at the time of authorization or settlement. They cannot be set or mutated. @@ -20158,17 +22331,21 @@ export interface components { issuer?: string | null; /** @description The last four digits of the card. */ last4?: string | null; + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; /** @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. */ + /** @description This is used by the financial networks to identify a transaction. Visa calls this the Transaction ID, Mastercard calls this the Trace ID, and American Express calls this the Acquirer Reference Data. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ network_transaction_id?: string | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** @description The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. */ preferred_locales?: string[] | null; /** * @description How card details were read in this transaction. * @enum {string|null} */ read_method?: "contact_emv" | "contactless_emv" | "contactless_magstripe_mode" | "magnetic_stripe_fallback" | "magnetic_stripe_track2" | null; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; /** @description A collection of fields required to be displayed on receipts. Only required for EMV transactions. */ receipt?: components["schemas"]["payment_method_details_interac_present_receipt"] | null; }; @@ -20179,9 +22356,9 @@ export interface components { * @enum {string} */ account_type?: "checking" | "savings" | "unknown"; - /** @description EMV tag 9F26, cryptogram generated by the integrated circuit chip. */ + /** @description The Application Cryptogram, a unique value generated by the card to authenticate the transaction with issuers. */ application_cryptogram?: string | null; - /** @description Mnenomic of the Application Identifier. */ + /** @description The Application Identifier (AID) on the card used to determine which networks are eligible to process the transaction. Referenced from EMV tag 9F12, data encoded on the card's chip. */ application_preferred_name?: string | null; /** @description Identifier for this transaction. */ authorization_code?: string | null; @@ -20189,17 +22366,19 @@ export interface components { authorization_response_code?: string | null; /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ cardholder_verification_method?: string | null; - /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ + /** @description Similar to the application_preferred_name, identifying the applications (AIDs) available on the card. Referenced from EMV tag 84. */ dedicated_file_name?: string | null; - /** @description The outcome of a series of EMV functions performed by the card reader. */ + /** @description A 5-byte string that records the checks and validations that occur between the card and the terminal. These checks determine how the terminal processes the transaction and what risk tolerance is acceptable. Referenced from EMV Tag 95. */ terminal_verification_results?: string | null; - /** @description An indication of various EMV functions performed during the transaction. */ + /** @description An indication of which steps were completed during the card read process. Referenced from EMV Tag 9B. */ 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; + /** @description The Kakao Pay transaction ID associated with this payment. */ + transaction_id?: string | null; }; /** payment_method_details_klarna */ payment_method_details_klarna: { @@ -20240,6 +22419,8 @@ export interface components { buyer_id?: string | null; /** @description The last four digits of the card. This may not be present for American Express cards. */ last4?: string | null; + /** @description The Korean Card transaction ID associated with this payment. */ + transaction_id?: string | null; }; /** payment_method_details_link */ payment_method_details_link: { @@ -20249,6 +22430,8 @@ export interface components { */ country?: string | null; }; + /** payment_method_details_mb_way */ + payment_method_details_mb_way: Record; /** payment_method_details_mobilepay */ payment_method_details_mobilepay: { /** @description Internal card details */ @@ -20265,6 +22448,25 @@ export interface components { payment_method_details_naver_pay: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ buyer_id?: string | null; + /** @description The Naver Pay transaction ID associated with this payment. */ + transaction_id?: string | null; + }; + /** payment_method_details_nz_bank_account */ + payment_method_details_nz_bank_account: { + /** @description The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. */ + account_holder_name?: string | null; + /** @description The numeric code for the bank account's bank. */ + bank_code: string; + /** @description The name of the bank. */ + bank_name: string; + /** @description The numeric code for the bank account's bank branch. */ + branch_code: string; + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; + /** @description Last four digits of the bank account number. */ + last4: string; + /** @description The suffix of the bank account number. */ + suffix?: string | null; }; /** payment_method_details_oxxo */ payment_method_details_oxxo: { @@ -20289,7 +22491,7 @@ export interface components { }; /** payment_method_details_passthrough_card */ payment_method_details_passthrough_card: { - /** @description Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. */ brand?: string | null; /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ country?: string | null; @@ -20308,9 +22510,165 @@ export interface components { payment_method_details_payco: { /** @description A unique identifier for the buyer as determined by the local payment processor. */ buyer_id?: string | null; + /** @description The Payco transaction ID associated with this payment. */ + transaction_id?: string | null; + }; + /** payment_method_details_payment_record_affirm */ + payment_method_details_payment_record_affirm: { + /** @description ID of the location that this reader is assigned to. */ + location?: string; + /** @description ID of the reader this transaction was made on. */ + reader?: string; + /** @description The Affirm transaction ID associated with this payment. */ + transaction_id?: string | null; }; + /** payment_method_details_payment_record_afterpay_clearpay */ + payment_method_details_payment_record_afterpay_clearpay: { + /** @description The Afterpay order ID associated with this payment intent. */ + order_id?: string | null; + /** @description Order identifier shown to the merchant in Afterpay's online portal. */ + reference?: string | null; + }; + /** payment_method_details_payment_record_bancontact */ + payment_method_details_payment_record_bancontact: { + /** @description Bank code of bank associated with the bank account. */ + bank_code?: string | null; + /** @description Name of the bank associated with the bank account. */ + bank_name?: string | null; + /** @description Bank Identifier Code of the bank associated with the bank account. */ + bic?: string | null; + /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; + /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ + generated_sepa_debit_mandate?: (string | components["schemas"]["mandate"]) | null; + /** @description Last four characters of the IBAN. */ + iban_last4?: string | null; + /** + * @description Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` + * @enum {string|null} + */ + preferred_language?: "de" | "en" | "fr" | "nl" | null; + /** @description Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. */ + verified_name?: string | null; + }; + /** payment_method_details_payment_record_boleto */ + payment_method_details_payment_record_boleto: { + /** @description The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) */ + tax_id?: string | null; + }; + /** payment_method_details_payment_record_cashapp */ + payment_method_details_payment_record_cashapp: { + /** @description A unique and immutable identifier assigned by Cash App to every buyer. */ + buyer_id?: string | null; + /** @description A public identifier for buyers using Cash App. */ + cashtag?: string | null; + /** @description A unique and immutable identifier of payments assigned by Cash App. */ + transaction_id?: string | null; + }; + /** payment_method_details_payment_record_giropay */ + payment_method_details_payment_record_giropay: { + /** @description Bank code of bank associated with the bank account. */ + bank_code?: string | null; + /** @description Name of the bank associated with the bank account. */ + bank_name?: string | null; + /** @description Bank Identifier Code of the bank associated with the bank account. */ + bic?: string | null; + /** @description Owner's verified full name. Values are verified or provided by Giropay directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Giropay rarely provides this information so the attribute is usually empty. */ + verified_name?: string | null; + }; + /** payment_method_details_payment_record_kakao_pay */ + payment_method_details_payment_record_kakao_pay: { + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + /** @description The Kakao Pay transaction ID associated with this payment. */ + transaction_id?: string | null; + }; + /** payment_method_details_payment_record_konbini */ + payment_method_details_payment_record_konbini: { + /** @description If the payment succeeded, this contains the details of the convenience store where the payment was completed. */ + store?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store"] | null; + }; + /** payment_method_details_payment_record_mb_way */ + payment_method_details_payment_record_mb_way: Record; + /** payment_method_details_payment_record_multibanco */ + payment_method_details_payment_record_multibanco: { + /** @description Entity number associated with this Multibanco payment. */ + entity?: string | null; + /** @description Reference number associated with this Multibanco payment. */ + reference?: string | null; + }; + /** payment_method_details_payment_record_naver_pay */ + payment_method_details_payment_record_naver_pay: { + /** @description A unique identifier for the buyer as determined by the local payment processor. */ + buyer_id?: string | null; + /** @description The Naver Pay transaction ID associated with this payment. */ + transaction_id?: string | null; + }; + /** payment_method_details_payment_record_oxxo */ + payment_method_details_payment_record_oxxo: { + /** @description OXXO reference number */ + number?: string | null; + }; + /** payment_method_details_payment_record_paynow */ + payment_method_details_payment_record_paynow: { + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; + /** @description Reference number associated with this PayNow payment */ + reference?: string | null; + }; + /** payment_method_details_payment_record_promptpay */ + payment_method_details_payment_record_promptpay: { + /** @description Bill reference generated by PromptPay */ + reference?: string | null; + }; + /** payment_method_details_payment_record_us_bank_account */ + payment_method_details_payment_record_us_bank_account: { + /** + * @description The type of entity that holds the account. This can be either 'individual' or 'company'. + * @enum {string|null} + */ + account_holder_type?: "company" | "individual" | null; + /** + * @description The type of the bank account. This can be either 'checking' or 'savings'. + * @enum {string|null} + */ + account_type?: "checking" | "savings" | null; + /** @description Name of the bank associated with the bank account. */ + bank_name?: string | null; + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; + /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ + fingerprint?: string | null; + /** @description Last four digits of the bank account number. */ + last4?: string | null; + /** @description ID of the mandate used to make this payment. */ + mandate?: string | components["schemas"]["mandate"]; + /** @description The ACH payment reference for this transaction. */ + payment_reference?: string | null; + /** @description The routing number for the bank account. */ + routing_number?: string | null; + }; + /** payment_method_details_payment_record_wechat_pay */ + payment_method_details_payment_record_wechat_pay: { + /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ + fingerprint?: string | null; + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; + /** @description Transaction ID of this particular WeChat Pay transaction. */ + transaction_id?: string | null; + }; + /** payment_method_details_payment_record_zip */ + payment_method_details_payment_record_zip: Record; /** payment_method_details_paynow */ payment_method_details_paynow: { + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; /** @description Reference number associated with this PayNow payment */ reference?: string | null; }; @@ -20335,6 +22693,17 @@ export interface components { /** @description A unique ID generated by PayPal for this transaction. */ transaction_id?: string | null; }; + /** payment_method_details_payto */ + payment_method_details_payto: { + /** @description Bank-State-Branch number of the bank account. */ + bsb_number?: string | null; + /** @description Last four digits of the bank account number. */ + last4?: string | null; + /** @description ID of the mandate used to make this payment. */ + mandate?: string; + /** @description The PayID alias for the bank account. */ + pay_id?: string | null; + }; /** payment_method_details_pix */ payment_method_details_pix: { /** @description Unique transaction id generated by BCB */ @@ -20348,11 +22717,20 @@ export interface components { /** payment_method_details_revolut_pay */ payment_method_details_revolut_pay: { funding?: components["schemas"]["revolut_pay_underlying_payment_method_funding_details"]; + /** @description The Revolut Pay transaction ID associated with this payment. */ + transaction_id?: string | null; }; /** 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; + /** @description The Samsung Pay transaction ID associated with this payment. */ + transaction_id?: string | null; + }; + /** payment_method_details_satispay */ + payment_method_details_satispay: { + /** @description The Satispay transaction ID associated with this payment. */ + transaction_id?: string | null; }; /** payment_method_details_sepa_debit */ payment_method_details_sepa_debit: { @@ -20362,11 +22740,13 @@ export interface components { branch_code?: string | null; /** @description Two-letter ISO code representing the country the bank account is located in. */ country?: string | null; + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ fingerprint?: string | null; /** @description Last four characters of the IBAN. */ last4?: string | null; - /** @description Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve). */ + /** @description Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://docs.stripe.com/api/mandates/retrieve). */ mandate?: string | null; }; /** payment_method_details_sofort */ @@ -20424,6 +22804,8 @@ export interface components { account_type?: "checking" | "savings" | null; /** @description Name of the bank associated with the bank account. */ bank_name?: string | null; + /** @description Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. */ + expected_debit_date?: string; /** @description Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. */ fingerprint?: string | null; /** @description Last four digits of the bank account number. */ @@ -20441,6 +22823,10 @@ export interface components { payment_method_details_wechat_pay: { /** @description Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same. */ fingerprint?: string | null; + /** @description ID of the [location](https://docs.stripe.com/api/terminal/locations) that this transaction's reader is assigned to. */ + location?: string; + /** @description ID of the [reader](https://docs.stripe.com/api/terminal/readers) this transaction was made on. */ + reader?: string; /** @description Transaction ID of this particular WeChat Pay transaction. */ transaction_id?: string | null; }; @@ -20451,7 +22837,7 @@ export interface components { * @description A payment method domain represents a web domain that you have registered with Stripe. * Stripe Elements use registered payment method domains to control where certain payment methods are shown. * - * Related guide: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + * Related guide: [Payment method domains](https://docs.stripe.com/payments/payment-methods/pmd-registration). */ payment_method_domain: { amazon_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; @@ -20468,6 +22854,7 @@ export interface components { google_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"]; /** @description Unique identifier for the object. */ id: string; + klarna: components["schemas"]["payment_method_domain_resource_payment_method_status"]; link: components["schemas"]["payment_method_domain_resource_payment_method_status"]; /** @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; @@ -20521,15 +22908,15 @@ export interface components { /** payment_method_ideal */ payment_method_ideal: { /** - * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * @description The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ - bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; + bic?: "ABNANL2A" | "ADYBNL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "BUUTNL2A" | "FNOMNL22" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MLLENL2A" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; }; /** payment_method_interac_present */ payment_method_interac_present: { @@ -20559,7 +22946,7 @@ export interface components { last4?: string | null; /** @description Contains information about card networks that can be used to process the payment. */ networks?: components["schemas"]["payment_method_card_present_networks"] | null; - /** @description EMV tag 5F2D. Preferred languages specified by the integrated circuit chip. */ + /** @description The languages that the issuing bank recommends using for localizing any customer-facing text, as read from the card. Referenced from EMV tag 5F2D, data encoded on the card's chip. */ preferred_locales?: string[] | null; /** * @description How card details were read in this transaction. @@ -20591,18 +22978,37 @@ export interface components { /** @description Account owner's email address. */ email?: string | null; }; + /** payment_method_mb_way */ + payment_method_mb_way: Record; /** payment_method_mobilepay */ payment_method_mobilepay: Record; /** payment_method_multibanco */ payment_method_multibanco: Record; /** payment_method_naver_pay */ payment_method_naver_pay: { + /** @description Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same. */ + buyer_id?: string | null; /** * @description Whether to fund this transaction with Naver Pay points or a card. * @enum {string} */ funding: "card" | "points"; }; + /** payment_method_nz_bank_account */ + payment_method_nz_bank_account: { + /** @description The name on the bank account. Only present if the account holder name is different from the name of the authorized signatory collected in the PaymentMethod’s billing details. */ + account_holder_name?: string | null; + /** @description The numeric code for the bank account's bank. */ + bank_code: string; + /** @description The name of the bank. */ + bank_name: string; + /** @description The numeric code for the bank account's bank branch. */ + branch_code: string; + /** @description Last four digits of the bank account number. */ + last4: string; + /** @description The suffix of the bank account number. */ + suffix?: string | null; + }; /** payment_method_options_affirm */ payment_method_options_affirm: { /** @@ -20708,6 +23114,14 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** payment_method_options_billie */ + payment_method_options_billie: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** payment_method_options_boleto */ payment_method_options_boleto: { /** @description The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time. */ @@ -20768,9 +23182,14 @@ export interface components { }; /** payment_method_options_card_present */ payment_method_options_card_present: { - /** @description Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) */ + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual" | "manual_preferred"; + /** @description Request ability to capture this payment beyond the standard [authorization validity window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) */ request_extended_authorization?: boolean | null; - /** @description Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support. */ + /** @description Request ability to [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. */ request_incremental_authorization_support?: boolean | null; routing?: components["schemas"]["payment_method_options_card_present_routing"]; }; @@ -20801,6 +23220,20 @@ export interface components { */ setup_future_usage?: "none" | "off_session" | "on_session"; }; + /** payment_method_options_crypto */ + payment_method_options_crypto: { + /** + * @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"; + }; /** payment_method_options_customer_balance */ payment_method_options_customer_balance: { bank_transfer?: components["schemas"]["payment_method_options_customer_balance_bank_transfer"]; @@ -20839,7 +23272,7 @@ export interface components { /** payment_method_options_customer_balance_eu_bank_account */ payment_method_options_customer_balance_eu_bank_account: { /** - * @description The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + * @description The desired country code of the bank account information. Permitted values include: `DE`, `FR`, `IE`, or `NL`. * @enum {string} */ country: "BE" | "DE" | "ES" | "FR" | "IE" | "NL"; @@ -20921,7 +23354,7 @@ export interface components { * 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"; + setup_future_usage?: "none" | "off_session" | "on_session"; }; /** payment_method_options_konbini */ payment_method_options_konbini: { @@ -20967,6 +23400,20 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** payment_method_options_mb_way */ + payment_method_options_mb_way: { + /** + * @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"; + }; /** payment_method_options_multibanco */ payment_method_options_multibanco: { /** @@ -21052,6 +23499,11 @@ export interface components { }; /** payment_method_options_pix */ payment_method_options_pix: { + /** + * @description Determines if the amount includes the IOF tax. + * @enum {string} + */ + amount_includes_iof?: "always" | "never"; /** @description The number of seconds (between 10 and 1209600) after which Pix payment will expire. */ expires_after_seconds?: number | null; /** @description The timestamp at which the Pix expires. */ @@ -21101,6 +23553,14 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** payment_method_options_satispay */ + payment_method_options_satispay: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + }; /** payment_method_options_sofort */ payment_method_options_sofort: { /** @@ -21205,6 +23665,15 @@ export interface components { /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ payer_id?: string | null; }; + /** payment_method_payto */ + payment_method_payto: { + /** @description Bank-State-Branch number of the bank account. */ + bsb_number?: string | null; + /** @description Last four digits of the bank account number. */ + last4?: string | null; + /** @description The PayID alias for the bank account. */ + pay_id?: string | null; + }; /** payment_method_pix */ payment_method_pix: Record; /** payment_method_promptpay */ @@ -21213,6 +23682,8 @@ export interface components { payment_method_revolut_pay: Record; /** payment_method_samsung_pay */ payment_method_samsung_pay: Record; + /** payment_method_satispay */ + payment_method_satispay: Record; /** payment_method_sepa_debit */ payment_method_sepa_debit: { /** @description Bank code of bank associated with the bank account. */ @@ -21275,7 +23746,7 @@ export interface components { * @description The reason why this PaymentMethod's fingerprint has been blocked * @enum {string|null} */ - reason?: "bank_account_closed" | "bank_account_frozen" | "bank_account_invalid_details" | "bank_account_restricted" | "bank_account_unusable" | "debit_not_authorized" | null; + reason?: "bank_account_closed" | "bank_account_frozen" | "bank_account_invalid_details" | "bank_account_restricted" | "bank_account_unusable" | "debit_not_authorized" | "tokenized_account_number_deactivated" | null; }; /** payment_method_us_bank_account_status_details */ payment_method_us_bank_account_status_details: { @@ -21287,7 +23758,7 @@ export interface components { payment_method_zip: Record; /** PaymentPagesCheckoutSessionAdaptivePricing */ payment_pages_checkout_session_adaptive_pricing: { - /** @description Whether Adaptive Pricing is enabled. */ + /** @description If enabled, Adaptive Pricing is available on [eligible sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). */ enabled: boolean; }; /** PaymentPagesCheckoutSessionAfterExpiration */ @@ -21319,12 +23790,80 @@ export interface components { enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ liability?: components["schemas"]["connect_account_reference"] | null; + /** @description The tax provider powering automatic tax. */ + provider?: string | null; /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} */ status?: "complete" | "failed" | "requires_location_inputs" | null; }; + /** PaymentPagesCheckoutSessionBrandingSettings */ + payment_pages_checkout_session_branding_settings: { + /** @description A hex color value starting with `#` representing the background color for the Checkout Session. */ + background_color: string; + /** + * @description The border style for the Checkout Session. Must be one of `rounded`, `rectangular`, or `pill`. + * @enum {string} + */ + border_style: "pill" | "rectangular" | "rounded"; + /** @description A hex color value starting with `#` representing the button color for the Checkout Session. */ + button_color: string; + /** @description The display name shown on the Checkout Session. */ + display_name: string; + /** @description The font family for the Checkout Session. Must be one of the [supported font families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility). */ + font_family: string; + /** @description The icon for the Checkout Session. You cannot set both `logo` and `icon`. */ + icon?: components["schemas"]["payment_pages_checkout_session_branding_settings_icon"] | null; + /** @description The logo for the Checkout Session. You cannot set both `logo` and `icon`. */ + logo?: components["schemas"]["payment_pages_checkout_session_branding_settings_logo"] | null; + }; + /** PaymentPagesCheckoutSessionBrandingSettingsIcon */ + payment_pages_checkout_session_branding_settings_icon: { + /** @description The ID of a [File upload](https://stripe.com/docs/api/files) representing the icon. Purpose must be `business_icon`. Required if `type` is `file` and disallowed otherwise. */ + file?: string; + /** + * @description The type of image for the icon. Must be one of `file` or `url`. + * @enum {string} + */ + type: "file" | "url"; + /** @description The URL of the image. Present when `type` is `url`. */ + url?: string; + }; + /** PaymentPagesCheckoutSessionBrandingSettingsLogo */ + payment_pages_checkout_session_branding_settings_logo: { + /** @description The ID of a [File upload](https://stripe.com/docs/api/files) representing the logo. Purpose must be `business_logo`. Required if `type` is `file` and disallowed otherwise. */ + file?: string; + /** + * @description The type of image for the logo. Must be one of `file` or `url`. + * @enum {string} + */ + type: "file" | "url"; + /** @description The URL of the image. Present when `type` is `url`. */ + url?: string; + }; + /** PaymentPagesCheckoutSessionBusinessName */ + payment_pages_checkout_session_business_name: { + /** @description Indicates whether business name collection is enabled for the session */ + enabled: boolean; + /** @description Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ + optional: boolean; + }; + /** PaymentPagesCheckoutSessionCheckoutAddressDetails */ + payment_pages_checkout_session_checkout_address_details: { + address: components["schemas"]["address"]; + /** @description Customer name. */ + name: string; + }; + /** PaymentPagesCheckoutSessionCollectedInformation */ + payment_pages_checkout_session_collected_information: { + /** @description Customer’s business name for this Checkout Session */ + business_name?: string | null; + /** @description Customer’s individual name for this Checkout Session */ + individual_name?: string | null; + /** @description Shipping information for this Checkout Session. */ + shipping_details?: components["schemas"]["payment_pages_checkout_session_checkout_address_details"] | null; + }; /** PaymentPagesCheckoutSessionConsent */ payment_pages_checkout_session_consent: { /** @@ -21388,7 +23927,7 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsDropdown */ payment_pages_checkout_session_custom_fields_dropdown: { - /** @description The value that will pre-fill on the payment page. */ + /** @description The value that pre-fills on the payment page. */ default_value?: string | null; /** @description The options available for the customer to select. Up to 200 options allowed. */ options: components["schemas"]["payment_pages_checkout_session_custom_fields_option"][]; @@ -21407,7 +23946,7 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsNumeric */ payment_pages_checkout_session_custom_fields_numeric: { - /** @description The value that will pre-fill the field on the payment page. */ + /** @description The value that pre-fills the field on the payment page. */ default_value?: string | null; /** @description The maximum character length constraint for the customer's input. */ maximum_length?: number | null; @@ -21425,7 +23964,7 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomFieldsText */ payment_pages_checkout_session_custom_fields_text: { - /** @description The value that will pre-fill the field on the payment page. */ + /** @description The value that pre-fills the field on the payment page. */ default_value?: string | null; /** @description The maximum character length constraint for the customer's input. */ maximum_length?: number | null; @@ -21447,18 +23986,22 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomTextPosition */ payment_pages_checkout_session_custom_text_position: { - /** @description Text may be up to 1200 characters in length. */ + /** @description Text can be up to 1200 characters in length. */ message: string; }; /** PaymentPagesCheckoutSessionCustomerDetails */ payment_pages_checkout_session_customer_details: { /** @description The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ address?: components["schemas"]["address"] | null; + /** @description The customer's business name after a completed Checkout Session. */ + business_name?: string | null; /** * @description The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry. * Otherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form. */ email?: string | null; + /** @description The customer's individual name after a completed Checkout Session. */ + individual_name?: string | null; /** @description The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022. */ name?: string | null; /** @description The customer's phone number after a completed Checkout Session. */ @@ -21478,6 +24021,13 @@ export interface components { /** @description Promotion code attached to the Checkout Session. */ promotion_code?: (string | components["schemas"]["promotion_code"]) | null; }; + /** PaymentPagesCheckoutSessionIndividualName */ + payment_pages_checkout_session_individual_name: { + /** @description Indicates whether individual name collection is enabled for the session */ + enabled: boolean; + /** @description Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`. */ + optional: boolean; + }; /** PaymentPagesCheckoutSessionInvoiceCreation */ payment_pages_checkout_session_invoice_creation: { /** @description Indicates whether invoice creation is enabled for the Checkout Session. */ @@ -21496,12 +24046,32 @@ export interface components { footer?: string | null; /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ issuer?: components["schemas"]["connect_account_reference"] | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Options for invoice PDF rendering. */ - rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; + rendering_options?: components["schemas"]["invoice_setting_checkout_rendering_options"] | null; + }; + /** PaymentPagesCheckoutSessionNameCollection */ + payment_pages_checkout_session_name_collection: { + business?: components["schemas"]["payment_pages_checkout_session_business_name"]; + individual?: components["schemas"]["payment_pages_checkout_session_individual_name"]; + }; + /** PaymentPagesCheckoutSessionOptionalItem */ + payment_pages_checkout_session_optional_item: { + adjustable_quantity?: components["schemas"]["payment_pages_checkout_session_optional_item_adjustable_quantity"] | null; + price: string; + quantity: number; + }; + /** PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity */ + payment_pages_checkout_session_optional_item_adjustable_quantity: { + /** @description Set to true if the quantity can be adjusted to any non-negative integer. */ + enabled: boolean; + /** @description The maximum quantity of this item the customer can purchase. By default this value is 99. You can specify a value up to 999999. */ + maximum?: number | null; + /** @description The minimum quantity of this item the customer must purchase, if they choose to purchase it. Because this item is optional, the customer will always be able to remove it from their order, even if the `minimum` configured here is greater than 0. By default this value is 0. */ + minimum?: number | null; }; /** PaymentPagesCheckoutSessionPaymentMethodReuseAgreement */ payment_pages_checkout_session_payment_method_reuse_agreement: { @@ -21513,6 +24083,18 @@ export interface components { */ position: "auto" | "hidden"; }; + /** PaymentPagesCheckoutSessionPermissions */ + payment_pages_checkout_session_permissions: { + /** + * @description Determines which entity is allowed to update the shipping details. + * + * Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details. + * + * When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API. + * @enum {string|null} + */ + update_shipping_details?: "client_only" | "server_only" | null; + }; /** PaymentPagesCheckoutSessionPhoneNumberCollection */ payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ @@ -21564,10 +24146,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`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` + * @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`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -21598,8 +24180,405 @@ export interface components { /** @description The aggregated tax amounts by rate. */ taxes: components["schemas"]["line_items_tax_amount"][]; }; + /** PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions */ + payment_pages_private_card_payment_method_options_resource_restrictions: { + /** @description Specify the card brands to block in the Checkout Session. If a customer enters or selects a card belonging to a blocked brand, they can't complete the Session. */ + brands_blocked?: ("american_express" | "discover_global_network" | "mastercard" | "visa")[]; + }; + /** + * PaymentRecord + * @description A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe. + * For example, you can create a Payment Record to model a payment made on a different payment processor, + * in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or + * more Payment Attempt Records, which represent individual attempts made on a payment network. + */ + payment_record: { + amount: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_authorized: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_canceled: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_failed: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_guaranteed: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_refunded: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + amount_requested: components["schemas"]["payments_primitives_payment_records_resource_amount"]; + /** @description ID of the Connect application that created the PaymentRecord. */ + application?: string | null; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Customer information for this payment. */ + customer_details?: components["schemas"]["payments_primitives_payment_records_resource_customer_details"] | null; + /** + * @description Indicates whether the customer was present in your checkout flow during this payment. + * @enum {string|null} + */ + customer_presence?: "off_session" | "on_session" | null; + /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + description?: string | null; + /** @description Unique identifier for the object. */ + id: string; + /** @description ID of the latest Payment Attempt Record attached to this Payment Record. */ + latest_payment_attempt_record?: string | null; + /** @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://docs.stripe.com/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 String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "payment_record"; + /** @description Information about the Payment Method debited for this payment. */ + payment_method_details?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_details"] | null; + processor_details: components["schemas"]["payments_primitives_payment_records_resource_processor_details"]; + /** + * @description Indicates who reported the payment. + * @enum {string} + */ + reported_by: "self" | "stripe"; + /** @description Shipping information for this payment. */ + shipping_details?: components["schemas"]["payments_primitives_payment_records_resource_shipping_details"] | null; + }; /** Polymorphic */ payment_source: components["schemas"]["account"] | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]; + /** + * PaymentsPrimitivesPaymentRecordsResourceAddress + * @description A representation of a physical address. + */ + payments_primitives_payment_records_resource_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, such as the street, PO Box, or company name. */ + line1?: string | null; + /** @description Address line 2, such as the apartment, suite, unit, or building. */ + line2?: string | null; + /** @description ZIP or postal code. */ + postal_code?: string | null; + /** @description State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ + state?: string | null; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourceAmount + * @description A representation of an amount of money, consisting of an amount and a currency. + */ + payments_primitives_payment_records_resource_amount: { + /** + * Format: 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). + */ + currency: string; + /** @description A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY. */ + value: number; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourceBillingDetails + * @description Billing details used by the customer for this payment. + */ + payments_primitives_payment_records_resource_billing_details: { + address: components["schemas"]["payments_primitives_payment_records_resource_address"]; + /** @description The billing email associated with the method of payment. */ + email?: string | null; + /** @description The billing name associated with the method of payment. */ + name?: string | null; + /** @description The billing phone number associated with the method of payment. */ + phone?: string | null; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourceCustomerDetails + * @description Information about the customer for this payment. + */ + payments_primitives_payment_records_resource_customer_details: { + /** @description ID of the Stripe Customer associated with this payment. */ + customer?: string | null; + /** @description The customer's email address. */ + email?: string | null; + /** @description The customer's name. */ + name?: string | null; + /** @description The customer's phone number. */ + phone?: string | null; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetails + * @description Details of the card used for this payment attempt. + */ + payments_primitives_payment_records_resource_payment_method_card_details: { + /** @description The authorization code of the payment. */ + authorization_code?: string | null; + /** + * @description Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. + * @enum {string} + */ + brand: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa"; + /** + * Format: unix-time + * @description When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured. + */ + capture_before?: number; + /** @description Check results by Card networks on Card address and CVC at time of payment. */ + checks?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_checks"] | null; + /** @description Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. */ + country?: string | null; + /** @description A high-level description of the type of cards issued in this range. */ + description?: string | null; + /** @description Two-digit number representing the card's expiration month. */ + exp_month: number; + /** @description Four-digit number representing the card's expiration year. */ + exp_year: number; + /** + * @description Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number. + * + * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.* + */ + fingerprint?: string | null; + /** + * @description Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. + * @enum {string} + */ + funding: "credit" | "debit" | "prepaid" | "unknown"; + /** @description Issuer identification number of the card. */ + iin?: string | null; + /** @description Installment details for this payment. */ + installments?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_installments"] | null; + /** @description The name of the card's issuing bank. */ + issuer?: string | null; + /** @description The last four digits of the card. */ + last4: string; + /** + * @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`. + * @enum {string|null} + */ + network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "link" | "mastercard" | "unionpay" | "unknown" | "visa" | null; + /** @description Advice code from the card network for the failed payment. */ + network_advice_code?: string | null; + /** @description Decline code from the card network for the failed payment. */ + network_decline_code?: string | null; + /** @description If this card has network token credentials, this contains the details of the network token credentials. */ + network_token?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token"] | 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. This value will be present if it is returned by the financial network in the authorization response, and null otherwise. */ + network_transaction_id?: string | null; + /** + * @description The transaction type that was passed for an off-session, Merchant-Initiated transaction, one of `recurring` or `unscheduled`. + * @enum {string|null} + */ + stored_credential_usage?: "recurring" | "unscheduled" | null; + /** @description Populated if this transaction used 3D Secure authentication. */ + three_d_secure?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure"] | null; + /** @description If this Card is part of a card wallet, this contains the details of the card wallet. */ + wallet?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet"] | null; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceChecks */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_checks: { + /** + * @description If you provide a value for `address.line1`, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. + * @enum {string|null} + */ + address_line1_check?: "fail" | "pass" | "unavailable" | "unchecked" | null; + /** + * @description If you provide a address postal code, the check result is one of `pass`, `fail`, `unavailable`, or `unchecked`. + * @enum {string|null} + */ + address_postal_code_check?: "fail" | "pass" | "unavailable" | "unchecked" | null; + /** + * @description If you provide a CVC, the check results is one of `pass`, `fail`, `unavailable`, or `unchecked`. + * @enum {string|null} + */ + cvc_check?: "fail" | "pass" | "unavailable" | "unchecked" | null; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallmentPlan */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan: { + /** @description For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card. */ + count?: number | null; + /** + * @description For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card. One of `month`. + * @enum {string|null} + */ + interval?: "month" | null; + /** + * @description Type of installment plan, one of `fixed_count`, `revolving`, or `bonus`. + * @enum {string} + */ + type: "bonus" | "fixed_count" | "revolving"; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallments */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_installments: { + /** @description Installment plan selected for the payment. */ + plan?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan"] | null; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceNetworkToken */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token: { + /** @description Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction. */ + used: boolean; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceThreeDSecure */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure: { + /** + * @description For authenticated transactions: Indicates how the issuing bank authenticated the customer. + * @enum {string|null} + */ + authentication_flow?: "challenge" | "frictionless" | null; + /** + * @description Indicates the outcome of 3D Secure authentication. + * @enum {string|null} + */ + result?: "attempt_acknowledged" | "authenticated" | "exempted" | "failed" | "not_supported" | "processing_error" | null; + /** + * @description Additional information about why 3D Secure succeeded or failed, based on the `result`. + * @enum {string|null} + */ + result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected" | null; + /** + * @description The version of 3D Secure that was used. + * @enum {string|null} + */ + version?: "1.0.2" | "2.1.0" | "2.2.0" | null; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWallet */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet: { + apple_pay?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay"]; + /** @description (For tokenized numbers only.) The last four digits of the device account number. */ + dynamic_last4?: string; + google_pay?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay"]; + /** @description The type of the card wallet, one of `apple_pay` or `google_pay`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type. */ + type: string; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceApplePay */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay: { + /** @description Type of the apple_pay transaction, one of `apple_pay` or `apple_pay_later`. */ + type: string; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceGooglePay */ + payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay: Record; + /** + * PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCustomDetails + * @description Custom Payment Methods represent Payment Method types not modeled directly in + * the Stripe API. This resource consists of details about the custom payment method + * used for this payment attempt. + */ + payments_primitives_payment_records_resource_payment_method_custom_details: { + /** @description Display name for the custom (user-defined) payment method type used to make this payment. */ + display_name: string; + /** @description The custom payment method type associated with this payment. */ + type?: string | null; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails + * @description Details about the Payment Method used in this payment attempt. + */ + payments_primitives_payment_records_resource_payment_method_details: { + ach_credit_transfer?: components["schemas"]["payment_method_details_ach_credit_transfer"]; + ach_debit?: components["schemas"]["payment_method_details_ach_debit"]; + acss_debit?: components["schemas"]["payment_method_details_acss_debit"]; + affirm?: components["schemas"]["payment_method_details_payment_record_affirm"]; + afterpay_clearpay?: components["schemas"]["payment_method_details_payment_record_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"]; + bancontact?: components["schemas"]["payment_method_details_payment_record_bancontact"]; + billie?: components["schemas"]["payment_method_details_billie"]; + /** @description The billing details associated with the method of payment. */ + billing_details?: components["schemas"]["payments_primitives_payment_records_resource_billing_details"] | null; + blik?: components["schemas"]["payment_method_details_blik"]; + boleto?: components["schemas"]["payment_method_details_payment_record_boleto"]; + card?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_card_details"]; + card_present?: components["schemas"]["payment_method_details_card_present"]; + cashapp?: components["schemas"]["payment_method_details_payment_record_cashapp"]; + crypto?: components["schemas"]["payment_method_details_crypto"]; + custom?: components["schemas"]["payments_primitives_payment_records_resource_payment_method_custom_details"]; + customer_balance?: components["schemas"]["payment_method_details_customer_balance"]; + eps?: components["schemas"]["payment_method_details_eps"]; + fpx?: components["schemas"]["payment_method_details_fpx"]; + giropay?: components["schemas"]["payment_method_details_payment_record_giropay"]; + 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_payment_record_kakao_pay"]; + klarna?: components["schemas"]["payment_method_details_klarna"]; + konbini?: components["schemas"]["payment_method_details_payment_record_konbini"]; + kr_card?: components["schemas"]["payment_method_details_kr_card"]; + link?: components["schemas"]["payment_method_details_link"]; + mb_way?: components["schemas"]["payment_method_details_payment_record_mb_way"]; + mobilepay?: components["schemas"]["payment_method_details_mobilepay"]; + multibanco?: components["schemas"]["payment_method_details_payment_record_multibanco"]; + naver_pay?: components["schemas"]["payment_method_details_payment_record_naver_pay"]; + nz_bank_account?: components["schemas"]["payment_method_details_nz_bank_account"]; + oxxo?: components["schemas"]["payment_method_details_payment_record_oxxo"]; + p24?: components["schemas"]["payment_method_details_p24"]; + pay_by_bank?: components["schemas"]["payment_method_details_pay_by_bank"]; + payco?: components["schemas"]["payment_method_details_payco"]; + /** @description ID of the Stripe PaymentMethod used to make this payment. */ + payment_method?: string | null; + paynow?: components["schemas"]["payment_method_details_payment_record_paynow"]; + paypal?: components["schemas"]["payment_method_details_paypal"]; + payto?: components["schemas"]["payment_method_details_payto"]; + pix?: components["schemas"]["payment_method_details_pix"]; + promptpay?: components["schemas"]["payment_method_details_payment_record_promptpay"]; + revolut_pay?: components["schemas"]["payment_method_details_revolut_pay"]; + samsung_pay?: components["schemas"]["payment_method_details_samsung_pay"]; + satispay?: components["schemas"]["payment_method_details_satispay"]; + 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"]; + swish?: components["schemas"]["payment_method_details_swish"]; + twint?: components["schemas"]["payment_method_details_twint"]; + /** + * @description The type of transaction-specific details of the payment method used in the payment. See [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) for the full list of possible types. + * An additional hash is included on `payment_method_details` with a name matching this value. + * It contains information specific to the payment method. + */ + type: string; + us_bank_account?: components["schemas"]["payment_method_details_payment_record_us_bank_account"]; + wechat?: components["schemas"]["payment_method_details_wechat"]; + wechat_pay?: components["schemas"]["payment_method_details_payment_record_wechat_pay"]; + zip?: components["schemas"]["payment_method_details_payment_record_zip"]; + }; + /** PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKonbiniDetailsResourceStore */ + payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store: { + /** + * @description The name of the convenience store chain where the payment was completed. + * @enum {string|null} + */ + chain?: "familymart" | "lawson" | "ministop" | "seicomart" | null; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourceProcessorDetails + * @description Processor information associated with this payment. + */ + payments_primitives_payment_records_resource_processor_details: { + custom?: components["schemas"]["payments_primitives_payment_records_resource_processor_details_resource_custom_details"]; + /** + * @description The processor used for this payment attempt. + * @enum {string} + */ + type: "custom"; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourceProcessorDetailsResourceCustomDetails + * @description Custom processors represent payment processors not modeled directly in + * the Stripe API. This resource consists of details about the custom processor + * used for this payment attempt. + */ + payments_primitives_payment_records_resource_processor_details_resource_custom_details: { + /** @description An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID. */ + payment_reference?: string | null; + }; + /** + * PaymentsPrimitivesPaymentRecordsResourceShippingDetails + * @description The customer's shipping information associated with this payment. + */ + payments_primitives_payment_records_resource_shipping_details: { + address: components["schemas"]["payments_primitives_payment_records_resource_address"]; + /** @description The shipping recipient's name. */ + name?: string | null; + /** @description The shipping recipient's phone number. */ + phone?: string | null; + }; /** * Payout * @description A `Payout` object is created when you receive funds from Stripe, or when you @@ -21609,21 +24588,21 @@ export interface components { * schedules](/docs/connect/manage-payout-schedule), depending on your country and * industry. * - * Related guide: [Receiving payouts](https://stripe.com/docs/payouts) + * Related guide: [Receiving payouts](https://docs.stripe.com/payouts) */ payout: { /** @description The amount (in cents (or local equivalent)) that transfers to your bank account or debit card. */ amount: number; - /** @description The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /** @description The application fee (if any) for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details. */ + /** @description The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. */ application_fee_amount?: number | null; /** * Format: unix-time * @description Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays. */ arrival_date: number; - /** @description Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ + /** @description Returns `true` if the payout is created by an [automated payout schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). */ automatic: boolean; /** @description ID of the balance transaction that describes the impact of this payout on your account balance. */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -21643,7 +24622,7 @@ export interface components { destination?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["deleted_bank_account"] | components["schemas"]["deleted_card"]) | null; /** @description If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance. */ failure_balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; - /** @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures). */ + /** @description Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://docs.stripe.com/api#payout_failures). */ failure_code?: string | null; /** @description Message that provides the reason for a payout failure, if available. */ failure_message?: string | null; @@ -21651,7 +24630,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -21664,8 +24643,10 @@ export interface components { object: "payout"; /** @description If the payout reverses another, this is the ID of the original payout. */ original_payout?: (string | components["schemas"]["payout"]) | null; + /** @description ID of the v2 FinancialAccount the funds are sent to. */ + payout_method?: string | null; /** - * @description If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. + * @description If `completed`, you can use the [Balance Transactions API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. * @enum {string} */ reconciliation_status: "completed" | "in_progress" | "not_applicable"; @@ -21702,24 +24683,11 @@ export interface components { */ status: "eligible" | "not_eligible" | "partially_eligible"; }; - /** Period */ - period: { - /** - * Format: unix-time - * @description The end date of this usage period. All usage up to and including this point in time is included. - */ - end?: number | null; - /** - * Format: unix-time - * @description The start date of this usage period. All usage after this point in time is included. - */ - start?: number | null; - }; /** * Person * @description This is an object representing a person associated with a Stripe account. * - * A platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. + * A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. * * See the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information). */ @@ -21736,15 +24704,15 @@ export interface components { */ created: number; dob?: components["schemas"]["legal_entity_dob"]; - /** @description The person's email address. */ + /** @description The person's email address. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ email?: string | null; - /** @description The person's first name. */ + /** @description The person's first name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ first_name?: string | null; - /** @description The Kana variation of the person's first name (Japan only). */ + /** @description The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ first_name_kana?: string | null; - /** @description The Kanji variation of the person's first name (Japan only). */ + /** @description The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ first_name_kanji?: string | null; - /** @description A list of alternate names or aliases that the person is known by. */ + /** @description A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ full_name_aliases?: string[]; future_requirements?: components["schemas"]["person_future_requirements"] | null; /** @description The person's gender. */ @@ -21755,15 +24723,15 @@ export interface components { id_number_provided?: boolean; /** @description Whether the person's `id_number_secondary` was provided. */ id_number_secondary_provided?: boolean; - /** @description The person's last name. */ + /** @description The person's last name. Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ last_name?: string | null; - /** @description The Kana variation of the person's last name (Japan only). */ + /** @description The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ last_name_kana?: string | null; - /** @description The Kanji variation of the person's last name (Japan only). */ + /** @description The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`. */ last_name_kanji?: string | null; /** @description The person's maiden name. */ maiden_name?: string | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -21786,6 +24754,8 @@ export interface components { requirements?: components["schemas"]["person_requirements"] | null; /** @description Whether the last four digits of the person's Social Security number have been provided (U.S. only). */ ssn_last_4_provided?: boolean; + /** @description Demographic data related to the person. */ + us_cfpb_data?: components["schemas"]["person_us_cfpb_data"] | null; verification?: components["schemas"]["legal_entity_person_verification"]; }; /** PersonAdditionalTOSAcceptance */ @@ -21805,21 +24775,35 @@ export interface components { /** @description Details on the legal guardian's acceptance of the main Stripe service agreement. */ account?: components["schemas"]["person_additional_tos_acceptance"] | null; }; + /** PersonEthnicityDetails */ + person_ethnicity_details: { + /** @description The persons ethnicity */ + ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[] | null; + /** @description Please specify your origin, when other is selected. */ + ethnicity_other?: string | null; + }; /** PersonFutureRequirements */ person_future_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** @description Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; - /** @description Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. */ + /** @description Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition. */ currently_due: string[]; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors: components["schemas"]["account_requirements_error"][]; /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set. */ eventually_due: string[]; - /** @description Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`. */ + /** @description Fields that haven't been resolved by the account's `requirements.current_deadline`. These fields need to be resolved to enable the person's account. `future_requirements.past_due` is a subset of `requirements.past_due`. */ past_due: string[]; - /** @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. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. */ pending_verification: string[]; }; + /** PersonRaceDetails */ + person_race_details: { + /** @description The persons race. */ + race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[] | null; + /** @description Please specify your race, when other is selected. */ + race_other?: string | null; + }; /** PersonRelationship */ person_relationship: { /** @description Whether the person is the authorizer of the account's representative. */ @@ -21841,38 +24825,42 @@ export interface components { }; /** PersonRequirements */ person_requirements: { - /** @description Fields that are due and can be satisfied by providing the corresponding alternative fields instead. */ + /** @description Fields that are due and can be resolved by providing the corresponding alternative fields instead. Many alternatives can list the same `original_fields_due`, and any of these alternatives can serve as a pathway for attempting to resolve the fields again. Re-providing `original_fields_due` also serves as a pathway for attempting to resolve the fields again. */ alternatives?: components["schemas"]["account_requirements_alternative"][] | null; - /** @description Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled. */ + /** @description Fields that need to be resolved to keep the person's account enabled. If not resolved by the account's `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled. */ currently_due: string[]; - /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ + /** @description Details about validation and verification failures for `due` requirements that must be resolved. */ errors: components["schemas"]["account_requirements_error"][]; /** @description Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set. */ eventually_due: string[]; - /** @description Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account. */ + /** @description Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the person's account. */ past_due: string[]; - /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ + /** @description Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending. */ pending_verification: string[]; }; + /** PersonUSCfpbData */ + person_us_cfpb_data: { + /** @description The persons ethnicity details */ + ethnicity_details?: components["schemas"]["person_ethnicity_details"] | null; + /** @description The persons race details */ + race_details?: components["schemas"]["person_race_details"] | null; + /** @description The persons self-identified gender */ + self_identified_gender?: string | null; + }; /** * Plan - * @description You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration. + * @description You can now model subscriptions more flexibly using the [Prices API](https://api.stripe.com#prices). It replaces the Plans API and is backwards compatible to simplify your migration. * * Plans define the base price, currency, and billing cycle for recurring purchases of products. - * [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. + * [Products](https://api.stripe.com#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme. * * For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year. * - * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview). + * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and prices](https://docs.stripe.com/products-prices/overview). */ plan: { /** @description Whether the plan can be used for new purchases. */ active: boolean; - /** - * @description Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. - * @enum {string|null} - */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum" | null; /** @description The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. */ amount?: number | null; /** @@ -21906,7 +24894,7 @@ export interface components { interval_count: number; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -21930,7 +24918,7 @@ export interface components { tiers_mode?: "graduated" | "volume" | null; /** @description Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. */ transform_usage?: components["schemas"]["transform_usage"] | null; - /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). */ + /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). */ trial_period_days?: number | null; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. @@ -21964,7 +24952,7 @@ export interface components { /** @description Payout ID that created this application fee. */ payout?: string; /** - * @description Type of object that created the application fee, either `charge` or `payout`. + * @description Type of object that created the application fee. * @enum {string} */ type: "charge" | "payout"; @@ -22049,9 +25037,9 @@ export interface components { }; /** PortalFlowsFlowSubscriptionUpdateConfirm */ portal_flows_flow_subscription_update_confirm: { - /** @description The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified. */ + /** @description The coupon or promotion code to apply to this subscription update. */ discounts?: components["schemas"]["portal_flows_subscription_update_confirm_discount"][] | null; - /** @description The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. */ + /** @description The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. */ items: components["schemas"]["portal_flows_subscription_update_confirm_item"][]; /** @description The ID of the subscription to be updated. */ subscription: string; @@ -22075,11 +25063,11 @@ export interface components { }; /** PortalFlowsSubscriptionUpdateConfirmItem */ portal_flows_subscription_update_confirm_item: { - /** @description The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated. */ + /** @description The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated. */ id?: string | null; - /** @description The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). */ + /** @description The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). */ price?: string | null; - /** @description [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow. */ + /** @description [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow. */ quantity?: number; }; /** PortalInvoiceList */ @@ -22095,13 +25083,15 @@ export interface components { * If `false`, the previously generated `url`, if any, will be deactivated. */ enabled: boolean; - /** @description A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal. */ + /** @description A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal. */ url?: string | null; }; /** PortalPaymentMethodUpdate */ portal_payment_method_update: { /** @description Whether the feature is enabled. */ enabled: boolean; + /** @description The [Payment Method Configuration](/api/payment_method_configurations) to use for this portal session. When specified, customers will be able to update their payment method to one of the options specified by the payment method configuration. If not set, the default payment method configuration is used. */ + payment_method_configuration?: string | null; }; /** PortalResourceScheduleUpdateAtPeriodEnd */ portal_resource_schedule_update_at_period_end: { @@ -22141,6 +25131,11 @@ export interface components { }; /** PortalSubscriptionUpdate */ portal_subscription_update: { + /** + * @description Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). + * @enum {string|null} + */ + billing_cycle_anchor?: "now" | "unchanged" | null; /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ default_allowed_updates: ("price" | "promotion_code" | "quantity")[]; /** @description Whether the feature is enabled. */ @@ -22153,22 +25148,37 @@ export interface components { */ proration_behavior: "always_invoice" | "create_prorations" | "none"; schedule_at_period_end: components["schemas"]["portal_resource_schedule_update_at_period_end"]; + /** + * @description Determines how handle updates to trialing subscriptions. Valid values are `end_trial` and `continue_trial`. Defaults to a value of `end_trial` if you don't set it during creation. + * @enum {string} + */ + trial_update_behavior: "continue_trial" | "end_trial"; }; /** PortalSubscriptionUpdateProduct */ portal_subscription_update_product: { + adjustable_quantity: components["schemas"]["portal_subscription_update_product_adjustable_quantity"]; /** @description The list of price IDs which, when subscribed to, a subscription can be updated. */ prices: string[]; /** @description The product ID. */ product: string; }; + /** PortalSubscriptionUpdateProductAdjustableQuantity */ + portal_subscription_update_product_adjustable_quantity: { + /** @description If true, the quantity can be adjusted to any non-negative integer. */ + enabled: boolean; + /** @description The maximum quantity that can be set for the product. */ + maximum?: number | null; + /** @description The minimum quantity that can be set for the product. */ + minimum: number; + }; /** * Price * @description Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. - * [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. + * [Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. * * For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once. * - * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview). + * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview). */ price: { /** @description Whether the price can be used for new purchases. */ @@ -22200,7 +25210,7 @@ export interface components { livemode: boolean; /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ lookup_key?: string | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -22216,7 +25226,7 @@ export interface components { /** @description The recurring components of a price such as `interval` and `usage_type`. */ recurring?: components["schemas"]["recurring"] | null; /** - * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + * @description Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; @@ -22265,12 +25275,12 @@ export interface components { * Product * @description Products describe the specific goods or services you offer to your customers. * For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. - * They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. + * They can be used in conjunction with [Prices](https://api.stripe.com#prices) to configure pricing in Payment Links, Checkout, and Subscriptions. * - * Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), - * [share a Payment Link](https://stripe.com/docs/payment-links), - * [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront), - * and more about [Products and Prices](https://stripe.com/docs/products-prices/overview) + * Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), + * [share a Payment Link](https://docs.stripe.com/payment-links), + * [accept payments with Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront), + * and more about [Products and Prices](https://docs.stripe.com/products-prices/overview) */ product: { /** @description Whether the product is currently available for purchase. */ @@ -22280,7 +25290,7 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. */ + /** @description The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. */ default_price?: (string | components["schemas"]["price"]) | null; /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ description?: string | null; @@ -22290,9 +25300,9 @@ export interface components { images: 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 A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). */ marketing_features: components["schemas"]["product_marketing_feature"][]; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -22309,7 +25319,7 @@ export interface components { shippable?: boolean | null; /** @description Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments. */ statement_descriptor?: string | null; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. */ tax_code?: (string | components["schemas"]["tax_code"]) | null; /** @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. */ unit_label?: string | null; @@ -22345,22 +25355,26 @@ export interface components { }; /** * PromotionCode - * @description A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to - * create multiple codes for a single coupon. + * @description A Promotion Code represents a customer-redeemable code for an underlying promotion. + * You can create multiple codes for a single promotion. + * + * If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal. + * Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal. */ 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. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). */ + /** @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), digits (0-9), and dashes (-). */ code: string; - coupon: components["schemas"]["coupon"]; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The customer that this promotion code can be used by. */ + /** @description The customer who can use this promotion code. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The account representing the customer who can use this promotion code. */ + customer_account?: string | null; /** * Format: unix-time * @description Date at which the promotion code can no longer be redeemed. @@ -22372,7 +25386,7 @@ export interface components { livemode: boolean; /** @description Maximum number of times this promotion code can be redeemed. */ max_redemptions?: number | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -22381,6 +25395,7 @@ export interface components { * @enum {string} */ object: "promotion_code"; + promotion: components["schemas"]["promotion_codes_resource_promotion"]; restrictions: components["schemas"]["promotion_codes_resource_restrictions"]; /** @description Number of times this promotion code has been used. */ times_redeemed: number; @@ -22390,6 +25405,16 @@ export interface components { /** @description Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work). */ minimum_amount: number; }; + /** PromotionCodesResourcePromotion */ + promotion_codes_resource_promotion: { + /** @description If promotion `type` is `coupon`, the coupon for this promotion. */ + coupon?: (string | components["schemas"]["coupon"]) | null; + /** + * @description The type of promotion. + * @enum {string} + */ + type: "coupon"; + }; /** PromotionCodesResourceRestrictions */ promotion_codes_resource_restrictions: { /** @description Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). */ @@ -22403,6 +25428,11 @@ export interface components { /** @description Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount */ minimum_amount_currency?: string | null; }; + /** ProrationDetails */ + proration_details: { + /** @description Discount amounts applied when the proration was created. */ + discount_amounts: components["schemas"]["discounts_resource_discount_amount"][]; + }; /** * Quote * @description A Quote is a way to model prices that you'd like to provide to a customer. @@ -22433,8 +25463,10 @@ 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 | null; - /** @description The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ + /** @description The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it. */ + customer_account?: string | null; /** @description The tax rates applied to this quote. */ default_tax_rates?: (string | components["schemas"]["tax_rate"])[]; /** @description A description that will be displayed on the quote PDF. */ @@ -22448,7 +25480,7 @@ export interface components { expires_at: number; /** @description A footer that will be displayed on the quote PDF. */ footer?: string | null; - /** @description Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details. */ + /** @description Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details. */ from_quote?: components["schemas"]["quotes_resource_from_quote"] | null; /** @description A header that will be displayed on the quote PDF. */ header?: string | null; @@ -22476,11 +25508,11 @@ export interface components { }; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize). */ + /** @description A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize). */ number?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. @@ -22512,6 +25544,8 @@ export interface components { enabled: boolean; /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ liability?: components["schemas"]["connect_account_reference"] | null; + /** @description The tax provider powering automatic tax. */ + provider?: string | null; /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} @@ -22564,8 +25598,21 @@ export interface components { */ finalized_at?: number | null; }; + /** + * QuotesResourceSubscriptionDataBillingMode + * @description The billing mode of the quote. + */ + quotes_resource_subscription_data_billing_mode: { + flexible?: components["schemas"]["subscriptions_resource_billing_mode_flexible"]; + /** + * @description Controls how prorations and invoices for subscriptions are calculated and orchestrated. + * @enum {string} + */ + type: "classic" | "flexible"; + }; /** QuotesResourceSubscriptionDataSubscriptionData */ quotes_resource_subscription_data_subscription_data: { + billing_mode: components["schemas"]["quotes_resource_subscription_data_billing_mode"]; /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; /** @@ -22573,7 +25620,7 @@ export interface components { * @description When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch. */ effective_date?: number | null; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values. */ metadata?: { [key: string]: string; } | null; @@ -22636,7 +25683,7 @@ export interface components { * @description An early fraud warning indicates that the card issuer has notified us that a * charge may be fraudulent. * - * Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings) + * Related guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings) */ "radar.early_fraud_warning": { /** @description An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later. */ @@ -22662,11 +25709,43 @@ export interface components { /** @description ID of the Payment Intent this early fraud warning is for, optionally expanded. */ payment_intent?: string | components["schemas"]["payment_intent"]; }; + /** + * InsightsResourcesPaymentEvaluation + * @description Payment Evaluations represent the risk lifecycle of an externally processed payment. It includes the Radar risk score from Stripe, payment outcome taken by the merchant or processor, and any post transaction events, such as refunds or disputes. See the [Radar API guide](/radar/multiprocessor) for integration steps. + */ + "radar.payment_evaluation": { + client_device_metadata_details?: components["schemas"]["insights_resources_payment_evaluation_client_device_metadata"]; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created_at: number; + customer_details?: components["schemas"]["insights_resources_payment_evaluation_customer_details"]; + /** @description Event information associated with the payment evaluation, such as refunds, dispute, early fraud warnings, or user interventions. */ + events: components["schemas"]["insights_resources_payment_evaluation_event"][]; + /** @description Unique identifier for the object. */ + id: string; + insights: components["schemas"]["insights_resources_payment_evaluation_insights"]; + /** @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://docs.stripe.com/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} + */ + object: "radar.payment_evaluation"; + /** @description Indicates the final outcome for the payment evaluation. */ + outcome?: components["schemas"]["insights_resources_payment_evaluation_outcome"] | null; + payment_details?: components["schemas"]["insights_resources_payment_evaluation_payment_details"]; + }; /** * RadarListList * @description Value lists allow you to group values together which can then be referenced in rules. * - * Related guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items) + * Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items) */ "radar.value_list": { /** @description The name of the value list for use in rules. */ @@ -22681,7 +25760,7 @@ export interface components { /** @description Unique identifier for the object. */ id: string; /** - * @description The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. + * @description The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. * @enum {string} */ item_type: "card_bin" | "card_fingerprint" | "case_sensitive_string" | "country" | "customer_id" | "email" | "ip_address" | "sepa_debit_fingerprint" | "string" | "us_bank_account_fingerprint"; @@ -22704,7 +25783,7 @@ export interface components { }; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -22720,7 +25799,7 @@ export interface components { * RadarListListItem * @description Value list items allow you to add specific values to a given Radar value list, which can then be used in rules. * - * Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items) + * Related guide: [Managing list items](https://docs.stripe.com/radar/lists#managing-list-items) */ "radar.value_list_item": { /** @@ -22746,10 +25825,10 @@ export interface components { }; /** * RadarRadarOptions - * @description Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + * @description Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. */ radar_radar_options: { - /** @description A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. */ + /** @description A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. */ session?: string; }; /** RadarReviewResourceLocation */ @@ -22788,11 +25867,6 @@ export interface components { }; /** Recurring */ recurring: { - /** - * @description Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. - * @enum {string|null} - */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum" | null; /** * @description The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. * @enum {string} @@ -22814,7 +25888,7 @@ export interface components { * refunded yet. Funds are refunded to the credit or debit card that's * initially charged. * - * Related guide: [Refunds](https://stripe.com/docs/refunds) + * Related guide: [Refunds](https://docs.stripe.com/refunds) */ refund: { /** @description Amount, in cents (or local equivalent). */ @@ -22844,7 +25918,7 @@ export interface components { id: string; /** @description For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -22856,6 +25930,12 @@ export interface components { object: "refund"; /** @description ID of the PaymentIntent that's refunded. */ payment_intent?: (string | components["schemas"]["payment_intent"]) | null; + /** + * @description Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`. + * @enum {string} + */ + pending_reason?: "charge_pending" | "insufficient_funds" | "processing"; + presentment_details?: components["schemas"]["payment_flows_payment_intent_presentment_details"]; /** * @description Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`). * @enum {string|null} @@ -22865,7 +25945,7 @@ export interface components { receipt_number?: string | null; /** @description The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. */ source_transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; - /** @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ + /** @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds). */ status?: string | null; /** @description This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. */ transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; @@ -22882,6 +25962,7 @@ export interface components { br_bank_transfer?: components["schemas"]["refund_destination_details_br_bank_transfer"]; card?: components["schemas"]["refund_destination_details_card"]; cashapp?: components["schemas"]["destination_details_unimplemented"]; + crypto?: components["schemas"]["refund_destination_details_crypto"]; customer_cash_balance?: components["schemas"]["destination_details_unimplemented"]; eps?: components["schemas"]["destination_details_unimplemented"]; eu_bank_transfer?: components["schemas"]["refund_destination_details_eu_bank_transfer"]; @@ -22890,16 +25971,19 @@ export interface components { grabpay?: components["schemas"]["destination_details_unimplemented"]; jp_bank_transfer?: components["schemas"]["refund_destination_details_jp_bank_transfer"]; klarna?: components["schemas"]["destination_details_unimplemented"]; + mb_way?: components["schemas"]["refund_destination_details_mb_way"]; multibanco?: components["schemas"]["refund_destination_details_multibanco"]; mx_bank_transfer?: components["schemas"]["refund_destination_details_mx_bank_transfer"]; + nz_bank_transfer?: components["schemas"]["destination_details_unimplemented"]; p24?: components["schemas"]["refund_destination_details_p24"]; paynow?: components["schemas"]["destination_details_unimplemented"]; - paypal?: components["schemas"]["destination_details_unimplemented"]; + paypal?: components["schemas"]["refund_destination_details_paypal"]; pix?: components["schemas"]["destination_details_unimplemented"]; revolut?: components["schemas"]["destination_details_unimplemented"]; sofort?: components["schemas"]["destination_details_unimplemented"]; swish?: components["schemas"]["refund_destination_details_swish"]; th_bank_transfer?: components["schemas"]["refund_destination_details_th_bank_transfer"]; + twint?: components["schemas"]["destination_details_unimplemented"]; /** @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_us_bank_transfer"]; @@ -22936,6 +26020,11 @@ export interface components { */ type: "pending" | "refund" | "reversal"; }; + /** refund_destination_details_crypto */ + refund_destination_details_crypto: { + /** @description The transaction hash of the refund. */ + reference?: string | null; + }; /** refund_destination_details_eu_bank_transfer */ refund_destination_details_eu_bank_transfer: { /** @description The reference assigned to the refund. */ @@ -22957,6 +26046,13 @@ export interface components { /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ reference_status?: string | null; }; + /** refund_destination_details_mb_way */ + refund_destination_details_mb_way: { + /** @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. */ @@ -22978,6 +26074,11 @@ export interface components { /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ reference_status?: string | null; }; + /** refund_destination_details_paypal */ + refund_destination_details_paypal: { + /** @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; + }; /** 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. */ @@ -23022,10 +26123,10 @@ export interface components { * specific run parameters. Once the object is created, Stripe begins processing the report. * When the report has finished running, it will give you a reference to a file * where you can retrieve your results. For an overview, see - * [API Access to Reports](https://stripe.com/docs/reporting/statements/api). + * [API Access to Reports](https://docs.stripe.com/reporting/statements/api). * * Note that certain report types can only be run based on your live-mode data (not test-mode - * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). + * data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes). */ "reporting.report_run": { /** @@ -23048,7 +26149,7 @@ export interface components { */ object: "reporting.report_run"; parameters: components["schemas"]["financial_reporting_finance_report_run_run_parameters"]; - /** @description The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`. */ + /** @description The ID of the [report type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`. */ report_type: string; /** * @description The file object representing the result of the report run (populated when @@ -23073,11 +26174,11 @@ export interface components { * @description The Report Type resource corresponds to a particular type of report, such as * the "Activity summary" or "Itemized payouts" reports. These objects are * identified by an ID belonging to a set of enumerated values. See - * [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api) + * [API Access to Reports documentation](https://docs.stripe.com/reporting/statements/api) * for those Report Type IDs, along with required and optional parameters. * * Note that certain report types can only be run based on your live-mode data (not test-mode - * data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes). + * data), and will error when queried without a [live-mode API key](https://docs.stripe.com/keys#test-live-modes). */ "reporting.report_type": { /** @@ -23092,7 +26193,7 @@ export interface components { data_available_start: number; /** @description List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.) */ default_columns?: string[] | null; - /** @description The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ + /** @description The [ID of the Report Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`. */ 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; @@ -23134,7 +26235,7 @@ export interface components { * @description Reviews can be used to supplement automated fraud detection with human expertise. * * Learn more about [Radar](/radar) and reviewing payments - * [here](https://stripe.com/docs/radar/reviews). + * [here](https://docs.stripe.com/radar/reviews). */ review: { /** @description The ZIP or postal code of the card used, if applicable. */ @@ -23142,10 +26243,10 @@ export interface components { /** @description The charge associated with this review. */ charge?: (string | components["schemas"]["charge"]) | null; /** - * @description The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. + * @description The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. * @enum {string|null} */ - closed_reason?: "approved" | "disputed" | "redacted" | "refunded" | "refunded_as_fraud" | null; + closed_reason?: "acknowledged" | "approved" | "canceled" | "disputed" | "payment_never_settled" | "redacted" | "refunded" | "refunded_as_fraud" | null; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. @@ -23173,7 +26274,7 @@ export interface components { opened_reason: "manual" | "rule"; /** @description The PaymentIntent ID associated with this review, if one exists. */ payment_intent?: string | components["schemas"]["payment_intent"]; - /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`. */ + /** @description The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. */ reason: string; /** @description Information related to the browsing session of the user who initiated the payment. */ session?: components["schemas"]["radar_review_resource_session"] | null; @@ -23198,7 +26299,7 @@ export interface components { }; /** * ScheduledQueryRun - * @description If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll + * @description If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll * receive a `sigma.scheduled_query_run.created` webhook each time the query * runs. The webhook contains a `ScheduledQueryRun` object, which you can use to * retrieve the query results. @@ -23275,7 +26376,7 @@ export interface components { * payment method using a SetupIntent. */ setup_attempt: { - /** @description The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. */ + /** @description The value of [application](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. */ application?: (string | components["schemas"]["application"]) | null; /** * @description If present, the SetupIntent's payment method will be attached to the in-context Stripe Account. @@ -23288,8 +26389,10 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. */ + /** @description The value of [customer](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** @description The value of [customer_account](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account) on the SetupIntent at the time of this confirmation. */ + customer_account?: string | null; /** * @description Indicates the directions of money movement for which this payment method is intended to be used. * @@ -23305,7 +26408,7 @@ export interface components { * @enum {string} */ object: "setup_attempt"; - /** @description The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. */ + /** @description The value of [on_behalf_of](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description ID of the payment method used with this SetupAttempt. */ payment_method: string | components["schemas"]["payment_method"]; @@ -23316,7 +26419,7 @@ export interface components { setup_intent: string | components["schemas"]["setup_intent"]; /** @description Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`. */ status: string; - /** @description The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. */ + /** @description The value of [usage](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. */ usage: string; }; /** SetupAttemptPaymentMethodDetails */ @@ -23335,7 +26438,10 @@ export interface components { 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"]; + naver_pay?: components["schemas"]["setup_attempt_payment_method_details_naver_pay"]; + nz_bank_account?: components["schemas"]["setup_attempt_payment_method_details_nz_bank_account"]; paypal?: components["schemas"]["setup_attempt_payment_method_details_paypal"]; + payto?: components["schemas"]["setup_attempt_payment_method_details_payto"]; revolut_pay?: components["schemas"]["setup_attempt_payment_method_details_revolut_pay"]; sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; @@ -23381,7 +26487,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`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. */ + /** @description Card brand. Can be `amex`, `cartes_bancaires`, `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; @@ -23439,15 +26545,15 @@ export interface components { /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** - * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * @description The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null; /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ - bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; + bic?: "ABNANL2A" | "ADYBNL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "BUUTNL2A" | "FNOMNL22" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MLLENL2A" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null; /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ @@ -23468,8 +26574,17 @@ export interface components { 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_naver_pay */ + setup_attempt_payment_method_details_naver_pay: { + /** @description Uniquely identifies this particular Naver Pay account. You can use this attribute to check whether two Naver Pay accounts are the same. */ + buyer_id?: string; + }; + /** setup_attempt_payment_method_details_nz_bank_account */ + setup_attempt_payment_method_details_nz_bank_account: Record; /** setup_attempt_payment_method_details_paypal */ setup_attempt_payment_method_details_paypal: Record; + /** setup_attempt_payment_method_details_payto */ + setup_attempt_payment_method_details_payto: Record; /** setup_attempt_payment_method_details_revolut_pay */ setup_attempt_payment_method_details_revolut_pay: Record; /** setup_attempt_payment_method_details_sepa_debit */ @@ -23506,7 +26621,7 @@ export interface components { * SetupIntent * @description A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. * For example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment. - * Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow. + * Later, you can use [PaymentIntents](https://api.stripe.com#payment_intents) to drive the payment flow. * * Create a SetupIntent when you're ready to collect your customer's payment credentials. * Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. @@ -23517,9 +26632,9 @@ export interface components { * For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through * [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection * to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). - * If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + * If you use the SetupIntent with a [Customer](https://api.stripe.com#setup_intent_object-customer), * it automatically attaches the resulting payment method to that Customer after successful setup. - * We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on + * We recommend using SetupIntents or [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on * PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods. * * By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. @@ -23559,8 +26674,16 @@ export interface components { * If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. */ customer?: (string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]) | null; + /** + * @description ID of the Account this SetupIntent belongs to, if one exists. + * + * If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + */ + customer_account?: string | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; + /** @description Payment method types that are excluded from this SetupIntent. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | null; /** * @description Indicates the directions of money movement for which this payment method is intended to be used. * @@ -23577,7 +26700,7 @@ export interface components { livemode: boolean; /** @description ID of the multi use Mandate generated by the SetupIntent. */ mandate?: (string | components["schemas"]["mandate"]) | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -23592,16 +26715,16 @@ 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](https://stripe.com/docs/api/payment_method_configurations) used for this Setup Intent. */ + /** @description Information about the [payment method configuration](https://docs.stripe.com/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; - /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. */ + /** @description The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ payment_method_types: string[]; /** @description ID of the single_use Mandate generated by the SetupIntent. */ single_use_mandate?: (string | components["schemas"]["mandate"]) | null; /** - * @description [Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. + * @description [Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. * @enum {string} */ status: "canceled" | "processing" | "requires_action" | "requires_confirmation" | "requires_payment_method" | "succeeded"; @@ -23616,7 +26739,7 @@ export interface components { setup_intent_next_action: { cashapp_handle_redirect_or_display_qr_code?: components["schemas"]["payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"]; redirect_to_url?: components["schemas"]["setup_intent_next_action_redirect_to_url"]; - /** @description Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ + /** @description Type of the next action to perform. Refer to the other child attributes under `next_action` for available values. Examples include: `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ type: string; /** @description When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. */ use_stripe_sdk?: Record; @@ -23651,8 +26774,10 @@ export interface components { bacs_debit?: components["schemas"]["setup_intent_payment_method_options_bacs_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card?: components["schemas"]["setup_intent_payment_method_options_card"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card_present?: components["schemas"]["setup_intent_payment_method_options_card_present"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; + klarna?: components["schemas"]["setup_intent_payment_method_options_klarna"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["setup_intent_payment_method_options_link"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; paypal?: components["schemas"]["setup_intent_payment_method_options_paypal"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; + payto?: components["schemas"]["setup_intent_payment_method_options_payto"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; us_bank_account?: components["schemas"]["setup_intent_payment_method_options_us_bank_account"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; }; @@ -23686,7 +26811,7 @@ export interface components { */ 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. + * @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://docs.stripe.com/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://docs.stripe.com/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} */ request_three_d_secure?: "any" | "automatic" | "challenge" | null; @@ -23731,6 +26856,16 @@ export interface components { }; /** setup_intent_payment_method_options_card_present */ setup_intent_payment_method_options_card_present: Record; + /** setup_intent_payment_method_options_klarna */ + setup_intent_payment_method_options_klarna: { + /** + * Format: currency + * @description The currency of the setup intent. Three letter ISO currency code. + */ + currency?: string | null; + /** @description Preferred locale of the Klarna checkout page that the customer is redirected to. */ + preferred_locale?: string | null; + }; /** setup_intent_payment_method_options_link */ setup_intent_payment_method_options_link: Record; /** setup_intent_payment_method_options_mandate_options_acss_debit */ @@ -23757,6 +26892,32 @@ export interface components { /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'DDIC' or 'STRIPE'. */ reference_prefix?: string; }; + /** setup_intent_payment_method_options_mandate_options_payto */ + setup_intent_payment_method_options_mandate_options_payto: { + /** @description Amount that will be collected. It is required when `amount_type` is `fixed`. */ + amount?: number | null; + /** + * @description The type of amount that will be collected. The amount charged must be exact or up to the value of `amount` param for `fixed` or `maximum` type respectively. Defaults to `maximum`. + * @enum {string|null} + */ + amount_type?: "fixed" | "maximum" | null; + /** @description Date, in YYYY-MM-DD format, after which payments will not be collected. Defaults to no end date. */ + end_date?: string | null; + /** + * @description The periodicity at which payments will be collected. Defaults to `adhoc`. + * @enum {string|null} + */ + payment_schedule?: "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly" | null; + /** @description The number of payments that will be made during a payment period. Defaults to 1 except for when `payment_schedule` is `adhoc`. In that case, it defaults to no limit. */ + payments_per_period?: number | null; + /** + * @description The purpose for which payments are made. Has a default value based on your merchant category code. + * @enum {string|null} + */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility" | null; + /** @description Date, in YYYY-MM-DD format, from which payments will be collected. Defaults to confirmation time. */ + start_date?: string | null; + }; /** setup_intent_payment_method_options_mandate_options_sepa_debit */ setup_intent_payment_method_options_mandate_options_sepa_debit: { /** @description Prefix used to generate the Mandate reference. Must be at most 12 characters long. Must consist of only uppercase letters, numbers, spaces, or the following special characters: '/', '_', '-', '&', '.'. Cannot begin with 'STRIPE'. */ @@ -23767,13 +26928,17 @@ export interface components { /** @description The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer. */ billing_agreement_id?: string | null; }; + /** setup_intent_payment_method_options_payto */ + setup_intent_payment_method_options_payto: { + mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_payto"]; + }; /** setup_intent_payment_method_options_sepa_debit */ setup_intent_payment_method_options_sepa_debit: { mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_sepa_debit"]; }; /** setup_intent_payment_method_options_us_bank_account */ setup_intent_payment_method_options_us_bank_account: { - financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; + financial_connections?: components["schemas"]["linked_account_options_common"]; mandate_options?: components["schemas"]["payment_method_options_us_bank_account_mandate_options"]; /** * @description Bank account verification method. @@ -23783,6 +26948,7 @@ export interface components { }; /** SetupIntentTypeSpecificPaymentMethodOptionsClient */ setup_intent_type_specific_payment_method_options_client: { + mandate_options?: components["schemas"]["setup_intent_payment_method_options_mandate_options_payto"]; /** * @description Bank account verification method. * @enum {string} @@ -23804,7 +26970,7 @@ export interface components { /** * ShippingRate * @description Shipping rates describe the price of shipping presented to your customers and - * applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping). + * applied to a purchase. For more information, see [Charge for shipping](https://docs.stripe.com/payments/during-payment/charge-shipping). */ shipping_rate: { /** @description Whether the shipping rate can be used for new purchases. Defaults to `true`. */ @@ -23823,7 +26989,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -23837,7 +27003,7 @@ export interface components { * @enum {string|null} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified" | null; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ tax_code?: (string | components["schemas"]["tax_code"]) | null; /** * @description The type of calculation to use on the shipping rate. @@ -23886,6 +27052,27 @@ export interface components { [key: string]: components["schemas"]["shipping_rate_currency_option"]; }; }; + /** + * SigmaSigmaResourcesSigmaAPIQuery + * @description A saved query object represents a query that can be executed for a run. + */ + "sigma.sigma_api_query": { + /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ + created: 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 The name of the query. */ + name: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "sigma.sigma_api_query"; + /** @description The sql statement for the query. */ + sql: string; + }; /** SigmaScheduledQueryRunError */ sigma_scheduled_query_run_error: { /** @description Information about the run failure. */ @@ -23898,11 +27085,11 @@ export interface components { * just like a `Card` object: once chargeable, they can be charged, or can be * attached to customers. * - * Stripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources). - * We recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods). + * Stripe doesn't recommend using the deprecated [Sources API](https://docs.stripe.com/api/sources). + * We recommend that you adopt the [PaymentMethods API](https://docs.stripe.com/api/payment_methods). * This newer API provides access to our latest features and payment method types. * - * Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers). + * Related guides: [Sources API](https://docs.stripe.com/sources) and [Sources & Customers](https://docs.stripe.com/sources/customers). */ source: { ach_credit_transfer?: components["schemas"]["source_type_ach_credit_transfer"]; @@ -23945,7 +27132,7 @@ export interface components { klarna?: components["schemas"]["source_type_klarna"]; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -23969,7 +27156,7 @@ export interface components { status: string; three_d_secure?: components["schemas"]["source_type_three_d_secure"]; /** - * @description The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used. + * @description The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://docs.stripe.com/sources) used. * @enum {string} */ type: "ach_credit_transfer" | "ach_debit" | "acss_debit" | "alipay" | "au_becs_debit" | "bancontact" | "card" | "card_present" | "eps" | "giropay" | "ideal" | "klarna" | "multibanco" | "p24" | "sepa_debit" | "sofort" | "three_d_secure" | "wechat"; @@ -24107,7 +27294,7 @@ export interface components { failure_reason?: string | null; /** @description The URL you provide to redirect the customer to after they authenticated their payment. */ return_url: string; - /** @description The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). */ + /** @description The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). */ status: string; /** @description The URL provided to you to redirect a customer to as part of a `redirect` authentication flow. */ url: string; @@ -24403,11 +27590,29 @@ export interface components { qr_code_url?: string | null; statement_descriptor?: string; }; + /** StackableDiscountWithDiscountSettings */ + stackable_discount_with_discount_settings: { + /** @description ID of the coupon to create a new discount for. */ + coupon?: (string | components["schemas"]["coupon"]) | null; + /** @description ID of an existing discount on the object (or one of its ancestors) to reuse. */ + discount?: (string | components["schemas"]["discount"]) | null; + /** @description ID of the promotion code to create a new discount for. */ + promotion_code?: (string | components["schemas"]["promotion_code"]) | null; + }; + /** StackableDiscountWithDiscountSettingsAndDiscountEnd */ + stackable_discount_with_discount_settings_and_discount_end: { + /** @description ID of the coupon to create a new discount for. */ + coupon?: (string | components["schemas"]["coupon"]) | null; + /** @description ID of an existing discount on the object (or one of its ancestors) to reuse. */ + discount?: (string | components["schemas"]["discount"]) | null; + /** @description ID of the promotion code to create a new discount for. */ + promotion_code?: (string | components["schemas"]["promotion_code"]) | null; + }; /** * Subscription * @description Subscriptions allow you to charge a customer on a recurring basis. * - * Related guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating) + * Related guide: [Creating subscriptions](https://docs.stripe.com/billing/subscriptions/creating) */ subscription: { /** @description ID of the Connect Application that created the subscription. */ @@ -24417,11 +27622,12 @@ export interface components { automatic_tax: components["schemas"]["subscription_automatic_tax"]; /** * Format: unix-time - * @description The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. + * @description The reference point that aligns future [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. */ billing_cycle_anchor: number; /** @description The fixed values used to calculate the `billing_cycle_anchor`. */ billing_cycle_anchor_config?: components["schemas"]["subscriptions_resource_billing_cycle_anchor_config"] | null; + billing_mode: components["schemas"]["subscriptions_resource_billing_mode"]; /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** @@ -24453,30 +27659,20 @@ export interface components { * @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; - /** - * Format: unix-time - * @description End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created. - */ - current_period_end: number; - /** - * Format: unix-time - * @description Start of the current period that the subscription has been invoiced for. - */ - current_period_start: number; /** @description ID of the customer who owns the subscription. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description ID of the account representing the customer who owns the subscription. */ + customer_account?: string | null; /** @description Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`. */ days_until_due?: number | null; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_payment_method?: (string | components["schemas"]["payment_method"]) | null; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_source?: (string | components["schemas"]["bank_account"] | components["schemas"]["card"] | components["schemas"]["source"]) | null; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. */ default_tax_rates?: components["schemas"]["tax_rate"][] | null; /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; - /** @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"])[]; /** @@ -24504,11 +27700,11 @@ export interface components { /** @description The URL where this list can be accessed. */ url: string; }; - /** @description The most recent invoice this subscription has generated. */ + /** @description The most recent invoice this subscription has generated over its lifecycle (for example, when it cycles or is updated). */ latest_invoice?: (string | components["schemas"]["invoice"]) | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -24522,17 +27718,17 @@ export interface components { * @enum {string} */ 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. */ + /** @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the [Connect documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) 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](https://stripe.com/docs/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://docs.stripe.com/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; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. */ pending_invoice_item_interval?: components["schemas"]["subscription_pending_invoice_item_interval"] | null; - /** @description You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). */ + /** @description You can use this [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2). */ pending_setup_intent?: (string | components["schemas"]["setup_intent"]) | null; - /** @description If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. */ + /** @description If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. */ pending_update?: components["schemas"]["subscriptions_resource_pending_update"] | null; /** @description The schedule attached to the subscription */ schedule?: (string | components["schemas"]["subscription_schedule"]) | null; @@ -24548,7 +27744,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](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. + * A subscription can only enter a `paused` status [when a trial ends without a payment method](https://docs.stripe.com/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://docs.stripe.com/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). * @@ -24566,7 +27762,7 @@ export interface components { */ trial_end?: number | null; /** @description Settings related to subscription trials. */ - trial_settings?: components["schemas"]["subscriptions_trials_resource_trial_settings"] | null; + trial_settings?: components["schemas"]["subscriptions_resource_trial_settings_trial_settings"] | null; /** * Format: unix-time * @description If the subscription has a trial, the beginning of that trial. @@ -24592,16 +27788,6 @@ export interface components { /** @description Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`. */ reset_billing_cycle_anchor?: boolean | null; }; - /** SubscriptionDetailsData */ - subscription_details_data: { - /** - * @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. - * *Note: This attribute is populated only for invoices created on or after June 29, 2023.* - */ - metadata?: { - [key: string]: string; - } | null; - }; /** * SubscriptionItem * @description Subscription items allow you to create customer subscriptions with more than @@ -24612,11 +27798,21 @@ export interface components { billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; + /** + * Format: unix-time + * @description The end time of this subscription item's current billing period. + */ + current_period_end: number; + /** + * Format: unix-time + * @description The start time of this subscription item's current billing period. + */ + current_period_start: number; /** @description The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ discounts: (string | components["schemas"]["discount"])[]; /** @description Unique identifier for the object. */ id: 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -24626,7 +27822,7 @@ export interface components { */ object: "subscription_item"; price: components["schemas"]["price"]; - /** @description The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed. */ + /** @description The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed. */ quantity?: number; /** @description The `subscription` this `subscription_item` belongs to. */ subscription: string; @@ -24647,7 +27843,7 @@ export interface components { */ 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. + * @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://docs.stripe.com/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://docs.stripe.com/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} */ request_three_d_secure?: "any" | "automatic" | "challenge" | null; @@ -24666,11 +27862,12 @@ export interface components { * SubscriptionSchedule * @description A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes. * - * Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules) + * Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules) */ subscription_schedule: { /** @description ID of the Connect Application that created the schedule. */ application?: (string | components["schemas"]["application"] | components["schemas"]["deleted_application"]) | null; + billing_mode: components["schemas"]["subscriptions_resource_billing_mode"]; /** * Format: unix-time * @description Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch. @@ -24690,6 +27887,8 @@ export interface components { current_phase?: components["schemas"]["subscription_schedule_current_phase"] | null; /** @description ID of the customer who owns the subscription schedule. */ customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + /** @description ID of the account who owns the subscription schedule. */ + customer_account?: string | null; default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; /** * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. @@ -24700,7 +27899,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -24719,7 +27918,7 @@ export interface components { /** @description ID of the subscription once managed by the subscription schedule (if it is released). */ released_subscription?: string | null; /** - * @description The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). + * @description The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules). * @enum {string} */ status: "active" | "canceled" | "completed" | "not_started" | "released"; @@ -24734,7 +27933,12 @@ export interface components { */ subscription_schedule_add_invoice_item: { /** @description The stackable discounts that will be applied to the item. */ - discounts: components["schemas"]["discounts_resource_stackable_discount"][]; + discounts: components["schemas"]["discounts_resource_stackable_discount_with_discount_end"][]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; + period: components["schemas"]["subscription_schedule_add_invoice_item_period"]; /** @description ID of the price used to generate the invoice item. */ price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; /** @description The quantity of the invoice item. */ @@ -24742,6 +27946,11 @@ export interface components { /** @description The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item. */ tax_rates?: components["schemas"]["tax_rate"][] | null; }; + /** SubscriptionScheduleAddInvoiceItemPeriod */ + subscription_schedule_add_invoice_item_period: { + end: components["schemas"]["subscription_schedules_resource_invoice_item_period_resource_period_end"]; + start: components["schemas"]["subscription_schedules_resource_invoice_item_period_resource_period_start"]; + }; /** * SubscriptionScheduleConfigurationItem * @description A phase item describes the price and quantity of a phase. @@ -24750,8 +27959,8 @@ export interface components { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ - discounts: components["schemas"]["discounts_resource_stackable_discount"][]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ + discounts: components["schemas"]["stackable_discount_with_discount_settings"][]; + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ metadata?: { [key: string]: string; } | null; @@ -24786,7 +27995,7 @@ export interface components { application_fee_percent?: number | null; automatic_tax?: components["schemas"]["schedules_phase_automatic_tax"]; /** - * @description Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * @description Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). * @enum {string|null} */ billing_cycle_anchor?: "automatic" | "phase_start" | null; @@ -24797,8 +28006,6 @@ export interface components { * @enum {string|null} */ collection_method?: "charge_automatically" | "send_invoice" | null; - /** @description ID of the coupon to use during this phase of the subscription schedule. */ - coupon?: (string | components["schemas"]["coupon"] | components["schemas"]["deleted_coupon"]) | null; /** * Format: 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). @@ -24811,7 +28018,7 @@ export interface components { /** @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; /** @description The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. */ - discounts: components["schemas"]["discounts_resource_stackable_discount"][]; + discounts: components["schemas"]["stackable_discount_with_discount_settings_and_discount_end"][]; /** * Format: unix-time * @description The end of this phase of the subscription schedule. @@ -24821,14 +28028,14 @@ export interface components { invoice_settings?: components["schemas"]["invoice_setting_subscription_schedule_phase_setting"] | null; /** @description Subscription items to configure the subscription to during this phase of the subscription schedule. */ items: components["schemas"]["subscription_schedule_configuration_item"][]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`. */ metadata?: { [key: string]: string; } | null; /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** - * @description If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`. + * @description When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`. * @enum {string} */ proration_behavior: "always_invoice" | "create_prorations" | "none"; @@ -24851,7 +28058,7 @@ export interface components { application_fee_percent?: number | null; automatic_tax?: components["schemas"]["subscription_schedules_resource_default_settings_automatic_tax"]; /** - * @description Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * @description Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). * @enum {string} */ billing_cycle_anchor: "automatic" | "phase_start"; @@ -24884,6 +28091,32 @@ export interface components { /** @description The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account. */ liability?: components["schemas"]["connect_account_reference"] | null; }; + /** SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodEnd */ + subscription_schedules_resource_invoice_item_period_resource_period_end: { + /** + * Format: unix-time + * @description A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`. + */ + timestamp?: number; + /** + * @description Select how to calculate the end of the invoice item period. + * @enum {string} + */ + type: "min_item_period_end" | "phase_end" | "timestamp"; + }; + /** SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodStart */ + subscription_schedules_resource_invoice_item_period_resource_period_start: { + /** + * Format: unix-time + * @description A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`. + */ + timestamp?: number; + /** + * @description Select how to calculate the start of the invoice item period. + * @enum {string} + */ + type: "max_item_period_start" | "phase_start" | "timestamp"; + }; /** SubscriptionTransferData */ subscription_transfer_data: { /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination. */ @@ -24904,6 +28137,32 @@ export interface components { /** @description The second of the minute of the billing_cycle_anchor. */ second?: number | null; }; + /** + * SubscriptionsResourceBillingMode + * @description The billing mode of the subscription. + */ + subscriptions_resource_billing_mode: { + /** @description Configure behavior for flexible billing mode */ + flexible?: components["schemas"]["subscriptions_resource_billing_mode_flexible"] | null; + /** + * @description Controls how prorations and invoices for subscriptions are calculated and orchestrated. + * @enum {string} + */ + type: "classic" | "flexible"; + /** + * Format: unix-time + * @description Details on when the current billing_mode was adopted. + */ + updated_at?: number; + }; + /** SubscriptionsResourceBillingModeFlexible */ + subscriptions_resource_billing_mode_flexible: { + /** + * @description Controls how invoices and invoice items display proration amounts and discount amounts. + * @enum {string} + */ + proration_discounts?: "included" | "itemized"; + }; /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -24933,6 +28192,8 @@ export interface components { customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; /** @description This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; + /** @description This sub-hash contains details about the PayTo payment method options to pass to invoices created by the subscription. */ + payto?: components["schemas"]["invoice_payment_method_options_payto"] | null; /** @description This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. */ sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; /** @description This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. */ @@ -24943,7 +28204,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" | "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; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "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} @@ -24973,7 +28234,7 @@ export interface components { * @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied. */ trial_end?: number | null; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_from_plan?: boolean | null; }; /** SubscriptionsResourceSubscriptionInvoiceSettings */ @@ -24982,6 +28243,24 @@ export interface components { account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; issuer: components["schemas"]["connect_account_reference"]; }; + /** + * SubscriptionsResourceTrialSettingsEndBehavior + * @description Defines how a subscription behaves when a trial ends. + */ + subscriptions_resource_trial_settings_end_behavior: { + /** + * @description Indicates how the subscription should change when the trial ends if the user did not provide a payment method. + * @enum {string} + */ + missing_payment_method: "cancel" | "create_invoice" | "pause"; + }; + /** + * SubscriptionsResourceTrialSettingsTrialSettings + * @description Configures how this subscription behaves during the trial period. + */ + subscriptions_resource_trial_settings_trial_settings: { + end_behavior: components["schemas"]["subscriptions_resource_trial_settings_end_behavior"]; + }; /** * SubscriptionsTrialsResourceEndBehavior * @description Defines how a subscription behaves when a free trial ends. @@ -25000,18 +28279,37 @@ export interface components { subscriptions_trials_resource_trial_settings: { end_behavior: components["schemas"]["subscriptions_trials_resource_end_behavior"]; }; + /** + * TaxProductResourceTaxAssociation + * @description A Tax Association exposes the Tax Transactions that Stripe attempted to create on your behalf based on the PaymentIntent input + */ + "tax.association": { + /** @description The [Tax Calculation](https://docs.stripe.com/api/tax/calculations/object) that was included in PaymentIntent. */ + calculation: string; + /** @description Unique identifier for the object. */ + id: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "tax.association"; + /** @description The [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) that this Tax Association is tracking. */ + payment_intent: string; + /** @description Information about the tax transactions linked to this payment intent */ + tax_transaction_attempts?: components["schemas"]["tax_product_resource_tax_association_transaction_attempts"][] | null; + }; /** * TaxProductResourceTaxCalculation * @description A Tax Calculation allows you to calculate the tax to collect from your customer. * - * Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom) + * Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom) */ "tax.calculation": { - /** @description Total amount after taxes in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description Total amount after taxes in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_total: 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 The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /** @description The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. */ customer?: string | null; customer_details: components["schemas"]["tax_product_resource_customer_details"]; /** @@ -25063,25 +28361,29 @@ export interface components { }; /** TaxProductResourceTaxCalculationLineItem */ "tax.calculation_line_item": { - /** @description The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_tax: 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 Set of [key-value pairs](https://docs.stripe.com/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} */ object: "tax.calculation_line_item"; - /** @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /** @description The ID of an existing [Product](https://docs.stripe.com/api/products/object). */ product?: string | null; /** @description The number of units of the item being purchased. For reversals, this is the quantity reversed. */ quantity: number; /** @description A custom identifier for this line item. */ - reference?: string | null; + reference: string; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. * @enum {string} @@ -25089,16 +28391,16 @@ export interface components { tax_behavior: "exclusive" | "inclusive"; /** @description Detailed account of taxes relevant to this line item. */ tax_breakdown?: components["schemas"]["tax_product_resource_line_item_tax_breakdown"][] | null; - /** @description The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. */ + /** @description The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. */ tax_code: string; }; /** * TaxProductRegistrationsResourceTaxRegistration - * @description A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax). + * @description A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://docs.stripe.com/tax). * - * Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering). + * Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://docs.stripe.com/tax/registering). * - * Related guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api) + * Related guide: [Using the Registrations API](https://docs.stripe.com/tax/registrations-api) */ "tax.registration": { /** @@ -25138,7 +28440,7 @@ export interface components { * TaxProductResourceTaxSettings * @description You can use Tax `Settings` to manage configurations used by Stripe Tax calculations. * - * Related guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api) + * Related guide: [Using the Settings API](https://docs.stripe.com/tax/settings-api) */ "tax.settings": { defaults: components["schemas"]["tax_product_resource_tax_settings_defaults"]; @@ -25162,7 +28464,7 @@ export interface components { * TaxProductResourceTaxTransaction * @description A Tax Transaction records the tax collected from or refunded to your customer. * - * Related guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction) + * Related guide: [Calculate tax in your custom payment flow](https://docs.stripe.com/tax/custom#tax-transaction) */ "tax.transaction": { /** @@ -25172,7 +28474,7 @@ 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 The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource. */ + /** @description The ID of an existing [Customer](https://docs.stripe.com/api/customers/object) used for the resource. */ customer?: string | null; customer_details: components["schemas"]["tax_product_resource_customer_details"]; /** @description Unique identifier for the transaction. */ @@ -25196,7 +28498,7 @@ export interface components { } | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -25231,15 +28533,15 @@ export interface components { }; /** TaxProductResourceTaxTransactionLineItem */ "tax.transaction_line_item": { - /** @description The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The line item amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of tax calculated for this line item, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_tax: 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 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -25248,7 +28550,7 @@ export interface components { * @enum {string} */ object: "tax.transaction_line_item"; - /** @description The ID of an existing [Product](https://stripe.com/docs/api/products/object). */ + /** @description The ID of an existing [Product](https://docs.stripe.com/api/products/object). */ product?: string | null; /** @description The number of units of the item being purchased. For reversals, this is the quantity reversed. */ quantity: number; @@ -25261,7 +28563,7 @@ export interface components { * @enum {string} */ tax_behavior: "exclusive" | "inclusive"; - /** @description The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource. */ + /** @description The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. */ tax_code: string; /** * @description If `reversal`, this line item reverses an earlier transaction. @@ -25316,6 +28618,8 @@ export interface components { application?: string | components["schemas"]["application"]; /** @description The customer being referenced when `type` is `customer`. */ customer?: string | components["schemas"]["customer"]; + /** @description The Account representing the customer being referenced when `type` is `customer`. */ + customer_account?: string | null; /** * @description Type of owner referenced. * @enum {string} @@ -25324,10 +28628,10 @@ export interface components { }; /** * tax_id - * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. + * @description You can add one or multiple tax IDs to a [customer](https://docs.stripe.com/api/customers) or account. * Customer and account tax IDs get displayed on related invoices and credit notes. * - * Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) + * Related guides: [Customer tax identification numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids) */ tax_id: { /** @description Two-letter ISO code representing the country of the tax ID. */ @@ -25339,6 +28643,8 @@ export interface components { created: number; /** @description ID of the customer. */ customer?: (string | components["schemas"]["customer"]) | null; + /** @description ID of the Account representing the customer. */ + customer_account?: string | 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. */ @@ -25351,10 +28657,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`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -25374,25 +28680,32 @@ export interface components { }; /** TaxProductRegistrationsResourceCountryOptions */ tax_product_registrations_resource_country_options: { - ae?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + ae?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; al?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; am?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ao?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; at?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; - au?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + au?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; + aw?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + az?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ba?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; bb?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + bd?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; be?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + bf?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; bg?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; bh?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + bj?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; bs?: 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"]; cd?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; - ch?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + ch?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; cl?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + cm?: 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"]; + cv?: 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"]; @@ -25401,9 +28714,10 @@ export interface components { 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"]; + et?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; fi?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; fr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; - gb?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + gb?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; ge?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; gn?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; gr?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; @@ -25411,13 +28725,17 @@ export interface components { hu?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; id?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ie?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; + in?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; is?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; it?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; - jp?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + jp?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; ke?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + kg?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kh?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; kz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + la?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + lk?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; 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"]; @@ -25431,11 +28749,12 @@ export interface components { my?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ng?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; nl?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; - no?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + no?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; np?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; - nz?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; + nz?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; om?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; pe?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + ph?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; 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"]; @@ -25443,15 +28762,17 @@ export interface components { 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"]; + sg?: components["schemas"]["tax_product_registrations_resource_country_options_default_inbound_goods"]; si?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; sk?: components["schemas"]["tax_product_registrations_resource_country_options_europe"]; sn?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; sr?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; - th?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + th?: components["schemas"]["tax_product_registrations_resource_country_options_thailand"]; tj?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tr?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + tw?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; tz?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; + ua?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; ug?: components["schemas"]["tax_product_registrations_resource_country_options_simplified"]; us?: components["schemas"]["tax_product_registrations_resource_country_options_united_states"]; uy?: components["schemas"]["tax_product_registrations_resource_country_options_default"]; @@ -25483,13 +28804,30 @@ export interface components { */ type: "standard"; }; + /** TaxProductRegistrationsResourceCountryOptionsDefaultInboundGoods */ + tax_product_registrations_resource_country_options_default_inbound_goods: { + standard?: components["schemas"]["tax_product_registrations_resource_country_options_default_standard"]; + /** + * @description Type of registration in `country`. + * @enum {string} + */ + type: "standard"; + }; + /** TaxProductRegistrationsResourceCountryOptionsDefaultStandard */ + tax_product_registrations_resource_country_options_default_standard: { + /** + * @description Place of supply scheme used in an Default standard registration. + * @enum {string} + */ + place_of_supply_scheme: "inbound_goods" | "standard"; + }; /** TaxProductRegistrationsResourceCountryOptionsEuStandard */ tax_product_registrations_resource_country_options_eu_standard: { /** * @description Place of supply scheme used in an EU standard registration. * @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** TaxProductRegistrationsResourceCountryOptionsEurope */ tax_product_registrations_resource_country_options_europe: { @@ -25508,6 +28846,14 @@ export interface components { */ type: "simplified"; }; + /** TaxProductRegistrationsResourceCountryOptionsThailand */ + tax_product_registrations_resource_country_options_thailand: { + /** + * @description Type of registration in `country`. + * @enum {string} + */ + type: "simplified"; + }; /** TaxProductRegistrationsResourceCountryOptionsUnitedStates */ tax_product_registrations_resource_country_options_united_states: { local_amusement_tax?: components["schemas"]["tax_product_registrations_resource_country_options_us_local_amusement_tax"]; @@ -25568,10 +28914,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`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or `unknown` + * @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`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "unknown" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description The value of the tax ID. */ value: string; }; @@ -25586,12 +28932,12 @@ export interface components { * @enum {string} */ level: "city" | "country" | "county" | "district" | "state"; - /** @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. */ + /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. */ state?: string | null; }; /** TaxProductResourceLineItemTaxBreakdown */ tax_product_resource_line_item_tax_breakdown: { - /** @description The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; jurisdiction: components["schemas"]["tax_product_resource_jurisdiction"]; /** @@ -25606,7 +28952,7 @@ export interface components { * @enum {string} */ taxability_reason: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; - /** @description The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ taxable_amount: number; }; /** TaxProductResourceLineItemTaxRateDetails */ @@ -25627,22 +28973,44 @@ export interface components { 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; - /** @description Address line 1 (e.g., street, PO Box, or company name). */ + /** @description Address line 1, such as the street, PO Box, or company name. */ line1?: string | null; - /** @description Address line 2 (e.g., apartment, suite, unit, or building). */ + /** @description Address line 2, such as the apartment, suite, unit, or building. */ line2?: string | null; /** @description ZIP or postal code. */ postal_code?: string | null; - /** @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". */ + /** @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix, such as "NY" or "TX". */ state?: string | null; }; /** TaxProductResourceShipFromDetails */ tax_product_resource_ship_from_details: { address: components["schemas"]["tax_product_resource_postal_address"]; }; + /** TaxProductResourceTaxAssociationTransactionAttempts */ + tax_product_resource_tax_association_transaction_attempts: { + committed?: components["schemas"]["tax_product_resource_tax_association_transaction_attempts_resource_committed"]; + errored?: components["schemas"]["tax_product_resource_tax_association_transaction_attempts_resource_errored"]; + /** @description The source of the tax transaction attempt. This is either a refund or a payment intent. */ + source: string; + /** @description The status of the transaction attempt. This can be `errored` or `committed`. */ + status: string; + }; + /** TaxProductResourceTaxAssociationTransactionAttemptsResourceCommitted */ + tax_product_resource_tax_association_transaction_attempts_resource_committed: { + /** @description The [Tax Transaction](https://docs.stripe.com/api/tax/transaction/object) */ + transaction: string; + }; + /** TaxProductResourceTaxAssociationTransactionAttemptsResourceErrored */ + tax_product_resource_tax_association_transaction_attempts_resource_errored: { + /** + * @description Details on why we couldn't commit the tax transaction. + * @enum {string} + */ + reason: "another_payment_associated_with_calculation" | "calculation_expired" | "currency_mismatch" | "original_transaction_voided" | "unique_reference_violation"; + }; /** TaxProductResourceTaxBreakdown */ tax_product_resource_tax_breakdown: { - /** @description The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of tax, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; /** @description Specifies whether the tax amount is included in the line item amount. */ inclusive: boolean; @@ -25652,16 +29020,16 @@ export interface components { * @enum {string} */ taxability_reason: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; - /** @description The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount on which tax is calculated, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ taxable_amount: number; }; /** TaxProductResourceTaxCalculationShippingCost */ tax_product_resource_tax_calculation_shipping_cost: { - /** @description The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_tax: number; - /** @description The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). */ + /** @description The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). */ shipping_rate?: string; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. @@ -25670,7 +29038,7 @@ export interface components { tax_behavior: "exclusive" | "inclusive"; /** @description Detailed account of taxes relevant to shipping cost. */ tax_breakdown?: components["schemas"]["tax_product_resource_line_item_tax_breakdown"][]; - /** @description The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. */ + /** @description The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. */ tax_code: string; }; /** TaxProductResourceTaxRateDetails */ @@ -25682,11 +29050,11 @@ export interface components { /** @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. + * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. * @enum {string|null} */ rate_type?: "flat_amount" | "percentage" | null; - /** @description State, county, province, or region. */ + /** @description State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). */ state?: string | null; /** * @description The tax type, such as `vat` or `sales_tax`. @@ -25696,6 +29064,11 @@ export interface components { }; /** TaxProductResourceTaxSettingsDefaults */ tax_product_resource_tax_settings_defaults: { + /** + * @description The tax calculation provider this account uses. Defaults to `stripe` when not using a [third-party provider](/tax/third-party-apps). + * @enum {string} + */ + provider: "anrok" | "avalara" | "sphere" | "stripe"; /** * @description Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior. * @enum {string|null} @@ -25732,25 +29105,25 @@ export interface components { }; /** TaxProductResourceTaxTransactionShippingCost */ tax_product_resource_tax_transaction_shipping_cost: { - /** @description The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The shipping amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of tax calculated for shipping, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_tax: number; - /** @description The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). */ + /** @description The ID of an existing [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). */ shipping_rate?: string; /** * @description Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes. * @enum {string} */ tax_behavior: "exclusive" | "inclusive"; - /** @description The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping. */ + /** @description The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. */ tax_code: string; }; /** * TaxRate - * @description Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax. + * @description Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax. * - * Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates) + * Related guide: [Tax rates](/billing/taxes/tax-rates) */ tax_rate: { /** @description Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set. */ @@ -25787,7 +29160,7 @@ export interface components { jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state" | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -25799,11 +29172,11 @@ export interface components { /** @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. + * @description Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax. * @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. */ + /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. */ state?: string | null; /** * @description The high-level tax type, such as `vat` or `sales_tax`. @@ -25824,9 +29197,12 @@ export interface components { /** * TerminalConfigurationConfiguration * @description A Configurations object represents how features should be configured for terminal readers. + * For information about how to use it, see the [Terminal configurations documentation](https://docs.stripe.com/terminal/fleet/configurations-overview). */ "terminal.configuration": { + bbpos_wisepad3?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; bbpos_wisepos_e?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; + cellular?: components["schemas"]["terminal_configuration_configuration_resource_cellular_config"]; /** @description Unique identifier for the object. */ id: string; /** @description Whether this Configuration is the default for your account */ @@ -25843,14 +29219,16 @@ export interface components { offline?: components["schemas"]["terminal_configuration_configuration_resource_offline_config"]; reboot_window?: components["schemas"]["terminal_configuration_configuration_resource_reboot_window"]; stripe_s700?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; + stripe_s710?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; tipping?: components["schemas"]["terminal_configuration_configuration_resource_tipping"]; verifone_p400?: components["schemas"]["terminal_configuration_configuration_resource_device_type_specific_config"]; + wifi?: components["schemas"]["terminal_configuration_configuration_resource_wifi_config"]; }; /** * TerminalConnectionToken * @description A Connection Token is used by the Stripe Terminal SDK to connect to a reader. * - * Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations) + * Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations) */ "terminal.connection_token": { /** @description The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens). */ @@ -25867,19 +29245,25 @@ export interface components { * TerminalLocationLocation * @description A Location represents a grouping of readers. * - * Related guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations) + * Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations) */ "terminal.location": { address: components["schemas"]["address"]; + address_kana?: components["schemas"]["legal_entity_japan_address"]; + address_kanji?: components["schemas"]["legal_entity_japan_address"]; /** @description The ID of a configuration that will be used to customize all readers in this location. */ configuration_overrides?: string; /** @description The display name of the location. */ display_name: string; + /** @description The Kana variation of the display name of the location. */ + display_name_kana?: string; + /** @description The Kanji variation of the display name of the location. */ + display_name_kanji?: string; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -25888,12 +29272,32 @@ export interface components { * @enum {string} */ object: "terminal.location"; + /** @description The phone number of the location. */ + phone?: string; + }; + /** + * TerminalOnboardingLinkOnboardingLink + * @description Returns redirect links used for onboarding onto Tap to Pay on iPhone. + */ + "terminal.onboarding_link": { + link_options: components["schemas"]["terminal_onboarding_link_link_options"]; + /** + * @description The type of link being generated. + * @enum {string} + */ + link_type: "apple_terms_and_conditions"; + /** @enum {string} */ + object: "terminal.onboarding_link"; + /** @description Stripe account ID to generate the link for. */ + on_behalf_of?: string | null; + /** @description The link passed back to the user for their onboarding. */ + redirect_url: string; }; /** * TerminalReaderReader * @description A Reader represents a physical device for accepting payment details. * - * Related guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader) + * Related guide: [Connecting to a reader](https://docs.stripe.com/terminal/payments/connect-reader) */ "terminal.reader": { /** @description The most recent action performed by the reader. */ @@ -25901,21 +29305,26 @@ export interface components { /** @description The current software version of the reader. */ device_sw_version?: string | null; /** - * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. + * @description Device type of the reader. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "verifone_P400"; + device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_stripe_s700" | "simulated_stripe_s710" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "stripe_s710" | "verifone_P400"; /** @description Unique identifier for the object. */ id: string; /** @description The local IP address of the reader. */ ip_address?: string | null; /** @description Custom label given to the reader for easier identification. */ label: string; + /** + * Format: unix-time + * @description The last time this reader reported to Stripe backend. Timestamp is measured in milliseconds since the Unix epoch. Unlike most other Stripe timestamp fields which use seconds, this field uses milliseconds. + */ + last_seen_at?: number | null; /** @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 The location identifier of the reader. */ location?: (string | components["schemas"]["terminal.location"]) | null; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -25932,6 +29341,16 @@ export interface components { */ status?: "offline" | "online" | null; }; + /** + * TerminalRefundsRefund + * @description A Refund object returned by the Terminal refunds API. + */ + "terminal.refund": Record; + /** TerminalConfigurationConfigurationResourceCellularConfig */ + terminal_configuration_configuration_resource_cellular_config: { + /** @description Whether a cellular-capable reader can connect to the internet over cellular. */ + enabled: boolean; + }; /** TerminalConfigurationConfigurationResourceCurrencySpecificConfig */ terminal_configuration_configuration_resource_currency_specific_config: { /** @description Fixed amounts displayed when collecting a tip */ @@ -25943,14 +29362,45 @@ export interface components { }; /** TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig */ terminal_configuration_configuration_resource_device_type_specific_config: { - /** @description A File ID representing an image you would like displayed on the reader. */ + /** @description A File ID representing an image to display on the reader */ splashscreen?: string | components["schemas"]["file"]; }; + /** TerminalConfigurationConfigurationResourceEnterprisePEAPWifi */ + terminal_configuration_configuration_resource_enterprise_peap_wifi: { + /** @description A File ID representing a PEM file containing the server certificate */ + ca_certificate_file?: string; + /** @description Password for connecting to the WiFi network */ + password: string; + /** @description Name of the WiFi network */ + ssid: string; + /** @description Username for connecting to the WiFi network */ + username: string; + }; + /** TerminalConfigurationConfigurationResourceEnterpriseTLSWifi */ + terminal_configuration_configuration_resource_enterprise_tls_wifi: { + /** @description A File ID representing a PEM file containing the server certificate */ + ca_certificate_file?: string; + /** @description A File ID representing a PEM file containing the client certificate */ + client_certificate_file: string; + /** @description A File ID representing a PEM file containing the client RSA private key */ + private_key_file: string; + /** @description Password for the private key file */ + private_key_file_password?: string; + /** @description Name of the WiFi network */ + ssid: string; + }; /** TerminalConfigurationConfigurationResourceOfflineConfig */ terminal_configuration_configuration_resource_offline_config: { /** @description Determines whether to allow transactions to be collected while reader is offline. Defaults to false. */ enabled?: boolean | null; }; + /** TerminalConfigurationConfigurationResourcePersonalPSKWifi */ + terminal_configuration_configuration_resource_personal_psk_wifi: { + /** @description Password for connecting to the WiFi network */ + password: string; + /** @description Name of the WiFi network */ + ssid: string; + }; /** TerminalConfigurationConfigurationResourceRebootWindow */ terminal_configuration_configuration_resource_reboot_window: { /** @description Integer between 0 to 23 that represents the end hour of the reboot time window. The value must be different than the start_hour. */ @@ -25960,6 +29410,7 @@ export interface components { }; /** TerminalConfigurationConfigurationResourceTipping */ terminal_configuration_configuration_resource_tipping: { + aed?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; aud?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; cad?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; chf?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; @@ -25967,16 +29418,49 @@ export interface components { dkk?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; eur?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; gbp?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; + gip?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; hkd?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; + huf?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; jpy?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; + mxn?: components["schemas"]["terminal_configuration_configuration_resource_currency_specific_config"]; 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"]; + ron?: 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"]; }; + /** TerminalConfigurationConfigurationResourceWifiConfig */ + terminal_configuration_configuration_resource_wifi_config: { + enterprise_eap_peap?: components["schemas"]["terminal_configuration_configuration_resource_enterprise_peap_wifi"]; + enterprise_eap_tls?: components["schemas"]["terminal_configuration_configuration_resource_enterprise_tls_wifi"]; + personal_psk?: components["schemas"]["terminal_configuration_configuration_resource_personal_psk_wifi"]; + /** + * @description Security type of the WiFi network. The hash with the corresponding name contains the credentials for this security type. + * @enum {string} + */ + type: "enterprise_eap_peap" | "enterprise_eap_tls" | "personal_psk"; + }; + /** + * TerminalOnboardingLinkAppleTermsAndConditions + * @description Options associated with the Apple Terms and Conditions link type. + */ + terminal_onboarding_link_apple_terms_and_conditions: { + /** @description Whether the link should also support users relinking their Apple account. */ + allow_relinking?: boolean | null; + /** @description The business name of the merchant accepting Apple's Terms and Conditions. */ + merchant_display_name: string; + }; + /** + * TerminalOnboardingLinkLinkOptions + * @description Link type options associated with the current onboarding link object. + */ + terminal_onboarding_link_link_options: { + /** @description The options associated with the Apple Terms and Conditions link type. */ + apple_terms_and_conditions?: components["schemas"]["terminal_onboarding_link_apple_terms_and_conditions"] | null; + }; /** * TerminalReaderReaderResourceCart * @description Represents a cart to be displayed on the reader @@ -25989,30 +29473,160 @@ export interface components { currency: string; /** @description List of line items in the cart. */ line_items: components["schemas"]["terminal_reader_reader_resource_line_item"][]; - /** @description Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ tax?: number | null; - /** @description Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ total: number; }; + /** + * TerminalReaderReaderResourceChoice + * @description Choice to be selected on a Reader + */ + terminal_reader_reader_resource_choice: { + /** @description The identifier for the selected choice. Maximum 50 characters. */ + id?: string | null; + /** + * @description The button style for the choice. Can be `primary` or `secondary`. + * @enum {string|null} + */ + style?: "primary" | "secondary" | null; + /** @description The text to be selected. Maximum 30 characters. */ + text: string; + }; + /** + * TerminalReaderReaderResourceCollectConfig + * @description Represents a per-transaction override of a reader configuration + */ + terminal_reader_reader_resource_collect_config: { + /** @description Enable customer-initiated cancellation when processing this payment. */ + enable_customer_cancellation?: boolean; + /** @description Override showing a tipping selection screen on this transaction. */ + skip_tipping?: boolean; + tipping?: components["schemas"]["terminal_reader_reader_resource_tipping_config"]; + }; + /** + * TerminalReaderReaderResourceCollectInputsAction + * @description Represents a reader action to collect customer inputs + */ + terminal_reader_reader_resource_collect_inputs_action: { + /** @description List of inputs to be collected. */ + inputs: components["schemas"]["terminal_reader_reader_resource_input"][]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; + }; + /** + * TerminalReaderReaderResourceCollectPaymentMethodAction + * @description Represents a reader action to collect a payment method + */ + terminal_reader_reader_resource_collect_payment_method_action: { + collect_config?: components["schemas"]["terminal_reader_reader_resource_collect_config"]; + /** @description Most recent PaymentIntent processed by the reader. */ + payment_intent: string | components["schemas"]["payment_intent"]; + payment_method?: components["schemas"]["payment_method"]; + }; + /** + * TerminalReaderReaderResourceConfirmConfig + * @description Represents a per-transaction override of a reader configuration + */ + terminal_reader_reader_resource_confirm_config: { + /** @description If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion. */ + return_url?: string; + }; + /** + * TerminalReaderReaderResourceConfirmPaymentIntentAction + * @description Represents a reader action to confirm a payment + */ + terminal_reader_reader_resource_confirm_payment_intent_action: { + confirm_config?: components["schemas"]["terminal_reader_reader_resource_confirm_config"]; + /** @description Most recent PaymentIntent processed by the reader. */ + payment_intent: string | components["schemas"]["payment_intent"]; + }; + /** + * TerminalReaderReaderResourceCustomText + * @description Represents custom text to be displayed when collecting the input using a reader + */ + terminal_reader_reader_resource_custom_text: { + /** @description Customize the default description for this input */ + description?: string | null; + /** @description Customize the default label for this input's skip button */ + skip_button?: string | null; + /** @description Customize the default label for this input's submit button */ + submit_button?: string | null; + /** @description Customize the default title for this input */ + title?: string | null; + }; + /** + * TerminalReaderReaderResourceEmail + * @description Information about a email being collected using a reader + */ + terminal_reader_reader_resource_email: { + /** @description The collected email address */ + value?: string | null; + }; + /** + * TerminalReaderReaderResourceInput + * @description Represents an input to be collected using the reader + */ + terminal_reader_reader_resource_input: { + /** @description Default text of input being collected. */ + custom_text?: components["schemas"]["terminal_reader_reader_resource_custom_text"] | null; + email?: components["schemas"]["terminal_reader_reader_resource_email"]; + numeric?: components["schemas"]["terminal_reader_reader_resource_numeric"]; + phone?: components["schemas"]["terminal_reader_reader_resource_phone"]; + /** @description Indicate that this input is required, disabling the skip button. */ + required?: boolean | null; + selection?: components["schemas"]["terminal_reader_reader_resource_selection"]; + signature?: components["schemas"]["terminal_reader_reader_resource_signature"]; + /** @description Indicate that this input was skipped by the user. */ + skipped?: boolean; + text?: components["schemas"]["terminal_reader_reader_resource_text"]; + /** @description List of toggles being collected. Values are present if collection is complete. */ + toggles?: components["schemas"]["terminal_reader_reader_resource_toggle"][] | null; + /** + * @description Type of input being collected. + * @enum {string} + */ + type: "email" | "numeric" | "phone" | "selection" | "signature" | "text"; + }; /** * TerminalReaderReaderResourceLineItem * @description Represents a line item to be displayed on the reader */ terminal_reader_reader_resource_line_item: { - /** @description The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount of the line item. A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; /** @description Description of the line item. */ description: string; /** @description The quantity of the line item. */ quantity: number; }; + /** + * TerminalReaderReaderResourceNumeric + * @description Information about a number being collected using a reader + */ + terminal_reader_reader_resource_numeric: { + /** @description The collected number */ + value?: string | null; + }; + /** + * TerminalReaderReaderResourcePhone + * @description Information about a phone number being collected using a reader + */ + terminal_reader_reader_resource_phone: { + /** @description The collected phone number */ + value?: string | null; + }; /** * TerminalReaderReaderResourceProcessConfig * @description Represents a per-transaction override of a reader configuration */ terminal_reader_reader_resource_process_config: { - /** @description Enable customer initiated cancellation when processing this payment. */ + /** @description Enable customer-initiated cancellation when processing this payment. */ enable_customer_cancellation?: boolean; + /** @description If the customer doesn't abandon authenticating the payment, they're redirected to this URL after completion. */ + return_url?: string; /** @description Override showing a tipping selection screen on this transaction. */ skip_tipping?: boolean; tipping?: components["schemas"]["terminal_reader_reader_resource_tipping_config"]; @@ -26031,7 +29645,7 @@ export interface components { * @description Represents a per-setup override of a reader configuration */ terminal_reader_reader_resource_process_setup_config: { - /** @description Enable customer initiated cancellation when processing this SetupIntent. */ + /** @description Enable customer-initiated cancellation when processing this SetupIntent. */ enable_customer_cancellation?: boolean; }; /** @@ -26050,6 +29664,9 @@ export interface components { * @description Represents an action performed by the reader */ terminal_reader_reader_resource_reader_action: { + collect_inputs?: components["schemas"]["terminal_reader_reader_resource_collect_inputs_action"]; + collect_payment_method?: components["schemas"]["terminal_reader_reader_resource_collect_payment_method_action"]; + confirm_payment_intent?: components["schemas"]["terminal_reader_reader_resource_confirm_payment_intent_action"]; /** @description Failure code, only set if status is `failed`. */ failure_code?: string | null; /** @description Detailed failure message, only set if status is `failed`. */ @@ -26067,7 +29684,7 @@ export interface components { * @description Type of action performed by the reader. * @enum {string} */ - type: "process_payment_intent" | "process_setup_intent" | "refund_payment" | "set_reader_display"; + type: "collect_inputs" | "collect_payment_method" | "confirm_payment_intent" | "process_payment_intent" | "process_setup_intent" | "refund_payment" | "set_reader_display"; }; /** * TerminalReaderReaderResourceRefundPaymentAction @@ -26078,7 +29695,7 @@ export interface components { amount?: number; /** @description Charge that is being refunded. */ charge?: string | components["schemas"]["charge"]; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26102,22 +29719,50 @@ export interface components { * @description Represents a per-transaction override of a reader configuration */ terminal_reader_reader_resource_refund_payment_config: { - /** @description Enable customer initiated cancellation when refunding this payment. */ + /** @description Enable customer-initiated cancellation when refunding this payment. */ enable_customer_cancellation?: boolean; }; + /** + * TerminalReaderReaderResourceSelection + * @description Information about a selection being collected using a reader + */ + terminal_reader_reader_resource_selection: { + /** @description List of possible choices to be selected */ + choices: components["schemas"]["terminal_reader_reader_resource_choice"][]; + /** @description The id of the selected choice */ + id?: string | null; + /** @description The text of the selected choice */ + text?: string | null; + }; /** * TerminalReaderReaderResourceSetReaderDisplayAction * @description Represents a reader action to set the reader display */ terminal_reader_reader_resource_set_reader_display_action: { - /** @description Cart object to be displayed by the reader. */ + /** @description Cart object to be displayed by the reader, including line items, amounts, and currency. */ cart?: components["schemas"]["terminal_reader_reader_resource_cart"] | null; /** - * @description Type of information to be displayed by the reader. + * @description Type of information to be displayed by the reader. Only `cart` is currently supported. * @enum {string} */ type: "cart"; }; + /** + * TerminalReaderReaderResourceSignature + * @description Information about a signature being collected using a reader + */ + terminal_reader_reader_resource_signature: { + /** @description The File ID of a collected signature image */ + value?: string | null; + }; + /** + * TerminalReaderReaderResourceText + * @description Information about text being collected using a reader + */ + terminal_reader_reader_resource_text: { + /** @description The collected text value */ + value?: string | null; + }; /** * TerminalReaderReaderResourceTippingConfig * @description Represents a per-transaction tipping configuration @@ -26126,6 +29771,26 @@ export interface components { /** @description Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency). */ amount_eligible?: number; }; + /** + * TerminalReaderReaderResourceToggle + * @description Information about an input's toggle + */ + terminal_reader_reader_resource_toggle: { + /** + * @description The toggle's default value. Can be `enabled` or `disabled`. + * @enum {string|null} + */ + default_value?: "disabled" | "enabled" | null; + /** @description The toggle's description text. Maximum 50 characters. */ + description?: string | null; + /** @description The toggle's title text. Maximum 50 characters. */ + title?: string | null; + /** + * @description The toggle's collected value. Can be `enabled` or `disabled`. + * @enum {string|null} + */ + value?: "disabled" | "enabled" | null; + }; /** * TestClock * @description A test clock enables deterministic control over objects in testmode. With a test clock, you can create @@ -26200,7 +29865,7 @@ export interface components { * @description The version of 3D Secure that was used. * @enum {string|null} */ - version?: "1.0.2" | "2.1.0" | "2.2.0" | null; + version?: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1" | null; }; /** three_d_secure_details_charge */ three_d_secure_details_charge: { @@ -26246,7 +29911,7 @@ export interface components { * @description The version of 3D Secure that was used. * @enum {string|null} */ - version?: "1.0.2" | "2.1.0" | "2.2.0" | null; + version?: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1" | null; }; /** three_d_secure_usage */ three_d_secure_usage: { @@ -26283,7 +29948,7 @@ export interface components { * account details, or personally identifiable information (PII), directly from * your customers in a secure manner. A token representing this information is * returned to your server to use. Use our - * [recommended payments integrations](https://stripe.com/docs/payments) to perform this process + * [recommended payments integrations](https://docs.stripe.com/payments) to perform this process * on the client-side. This guarantees that no sensitive card data touches your server, * and allows your integration to operate in a PCI-compliant way. * @@ -26295,9 +29960,9 @@ export interface components { * Stripe, so we can't determine how it's handled or stored. * * You can't store or use tokens more than once. To store card or bank account - * information for later use, create [Customer](https://stripe.com/docs/api#customers) + * information for later use, create [Customer](https://docs.stripe.com/api#customers) * objects or [External accounts](/api#external_accounts). - * [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, + * [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection, * performs best with integrations that use client-side tokenization. */ token: { @@ -26335,7 +30000,7 @@ export interface components { * individual top-ups, as well as list all top-ups. Top-ups are identified by a * unique, random ID. * - * Related guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups) + * Related guide: [Topping up your platform account](https://docs.stripe.com/connect/top-ups) */ topup: { /** @description Amount transferred. */ @@ -26353,7 +30018,7 @@ export interface components { description?: string | null; /** @description Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up. */ expected_availability_date?: number | null; - /** @description Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes). */ + /** @description Error code explaining reason for top-up failure if available (see [the errors section](https://docs.stripe.com/api#errors) for a list of codes). */ failure_code?: string | null; /** @description Message to user further explaining reason for top-up failure if available. */ failure_message?: string | null; @@ -26361,7 +30026,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26389,11 +30054,11 @@ export interface components { * * Before April 6, 2017, transfers also represented movement of funds from a * Stripe account to a card or bank account. This behavior has since been split - * out into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more + * out into a [Payout](https://api.stripe.com#payout_object) object, with corresponding payout endpoints. For more * information, read about the - * [transfer/payout split](https://stripe.com/docs/transfer-payout-split). + * [transfer/payout split](https://docs.stripe.com/transfer-payout-split). * - * Related guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) + * Related guide: [Creating separate charges and transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) */ transfer: { /** @description Amount in cents (or local equivalent) to be transferred. */ @@ -26422,7 +30087,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26454,23 +30119,23 @@ export interface components { source_transaction?: (string | components["schemas"]["charge"]) | null; /** @description The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`. */ source_type?: string; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. */ transfer_group?: string | null; }; /** transfer_data */ transfer_data: { - /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ - amount?: number; /** - * @description The account (if any) that the payment is attributed to for tax - * reporting, and where funds from the payment are transferred to after - * payment success. + * @description The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account. + * The amount must be less than or equal to the [amount](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer + * representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00). */ + amount?: number; + /** @description The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success. */ destination: string | components["schemas"]["account"]; }; /** * TransferReversal - * @description [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a + * @description [Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a * connected account, either entirely or partially, and can also specify whether * to refund any related application fees. Transfer reversals add to the * platform's balance and subtract from the destination account's balance. @@ -26478,11 +30143,11 @@ export interface components { * Reversing a transfer that was made for a [destination * charge](/docs/connect/destination-charges) is allowed only up to the amount of * the charge. It is possible to reverse a - * [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + * [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) * transfer only if the destination account has enough balance to cover the * reversal. * - * Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers) + * Related guide: [Reverse transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) */ transfer_reversal: { /** @description Amount, in cents (or local equivalent). */ @@ -26503,7 +30168,7 @@ export interface components { destination_payment_refund?: (string | components["schemas"]["refund"]) | null; /** @description Unique identifier for the object. */ id: 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -26525,8 +30190,12 @@ export interface components { interval: string; /** @description The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. */ monthly_anchor?: number; + /** @description The days of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. */ + monthly_payout_days?: number[]; /** @description The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. */ weekly_anchor?: string; + /** @description The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly. */ + weekly_payout_days?: ("friday" | "monday" | "thursday" | "tuesday" | "wednesday")[]; }; /** TransformQuantity */ transform_quantity: { @@ -26550,7 +30219,7 @@ export interface components { }; /** * TreasuryReceivedCreditsResourceCreditReversal - * @description You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. + * @description You can reverse some [ReceivedCredits](https://api.stripe.com#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal. */ "treasury.credit_reversal": { /** @description Amount (in cents) transferred. */ @@ -26567,13 +30236,13 @@ export interface components { currency: string; /** @description The FinancialAccount to reverse funds from. */ financial_account: string; - /** @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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26600,7 +30269,7 @@ export interface components { }; /** * TreasuryReceivedDebitsResourceDebitReversal - * @description You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. + * @description You can reverse some [ReceivedDebits](https://api.stripe.com#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. */ "treasury.debit_reversal": { /** @description Amount (in cents) transferred. */ @@ -26617,7 +30286,7 @@ export interface components { currency: string; /** @description The FinancialAccount to reverse funds from. */ 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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26625,7 +30294,7 @@ export interface components { linked_flows?: components["schemas"]["treasury_received_debits_resource_debit_reversal_linked_flows"] | null; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26674,7 +30343,7 @@ export interface components { is_default?: boolean; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; @@ -26721,7 +30390,7 @@ export interface components { }; /** * TreasuryInboundTransfersResourceInboundTransfer - * @description Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. + * @description Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. * * Related guide: [Moving money with Treasury using InboundTransfer objects](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) */ @@ -26746,14 +30415,14 @@ export interface components { failure_details?: components["schemas"]["treasury_inbound_transfers_resource_failure_details"] | null; /** @description The FinancialAccount that received the funds. */ financial_account: string; - /** @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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; linked_flows: components["schemas"]["treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows"]; /** @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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26781,7 +30450,7 @@ export interface components { }; /** * TreasuryOutboundPaymentsResourceOutboundPayment - * @description Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + * @description Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or [FinancialAccount](https://api.stripe.com#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://api.stripe.com#outbound_transfers). * * Simulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects. * @@ -26802,7 +30471,7 @@ export interface components { * @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 ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent. */ + /** @description ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. */ customer?: string | null; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; @@ -26819,13 +30488,13 @@ export interface components { expected_arrival_date: number; /** @description The FinancialAccount that funds were pulled from. */ financial_account: string; - /** @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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26851,7 +30520,7 @@ export interface components { }; /** * TreasuryOutboundTransfersResourceOutboundTransfer - * @description Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. + * @description Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. * * Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects. * @@ -26884,13 +30553,13 @@ export interface components { expected_arrival_date: number; /** @description The FinancialAccount that funds were pulled from. */ financial_account: string; - /** @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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -26916,7 +30585,7 @@ export interface components { }; /** * TreasuryReceivedCreditsResourceReceivedCredit - * @description ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. + * @description ReceivedCredits represent funds sent to a [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. */ "treasury.received_credit": { /** @description Amount (in cents) transferred. */ @@ -26940,7 +30609,7 @@ export interface components { 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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -26970,7 +30639,7 @@ export interface components { }; /** * TreasuryReceivedDebitsResourceReceivedDebit - * @description ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount. + * @description ReceivedDebits represent funds pulled from a [FinancialAccount](https://api.stripe.com#financial_accounts). These are not initiated from the FinancialAccount. */ "treasury.received_debit": { /** @description Amount (in cents) transferred. */ @@ -26994,7 +30663,7 @@ export interface components { failure_code?: "account_closed" | "account_frozen" | "insufficient_funds" | "international_transaction" | "other" | null; /** @description The FinancialAccount that funds were pulled from. */ 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. */ + /** @description A [hosted transaction receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. */ hosted_regulatory_receipt_url?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -27024,7 +30693,7 @@ export interface components { }; /** * TreasuryTransactionsResourceTransaction - * @description Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance. + * @description Transactions represent changes to a [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. */ "treasury.transaction": { /** @description Amount (in cents) transferred. */ @@ -27088,7 +30757,7 @@ export interface components { }; /** * TreasuryTransactionsResourceTransactionEntry - * @description TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions). + * @description TransactionEntries represent individual units of money movements within a single [Transaction](https://api.stripe.com#transactions). */ "treasury.transaction_entry": { balance_impact: components["schemas"]["treasury_transactions_resource_balance_impact"]; @@ -27476,9 +31145,9 @@ export interface components { treasury_received_credits_resource_linked_flows: { /** @description The CreditReversal created as a result of this ReceivedCredit being reversed. */ credit_reversal?: string | null; - /** @description Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /** @description Set if the ReceivedCredit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object. */ issuing_authorization?: string | null; - /** @description Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object. */ + /** @description Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://api.stripe.com#issuing_transactions) object. */ issuing_transaction?: string | null; /** @description ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. */ source_flow?: string | null; @@ -27531,12 +31200,14 @@ export interface components { debit_reversal?: string | null; /** @description Set if the ReceivedDebit is associated with an InboundTransfer's return of funds. */ inbound_transfer?: string | null; - /** @description Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object. */ + /** @description Set if the ReceivedDebit was created due to an [Issuing Authorization](https://api.stripe.com#issuing_authorizations) object. */ issuing_authorization?: string | null; - /** @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. */ + /** @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://api.stripe.com#issuing_disputes) object. */ issuing_transaction?: string | null; - /** @description Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. */ + /** @description Set if the ReceivedDebit was created due to a [Payout](https://api.stripe.com#payouts) object. */ payout?: string | null; + /** @description Set if the ReceivedDebit was created due to a [Topup](https://api.stripe.com#topups) object. */ + topup?: string | null; }; /** TreasuryReceivedDebitsResourceReversalDetails */ treasury_received_debits_resource_reversal_details: { @@ -27576,7 +31247,7 @@ export interface components { balance?: "payments"; billing_details: components["schemas"]["treasury_shared_resource_billing_details"]; financial_account?: components["schemas"]["received_payment_method_details_financial_account"]; - /** @description Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID. */ + /** @description Set when `type` is `issuing_card`. This is an [Issuing Card](https://api.stripe.com#issuing_cards) ID. */ issuing_card?: string; /** * @description Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount. @@ -27642,57 +31313,6 @@ export interface components { /** @description All supported networks. */ supported: ("ach" | "us_domestic_wire")[]; }; - /** - * UsageRecord - * @description Usage records allow you to report customer usage and metrics to Stripe for - * metered billing of subscription prices. - * - * Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) - * - * This is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based). - */ - usage_record: { - /** @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: "usage_record"; - /** @description The usage quantity for the specified date. */ - quantity: number; - /** @description The ID of the subscription item this usage record contains data for. */ - subscription_item: string; - /** - * Format: unix-time - * @description The timestamp when this usage occurred. - */ - timestamp: number; - }; - /** - * 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; - /** @description The invoice in which this usage period has been billed for. */ - invoice?: string | null; - /** @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: "usage_record_summary"; - period: components["schemas"]["period"]; - /** @description The ID of the subscription item this summary is describing. */ - subscription_item: string; - /** @description The total usage within this usage period. */ - total_usage: number; - }; /** verification_session_redaction */ verification_session_redaction: { /** @@ -27729,7 +31349,7 @@ 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. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -27824,7 +31444,9 @@ export interface operations { /** @description The URL that the user will be redirected to upon leaving or completing the linked flow. */ return_url?: string; /** - * @description The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`. + * @description The type of account link the user is requesting. + * + * You can create Account Links of type `account_update` only for connected accounts where your platform is responsible for collecting requirements, including Custom accounts. You can't create them for accounts that have access to a Stripe-hosted Dashboard. If you use [Connect embedded components](/connect/get-started-connect-embedded-components), you can include components that allow your connected accounts to update their own information. For an account without Stripe-hosted Dashboard access where Stripe is liable for negative balances, you must use embedded components. * @enum {string} */ type: "account_onboarding" | "account_update"; @@ -27899,6 +31521,17 @@ export interface operations { standard_payouts?: boolean; }; }; + /** disputes_list_config_param */ + disputes_list?: { + enabled: boolean; + /** disputes_list_features_param */ + features?: { + capture_payments?: boolean; + destination_on_behalf_of_charge_management?: boolean; + dispute_management?: boolean; + refund_management?: boolean; + }; + }; /** base_config_param */ documents?: { enabled: boolean; @@ -27924,6 +31557,16 @@ export interface operations { card_spend_dispute_management?: boolean; }; }; + /** instant_payouts_promotion_config_param */ + instant_payouts_promotion?: { + enabled: boolean; + /** instant_payouts_promotion_features_param */ + features?: { + disable_stripe_user_authentication?: boolean; + external_account_collection?: boolean; + instant_payouts?: boolean; + }; + }; /** issuing_card_config_param */ issuing_card?: { enabled: boolean; @@ -27967,6 +31610,16 @@ export interface operations { refund_management?: boolean; }; }; + /** payment_disputes_config_param */ + payment_disputes?: { + enabled: boolean; + /** payment_disputes_features_param */ + features?: { + destination_on_behalf_of_charge_management?: boolean; + dispute_management?: boolean; + refund_management?: boolean; + }; + }; /** payments_config_param */ payments?: { enabled: boolean; @@ -27978,6 +31631,12 @@ export interface operations { refund_management?: boolean; }; }; + /** base_config_param */ + payout_details?: { + enabled: boolean; + /** base_features_param */ + features?: Record; + }; /** payouts_config_param */ payouts?: { enabled: boolean; @@ -28105,7 +31764,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ + /** @description An [account token](https://api.stripe.com#create_account_token), used to securely provide details to the account. */ account_token?: string; /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ bank_account?: { @@ -28143,6 +31802,7 @@ export interface operations { }; estimated_worker_count?: number; mcc?: string; + minority_owned_business_designation?: ("lgbtqi_owned_business" | "minority_owned_business" | "none_of_these_apply" | "prefer_not_to_answer" | "women_owned_business")[]; /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; @@ -28219,6 +31879,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + billie_payments?: { + requested?: boolean; + }; + /** capability_param */ blik_payments?: { requested?: boolean; }; @@ -28243,6 +31907,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + crypto_payments?: { + requested?: boolean; + }; + /** capability_param */ eps_payments?: { requested?: boolean; }; @@ -28303,6 +31971,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + mb_way_payments?: { + requested?: boolean; + }; + /** capability_param */ mobilepay_payments?: { requested?: boolean; }; @@ -28319,6 +31991,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + nz_bank_account_becs_debit_payments?: { + requested?: boolean; + }; + /** capability_param */ oxxo_payments?: { requested?: boolean; }; @@ -28339,6 +32015,14 @@ export interface operations { requested?: boolean; }; /** capability_param */ + payto_payments?: { + requested?: boolean; + }; + /** capability_param */ + pix_payments?: { + requested?: boolean; + }; + /** capability_param */ promptpay_payments?: { requested?: boolean; }; @@ -28351,6 +32035,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + satispay_payments?: { + requested?: boolean; + }; + /** capability_param */ sepa_bank_transfer_payments?: { requested?: boolean; }; @@ -28458,7 +32146,19 @@ export interface operations { /** @enum {string} */ ownership_exemption_reason?: "" | "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; phone?: string; + registration_date?: { + day: number; + month: number; + year: number; + } | ""; registration_number?: string; + /** company_representative_declaration */ + representative_declaration?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string; + }; /** @enum {string} */ structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; @@ -28533,12 +32233,24 @@ export interface operations { files?: string[]; }; /** documents_param */ + proof_of_address?: { + files?: string[]; + }; + /** signer_param */ proof_of_registration?: { files?: string[]; + /** signer_name_param */ + signer?: { + person?: string; + }; }; - /** documents_param */ + /** signer_param */ proof_of_ultimate_beneficial_ownership?: { files?: string[]; + /** signer_name_param */ + signer?: { + person?: string; + }; }; }; /** @description The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ @@ -28643,7 +32355,7 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -28684,6 +32396,11 @@ export interface operations { statement_descriptor_prefix_kana?: string | ""; statement_descriptor_prefix_kanji?: string | ""; }; + /** invoices_settings_specs_create */ + invoices?: { + /** @enum {string} */ + hosted_payment_method_save?: "always" | "never" | "offer"; + }; /** payments_settings_specs */ payments?: { statement_descriptor?: string; @@ -28699,8 +32416,10 @@ export interface operations { /** @enum {string} */ interval?: "daily" | "manual" | "monthly" | "weekly"; monthly_anchor?: number; + monthly_payout_days?: number[]; /** @enum {string} */ weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; + weekly_payout_days?: ("friday" | "monday" | "thursday" | "tuesday" | "wednesday")[]; }; statement_descriptor?: string; }; @@ -28805,7 +32524,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account. */ + /** @description An [account token](https://api.stripe.com#create_account_token), used to securely provide details to the account. */ account_token?: string; /** * business_profile_update_specs @@ -28821,6 +32540,7 @@ export interface operations { }; estimated_worker_count?: number; mcc?: string; + minority_owned_business_designation?: ("lgbtqi_owned_business" | "minority_owned_business" | "none_of_these_apply" | "prefer_not_to_answer" | "women_owned_business")[]; /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { amount: number; @@ -28897,6 +32617,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + billie_payments?: { + requested?: boolean; + }; + /** capability_param */ blik_payments?: { requested?: boolean; }; @@ -28921,6 +32645,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + crypto_payments?: { + requested?: boolean; + }; + /** capability_param */ eps_payments?: { requested?: boolean; }; @@ -28981,6 +32709,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + mb_way_payments?: { + requested?: boolean; + }; + /** capability_param */ mobilepay_payments?: { requested?: boolean; }; @@ -28997,6 +32729,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + nz_bank_account_becs_debit_payments?: { + requested?: boolean; + }; + /** capability_param */ oxxo_payments?: { requested?: boolean; }; @@ -29017,6 +32753,14 @@ export interface operations { requested?: boolean; }; /** capability_param */ + payto_payments?: { + requested?: boolean; + }; + /** capability_param */ + pix_payments?: { + requested?: boolean; + }; + /** capability_param */ promptpay_payments?: { requested?: boolean; }; @@ -29029,6 +32773,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + satispay_payments?: { + requested?: boolean; + }; + /** capability_param */ sepa_bank_transfer_payments?: { requested?: boolean; }; @@ -29136,7 +32884,19 @@ export interface operations { /** @enum {string} */ ownership_exemption_reason?: "" | "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; phone?: string; + registration_date?: { + day: number; + month: number; + year: number; + } | ""; registration_number?: string; + /** company_representative_declaration */ + representative_declaration?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string; + }; /** @enum {string} */ structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; @@ -29186,12 +32946,24 @@ export interface operations { files?: string[]; }; /** documents_param */ + proof_of_address?: { + files?: string[]; + }; + /** signer_param */ proof_of_registration?: { files?: string[]; + /** signer_name_param */ + signer?: { + person?: string; + }; }; - /** documents_param */ + /** signer_param */ proof_of_ultimate_beneficial_ownership?: { files?: string[]; + /** signer_name_param */ + signer?: { + person?: string; + }; }; }; /** @description The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ @@ -29296,7 +33068,7 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -29340,6 +33112,8 @@ export interface operations { /** invoices_settings_specs */ invoices?: { default_account_tax_ids?: string[] | ""; + /** @enum {string} */ + hosted_payment_method_save?: "always" | "never" | "offer"; }; /** payments_settings_specs */ payments?: { @@ -29356,8 +33130,10 @@ export interface operations { /** @enum {string} */ interval?: "daily" | "manual" | "monthly" | "weekly"; monthly_anchor?: number; + monthly_payout_days?: number[]; /** @enum {string} */ weekly_anchor?: "friday" | "monday" | "saturday" | "sunday" | "thursday" | "tuesday" | "wednesday"; + weekly_payout_days?: ("friday" | "monday" | "thursday" | "tuesday" | "wednesday")[]; }; statement_descriptor?: string; }; @@ -29480,9 +33256,9 @@ export interface operations { default_for_currency?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** @description A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. */ external_account?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -29519,6 +33295,7 @@ export interface operations { header?: never; path: { account: string; + /** @description Unique identifier for the external account to be retrieved. */ id: string; }; cookie?: never; @@ -29604,7 +33381,7 @@ export interface operations { exp_year?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -29640,6 +33417,7 @@ export interface operations { header?: never; path: { account: string; + /** @description Unique identifier for the external account to be deleted. */ id: string; }; cookie?: never; @@ -29899,9 +33677,9 @@ export interface operations { default_for_currency?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** @description A token, like the ones returned by [Stripe.js](https://docs.stripe.com/js) or a dictionary containing a user's external account details (with the options shown below). Please refer to full [documentation](https://stripe.com/docs/api/external_accounts) instead. */ external_account?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -29938,6 +33716,7 @@ export interface operations { header?: never; path: { account: string; + /** @description Unique identifier for the external account to be retrieved. */ id: string; }; cookie?: never; @@ -30023,7 +33802,7 @@ export interface operations { exp_year?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -30059,6 +33838,7 @@ export interface operations { header?: never; path: { account: string; + /** @description Unique identifier for the external account to be deleted. */ id: string; }; cookie?: never; @@ -30304,7 +34084,7 @@ export interface operations { last_name_kanji?: string; /** @description The person's maiden name. */ maiden_name?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -30314,8 +34094,11 @@ export interface operations { person_token?: string; /** @description The person's phone number. */ phone?: string; - /** @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. */ - political_exposure?: string; + /** + * @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. + * @enum {string} + */ + political_exposure?: "existing" | "none"; /** * address_specs * @description The person's registered address. @@ -30344,6 +34127,23 @@ export interface operations { }; /** @description The last four digits of the person's Social Security number (U.S. only). */ ssn_last_4?: string; + /** + * us_cfpb_data_specs + * @description Demographic data related to the person. + */ + us_cfpb_data?: { + /** us_cfpb_ethnicity_details_specs */ + ethnicity_details?: { + ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[]; + ethnicity_other?: string; + }; + /** us_cfpb_race_details_specs */ + race_details?: { + race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[]; + race_other?: string; + }; + self_identified_gender?: string; + }; /** * person_verification_specs * @description The person's verification status. @@ -30537,7 +34337,7 @@ export interface operations { last_name_kanji?: string; /** @description The person's maiden name. */ maiden_name?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -30547,8 +34347,11 @@ export interface operations { person_token?: string; /** @description The person's phone number. */ phone?: string; - /** @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. */ - political_exposure?: string; + /** + * @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. + * @enum {string} + */ + political_exposure?: "existing" | "none"; /** * address_specs * @description The person's registered address. @@ -30577,6 +34380,23 @@ export interface operations { }; /** @description The last four digits of the person's Social Security number (U.S. only). */ ssn_last_4?: string; + /** + * us_cfpb_data_specs + * @description Demographic data related to the person. + */ + us_cfpb_data?: { + /** us_cfpb_ethnicity_details_specs */ + ethnicity_details?: { + ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[]; + ethnicity_other?: string; + }; + /** us_cfpb_race_details_specs */ + race_details?: { + race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[]; + race_other?: string; + }; + self_identified_gender?: string; + }; /** * person_verification_specs * @description The person's verification status. @@ -30830,7 +34650,7 @@ export interface operations { last_name_kanji?: string; /** @description The person's maiden name. */ maiden_name?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -30840,8 +34660,11 @@ export interface operations { person_token?: string; /** @description The person's phone number. */ phone?: string; - /** @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. */ - political_exposure?: string; + /** + * @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. + * @enum {string} + */ + political_exposure?: "existing" | "none"; /** * address_specs * @description The person's registered address. @@ -30870,6 +34693,23 @@ export interface operations { }; /** @description The last four digits of the person's Social Security number (U.S. only). */ ssn_last_4?: string; + /** + * us_cfpb_data_specs + * @description Demographic data related to the person. + */ + us_cfpb_data?: { + /** us_cfpb_ethnicity_details_specs */ + ethnicity_details?: { + ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[]; + ethnicity_other?: string; + }; + /** us_cfpb_race_details_specs */ + race_details?: { + race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[]; + race_other?: string; + }; + self_identified_gender?: string; + }; /** * person_verification_specs * @description The person's verification status. @@ -31063,7 +34903,7 @@ export interface operations { last_name_kanji?: string; /** @description The person's maiden name. */ maiden_name?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -31073,8 +34913,11 @@ export interface operations { person_token?: string; /** @description The person's phone number. */ phone?: string; - /** @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. */ - political_exposure?: string; + /** + * @description Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. + * @enum {string} + */ + political_exposure?: "existing" | "none"; /** * address_specs * @description The person's registered address. @@ -31103,6 +34946,23 @@ export interface operations { }; /** @description The last four digits of the person's Social Security number (U.S. only). */ ssn_last_4?: string; + /** + * us_cfpb_data_specs + * @description Demographic data related to the person. + */ + us_cfpb_data?: { + /** us_cfpb_ethnicity_details_specs */ + ethnicity_details?: { + ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[]; + ethnicity_other?: string; + }; + /** us_cfpb_race_details_specs */ + race_details?: { + race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[]; + race_other?: string; + }; + self_identified_gender?: string; + }; /** * person_verification_specs * @description The person's verification status. @@ -31499,7 +35359,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -31677,7 +35537,7 @@ export interface operations { amount?: number; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -31965,11 +35825,11 @@ export interface operations { limit?: number; /** @description For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ payout?: string; - /** @description Only returns the original transaction. */ + /** @description Only returns transactions associated with the given object. */ source?: 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 returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -32051,6 +35911,103 @@ export interface operations { }; }; }; + GetBalanceSettings: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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": components["schemas"]["balance_settings"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBalanceSettings: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * payments + * @description Settings that apply to the [Payments Balance](https://docs.stripe.com/api/balance). + */ + payments?: { + debit_negative_balances?: boolean; + /** payouts */ + payouts?: { + minimum_balance_by_currency?: { + [key: string]: number | ""; + } | ""; + /** payout_schedule */ + schedule?: { + /** @enum {string} */ + interval?: "daily" | "manual" | "monthly" | "weekly"; + monthly_payout_days?: number[]; + weekly_payout_days?: ("friday" | "monday" | "thursday" | "tuesday" | "wednesday")[]; + }; + statement_descriptor?: string; + }; + /** settlement_timing */ + settlement_timing?: { + delay_days_override?: number | ""; + }; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["balance_settings"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetBalanceTransactions: { parameters: { query?: { @@ -32071,11 +36028,11 @@ export interface operations { limit?: number; /** @description For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID. */ payout?: string; - /** @description Only returns the original transaction. */ + /** @description Only returns transactions associated with the given object. */ source?: 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 returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ + /** @description Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. */ type?: string; }; header?: never; @@ -32244,7 +36201,7 @@ export interface operations { type: "customer"; }[]; gte: number; - meter?: string; + meter: string; /** @enum {string} */ recurrence: "one_time"; }; @@ -32427,8 +36384,10 @@ export interface operations { GetBillingCreditBalanceSummary: { parameters: { query: { - /** @description The customer for which to fetch credit balance summary. */ - customer: string; + /** @description The customer whose credit balance summary you're retrieving. */ + customer?: string; + /** @description The account representing the customer whose credit balance summary you're retrieving. */ + customer_account?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description The filter criteria for the credit balance summary. */ @@ -32436,7 +36395,10 @@ export interface operations { /** scope_param */ applicability_scope?: { /** @enum {string} */ - price_type: "metered"; + price_type?: "metered"; + prices?: { + id: string; + }[]; }; credit_grant?: string; /** @enum {string} */ @@ -32475,11 +36437,13 @@ export interface operations { }; GetBillingCreditBalanceTransactions: { parameters: { - query: { + 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 The customer whose credit balance transactions you're retrieving. */ + customer?: string; + /** @description The account representing the customer whose credit balance transactions you're retrieving. */ + customer_account?: 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. */ @@ -32574,6 +36538,8 @@ export interface operations { query?: { /** @description Only return credit grants for this customer. */ customer?: string; + /** @description Only return credit grants for this account representing the customer. */ + customer_account?: 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. */ @@ -32650,22 +36616,27 @@ export interface operations { }; /** * applicability_config_param - * @description Configuration specifying what this credit grant applies to. + * @description Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. */ applicability_config: { /** scope_param */ scope: { /** @enum {string} */ - price_type: "metered"; + price_type?: "metered"; + prices?: { + id: string; + }[]; }; }; /** - * @description The category of this credit grant. + * @description The category of this credit grant. It defaults to `paid` if not specified. * @enum {string} */ - category: "paid" | "promotional"; - /** @description ID of the customer to receive the billing credits. */ - customer: string; + category?: "paid" | "promotional"; + /** @description ID of the customer receiving the billing credits. */ + customer?: string; + /** @description ID of the account representing the customer receiving the billing credits. */ + customer_account?: string; /** * Format: unix-time * @description The time when the billing credits become effective-when they're eligible for use. It defaults to the current timestamp if not specified. @@ -32684,6 +36655,8 @@ export interface operations { }; /** @description A descriptive name shown in the Dashboard. */ name?: string; + /** @description The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100. */ + priority?: number; }; }; }; @@ -32936,7 +36909,7 @@ export interface operations { expand?: string[]; /** @description A unique identifier for the event. If not provided, one is generated. We recommend using UUID-like identifiers. We will enforce uniqueness within a rolling period of at least 24 hours. The enforcement of uniqueness primarily addresses issues arising from accidental retries or other problems occurring within extremely brief time intervals. This approach helps prevent duplicate entries and ensures data integrity in high-frequency operations. */ 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). */ + /** @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/meters/configure#meter-configuration-attributes). */ payload: { [key: string]: string; }; @@ -33049,14 +37022,14 @@ export interface operations { */ default_aggregation: { /** @enum {string} */ - formula: "count" | "sum"; + formula: "count" | "last" | "sum"; }; /** @description The meter’s name. Not visible to the customer. */ display_name: string; /** @description The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events. */ event_name: string; /** - * @description The time window to pre-aggregate meter events for, if any. + * @description The time window which meter events have been pre-aggregated for, if any. * @enum {string} */ event_time_window?: "day" | "hour"; @@ -33101,7 +37074,6 @@ export interface operations { }; header?: never; path: { - /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -33137,7 +37109,6 @@ export interface operations { query?: never; header?: never; path: { - /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -33178,7 +37149,6 @@ export interface operations { query?: never; header?: never; path: { - /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -33281,7 +37251,6 @@ export interface operations { query?: never; header?: never; path: { - /** @description Unique identifier for the object. */ id: string; }; cookie?: never; @@ -33391,7 +37360,7 @@ export interface operations { privacy_policy_url?: string; terms_of_service_url?: string; }; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ default_return_url?: string | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -33412,6 +37381,7 @@ export interface operations { /** payment_method_update_param */ payment_method_update?: { enabled: boolean; + payment_method_configuration?: string | ""; }; /** subscription_cancel_creation_param */ subscription_cancel?: { @@ -33428,9 +37398,17 @@ export interface operations { }; /** subscription_update_creation_param */ subscription_update?: { + /** @enum {string} */ + billing_cycle_anchor?: "now" | "unchanged"; default_allowed_updates?: ("price" | "promotion_code" | "quantity")[] | ""; enabled: boolean; products?: { + /** subscription_update_product_adjustable_quantity_param */ + adjustable_quantity?: { + enabled: boolean; + maximum?: number; + minimum?: number; + }; prices: string[]; product: string; }[] | ""; @@ -33443,6 +37421,8 @@ export interface operations { type: "decreasing_item_amount" | "shortening_interval"; }[]; }; + /** @enum {string} */ + trial_update_behavior?: "continue_trial" | "end_trial"; }; }; /** @@ -33452,10 +37432,12 @@ export interface operations { login_page?: { enabled: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 name of the configuration. */ + name?: string | ""; }; }; }; @@ -33541,7 +37523,7 @@ export interface operations { privacy_policy_url?: string | ""; terms_of_service_url?: string | ""; }; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ default_return_url?: string | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -33562,6 +37544,7 @@ export interface operations { /** payment_method_update_param */ payment_method_update?: { enabled: boolean; + payment_method_configuration?: string | ""; }; /** subscription_cancel_updating_param */ subscription_cancel?: { @@ -33578,9 +37561,17 @@ export interface operations { }; /** subscription_update_updating_param */ subscription_update?: { + /** @enum {string} */ + billing_cycle_anchor?: "now" | "unchanged"; default_allowed_updates?: ("price" | "promotion_code" | "quantity")[] | ""; enabled?: boolean; products?: { + /** subscription_update_product_adjustable_quantity_param */ + adjustable_quantity?: { + enabled: boolean; + maximum?: number; + minimum?: number; + }; prices: string[]; product: string; }[] | ""; @@ -33593,6 +37584,8 @@ export interface operations { type: "decreasing_item_amount" | "shortening_interval"; }[] | ""; }; + /** @enum {string} */ + trial_update_behavior?: "continue_trial" | "end_trial"; }; }; /** @@ -33602,10 +37595,12 @@ export interface operations { login_page?: { enabled: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 name of the configuration. */ + name?: string | ""; }; }; }; @@ -33637,18 +37632,20 @@ export interface operations { path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ + /** @description The ID of an existing [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ configuration?: string; /** @description The ID of an existing customer. */ - customer: string; + customer?: string; + /** @description The ID of an existing account. */ + customer_account?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** * flow_data_param - * @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. + * @description Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. */ flow_data?: { /** flow_data_after_completion_param */ @@ -33702,7 +37699,7 @@ export interface operations { * @enum {string} */ locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-IE" | "en-IN" | "en-NZ" | "en-SG" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW"; - /** @description The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + /** @description The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ on_behalf_of?: string; /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ return_url?: string; @@ -33806,12 +37803,12 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ amount?: number; application_fee?: number; - /** @description A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees). */ + /** @description A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/connect/direct-charges#collect-fees). */ application_fee_amount?: number; - /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ + /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://api.stripe.com#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://docs.stripe.com/charges/placing-a-hold) documentation. */ capture?: boolean; /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: { @@ -33847,20 +37844,20 @@ export interface operations { } | string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). */ + /** @description The Stripe account ID for which these funds are intended. You can specify the business of record as the connected account using the `on_behalf_of` attribute on the charge. For details, see [Creating Separate Charges and Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). */ on_behalf_of?: string; /** * radar_options_with_hidden_options - * @description Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + * @description Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. */ radar_options?: { session?: string; }; - /** @description The email address to which this charge's [receipt](https://stripe.com/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://stripe.com/docs/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ + /** @description The email address to which this charge's [receipt](https://docs.stripe.com/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a [Customer](https://docs.stripe.com/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ receipt_email?: string; /** * optional_fields_shipping @@ -33881,7 +37878,7 @@ export interface operations { phone?: string; tracking_number?: string; }; - /** @description A payment source to be charged. This can be the ID of a [card](https://stripe.com/docs/api#cards) (i.e., credit or debit card), a [bank account](https://stripe.com/docs/api#bank_accounts), a [source](https://stripe.com/docs/api#sources), a [token](https://stripe.com/docs/api#tokens), or a [connected account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://stripe.com/docs/api#cards), [bank accounts](https://stripe.com/docs/api#bank_accounts), and attached [sources](https://stripe.com/docs/api#sources)---you must also pass the ID of the associated customer. */ + /** @description A payment source to be charged. This can be the ID of a [card](https://docs.stripe.com/api#cards) (i.e., credit or debit card), a [bank account](https://docs.stripe.com/api#bank_accounts), a [source](https://docs.stripe.com/api#sources), a [token](https://docs.stripe.com/api#tokens), or a [connected account](https://docs.stripe.com/connect/account-debits#charging-a-connected-account). For certain sources---namely, [cards](https://docs.stripe.com/api#cards), [bank accounts](https://docs.stripe.com/api#bank_accounts), and attached [sources](https://docs.stripe.com/api#sources)---you must also pass the ID of the associated customer. */ source?: string; /** * @description For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). @@ -33893,13 +37890,13 @@ export interface operations { statement_descriptor_suffix?: string; /** * transfer_data_specs - * @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. + * @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ transfer_data?: { amount?: number; destination: string; }; - /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options). */ + /** @description A string that identifies this transaction as part of a group. For details, see [Grouping transactions](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options). */ transfer_group?: string; }; }; @@ -33934,7 +37931,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for charges](https://stripe.com/docs/search#query-fields-for-charges). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for charges](https://docs.stripe.com/search#query-fields-for-charges). */ query: string; }; header?: never; @@ -34043,7 +38040,7 @@ export interface operations { /** @enum {string} */ user_report: "" | "fraudulent" | "safe"; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -34068,7 +38065,7 @@ export interface operations { phone?: string; tracking_number?: string; }; - /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. */ transfer_group?: string; }; }; @@ -34106,7 +38103,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. */ + /** @description The amount to capture, which must be less than or equal to the original amount. */ amount?: number; /** @description An application fee to add on to this charge. */ application_fee?: number; @@ -34126,12 +38123,12 @@ export interface operations { statement_descriptor_suffix?: string; /** * transfer_data_specs - * @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details. + * @description An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. */ transfer_data?: { amount?: number; }; - /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** @description A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. */ transfer_group?: string; }; }; @@ -34289,7 +38286,7 @@ export interface operations { }; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -34370,20 +38367,20 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. */ + /** @description A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. */ amount?: number; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 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. + * @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://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. * @enum {string} */ reason?: "duplicate" | "fraudulent" | "requested_by_customer"; @@ -34496,7 +38493,7 @@ export interface operations { 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -34508,7 +38505,7 @@ export interface operations { /** @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. + * @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://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. * @enum {string} */ reason?: "duplicate" | "fraudulent" | "requested_by_customer"; @@ -34633,6 +38630,8 @@ export interface operations { } | number; /** @description Only return the Checkout Sessions for the Customer specified. */ customer?: string; + /** @description Only return the Checkout Sessions for the Account specified. */ + customer_account?: string; /** @description Only return the Checkout Sessions for the Customer details specified. */ customer_details?: { email: string; @@ -34714,7 +38713,7 @@ export interface operations { }; /** * after_expiration_params - * @description Configure actions after a Checkout Session has expired. + * @description Configure actions after a Checkout Session has expired. You can't set this parameter if `ui_mode` is `custom`. */ after_expiration?: { /** recovery_params */ @@ -34743,7 +38742,34 @@ export interface operations { * @enum {string} */ billing_address_collection?: "auto" | "required"; - /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded`. */ + /** + * branding_settings_params + * @description The branding settings for the Checkout Session. This parameter is not allowed if ui_mode is `custom`. + */ + branding_settings?: { + background_color?: string | ""; + /** @enum {string} */ + border_style?: "" | "pill" | "rectangular" | "rounded"; + button_color?: string | ""; + display_name?: string; + /** @enum {string} */ + font_family?: "" | "be_vietnam_pro" | "bitter" | "chakra_petch" | "default" | "hahmlet" | "inconsolata" | "inter" | "lato" | "lora" | "m_plus_1_code" | "montserrat" | "noto_sans" | "noto_sans_jp" | "noto_serif" | "nunito" | "open_sans" | "pridi" | "pt_sans" | "pt_serif" | "raleway" | "roboto" | "roboto_slab" | "source_sans_pro" | "titillium_web" | "ubuntu_mono" | "zen_maru_gothic"; + /** icon_params */ + icon?: { + file?: string; + /** @enum {string} */ + type: "file" | "url"; + url?: string; + }; + /** logo_params */ + logo?: { + file?: string; + /** @enum {string} */ + type: "file" | "url"; + url?: string; + }; + }; + /** @description If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if ui_mode is `embedded` or `custom`. */ cancel_url?: string; /** * @description A unique string to reference the Checkout Session. This can be a @@ -34771,7 +38797,7 @@ export interface operations { * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Required in `setup` mode when `payment_method_types` is not set. */ currency?: string; - /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. */ custom_fields?: { /** custom_field_dropdown_param */ dropdown?: { @@ -34806,7 +38832,7 @@ export interface operations { }[]; /** * custom_text_param - * @description Display additional text for your customers using custom text. + * @description Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`. */ custom_text?: { after_submit?: { @@ -34825,24 +38851,26 @@ export interface operations { /** * @description ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved card * payment method will be used to prefill the email, name, card details, and billing address - * on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + * on the Checkout page. In `subscription` mode, the customer’s [default payment method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) * will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details. * - * If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. + * If the Customer already has a valid [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. * If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer. * * If blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow. * - * You can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. + * You can set [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. */ customer?: string; + /** @description ID of an existing Account, if one exists. Has the same behavior as `customer`. */ + customer_account?: string; /** - * @description Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation. + * @description Configure whether a Checkout Session creates a [Customer](https://docs.stripe.com/api/customers) during Session confirmation. * * When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout - * with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details). + * with [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details). * - * Sessions that don't create Customers instead are grouped by [guest customers](https://stripe.com/docs/payments/checkout/guest-customers) + * Sessions that don't create Customers instead are grouped by [guest customers](https://docs.stripe.com/payments/checkout/guest-customers) * in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions. * * Can only be set in `payment` and `setup` mode. @@ -34874,6 +38902,8 @@ export interface operations { coupon?: string; promotion_code?: string; }[]; + /** @description A list of the types of payment methods (e.g., `card`) that should be excluded from this Checkout Session. This should only be used when payment methods for this Checkout Session are managed through the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -34908,11 +38938,12 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; }; /** - * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://stripe.com/docs/api/prices). + * @description A list of items the customer is purchasing. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). The parameter is required for `payment` and `subscription` mode. * * For `payment` mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen. * @@ -34926,6 +38957,9 @@ export interface operations { minimum?: number; }; dynamic_tax_rates?: string[]; + metadata?: { + [key: string]: string; + }; price?: string; /** price_data_with_product_data */ price_data?: { @@ -34941,6 +38975,7 @@ export interface operations { }; name: string; tax_code?: string; + unit_label?: string; }; /** recurring_adhoc */ recurring?: { @@ -34962,7 +38997,7 @@ export interface operations { * @enum {string} */ locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-GB" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW"; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -34971,6 +39006,54 @@ export interface operations { * @enum {string} */ mode?: "payment" | "setup" | "subscription"; + /** + * name_collection_params + * @description Controls name collection settings for the session. + * + * You can configure Checkout to collect your customers' business names, individual names, or both. Each name field can be either required or optional. + * + * If a [Customer](https://docs.stripe.com/api/customers) is created or provided, the names can be saved to the Customer object as well. + * + * You can't set this parameter if `ui_mode` is `custom`. + */ + name_collection?: { + /** name_collection_business_params */ + business?: { + enabled: boolean; + optional?: boolean; + }; + /** name_collection_individual_params */ + individual?: { + enabled: boolean; + optional?: boolean; + }; + }; + /** + * @description A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). + * + * There is a maximum of 10 optional items allowed on a Checkout Session, and the existing limits on the number of line items allowed on a Checkout Session apply to the combined number of line items and optional items. + * + * For `payment` mode, there is a maximum of 100 combined line items and optional items, however it is recommended to consolidate items if there are more than a few dozen. + * + * For `subscription` mode, there is a maximum of 20 line items and optional items with recurring Prices and 20 line items and optional items with one-time Prices. + * + * You can't set this parameter if `ui_mode` is `custom`. + */ + optional_items?: { + /** optional_item_adjustable_quantity_params */ + adjustable_quantity?: { + enabled: boolean; + maximum?: number; + minimum?: number; + }; + price: string; + quantity: number; + }[]; + /** + * @description Where the user is coming from. This informs the optimizations that are applied to the session. You can't set this parameter if `ui_mode` is `custom`. + * @enum {string} + */ + origin_context?: "mobile_app" | "web"; /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. @@ -35018,7 +39101,7 @@ export interface operations { * * Can only be set in `subscription` mode. Defaults to `always`. * - * If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). + * If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials). * @enum {string} */ payment_method_collection?: "always" | "if_required"; @@ -35053,16 +39136,21 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + target_date?: string; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; /** payment_method_options_param */ affirm?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none"; }; /** payment_method_options_param */ afterpay_clearpay?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none"; }; @@ -35072,7 +39160,14 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + alma?: { + /** @enum {string} */ + capture_method?: "manual"; + }; + /** payment_method_options_param */ amazon_pay?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none" | "off_session"; }; @@ -35080,6 +39175,7 @@ export interface operations { au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "none"; + target_date?: string; }; /** payment_method_options_param */ bacs_debit?: { @@ -35089,6 +39185,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + target_date?: string; }; /** payment_method_options_param */ bancontact?: { @@ -35096,6 +39193,11 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + billie?: { + /** @enum {string} */ + capture_method?: "manual"; + }; + /** payment_method_options_param */ boleto?: { expires_after_days?: number; /** @enum {string} */ @@ -35103,6 +39205,8 @@ export interface operations { }; /** payment_method_options_param */ card?: { + /** @enum {string} */ + capture_method?: "manual"; /** installments_param */ installments?: { enabled?: boolean; @@ -35117,6 +39221,10 @@ export interface operations { request_overcapture?: "if_available" | "never"; /** @enum {string} */ request_three_d_secure?: "any" | "automatic" | "challenge"; + /** restrictions_param */ + restrictions?: { + brands_blocked?: ("american_express" | "discover_global_network" | "mastercard" | "visa")[]; + }; /** @enum {string} */ setup_future_usage?: "off_session" | "on_session"; statement_descriptor_suffix_kana?: string; @@ -35124,6 +39232,8 @@ export interface operations { }; /** payment_method_options_param */ cashapp?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; }; @@ -35145,6 +39255,11 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + demo_pay?: { + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ eps?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -35178,8 +39293,22 @@ export interface operations { }; /** payment_method_options_param */ klarna?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; }; /** payment_method_options_param */ konbini?: { @@ -35196,11 +39325,15 @@ export interface operations { }; /** payment_method_options_param */ link?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none" | "off_session"; }; /** payment_method_options_param */ mobilepay?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none"; }; @@ -35252,11 +39385,35 @@ export interface operations { setup_future_usage?: "" | "none" | "off_session"; }; /** payment_method_options_param */ + payto?: { + /** setup_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + start_date?: string | ""; + }; + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ pix?: { + /** @enum {string} */ + amount_includes_iof?: "always" | "never"; expires_after_seconds?: number; + /** @enum {string} */ + setup_future_usage?: "none"; }; /** payment_method_options_param */ revolut_pay?: { + /** @enum {string} */ + capture_method?: "manual"; /** @enum {string} */ setup_future_usage?: "none" | "off_session"; }; @@ -35266,6 +39423,11 @@ export interface operations { capture_method?: "manual"; }; /** payment_method_options_param */ + satispay?: { + /** @enum {string} */ + capture_method?: "manual"; + }; + /** payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -35273,6 +39435,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + target_date?: string; }; /** payment_method_options_param */ sofort?: { @@ -35284,6 +39447,11 @@ export interface operations { reference?: string; }; /** payment_method_options_param */ + twint?: { + /** @enum {string} */ + setup_future_usage?: "none"; + }; + /** payment_method_options_param */ us_bank_account?: { /** linked_account_options_param */ financial_connections?: { @@ -35292,6 +39460,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; + target_date?: string; /** @enum {string} */ verification_method?: "automatic" | "instant"; }; @@ -35308,7 +39477,7 @@ export interface operations { * @description A list of the types of payment methods (e.g., `card`) this Checkout Session can accept. * * You can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). - * See [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. + * See [Dynamic Payment Methods](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. * * Read more about the supported payment methods and their requirements in our [payment * method details guide](/docs/payments/checkout/payment-methods). @@ -35317,25 +39486,35 @@ export interface operations { * prioritize the most relevant payment methods based on the customer's location and * other characteristics. */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; + /** + * permissions_param + * @description This property is used to set up permissions for various actions (e.g., update) on the CheckoutSession object. Can only be set when creating `embedded` or `custom` sessions. + * + * For specific permissions, please refer to their dedicated subsections, such as `permissions.update_shipping_details`. + */ + permissions?: { + /** @enum {string} */ + update_shipping_details?: "client_only" | "server_only"; + }; /** * phone_number_collection_params * @description Controls phone number collection settings for the session. * * We recommend that you review your privacy policy and check with your legal contacts - * before using this feature. Learn more about [collecting phone numbers with Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). + * before using this feature. Learn more about [collecting phone numbers with Checkout](https://docs.stripe.com/payments/checkout/phone-numbers). */ phone_number_collection?: { enabled: boolean; }; /** - * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; /** * @description The URL to redirect your customer back to after they authenticate or cancel their payment on the - * payment method's app or site. This parameter is required if ui_mode is `embedded` + * payment method's app or site. This parameter is required if `ui_mode` is `embedded` or `custom` * and redirect-based payment methods are enabled on the session. */ return_url?: string; @@ -35346,6 +39525,8 @@ export interface operations { saved_payment_method_options?: { allow_redisplay_filters?: ("always" | "limited" | "unspecified")[]; /** @enum {string} */ + payment_method_remove?: "disabled" | "enabled"; + /** @enum {string} */ payment_method_save?: "disabled" | "enabled"; }; /** @@ -35411,9 +39592,11 @@ export interface operations { }; }[]; /** - * @description Describes the type of transaction being performed by Checkout in order to customize - * relevant text on the page, such as the submit button. `submit_type` can only be - * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. + * @description Describes the type of transaction being performed by Checkout in order + * to customize relevant text on the page, such as the submit button. + * `submit_type` can only be specified on Checkout Sessions in + * `payment` or `subscription` mode. If blank or `auto`, `pay` is used. + * You can't set this parameter if `ui_mode` is `custom`. * @enum {string} */ submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe"; @@ -35425,6 +39608,16 @@ export interface operations { application_fee_percent?: number; /** Format: unix-time */ billing_cycle_anchor?: number; + /** billing_mode */ + billing_mode?: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "classic" | "flexible"; + }; default_tax_rates?: string[]; description?: string; /** invoice_settings_params */ @@ -35462,9 +39655,9 @@ export interface operations { /** * @description The URL to which Stripe should send customers when payment or setup * is complete. - * This parameter is not allowed if ui_mode is `embedded`. If you’d like to use + * This parameter is not allowed if ui_mode is `embedded` or `custom`. If you'd like to use * information from the successful Checkout Session on your page, read the - * guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page). + * guide on [customizing your success page](https://docs.stripe.com/payments/checkout/custom-success-page). */ success_url?: string; /** @@ -35480,7 +39673,18 @@ export interface operations { * @description The UI mode of the Session. Defaults to `hosted`. * @enum {string} */ - ui_mode?: "embedded" | "hosted"; + ui_mode?: "custom" | "embedded" | "hosted"; + /** + * wallet_options_param + * @description Wallet-specific configuration. + */ + wallet_options?: { + /** wallet_options_param */ + link?: { + /** @enum {string} */ + display?: "auto" | "never"; + }; + }; }; }; }; @@ -35555,12 +39759,133 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * collected_information_params + * @description Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions. + */ + collected_information?: { + /** shipping_details_params */ + shipping_details?: { + /** address */ + address: { + city?: string; + country: string; + line1: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name: string; + }; + }; /** @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`. */ + /** + * @description A list of items the customer is purchasing. + * + * When updating line items, you must retransmit the entire array of line items. + * + * To retain an existing line item, specify its `id`. + * + * To update an existing line item, specify its `id` along with the new values of the fields to update. + * + * To add a new line item, specify one of `price` or `price_data` and `quantity`. + * + * To remove an existing line item, omit the line item's ID from the retransmitted array. + * + * To reorder a line item, specify it at the desired position in the retransmitted array. + */ + line_items?: { + /** adjustable_quantity_params */ + adjustable_quantity?: { + enabled: boolean; + maximum?: number; + minimum?: number; + }; + id?: string; + metadata?: { + [key: string]: string; + } | ""; + price?: string; + /** price_data_with_product_data */ + price_data?: { + /** Format: currency */ + currency: string; + product?: string; + /** product_data */ + product_data?: { + description?: string; + images?: string[]; + metadata?: { + [key: string]: string; + }; + name: string; + tax_code?: string; + unit_label?: string; + }; + /** recurring_adhoc */ + recurring?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 shipping rate options to apply to this Session. Up to a maximum of 5. */ + shipping_options?: { + shipping_rate?: string; + /** method_params */ + shipping_rate_data?: { + /** delivery_estimate */ + delivery_estimate?: { + /** delivery_estimate_bound */ + maximum?: { + /** @enum {string} */ + unit: "business_day" | "day" | "hour" | "month" | "week"; + value: number; + }; + /** delivery_estimate_bound */ + minimum?: { + /** @enum {string} */ + unit: "business_day" | "day" | "hour" | "month" | "week"; + value: number; + }; + }; + display_name: string; + /** fixed_amount */ + fixed_amount?: { + amount: number; + /** Format: currency */ + currency: string; + currency_options?: { + [key: string]: { + amount: number; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + }; + }; + }; + metadata?: { + [key: string]: string; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_code?: string; + /** @enum {string} */ + type?: "fixed_amount"; + }; + }[] | ""; }; }; }; @@ -35755,7 +40080,7 @@ export interface operations { currency?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -35848,7 +40173,7 @@ export interface operations { } | ""; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -36329,7 +40654,7 @@ export interface operations { id?: string; /** @description A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use. */ max_redemptions?: number; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -36339,7 +40664,7 @@ export interface operations { percent_off?: number; /** * Format: unix-time - * @description Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers. + * @description Unix timestamp specifying the last time at which the coupon can be redeemed (cannot be set to more than 5 years in the future). After the redeem_by date, the coupon can no longer be applied to new customers. */ redeem_by?: number; }; @@ -36424,7 +40749,7 @@ export interface operations { }; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -36501,6 +40826,8 @@ export interface operations { } | number; /** @description Only return credit notes for the customer specified by this customer ID. */ customer?: string; + /** @description Only return credit notes for the account representing the customer specified by this account ID. */ + customer_account?: 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. */ @@ -36563,7 +40890,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ amount?: number; /** @description The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ credit_amount?: number; @@ -36581,7 +40908,7 @@ export interface operations { expand?: string[]; /** @description ID of the invoice. */ invoice: string; - /** @description Line items that make up the credit note. */ + /** @description Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ lines?: { amount?: number; description?: string; @@ -36601,7 +40928,7 @@ export interface operations { }[]; /** @description The credit note's memo appears on the credit note PDF. */ memo?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -36612,13 +40939,23 @@ export interface operations { * @enum {string} */ reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; - /** @description ID of an existing refund to link this credit note to. */ - refund?: string; /** @description The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ refund_amount?: number; + /** @description Refunds to link to this credit note. */ + refunds?: { + amount_refunded?: number; + /** payment_record_refund_params */ + payment_record_refund?: { + payment_record: string; + refund_group: string; + }; + refund?: string; + /** @enum {string} */ + type?: "payment_record_refund" | "refund"; + }[]; /** * credit_note_shipping_cost - * @description When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. + * @description When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ shipping_cost?: { shipping_rate?: string; @@ -36650,7 +40987,7 @@ export interface operations { GetCreditNotesPreview: { parameters: { query: { - /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ amount?: number; /** @description The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ credit_amount?: number; @@ -36662,7 +40999,7 @@ export interface operations { expand?: string[]; /** @description ID of the invoice. */ invoice: string; - /** @description Line items that make up the credit note. */ + /** @description Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ lines?: { amount?: number; description?: string; @@ -36682,7 +41019,7 @@ export interface operations { }[]; /** @description The credit note's memo appears on the credit note PDF. */ memo?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -36690,11 +41027,21 @@ export interface operations { out_of_band_amount?: number; /** @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; - /** @description ID of an existing refund to link this credit note to. */ - refund?: string; /** @description The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ refund_amount?: number; - /** @description When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. */ + /** @description Refunds to link to this credit note. */ + refunds?: { + amount_refunded?: number; + /** payment_record_refund_params */ + payment_record_refund?: { + payment_record: string; + refund_group: string; + }; + refund?: string; + /** @enum {string} */ + type?: "payment_record_refund" | "refund"; + }[]; + /** @description When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ shipping_cost?: { shipping_rate?: string; }; @@ -36732,7 +41079,7 @@ export interface operations { GetCreditNotesPreviewLines: { parameters: { query: { - /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note. */ + /** @description The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ amount?: number; /** @description The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice. */ credit_amount?: number; @@ -36748,7 +41095,7 @@ export interface operations { invoice: 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 Line items that make up the credit note. */ + /** @description Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ lines?: { amount?: number; description?: string; @@ -36768,7 +41115,7 @@ export interface operations { }[]; /** @description The credit note's memo appears on the credit note PDF. */ memo?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -36776,11 +41123,21 @@ export interface operations { out_of_band_amount?: number; /** @description Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory` */ reason?: "duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory"; - /** @description ID of an existing refund to link this credit note to. */ - refund?: string; /** @description The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. */ refund_amount?: number; - /** @description When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. */ + /** @description Refunds to link to this credit note. */ + refunds?: { + amount_refunded?: number; + /** payment_record_refund_params */ + payment_record_refund?: { + payment_record: string; + refund_group: string; + }; + refund?: string; + /** @enum {string} */ + type?: "payment_record_refund" | "refund"; + }[]; + /** @description When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided. */ shipping_cost?: { shipping_rate?: string; }; @@ -36939,7 +41296,7 @@ export interface operations { expand?: string[]; /** @description Credit note memo. */ memo?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -37017,13 +41374,39 @@ export interface operations { "application/x-www-form-urlencoded": { /** * components - * @description Configuration for each component. Exactly 1 component must be enabled. + * @description Configuration for each component. At least 1 component must be enabled. */ components: { /** buy_button_param */ buy_button?: { enabled: boolean; }; + /** customer_sheet_param */ + customer_sheet?: { + enabled: boolean; + /** features_param */ + features?: { + payment_method_allow_redisplay_filters?: ("always" | "limited" | "unspecified")[]; + /** @enum {string} */ + payment_method_remove?: "disabled" | "enabled"; + }; + }; + /** mobile_payment_element_param */ + mobile_payment_element?: { + enabled: boolean; + /** features_param */ + features?: { + payment_method_allow_redisplay_filters?: ("always" | "limited" | "unspecified")[]; + /** @enum {string} */ + payment_method_redisplay?: "disabled" | "enabled"; + /** @enum {string} */ + payment_method_remove?: "disabled" | "enabled"; + /** @enum {string} */ + payment_method_save?: "disabled" | "enabled"; + /** @enum {string} */ + payment_method_save_allow_redisplay_override?: "always" | "limited" | "unspecified"; + }; + }; /** payment_element_param */ payment_element?: { enabled: boolean; @@ -37047,7 +41430,9 @@ export interface operations { }; }; /** @description The ID of an existing customer for which to create the Customer Session. */ - customer: string; + customer?: string; + /** @description The ID of an existing Account for which to create the Customer Session. */ + customer_account?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; }; @@ -37148,7 +41533,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The customer's address. */ + /** @description The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). */ address?: { city?: string; country?: string; @@ -37159,6 +41544,8 @@ export interface operations { } | ""; /** @description An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ balance?: number; + /** @description The customer's business name. This may be up to *150 characters*. */ + business_name?: string | ""; /** * cash_balance_param * @description Balance information and default balance settings for this customer. @@ -37170,13 +41557,14 @@ export interface operations { reconciliation_mode?: "automatic" | "manual" | "merchant_default"; }; }; - coupon?: string; /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ description?: string; /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ email?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description The customer's full name. This may be up to *150 characters*. */ + individual_name?: string | ""; /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ invoice_prefix?: string; /** @@ -37196,7 +41584,7 @@ export interface operations { template?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -37209,8 +41597,6 @@ export interface operations { phone?: string; /** @description Customer's preferred languages, ordered by preference. */ preferred_locales?: string[]; - /** @description The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: { /** optional_fields_customer_address */ @@ -37243,7 +41629,7 @@ export interface operations { /** @description The customer's tax IDs. */ tax_id_data?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; /** @description ID of the test clock to attach to the customer. */ @@ -37281,7 +41667,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for customers](https://docs.stripe.com/search#query-fields-for-customers). */ query: string; }; header?: never; @@ -37376,7 +41762,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The customer's address. */ + /** @description The customer's address. Learn about [country-specific requirements for calculating tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). */ address?: { city?: string; country?: string; @@ -37400,6 +41786,8 @@ export interface operations { object?: "bank_account"; routing_number?: string; } | string; + /** @description The customer's business name. This may be up to *150 characters*. */ + business_name?: string | ""; /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ card?: { address_city?: string; @@ -37430,7 +41818,6 @@ export interface operations { reconciliation_mode?: "automatic" | "manual" | "merchant_default"; }; }; - coupon?: string; /** @description ID of Alipay account to make the customer's new default for invoice payments. */ default_alipay_account?: string; /** @description ID of bank account to make the customer's new default for invoice payments. */ @@ -37438,11 +41825,11 @@ export interface operations { /** @description ID of card to make the customer's new default for invoice payments. */ default_card?: string; /** - * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. + * @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. * * Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. * - * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. + * If you want to add a new payment source and make it the default, see the [source](https://docs.stripe.com/api/customers/update#update_customer-source) property. */ default_source?: string; /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ @@ -37451,6 +41838,8 @@ export interface operations { email?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description The customer's full name. This may be up to *150 characters*. */ + individual_name?: string | ""; /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ invoice_prefix?: string; /** @@ -37470,7 +41859,7 @@ export interface operations { template?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -37482,8 +41871,6 @@ export interface operations { phone?: string; /** @description Customer's preferred languages, ordered by preference. */ preferred_locales?: string[]; - /** @description The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: { /** optional_fields_customer_address */ @@ -37575,10 +41962,19 @@ export interface operations { GetCustomersCustomerBalanceTransactions: { parameters: { query?: { + /** @description Only return customer balance transactions that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; /** @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 Only return transactions that are related to the specified invoice. */ + invoice?: 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. */ @@ -37644,14 +42040,14 @@ export interface operations { amount: number; /** * Format: currency - * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. + * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the [`invoice_credit_balance`](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. */ currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -37735,7 +42131,7 @@ export interface operations { description?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -37867,11 +42263,11 @@ export interface operations { } | string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** @description Please refer to full [documentation](https://api.stripe.com) instead. */ source?: string; }; }; @@ -37974,7 +42370,7 @@ export interface operations { exp_year?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -38202,11 +42598,11 @@ export interface operations { } | string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** @description Please refer to full [documentation](https://api.stripe.com) instead. */ source?: string; }; }; @@ -38309,7 +42705,7 @@ export interface operations { exp_year?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -38709,7 +43105,7 @@ export interface operations { GetCustomersCustomerPaymentMethods: { parameters: { query?: { - /** @description This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`. */ + /** @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. */ allow_redisplay?: "always" | "limited" | "unspecified"; /** @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; @@ -38720,7 +43116,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" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path: { @@ -38910,11 +43306,11 @@ export interface operations { } | string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Please refer to full [documentation](https://stripe.com/docs/api) instead. */ + /** @description Please refer to full [documentation](https://api.stripe.com) instead. */ source?: string; }; }; @@ -39017,7 +43413,7 @@ export interface operations { exp_year?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -39217,6 +43613,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "now" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -39236,7 +43652,7 @@ export interface operations { application_fee_percent?: number | ""; /** * automatic_tax_config - * @description Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. + * @description Automatic tax settings for this subscription. */ automatic_tax?: { enabled: boolean; @@ -39249,24 +43665,21 @@ export interface operations { }; /** * Format: unix-time - * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. + * @description A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ backdate_start_date?: number; /** * Format: unix-time - * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. + * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. */ billing_cycle_anchor?: number; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ + /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: { amount_gte?: number; reset_billing_cycle_anchor?: boolean; } | ""; - /** - * Format: unix-time - * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - */ - cancel_at?: number; + /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ + cancel_at?: number | ("max_period_end" | "min_period_end"); /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** @@ -39274,8 +43687,6 @@ export interface operations { * @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; /** * Format: 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). @@ -39283,9 +43694,9 @@ export interface operations { currency?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ days_until_due?: number; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_payment_method?: string; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_source?: string; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. */ default_tax_rates?: string[] | ""; @@ -39344,7 +43755,7 @@ export interface operations { quantity?: number; tax_rates?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -39353,11 +43764,11 @@ export interface operations { /** * @description Only applies to subscriptions with `collection_method=charge_automatically`. * - * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. + * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more. * * `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. * @@ -39410,6 +43821,14 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + payto?: { + /** mandate_options_param */ + mandate_options?: { + amount?: number; + /** @enum {string} */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + } | ""; sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ @@ -39425,20 +43844,18 @@ 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" | "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")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. */ pending_invoice_item_interval?: { /** @enum {string} */ interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -39450,11 +43867,11 @@ export interface operations { amount_percent?: number; destination: string; }; - /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_end?: "now" | number; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_from_plan?: boolean; - /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_period_days?: number; /** * trial_settings_config @@ -39550,6 +43967,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "now" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -39581,17 +44018,17 @@ export interface operations { }; }; /** - * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). * @enum {string} */ billing_cycle_anchor?: "now" | "unchanged"; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ + /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: { amount_gte?: number; reset_billing_cycle_anchor?: boolean; } | ""; /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ - cancel_at?: number | ""; + cancel_at?: number | "" | ("max_period_end" | "min_period_end"); /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** @@ -39608,13 +44045,11 @@ export interface operations { * @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ days_until_due?: number; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_payment_method?: string; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_source?: string | ""; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates. */ default_tax_rates?: string[] | ""; @@ -39676,13 +44111,13 @@ export interface operations { quantity?: number; tax_rates?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 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](https://stripe.com/docs/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://docs.stripe.com/billing/subscriptions/pause-payment). */ pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; @@ -39690,13 +44125,13 @@ export interface operations { resumes_at?: number; } | ""; /** - * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. * - * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + * Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. * @enum {string} */ payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; @@ -39745,6 +44180,14 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + payto?: { + /** mandate_options_param */ + mandate_options?: { + amount?: number; + /** @enum {string} */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + } | ""; sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ @@ -39760,26 +44203,24 @@ 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" | "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")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. */ pending_invoice_item_interval?: { /** @enum {string} */ interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** * Format: unix-time - * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + * @description If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ proration_date?: number; /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ @@ -39789,7 +44230,7 @@ export interface operations { } | ""; /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ trial_end?: "now" | number; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_from_plan?: boolean; /** * trial_settings_config @@ -40015,10 +44456,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`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; }; @@ -40316,7 +44757,7 @@ export interface operations { }; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -40941,6 +45382,90 @@ export interface operations { }; }; }; + PostExternalAccountsId: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description The name of the person or business that owns the bank account. */ + account_holder_name?: string; + /** + * @description The type of entity that holds the account. This can be either `individual` or `company`. + * @enum {string} + */ + account_holder_type?: "" | "company" | "individual"; + /** + * @description The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`. + * @enum {string} + */ + account_type?: "checking" | "futsu" | "savings" | "toza"; + /** @description City/District/Suburb/Town/Village. */ + address_city?: string; + /** @description Billing address country, if provided when creating card. */ + address_country?: string; + /** @description Address line 1 (Street address/PO Box/Company name). */ + address_line1?: string; + /** @description Address line 2 (Apartment/Suite/Unit/Building). */ + address_line2?: string; + /** @description State/County/Province/Region. */ + address_state?: string; + /** @description ZIP or postal code. */ + address_zip?: string; + /** @description When set to true, this becomes the default external account for its currency. */ + default_for_currency?: boolean; + /** + * external_account_documents_param + * @description Documents that may be submitted to satisfy various informational requests. + */ + documents?: { + /** documents_param */ + bank_account_ownership_verification?: { + files?: string[]; + }; + }; + /** @description Two digit number representing the card’s expiration month. */ + exp_month?: string; + /** @description Four digit number representing the card’s expiration year. */ + exp_year?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Cardholder name. */ + name?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["external_account"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetFileLinks: { parameters: { query?: { @@ -41023,9 +45548,9 @@ 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`, `financial_account_statement`, `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`, `terminal_android_apk`, 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -41107,7 +45632,7 @@ export interface operations { expand?: string[]; /** @description A future timestamp after which the link will no longer be usable, or `now` to expire the link immediately. */ expires_at?: "now" | number | ""; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -41152,7 +45677,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" | "financial_account_statement" | "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" | "platform_terms_of_service" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_android_apk" | "terminal_reader_splashscreen" | "terminal_wifi_certificate" | "terminal_wifi_private_key"; /** @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; }; @@ -41216,7 +45741,7 @@ export interface operations { file: string; /** * file_link_creation_params - * @description Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file. + * @description Optional parameters that automatically create a [file link](https://api.stripe.com#file_links) for the newly created file. */ file_link_data?: { create: boolean; @@ -41227,10 +45752,10 @@ export interface operations { } | ""; }; /** - * @description The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. + * @description The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. * @enum {string} */ - purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "identity_document" | "issuing_regulatory_reporting" | "pci_document" | "tax_document_user_upload" | "terminal_reader_splashscreen"; + purpose: "account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "identity_document" | "issuing_regulatory_reporting" | "pci_document" | "platform_terms_of_service" | "tax_document_user_upload" | "terminal_android_apk" | "terminal_reader_splashscreen" | "terminal_wifi_certificate" | "terminal_wifi_private_key"; }; }; }; @@ -41300,6 +45825,7 @@ export interface operations { account_holder?: { account?: string; customer?: string; + customer_account?: 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; @@ -41625,6 +46151,7 @@ export interface operations { account_holder: { account?: string; customer?: string; + customer_account?: string; /** @enum {string} */ type: "account" | "customer"; }; @@ -41887,7 +46414,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -42092,10 +46619,13 @@ export interface operations { expand?: string[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; + /** @description Customer ID */ related_customer?: string; + /** @description The ID of the Account representing a customer. */ + related_customer_account?: 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 VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work). */ + /** @description Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://docs.stripe.com/identity/how-sessions-work). */ status?: "canceled" | "processing" | "requires_input" | "verified"; }; header?: never; @@ -42153,7 +46683,7 @@ export interface operations { client_reference_id?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -42177,12 +46707,22 @@ export interface operations { email?: string; phone?: string; }; - /** @description Token referencing a Customer resource. */ + /** @description Customer ID */ related_customer?: string; + /** @description The ID of the Account representing a customer. */ + related_customer_account?: string; + /** + * related_person_param + * @description Tokens referencing a Person resource and it's associated account. + */ + related_person?: { + account: string; + person: string; + }; /** @description The URL that the user will be redirected to upon completing the verification flow. */ return_url?: string; /** - * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. + * @description The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. * @enum {string} */ type?: "document" | "id_number"; @@ -42264,7 +46804,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -42289,7 +46829,7 @@ export interface operations { phone?: string; }; /** - * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + * @description The type of [verification check](https://docs.stripe.com/identity/verification-checks) to be performed. * @enum {string} */ type?: "document" | "id_number"; @@ -42393,6 +46933,116 @@ export interface operations { }; }; }; + GetInvoicePayments: { + parameters: { + query?: { + /** @description Only return invoice payments that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; + /** @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 The identifier of the invoice whose payments to return. */ + invoice?: string; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description The payment details of the invoice payments to return. */ + payment?: { + payment_intent?: string; + payment_record?: string; + /** @enum {string} */ + type: "payment_intent" | "payment_record"; + }; + /** @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 The status of the invoice payments to return. */ + status?: "canceled" | "open" | "paid"; + }; + 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": { + /** @description Details about each object. */ + data: components["schemas"]["invoice_payment"][]; + /** @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"]; + }; + }; + }; + }; + GetInvoicePaymentsInvoicePayment: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + invoice_payment: 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"]["invoice_payment"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetInvoiceRenderingTemplates: { parameters: { query?: { @@ -42573,8 +47223,10 @@ export interface operations { lt?: number; lte?: number; } | number; - /** @description The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned. */ + /** @description The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items. */ customer?: string; + /** @description The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items. */ + customer_account?: 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. */ @@ -42636,7 +47288,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { /** @description The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice. */ @@ -42646,8 +47298,10 @@ export interface operations { * @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 The ID of the customer who will be billed when this invoice item is billed. */ - customer: string; + /** @description The ID of the customer to bill for this invoice item. */ + customer?: string; + /** @description The ID of the account representing the customer to bill for this invoice item. */ + customer_account?: string; /** @description An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. */ description?: string; /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ @@ -42660,15 +47314,15 @@ export interface operations { }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ + /** @description The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice. */ invoice?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; /** * period - * @description The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. + * @description The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. */ period?: { /** Format: unix-time */ @@ -42676,11 +47330,9 @@ export interface operations { /** Format: unix-time */ start: number; }; - /** @description The ID of the price object. One of `price` or `price_data` is required. */ - price?: string; /** * one_time_price_data - * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + * @description Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. */ price_data?: { /** Format: currency */ @@ -42692,24 +47344,29 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }; + /** + * pricing_param + * @description The pricing information for the invoice item. + */ + pricing?: { + price?: string; + }; /** @description Non-negative integer. The quantity of units for the invoice item. */ quantity?: number; /** @description The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription. */ subscription?: string; /** - * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + * @description Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. */ tax_code?: string | ""; /** @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. */ tax_rates?: string[]; - /** @description The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice. */ - unit_amount?: number; /** * Format: decimal - * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @description The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places. */ unit_amount_decimal?: string; }; @@ -42800,13 +47457,13 @@ export interface operations { }[] | ""; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; /** * period - * @description The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. + * @description The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. */ period?: { /** Format: unix-time */ @@ -42814,11 +47471,9 @@ export interface operations { /** Format: unix-time */ start: number; }; - /** @description The ID of the price object. One of `price` or `price_data` is required. */ - price?: string; /** * one_time_price_data - * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + * @description Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. */ price_data?: { /** Format: currency */ @@ -42830,22 +47485,27 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }; + /** + * pricing_param + * @description The pricing information for the invoice item. + */ + pricing?: { + price?: string; + }; /** @description Non-negative integer. The quantity of units for the invoice item. */ quantity?: number; /** - * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + * @description Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. */ tax_code?: string | ""; /** @description The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates. */ tax_rates?: string[] | ""; - /** @description The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount. */ - unit_amount?: number; /** * Format: decimal - * @description Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. + * @description The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places. */ unit_amount_decimal?: string; }; @@ -42921,6 +47581,8 @@ export interface operations { } | number; /** @description Only return invoices for the customer specified by this customer ID. */ customer?: string; + /** @description Only return invoices for the account representing the customer specified by this account ID. */ + customer_account?: string; due_date?: { gt?: number; gte?: number; @@ -42935,7 +47597,7 @@ export interface operations { 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; - /** @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) */ + /** @description The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) */ status?: "draft" | "open" | "paid" | "uncollectible" | "void"; /** @description Only return invoices for the subscription specified by this subscription ID. */ subscription?: string; @@ -42993,9 +47655,9 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ account_tax_ids?: string[] | ""; - /** @description A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ + /** @description A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees). */ application_fee_amount?: number; - /** @description Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ + /** @description Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false. */ auto_advance?: boolean; /** * automatic_tax_param @@ -43012,7 +47674,7 @@ export interface operations { }; /** * 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. + * @description The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. */ automatically_finalizes_at?: number; /** @@ -43030,8 +47692,10 @@ export interface operations { name: string; value: string; }[] | ""; - /** @description The ID of the customer who will be billed. */ + /** @description The ID of the customer to bill. */ customer?: string; + /** @description The ID of the account to bill. */ + customer_account?: string; /** @description The number of days from when the invoice is created until it is due. Valid only for invoices where `collection_method=send_invoice`. */ days_until_due?: number; /** @description ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings. */ @@ -43064,7 +47728,7 @@ export interface operations { footer?: string; /** * from_invoice - * @description Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. + * @description Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details. */ from_invoice?: { /** @enum {string} */ @@ -43080,13 +47744,13 @@ export interface operations { /** @enum {string} */ type: "account" | "self"; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. */ number?: string; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. */ on_behalf_of?: string; /** * payment_settings @@ -43118,7 +47782,7 @@ export interface operations { /** @enum {string} */ interval?: "month"; /** @enum {string} */ - type: "fixed_count"; + type: "bonus" | "fixed_count" | "revolving"; } | ""; }; /** @enum {string} */ @@ -43136,6 +47800,14 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + payto?: { + /** mandate_options_param */ + mandate_options?: { + amount?: number; + /** @enum {string} */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + } | ""; sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ @@ -43151,7 +47823,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" | "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")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "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. @@ -43296,15 +47968,15 @@ export interface operations { type: "account" | "self"; }; }; - /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; /** * Format: currency * @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ currency?: string; - /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ + /** @description The identifier of the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ customer?: string; + /** @description The identifier of the account representing the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set. */ + customer_account?: string; /** * customer_details_param * @description Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. @@ -43339,7 +48011,7 @@ export interface operations { tax_exempt?: "" | "exempt" | "none" | "reverse"; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; }; @@ -43404,7 +48076,7 @@ export interface operations { /** @enum {string} */ type: "account" | "self"; }; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. */ on_behalf_of?: string | ""; /** * @description Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. @@ -43418,6 +48090,16 @@ export interface operations { * @description The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ schedule_details?: { + /** billing_mode */ + billing_mode?: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "classic" | "flexible"; + }; /** @enum {string} */ end_behavior?: "cancel" | "release"; phases?: { @@ -43427,6 +48109,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "phase_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "phase_start" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -43461,7 +48163,6 @@ export interface operations { } | ""; /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; default_payment_method?: string; default_tax_rates?: string[] | ""; description?: string | ""; @@ -43470,6 +48171,12 @@ export interface operations { discount?: string; promotion_code?: string; }[] | ""; + /** duration_params */ + duration?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; end_date?: number | "now"; /** invoice_settings */ invoice_settings?: { @@ -43515,7 +48222,6 @@ export interface operations { quantity?: number; tax_rates?: string[] | ""; }[]; - iterations?: number; metadata?: { [key: string]: string; }; @@ -43542,7 +48248,17 @@ export interface operations { */ subscription_details?: { billing_cycle_anchor?: ("now" | "unchanged") | number; - cancel_at?: number | ""; + /** billing_mode */ + billing_mode?: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "classic" | "flexible"; + }; + cancel_at?: number | "" | ("max_period_end" | "min_period_end"); cancel_at_period_end?: boolean; cancel_now?: boolean; default_tax_rates?: string[] | ""; @@ -43625,7 +48341,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for invoices](https://stripe.com/docs/search#query-fields-for-invoices). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for invoices](https://docs.stripe.com/search#query-fields-for-invoices). */ query: string; }; header?: never; @@ -43670,792 +48386,16 @@ export interface operations { }; }; }; - GetInvoicesUpcoming: { + GetInvoicesInvoice: { parameters: { query?: { - /** @description Settings for automatic tax lookup for this invoice preview. */ - automatic_tax?: { - enabled: boolean; - /** param */ - liability?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - }; - /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; - /** @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ - currency?: string; - /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ - customer?: string; - /** @description Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ - customer_details?: { - address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } | ""; - shipping?: { - /** optional_fields_customer_address */ - address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - } | ""; - /** tax_param */ - tax?: { - ip_address?: string | ""; - }; - /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; - tax_ids?: { - /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; - value: string; - }[]; - }; - /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description List of invoice items to add or update in the upcoming invoice preview (up to 250). */ - invoice_items?: { - amount?: number; - /** Format: currency */ - currency?: string; - description?: string; - discountable?: boolean; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - invoiceitem?: string; - metadata?: { - [key: string]: string; - } | ""; - /** period */ - period?: { - /** Format: unix-time */ - end: number; - /** Format: unix-time */ - start: number; - }; - price?: string; - /** one_time_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - tax_code?: string | ""; - tax_rates?: string[] | ""; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }[]; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ - issuer?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ - on_behalf_of?: string | ""; - /** @description Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. */ - preview_mode?: "next" | "recurring"; - /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; - /** @description The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ - schedule_details?: { - /** @enum {string} */ - end_behavior?: "cancel" | "release"; - phases?: { - add_invoice_items?: { - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[]; - price?: string; - /** one_time_price_data_with_negative_amounts */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - application_fee_percent?: number; - /** automatic_tax_config */ - automatic_tax?: { - enabled: boolean; - /** param */ - liability?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - }; - /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; - billing_thresholds?: { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; - } | ""; - /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: string[] | ""; - description?: string | ""; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - end_date?: number | "now"; - /** invoice_settings */ - invoice_settings?: { - account_tax_ids?: string[] | ""; - days_until_due?: number; - /** param */ - issuer?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - }; - items: { - billing_thresholds?: { - usage_gte: number; - } | ""; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - metadata?: { - [key: string]: string; - }; - price?: string; - /** recurring_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - iterations?: number; - metadata?: { - [key: string]: string; - }; - on_behalf_of?: string; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: number | "now"; - /** transfer_data_specs */ - transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; - trial_end?: number | "now"; - }[]; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - /** @description The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; - /** @description For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. */ - subscription_billing_cycle_anchor?: ("now" | "unchanged") | number; - /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ - subscription_cancel_at?: number | ""; - /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ - subscription_cancel_at_period_end?: boolean; - /** @description This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ - subscription_cancel_now?: boolean; - /** @description If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. */ - subscription_default_tax_rates?: string[] | ""; - /** @description The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. */ - subscription_details?: { - billing_cycle_anchor?: ("now" | "unchanged") | number; - cancel_at?: number | ""; - cancel_at_period_end?: boolean; - cancel_now?: boolean; - default_tax_rates?: string[] | ""; - items?: { - billing_thresholds?: { - usage_gte: number; - } | ""; - clear_usage?: boolean; - deleted?: boolean; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - id?: string; - metadata?: { - [key: string]: string; - } | ""; - price?: string; - /** recurring_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ - proration_date?: number; - /** @enum {string} */ - resume_at?: "now"; - /** Format: unix-time */ - start_date?: number; - trial_end?: "now" | number; - }; - /** @description A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. */ - subscription_items?: { - billing_thresholds?: { - usage_gte: number; - } | ""; - clear_usage?: boolean; - deleted?: boolean; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - id?: string; - metadata?: { - [key: string]: string; - } | ""; - price?: string; - /** recurring_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - /** @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** @description If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. */ - subscription_proration_date?: number; - /** @description For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. */ - subscription_resume_at?: "now"; - /** @description Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. */ - subscription_start_date?: number; - /** @description If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. */ - subscription_trial_end?: "now" | number; }; 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"]["invoice"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - GetInvoicesUpcomingLines: { - parameters: { - query?: { - /** @description Settings for automatic tax lookup for this invoice preview. */ - automatic_tax?: { - enabled: boolean; - /** param */ - liability?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - }; - /** @description The ID of the coupon to apply to this phase of the subscription schedule. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; - /** @description The currency to preview this invoice in. Defaults to that of `customer` if not specified. */ - currency?: string; - /** @description The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ - customer?: string; - /** @description Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. */ - customer_details?: { - address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } | ""; - shipping?: { - /** optional_fields_customer_address */ - address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - } | ""; - /** tax_param */ - tax?: { - ip_address?: string | ""; - }; - /** @enum {string} */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; - tax_ids?: { - /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; - value: string; - }[]; - }; - /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: 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 List of invoice items to add or update in the upcoming invoice preview (up to 250). */ - invoice_items?: { - amount?: number; - /** Format: currency */ - currency?: string; - description?: string; - discountable?: boolean; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - invoiceitem?: string; - metadata?: { - [key: string]: string; - } | ""; - /** period */ - period?: { - /** Format: unix-time */ - end: number; - /** Format: unix-time */ - start: number; - }; - price?: string; - /** one_time_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - tax_code?: string | ""; - tax_rates?: string[] | ""; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }[]; - /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ - issuer?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ - on_behalf_of?: string | ""; - /** @description Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified. */ - preview_mode?: "next" | "recurring"; - /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ - schedule?: string; - /** @description The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ - schedule_details?: { - /** @enum {string} */ - end_behavior?: "cancel" | "release"; - phases?: { - add_invoice_items?: { - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[]; - price?: string; - /** one_time_price_data_with_negative_amounts */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - application_fee_percent?: number; - /** automatic_tax_config */ - automatic_tax?: { - enabled: boolean; - /** param */ - liability?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - }; - /** @enum {string} */ - billing_cycle_anchor?: "automatic" | "phase_start"; - billing_thresholds?: { - amount_gte?: number; - reset_billing_cycle_anchor?: boolean; - } | ""; - /** @enum {string} */ - collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; - default_payment_method?: string; - default_tax_rates?: string[] | ""; - description?: string | ""; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - end_date?: number | "now"; - /** invoice_settings */ - invoice_settings?: { - account_tax_ids?: string[] | ""; - days_until_due?: number; - /** param */ - issuer?: { - account?: string; - /** @enum {string} */ - type: "account" | "self"; - }; - }; - items: { - billing_thresholds?: { - usage_gte: number; - } | ""; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - metadata?: { - [key: string]: string; - }; - price?: string; - /** recurring_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - iterations?: number; - metadata?: { - [key: string]: string; - }; - on_behalf_of?: string; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - start_date?: number | "now"; - /** transfer_data_specs */ - transfer_data?: { - amount_percent?: number; - destination: string; - }; - trial?: boolean; - trial_end?: number | "now"; - }[]; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - /** @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 The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_details.items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_details.items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ - subscription?: string; - /** @description For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. */ - subscription_billing_cycle_anchor?: ("now" | "unchanged") | number; - /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ - subscription_cancel_at?: number | ""; - /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ - subscription_cancel_at_period_end?: boolean; - /** @description This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ - subscription_cancel_now?: boolean; - /** @description If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. */ - subscription_default_tax_rates?: string[] | ""; - /** @description The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. */ - subscription_details?: { - billing_cycle_anchor?: ("now" | "unchanged") | number; - cancel_at?: number | ""; - cancel_at_period_end?: boolean; - cancel_now?: boolean; - default_tax_rates?: string[] | ""; - items?: { - billing_thresholds?: { - usage_gte: number; - } | ""; - clear_usage?: boolean; - deleted?: boolean; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - id?: string; - metadata?: { - [key: string]: string; - } | ""; - price?: string; - /** recurring_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** Format: unix-time */ - proration_date?: number; - /** @enum {string} */ - resume_at?: "now"; - /** Format: unix-time */ - start_date?: number; - trial_end?: "now" | number; - }; - /** @description A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. */ - subscription_items?: { - billing_thresholds?: { - usage_gte: number; - } | ""; - clear_usage?: boolean; - deleted?: boolean; - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - id?: string; - metadata?: { - [key: string]: string; - } | ""; - price?: string; - /** recurring_price_data */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - quantity?: number; - tax_rates?: string[] | ""; - }[]; - /** @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. */ - subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** @description If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. */ - subscription_proration_date?: number; - /** @description For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. */ - subscription_resume_at?: "now"; - /** @description Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. */ - subscription_start_date?: number; - /** @description If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. */ - subscription_trial_end?: "now" | number; - }; - 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": { - /** @description Details about each object. */ - data: components["schemas"]["line_item"][]; - /** @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"]; - }; - }; - }; - }; - GetInvoicesInvoice: { - parameters: { - query?: { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - header?: never; - path: { - invoice: string; - }; + path: { + invoice: string; + }; cookie?: never; }; requestBody?: { @@ -44498,9 +48438,9 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The account tax IDs associated with the invoice. Only editable when the invoice is a draft. */ account_tax_ids?: string[] | ""; - /** @description A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). */ + /** @description A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees). */ application_fee_amount?: number; - /** @description Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. */ + /** @description Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. */ auto_advance?: boolean; /** * automatic_tax_param @@ -44517,7 +48457,7 @@ export interface operations { }; /** * 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. + * @description The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false. */ automatically_finalizes_at?: number; /** @@ -44566,13 +48506,13 @@ export interface operations { /** @enum {string} */ type: "account" | "self"; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. */ number?: string | ""; - /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. */ on_behalf_of?: string | ""; /** * payment_settings @@ -44604,7 +48544,7 @@ export interface operations { /** @enum {string} */ interval?: "month"; /** @enum {string} */ - type: "fixed_count"; + type: "bonus" | "fixed_count" | "revolving"; } | ""; }; /** @enum {string} */ @@ -44622,6 +48562,14 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + payto?: { + /** mandate_options_param */ + mandate_options?: { + amount?: number; + /** @enum {string} */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + } | ""; sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ @@ -44637,7 +48585,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" | "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")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; }; /** * rendering_param @@ -44792,7 +48740,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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`. */ invoice_metadata?: { [key: string]: string; } | ""; @@ -44817,7 +48765,6 @@ export interface operations { /** Format: unix-time */ start: number; }; - price?: string; /** one_time_price_data_with_product_data */ price_data?: { /** Format: currency */ @@ -44832,6 +48779,7 @@ export interface operations { }; name: string; tax_code?: string; + unit_label?: string; }; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -44839,6 +48787,10 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }; + /** pricing_param */ + pricing?: { + price?: string; + }; quantity?: number; tax_amounts?: { amount: number; @@ -44849,11 +48801,15 @@ export interface operations { display_name: string; inclusive: boolean; jurisdiction?: string; + /** @enum {string} */ + jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state"; percentage: number; state?: string; /** @enum {string} */ tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; + /** @enum {string} */ + taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; taxable_amount: number; }[] | ""; tax_rates?: string[] | ""; @@ -44882,6 +48838,48 @@ export interface operations { }; }; }; + PostInvoicesInvoiceAttachPayment: { + parameters: { + query?: never; + header?: never; + path: { + invoice: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The ID of the PaymentIntent to attach to the invoice. */ + payment_intent?: string; + /** @description The ID of the PaymentRecord to attach to the invoice. */ + payment_record?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostInvoicesInvoiceFinalize: { parameters: { query?: never; @@ -44894,7 +48892,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ + /** @description Controls whether Stripe performs [automatic collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. */ auto_advance?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -45007,13 +49005,13 @@ export interface operations { }[] | ""; /** @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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. */ metadata?: { [key: string]: string; } | ""; /** * period - * @description The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details. + * @description The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. */ period?: { /** Format: unix-time */ @@ -45021,11 +49019,9 @@ export interface operations { /** Format: unix-time */ start: number; }; - /** @description The ID of the price object. One of `price` or `price_data` is required. */ - price?: string; /** * one_time_price_data_with_product_data - * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. + * @description Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. */ price_data?: { /** Format: currency */ @@ -45040,6 +49036,7 @@ export interface operations { }; name: string; tax_code?: string; + unit_label?: string; }; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -45047,9 +49044,16 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }; + /** + * pricing_param + * @description The pricing information for the invoice item. + */ + pricing?: { + price?: string; + }; /** @description Non-negative integer. The quantity of units for the line item. */ quantity?: number; - /** @description A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts. */ + /** @description A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts. */ tax_amounts?: { amount: number; /** tax_rate_data_param */ @@ -45059,11 +49063,15 @@ export interface operations { display_name: string; inclusive: boolean; jurisdiction?: string; + /** @enum {string} */ + jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state"; percentage: number; state?: string; /** @enum {string} */ tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; + /** @enum {string} */ + taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; taxable_amount: number; }[] | ""; /** @description The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates. */ @@ -45198,7 +49206,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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`. */ invoice_metadata?: { [key: string]: string; } | ""; @@ -45284,7 +49292,7 @@ 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`. For [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) line items, where any existing metadata on the invoice line is merged with the incoming data. */ invoice_metadata?: { [key: string]: string; } | ""; @@ -45309,7 +49317,6 @@ export interface operations { /** Format: unix-time */ start: number; }; - price?: string; /** one_time_price_data_with_product_data */ price_data?: { /** Format: currency */ @@ -45324,6 +49331,7 @@ export interface operations { }; name: string; tax_code?: string; + unit_label?: string; }; /** @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -45331,6 +49339,10 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }; + /** pricing_param */ + pricing?: { + price?: string; + }; quantity?: number; tax_amounts?: { amount: number; @@ -45341,11 +49353,15 @@ export interface operations { display_name: string; inclusive: boolean; jurisdiction?: string; + /** @enum {string} */ + jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state"; percentage: number; state?: string; /** @enum {string} */ tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "retail_delivery_fee" | "rst" | "sales_tax" | "service_tax" | "vat"; }; + /** @enum {string} */ + taxability_reason?: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; taxable_amount: number; }[] | ""; tax_rates?: string[] | ""; @@ -45435,7 +49451,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 Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`. */ - status?: "closed" | "pending" | "reversed"; + status?: "closed" | "expired" | "pending" | "reversed"; }; header?: never; path?: never; @@ -45530,7 +49546,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -45570,11 +49586,11 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) to decline an authorization request). */ + /** @description If the authorization's `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use [`decline`](https://docs.stripe.com/api/issuing/authorizations/decline) to decline an authorization request). */ amount?: number; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -45616,7 +49632,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -45780,22 +49796,22 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 cardholder's name. This will be printed on cards issued to them. The maximum length of this field is 24 characters. This field cannot contain any special characters or numbers. */ name: string; - /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ + /** @description The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. */ phone_number?: string; /** * @description The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - * This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + * This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. */ preferred_locales?: ("de" | "en" | "es" | "fr" | "it")[]; /** * authorization_controls_param_v2 - * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -45816,7 +49832,7 @@ export interface operations { */ status?: "active" | "inactive"; /** - * @description One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details. + * @description One of `individual` or `company`. See [Choose a cardholder type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. * @enum {string} */ type?: "company" | "individual"; @@ -45952,20 +49968,20 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure) for more details. */ + /** @description The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://docs.stripe.com/issuing/3d-secure) for more details. */ phone_number?: string; /** * @description The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - * This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + * This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. */ preferred_locales?: ("de" | "en" | "es" | "fr" | "it")[]; /** * authorization_controls_param_v2 - * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + * @description Rules that control spending across this cardholder's cards. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -46092,14 +50108,19 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) object with which the card will be associated. */ + /** @description The [Cardholder](https://docs.stripe.com/api#issuing_cardholder_object) object with which the card will be associated. */ cardholder?: string; /** @description The currency for the card. */ currency: string; + /** @description The desired expiration month (1-12) for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates). */ + exp_month?: number; + /** @description The desired 4-digit expiration year for this card if [specifying a custom expiration date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates). */ + exp_year?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account. */ financial_account?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -46154,7 +50175,7 @@ export interface operations { }; /** * authorization_controls_param - * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + * @description Rules that control spending for this card. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -46259,7 +50280,7 @@ export interface operations { cancellation_reason?: "lost" | "stolen"; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -46304,7 +50325,7 @@ export interface operations { }; /** * authorization_controls_param - * @description Rules that control spending for this card. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details. + * @description Rules that control spending for this card. Refer to our [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -46421,7 +50442,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount. */ + /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If not set, defaults to the full transaction amount. */ amount?: number; /** * evidence_param @@ -46494,7 +50515,7 @@ export interface operations { }; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -46581,7 +50602,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount?: number; /** * evidence_param @@ -46654,7 +50675,7 @@ export interface operations { }; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -46696,7 +50717,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -46812,7 +50833,7 @@ export interface operations { expand?: string[]; /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ lookup_key?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -46916,7 +50937,7 @@ export interface operations { expand?: string[]; /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ lookup_key?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -47104,7 +51125,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -47395,7 +51416,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -47440,6 +51461,7 @@ export interface operations { account_holder: { account?: string; customer?: string; + customer_account?: string; /** @enum {string} */ type: "account" | "customer"; }; @@ -47532,6 +51554,7 @@ export interface operations { account_holder?: { account?: string; customer?: string; + customer_account?: 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; @@ -47798,6 +51821,98 @@ export interface operations { }; }; }; + GetPaymentAttemptRecords: { + parameters: { + query: { + /** @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 The ID of the Payment Record. */ + payment_record: 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; + }; + 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"]["payment_attempt_record"][]; + /** @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"]; + }; + }; + }; + }; + GetPaymentAttemptRecordsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description The ID of the Payment Attempt Record. */ + 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"]["payment_attempt_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetPaymentIntents: { parameters: { query?: { @@ -47810,6 +51925,8 @@ export interface operations { } | number; /** @description Only return PaymentIntents for the customer that this customer ID specifies. */ customer?: string; + /** @description Only return PaymentIntents for the account representing the customer that this ID specifies. */ + customer_account?: 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. */ @@ -47870,9 +51987,62 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ amount: number; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** + * amount_details_param + * @description Provides industry-specific information about the amount. + */ + amount_details?: { + discount_amount?: number | ""; + enforce_arithmetic_validation?: boolean; + line_items?: { + discount_amount?: number; + /** amount_details_line_item_payment_method_options_param */ + payment_method_options?: { + /** payment_intent_amount_details_line_item_payment_method_options_param */ + card?: { + commodity_code?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + card_present?: { + commodity_code?: string; + }; + /** payment_intent_amount_details_line_item_payment_method_options_param */ + klarna?: { + image_url?: string; + product_url?: string; + reference?: string; + subscription_reference?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + paypal?: { + /** @enum {string} */ + category?: "digital_goods" | "donation" | "physical_goods"; + description?: string; + sold_by?: string; + }; + }; + product_code?: string; + product_name: string; + quantity: number; + /** amount_details_line_item_tax_param */ + tax?: { + total_tax_amount: number; + }; + unit_cost: number; + unit_of_measure?: string; + }[] | ""; + shipping?: { + amount?: number | ""; + from_postal_code?: string | ""; + to_postal_code?: string | ""; + } | ""; + tax?: { + total_tax_amount: number; + } | ""; + }; + /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ application_fee_amount?: number; /** * automatic_payment_methods_param @@ -47888,7 +52058,7 @@ export interface operations { * @enum {string} */ capture_method?: "automatic" | "automatic_async" | "manual"; - /** @description Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). */ + /** @description Set to `true` to attempt to [confirm this PaymentIntent](https://docs.stripe.com/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://docs.stripe.com/api/payment_intents/confirm). */ confirm?: boolean; /** * @description Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. @@ -47911,18 +52081,41 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; + /** + * @description ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + * + * Payment methods attached to other Accounts cannot be used with this PaymentIntent. + * + * If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. + */ + customer_account?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; - /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ + /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://docs.stripe.com/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). */ error_on_requires_action?: boolean; + /** @description The list of payment method types to exclude from use with this payment. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ + /** + * async_workflows_param + * @description Automations to be run during the PaymentIntent lifecycle + */ + hooks?: { + /** async_workflows_inputs_param */ + inputs?: { + /** async_workflows_inputs_tax_param */ + tax?: { + calculation: string | ""; + }; + }; + }; + /** @description ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). */ mandate?: string; - /** @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ + /** @description This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). */ mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { @@ -47939,26 +52132,35 @@ export interface operations { type: "offline" | "online"; }; } | ""; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ + /** @description Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://docs.stripe.com/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). */ off_session?: boolean | ("one_off" | "recurring"); - /** @description The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** @description The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ on_behalf_of?: string; /** - * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + * payment_details + * @description Provides industry-specific information about the charge. + */ + payment_details?: { + customer_reference?: string | ""; + order_reference?: string | ""; + }; + /** + * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. * * 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. + * If the payment method is attached to a Customer, you must also provide the ID of that Customer as the [customer](https://api.stripe.com#create_payment_intent-customer) parameter of this PaymentIntent. */ payment_method?: string; - /** @description The ID of the [payment method configuration](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. */ + /** @description The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. */ payment_method_configuration?: string; /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - * in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + * in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) * property on the PaymentIntent. */ payment_method_data?: { @@ -47992,6 +52194,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -48005,6 +52209,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -48015,6 +52220,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -48033,7 +52240,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -48054,6 +52261,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -48067,6 +52276,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -48082,6 +52300,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -48094,6 +52318,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -48107,7 +52333,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -48140,6 +52366,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; @@ -48174,6 +52401,7 @@ export interface operations { au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ @@ -48182,6 +52410,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; bancontact?: { /** @enum {string} */ @@ -48189,6 +52418,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + billie?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; blik?: { code?: string; /** @enum {string} */ @@ -48211,7 +52444,7 @@ export interface operations { /** @enum {string} */ interval?: "month"; /** @enum {string} */ - type: "fixed_count"; + type: "bonus" | "fixed_count" | "revolving"; } | ""; }; /** mandate_options_param */ @@ -48269,10 +52502,12 @@ export interface operations { requestor_challenge_indicator?: string; transaction_id: string; /** @enum {string} */ - version: "1.0.2" | "2.1.0" | "2.2.0"; + version: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1"; }; } | ""; card_present?: { + /** @enum {string} */ + capture_method?: "manual" | "manual_preferred"; request_extended_authorization?: boolean; request_incremental_authorization_support?: boolean; /** routing_payment_method_options_param */ @@ -48287,6 +52522,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; + crypto?: { + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; customer_balance?: { /** bank_transfer_param */ bank_transfer?: { @@ -48333,10 +52572,31 @@ export interface operations { klarna?: { /** @enum {string} */ capture_method?: "" | "manual"; + /** on_demand_param */ + on_demand?: { + average_amount?: number; + maximum_amount?: number; + minimum_amount?: number; + /** @enum {string} */ + purchase_interval?: "day" | "month" | "week" | "year"; + purchase_interval_count?: number; + }; /** @enum {string} */ preferred_locale?: "cs-CZ" | "da-DK" | "de-AT" | "de-CH" | "de-DE" | "el-GR" | "en-AT" | "en-AU" | "en-BE" | "en-CA" | "en-CH" | "en-CZ" | "en-DE" | "en-DK" | "en-ES" | "en-FI" | "en-FR" | "en-GB" | "en-GR" | "en-IE" | "en-IT" | "en-NL" | "en-NO" | "en-NZ" | "en-PL" | "en-PT" | "en-RO" | "en-SE" | "en-US" | "es-ES" | "es-US" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "it-CH" | "it-IT" | "nb-NO" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-PT" | "ro-RO" | "sv-FI" | "sv-SE"; /** @enum {string} */ - setup_future_usage?: "none"; + setup_future_usage?: "none" | "off_session" | "on_session"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing?: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; } | ""; konbini?: { confirmation_number?: string | ""; @@ -48358,6 +52618,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + mb_way?: { + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; mobilepay?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -48371,6 +52635,13 @@ export interface operations { naver_pay?: { /** @enum {string} */ capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; + nz_bank_account?: { + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; oxxo?: { expires_after_days?: number; @@ -48401,7 +52672,25 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + payto?: { + /** payment_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; pix?: { + /** @enum {string} */ + amount_includes_iof?: "always" | "never"; expires_after_seconds?: number; /** Format: unix-time */ expires_at?: number; @@ -48422,6 +52711,10 @@ export interface operations { /** @enum {string} */ capture_method?: "" | "manual"; } | ""; + satispay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -48429,6 +52722,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; sofort?: { /** @enum {string} */ @@ -48466,16 +52760,17 @@ export interface operations { requested?: ("ach" | "us_domestic_wire")[]; }; /** @enum {string} */ - preferred_settlement_speed?: "" | "fastest" | "standard"; - /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; + /** @enum {string} */ + transaction_purpose?: "" | "goods" | "other" | "services" | "unspecified"; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; wechat_pay?: { app_id?: string; /** @enum {string} */ - client: "android" | "ios" | "web"; + client?: "android" | "ios" | "web"; /** @enum {string} */ setup_future_usage?: "none"; } | ""; @@ -48484,18 +52779,18 @@ 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, Stripe will dynamically show relevant payment methods from your [payment method settings](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). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ payment_method_types?: string[]; /** - * radar_options_with_hidden_options - * @description Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). + * radar_options_with_peval_options + * @description Options to configure Radar. Learn more about [Radar Sessions](https://docs.stripe.com/radar/radar-session). */ radar_options?: { session?: string; }; /** @description Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ receipt_email?: 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. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). */ + /** @description The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). */ return_url?: string; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. @@ -48538,13 +52833,13 @@ export interface operations { /** * transfer_data_creation_params * @description The parameters that you can use to automatically create a Transfer. - * Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ transfer_data?: { amount?: number; destination: string; }; - /** @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). */ + /** @description A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). */ transfer_group?: string; /** @description Set to `true` when confirming server-side and using Stripe.js, iOS, or Android client-side SDKs to handle the next actions. */ use_stripe_sdk?: boolean; @@ -48581,7 +52876,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for payment intents](https://stripe.com/docs/search#query-fields-for-payment-intents). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment intents](https://docs.stripe.com/search#query-fields-for-payment-intents). */ query: string; }; header?: never; @@ -48678,9 +52973,59 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ + /** @description Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ amount?: number; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** @description Provides industry-specific information about the amount. */ + amount_details?: { + discount_amount?: number | ""; + enforce_arithmetic_validation?: boolean; + line_items?: { + discount_amount?: number; + /** amount_details_line_item_payment_method_options_param */ + payment_method_options?: { + /** payment_intent_amount_details_line_item_payment_method_options_param */ + card?: { + commodity_code?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + card_present?: { + commodity_code?: string; + }; + /** payment_intent_amount_details_line_item_payment_method_options_param */ + klarna?: { + image_url?: string; + product_url?: string; + reference?: string; + subscription_reference?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + paypal?: { + /** @enum {string} */ + category?: "digital_goods" | "donation" | "physical_goods"; + description?: string; + sold_by?: string; + }; + }; + product_code?: string; + product_name: string; + quantity: number; + /** amount_details_line_item_tax_param */ + tax?: { + total_tax_amount: number; + }; + unit_cost: number; + unit_of_measure?: string; + }[] | ""; + shipping?: { + amount?: number | ""; + from_postal_code?: string | ""; + to_postal_code?: string | ""; + } | ""; + tax?: { + total_tax_amount: number; + } | ""; + } | ""; + /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ application_fee_amount?: number | ""; /** * @description Controls when the funds will be captured from the customer's account. @@ -48697,25 +53042,53 @@ export interface operations { * * Payment methods attached to other Customers cannot be used with this PaymentIntent. * - * If [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. + * If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Customer instead. */ customer?: string; + /** + * @description ID of the Account representing the customer that this PaymentIntent belongs to, if one exists. + * + * Payment methods attached to other Accounts cannot be used with this PaymentIntent. + * + * If [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Account after the PaymentIntent has been confirmed and any required actions from the user are complete. If the payment method is `card_present` and isn't a digital wallet, then a [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card is created and attached to the Account instead. + */ + customer_account?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; + /** @description The list of payment method types to exclude from use with this payment. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; /** @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`. */ + /** + * async_workflows_param + * @description Automations to be run during the PaymentIntent lifecycle + */ + hooks?: { + /** async_workflows_inputs_param */ + inputs?: { + /** async_workflows_inputs_tax_param */ + tax?: { + calculation: string | ""; + }; + }; + }; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 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. */ + /** @description Provides industry-specific information about the charge. */ + payment_details?: { + customer_reference?: string | ""; + order_reference?: string | ""; + } | ""; + /** @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/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](https://stripe.com/docs/api/payment_method_configurations) to use with this PaymentIntent. */ + /** @description The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. */ payment_method_configuration?: string; /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - * in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + * in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) * property on the PaymentIntent. */ payment_method_data?: { @@ -48749,6 +53122,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -48762,6 +53137,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -48772,6 +53148,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -48790,7 +53168,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -48811,6 +53189,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -48824,6 +53204,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -48839,6 +53228,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -48851,6 +53246,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -48864,7 +53261,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -48897,6 +53294,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; @@ -48931,6 +53329,7 @@ export interface operations { au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ @@ -48939,6 +53338,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; bancontact?: { /** @enum {string} */ @@ -48946,6 +53346,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + billie?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; blik?: { code?: string; /** @enum {string} */ @@ -48968,7 +53372,7 @@ export interface operations { /** @enum {string} */ interval?: "month"; /** @enum {string} */ - type: "fixed_count"; + type: "bonus" | "fixed_count" | "revolving"; } | ""; }; /** mandate_options_param */ @@ -49026,10 +53430,12 @@ export interface operations { requestor_challenge_indicator?: string; transaction_id: string; /** @enum {string} */ - version: "1.0.2" | "2.1.0" | "2.2.0"; + version: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1"; }; } | ""; card_present?: { + /** @enum {string} */ + capture_method?: "manual" | "manual_preferred"; request_extended_authorization?: boolean; request_incremental_authorization_support?: boolean; /** routing_payment_method_options_param */ @@ -49044,6 +53450,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; + crypto?: { + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; customer_balance?: { /** bank_transfer_param */ bank_transfer?: { @@ -49090,10 +53500,31 @@ export interface operations { klarna?: { /** @enum {string} */ capture_method?: "" | "manual"; + /** on_demand_param */ + on_demand?: { + average_amount?: number; + maximum_amount?: number; + minimum_amount?: number; + /** @enum {string} */ + purchase_interval?: "day" | "month" | "week" | "year"; + purchase_interval_count?: number; + }; /** @enum {string} */ preferred_locale?: "cs-CZ" | "da-DK" | "de-AT" | "de-CH" | "de-DE" | "el-GR" | "en-AT" | "en-AU" | "en-BE" | "en-CA" | "en-CH" | "en-CZ" | "en-DE" | "en-DK" | "en-ES" | "en-FI" | "en-FR" | "en-GB" | "en-GR" | "en-IE" | "en-IT" | "en-NL" | "en-NO" | "en-NZ" | "en-PL" | "en-PT" | "en-RO" | "en-SE" | "en-US" | "es-ES" | "es-US" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "it-CH" | "it-IT" | "nb-NO" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-PT" | "ro-RO" | "sv-FI" | "sv-SE"; /** @enum {string} */ - setup_future_usage?: "none"; + setup_future_usage?: "none" | "off_session" | "on_session"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing?: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; } | ""; konbini?: { confirmation_number?: string | ""; @@ -49115,6 +53546,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + mb_way?: { + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; mobilepay?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -49128,6 +53563,13 @@ export interface operations { naver_pay?: { /** @enum {string} */ capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; + nz_bank_account?: { + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; oxxo?: { expires_after_days?: number; @@ -49158,7 +53600,25 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + payto?: { + /** payment_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; pix?: { + /** @enum {string} */ + amount_includes_iof?: "always" | "never"; expires_after_seconds?: number; /** Format: unix-time */ expires_at?: number; @@ -49179,6 +53639,10 @@ export interface operations { /** @enum {string} */ capture_method?: "" | "manual"; } | ""; + satispay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -49186,6 +53650,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; sofort?: { /** @enum {string} */ @@ -49223,16 +53688,17 @@ export interface operations { requested?: ("ach" | "us_domestic_wire")[]; }; /** @enum {string} */ - preferred_settlement_speed?: "" | "fastest" | "standard"; - /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; + /** @enum {string} */ + transaction_purpose?: "" | "goods" | "other" | "services" | "unspecified"; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; wechat_pay?: { app_id?: string; /** @enum {string} */ - client: "android" | "ios" | "web"; + client?: "android" | "ios" | "web"; /** @enum {string} */ setup_future_usage?: "none"; } | ""; @@ -49241,7 +53707,7 @@ export interface operations { setup_future_usage?: "none"; } | ""; }; - /** @description The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). */ + /** @description The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ payment_method_types?: string[]; /** @description Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails). */ receipt_email?: string | ""; @@ -49284,12 +53750,12 @@ export interface operations { statement_descriptor_suffix?: string; /** * transfer_data_update_params - * @description Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * @description Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ transfer_data?: { amount?: number; }; - /** @description A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** @description A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ transfer_group?: string; }; }; @@ -49315,6 +53781,62 @@ export interface operations { }; }; }; + GetPaymentIntentsIntentAmountDetailsLineItems: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @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: { + intent: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Details about each object. */ + data: components["schemas"]["payment_intent_amount_details_line_item"][]; + /** @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"]; + }; + }; + }; + }; PostPaymentIntentsIntentApplyCustomerBalance: { parameters: { query?: never; @@ -49330,7 +53852,7 @@ export interface operations { /** * @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://docs.stripe.com/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. */ @@ -49421,18 +53943,89 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided. */ + /** + * amount_details_param + * @description Provides industry-specific information about the amount. + */ + amount_details?: { + discount_amount?: number | ""; + enforce_arithmetic_validation?: boolean; + line_items?: { + discount_amount?: number; + /** amount_details_line_item_payment_method_options_param */ + payment_method_options?: { + /** payment_intent_amount_details_line_item_payment_method_options_param */ + card?: { + commodity_code?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + card_present?: { + commodity_code?: string; + }; + /** payment_intent_amount_details_line_item_payment_method_options_param */ + klarna?: { + image_url?: string; + product_url?: string; + reference?: string; + subscription_reference?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + paypal?: { + /** @enum {string} */ + category?: "digital_goods" | "donation" | "physical_goods"; + description?: string; + sold_by?: string; + }; + }; + product_code?: string; + product_name: string; + quantity: number; + /** amount_details_line_item_tax_param */ + tax?: { + total_tax_amount: number; + }; + unit_cost: number; + unit_of_measure?: string; + }[] | ""; + shipping?: { + amount?: number | ""; + from_postal_code?: string | ""; + to_postal_code?: string | ""; + } | ""; + tax?: { + total_tax_amount: number; + } | ""; + }; + /** @description The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Defaults to the full `amount_capturable` if it's not provided. */ amount_to_capture?: number; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ application_fee_amount?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents. */ + /** @description Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://docs.stripe.com/payments/multicapture) is available for PaymentIntents. */ final_capture?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + /** + * async_workflows_param + * @description Automations to be run during the PaymentIntent lifecycle + */ + hooks?: { + /** async_workflows_inputs_param */ + inputs?: { + /** async_workflows_inputs_tax_param */ + tax?: { + calculation: string | ""; + }; + }; + }; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Provides industry-specific information about the charge. */ + payment_details?: { + customer_reference?: string | ""; + order_reference?: string | ""; + } | ""; /** * @description Text that appears on the customer's statement as the statement descriptor for a non-card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). * @@ -49442,9 +54035,9 @@ export interface operations { /** @description Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. */ statement_descriptor_suffix?: string; /** - * transfer_data_update_params + * transfer_data_capture_params * @description The parameters that you can use to automatically create a transfer after the payment - * is captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * is captured. Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ transfer_data?: { amount?: number; @@ -49485,6 +54078,56 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** @description Provides industry-specific information about the amount. */ + amount_details?: { + discount_amount?: number | ""; + enforce_arithmetic_validation?: boolean; + line_items?: { + discount_amount?: number; + /** amount_details_line_item_payment_method_options_param */ + payment_method_options?: { + /** payment_intent_amount_details_line_item_payment_method_options_param */ + card?: { + commodity_code?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + card_present?: { + commodity_code?: string; + }; + /** payment_intent_amount_details_line_item_payment_method_options_param */ + klarna?: { + image_url?: string; + product_url?: string; + reference?: string; + subscription_reference?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + paypal?: { + /** @enum {string} */ + category?: "digital_goods" | "donation" | "physical_goods"; + description?: string; + sold_by?: string; + }; + }; + product_code?: string; + product_name: string; + quantity: number; + /** amount_details_line_item_tax_param */ + tax?: { + total_tax_amount: number; + }; + unit_cost: number; + unit_of_measure?: string; + }[] | ""; + shipping?: { + amount?: number | ""; + from_postal_code?: string | ""; + to_postal_code?: string | ""; + } | ""; + tax?: { + total_tax_amount: number; + } | ""; + } | ""; /** * @description Controls when the funds will be captured from the customer's account. * @enum {string} @@ -49498,10 +54141,25 @@ export interface operations { * If the provided ConfirmationToken contains properties that are also being provided in this request, such as `payment_method`, then the values in this request will take precedence. */ confirmation_token?: string; - /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ + /** @description Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://docs.stripe.com/payments/save-card-without-authentication). */ error_on_requires_action?: boolean; + /** @description The list of payment method types to exclude from use with this payment. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * async_workflows_param + * @description Automations to be run during the PaymentIntent lifecycle + */ + hooks?: { + /** async_workflows_inputs_param */ + inputs?: { + /** async_workflows_inputs_tax_param */ + tax?: { + calculation: string | ""; + }; + }; + }; /** @description ID of the mandate that's used for this payment. */ mandate?: string; mandate_data?: { @@ -49531,14 +54189,22 @@ export interface operations { type: "online"; }; }; - /** @description Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). */ + /** @description Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://docs.stripe.com/payments/cards/charging-saved-cards). */ off_session?: boolean | ("one_off" | "recurring"); - /** @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. */ + /** @description Provides industry-specific information about the charge. */ + payment_details?: { + customer_reference?: string | ""; + order_reference?: string | ""; + } | ""; + /** + * @description ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + * If the payment method is attached to a Customer, it must match the [customer](https://api.stripe.com#create_payment_intent-customer) that is set on this PaymentIntent. + */ payment_method?: string; /** * payment_method_data_params * @description If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear - * in the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + * in the [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) * property on the PaymentIntent. */ payment_method_data?: { @@ -49572,6 +54238,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -49585,6 +54253,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -49595,6 +54264,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -49613,7 +54284,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -49634,6 +54305,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -49647,6 +54320,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -49662,6 +54344,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -49674,6 +54362,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -49687,7 +54377,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -49720,6 +54410,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; @@ -49754,6 +54445,7 @@ export interface operations { au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; bacs_debit?: { /** payment_method_options_mandate_options_param */ @@ -49762,6 +54454,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; bancontact?: { /** @enum {string} */ @@ -49769,6 +54462,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + billie?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; blik?: { code?: string; /** @enum {string} */ @@ -49791,7 +54488,7 @@ export interface operations { /** @enum {string} */ interval?: "month"; /** @enum {string} */ - type: "fixed_count"; + type: "bonus" | "fixed_count" | "revolving"; } | ""; }; /** mandate_options_param */ @@ -49849,10 +54546,12 @@ export interface operations { requestor_challenge_indicator?: string; transaction_id: string; /** @enum {string} */ - version: "1.0.2" | "2.1.0" | "2.2.0"; + version: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1"; }; } | ""; card_present?: { + /** @enum {string} */ + capture_method?: "manual" | "manual_preferred"; request_extended_authorization?: boolean; request_incremental_authorization_support?: boolean; /** routing_payment_method_options_param */ @@ -49867,6 +54566,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; } | ""; + crypto?: { + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; customer_balance?: { /** bank_transfer_param */ bank_transfer?: { @@ -49913,10 +54616,31 @@ export interface operations { klarna?: { /** @enum {string} */ capture_method?: "" | "manual"; + /** on_demand_param */ + on_demand?: { + average_amount?: number; + maximum_amount?: number; + minimum_amount?: number; + /** @enum {string} */ + purchase_interval?: "day" | "month" | "week" | "year"; + purchase_interval_count?: number; + }; /** @enum {string} */ preferred_locale?: "cs-CZ" | "da-DK" | "de-AT" | "de-CH" | "de-DE" | "el-GR" | "en-AT" | "en-AU" | "en-BE" | "en-CA" | "en-CH" | "en-CZ" | "en-DE" | "en-DK" | "en-ES" | "en-FI" | "en-FR" | "en-GB" | "en-GR" | "en-IE" | "en-IT" | "en-NL" | "en-NO" | "en-NZ" | "en-PL" | "en-PT" | "en-RO" | "en-SE" | "en-US" | "es-ES" | "es-US" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "it-CH" | "it-IT" | "nb-NO" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-PT" | "ro-RO" | "sv-FI" | "sv-SE"; /** @enum {string} */ - setup_future_usage?: "none"; + setup_future_usage?: "none" | "off_session" | "on_session"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing?: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; } | ""; konbini?: { confirmation_number?: string | ""; @@ -49938,6 +54662,10 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + mb_way?: { + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; mobilepay?: { /** @enum {string} */ capture_method?: "" | "manual"; @@ -49951,6 +54679,13 @@ export interface operations { naver_pay?: { /** @enum {string} */ capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; + nz_bank_account?: { + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; oxxo?: { expires_after_days?: number; @@ -49981,7 +54716,25 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + payto?: { + /** payment_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; pix?: { + /** @enum {string} */ + amount_includes_iof?: "always" | "never"; expires_after_seconds?: number; /** Format: unix-time */ expires_at?: number; @@ -50002,6 +54755,10 @@ export interface operations { /** @enum {string} */ capture_method?: "" | "manual"; } | ""; + satispay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + } | ""; sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -50009,6 +54766,7 @@ export interface operations { }; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; } | ""; sofort?: { /** @enum {string} */ @@ -50046,16 +54804,17 @@ export interface operations { requested?: ("ach" | "us_domestic_wire")[]; }; /** @enum {string} */ - preferred_settlement_speed?: "" | "fastest" | "standard"; - /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; + target_date?: string; + /** @enum {string} */ + transaction_purpose?: "" | "goods" | "other" | "services" | "unspecified"; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; wechat_pay?: { app_id?: string; /** @enum {string} */ - client: "android" | "ios" | "web"; + client?: "android" | "ios" | "web"; /** @enum {string} */ setup_future_usage?: "none"; } | ""; @@ -50064,11 +54823,11 @@ export interface operations { setup_future_usage?: "none"; } | ""; }; - /** @description The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). */ + /** @description The list of payment method types (for example, a card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ payment_method_types?: string[]; /** - * radar_options_with_hidden_options - * @description Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session). + * radar_options_with_peval_options + * @description Options to configure Radar. Learn more about [Radar Sessions](https://docs.stripe.com/radar/radar-session). */ radar_options?: { session?: string; @@ -50150,22 +54909,96 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount. */ amount: number; - /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). */ + /** + * amount_details_param + * @description Provides industry-specific information about the amount. + */ + amount_details?: { + discount_amount?: number | ""; + enforce_arithmetic_validation?: boolean; + line_items?: { + discount_amount?: number; + /** amount_details_line_item_payment_method_options_param */ + payment_method_options?: { + /** payment_intent_amount_details_line_item_payment_method_options_param */ + card?: { + commodity_code?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + card_present?: { + commodity_code?: string; + }; + /** payment_intent_amount_details_line_item_payment_method_options_param */ + klarna?: { + image_url?: string; + product_url?: string; + reference?: string; + subscription_reference?: string; + }; + /** amount_details_line_item_payment_method_options_param */ + paypal?: { + /** @enum {string} */ + category?: "digital_goods" | "donation" | "physical_goods"; + description?: string; + sold_by?: string; + }; + }; + product_code?: string; + product_name: string; + quantity: number; + /** amount_details_line_item_tax_param */ + tax?: { + total_tax_amount: number; + }; + unit_cost: number; + unit_of_measure?: string; + }[] | ""; + shipping?: { + amount?: number | ""; + from_postal_code?: string | ""; + to_postal_code?: string | ""; + } | ""; + tax?: { + total_tax_amount: number; + } | ""; + }; + /** @description The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total amount captured. For more information, see the PaymentIntents [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ application_fee_amount?: number; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; /** @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`. */ + /** + * async_workflows_param + * @description Automations to be run during the PaymentIntent lifecycle + */ + hooks?: { + /** async_workflows_inputs_param */ + inputs?: { + /** async_workflows_inputs_tax_param */ + tax?: { + calculation: string | ""; + }; + }; + }; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; + /** + * payment_details_order_customer_reference_param + * @description Provides industry-specific information about the charge. + */ + payment_details?: { + customer_reference?: string | ""; + order_reference?: string | ""; + }; /** @description Text that appears on the customer's statement as the statement descriptor for a non-card or card charge. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). */ statement_descriptor?: string; /** - * transfer_data_update_params + * transfer_data_update_auth_params * @description The parameters used to automatically create a transfer after the payment is captured. - * Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts). + * Learn more about the [use case for connected accounts](https://docs.stripe.com/payments/connected-accounts). */ transfer_data?: { amount?: number; @@ -50363,10 +55196,11 @@ export interface operations { * @description Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies) and supported by each line item's price. */ currency?: string; - /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. */ custom_fields?: { /** custom_field_dropdown_param */ dropdown?: { + default_value?: string; options: { label: string; value: string; @@ -50381,12 +55215,14 @@ export interface operations { }; /** custom_field_numeric_param */ numeric?: { + default_value?: string; maximum_length?: number; minimum_length?: number; }; optional?: boolean; /** custom_field_text_param */ text?: { + default_value?: string; maximum_length?: number; minimum_length?: number; }; @@ -50395,7 +55231,7 @@ export interface operations { }[]; /** * custom_text_param - * @description Display additional text for your customers using custom text. + * @description Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`. */ custom_text?: { after_submit?: { @@ -50412,7 +55248,7 @@ export interface operations { } | ""; }; /** - * @description Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). + * @description Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers). * @enum {string} */ customer_creation?: "always" | "if_required"; @@ -50447,6 +55283,7 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; }; @@ -50458,15 +55295,74 @@ export interface operations { maximum?: number; minimum?: number; }; - price: string; + price?: string; + /** custom_amount_price_data_with_product_data */ + price_data?: { + /** Format: currency */ + currency: string; + product?: string; + /** product_data */ + product_data?: { + description?: string; + images?: string[]; + metadata?: { + [key: string]: string; + }; + name: string; + tax_code?: string; + unit_label?: string; + }; + /** recurring_adhoc */ + recurring?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; quantity: number; }[]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. */ metadata?: { [key: string]: string; }; + /** + * name_collection_params + * @description Controls settings applied for collecting the customer's name. + */ + name_collection?: { + /** name_collection_business_params */ + business?: { + enabled: boolean; + optional?: boolean; + }; + /** name_collection_individual_params */ + individual?: { + enabled: boolean; + optional?: boolean; + }; + }; /** @description The account on behalf of which to charge. */ on_behalf_of?: string; + /** + * @description A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). + * There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. + * There is a maximum of 20 combined line items and optional items. + */ + optional_items?: { + /** optional_item_adjustable_quantity_params */ + adjustable_quantity?: { + enabled: boolean; + maximum?: number; + minimum?: number; + }; + price: string; + quantity: number; + }[]; /** * payment_intent_data_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. @@ -50489,12 +55385,12 @@ export interface operations { * * Can only be set in `subscription` mode. Defaults to `always`. * - * If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). + * If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials). * @enum {string} */ 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" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; + /** @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://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support)). */ + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mb_way" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -50521,12 +55417,12 @@ 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" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; }; - /** @description The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ + /** @description The shipping rate options to apply to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. */ shipping_options?: { shipping_rate?: string; }[]; /** - * @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`). + * @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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). * @enum {string} */ submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe"; @@ -50687,10 +55583,11 @@ export interface operations { * @enum {string} */ billing_address_collection?: "auto" | "required"; - /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. You can't set this parameter if `ui_mode` is `custom`. */ custom_fields?: { /** custom_field_dropdown_param */ dropdown?: { + default_value?: string; options: { label: string; value: string; @@ -50705,12 +55602,14 @@ export interface operations { }; /** custom_field_numeric_param */ numeric?: { + default_value?: string; maximum_length?: number; minimum_length?: number; }; optional?: boolean; /** custom_field_text_param */ text?: { + default_value?: string; maximum_length?: number; minimum_length?: number; }; @@ -50719,7 +55618,7 @@ export interface operations { }[] | ""; /** * custom_text_param - * @description Display additional text for your customers using custom text. + * @description Display additional text for your customers using custom text. You can't set this parameter if `ui_mode` is `custom`. */ custom_text?: { after_submit?: { @@ -50736,7 +55635,7 @@ export interface operations { } | ""; }; /** - * @description Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers). + * @description Configures whether [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a [Customer](https://docs.stripe.com/api/customers). * @enum {string} */ customer_creation?: "always" | "if_required"; @@ -50771,6 +55670,7 @@ export interface operations { rendering_options?: { /** @enum {string} */ amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + template?: string; } | ""; }; }; @@ -50785,10 +55685,38 @@ export interface operations { id: string; quantity?: number; }[]; - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. */ metadata?: { [key: string]: string; }; + /** @description Controls settings applied for collecting the customer's name. */ + name_collection?: { + /** name_collection_business_params */ + business?: { + enabled: boolean; + optional?: boolean; + }; + /** name_collection_individual_params */ + individual?: { + enabled: boolean; + optional?: boolean; + }; + } | ""; + /** + * @description A list of optional items the customer can add to their order at checkout. Use this parameter to pass one-time or recurring [Prices](https://docs.stripe.com/api/prices). + * There is a maximum of 10 optional items allowed on a payment link, and the existing limits on the number of line items allowed on a payment link apply to the combined number of line items and optional items. + * There is a maximum of 20 combined line items and optional items. + */ + optional_items?: { + /** optional_item_adjustable_quantity_params */ + adjustable_quantity?: { + enabled: boolean; + maximum?: number; + minimum?: number; + }; + price: string; + quantity: number; + }[] | ""; /** * payment_intent_data_update_params * @description A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode. @@ -50807,12 +55735,12 @@ export interface operations { * * Can only be set in `subscription` mode. Defaults to `always`. * - * If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). + * If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://docs.stripe.com/payments/checkout/free-trials). * @enum {string} */ 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" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "alma" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mb_way" | "mobilepay" | "multibanco" | "oxxo" | "p24" | "pay_by_bank" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -50834,7 +55762,7 @@ export interface operations { 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" | "SD" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; } | ""; /** - * @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`). + * @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://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). * @enum {string} */ submit_type?: "auto" | "book" | "donate" | "pay" | "subscribe"; @@ -51020,7 +55948,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * payment_method_param - * @description Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + * @description Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. */ acss_debit?: { /** display_preference_param */ @@ -51031,7 +55959,7 @@ export interface operations { }; /** * payment_method_param - * @description [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. + * @description [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. */ affirm?: { /** display_preference_param */ @@ -51042,7 +55970,7 @@ export interface operations { }; /** * payment_method_param - * @description Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. + * @description Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. */ afterpay_clearpay?: { /** display_preference_param */ @@ -51053,7 +55981,7 @@ export interface operations { }; /** * payment_method_param - * @description Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. + * @description Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. */ alipay?: { /** display_preference_param */ @@ -51086,7 +56014,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + * @description Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. */ apple_pay?: { /** display_preference_param */ @@ -51108,7 +56036,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. + * @description Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. */ au_becs_debit?: { /** display_preference_param */ @@ -51119,7 +56047,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. + * @description Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. */ bacs_debit?: { /** display_preference_param */ @@ -51130,7 +56058,7 @@ export interface operations { }; /** * payment_method_param - * @description Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. + * @description Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. */ bancontact?: { /** display_preference_param */ @@ -51141,7 +56069,18 @@ export interface operations { }; /** * payment_method_param - * @description BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. + * @description Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. + */ + billie?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. */ blik?: { /** display_preference_param */ @@ -51152,7 +56091,7 @@ export interface operations { }; /** * payment_method_param - * @description Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. + * @description Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. */ boleto?: { /** display_preference_param */ @@ -51174,7 +56113,7 @@ export interface operations { }; /** * payment_method_param - * @description Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. + * @description Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. */ cartes_bancaires?: { /** display_preference_param */ @@ -51185,7 +56124,7 @@ export interface operations { }; /** * payment_method_param - * @description Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. + * @description Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. */ cashapp?: { /** display_preference_param */ @@ -51196,7 +56135,18 @@ export interface operations { }; /** * payment_method_param - * @description Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + * @description [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. + */ + crypto?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Uses a customer’s [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. */ customer_balance?: { /** display_preference_param */ @@ -51207,7 +56157,7 @@ export interface operations { }; /** * payment_method_param - * @description EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. + * @description EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://docs.stripe.com/payments/eps) for more details. */ eps?: { /** display_preference_param */ @@ -51220,7 +56170,7 @@ export interface operations { expand?: string[]; /** * payment_method_param - * @description Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. + * @description Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. */ fpx?: { /** display_preference_param */ @@ -51231,7 +56181,18 @@ export interface operations { }; /** * payment_method_param - * @description giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. + * @description Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) for more details. + */ + fr_meal_voucher_conecs?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. */ giropay?: { /** display_preference_param */ @@ -51242,7 +56203,7 @@ export interface operations { }; /** * payment_method_param - * @description Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. + * @description Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. */ google_pay?: { /** display_preference_param */ @@ -51253,7 +56214,7 @@ export interface operations { }; /** * payment_method_param - * @description GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. + * @description GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. */ grabpay?: { /** display_preference_param */ @@ -51264,7 +56225,7 @@ export interface operations { }; /** * payment_method_param - * @description iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. + * @description iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. */ ideal?: { /** display_preference_param */ @@ -51286,7 +56247,18 @@ export interface operations { }; /** * payment_method_param - * @description Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. + * @description Kakao Pay is a popular local wallet available in South Korea. + */ + kakao_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. */ klarna?: { /** display_preference_param */ @@ -51297,7 +56269,7 @@ export interface operations { }; /** * payment_method_param - * @description Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. + * @description Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. */ konbini?: { /** display_preference_param */ @@ -51308,7 +56280,18 @@ export interface operations { }; /** * payment_method_param - * @description [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. + * @description Korean cards let users pay using locally issued cards from South Korea. + */ + kr_card?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. */ link?: { /** display_preference_param */ @@ -51319,7 +56302,18 @@ export interface operations { }; /** * payment_method_param - * @description MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + * @description MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. + */ + mb_way?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. */ mobilepay?: { /** display_preference_param */ @@ -51343,7 +56337,29 @@ export interface operations { name?: string; /** * payment_method_param - * @description OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. + * @description Naver Pay is a popular local wallet available in South Korea. + */ + naver_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. + */ + nz_bank_account?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. */ oxxo?: { /** display_preference_param */ @@ -51354,7 +56370,7 @@ export interface operations { }; /** * payment_method_param - * @description Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. + * @description Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://docs.stripe.com/payments/p24) for more details. */ p24?: { /** display_preference_param */ @@ -51378,7 +56394,18 @@ export interface operations { }; /** * payment_method_param - * @description PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. + * @description PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + */ + payco?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. */ paynow?: { /** display_preference_param */ @@ -51389,7 +56416,7 @@ export interface operations { }; /** * payment_method_param - * @description PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. + * @description PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. */ paypal?: { /** display_preference_param */ @@ -51400,7 +56427,29 @@ export interface operations { }; /** * payment_method_param - * @description PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. + * @description PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. + */ + payto?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details. + */ + pix?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. */ promptpay?: { /** display_preference_param */ @@ -51422,7 +56471,29 @@ export interface operations { }; /** * payment_method_param - * @description The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. + * @description Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + */ + samsung_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. + */ + satispay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. */ sepa_debit?: { /** display_preference_param */ @@ -51433,7 +56504,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. + * @description Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. */ sofort?: { /** display_preference_param */ @@ -51444,7 +56515,7 @@ export interface operations { }; /** * payment_method_param - * @description Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + * @description Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. */ swish?: { /** display_preference_param */ @@ -51466,7 +56537,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-direct-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://docs.stripe.com/payments/ach-direct-debit) for more details. */ us_bank_account?: { /** display_preference_param */ @@ -51477,7 +56548,7 @@ export interface operations { }; /** * payment_method_param - * @description WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. + * @description WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. */ wechat_pay?: { /** display_preference_param */ @@ -51488,7 +56559,7 @@ export interface operations { }; /** * payment_method_param - * @description Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + * @description Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. */ zip?: { /** display_preference_param */ @@ -51573,7 +56644,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** * payment_method_param - * @description Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability. + * @description Canadian pre-authorized debit payments, check this [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. */ acss_debit?: { /** display_preference_param */ @@ -51586,7 +56657,7 @@ export interface operations { active?: boolean; /** * payment_method_param - * @description [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability. + * @description [Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://docs.stripe.com/payments/affirm) for more details like country availability. */ affirm?: { /** display_preference_param */ @@ -51597,7 +56668,7 @@ export interface operations { }; /** * payment_method_param - * @description Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. + * @description Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. */ afterpay_clearpay?: { /** display_preference_param */ @@ -51608,7 +56679,7 @@ export interface operations { }; /** * payment_method_param - * @description Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details. + * @description Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://docs.stripe.com/payments/alipay) for more details. */ alipay?: { /** display_preference_param */ @@ -51641,7 +56712,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. + * @description Stripe users can accept [Apple Pay](https://stripe.com/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](https://stripe.com/pricing) is the same as other card transactions. Check this [page](https://docs.stripe.com/apple-pay) for more details. */ apple_pay?: { /** display_preference_param */ @@ -51663,7 +56734,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details. + * @description Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://docs.stripe.com/payments/au-becs-debit) for more details. */ au_becs_debit?: { /** display_preference_param */ @@ -51674,7 +56745,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details. + * @description Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. */ bacs_debit?: { /** display_preference_param */ @@ -51685,7 +56756,7 @@ export interface operations { }; /** * payment_method_param - * @description Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details. + * @description Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://docs.stripe.com/payments/bancontact) for more details. */ bancontact?: { /** display_preference_param */ @@ -51696,7 +56767,18 @@ export interface operations { }; /** * payment_method_param - * @description BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details. + * @description Billie is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method that offers businesses Pay by Invoice where they offer payment terms ranging from 7-120 days. Customers are redirected from your website or app, authorize the payment with Billie, then return to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. + */ + billie?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description BLIK is a [single use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://docs.stripe.com/payments/blik) for more details. */ blik?: { /** display_preference_param */ @@ -51707,7 +56789,7 @@ export interface operations { }; /** * payment_method_param - * @description Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details. + * @description Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://docs.stripe.com/payments/boleto) for more details. */ boleto?: { /** display_preference_param */ @@ -51729,7 +56811,7 @@ export interface operations { }; /** * payment_method_param - * @description Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details. + * @description Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. */ cartes_bancaires?: { /** display_preference_param */ @@ -51740,7 +56822,7 @@ export interface operations { }; /** * payment_method_param - * @description Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details. + * @description Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://docs.stripe.com/payments/cash-app-pay) for more details. */ cashapp?: { /** display_preference_param */ @@ -51751,7 +56833,18 @@ export interface operations { }; /** * payment_method_param - * @description Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + * @description [Stablecoin payments](https://docs.stripe.com/payments/stablecoin-payments) enable customers to pay in stablecoins like USDC from 100s of wallets including Phantom and Metamask. + */ + crypto?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Uses a customer’s [cash balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://docs.stripe.com/payments/bank-transfers) for more details. */ customer_balance?: { /** display_preference_param */ @@ -51762,7 +56855,7 @@ export interface operations { }; /** * payment_method_param - * @description EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. + * @description EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://docs.stripe.com/payments/eps) for more details. */ eps?: { /** display_preference_param */ @@ -51775,7 +56868,7 @@ export interface operations { expand?: string[]; /** * payment_method_param - * @description Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details. + * @description Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://docs.stripe.com/payments/fpx) for more details. */ fpx?: { /** display_preference_param */ @@ -51786,7 +56879,18 @@ export interface operations { }; /** * payment_method_param - * @description giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details. + * @description Meal vouchers in France, or “titres-restaurant”, is a local benefits program commonly offered by employers for their employees to purchase prepared food and beverages on working days. Check this [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) for more details. + */ + fr_meal_voucher_conecs?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://docs.stripe.com/payments/giropay) for more details. */ giropay?: { /** display_preference_param */ @@ -51797,7 +56901,7 @@ export interface operations { }; /** * payment_method_param - * @description Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details. + * @description Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://docs.stripe.com/google-pay) for more details. */ google_pay?: { /** display_preference_param */ @@ -51808,7 +56912,7 @@ export interface operations { }; /** * payment_method_param - * @description GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details. + * @description GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://docs.stripe.com/payments/grabpay) for more details. */ grabpay?: { /** display_preference_param */ @@ -51819,7 +56923,7 @@ export interface operations { }; /** * payment_method_param - * @description iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details. + * @description iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://docs.stripe.com/payments/ideal) for more details. */ ideal?: { /** display_preference_param */ @@ -51841,7 +56945,18 @@ export interface operations { }; /** * payment_method_param - * @description Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details. + * @description Kakao Pay is a popular local wallet available in South Korea. + */ + kakao_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Klarna gives customers a range of [payment options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://docs.stripe.com/payments/klarna) for more details. */ klarna?: { /** display_preference_param */ @@ -51852,7 +56967,7 @@ export interface operations { }; /** * payment_method_param - * @description Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details. + * @description Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://docs.stripe.com/payments/konbini) for more details. */ konbini?: { /** display_preference_param */ @@ -51863,7 +56978,18 @@ export interface operations { }; /** * payment_method_param - * @description [Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. + * @description Korean cards let users pay using locally issued cards from South Korea. + */ + kr_card?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. */ link?: { /** display_preference_param */ @@ -51874,7 +57000,18 @@ export interface operations { }; /** * payment_method_param - * @description MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + * @description MB WAY is the most popular wallet in Portugal. After entering their phone number in your checkout, customers approve the payment directly in their MB WAY app. Check this [page](https://docs.stripe.com/payments/mb-way) for more details. + */ + mb_way?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description MobilePay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://docs.stripe.com/payments/mobilepay) for more details. */ mobilepay?: { /** display_preference_param */ @@ -51898,7 +57035,29 @@ export interface operations { name?: string; /** * payment_method_param - * @description OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details. + * @description Naver Pay is a popular local wallet available in South Korea. + */ + naver_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Stripe users in New Zealand can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with a New Zeland bank account. Check this [page](https://docs.stripe.com/payments/nz-bank-account) for more details. + */ + nz_bank_account?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://docs.stripe.com/payments/oxxo) for more details. */ oxxo?: { /** display_preference_param */ @@ -51909,7 +57068,7 @@ export interface operations { }; /** * payment_method_param - * @description Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details. + * @description Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://docs.stripe.com/payments/p24) for more details. */ p24?: { /** display_preference_param */ @@ -51931,7 +57090,18 @@ export interface operations { }; /** * payment_method_param - * @description PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details. + * @description PAYCO is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + */ + payco?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://docs.stripe.com/payments/paynow) for more details. */ paynow?: { /** display_preference_param */ @@ -51942,7 +57112,7 @@ export interface operations { }; /** * payment_method_param - * @description PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details. + * @description PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://docs.stripe.com/payments/paypal) for more details. */ paypal?: { /** display_preference_param */ @@ -51953,7 +57123,29 @@ export interface operations { }; /** * payment_method_param - * @description PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details. + * @description PayTo is a [real-time](https://docs.stripe.com/payments/real-time) payment method that enables customers in Australia to pay by providing their bank account details. Customers must accept a mandate authorizing you to debit their account. Check this [page](https://docs.stripe.com/payments/payto) for more details. + */ + payto?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Pix is a payment method popular in Brazil. When paying with Pix, customers authenticate and approve payments by scanning a QR code in their preferred banking app. Check this [page](https://docs.stripe.com/payments/pix) for more details. + */ + pix?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://docs.stripe.com/payments/promptpay) for more details. */ promptpay?: { /** display_preference_param */ @@ -51975,7 +57167,29 @@ export interface operations { }; /** * payment_method_param - * @description The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. + * @description Samsung Pay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage local wallet available in South Korea. + */ + samsung_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description Satispay is a [single-use](https://docs.stripe.com/payments/payment-methods#usage) payment method where customers are required to [authenticate](/payments/payment-methods#customer-actions) their payment. Customers pay by being redirected from your website or app, authorizing the payment with Satispay, then returning to your website or app. You get [immediate notification](/payments/payment-methods#payment-notification) of whether the payment succeeded or failed. + */ + satispay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; + /** + * payment_method_param + * @description The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://docs.stripe.com/payments/sepa-debit) for more details. */ sepa_debit?: { /** display_preference_param */ @@ -51986,7 +57200,7 @@ export interface operations { }; /** * payment_method_param - * @description Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details. + * @description Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://docs.stripe.com/payments/sofort) for more details. */ sofort?: { /** display_preference_param */ @@ -51997,7 +57211,7 @@ export interface operations { }; /** * payment_method_param - * @description Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + * @description Swish is a [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://docs.stripe.com/payments/swish) for more details. */ swish?: { /** display_preference_param */ @@ -52019,7 +57233,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-direct-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://docs.stripe.com/payments/ach-direct-debit) for more details. */ us_bank_account?: { /** display_preference_param */ @@ -52030,7 +57244,7 @@ export interface operations { }; /** * payment_method_param - * @description WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details. + * @description WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://docs.stripe.com/payments/wechat-pay) for more details. */ wechat_pay?: { /** display_preference_param */ @@ -52041,7 +57255,7 @@ export interface operations { }; /** * payment_method_param - * @description Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + * @description Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://docs.stripe.com/payments/zip) for more details like country availability. */ zip?: { /** display_preference_param */ @@ -52079,7 +57293,7 @@ export interface operations { query?: { /** @description The domain name that this payment method domain object represents. */ domain_name?: string; - /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements */ + /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout */ enabled?: boolean; /** @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; @@ -52143,7 +57357,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The domain name that this payment method domain object represents. */ domain_name: string; - /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. */ + /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout. */ enabled?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -52221,7 +57435,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. */ + /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout. */ enabled?: boolean; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -52290,8 +57504,12 @@ export interface operations { GetPaymentMethods: { parameters: { query?: { + /** @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. */ + allow_redisplay?: "always" | "limited" | "unspecified"; /** @description The ID of the customer whose PaymentMethods will be retrieved. */ customer?: string; + /** @description The ID of the Account whose PaymentMethods will be retrieved. */ + customer_account?: 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. */ @@ -52300,8 +57518,8 @@ export interface operations { 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; - /** @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" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + /** @description Filters the list by the object `type` field. Unfiltered, the list returns all payment method types except `custom`. If your integration expects only one type of payment method in the response, specify that type value in the request to reduce your payload. */ + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path?: never; @@ -52414,6 +57632,11 @@ export interface operations { * @description If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method. */ bancontact?: Record; + /** + * param + * @description If this is a `billie` PaymentMethod, this hash contains details about the Billie payment method. + */ + billie?: Record; /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. @@ -52430,6 +57653,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** * param @@ -52462,6 +57686,18 @@ export interface operations { * @description If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method. */ cashapp?: Record; + /** + * param + * @description If this is a Crypto PaymentMethod, this hash contains details about the Crypto payment method. + */ + crypto?: Record; + /** + * create_param + * @description If this is a `custom` PaymentMethod, this hash contains details about the Custom payment method. + */ + custom?: { + type: string; + }; /** @description The `Customer` to whom the original PaymentMethod is attached. */ customer?: string; /** @@ -52503,7 +57739,7 @@ export interface operations { */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** * param @@ -52542,7 +57778,12 @@ export interface operations { * @description If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. */ link?: Record; - /** @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`. */ + /** + * param + * @description If this is a MB WAY PaymentMethod, this hash contains details about the MB WAY payment method. + */ + mb_way?: Record; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -52564,6 +57805,18 @@ export interface operations { /** @enum {string} */ funding?: "card" | "points"; }; + /** + * param + * @description If this is an nz_bank_account PaymentMethod, this hash contains details about the nz_bank_account payment method. + */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. @@ -52599,6 +57852,15 @@ export interface operations { * @description If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method. */ paypal?: Record; + /** + * param + * @description If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. + */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; /** * param * @description If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method. @@ -52611,14 +57873,14 @@ export interface operations { promptpay?: Record; /** * radar_options_with_hidden_options - * @description Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. + * @description Options to configure Radar. See [Radar Session](https://docs.stripe.com/radar/radar-session) for more information. */ radar_options?: { session?: string; }; /** * param - * @description If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. + * @description If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. */ revolut_pay?: Record; /** @@ -52626,6 +57888,11 @@ export interface operations { * @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 `satispay` PaymentMethod, this hash contains details about the Satispay payment method. + */ + satispay?: Record; /** * param * @description If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account. @@ -52655,7 +57922,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" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mobilepay" | "multibanco" | "naver_pay" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "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. @@ -52774,6 +58041,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** * update_api_param @@ -52790,28 +58058,19 @@ export interface operations { }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** - * param - * @description If this is an `Link` PaymentMethod, this hash contains details about the Link payment method. - */ - link?: Record; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; /** * param - * @description If this is a `naver_pay` PaymentMethod, this hash contains details about the Naver Pay payment method. + * @description If this is a `payto` PaymentMethod, this hash contains details about the PayTo payment method. */ - naver_pay?: { - /** @enum {string} */ - funding?: "card" | "points"; + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; }; - /** - * param - * @description If this is a `pay_by_bank` PaymentMethod, this hash contains details about the PayByBank payment method. - */ - pay_by_bank?: Record; /** * update_param * @description If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. @@ -52855,11 +58114,13 @@ export interface operations { }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { /** @description The ID of the customer to which to attach the PaymentMethod. */ - customer: string; + customer?: string; + /** @description The ID of the Account representing the customer to which to attach the PaymentMethod. */ + customer_account?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; }; @@ -52924,6 +58185,607 @@ export interface operations { }; }; }; + PostPaymentRecordsReportPayment: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * amount + * @description The amount you initially requested for this payment. + */ + amount_requested: { + /** Format: currency */ + currency: string; + value: number; + }; + /** + * customer_details + * @description Customer information for this payment. + */ + customer_details?: { + customer?: string; + email?: string; + name?: string; + phone?: string; + }; + /** + * @description Indicates whether the customer was present in your checkout flow during this payment. + * @enum {string} + */ + customer_presence?: "off_session" | "on_session"; + /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + description?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * failed + * @description Information about the payment attempt failure. + */ + failed?: { + /** Format: unix-time */ + failed_at: number; + }; + /** + * guaranteed + * @description Information about the payment attempt guarantee. + */ + guaranteed?: { + /** Format: unix-time */ + guaranteed_at: number; + }; + /** + * Format: unix-time + * @description When the reported payment was initiated. Measured in seconds since the Unix epoch. + */ + initiated_at: number; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 outcome of the reported payment. + * @enum {string} + */ + outcome?: "failed" | "guaranteed"; + /** + * payment_method_details + * @description Information about the Payment Method debited for this payment. + */ + payment_method_details: { + /** billing_details */ + billing_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + email?: string; + name?: string; + phone?: string; + }; + /** custom */ + custom?: { + display_name?: string; + type?: string; + }; + payment_method?: string; + /** @enum {string} */ + type?: "custom"; + }; + /** + * processor_details + * @description Processor information for this payment. + */ + processor_details?: { + /** custom */ + custom?: { + payment_reference: string; + }; + /** @enum {string} */ + type: "custom"; + }; + /** + * shipping_details + * @description Shipping information for this payment. + */ + shipping_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name?: string; + phone?: string; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetPaymentRecordsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + 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"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostPaymentRecordsIdReportPaymentAttempt: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + description?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * failed + * @description Information about the payment attempt failure. + */ + failed?: { + /** Format: unix-time */ + failed_at: number; + }; + /** + * guaranteed + * @description Information about the payment attempt guarantee. + */ + guaranteed?: { + /** Format: unix-time */ + guaranteed_at: number; + }; + /** + * Format: unix-time + * @description When the reported payment was initiated. Measured in seconds since the Unix epoch. + */ + initiated_at: number; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 outcome of the reported payment. + * @enum {string} + */ + outcome?: "failed" | "guaranteed"; + /** + * payment_method_details + * @description Information about the Payment Method debited for this payment. + */ + payment_method_details?: { + /** billing_details */ + billing_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + email?: string; + name?: string; + phone?: string; + }; + /** custom */ + custom?: { + display_name?: string; + type?: string; + }; + payment_method?: string; + /** @enum {string} */ + type?: "custom"; + }; + /** + * shipping_details + * @description Shipping information for this payment. + */ + shipping_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name?: string; + phone?: string; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostPaymentRecordsIdReportPaymentAttemptCanceled: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * Format: unix-time + * @description When the reported payment was canceled. Measured in seconds since the Unix epoch. + */ + canceled_at: number; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostPaymentRecordsIdReportPaymentAttemptFailed: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * Format: unix-time + * @description When the reported payment failed. Measured in seconds since the Unix epoch. + */ + failed_at: number; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostPaymentRecordsIdReportPaymentAttemptGuaranteed: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * Format: unix-time + * @description When the reported payment was guaranteed. Measured in seconds since the Unix epoch. + */ + guaranteed_at: number; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostPaymentRecordsIdReportPaymentAttemptInformational: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * customer_details + * @description Customer information for this payment. + */ + customer_details?: { + customer?: string; + email?: string; + name?: string; + phone?: string; + }; + /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ + description?: string | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Shipping information for this payment. */ + shipping_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name?: string; + phone?: string; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostPaymentRecordsIdReportRefund: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The ID of the Payment Record. */ + id: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * amount + * @description A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment. + */ + amount?: { + /** Format: currency */ + currency: string; + value: number; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * Format: unix-time + * @description When the reported refund was initiated. Measured in seconds since the Unix epoch. + */ + initiated_at?: number; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 outcome of the reported refund. + * @enum {string} + */ + outcome: "refunded"; + /** + * processor_details + * @description Processor information for this refund. + */ + processor_details: { + /** custom */ + custom?: { + refund_reference: string; + }; + /** @enum {string} */ + type: "custom"; + }; + /** + * refunded + * @description Information about the payment attempt refund. + */ + refunded: { + /** Format: unix-time */ + refunded_at: number; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["payment_record"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetPayouts: { parameters: { query?: { @@ -53018,7 +58880,7 @@ export interface operations { destination?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -53027,6 +58889,8 @@ export interface operations { * @enum {string} */ method?: "instant" | "standard"; + /** @description The ID of a v2 FinancialAccount to send funds to. */ + payout_method?: string; /** * @description The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`. * @enum {string} @@ -53110,7 +58974,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -53190,7 +59054,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -53295,11 +59159,6 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Whether the plan is currently available for new subscriptions. Defaults to `true`. */ active?: boolean; - /** - * @description Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. - * @enum {string} - */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; /** @description A positive integer in cents (or local equivalent) (or 0 for a free plan) representing how much to charge on a recurring basis. */ amount?: number; /** @@ -53328,7 +59187,7 @@ export interface operations { interval: "day" | "month" | "week" | "year"; /** @description The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). */ interval_count?: number; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -53372,7 +59231,7 @@ export interface operations { /** @enum {string} */ round: "down" | "up"; }; - /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). */ + /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). */ trial_period_days?: number; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. @@ -53457,7 +59316,7 @@ export interface operations { active?: boolean; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -53465,7 +59324,7 @@ export interface operations { nickname?: string; /** @description The product the plan belongs to. This cannot be changed once it has been used in a subscription or subscription schedule. */ product?: string; - /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). */ + /** @description Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). */ trial_period_days?: number; }; }; @@ -53667,13 +59526,13 @@ export interface operations { expand?: string[]; /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ lookup_key?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 A brief description of the price, hidden from customers. */ nickname?: string; - /** @description The ID of the product that this price will belong to. */ + /** @description The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. */ product?: string; /** * inline_product_params @@ -53696,8 +59555,6 @@ export interface operations { * @description The recurring components of a price such as `interval` and `usage_type`. */ recurring?: { - /** @enum {string} */ - aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; /** @enum {string} */ interval: "day" | "month" | "week" | "year"; interval_count?: number; @@ -53706,7 +59563,7 @@ export interface operations { usage_type?: "licensed" | "metered"; }; /** - * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + * @description Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -53776,7 +59633,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for prices](https://stripe.com/docs/search#query-fields-for-prices). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for prices](https://docs.stripe.com/search#query-fields-for-prices). */ query: string; }; header?: never; @@ -53903,14 +59760,14 @@ export interface operations { expand?: string[]; /** @description A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. */ lookup_key?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 A brief description of the price, hidden from customers. */ nickname?: string; /** - * @description Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. + * @description Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. * @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; @@ -53956,7 +59813,7 @@ export interface operations { ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before). */ + /** @description Only return products with the given IDs. Cannot be used with [starting_after](https://api.stripe.com#list_products-starting_after) or [ending_before](https://api.stripe.com#list_products-ending_before). */ ids?: 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; @@ -54022,8 +59879,8 @@ export interface operations { /** @description Whether the product is currently available for purchase. Defaults to `true`. */ active?: boolean; /** - * price_data_without_product - * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product. + * price_data_without_product_with_metadata + * @description Data used to generate a new [Price](https://docs.stripe.com/api/prices) object. This Price will be set as the default price for this product. */ default_price_data?: { /** Format: currency */ @@ -54060,6 +59917,9 @@ export interface operations { minimum?: number; preset?: number; }; + metadata?: { + [key: string]: string; + }; /** recurring_adhoc */ recurring?: { /** @enum {string} */ @@ -54080,11 +59940,11 @@ export interface operations { id?: string; /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ images?: string[]; - /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). */ marketing_features?: { name: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -54109,7 +59969,7 @@ export interface operations { * It must contain at least one letter. Only used for subscription payments. */ statement_descriptor?: string; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. */ tax_code?: string; /** @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. */ unit_label?: string; @@ -54148,7 +60008,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for products](https://docs.stripe.com/search#query-fields-for-products). */ query: string; }; header?: never; @@ -54245,7 +60105,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Whether the product is available for purchase. */ active?: boolean; - /** @description The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product. */ + /** @description The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. */ default_price?: string; /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ description?: string | ""; @@ -54253,11 +60113,11 @@ export interface operations { expand?: string[]; /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ images?: string[] | ""; - /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table). */ marketing_features?: { name: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -54279,7 +60139,7 @@ export interface operations { * It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments. */ statement_descriptor?: string; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. */ tax_code?: string | ""; /** @description A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`. */ unit_label?: string | ""; @@ -54411,7 +60271,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product. */ + /** @description The ID of the [Feature](https://docs.stripe.com/api/entitlements/feature) object attached to this product. */ entitlement_feature: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -54534,6 +60394,8 @@ export interface operations { } | number; /** @description Only return promotion codes that are restricted to this customer. */ customer?: string; + /** @description Only return promotion codes that are restricted to this account representing the customer. */ + customer_account?: 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. */ @@ -54597,15 +60459,15 @@ export interface operations { /** @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. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9). + * @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), digits (0-9), and dashes (-). * * If left blank, we will generate one automatically. */ code?: string; - /** @description The coupon for this promotion code. */ - coupon: string; - /** @description The customer that this promotion code can be used by. If not set, the promotion code can be used by all customers. */ + /** @description The customer who can use this promotion code. If not set, all customers can use the promotion code. */ customer?: string; + /** @description The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code. */ + customer_account?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -54615,10 +60477,19 @@ export interface operations { expires_at?: number; /** @description A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a `max_redemptions`, then this value cannot be greater than the coupon's `max_redemptions`. */ max_redemptions?: number; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; + /** + * promotion + * @description The promotion referenced by this promotion code. + */ + promotion: { + coupon?: string; + /** @enum {string} */ + type: "coupon"; + }; /** * restrictions_params * @description Settings that restrict the redemption of the promotion code. @@ -54712,7 +60583,7 @@ export interface operations { active?: boolean; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -54754,8 +60625,10 @@ export interface operations { GetQuotes: { parameters: { query?: { - /** @description The ID of the customer whose quotes will be retrieved. */ + /** @description The ID of the customer whose quotes you're retrieving. */ customer?: string; + /** @description The ID of the account representing the customer whose quotes you're retrieving. */ + customer_account?: 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. */ @@ -54844,6 +60717,8 @@ export interface operations { collection_method?: "charge_automatically" | "send_invoice"; /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ customer?: string; + /** @description The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. */ + customer_account?: string; /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ default_tax_rates?: string[] | ""; /** @description A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used. */ @@ -54914,7 +60789,7 @@ export interface operations { quantity?: number; tax_rates?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -54925,6 +60800,16 @@ export interface operations { * @description When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. */ subscription_data?: { + /** billing_mode */ + billing_mode?: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "classic" | "flexible"; + }; description?: string; effective_date?: "current_period_end" | number | ""; metadata?: { @@ -55038,6 +60923,8 @@ export interface operations { collection_method?: "charge_automatically" | "send_invoice"; /** @description The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed. */ customer?: string; + /** @description The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed. */ + customer_account?: string; /** @description The tax rates that will apply to any line item that does not have `tax_rates` set. */ default_tax_rates?: string[] | ""; /** @description A description that will be displayed on the quote PDF. */ @@ -55101,7 +60988,7 @@ export interface operations { quantity?: number; tax_rates?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -55520,6 +61407,120 @@ export interface operations { }; }; }; + PostRadarPaymentEvaluations: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * client_device_metadata_wrapper + * @description Details about the Client Device Metadata to associate with the payment evaluation. + */ + client_device_metadata_details?: { + radar_session: string; + }; + /** + * customer_details + * @description Details about the customer associated with the payment evaluation. + */ + customer_details: { + customer?: string; + customer_account?: string; + email?: string; + name?: string; + phone?: string; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; + }; + /** + * payment_details + * @description Details about the payment. + */ + payment_details: { + amount: number; + /** Format: currency */ + currency: string; + description?: string; + /** money_movement_details */ + money_movement_details?: { + /** money_movement_card_additional_data */ + card?: { + /** @enum {string} */ + customer_presence?: "off_session" | "on_session"; + /** @enum {string} */ + payment_type?: "one_off" | "recurring" | "setup_one_off" | "setup_recurring"; + }; + /** @enum {string} */ + money_movement_type: "card"; + }; + /** payment_method_details */ + payment_method_details: { + /** billing_details */ + billing_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + email?: string; + name?: string; + phone?: string; + }; + payment_method: string; + }; + /** shipping_details */ + shipping_details?: { + /** address */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name?: string; + phone?: string; + }; + statement_descriptor?: string; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["radar.payment_evaluation"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetRadarValueListItems: { parameters: { query: { @@ -55776,11 +61777,11 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed. + * @description Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed. * @enum {string} */ item_type?: "card_bin" | "card_fingerprint" | "case_sensitive_string" | "country" | "customer_id" | "email" | "ip_address" | "sepa_debit_fingerprint" | "string" | "us_bank_account_fingerprint"; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -55864,7 +61865,7 @@ export interface operations { alias?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -56017,7 +62018,7 @@ export interface operations { 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -56029,7 +62030,7 @@ export interface operations { /** @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. + * @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://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. * @enum {string} */ reason?: "duplicate" | "fraudulent" | "requested_by_customer"; @@ -56113,7 +62114,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -56253,7 +62254,7 @@ export interface operations { expand?: string[]; /** * run_parameter_specs - * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://stripe.com/docs/reporting/statements/api) documentation. + * @description Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to Reports](https://docs.stripe.com/reporting/statements/api) documentation. */ parameters?: { columns?: string[]; @@ -56268,9 +62269,9 @@ export interface operations { /** @enum {string} */ reporting_category?: "advance" | "advance_funding" | "anticipation_repayment" | "charge" | "charge_failure" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "connect_reserved_funds" | "contribution" | "dispute" | "dispute_reversal" | "fee" | "financing_paydown" | "financing_paydown_reversal" | "financing_payout" | "financing_payout_reversal" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "network_cost" | "other_adjustment" | "partial_capture_reversal" | "payout" | "payout_reversal" | "platform_earning" | "platform_earning_refund" | "refund" | "refund_failure" | "risk_reserved_funds" | "tax" | "topup" | "topup_reversal" | "transfer" | "transfer_reversal" | "unreconciled_customer_funds"; /** @enum {string} */ - timezone?: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Factory" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Pacific-New" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu"; + timezone?: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Coyhaique" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Factory" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Pacific-New" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu"; }; - /** @description The ID of the [report type](https://stripe.com/docs/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ + /** @description The ID of the [report type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. */ report_type: string; }; }; @@ -56642,6 +62643,8 @@ export interface operations { } | number; /** @description Only return SetupIntents for the customer specified by this customer ID. */ customer?: string; + /** @description Only return SetupIntents for the account specified by this customer ID. */ + customer_account?: 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. */ @@ -56733,8 +62736,16 @@ export interface operations { * If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. */ customer?: string; + /** + * @description ID of the Account this SetupIntent belongs to, if one exists. + * + * If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + */ + customer_account?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; + /** @description The list of payment method types to exclude from use with this SetupIntent. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -56743,7 +62754,7 @@ export interface operations { * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. */ flow_directions?: ("inbound" | "outbound")[]; - /** @description This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). */ + /** @description This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm). */ mandate_data?: { /** customer_acceptance_param */ customer_acceptance: { @@ -56760,7 +62771,7 @@ export interface operations { type: "offline" | "online"; }; } | ""; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -56768,11 +62779,11 @@ 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](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. */ + /** @description The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. */ payment_method_configuration?: string; /** * payment_method_data_params - * @description When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + * @description When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) * value in the SetupIntent. */ payment_method_data?: { @@ -56806,6 +62817,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -56819,6 +62832,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -56829,6 +62843,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -56847,7 +62863,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -56868,6 +62884,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -56881,6 +62899,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -56896,6 +62923,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -56908,6 +62941,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -56921,7 +62956,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -57012,18 +63047,62 @@ export interface operations { requestor_challenge_indicator?: string; transaction_id?: string; /** @enum {string} */ - version?: "1.0.2" | "2.1.0" | "2.2.0"; + version?: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1"; }; }; /** setup_intent_payment_method_options_param */ card_present?: Record; /** setup_intent_payment_method_options_param */ + klarna?: { + /** Format: currency */ + currency?: string; + /** on_demand_param */ + on_demand?: { + average_amount?: number; + maximum_amount?: number; + minimum_amount?: number; + /** @enum {string} */ + purchase_interval?: "day" | "month" | "week" | "year"; + purchase_interval_count?: number; + }; + /** @enum {string} */ + preferred_locale?: "cs-CZ" | "da-DK" | "de-AT" | "de-CH" | "de-DE" | "el-GR" | "en-AT" | "en-AU" | "en-BE" | "en-CA" | "en-CH" | "en-CZ" | "en-DE" | "en-DK" | "en-ES" | "en-FI" | "en-FR" | "en-GB" | "en-GR" | "en-IE" | "en-IT" | "en-NL" | "en-NO" | "en-NZ" | "en-PL" | "en-PT" | "en-RO" | "en-SE" | "en-US" | "es-ES" | "es-US" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "it-CH" | "it-IT" | "nb-NO" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-PT" | "ro-RO" | "sv-FI" | "sv-SE"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; + }; + /** setup_intent_payment_method_options_param */ link?: Record; /** payment_method_options_param */ paypal?: { billing_agreement_id?: string; }; /** setup_intent_payment_method_options_param */ + payto?: { + /** setup_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + start_date?: string | ""; + }; + }; + /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -57055,13 +63134,15 @@ 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, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ + /** @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). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ 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). */ + /** @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://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm). */ return_url?: string; /** * setup_intent_single_use_params * @description If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion. + * + * Single-use mandates are only valid for the following payment methods: `acss_debit`, `alipay`, `au_becs_debit`, `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, `sepa_debit`, and `us_bank_account`. */ single_use?: { amount: number; @@ -57163,8 +63244,16 @@ export interface operations { * If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. */ customer?: string; + /** + * @description ID of the Account this SetupIntent belongs to, if one exists. + * + * If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent. + */ + customer_account?: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string; + /** @description The list of payment method types to exclude from use with this SetupIntent. */ + excluded_payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "alma" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "billie" | "blik" | "boleto" | "card" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip")[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @@ -57173,17 +63262,17 @@ export interface operations { * Include `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes. */ flow_directions?: ("inbound" | "outbound")[]; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 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](https://stripe.com/docs/api/payment_method_configurations) to use with this SetupIntent. */ + /** @description The ID of the [payment method configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. */ payment_method_configuration?: string; /** * payment_method_data_params - * @description When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + * @description When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) * value in the SetupIntent. */ payment_method_data?: { @@ -57217,6 +63306,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -57230,6 +63321,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -57240,6 +63332,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -57258,7 +63352,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -57279,6 +63373,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -57292,6 +63388,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -57307,6 +63412,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -57319,6 +63430,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -57332,7 +63445,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -57423,18 +63536,62 @@ export interface operations { requestor_challenge_indicator?: string; transaction_id?: string; /** @enum {string} */ - version?: "1.0.2" | "2.1.0" | "2.2.0"; + version?: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1"; }; }; /** setup_intent_payment_method_options_param */ card_present?: Record; /** setup_intent_payment_method_options_param */ + klarna?: { + /** Format: currency */ + currency?: string; + /** on_demand_param */ + on_demand?: { + average_amount?: number; + maximum_amount?: number; + minimum_amount?: number; + /** @enum {string} */ + purchase_interval?: "day" | "month" | "week" | "year"; + purchase_interval_count?: number; + }; + /** @enum {string} */ + preferred_locale?: "cs-CZ" | "da-DK" | "de-AT" | "de-CH" | "de-DE" | "el-GR" | "en-AT" | "en-AU" | "en-BE" | "en-CA" | "en-CH" | "en-CZ" | "en-DE" | "en-DK" | "en-ES" | "en-FI" | "en-FR" | "en-GB" | "en-GR" | "en-IE" | "en-IT" | "en-NL" | "en-NO" | "en-NZ" | "en-PL" | "en-PT" | "en-RO" | "en-SE" | "en-US" | "es-ES" | "es-US" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "it-CH" | "it-IT" | "nb-NO" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-PT" | "ro-RO" | "sv-FI" | "sv-SE"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; + }; + /** setup_intent_payment_method_options_param */ link?: Record; /** payment_method_options_param */ paypal?: { billing_agreement_id?: string; }; /** setup_intent_payment_method_options_param */ + payto?: { + /** setup_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + start_date?: string | ""; + }; + }; + /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -57466,7 +63623,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, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ + /** @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). A list of valid payment method types can be found [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). */ payment_method_types?: string[]; }; }; @@ -57588,7 +63745,7 @@ export interface operations { payment_method?: string; /** * payment_method_data_params - * @description When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + * @description When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) * value in the SetupIntent. */ payment_method_data?: { @@ -57622,6 +63779,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -57635,6 +63794,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -57645,6 +63805,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -57663,7 +63825,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -57684,6 +63846,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -57697,6 +63861,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -57712,6 +63885,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -57724,6 +63903,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -57737,7 +63918,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -57828,18 +64009,62 @@ export interface operations { requestor_challenge_indicator?: string; transaction_id?: string; /** @enum {string} */ - version?: "1.0.2" | "2.1.0" | "2.2.0"; + version?: "1.0.2" | "2.1.0" | "2.2.0" | "2.3.0" | "2.3.1"; }; }; /** setup_intent_payment_method_options_param */ card_present?: Record; /** setup_intent_payment_method_options_param */ + klarna?: { + /** Format: currency */ + currency?: string; + /** on_demand_param */ + on_demand?: { + average_amount?: number; + maximum_amount?: number; + minimum_amount?: number; + /** @enum {string} */ + purchase_interval?: "day" | "month" | "week" | "year"; + purchase_interval_count?: number; + }; + /** @enum {string} */ + preferred_locale?: "cs-CZ" | "da-DK" | "de-AT" | "de-CH" | "de-DE" | "el-GR" | "en-AT" | "en-AU" | "en-BE" | "en-CA" | "en-CH" | "en-CZ" | "en-DE" | "en-DK" | "en-ES" | "en-FI" | "en-FR" | "en-GB" | "en-GR" | "en-IE" | "en-IT" | "en-NL" | "en-NO" | "en-NZ" | "en-PL" | "en-PT" | "en-RO" | "en-SE" | "en-US" | "es-ES" | "es-US" | "fi-FI" | "fr-BE" | "fr-CA" | "fr-CH" | "fr-FR" | "it-CH" | "it-IT" | "nb-NO" | "nl-BE" | "nl-NL" | "pl-PL" | "pt-PT" | "ro-RO" | "sv-FI" | "sv-SE"; + subscriptions?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + name?: string; + /** subscription_next_billing_param */ + next_billing: { + amount: number; + date: string; + }; + reference: string; + }[] | ""; + }; + /** setup_intent_payment_method_options_param */ link?: Record; /** payment_method_options_param */ paypal?: { billing_agreement_id?: string; }; /** setup_intent_payment_method_options_param */ + payto?: { + /** setup_intent_payment_method_options_mandate_options_param */ + mandate_options?: { + amount?: number | ""; + /** @enum {string} */ + amount_type?: "" | "fixed" | "maximum"; + end_date?: string | ""; + /** @enum {string} */ + payment_schedule?: "" | "adhoc" | "annual" | "daily" | "fortnightly" | "monthly" | "quarterly" | "semi_annual" | "weekly"; + payments_per_period?: number | ""; + /** @enum {string} */ + purpose?: "" | "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + start_date?: string | ""; + }; + }; + /** setup_intent_payment_method_options_param */ sepa_debit?: { /** payment_method_options_mandate_options_param */ mandate_options?: { @@ -58059,7 +64284,7 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -58068,7 +64293,7 @@ export interface operations { * @enum {string} */ tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - /** @description A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ + /** @description A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. */ tax_code?: string; /** * @description The type of calculation to use on the shipping rate. @@ -58166,7 +64391,7 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -58199,6 +64424,49 @@ export interface operations { }; }; }; + PostSigmaSavedQueriesId: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The `id` of the saved query to update. This should be a valid `id` that was previously created. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The name of the query to update. */ + name?: string; + /** @description The sql statement to update the specified query statement with. This should be a valid Trino SQL statement that can be run in Sigma. */ + sql?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["sigma.sigma_api_query"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetSigmaScheduledQueryRuns: { parameters: { query?: { @@ -58425,7 +64693,7 @@ export interface operations { statement_descriptor?: string; /** @description An optional token used to create the source. When passed, token properties will override source parameters. */ token?: string; - /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) guide) */ + /** @description The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide) */ type?: string; /** @enum {string} */ usage?: "reusable" | "single_use"; @@ -58544,7 +64812,7 @@ export interface operations { /** @enum {string} */ notification_method?: "deprecated_none" | "email" | "manual" | "none" | "stripe_email"; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -58860,7 +65128,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ + /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: { usage_gte: number; } | ""; @@ -58872,18 +65140,18 @@ export interface operations { }[] | ""; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. * - * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + * Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. * @enum {string} */ payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; @@ -58891,7 +65159,7 @@ export interface operations { price?: string; /** * recurring_price_data - * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. + * @description Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. */ price_data?: { /** Format: currency */ @@ -58910,159 +65178,20 @@ export interface operations { unit_amount_decimal?: string; }; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** * Format: unix-time - * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. */ proration_date?: number; /** @description The quantity you'd like to apply to the subscription item you're creating. */ quantity?: number; /** @description The identifier of the subscription to modify. */ subscription: string; - /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ - tax_rates?: string[] | ""; - }; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["subscription_item"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - GetSubscriptionItemsItem: { - parameters: { - query?: { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - header?: never; - path: { - item: 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"]["subscription_item"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - PostSubscriptionItemsItem: { - parameters: { - query?: never; - header?: never; - path: { - item: string; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": { - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ - billing_thresholds?: { - usage_gte: number; - } | ""; - /** @description The coupons to redeem into discounts for the subscription item. */ - discounts?: { - coupon?: string; - discount?: string; - promotion_code?: string; - }[] | ""; - /** @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 Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ - off_session?: boolean; - /** - * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. - * - * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. - * - * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). - * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. - * @enum {string} - */ - payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; - /** @description The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ - price?: string; - /** - * recurring_price_data - * @description Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required. - */ - price_data?: { - /** Format: currency */ - currency: string; - product: string; - /** recurring_adhoc */ - recurring: { - /** @enum {string} */ - interval: "day" | "month" | "week" | "year"; - interval_count?: number; - }; - /** @enum {string} */ - tax_behavior?: "exclusive" | "inclusive" | "unspecified"; - unit_amount?: number; - /** Format: decimal */ - unit_amount_decimal?: string; - }; - /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. - * @enum {string} - */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** - * Format: unix-time - * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. - */ - proration_date?: number; - /** @description The quantity you'd like to apply to the subscription item you're creating. */ - quantity?: number; - /** @description A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ + /** @description A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ tax_rates?: string[] | ""; }; }; @@ -59088,9 +65217,12 @@ export interface operations { }; }; }; - DeleteSubscriptionItemsItem: { + GetSubscriptionItemsItem: { parameters: { - query?: never; + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; header?: never; path: { item: string; @@ -59099,20 +65231,7 @@ export interface operations { }; requestBody?: { content: { - "application/x-www-form-urlencoded": { - /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ - clear_usage?: boolean; - /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. - * @enum {string} - */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** - * Format: unix-time - * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. - */ - proration_date?: number; - }; + "application/x-www-form-urlencoded": Record; }; }; responses: { @@ -59122,7 +65241,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["deleted_subscription_item"]; + "application/json": components["schemas"]["subscription_item"]; }; }; /** @description Error response. */ @@ -59136,27 +65255,84 @@ export interface operations { }; }; }; - GetSubscriptionItemsSubscriptionItemUsageRecordSummaries: { + PostSubscriptionItemsItem: { parameters: { - query?: { - /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ - ending_before?: string; - /** @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; - }; + query?: never; header?: never; path: { - subscription_item: string; + item: string; }; cookie?: never; }; requestBody?: { content: { - "application/x-www-form-urlencoded": Record; + "application/x-www-form-urlencoded": { + /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ + billing_thresholds?: { + usage_gte: number; + } | ""; + /** @description The coupons to redeem into discounts for the subscription item. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session). */ + off_session?: boolean; + /** + * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * + * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + * + * Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). + * + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. + * @enum {string} + */ + payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + /** @description The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided. */ + price?: string; + /** + * recurring_price_data + * @description Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. + */ + price_data?: { + /** Format: currency */ + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + /** + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @enum {string} + */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** + * Format: unix-time + * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. + */ + proration_date?: number; + /** @description The quantity you'd like to apply to the subscription item you're creating. */ + quantity?: number; + /** @description A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. */ + tax_rates?: string[] | ""; + }; }; }; responses: { @@ -59166,18 +65342,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - data: components["schemas"]["usage_record_summary"][]; - /** @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; - }; + "application/json": components["schemas"]["subscription_item"]; }; }; /** @description Error response. */ @@ -59191,29 +65356,41 @@ export interface operations { }; }; }; - PostSubscriptionItemsSubscriptionItemUsageRecords: { + DeleteSubscriptionItemsItem: { parameters: { query?: never; header?: never; path: { - subscription_item: string; + item: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { + /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ + clear_usage?: boolean; /** - * @description Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp. If the subscription has [billing thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), `increment` is the only allowed value. + * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * + * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + * + * Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). + * + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. * @enum {string} */ - action?: "increment" | "set"; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - /** @description The usage quantity for the specified timestamp. */ - quantity: number; - /** @description The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`, and must not be in the future. When passing `"now"`, Stripe records usage for the current time. Default is `"now"` if a value is not provided. */ - timestamp?: "now" | number; + payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; + /** + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @enum {string} + */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** + * Format: unix-time + * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. + */ + proration_date?: number; }; }; }; @@ -59224,7 +65401,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["usage_record"]; + "application/json": components["schemas"]["deleted_subscription_item"]; }; }; /** @description Error response. */ @@ -59264,6 +65441,8 @@ export interface operations { } | number; /** @description Only return subscription schedules for the given customer. */ customer?: string; + /** @description Only return subscription schedules for the given account. */ + customer_account?: 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. */ @@ -59333,8 +65512,23 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * billing_mode + * @description Controls how prorations and invoices for subscriptions are calculated and orchestrated. + */ + billing_mode?: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "classic" | "flexible"; + }; /** @description The identifier of the customer to create the subscription schedule for. */ customer?: string; + /** @description The identifier of the account to create the subscription schedule for. */ + customer_account?: string; /** * default_settings_params * @description Object representing the subscription schedule's default settings. @@ -59387,7 +65581,7 @@ export interface operations { expand?: string[]; /** @description Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls. */ from_subscription?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -59399,6 +65593,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "phase_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "phase_start" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -59433,7 +65647,6 @@ export interface operations { } | ""; /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; /** Format: currency */ currency?: string; default_payment_method?: string; @@ -59444,6 +65657,12 @@ export interface operations { discount?: string; promotion_code?: string; }[] | ""; + /** duration_params */ + duration?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; /** Format: unix-time */ end_date?: number; /** invoice_settings */ @@ -59490,7 +65709,6 @@ export interface operations { quantity?: number; tax_rates?: string[] | ""; }[]; - iterations?: number; metadata?: { [key: string]: string; }; @@ -59632,7 +65850,7 @@ export interface operations { end_behavior?: "cancel" | "none" | "release" | "renew"; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -59644,6 +65862,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "phase_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "phase_start" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -59678,7 +65916,6 @@ export interface operations { } | ""; /** @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - coupon?: string; default_payment_method?: string; default_tax_rates?: string[] | ""; description?: string | ""; @@ -59687,6 +65924,12 @@ export interface operations { discount?: string; promotion_code?: string; }[] | ""; + /** duration_params */ + duration?: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; end_date?: number | "now"; /** invoice_settings */ invoice_settings?: { @@ -59732,7 +65975,6 @@ export interface operations { quantity?: number; tax_rates?: string[] | ""; }[]; - iterations?: number; metadata?: { [key: string]: string; }; @@ -59749,7 +65991,7 @@ export interface operations { trial_end?: number | "now"; }[]; /** - * @description If the update changes the current phase, indicates whether the changes should be prorated. The default value is `create_prorations`. + * @description If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -59875,22 +66117,24 @@ export interface operations { lt?: number; lte?: number; } | number; - /** @description Only return subscriptions whose current_period_end falls within the given date interval. */ + /** @description Only return subscriptions whose minimum item current_period_end falls within the given date interval. */ current_period_end?: { gt?: number; gte?: number; lt?: number; lte?: number; } | number; - /** @description Only return subscriptions whose current_period_start falls within the given date interval. */ + /** @description Only return subscriptions whose maximum item current_period_start falls within the given date interval. */ current_period_start?: { gt?: number; gte?: number; lt?: number; lte?: number; } | number; - /** @description The ID of the customer whose subscriptions will be retrieved. */ + /** @description The ID of the customer whose subscriptions you're retrieving. */ customer?: string; + /** @description The ID of the account representing the customer whose subscriptions you're retrieving. */ + customer_account?: 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. */ @@ -59901,7 +66145,7 @@ export interface operations { price?: 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 The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. */ + /** @description The status of the subscriptions to retrieve. Passing in a value of `canceled` will return all canceled subscriptions, including those belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. */ status?: "active" | "all" | "canceled" | "ended" | "incomplete" | "incomplete_expired" | "past_due" | "paused" | "trialing" | "unpaid"; /** @description Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. */ test_clock?: string; @@ -59954,7 +66198,7 @@ export interface operations { path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. */ @@ -59964,6 +66208,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "now" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -59983,7 +66247,7 @@ export interface operations { application_fee_percent?: number | ""; /** * automatic_tax_config - * @description Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. + * @description Automatic tax settings for this subscription. */ automatic_tax?: { enabled: boolean; @@ -59996,17 +66260,17 @@ export interface operations { }; /** * Format: unix-time - * @description For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. + * @description A past timestamp to backdate the subscription's start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor. */ backdate_start_date?: number; /** * Format: unix-time - * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. + * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. */ billing_cycle_anchor?: number; /** - * billing_cycle_anchor_config_param - * @description Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC. + * cycle_anchor_config_param + * @description Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC. */ billing_cycle_anchor_config?: { day_of_month: number; @@ -60015,16 +66279,26 @@ export interface operations { month?: number; second?: number; }; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ + /** + * billing_mode + * @description Controls how prorations and invoices for subscriptions are calculated and orchestrated. + */ + billing_mode?: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "classic" | "flexible"; + }; + /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: { amount_gte?: number; reset_billing_cycle_anchor?: boolean; } | ""; - /** - * Format: unix-time - * @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - */ - cancel_at?: number; + /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ + cancel_at?: number | ("max_period_end" | "min_period_end"); /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** @@ -60032,20 +66306,20 @@ export interface operations { * @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; /** * Format: 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). */ currency?: string; /** @description The identifier of the customer to subscribe. */ - customer: string; + customer?: string; + /** @description The identifier of the account representing the customer to subscribe. */ + customer_account?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ days_until_due?: number; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_payment_method?: string; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_source?: string; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. */ default_tax_rates?: string[] | ""; @@ -60106,7 +66380,7 @@ export interface operations { quantity?: number; tax_rates?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -60117,11 +66391,11 @@ export interface operations { /** * @description Only applies to subscriptions with `collection_method=charge_automatically`. * - * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. + * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more. * * `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. * @@ -60174,6 +66448,14 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + payto?: { + /** mandate_options_param */ + mandate_options?: { + amount?: number; + /** @enum {string} */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + } | ""; sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ @@ -60189,20 +66471,18 @@ 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" | "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")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. */ pending_invoice_item_interval?: { /** @enum {string} */ interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -60214,11 +66494,11 @@ export interface operations { amount_percent?: number; destination: string; }; - /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_end?: "now" | number; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_from_plan?: boolean; - /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_period_days?: number; /** * trial_settings_config @@ -60264,7 +66544,7 @@ export interface operations { limit?: number; /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions). */ + /** @description The search query string. See [search query language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions). */ query: string; }; header?: never; @@ -60366,6 +66646,26 @@ export interface operations { discount?: string; promotion_code?: string; }[]; + metadata?: { + [key: string]: string; + }; + /** invoice_item_period */ + period?: { + /** invoice_item_period_end */ + end: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "min_item_period_end" | "timestamp"; + }; + /** invoice_item_period_start */ + start: { + /** Format: unix-time */ + timestamp?: number; + /** @enum {string} */ + type: "max_item_period_start" | "now" | "timestamp"; + }; + }; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -60397,17 +66697,17 @@ export interface operations { }; }; /** - * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). * @enum {string} */ billing_cycle_anchor?: "now" | "unchanged"; - /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ + /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: { amount_gte?: number; reset_billing_cycle_anchor?: boolean; } | ""; /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. */ - cancel_at?: number | ""; + cancel_at?: number | "" | ("max_period_end" | "min_period_end"); /** @description Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. */ cancel_at_period_end?: boolean; /** @@ -60424,13 +66724,11 @@ export interface operations { * @enum {string} */ collection_method?: "charge_automatically" | "send_invoice"; - /** @description The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - coupon?: string; /** @description Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`. */ days_until_due?: number; - /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_payment_method?: string; - /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). */ + /** @description ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). */ default_source?: string | ""; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates. */ default_tax_rates?: string[] | ""; @@ -60494,7 +66792,7 @@ export interface operations { quantity?: number; tax_rates?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -60502,7 +66800,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](https://stripe.com/docs/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://docs.stripe.com/billing/subscriptions/pause-payment). */ pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; @@ -60510,13 +66808,13 @@ export interface operations { resumes_at?: number; } | ""; /** - * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * @description Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. + * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. * - * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + * Use `pending_if_incomplete` to update the subscription using [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. * @enum {string} */ payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; @@ -60565,6 +66863,14 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + payto?: { + /** mandate_options_param */ + mandate_options?: { + amount?: number; + /** @enum {string} */ + purpose?: "dependant_support" | "government" | "loan" | "mortgage" | "other" | "pension" | "personal" | "retail" | "salary" | "tax" | "utility"; + }; + } | ""; sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ @@ -60580,26 +66886,24 @@ 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" | "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")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "affirm" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "crypto" | "custom" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "jp_credit_transfer" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "multibanco" | "naver_pay" | "nz_bank_account" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "promptpay" | "revolut_pay" | "sepa_credit_transfer" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; - /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval. */ + /** @description Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. */ pending_invoice_item_interval?: { /** @enum {string} */ interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ - promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** * Format: unix-time - * @description If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. + * @description If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. `proration_date` can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations. */ proration_date?: number; /** @description If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value. */ @@ -60607,9 +66911,9 @@ export interface operations { amount_percent?: number; destination: string; } | ""; - /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ + /** @description Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, `trial_end` will override the default trial period of the plan the customer is being subscribed to. The `billing_cycle_anchor` will be updated to the `trial_end` value. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. */ trial_end?: "now" | number; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ + /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. */ trial_from_plan?: boolean; /** * trial_settings_config @@ -60646,7 +66950,58 @@ export interface operations { }; }; }; - DeleteSubscriptionsSubscriptionExposedId: { + DeleteSubscriptionsSubscriptionExposedId: { + parameters: { + query?: never; + header?: never; + path: { + subscription_exposed_id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * cancellation_details_param + * @description Details about why this subscription was cancelled + */ + cancellation_details?: { + comment?: string | ""; + /** @enum {string} */ + feedback?: "" | "customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused"; + }; + /** @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 `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; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["subscription"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + DeleteSubscriptionsSubscriptionExposedIdDiscount: { parameters: { query?: never; header?: never; @@ -60657,23 +67012,7 @@ export interface operations { }; requestBody?: { content: { - "application/x-www-form-urlencoded": { - /** - * cancellation_details_param - * @description Details about why this subscription was cancelled - */ - cancellation_details?: { - comment?: string | ""; - /** @enum {string} */ - feedback?: "" | "customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused"; - }; - /** @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 `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; - }; + "application/x-www-form-urlencoded": Record; }; }; responses: { @@ -60683,7 +67022,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["subscription"]; + "application/json": components["schemas"]["deleted_discount"]; }; }; /** @description Error response. */ @@ -60697,18 +67036,34 @@ export interface operations { }; }; }; - DeleteSubscriptionsSubscriptionExposedIdDiscount: { + PostSubscriptionsSubscriptionMigrate: { parameters: { query?: never; header?: never; path: { - subscription_exposed_id: string; + subscription: string; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/x-www-form-urlencoded": Record; + "application/x-www-form-urlencoded": { + /** + * billing_mode_migrate + * @description Controls how prorations and invoices for subscriptions are calculated and orchestrated. + */ + billing_mode: { + /** flexible_params */ + flexible?: { + /** @enum {string} */ + proration_discounts?: "included" | "itemized"; + }; + /** @enum {string} */ + type: "flexible"; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; }; }; responses: { @@ -60718,7 +67073,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["deleted_discount"]; + "application/json": components["schemas"]["subscription"]; }; }; /** @description Error response. */ @@ -60745,20 +67100,20 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * @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). + * @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://docs.stripe.com/billing/subscriptions/billing-cycle). * @enum {string} */ billing_cycle_anchor?: "now" | "unchanged"; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; /** * Format: unix-time - * @description If set, the proration will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#retrieve_customer_invoice) endpoint. + * @description If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used to apply exactly the same prorations that were previewed with the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. */ proration_date?: number; }; @@ -60785,6 +67140,44 @@ export interface operations { }; }; }; + GetTaxAssociationsFind: { + parameters: { + query: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Valid [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) id */ + payment_intent: 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": components["schemas"]["tax.association"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTaxCalculations: { parameters: { query?: never; @@ -60821,7 +67214,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; value: string; }[]; /** @enum {string} */ @@ -60832,6 +67225,9 @@ export interface operations { /** @description A list of items the customer is purchasing. */ line_items: { amount: number; + metadata?: { + [key: string]: string; + }; product?: string; quantity?: number; reference?: string; @@ -61061,11 +67457,21 @@ export interface operations { country_options: { /** default */ ae?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; /** default */ al?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61076,6 +67482,11 @@ export interface operations { }; /** default */ ao?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61084,23 +67495,63 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ au?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; + /** @enum {string} */ + type: "standard"; + }; + /** default */ + aw?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; + /** simplified */ + az?: { + /** @enum {string} */ + type: "simplified"; + }; /** default */ ba?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; /** default */ bb?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; + /** @enum {string} */ + type: "standard"; + }; + /** default */ + bd?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61109,28 +67560,53 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; + /** default */ + bf?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; + /** @enum {string} */ + type: "standard"; + }; /** europe */ bg?: { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ bh?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; + /** simplified */ + bj?: { + /** @enum {string} */ + type: "simplified"; + }; /** default */ bs?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61150,11 +67626,21 @@ export interface operations { }; /** default */ cd?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; /** default */ ch?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61164,6 +67650,11 @@ export interface operations { type: "simplified"; }; /** simplified */ + cm?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ co?: { /** @enum {string} */ type: "simplified"; @@ -61173,12 +67664,17 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + cv?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ cy?: { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61188,7 +67684,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61198,7 +67694,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61208,7 +67704,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61223,7 +67719,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61238,17 +67734,27 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; + /** default */ + et?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; + /** @enum {string} */ + type: "standard"; + }; /** europe */ fi?: { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61258,13 +67764,18 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ gb?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61275,6 +67786,11 @@ export interface operations { }; /** default */ gn?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61283,7 +67799,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61293,7 +67809,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61303,7 +67819,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61318,13 +67834,23 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; + /** simplified */ + in?: { + /** @enum {string} */ + type: "simplified"; + }; /** default */ is?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61333,13 +67859,18 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ jp?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61349,6 +67880,11 @@ export interface operations { type: "simplified"; }; /** simplified */ + kg?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ kh?: { /** @enum {string} */ type: "simplified"; @@ -61363,12 +67899,22 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + la?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ + lk?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ lt?: { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61378,7 +67924,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61388,7 +67934,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61405,16 +67951,31 @@ export interface operations { }; /** default */ me?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; /** default */ mk?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; /** default */ mr?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61423,7 +67984,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61448,13 +68009,18 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ no?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61465,11 +68031,21 @@ export interface operations { }; /** default */ nz?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; /** default */ om?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61478,12 +68054,17 @@ export interface operations { /** @enum {string} */ type: "simplified"; }; + /** simplified */ + ph?: { + /** @enum {string} */ + type: "simplified"; + }; /** europe */ pl?: { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61493,7 +68074,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61503,13 +68084,18 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ rs?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61528,13 +68114,18 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; }; /** default */ sg?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61543,7 +68134,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61553,7 +68144,7 @@ export interface operations { /** standard */ standard?: { /** @enum {string} */ - place_of_supply_scheme: "small_seller" | "standard"; + place_of_supply_scheme: "inbound_goods" | "small_seller" | "standard"; }; /** @enum {string} */ type: "ioss" | "oss_non_union" | "oss_union" | "standard"; @@ -61565,10 +68156,15 @@ export interface operations { }; /** default */ sr?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; - /** simplified */ + /** thailand */ th?: { /** @enum {string} */ type: "simplified"; @@ -61584,11 +68180,21 @@ export interface operations { type: "simplified"; }; /** simplified */ + tw?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ tz?: { /** @enum {string} */ type: "simplified"; }; /** simplified */ + ua?: { + /** @enum {string} */ + type: "simplified"; + }; + /** simplified */ ug?: { /** @enum {string} */ type: "simplified"; @@ -61617,6 +68223,11 @@ export interface operations { }; /** default */ uy?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61632,6 +68243,11 @@ export interface operations { }; /** default */ za?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61642,6 +68258,11 @@ export interface operations { }; /** default */ zw?: { + /** standard */ + standard?: { + /** @enum {string} */ + place_of_supply_scheme?: "inbound_goods" | "standard"; + }; /** @enum {string} */ type: "standard"; }; @@ -61867,7 +68488,7 @@ export interface operations { calculation: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -61914,7 +68535,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. */ + /** @description A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. */ flat_amount?: number; /** @description The line item amounts to reverse. */ line_items?: { @@ -61927,7 +68548,7 @@ export interface operations { quantity?: number; reference: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -61938,7 +68559,7 @@ export interface operations { mode: "full" | "partial"; /** @description The ID of the Transaction to partially or fully reverse. */ original_transaction: string; - /** @description A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports). */ + /** @description A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://docs.stripe.com/tax/reports). */ reference: string; /** * transaction_shipping_cost_reversal @@ -62170,6 +68791,7 @@ export interface operations { owner?: { account?: string; customer?: string; + customer_account?: string; /** @enum {string} */ type: "account" | "application" | "customer" | "self"; }; @@ -62237,14 +68859,15 @@ export interface operations { owner?: { account?: string; customer?: string; + customer_account?: string; /** @enum {string} */ type: "account" | "application" | "customer" | "self"; }; /** - * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` + * @description Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, `ve_rif`, `vn_tin`, `za_vat`, `zm_tin`, or `zw_tin` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "ba_tin" | "bb_tin" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kh_tin" | "kr_brn" | "kz_bin" | "li_uid" | "li_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; + type: "ad_nrt" | "ae_trn" | "al_tin" | "am_tin" | "ao_tin" | "ar_cuit" | "au_abn" | "au_arn" | "aw_tin" | "az_tin" | "ba_tin" | "bb_tin" | "bd_bin" | "bf_ifu" | "bg_uic" | "bh_vat" | "bj_ifu" | "bo_tin" | "br_cnpj" | "br_cpf" | "bs_tin" | "by_tin" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "cd_nif" | "ch_uid" | "ch_vat" | "cl_tin" | "cm_niu" | "cn_tin" | "co_nit" | "cr_tin" | "cv_nif" | "de_stn" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "et_tin" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "gn_nif" | "hk_br" | "hr_oib" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kg_tin" | "kh_tin" | "kr_brn" | "kz_bin" | "la_tin" | "li_uid" | "li_vat" | "lk_vat" | "ma_vat" | "md_vat" | "me_pib" | "mk_vat" | "mr_nif" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "ng_tin" | "no_vat" | "no_voec" | "np_pan" | "nz_gst" | "om_vat" | "pe_ruc" | "ph_tin" | "pl_nip" | "ro_tin" | "rs_pib" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "sn_ninea" | "sr_fin" | "sv_nit" | "th_vat" | "tj_tin" | "tr_tin" | "tw_vat" | "tz_vat" | "ua_vat" | "ug_tin" | "us_ein" | "uy_ruc" | "uz_tin" | "uz_vat" | "ve_rif" | "vn_tin" | "za_vat" | "zm_tin" | "zw_tin"; /** @description Value of the tax ID. */ value: string; }; @@ -62432,13 +69055,13 @@ export interface operations { inclusive: boolean; /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ jurisdiction?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 This represents the tax rate percent out of 100. */ percentage: number; - /** @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. */ + /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. */ state?: string; /** * @description The high-level tax type, such as `vat` or `sales_tax`. @@ -62531,11 +69154,11 @@ export interface operations { expand?: string[]; /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ jurisdiction?: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 [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. */ + /** @description [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. */ state?: string; /** * @description The high-level tax type, such as `vat` or `sales_tax`. @@ -62631,13 +69254,24 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * bbpos_wise_pad3 + * @description An object containing device type specific settings for BBPOS WisePad 3 readers. + */ + bbpos_wisepad3?: { + splashscreen?: string | ""; + }; /** * bbpos_wise_pose - * @description An object containing device type specific settings for BBPOS WisePOS E readers + * @description An object containing device type specific settings for BBPOS WisePOS E readers. */ bbpos_wisepos_e?: { splashscreen?: string | ""; }; + /** @description Configuration for cellular connectivity. */ + cellular?: { + enabled: boolean; + } | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Name of the configuration */ @@ -62648,7 +69282,7 @@ export interface operations { } | ""; /** * reboot_window - * @description Reboot time settings for readers that support customized reboot time configuration. + * @description Reboot time settings for readers. that support customized reboot time configuration. */ reboot_window?: { end_hour: number; @@ -62656,13 +69290,26 @@ export interface operations { }; /** * stripe_s700 - * @description An object containing device type specific settings for Stripe S700 readers + * @description An object containing device type specific settings for Stripe S700 readers. */ stripe_s700?: { splashscreen?: string | ""; }; - /** @description Tipping configurations for readers supporting on-reader tips */ + /** + * stripe_s710 + * @description An object containing device type specific settings for Stripe S710 readers. + */ + stripe_s710?: { + splashscreen?: string | ""; + }; + /** @description Tipping configurations for readers that support on-reader tips. */ tipping?: { + /** currency_specific_config */ + aed?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; /** currency_specific_config */ aud?: { fixed_amounts?: number[]; @@ -62706,18 +69353,36 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + gip?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ hkd?: { fixed_amounts?: number[]; percentages?: number[]; smart_tip_threshold?: number; }; /** currency_specific_config */ + huf?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ jpy?: { fixed_amounts?: number[]; percentages?: number[]; smart_tip_threshold?: number; }; /** currency_specific_config */ + mxn?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ myr?: { fixed_amounts?: number[]; percentages?: number[]; @@ -62742,6 +69407,12 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + ron?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ sek?: { fixed_amounts?: number[]; percentages?: number[]; @@ -62762,11 +69433,36 @@ export interface operations { } | ""; /** * verifone_p400 - * @description An object containing device type specific settings for Verifone P400 readers + * @description An object containing device type specific settings for Verifone P400 readers. */ verifone_p400?: { splashscreen?: string | ""; }; + /** @description Configurations for connecting to a WiFi network. */ + wifi?: { + /** enterprise_peap_config */ + enterprise_eap_peap?: { + ca_certificate_file?: string; + password: string; + ssid: string; + username: string; + }; + /** enterprise_tls_config */ + enterprise_eap_tls?: { + ca_certificate_file?: string; + client_certificate_file: string; + private_key_file: string; + private_key_file_password?: string; + ssid: string; + }; + /** personal_psk_config */ + personal_psk?: { + password: string; + ssid: string; + }; + /** @enum {string} */ + type: "enterprise_eap_peap" | "enterprise_eap_tls" | "personal_psk"; + } | ""; }; }; }; @@ -62841,10 +69537,18 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description An object containing device type specific settings for BBPOS WisePOS E readers */ + /** @description An object containing device type specific settings for BBPOS WisePad 3 readers. */ + bbpos_wisepad3?: { + splashscreen?: string | ""; + } | ""; + /** @description An object containing device type specific settings for BBPOS WisePOS E readers. */ bbpos_wisepos_e?: { splashscreen?: string | ""; } | ""; + /** @description Configuration for cellular connectivity. */ + cellular?: { + enabled: boolean; + } | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description Name of the configuration */ @@ -62853,17 +69557,27 @@ export interface operations { offline?: { enabled: boolean; } | ""; - /** @description Reboot time settings for readers that support customized reboot time configuration. */ + /** @description Reboot time settings for readers. that support customized reboot time configuration. */ reboot_window?: { end_hour: number; start_hour: number; } | ""; - /** @description An object containing device type specific settings for Stripe S700 readers */ + /** @description An object containing device type specific settings for Stripe S700 readers. */ stripe_s700?: { splashscreen?: string | ""; } | ""; - /** @description Tipping configurations for readers supporting on-reader tips */ + /** @description An object containing device type specific settings for Stripe S710 readers. */ + stripe_s710?: { + splashscreen?: string | ""; + } | ""; + /** @description Tipping configurations for readers that support on-reader tips. */ tipping?: { + /** currency_specific_config */ + aed?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; /** currency_specific_config */ aud?: { fixed_amounts?: number[]; @@ -62907,18 +69621,36 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + gip?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ hkd?: { fixed_amounts?: number[]; percentages?: number[]; smart_tip_threshold?: number; }; /** currency_specific_config */ + huf?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ jpy?: { fixed_amounts?: number[]; percentages?: number[]; smart_tip_threshold?: number; }; /** currency_specific_config */ + mxn?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ myr?: { fixed_amounts?: number[]; percentages?: number[]; @@ -62943,6 +69675,12 @@ export interface operations { smart_tip_threshold?: number; }; /** currency_specific_config */ + ron?: { + fixed_amounts?: number[]; + percentages?: number[]; + smart_tip_threshold?: number; + }; + /** currency_specific_config */ sek?: { fixed_amounts?: number[]; percentages?: number[]; @@ -62961,10 +69699,35 @@ export interface operations { smart_tip_threshold?: number; }; } | ""; - /** @description An object containing device type specific settings for Verifone P400 readers */ + /** @description An object containing device type specific settings for Verifone P400 readers. */ verifone_p400?: { splashscreen?: string | ""; } | ""; + /** @description Configurations for connecting to a WiFi network. */ + wifi?: { + /** enterprise_peap_config */ + enterprise_eap_peap?: { + ca_certificate_file?: string; + password: string; + ssid: string; + username: string; + }; + /** enterprise_tls_config */ + enterprise_eap_tls?: { + ca_certificate_file?: string; + client_certificate_file: string; + private_key_file: string; + private_key_file_password?: string; + ssid: string; + }; + /** personal_psk_config */ + personal_psk?: { + password: string; + ssid: string; + }; + /** @enum {string} */ + type: "enterprise_eap_peap" | "enterprise_eap_tls" | "personal_psk"; + } | ""; }; }; }; @@ -63115,7 +69878,374 @@ export interface operations { }; }; }; - PostTerminalLocations: { + PostTerminalLocations: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * create_location_address_param + * @description The full address of the location. + */ + address?: { + city?: string; + country: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + /** + * japan_address_kana_specs + * @description The Kana variation of the full address of the location (Japan only). + */ + address_kana?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + town?: string; + }; + /** + * japan_address_kanji_specs + * @description The Kanji variation of the full address of the location (Japan only). + */ + address_kanji?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + town?: string; + }; + /** @description The ID of a configuration that will be used to customize all readers in this location. */ + configuration_overrides?: string; + /** @description A name for the location. Maximum length is 1000 characters. */ + display_name?: string; + /** @description The Kana variation of the name for the location (Japan only). Maximum length is 1000 characters. */ + display_name_kana?: string; + /** @description The Kanji variation of the name for the location (Japan only). Maximum length is 1000 characters. */ + display_name_kanji?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 phone number for the location. */ + phone?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["terminal.location"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetTerminalLocationsLocation: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + location: 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"]["terminal.location"] | components["schemas"]["deleted_terminal.location"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTerminalLocationsLocation: { + parameters: { + query?: never; + header?: never; + path: { + location: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * optional_fields_address + * @description The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location. + */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + /** + * japan_address_kana_specs + * @description The Kana variation of the full address of the location (Japan only). + */ + address_kana?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + town?: string; + }; + /** + * japan_address_kanji_specs + * @description The Kanji variation of the full address of the location (Japan only). + */ + address_kanji?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + town?: string; + }; + /** @description The ID of a configuration that will be used to customize all readers in this location. */ + configuration_overrides?: string | ""; + /** @description A name for the location. */ + display_name?: string | ""; + /** @description The Kana variation of the name for the location (Japan only). */ + display_name_kana?: string | ""; + /** @description The Kanji variation of the name for the location (Japan only). */ + display_name_kanji?: string | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 phone number for the location. */ + phone?: string | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["terminal.location"] | components["schemas"]["deleted_terminal.location"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + DeleteTerminalLocationsLocation: { + parameters: { + query?: never; + header?: never; + path: { + location: 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"]["deleted_terminal.location"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTerminalOnboardingLinks: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * link_options_params + * @description Specific fields needed to generate the desired link type. + */ + link_options: { + /** apple_terms_and_conditions_params */ + apple_terms_and_conditions?: { + allow_relinking?: boolean; + merchant_display_name: string; + }; + }; + /** + * @description The type of link being generated. + * @enum {string} + */ + link_type: "apple_terms_and_conditions"; + /** @description Stripe account ID to generate the link for. */ + on_behalf_of?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["terminal.onboarding_link"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetTerminalReaders: { + parameters: { + query?: { + /** @description Filters readers by device type */ + device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_stripe_s700" | "simulated_stripe_s710" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "stripe_s710" | "verifone_P400"; + /** @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 location ID to filter the response list to only readers at the specific location */ + location?: string; + /** @description Filters readers by serial number */ + serial_number?: 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 A status filter to filter readers to only offline or online readers */ + status?: "offline" | "online"; + }; + 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": { + /** @description A list of readers */ + data: components["schemas"]["terminal.reader"][]; + /** @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"]; + }; + }; + }; + }; + PostTerminalReaders: { parameters: { query?: never; header?: never; @@ -63125,28 +70255,18 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** - * create_location_address_param - * @description The full address of the location. - */ - address: { - city?: string; - country: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - /** @description The ID of a configuration that will be used to customize all readers in this location. */ - configuration_overrides?: string; - /** @description A name for the location. Maximum length is 1000 characters. */ - display_name: string; /** @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`. */ + /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ + label?: string; + /** @description The location to assign the reader to. */ + location?: string; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 A code generated by the reader used for registering to an account. */ + registration_code: string; }; }; }; @@ -63157,7 +70277,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.location"]; + "application/json": components["schemas"]["terminal.reader"]; }; }; /** @description Error response. */ @@ -63171,7 +70291,7 @@ export interface operations { }; }; }; - GetTerminalLocationsLocation: { + GetTerminalReadersReader: { parameters: { query?: { /** @description Specifies which fields in the response should be expanded. */ @@ -63179,7 +70299,7 @@ export interface operations { }; header?: never; path: { - location: string; + reader: string; }; cookie?: never; }; @@ -63195,7 +70315,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.location"] | components["schemas"]["deleted_terminal.location"]; + "application/json": components["schemas"]["terminal.reader"] | components["schemas"]["deleted_terminal.reader"]; }; }; /** @description Error response. */ @@ -63209,37 +70329,23 @@ export interface operations { }; }; }; - PostTerminalLocationsLocation: { + PostTerminalReadersReader: { parameters: { query?: never; header?: never; path: { - location: string; + reader: string; }; cookie?: never; }; requestBody?: { content: { "application/x-www-form-urlencoded": { - /** - * optional_fields_address - * @description The full address of the location. You can't change the location's `country`. If you need to modify the `country` field, create a new `Location` object and re-register any existing readers to that location. - */ - address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - /** @description The ID of a configuration that will be used to customize all readers in this location. */ - configuration_overrides?: string | ""; - /** @description A name for the location. */ - display_name?: string; /** @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`. */ + /** @description The new label of the reader. */ + label?: string | ""; + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -63253,7 +70359,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.location"] | components["schemas"]["deleted_terminal.location"]; + "application/json": components["schemas"]["terminal.reader"] | components["schemas"]["deleted_terminal.reader"]; }; }; /** @description Error response. */ @@ -63267,12 +70373,12 @@ export interface operations { }; }; }; - DeleteTerminalLocationsLocation: { + DeleteTerminalReadersReader: { parameters: { query?: never; header?: never; path: { - location: string; + reader: string; }; cookie?: never; }; @@ -63288,7 +70394,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["deleted_terminal.location"]; + "application/json": components["schemas"]["deleted_terminal.reader"]; }; }; /** @description Error response. */ @@ -63302,33 +70408,21 @@ export interface operations { }; }; }; - GetTerminalReaders: { + PostTerminalReadersReaderCancelAction: { parameters: { - query?: { - /** @description Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700" | "verifone_P400"; - /** @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 location ID to filter the response list to only readers at the specific location */ - location?: string; - /** @description Filters readers by serial number */ - serial_number?: 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 A status filter to filter readers to only offline or online readers */ - status?: "offline" | "online"; - }; + query?: never; header?: never; - path?: never; + path: { + reader: string; + }; cookie?: never; }; requestBody?: { content: { - "application/x-www-form-urlencoded": Record; + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; }; }; responses: { @@ -63338,19 +70432,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": { - /** @description A list of readers */ - data: components["schemas"]["terminal.reader"][]; - /** @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; - }; + "application/json": components["schemas"]["terminal.reader"]; }; }; /** @description Error response. */ @@ -63364,11 +70446,13 @@ export interface operations { }; }; }; - PostTerminalReaders: { + PostTerminalReadersReaderCollectInputs: { parameters: { query?: never; header?: never; - path?: never; + path: { + reader: string; + }; cookie?: never; }; requestBody: { @@ -63376,16 +70460,38 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Custom label given to the reader for easier identification. If no label is specified, the registration code will be used. */ - label?: string; - /** @description The location to assign the reader to. */ - location?: 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`. */ + /** @description List of inputs to be collected from the customer using the Reader. Maximum 5 inputs. */ + inputs: { + /** custom_text_params */ + custom_text: { + description?: string; + skip_button?: string; + submit_button?: string; + title: string; + }; + required?: boolean; + /** selection_params */ + selection?: { + choices: { + id: string; + /** @enum {string} */ + style?: "primary" | "secondary"; + text: string; + }[]; + }; + toggles?: { + /** @enum {string} */ + default_value?: "disabled" | "enabled"; + description?: string; + title?: string; + }[]; + /** @enum {string} */ + type: "email" | "numeric" | "phone" | "selection" | "signature" | "text"; + }[]; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 A code generated by the reader used for registering to an account. */ - registration_code: string; + }; }; }; }; @@ -63410,21 +70516,37 @@ export interface operations { }; }; }; - GetTerminalReadersReader: { + PostTerminalReadersReaderCollectPaymentMethod: { parameters: { - query?: { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; + query?: never; header?: never; path: { reader: string; }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/x-www-form-urlencoded": Record; + "application/x-www-form-urlencoded": { + /** + * collect_config + * @description Configuration overrides for this collection, such as tipping, surcharging, and customer cancellation settings. + */ + collect_config?: { + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + enable_customer_cancellation?: boolean; + skip_tipping?: boolean; + /** tipping_config */ + tipping?: { + amount_eligible?: number; + }; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The ID of the PaymentIntent to collect a payment method for. */ + payment_intent: string; + }; }; }; responses: { @@ -63434,7 +70556,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.reader"] | components["schemas"]["deleted_terminal.reader"]; + "application/json": components["schemas"]["terminal.reader"]; }; }; /** @description Error response. */ @@ -63448,7 +70570,7 @@ export interface operations { }; }; }; - PostTerminalReadersReader: { + PostTerminalReadersReaderConfirmPaymentIntent: { parameters: { query?: never; header?: never; @@ -63457,17 +70579,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/x-www-form-urlencoded": { + /** + * confirm_config + * @description Configuration overrides for this confirmation, such as surcharge settings and return URL. + */ + confirm_config?: { + return_url?: string; + }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description The new label of the reader. */ - label?: 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 ID of the PaymentIntent to confirm. */ + payment_intent: string; }; }; }; @@ -63478,7 +70603,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.reader"] | components["schemas"]["deleted_terminal.reader"]; + "application/json": components["schemas"]["terminal.reader"]; }; }; /** @description Error response. */ @@ -63492,7 +70617,7 @@ export interface operations { }; }; }; - DeleteTerminalReadersReader: { + PostTerminalReadersReaderProcessPaymentIntent: { parameters: { query?: never; header?: never; @@ -63501,9 +70626,29 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { - "application/x-www-form-urlencoded": Record; + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The ID of the PaymentIntent to process on the reader. */ + payment_intent: string; + /** + * process_config + * @description Configuration overrides for this transaction, such as tipping and customer cancellation settings. + */ + process_config?: { + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + enable_customer_cancellation?: boolean; + return_url?: string; + skip_tipping?: boolean; + /** tipping_config */ + tipping?: { + amount_eligible?: number; + }; + }; + }; }; }; responses: { @@ -63513,7 +70658,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["deleted_terminal.reader"]; + "application/json": components["schemas"]["terminal.reader"]; }; }; /** @description Error response. */ @@ -63527,7 +70672,7 @@ export interface operations { }; }; }; - PostTerminalReadersReaderCancelAction: { + PostTerminalReadersReaderProcessSetupIntent: { parameters: { query?: never; header?: never; @@ -63536,11 +70681,25 @@ export interface operations { }; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/x-www-form-urlencoded": { + /** + * @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[]; + /** + * process_setup_config + * @description Configuration overrides for this setup, such as MOTO and customer cancellation settings. + */ + process_config?: { + enable_customer_cancellation?: boolean; + }; + /** @description The ID of the SetupIntent to process on the reader. */ + setup_intent: string; }; }; }; @@ -63565,7 +70724,7 @@ export interface operations { }; }; }; - PostTerminalReadersReaderProcessPaymentIntent: { + PostTerminalReadersReaderRefundPayment: { parameters: { query?: never; header?: never; @@ -63574,27 +70733,32 @@ export interface operations { }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { + /** @description A positive integer in __cents__ representing how much of this charge to refund. */ + amount?: number; + /** @description ID of the Charge to refund. */ + charge?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description PaymentIntent ID */ - payment_intent: string; + /** @description Set of [key-value pairs](https://docs.stripe.com/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 ID of the PaymentIntent to refund. */ + payment_intent?: string; + /** @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; /** - * process_config - * @description Configuration overrides + * refund_payment_config + * @description Configuration overrides for this refund, such as customer cancellation settings. */ - process_config?: { - /** @enum {string} */ - allow_redisplay?: "always" | "limited" | "unspecified"; + refund_payment_config?: { enable_customer_cancellation?: boolean; - skip_tipping?: boolean; - /** tipping_config */ - tipping?: { - amount_eligible?: number; - }; }; + /** @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; }; }; }; @@ -63619,7 +70783,7 @@ export interface operations { }; }; }; - PostTerminalReadersReaderProcessSetupIntent: { + PostTerminalReadersReaderSetReaderDisplay: { parameters: { query?: never; header?: never; @@ -63632,21 +70796,27 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * @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} + * cart + * @description Cart details to display on the reader screen, including line items, amounts, and currency. */ - allow_redisplay: "always" | "limited" | "unspecified"; + cart?: { + /** Format: currency */ + currency: string; + line_items: { + amount: number; + description: string; + quantity: number; + }[]; + tax?: number; + total: number; + }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * process_setup_config - * @description Configuration overrides + * @description Type of information to display. Only `cart` is currently supported. + * @enum {string} */ - process_config?: { - enable_customer_cancellation?: boolean; - }; - /** @description SetupIntent ID */ - setup_intent: string; + type: "cart"; }; }; }; @@ -63671,99 +70841,37 @@ export interface operations { }; }; }; - PostTerminalReadersReaderRefundPayment: { + PostTerminalRefunds: { parameters: { query?: never; header?: never; - path: { - reader: string; - }; + path?: never; cookie?: never; }; requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description A positive integer in __cents__ representing how much of this charge to refund. */ + /** @description A positive integer in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. */ amount?: number; - /** @description ID of the Charge to refund. */ + /** @description The identifier of the charge to refund. */ charge?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 ID of the PaymentIntent to refund. */ + /** @description The identifier of the PaymentIntent to refund. */ payment_intent?: string; - /** @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; - /** - * refund_payment_config - * @description Configuration overrides - */ - refund_payment_config?: { - enable_customer_cancellation?: 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"]["terminal.reader"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - PostTerminalReadersReaderSetReaderDisplay: { - parameters: { - query?: never; - header?: never; - path: { - reader: string; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/x-www-form-urlencoded": { - /** - * cart - * @description Cart - */ - cart?: { - /** Format: currency */ - currency: string; - line_items: { - amount: number; - description: string; - quantity: number; - }[]; - tax?: number; - total: number; - }; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; /** - * @description Type + * @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://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. * @enum {string} */ - type: "cart"; + 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; }; }; }; @@ -63774,7 +70882,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.reader"]; + "application/json": components["schemas"]["terminal.refund"]; }; }; /** @description Error response. */ @@ -63837,6 +70945,8 @@ export interface operations { }; /** param */ bancontact?: Record; + /** param */ + billie?: Record; /** billing_details_inner_params */ billing_details?: { address?: { @@ -63850,6 +70960,7 @@ export interface operations { email?: string | ""; name?: string | ""; phone?: string | ""; + tax_id?: string; }; /** param */ blik?: Record; @@ -63860,6 +70971,8 @@ export interface operations { /** param */ cashapp?: Record; /** param */ + crypto?: Record; + /** param */ customer_balance?: Record; /** param */ eps?: { @@ -63878,7 +70991,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "adyen" | "asn_bank" | "bunq" | "buut" | "finom" | "handelsbanken" | "ing" | "knab" | "mollie" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -63899,6 +71012,8 @@ export interface operations { kr_card?: Record; /** param */ link?: Record; + /** param */ + mb_way?: Record; metadata?: { [key: string]: string; }; @@ -63912,6 +71027,15 @@ export interface operations { funding?: "card" | "points"; }; /** param */ + nz_bank_account?: { + account_holder_name?: string; + account_number: string; + bank_code: string; + branch_code: string; + reference?: string; + suffix: string; + }; + /** param */ oxxo?: Record; /** param */ p24?: { @@ -63927,6 +71051,12 @@ export interface operations { /** param */ paypal?: Record; /** param */ + payto?: { + account_number?: string; + bsb_number?: string; + pay_id?: string; + }; + /** param */ pix?: Record; /** param */ promptpay?: Record; @@ -63939,6 +71069,8 @@ export interface operations { /** param */ samsung_pay?: Record; /** param */ + satispay?: Record; + /** param */ sepa_debit?: { iban: string; }; @@ -63952,7 +71084,7 @@ export interface operations { /** param */ twint?: Record; /** @enum {string} */ - 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" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "samsung_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" | "billie" | "blik" | "boleto" | "cashapp" | "crypto" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "kakao_pay" | "klarna" | "konbini" | "kr_card" | "link" | "mb_way" | "mobilepay" | "multibanco" | "naver_pay" | "nz_bank_account" | "oxxo" | "p24" | "pay_by_bank" | "payco" | "paynow" | "paypal" | "payto" | "pix" | "promptpay" | "revolut_pay" | "samsung_pay" | "satispay" | "sepa_debit" | "sofort" | "swish" | "twint" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -63968,12 +71100,32 @@ export interface operations { /** param */ zip?: Record; }; + /** + * test_payment_method_options_param + * @description Payment-method-specific configuration for this ConfirmationToken. + */ + payment_method_options?: { + /** card_param */ + card?: { + /** installments_param */ + installments?: { + /** installment_plan */ + plan: { + count?: number; + /** @enum {string} */ + interval?: "month"; + /** @enum {string} */ + type: "bonus" | "fixed_count" | "revolving"; + }; + }; + }; + }; /** @description Return URL used to confirm the Intent. */ return_url?: string; /** * @description Indicates that you intend to make future payments with this ConfirmationToken's payment method. * - * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. + * The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. * @enum {string} */ setup_future_usage?: "off_session" | "on_session"; @@ -64030,7 +71182,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ + /** @description Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). */ amount: number; /** * Format: currency @@ -64039,7 +71191,7 @@ export interface operations { currency: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) applies to different user inputs. */ + /** @description A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation algorithm](https://docs.stripe.com/payments/customer-balance/reconciliation) applies to different user inputs. */ reference?: string; }; }; @@ -64075,11 +71227,11 @@ export interface operations { requestBody: { 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). */ + /** @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://docs.stripe.com/currencies#zero-decimal). */ 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). + * @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount_details?: { atm_fee?: number; @@ -64137,6 +71289,11 @@ export interface operations { /** @enum {string} */ service_type?: "full_service" | "non_fuel_transaction" | "self_service"; }; + /** + * @description Probability that this transaction can be disputed in the event of fraud. Assessed by comparing the characteristics of the authorization to card network rules. + * @enum {string} + */ + fraud_disputability_likelihood?: "neutral" | "unknown" | "very_likely" | "very_unlikely"; /** * fuel_specs * @description Information about fuel that was purchased with this transaction. @@ -64152,9 +71309,9 @@ export interface operations { /** Format: decimal */ unit_cost_decimal?: string; }; - /** @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. */ + /** @description If set `true`, you may provide [amount](https://docs.stripe.com/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). */ + /** @description The total amount to attempt to authorize. This amount is in the provided merchant currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ merchant_amount?: number; /** * Format: currency @@ -64184,6 +71341,31 @@ export interface operations { network_data?: { acquiring_institution_id?: string; }; + /** + * risk_assessment_specs + * @description Stripe’s assessment of the fraud risk for this authorization. + */ + risk_assessment?: { + /** card_testing_risk_specs */ + card_testing_risk?: { + invalid_account_number_decline_rate_past_hour?: number; + invalid_credentials_decline_rate_past_hour?: number; + /** @enum {string} */ + risk_level: "elevated" | "highest" | "low" | "normal" | "not_assessed" | "unknown"; + }; + /** fraud_risk_specs */ + fraud_risk?: { + /** @enum {string} */ + level: "elevated" | "highest" | "low" | "normal" | "not_assessed" | "unknown"; + score?: number; + }; + /** merchant_dispute_risk_specs */ + merchant_dispute_risk?: { + dispute_rate?: number; + /** @enum {string} */ + risk_level: "elevated" | "highest" | "low" | "normal" | "not_assessed" | "unknown"; + }; + }; /** * verification_data_specs * @description Verifications that Stripe performed on information that the cardholder provided to the merchant. @@ -64251,7 +71433,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ capture_amount?: number; /** @description Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. */ close_authorization?: boolean; @@ -64416,7 +71598,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ final_amount: number; /** * fleet_specs @@ -64549,9 +71731,9 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ increment_amount: number; - /** @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. */ + /** @description If set `true`, you may provide [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */ is_amount_controllable?: boolean; }; }; @@ -64591,7 +71773,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ reverse_amount?: number; }; }; @@ -64951,15 +72133,59 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description The total interchange received as reimbursement for the transactions. */ - interchange_fees?: number; + interchange_fees_amount?: number; /** @description The total net amount required to settle with the network. */ - net_total: number; + net_total_amount: number; + /** + * @description The card network for this settlement. One of ["visa", "maestro"] + * @enum {string} + */ + network?: "maestro" | "visa"; /** @description The Settlement Identification Number assigned by the network. */ network_settlement_identifier?: string; + /** @description The total transaction amount reflected in this settlement. */ + transaction_amount?: number; /** @description The total number of transactions reflected in this settlement. */ transaction_count?: number; - /** @description The total transaction amount reflected in this settlement. */ - transaction_volume?: number; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.settlement"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTestHelpersIssuingSettlementsSettlementComplete: { + parameters: { + query?: never; + header?: never; + path: { + /** @description The settlement token to mark as complete. */ + settlement: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; }; }; }; @@ -64994,7 +72220,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; /** @description Card associated with this transaction. */ card: string; @@ -65138,7 +72364,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ amount: number; /** @description Card associated with this unlinked refund transaction. */ card: string; @@ -65286,7 +72512,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). */ refund_amount?: number; }; }; @@ -65364,6 +72590,16 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Simulated on-reader tip amount. */ amount_tip?: number; + /** + * card + * @description Simulated data for the card payment method. + */ + card?: { + cvc?: string; + exp_month: number; + exp_year: number; + number: string; + }; /** * card_present * @description Simulated data for the card_present payment method. @@ -65384,7 +72620,88 @@ export interface operations { * @description Simulated payment type. * @enum {string} */ - type?: "card_present" | "interac_present"; + type?: "card" | "card_present" | "interac_present"; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["terminal.reader"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTestHelpersTerminalReadersReaderSucceedInputCollection: { + parameters: { + query?: never; + header?: never; + path: { + reader: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * @description This parameter defines the skip behavior for input collection. + * @enum {string} + */ + skip_non_required_inputs?: "all" | "none"; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["terminal.reader"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTestHelpersTerminalReadersReaderTimeoutInputCollection: { + parameters: { + query?: never; + header?: never; + path: { + reader: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; }; }; }; @@ -66137,7 +73454,7 @@ export interface operations { }; }; /** - * @description Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. + * @description Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach" | "us_domestic_wire"; @@ -66203,7 +73520,7 @@ export interface operations { }; }; /** - * @description Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. + * @description Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach"; @@ -66305,7 +73622,19 @@ export interface operations { /** @enum {string} */ ownership_exemption_reason?: "" | "qualified_entity_exceeds_ownership_threshold" | "qualifies_as_financial_institution"; phone?: string; + registration_date?: { + day: number; + month: number; + year: number; + } | ""; registration_number?: string; + /** company_representative_declaration */ + representative_declaration?: { + /** Format: unix-time */ + date?: number; + ip?: string; + user_agent?: string; + }; /** @enum {string} */ structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; @@ -66445,7 +73774,7 @@ export interface operations { }; number: string; } | string; - /** @description Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ + /** @description Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://docs.stripe.com/connect/standard-accounts) or [Stripe-Account header](https://docs.stripe.com/connect/authentication). Learn more about [cloning saved payment methods](https://docs.stripe.com/connect/cloning-saved-payment-methods). */ customer?: string; /** * cvc_params @@ -66537,7 +73866,8 @@ export interface operations { } | ""; nationality?: string; phone?: string; - political_exposure?: string; + /** @enum {string} */ + political_exposure?: "existing" | "none"; /** address_specs */ registered_address?: { city?: string; @@ -66559,6 +73889,20 @@ export interface operations { title?: string; }; ssn_last_4?: string; + /** us_cfpb_data_specs */ + us_cfpb_data?: { + /** us_cfpb_ethnicity_details_specs */ + ethnicity_details?: { + ethnicity?: ("cuban" | "hispanic_or_latino" | "mexican" | "not_hispanic_or_latino" | "other_hispanic_or_latino" | "prefer_not_to_answer" | "puerto_rican")[]; + ethnicity_other?: string; + }; + /** us_cfpb_race_details_specs */ + race_details?: { + race?: ("african_american" | "american_indian_or_alaska_native" | "asian" | "asian_indian" | "black_or_african_american" | "chinese" | "ethiopian" | "filipino" | "guamanian_or_chamorro" | "haitian" | "jamaican" | "japanese" | "korean" | "native_hawaiian" | "native_hawaiian_or_other_pacific_islander" | "nigerian" | "other_asian" | "other_black_or_african_american" | "other_pacific_islander" | "prefer_not_to_answer" | "samoan" | "somali" | "vietnamese" | "white")[]; + race_other?: string; + }; + self_identified_gender?: string; + }; /** person_verification_specs */ verification?: { /** person_verification_document_specs */ @@ -66729,11 +74073,11 @@ export interface operations { description?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). */ + /** @description The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://docs.stripe.com/connect/testing#testing-top-ups)). */ source?: string; /** @description Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters. */ statement_descriptor?: string; @@ -66817,7 +74161,7 @@ export interface operations { description?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -66971,18 +74315,18 @@ export interface operations { destination: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) for details. */ + /** @description You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability) for details. */ source_transaction?: string; /** * @description The source balance to use for this transfer. One of `bank_account`, `card`, or `fpx`. For most users, this will default to `card`. * @enum {string} */ source_type?: "bank_account" | "card" | "fpx"; - /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details. */ + /** @description A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. */ transfer_group?: string; }; }; @@ -67082,7 +74426,7 @@ export interface operations { description?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -67166,7 +74510,7 @@ export interface operations { description?: string; /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -67248,7 +74592,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -67348,7 +74692,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -67490,7 +74834,7 @@ 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -67576,6 +74920,8 @@ export interface operations { limit?: number; /** @description An object ID cursor for use in pagination. */ starting_after?: string; + /** @description Only return FinancialAccounts that have the given status: `open` or `closed` */ + status?: "closed" | "open"; }; header?: never; path?: never; @@ -67652,7 +74998,7 @@ export interface operations { }; /** inbound_transfers */ inbound_transfers?: { - /** access_with_ach_details */ + /** access_with_ach_details_inbound */ ach?: { requested: boolean; }; @@ -67663,7 +75009,7 @@ export interface operations { }; /** outbound_payments */ outbound_payments?: { - /** access_with_ach_details */ + /** access_with_ach_details_outbound */ ach?: { requested: boolean; }; @@ -67674,7 +75020,7 @@ export interface operations { }; /** outbound_transfers */ outbound_transfers?: { - /** access_with_ach_details */ + /** access_with_ach_details_outbound */ ach?: { requested: boolean; }; @@ -67684,7 +75030,7 @@ export interface operations { }; }; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -67800,7 +75146,7 @@ export interface operations { }; /** inbound_transfers */ inbound_transfers?: { - /** access_with_ach_details */ + /** access_with_ach_details_inbound */ ach?: { requested: boolean; }; @@ -67811,7 +75157,7 @@ export interface operations { }; /** outbound_payments */ outbound_payments?: { - /** access_with_ach_details */ + /** access_with_ach_details_outbound */ ach?: { requested: boolean; }; @@ -67822,7 +75168,7 @@ export interface operations { }; /** outbound_transfers */ outbound_transfers?: { - /** access_with_ach_details */ + /** access_with_ach_details_outbound */ ach?: { requested: boolean; }; @@ -67842,7 +75188,7 @@ export interface operations { /** @enum {string} */ type: "financial_account" | "payment_method"; }; - /** @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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; }; @@ -68011,7 +75357,7 @@ export interface operations { * @description Contains settings related to adding funds to a FinancialAccount from another Account with the same owner. */ inbound_transfers?: { - /** access_with_ach_details */ + /** access_with_ach_details_inbound */ ach?: { requested: boolean; }; @@ -68028,7 +75374,7 @@ export interface operations { * @description Includes Features related to initiating money movement out of the FinancialAccount to someone else's bucket of money. */ outbound_payments?: { - /** access_with_ach_details */ + /** access_with_ach_details_outbound */ ach?: { requested: boolean; }; @@ -68042,7 +75388,7 @@ export interface operations { * @description Contains a Feature and settings related to moving money out of the FinancialAccount into another Account with the same owner. */ outbound_transfers?: { - /** access_with_ach_details */ + /** access_with_ach_details_outbound */ ach?: { requested: boolean; }; @@ -68156,13 +75502,13 @@ export interface operations { expand?: string[]; /** @description The FinancialAccount to send funds to. */ financial_account: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 origin payment method to be debited for the InboundTransfer. */ origin_payment_method: string; - /** @description The complete description that appears on your customers' statements. Maximum 10 characters. */ + /** @description The complete description that appears on your customers' statements. Maximum 10 characters. Can only include -#.$&*, spaces, and alphanumeric characters. */ statement_descriptor?: string; }; }; @@ -68412,11 +75758,11 @@ export interface operations { expand?: string[]; /** @description The FinancialAccount to pull funds from. */ financial_account: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment". */ + /** @description The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is "payment". */ statement_descriptor?: string; }; }; @@ -68620,11 +75966,11 @@ export interface operations { expand?: string[]; /** @description The FinancialAccount to pull funds from. */ financial_account: 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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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 Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". */ + /** @description Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". Can only include -#.$&*, spaces, and alphanumeric characters. */ statement_descriptor?: string; }; }; @@ -69215,16 +76561,16 @@ 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" | "2024-09-30.acacia" | "2024-10-28.acacia" | "2024-11-20.acacia" | "2024-12-18.acacia" | "2025-01-27.acacia"; + 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" | "2024-11-20.acacia" | "2024-12-18.acacia" | "2025-01-27.acacia" | "2025-02-24.acacia" | "2025-03-01.dashboard" | "2025-03-31.basil" | "2025-04-30.basil" | "2025-05-28.basil" | "2025-06-30.basil" | "2025-07-30.basil" | "2025-08-27.basil" | "2025-09-30.clover" | "2025-10-29.clover" | "2025-11-17.clover" | "2025-12-15.clover" | "2026-01-28.clover" | "2026-02-25.clover"; /** @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.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")[]; + 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" | "balance_settings.updated" | "billing.alert.triggered" | "billing.credit_grant.created" | "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.account_numbers_updated" | "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" | "financial_connections.account.upcoming_account_number_expiry" | "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.overpaid" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_attempt_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoice_payment.paid" | "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" | "reserve.hold.created" | "reserve.hold.updated" | "reserve.plan.created" | "reserve.plan.disabled" | "reserve.plan.expired" | "reserve.plan.updated" | "reserve.release.created" | "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" | "terminal.reader.action_updated" | "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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; @@ -69309,10 +76655,10 @@ 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.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")[]; + 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" | "balance_settings.updated" | "billing.alert.triggered" | "billing.credit_grant.created" | "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.account_numbers_updated" | "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" | "financial_connections.account.upcoming_account_number_expiry" | "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.overpaid" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_attempt_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoice.will_be_due" | "invoice_payment.paid" | "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" | "reserve.hold.created" | "reserve.hold.updated" | "reserve.plan.created" | "reserve.plan.disabled" | "reserve.plan.expired" | "reserve.plan.updated" | "reserve.release.created" | "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" | "terminal.reader.action_updated" | "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`. */ + /** @description Set of [key-value pairs](https://docs.stripe.com/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; } | ""; diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index 1e48b1d1c..2b39176b8 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -38,13 +38,7 @@ components: description: Business information about the account. nullable: true business_type: - description: >- - The business type. After you create an [Account - Link](/api/account_links) or [Account - Session](/api/account_sessions), this property is only returned for - accounts where - [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) - is `application`, which includes Custom accounts. + description: The business type. enum: - company - government_entity @@ -155,7 +149,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -333,6 +327,20 @@ components: maxLength: 5000 nullable: true type: string + minority_owned_business_designation: + description: >- + Whether the business is a minority-owned, women-owned, and/or + LGBTQI+ -owned business. + items: + enum: + - lgbtqi_owned_business + - minority_owned_business + - none_of_these_apply + - prefer_not_to_answer + - women_owned_business + type: string + nullable: true + type: array monthly_estimated_revenue: $ref: '#/components/schemas/account_monthly_estimated_revenue' name: @@ -467,6 +475,15 @@ components: - inactive - pending type: string + billie_payments: + description: >- + The status of the Billie capability of the account, or whether the + account can directly process Billie payments. + enum: + - active + - inactive + - pending + type: string blik_payments: description: >- The status of the blik payments capability of the account, or @@ -523,6 +540,15 @@ components: - inactive - pending type: string + crypto_payments: + description: >- + The status of the Crypto capability of the account, or whether the + account can directly process Crypto payments. + enum: + - active + - inactive + - pending + type: string eps_payments: description: >- The status of the EPS payments capability of the account, or whether @@ -660,6 +686,15 @@ components: - inactive - pending type: string + mb_way_payments: + description: >- + The status of the MB WAY payments capability of the account, or + whether the account can directly process MB WAY charges. + enum: + - active + - inactive + - pending + type: string mobilepay_payments: description: >- The status of the MobilePay capability of the account, or whether @@ -697,6 +732,16 @@ components: - inactive - pending type: string + nz_bank_account_becs_debit_payments: + description: >- + The status of the New Zealand BECS Direct Debit payments capability + of the account, or whether the account can directly process New + Zealand BECS Direct Debit charges. + enum: + - active + - inactive + - pending + type: string oxxo_payments: description: >- The status of the OXXO payments capability of the account, or @@ -742,6 +787,24 @@ components: - inactive - pending type: string + payto_payments: + description: >- + The status of the PayTo capability of the account, or whether the + account can directly process PayTo charges. + enum: + - active + - inactive + - pending + type: string + pix_payments: + description: >- + The status of the pix payments capability of the account, or whether + the account can directly process pix charges. + enum: + - active + - inactive + - pending + type: string promptpay_payments: description: >- The status of the promptpay payments capability of the account, or @@ -769,6 +832,15 @@ components: - inactive - pending type: string + satispay_payments: + description: >- + The status of the Satispay capability of the account, or whether the + account can directly process Satispay payments. + enum: + - active + - inactive + - pending + type: string sepa_bank_transfer_payments: description: >- The status of the SEPA customer_balance payments (EUR currency) @@ -889,8 +961,12 @@ components: properties: alternatives: description: >- - Fields that are due and can be satisfied by providing the - corresponding alternative fields instead. + Fields that are due and can be resolved by providing the + corresponding alternative fields instead. Multiple alternatives can + reference the same `original_fields_due`. When this happens, any of + these alternatives can serve as a pathway for attempting to resolve + the fields. Additionally, providing `original_fields_due` again also + serves as a pathway for attempting to resolve the fields. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true @@ -907,8 +983,8 @@ components: type: integer currently_due: description: >- - Fields that need to be collected to keep the capability enabled. If - not collected by `future_requirements[current_deadline]`, these + Fields that need to be resolved to keep the capability enabled. If + not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. items: maxLength: 5000 @@ -933,10 +1009,11 @@ components: - requirements.fields_needed nullable: true type: string + x-stripeBypassValidation: true errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' type: array @@ -950,23 +1027,23 @@ components: type: array past_due: description: >- - Fields that weren't collected by `requirements.current_deadline`. - These fields need to be collected to enable the capability on the - account. New fields will never appear here; - `future_requirements.past_due` will always be a subset of - `requirements.past_due`. + Fields that haven't been resolved by + `requirements.current_deadline`. These fields need to be resolved to + enable the capability on the account. `future_requirements.past_due` + is a subset of `requirements.past_due`. items: maxLength: 5000 type: string type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due` or `currently_due`. Fields might appear in - `eventually_due` or `currently_due` and in `pending_verification` if - verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -987,25 +1064,31 @@ components: properties: alternatives: description: >- - Fields that are due and can be satisfied by providing the - corresponding alternative fields instead. + Fields that are due and can be resolved by providing the + corresponding alternative fields instead. Multiple alternatives can + reference the same `original_fields_due`. When this happens, any of + these alternatives can serve as a pathway for attempting to resolve + the fields. Additionally, providing `original_fields_due` again also + serves as a pathway for attempting to resolve the fields. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array current_deadline: description: >- - Date by which the fields in `currently_due` must be collected to - keep the capability enabled for the account. These fields may - disable the capability sooner if the next threshold is reached - before they are collected. + The date by which all required account information must be both + submitted and verified. This includes fields listed in + `currently_due` as well as those in `pending_verification`. If any + required information is missing or unverified by this date, the + account may be disabled. Note that `current_deadline` may change if + additional `currently_due` requirements are requested. format: unix-time nullable: true type: integer currently_due: description: >- - Fields that need to be collected to keep the capability enabled. If - not collected by `current_deadline`, these fields appear in + Fields that need to be resolved to keep the capability enabled. If + not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled. items: maxLength: 5000 @@ -1015,7 +1098,7 @@ components: description: >- Description of why the capability is disabled. [Learn more about handling verification - issues](https://stripe.com/docs/connect/handling-api-verification). + issues](https://docs.stripe.com/connect/handling-api-verification). enum: - other - paused.inactivity @@ -1029,10 +1112,11 @@ components: - requirements.fields_needed nullable: true type: string + x-stripeBypassValidation: true errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' type: array @@ -1047,21 +1131,21 @@ components: type: array past_due: description: >- - Fields that weren't collected by `current_deadline`. These fields - need to be collected to enable the capability on the account. + Fields that haven't been resolved by `current_deadline`. These + fields need to be resolved to enable the capability on the account. items: maxLength: 5000 type: string type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due`, `currently_due`, or `past_due`. Fields might - appear in `eventually_due`, `currently_due`, or `past_due` and in - `pending_verification` if verification fails but another - verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -1172,8 +1256,12 @@ components: properties: alternatives: description: >- - Fields that are due and can be satisfied by providing the - corresponding alternative fields instead. + Fields that are due and can be resolved by providing the + corresponding alternative fields instead. Many alternatives can list + the same `original_fields_due`, and any of these alternatives can + serve as a pathway for attempting to resolve the fields again. + Re-providing `original_fields_due` also serves as a pathway for + attempting to resolve the fields again. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true @@ -1190,8 +1278,8 @@ components: type: integer currently_due: description: >- - Fields that need to be collected to keep the account enabled. If not - collected by `future_requirements[current_deadline]`, these fields + Fields that need to be resolved to keep the account enabled. If not + resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash. items: maxLength: 5000 @@ -1222,8 +1310,8 @@ components: type: string errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' nullable: true @@ -1239,11 +1327,10 @@ components: type: array past_due: description: >- - Fields that weren't collected by `requirements.current_deadline`. - These fields need to be collected to enable the capability on the - account. New fields will never appear here; - `future_requirements.past_due` will always be a subset of - `requirements.past_due`. + Fields that haven't been resolved by + `requirements.current_deadline`. These fields need to be resolved to + enable the capability on the account. `future_requirements.past_due` + is a subset of `requirements.past_due`. items: maxLength: 5000 type: string @@ -1251,12 +1338,13 @@ components: type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due` or `currently_due`. Fields might appear in - `eventually_due` or `currently_due` and in `pending_verification` if - verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -1275,7 +1363,7 @@ components: 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) + documentation](https://docs.stripe.com/connect/platform-pricing-tools) for details. maxLength: 5000 nullable: true @@ -1300,6 +1388,17 @@ components: - $ref: '#/components/schemas/tax_id' nullable: true type: array + hosted_payment_method_save: + description: >- + Whether to save the payment method after a payment is completed for + a one-time invoice or a subscription invoice when the customer + already has a default payment method on the hosted invoice page. + enum: + - always + - never + - offer + nullable: true + type: string title: AccountInvoicesSettings type: object x-expandableFields: @@ -1313,7 +1412,7 @@ components: Related guide: [Connect - Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding) + Onboarding](https://docs.stripe.com/connect/custom/hosted-onboarding) properties: created: description: >- @@ -1394,22 +1493,6 @@ components: maxLength: 5000 nullable: true type: string - statement_descriptor_prefix_kana: - description: >- - The Kana variation of `statement_descriptor_prefix` used for card - charges in Japan. Japanese statement descriptors have [special - requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - maxLength: 5000 - nullable: true - type: string - statement_descriptor_prefix_kanji: - description: >- - The Kanji variation of `statement_descriptor_prefix` used for card - charges in Japan. Japanese statement descriptors have [special - requirements](https://docs.stripe.com/get-started/account/statement-descriptors#set-japanese-statement-descriptors). - maxLength: 5000 - nullable: true - type: string title: AccountPaymentsSettings type: object x-expandableFields: [] @@ -1447,8 +1530,12 @@ components: properties: alternatives: description: >- - Fields that are due and can be satisfied by providing the - corresponding alternative fields instead. + Fields that are due and can be resolved by providing the + corresponding alternative fields instead. Many alternatives can list + the same `original_fields_due`, and any of these alternatives can + serve as a pathway for attempting to resolve the fields again. + Re-providing `original_fields_due` also serves as a pathway for + attempting to resolve the fields again. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true @@ -1463,9 +1550,9 @@ components: type: integer currently_due: description: >- - Fields that need to be collected to keep the account enabled. If not - collected by `current_deadline`, these fields appear in `past_due` - as well, and the account is disabled. + Fields that need to be resolved to keep the account enabled. If not + resolved by `current_deadline`, these fields will appear in + `past_due` as well, and the account is disabled. items: maxLength: 5000 type: string @@ -1475,7 +1562,7 @@ components: description: >- If the account is disabled, this enum describes why. [Learn more about handling verification - issues](https://stripe.com/docs/connect/handling-api-verification). + issues](https://docs.stripe.com/connect/handling-api-verification). enum: - action_required.requested_capabilities - listed @@ -1496,8 +1583,8 @@ components: type: string errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' nullable: true @@ -1514,8 +1601,8 @@ components: type: array past_due: description: >- - Fields that weren't collected by `current_deadline`. These fields - need to be collected to enable the account. + Fields that haven't been resolved by `current_deadline`. These + fields need to be resolved to enable the account. items: maxLength: 5000 type: string @@ -1523,13 +1610,13 @@ components: type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due`, `currently_due`, or `past_due`. Fields might - appear in `eventually_due`, `currently_due`, or `past_due` and in - `pending_verification` if verification fails but another - verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -1545,7 +1632,7 @@ components: properties: alternative_fields_due: description: >- - Fields that can be provided to satisfy all fields in + Fields that can be provided to resolve all fields in `original_fields_due`. items: maxLength: 5000 @@ -1553,7 +1640,7 @@ components: type: array original_fields_due: description: >- - Fields that are due and can be satisfied by providing all fields in + Fields that are due and can be resolved by providing all fields in `alternative_fields_due`. items: maxLength: 5000 @@ -1571,6 +1658,8 @@ components: code: description: The code for the type of error. enum: + - external_request + - information_missing - invalid_address_city_state_postal_code - invalid_address_highway_contract_box - invalid_address_private_mailbox @@ -1583,6 +1672,7 @@ components: - invalid_product_description_length - invalid_product_description_url_match - invalid_representative_country + - invalid_signator - invalid_statement_descriptor_business_mismatch - invalid_statement_descriptor_denylisted - invalid_statement_descriptor_length @@ -1610,6 +1700,7 @@ components: - invalid_url_website_incomplete_under_construction - invalid_url_website_other - invalid_value_other + - unsupported_business_type - verification_directors_mismatch - verification_document_address_mismatch - verification_document_address_missing @@ -1643,6 +1734,7 @@ components: - verification_document_type_not_supported - verification_extraneous_directors - verification_failed_address_match + - verification_failed_authorizer_authority - verification_failed_business_iec_number - verification_failed_document_match - verification_failed_id_number_match @@ -1654,9 +1746,11 @@ components: - verification_failed_residential_address - verification_failed_tax_id_match - verification_failed_tax_id_not_issued + - verification_legal_entity_structure_mismatch - verification_missing_directors - verification_missing_executives - verification_missing_owners + - verification_rejected_ownership_exemption_reason - verification_requires_additional_memorandum_of_associations - verification_requires_additional_proof_of_registration - verification_supportability @@ -1709,7 +1803,7 @@ components: Related guide: [Connect embedded - components](https://stripe.com/docs/connect/get-started-connect-embedded-components) + components](https://docs.stripe.com/connect/get-started-connect-embedded-components) properties: account: description: The ID of the account the AccountSession was created for @@ -1728,7 +1822,7 @@ components: Refer to our docs to [setup Connect embedded - components](https://stripe.com/docs/connect/get-started-connect-embedded-components) + components](https://docs.stripe.com/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled. maxLength: 5000 type: string @@ -1878,7 +1972,7 @@ components: description: >- `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform - controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). + controls](https://docs.stripe.com/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. type: boolean losses: @@ -1981,12 +2075,12 @@ components: nullable: true type: string line1: - description: 'Address line 1 (e.g., street, PO Box, or company name).' + description: 'Address line 1, such as the street, PO Box, or company name.' maxLength: 5000 nullable: true type: string line2: - description: 'Address line 2 (e.g., apartment, suite, unit, or building).' + description: 'Address line 2, such as the apartment, suite, unit, or building.' maxLength: 5000 nullable: true type: string @@ -1996,13 +2090,26 @@ components: nullable: true type: string state: - description: 'State, county, province, or region.' + description: >- + State, county, province, or region ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). maxLength: 5000 nullable: true type: string title: Address type: object x-expandableFields: [] + alma_installments: + description: '' + properties: + count: + description: The number of installments. + type: integer + required: + - count + title: alma_installments + type: object + x-expandableFields: [] amazon_pay_underlying_payment_method_funding_details: description: '' properties: @@ -2025,7 +2132,7 @@ components: description: >- For card errors resulting from a card issuer decline, a short string indicating [how to proceed with an - error](https://stripe.com/docs/declines#retrying-issuer-declines) if + error](https://docs.stripe.com/declines#retrying-issuer-declines) if they provide one. maxLength: 5000 type: string @@ -2037,21 +2144,21 @@ components: description: >- For some errors that could be handled programmatically, a short string indicating the [error - code](https://stripe.com/docs/error-codes) reported. + code](https://docs.stripe.com/error-codes) reported. maxLength: 5000 type: string decline_code: description: >- For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the - decline](https://stripe.com/docs/declines#issuer-declines) if they + decline](https://docs.stripe.com/declines#issuer-declines) if they provide one. maxLength: 5000 type: string doc_url: description: >- A URL to more information about the [error - code](https://stripe.com/docs/error-codes) reported. + code](https://docs.stripe.com/error-codes) reported. maxLength: 5000 type: string message: @@ -2069,9 +2176,8 @@ components: type: string network_decline_code: description: >- - For card errors resulting from a card issuer decline, a brand - specific 2, 3, or 4 digit code which indicates the reason the - authorization failed. + For payments declined by the network, an alphanumeric code which + indicates the reason the payment failed. maxLength: 5000 type: string param: @@ -2104,7 +2210,7 @@ components: - $ref: '#/components/schemas/card' - $ref: '#/components/schemas/source' description: >- - The [source object](https://stripe.com/docs/api/sources/object) for + The [source object](https://docs.stripe.com/api/sources/object) for errors returned on a request involving a source. x-stripeBypassValidation: true type: @@ -2372,7 +2478,7 @@ components: Related guide: [Store data between page - reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects) + reloads](https://docs.stripe.com/stripe-apps/store-auth-data-custom-objects) properties: created: description: >- @@ -2443,7 +2549,7 @@ components: description: >- Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified - [tax rates](https://stripe.com/docs/api/tax_rates), negative + [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. type: boolean @@ -2456,6 +2562,11 @@ components: from this account. The tax transaction is returned in the report of the connected account. nullable: true + provider: + description: The tax provider powering automatic tax. + maxLength: 5000 + nullable: true + type: string status: description: >- The status of the most recent automated tax calculation for this @@ -2480,31 +2591,22 @@ components: the balance currently on your Stripe account. - You can also retrieve the balance history, which contains a list of - - [transactions](https://stripe.com/docs/reporting/balance-transaction-types) - that contributed to the balance - - (charges, payouts, and so forth). - - - The available and pending amounts for each currency are broken down - further by - - payment source types. + The top-level `available` and `pending` comprise your "payments + balance." - Related guide: [Understanding Connect account - balances](https://stripe.com/docs/connect/account-balances) + Related guide: [Balances and settlement + time](https://docs.stripe.com/payments/balances), [Understanding Connect + account balances](https://docs.stripe.com/connect/account-balances) properties: available: description: >- Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers - API](https://stripe.com/docs/api#transfers) or [Payouts - API](https://stripe.com/docs/api#payouts). You can find the - available balance for each currency and payment type in the - `source_types` property. + API](https://api.stripe.com#transfers) or [Payouts + API](https://api.stripe.com#payouts). You can find the available + balance for each currency and payment type in the `source_types` + property. items: $ref: '#/components/schemas/balance_amount' type: array @@ -2545,6 +2647,8 @@ components: items: $ref: '#/components/schemas/balance_amount' type: array + refund_and_dispute_prefunding: + $ref: '#/components/schemas/balance_detail_ungated' required: - available - livemode @@ -2558,6 +2662,7 @@ components: - instant_available - issuing - pending + - refund_and_dispute_prefunding x-resourceId: balance balance_amount: description: '' @@ -2586,13 +2691,20 @@ components: description: '' properties: bank_account: - description: Amount for bank account. + description: >- + Amount coming from [legacy US ACH + payments](https://docs.stripe.com/ach-deprecated). type: integer card: - description: Amount for card. + description: >- + Amount coming from most payment methods, including cards as well as + [non-legacy bank + debits](https://docs.stripe.com/payments/bank-debits). type: integer fpx: - description: Amount for FPX. + description: >- + Amount coming from [FPX](https://docs.stripe.com/payments/fpx), a + Malaysian payment method. type: integer title: BalanceAmountBySourceType type: object @@ -2640,6 +2752,27 @@ components: type: object x-expandableFields: - available + balance_detail_ungated: + description: '' + properties: + available: + description: Funds that are available for use. + items: + $ref: '#/components/schemas/balance_amount' + type: array + pending: + description: Funds that are pending + items: + $ref: '#/components/schemas/balance_amount' + type: array + required: + - available + - pending + title: BalanceDetailUngated + type: object + x-expandableFields: + - available + - pending balance_net_available: description: '' properties: @@ -2659,6 +2792,155 @@ components: type: object x-expandableFields: - source_types + balance_settings: + description: >- + Options for customizing account balances and payout settings for a + Stripe platform’s connected accounts. + properties: + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - balance_settings + type: string + payments: + $ref: '#/components/schemas/balance_settings_resource_payments' + required: + - object + - payments + title: BalanceSettingsResourceBalanceSettings + type: object + x-expandableFields: + - payments + x-resourceId: balance_settings + balance_settings_resource_payments: + description: '' + properties: + debit_negative_balances: + description: >- + A Boolean indicating if Stripe should try to reclaim negative + balances from an attached bank account. See [Understanding Connect + account balances](/connect/account-balances) for details. The + default value is `false` when + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `application`, which includes Custom accounts, otherwise `true`. + nullable: true + type: boolean + payouts: + anyOf: + - $ref: '#/components/schemas/balance_settings_resource_payouts' + description: Settings specific to the account's payouts. + nullable: true + settlement_timing: + $ref: '#/components/schemas/balance_settings_resource_settlement_timing' + required: + - settlement_timing + title: BalanceSettingsResourcePayments + type: object + x-expandableFields: + - payouts + - settlement_timing + balance_settings_resource_payout_schedule: + description: '' + properties: + interval: + description: >- + How frequently funds will be paid out. One of `manual` (payouts only + created via API call), `daily`, `weekly`, or `monthly`. + enum: + - daily + - manual + - monthly + - weekly + nullable: true + type: string + monthly_payout_days: + description: >- + The day of the month funds will be paid out. Only shown if + `interval` is monthly. Payouts scheduled between the 29th and 31st + of the month are sent on the last day of shorter months. + items: + type: integer + type: array + weekly_payout_days: + description: >- + The days of the week when available funds are paid out, specified as + an array, for example, [`monday`, `tuesday`]. Only shown if + `interval` is weekly. + items: + enum: + - friday + - monday + - thursday + - tuesday + - wednesday + type: string + x-stripeBypassValidation: true + type: array + title: BalanceSettingsResourcePayoutSchedule + type: object + x-expandableFields: [] + balance_settings_resource_payouts: + description: '' + properties: + minimum_balance_by_currency: + additionalProperties: + type: integer + description: >- + The minimum balance amount to retain per currency after automatic + payouts. Only funds that exceed these amounts are paid out. Learn + more about the [minimum balances for automatic + payouts](/payouts/minimum-balances-for-automatic-payouts). + nullable: true + type: object + schedule: + anyOf: + - $ref: '#/components/schemas/balance_settings_resource_payout_schedule' + description: >- + Details on when funds from charges are available, and when they are + paid out to an external account. See our [Setting Bank and Debit + Card + Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) + documentation for details. + nullable: true + statement_descriptor: + description: >- + The text that appears on the bank account statement for payouts. If + not set, this defaults to the platform's bank descriptor as set in + the Dashboard. + maxLength: 5000 + nullable: true + type: string + status: + description: Whether the funds in this account can be paid out. + enum: + - disabled + - enabled + type: string + required: + - status + title: BalanceSettingsResourcePayouts + type: object + x-expandableFields: + - schedule + balance_settings_resource_settlement_timing: + description: '' + properties: + delay_days: + description: The number of days charge funds are held before becoming available. + type: integer + delay_days_override: + description: >- + The number of days charge funds are held before becoming available. + If present, overrides the default, or minimum available, for the + account. + type: integer + required: + - delay_days + title: BalanceSettingsResourceSettlementTiming + type: object + x-expandableFields: [] balance_transaction: description: >- Balance transactions represent funds moving through your Stripe account. @@ -2668,7 +2950,7 @@ components: Related guide: [Balance transaction - types](https://stripe.com/docs/reports/balance-transaction-types) + types](https://docs.stripe.com/reports/balance-transaction-types) properties: amount: description: >- @@ -2682,6 +2964,15 @@ components: Stripe balance. format: unix-time type: integer + balance_type: + description: The balance that this transaction impacts. + enum: + - issuing + - payments + - refund_and_dispute_prefunding + - risk_reserved + type: string + x-stripeBypassValidation: true created: description: >- Time at which the object was created. Measured in seconds since the @@ -2815,10 +3106,12 @@ components: `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, - `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, - `transfer`, `transfer_cancel`, `transfer_failure`, or - `transfer_refund`. Learn more about [balance transaction types and - what they + `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, + `stripe_balance_payment_debit`, + `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, + `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, + or `transfer_refund`. Learn more about [balance transaction types + and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead. @@ -2854,8 +3147,12 @@ components: - payout_minimum_balance_release - refund - refund_failure + - reserve_hold + - reserve_release - reserve_transaction - reserved_funds + - stripe_balance_payment_debit + - stripe_balance_payment_debit_reversal - stripe_fee - stripe_fx_fee - tax_fee @@ -2869,6 +3166,7 @@ components: required: - amount - available_on + - balance_type - created - currency - fee @@ -2907,7 +3205,13 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' - description: The ID of the account that the bank account is associated with. + description: >- + The account this bank account belongs to. Only applicable on + Accounts (not customers or recipients) This property is only + available when returned as an [External + Account](/api/external_account_bank_accounts/object) where + [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) + is `true`. nullable: true x-expansionResources: oneOf: @@ -2993,7 +3297,7 @@ components: - $ref: '#/components/schemas/external_account_requirements' description: >- Information about the [upcoming new requirements for the bank - account](https://stripe.com/docs/connect/custom-accounts/future-requirements), + account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when. nullable: true id: @@ -3009,7 +3313,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -3036,25 +3340,31 @@ components: status: description: >- For bank accounts, possible values are `new`, `validated`, - `verified`, `verification_failed`, or `errored`. A bank account that - hasn't had any activity or validation performed is `new`. If Stripe - can determine that the bank account exists, its status will be - `validated`. Note that there often isn’t enough information to know - (e.g., for smaller credit unions), and the validation is not always - run. If customer bank account verification has succeeded, the bank - account status will be `verified`. If the verification failed for - any reason, such as microdeposit failure, the status will be - `verification_failed`. If a payout sent to this bank account fails, - we'll set the status to `errored` and will not continue to send - [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) - until the bank details are updated. - - - For external accounts, possible values are `new`, `errored` and - `verification_failed`. If a payout fails, the status is set to - `errored` and scheduled payouts are stopped until account details - are updated. In the US and India, if we can't [verify the owner of - the bank + `verified`, `verification_failed`, + `tokenized_account_number_deactivated` or `errored`. A bank account + that hasn't had any activity or validation performed is `new`. If + Stripe can determine that the bank account exists, its status will + be `validated`. Note that there often isn’t enough information to + know (e.g., for smaller credit unions), and the validation is not + always run. If customer bank account verification has succeeded, the + bank account status will be `verified`. If the verification failed + for any reason, such as microdeposit failure, the status will be + `verification_failed`. If the status is + `tokenized_account_number_deactivated`, the account utilizes a + tokenized account number which has been deactivated due to + expiration or revocation. This account will need to be reverified to + continue using it for money movement. If a payout sent to this bank + account fails, we'll set the status to `errored` and will not + continue to send [scheduled + payouts](https://stripe.com/docs/payouts#payout-schedule) until the + bank details are updated. + + + For external accounts, possible values are `new`, `errored`, + `verification_failed`, and `tokenized_account_number_deactivated`. + If a payout fails, the status is set to `errored` and scheduled + payouts are stopped until account details are updated. In the US and + India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for @@ -3076,6 +3386,43 @@ components: - future_requirements - requirements x-resourceId: bank_account + bank_connections_resource_account_number_details: + description: '' + properties: + expected_expiry_date: + description: 'When the account number is expected to expire, if applicable.' + format: unix-time + nullable: true + type: integer + identifier_type: + description: The type of account number associated with the account. + enum: + - account_number + - tokenized_account_number + type: string + status: + description: >- + Whether the account number is currently active and usable for + transactions. + enum: + - deactivated + - transactable + type: string + supported_networks: + description: The payment networks that the account number can be used for. + items: + enum: + - ach + type: string + x-stripeBypassValidation: true + type: array + required: + - identifier_type + - status + - supported_networks + title: BankConnectionsResourceAccountNumberDetails + type: object + x-expandableFields: [] bank_connections_resource_accountholder: description: '' properties: @@ -3085,8 +3432,8 @@ components: type: string - $ref: '#/components/schemas/account' description: >- - The ID of the Stripe account this account belongs to. Should only be - present if `account_holder.type` is `account`. + The ID of the Stripe account that this account belongs to. Only + available when `account_holder.type` is `account`. x-expansionResources: oneOf: - $ref: '#/components/schemas/account' @@ -3096,11 +3443,14 @@ components: type: string - $ref: '#/components/schemas/customer' description: >- - ID of the Stripe customer this account belongs to. Present if and - only if `account_holder.type` is `customer`. + The ID for an Account representing a customer that this account + belongs to. Only available when `account_holder.type` is `customer`. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + maxLength: 5000 + type: string type: description: Type of account holder that this account belongs to. enum: @@ -3400,7 +3750,7 @@ components: - $ref: '#/components/schemas/thresholds_resource_usage_threshold_config' description: >- Encapsulates configuration of the alert to monitor usage on a - specific [Billing Meter](https://stripe.com/docs/api/billing/meter). + specific [Billing Meter](https://docs.stripe.com/api/billing/meter). nullable: true required: - alert_type @@ -3437,6 +3787,11 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: The account the balance is for. + maxLength: 5000 + nullable: true + type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -3587,6 +3942,13 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + ID of the account representing the customer receiving the billing + credits + maxLength: 5000 + nullable: true + type: string effective_at: description: >- The time when the billing credits become effective-when they're @@ -3615,7 +3977,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -3631,6 +3993,12 @@ components: enum: - billing.credit_grant type: string + priority: + description: >- + The priority for applying this credit grant. The highest priority is + 0 and the lowest is 100. + nullable: true + type: integer test_clock: anyOf: - maxLength: 5000 @@ -3705,7 +4073,9 @@ components: maxLength: 5000 type: string event_time_window: - description: 'The time window to pre-aggregate meter events for, if any.' + description: >- + The time window which meter events have been pre-aggregated for, if + any. enum: - day - hour @@ -3809,7 +4179,7 @@ components: a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the - [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). + [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes). type: object timestamp: description: >- @@ -3891,6 +4261,10 @@ components: indicates how much usage was accrued by a customer for that period. + + + Note: Meters events are aggregated asynchronously so the meter event + summaries provide an eventually consistent view of the reported usage. properties: aggregated_value: description: >- @@ -3942,6 +4316,369 @@ components: type: object x-expandableFields: [] x-resourceId: billing.meter_event_summary + billing_bill_resource_invoice_item_parents_invoice_item_parent: + description: '' + properties: + subscription_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent + description: Details about the subscription that generated this invoice item + nullable: true + type: + description: The type of parent that generated this invoice item + enum: + - subscription_details + type: string + x-stripeBypassValidation: true + required: + - type + title: BillingBillResourceInvoiceItemParentsInvoiceItemParent + type: object + x-expandableFields: + - subscription_details + billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent: + description: '' + properties: + subscription: + description: The subscription that generated this invoice item + maxLength: 5000 + type: string + subscription_item: + description: The subscription item that generated this invoice item + maxLength: 5000 + type: string + required: + - subscription + title: BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent + type: object + x-expandableFields: [] + billing_bill_resource_invoicing_lines_common_credited_items: + description: '' + properties: + invoice: + description: Invoice containing the credited invoice line items + maxLength: 5000 + type: string + invoice_line_items: + description: Credited invoice line items + items: + maxLength: 5000 + type: string + type: array + required: + - invoice + - invoice_line_items + title: BillingBillResourceInvoicingLinesCommonCreditedItems + type: object + x-expandableFields: [] + billing_bill_resource_invoicing_lines_common_proration_details: + description: '' + properties: + credited_items: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_lines_common_credited_items + description: >- + For a credit proration `line_item`, the original debit line_items to + which the credit proration applies. + nullable: true + title: BillingBillResourceInvoicingLinesCommonProrationDetails + type: object + x-expandableFields: + - credited_items + billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent: + description: '' + properties: + invoice_item: + description: The invoice item that generated this line item + maxLength: 5000 + type: string + proration: + description: Whether this is a proration + type: boolean + proration_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details + description: Additional details for proration line items + nullable: true + subscription: + description: The subscription that the invoice item belongs to + maxLength: 5000 + nullable: true + type: string + required: + - invoice_item + - proration + title: BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent + type: object + x-expandableFields: + - proration_details + billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent: + description: '' + properties: + invoice_item_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent + description: Details about the invoice item that generated this line item + nullable: true + subscription_item_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent + description: Details about the subscription item that generated this line item + nullable: true + type: + description: The type of parent that generated this line item + enum: + - invoice_item_details + - subscription_item_details + type: string + x-stripeBypassValidation: true + required: + - type + title: BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent + type: object + x-expandableFields: + - invoice_item_details + - subscription_item_details + billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent: + description: '' + properties: + invoice_item: + description: The invoice item that generated this line item + maxLength: 5000 + nullable: true + type: string + proration: + description: Whether this is a proration + type: boolean + proration_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details + description: Additional details for proration line items + nullable: true + subscription: + description: The subscription that the subscription item belongs to + maxLength: 5000 + nullable: true + type: string + subscription_item: + description: The subscription item that generated this line item + maxLength: 5000 + type: string + required: + - proration + - subscription_item + title: >- + BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent + type: object + x-expandableFields: + - proration_details + billing_bill_resource_invoicing_parents_invoice_parent: + description: '' + properties: + quote_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent + description: Details about the quote that generated this invoice + nullable: true + subscription_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent + description: Details about the subscription that generated this invoice + nullable: true + type: + description: The type of parent that generated this invoice + enum: + - quote_details + - subscription_details + type: string + x-stripeBypassValidation: true + required: + - type + title: BillingBillResourceInvoicingParentsInvoiceParent + type: object + x-expandableFields: + - quote_details + - subscription_details + billing_bill_resource_invoicing_parents_invoice_quote_parent: + description: '' + properties: + quote: + description: The quote that generated this invoice + maxLength: 5000 + type: string + required: + - quote + title: BillingBillResourceInvoicingParentsInvoiceQuoteParent + type: object + x-expandableFields: [] + billing_bill_resource_invoicing_parents_invoice_subscription_parent: + description: '' + properties: + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://docs.stripe.com/api/metadata) + defined as subscription metadata when an invoice is created. Becomes + an immutable snapshot of the subscription metadata at the time of + invoice finalization. + *Note: This attribute is populated only for invoices created on or after June 29, 2023.* + nullable: true + type: object + subscription: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/subscription' + description: The subscription that generated this invoice + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/subscription' + subscription_proration_date: + description: >- + Only set for upcoming invoices that preview prorations. The time + used to calculate prorations. + format: unix-time + type: integer + required: + - subscription + title: BillingBillResourceInvoicingParentsInvoiceSubscriptionParent + type: object + x-expandableFields: + - subscription + billing_bill_resource_invoicing_pricing_pricing: + description: '' + properties: + price_details: + $ref: >- + #/components/schemas/billing_bill_resource_invoicing_pricing_pricing_price_details + type: + description: The type of the pricing details. + enum: + - price_details + type: string + x-stripeBypassValidation: true + unit_amount_decimal: + description: >- + The unit amount (in the `currency` specified) of the item which + contains a decimal value with at most 12 decimal places. + format: decimal + nullable: true + type: string + required: + - type + title: BillingBillResourceInvoicingPricingPricing + type: object + x-expandableFields: + - price_details + billing_bill_resource_invoicing_pricing_pricing_price_details: + description: '' + properties: + price: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/price' + description: The ID of the price this item is associated with. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/price' + product: + description: The ID of the product this item is associated with. + maxLength: 5000 + type: string + required: + - price + - product + title: BillingBillResourceInvoicingPricingPricingPriceDetails + type: object + x-expandableFields: + - price + billing_bill_resource_invoicing_taxes_tax: + description: '' + properties: + amount: + description: 'The amount of the tax, in cents (or local equivalent).' + type: integer + tax_behavior: + description: Whether this tax is inclusive or exclusive. + enum: + - exclusive + - inclusive + type: string + tax_rate_details: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_taxes_tax_rate_details + description: >- + Additional details about the tax rate. Only present when `type` is + `tax_rate_details`. + nullable: true + taxability_reason: + description: >- + The reasoning behind this tax, for example, if the product is tax + exempt. The possible values for this field may be extended as new + tax rules are supported. + enum: + - customer_exempt + - not_available + - not_collecting + - not_subject_to_tax + - not_supported + - portion_product_exempt + - portion_reduced_rated + - portion_standard_rated + - product_exempt + - product_exempt_holiday + - proportionally_rated + - reduced_rated + - reverse_charge + - standard_rated + - taxable_basis_reduced + - zero_rated + type: string + x-stripeBypassValidation: true + taxable_amount: + description: >- + The amount on which tax is calculated, in cents (or local + equivalent). + nullable: true + type: integer + type: + description: The type of tax information. + enum: + - tax_rate_details + type: string + required: + - amount + - tax_behavior + - taxability_reason + - type + title: BillingBillResourceInvoicingTaxesTax + type: object + x-expandableFields: + - tax_rate_details + billing_bill_resource_invoicing_taxes_tax_rate_details: + description: '' + properties: + tax_rate: + description: ID of the tax rate + maxLength: 5000 + type: string + required: + - tax_rate + title: BillingBillResourceInvoicingTaxesTaxRateDetails + type: object + x-expandableFields: [] billing_clocks_resource_status_details_advancing_status_details: description: '' properties: @@ -3980,6 +4717,7 @@ components: enum: - monetary type: string + x-stripeBypassValidation: true required: - type title: BillingCreditGrantsResourceAmount @@ -3997,6 +4735,17 @@ components: type: object x-expandableFields: - scope + billing_credit_grants_resource_applicable_price: + description: '' + properties: + id: + description: Unique identifier for the object. + maxLength: 5000 + nullable: true + type: string + title: BillingCreditGrantsResourceApplicablePrice + type: object + x-expandableFields: [] billing_credit_grants_resource_balance_credit: description: '' properties: @@ -4131,15 +4880,24 @@ components: The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached - to them. + to them. Cannot be used in combination with `prices`. enum: - metered type: string - required: - - price_type + prices: + description: >- + The prices that credit grants can apply to. We currently only + support `metered` prices. This refers to prices that have a [Billing + Meter](https://docs.stripe.com/api/billing/meter) attached to them. + Cannot be used in combination with `price_type`. + items: + $ref: >- + #/components/schemas/billing_credit_grants_resource_applicable_price + type: array title: BillingCreditGrantsResourceScope type: object - x-expandableFields: [] + x-expandableFields: + - prices billing_details: description: '' properties: @@ -4163,6 +4921,13 @@ components: maxLength: 5000 nullable: true type: string + tax_id: + description: >- + Taxpayer identification number. Used only for transactions between + LATAM buyers and non-LATAM sellers. + maxLength: 5000 + nullable: true + type: string title: billing_details type: object x-expandableFields: @@ -4174,8 +4939,10 @@ components: description: Specifies how events are aggregated. enum: - count + - last - sum type: string + x-stripeBypassValidation: true required: - formula title: BillingMeterResourceAggregationSettings @@ -4241,8 +5008,9 @@ components: x-expandableFields: [] billing_portal.configuration: description: >- - A portal configuration describes the functionality and behavior of a - portal session. + A portal configuration describes the functionality and behavior you + embed in a portal session. Related guide: [Configure the customer + portal](/customer-management/configure-portal). properties: active: description: >- @@ -4273,7 +5041,7 @@ components: description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. This can be - [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) + [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. maxLength: 5000 nullable: true @@ -4303,11 +5071,16 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. nullable: true type: object + name: + description: The name of the configuration. + maxLength: 5000 + nullable: true + type: string object: description: >- String representing the object's type. Objects of the same type @@ -4391,13 +5164,18 @@ components: description: The ID of the customer for this session. maxLength: 5000 type: string + customer_account: + description: The ID of the account for this session. + maxLength: 5000 + nullable: true + type: string flow: anyOf: - $ref: '#/components/schemas/portal_flows_flow' description: >- Information about a specific flow for the customer to go through. See the - [docs](https://stripe.com/docs/customer-management/portal-deep-links) + [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. nullable: true id: @@ -4476,9 +5254,9 @@ components: The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the - [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). + [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts - API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) + API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. maxLength: 5000 @@ -4553,7 +5331,7 @@ components: Related guide: [Account - capabilities](https://stripe.com/docs/connect/account-capabilities) + capabilities](https://docs.stripe.com/connect/account-capabilities) properties: account: anyOf: @@ -4593,11 +5371,11 @@ components: description: The status of the capability. enum: - active - - disabled - inactive - pending - unrequested type: string + x-stripeBypassValidation: true required: - account - id @@ -4623,19 +5401,13 @@ components: Related guide: [Card payments with - Sources](https://stripe.com/docs/sources/cards) + Sources](https://docs.stripe.com/sources/cards) properties: account: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' - description: >- - The account this card belongs to. This attribute will not be in the - card object if the card belongs to a customer or recipient instead. - This property is only available for accounts where - [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) - is `application`, which includes Custom accounts. nullable: true x-expansionResources: oneOf: @@ -4710,9 +5482,9 @@ components: type: array brand: description: >- - Card brand. Can be `American Express`, `Diners Club`, `Discover`, - `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, - `Visa`, or `Unknown`. + Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners + Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, + `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. maxLength: 5000 type: string country: @@ -4731,9 +5503,10 @@ components: currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is - only available for accounts where - [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) - is `application`, which includes Custom accounts. + only available when returned as an [External + Account](/api/external_account_cards/object) where + [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) + is `true`. format: currency nullable: true type: string @@ -4824,7 +5597,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -4944,13 +5717,20 @@ components: A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true type: object customer: description: The ID of the customer whose cash balance this object represents. maxLength: 5000 type: string + customer_account: + description: >- + The ID of an Account representing a customer whose cash balance this + object represents. + maxLength: 5000 + nullable: true + type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -4981,10 +5761,8 @@ components: Stripe account. PaymentIntent confirmation is the most common way to create Charges, but - transferring - - money to a different Stripe account through Connect also creates - Charges. + [Account Debits](https://docs.stripe.com/connect/account-debits) may + also create Charges. Some legacy payment flows create Charges directly, which is not recommended for new integrations. @@ -4993,10 +5771,10 @@ components: description: >- Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge - currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). + currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer @@ -5027,7 +5805,7 @@ components: - $ref: '#/components/schemas/application_fee' description: >- The application fee (if any) for the charge. [See the Connect - documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) + documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. nullable: true x-expansionResources: @@ -5037,7 +5815,7 @@ components: description: >- The amount of the application fee (if any) requested for the charge. [See the Connect - documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) + documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. nullable: true type: integer @@ -5121,7 +5899,7 @@ components: failure_code: description: >- Error code explaining reason for charge failure if available (see - [the errors section](https://stripe.com/docs/error-codes) for a list + [the errors section](https://docs.stripe.com/error-codes) for a list of codes). maxLength: 5000 nullable: true @@ -5142,16 +5920,6 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string - invoice: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: ID of the invoice this charge is for if one exists. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -5162,7 +5930,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -5181,7 +5949,7 @@ components: description: >- The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. nullable: true x-expansionResources: @@ -5192,7 +5960,7 @@ components: - $ref: '#/components/schemas/charge_outcome' description: >- Details about whether the payment was accepted, and why. See - [understanding declines](https://stripe.com/docs/declines) for + [understanding declines](https://docs.stripe.com/declines) for details. nullable: true paid: @@ -5220,6 +5988,9 @@ components: - $ref: '#/components/schemas/payment_method_details' description: Details about the payment method at the time of the transaction. nullable: true + presentment_details: + $ref: >- + #/components/schemas/payment_flows_payment_intent_presentment_details radar_options: $ref: '#/components/schemas/radar_radar_options' receipt_email: @@ -5366,14 +6137,14 @@ components: description: >- An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect - documentation](https://stripe.com/docs/connect/destination-charges) + documentation](https://docs.stripe.com/connect/destination-charges) for details. nullable: true transfer_group: description: >- A string that identifies this transaction as part of a group. See the [Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. maxLength: 5000 nullable: true @@ -5404,11 +6175,11 @@ components: - customer - failure_balance_transaction - fraud_details - - invoice - on_behalf_of - outcome - payment_intent - payment_method_details + - presentment_details - radar_options - refunds - review @@ -5440,7 +6211,7 @@ components: description: >- An enumerated value providing a more detailed explanation on [how to proceed with an - error](https://stripe.com/docs/declines#retrying-issuer-declines). + error](https://docs.stripe.com/declines#retrying-issuer-declines). enum: - confirm_card_data - do_not_try_again @@ -5456,8 +6227,8 @@ components: type: string network_decline_code: description: >- - For charges declined by the network, a brand specific 2, 3, or 4 - digit code which indicates the reason the authorization failed. + For charges declined by the network, an alphanumeric code which + indicates the reason the charge failed. maxLength: 5000 nullable: true type: string @@ -5466,7 +6237,7 @@ components: Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by - Stripe](https://stripe.com/docs/declines#blocked-payments) after + Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. maxLength: 5000 @@ -5478,9 +6249,11 @@ components: outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges - authorized, blocked, or placed in review by custom rules have the - value `rule`. See [understanding - declines](https://stripe.com/docs/declines) for more details. + blocked because the payment is unlikely to be authorized have the + value `low_probability_of_authorization`. Charges authorized, + blocked, or placed in review by custom rules have the value `rule`. + See [understanding declines](https://docs.stripe.com/declines) for + more details. maxLength: 5000 nullable: true type: string @@ -5524,8 +6297,8 @@ components: description: >- Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding - declines](https://stripe.com/docs/declines) and [Radar - reviews](https://stripe.com/docs/radar/reviews) for details. + declines](https://docs.stripe.com/declines) and [Radar + reviews](https://docs.stripe.com/radar/reviews) for details. maxLength: 5000 type: string required: @@ -5566,9 +6339,9 @@ components: A Checkout Session represents your customer's session as they pay for one-time purchases or subscriptions through - [Checkout](https://stripe.com/docs/payments/checkout) + [Checkout](https://docs.stripe.com/payments/checkout) - or [Payment Links](https://stripe.com/docs/payments/payment-links). We + or [Payment Links](https://docs.stripe.com/payments/payment-links). We recommend creating a new Session each time your customer attempts to pay. @@ -5577,13 +6350,13 @@ components: Once payment is successful, the Checkout Session will contain a reference - to the [Customer](https://stripe.com/docs/api/customers), and either the + to the [Customer](https://docs.stripe.com/api/customers), and either the successful - [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an + [PaymentIntent](https://docs.stripe.com/api/payment_intents) or an active - [Subscription](https://stripe.com/docs/api/subscriptions). + [Subscription](https://docs.stripe.com/api/subscriptions). You can create a Checkout Session on your server and redirect to its URL @@ -5592,7 +6365,7 @@ components: Related guide: [Checkout - quickstart](https://stripe.com/docs/checkout/quickstart) + quickstart](https://docs.stripe.com/checkout/quickstart) properties: adaptive_pricing: anyOf: @@ -5633,6 +6406,9 @@ components: - required nullable: true type: string + branding_settings: + $ref: >- + #/components/schemas/payment_pages_checkout_session_branding_settings cancel_url: description: >- If set, Checkout displays a back button and customers will be @@ -5651,11 +6427,22 @@ components: type: string client_secret: description: >- - Client secret to be used when initializing Stripe.js embedded - checkout. + The client secret of your Checkout Session. Applies to Checkout + Sessions with `ui_mode: embedded` or `ui_mode: custom`. For + `ui_mode: embedded`, the client secret is to be used when + initializing Stripe.js embedded checkout. + For `ui_mode: custom`, use the client secret with [initCheckout](https://docs.stripe.com/js/custom_checkout/init) on your front end. maxLength: 5000 nullable: true type: string + collected_information: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_collected_information + description: >- + Information about the customer collected within the Checkout + Session. + nullable: true consent: anyOf: - $ref: '#/components/schemas/payment_pages_checkout_session_consent' @@ -5691,12 +6478,13 @@ components: description: >- Currency conversion details for [Adaptive Pricing](https://docs.stripe.com/payments/checkout/adaptive-pricing) - sessions + sessions created before 2025-03-31. nullable: true custom_fields: description: >- Collect additional information from your customer using custom - fields. Up to 3 fields are supported. + fields. Up to 3 fields are supported. You can't set this parameter + if `ui_mode` is `custom`. items: $ref: '#/components/schemas/payment_pages_checkout_session_custom_fields' type: array @@ -5725,6 +6513,11 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: The ID of the account for this Session. + maxLength: 5000 + nullable: true + type: string customer_creation: description: >- Configure whether a Checkout Session creates a Customer when the @@ -5769,6 +6562,17 @@ components: $ref: '#/components/schemas/payment_pages_checkout_session_discount' nullable: true type: array + excluded_payment_method_types: + description: >- + A list of the types of payment methods (e.g., `card`) that should be + excluded from this Checkout Session. This should only be used when + payment methods for this Checkout Session are managed through the + [Stripe + Dashboard](https://dashboard.stripe.com/settings/payment_methods). + items: + maxLength: 5000 + type: string + type: array expires_at: description: The timestamp at which the Checkout Session will expire. format: unix-time @@ -5885,7 +6689,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -5898,6 +6702,8 @@ components: - subscription type: string x-stripeBypassValidation: true + name_collection: + $ref: '#/components/schemas/payment_pages_checkout_session_name_collection' object: description: >- String representing the object's type. Objects of the same type @@ -5905,6 +6711,21 @@ components: enum: - checkout.session type: string + optional_items: + description: The optional items presented to the customer at checkout. + items: + $ref: '#/components/schemas/payment_pages_checkout_session_optional_item' + nullable: true + type: array + origin_context: + description: >- + Where the user is coming from. This informs the optimizations that + are applied to the session. + enum: + - mobile_app + - web + nullable: true + type: string payment_intent: anyOf: - maxLength: 5000 @@ -5914,7 +6735,7 @@ components: The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout - Session](https://stripe.com/docs/api/checkout/sessions/expire) + Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. nullable: true x-expansionResources: @@ -5974,9 +6795,23 @@ components: - paid - unpaid type: string + permissions: + anyOf: + - $ref: '#/components/schemas/payment_pages_checkout_session_permissions' + description: >- + This property is used to set up permissions for various actions + (e.g., update) on the CheckoutSession object. + + + For specific permissions, please refer to their dedicated + subsections, such as `permissions.update_shipping_details`. + nullable: true phone_number_collection: $ref: >- #/components/schemas/payment_pages_checkout_session_phone_number_collection + presentment_details: + $ref: >- + #/components/schemas/payment_flows_payment_intent_presentment_details recovered_from: description: >- The ID of the original expired Checkout Session that triggered the @@ -5988,7 +6823,7 @@ components: description: >- This parameter applies to `ui_mode: embedded`. Learn more about the [redirect - behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) + behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. enum: - always @@ -5997,9 +6832,10 @@ components: type: string return_url: description: >- - Applies to Checkout Sessions with `ui_mode: embedded`. The URL to - redirect your customer back to after they authenticate or cancel - their payment on the payment method's app or site. + Applies to Checkout Sessions with `ui_mode: embedded` or `ui_mode: + custom`. The URL to redirect your customer back to after they + authenticate or cancel their payment on the payment method's app or + site. maxLength: 5000 type: string saved_payment_method_options: @@ -6019,7 +6855,7 @@ components: The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout - Session](https://stripe.com/docs/api/checkout/sessions/expire) + Session](https://docs.stripe.com/api/checkout/sessions/expire) instead. nullable: true x-expansionResources: @@ -6041,11 +6877,6 @@ components: The details of the customer cost of shipping, including the customer chosen ShippingRate. nullable: true - shipping_details: - anyOf: - - $ref: '#/components/schemas/shipping' - description: Shipping information for this Checkout Session. - nullable: true shipping_options: description: The shipping rate options applied to this Session. items: @@ -6086,8 +6917,9 @@ components: type: string - $ref: '#/components/schemas/subscription' description: >- - The ID of the subscription for Checkout Sessions in `subscription` - mode. + The ID of the + [Subscription](https://docs.stripe.com/api/subscriptions) for + Checkout Sessions in `subscription` mode. nullable: true x-expansionResources: oneOf: @@ -6111,16 +6943,17 @@ components: ui_mode: description: The UI mode of the Session. Defaults to `hosted`. enum: + - custom - embedded - hosted nullable: true type: string - x-stripeBypassValidation: true url: description: >- - The URL to the Checkout Session. Redirect customers to this URL to - take them to Checkout. If you’re using [Custom - Domains](https://stripe.com/docs/payments/checkout/custom-domains), + The URL to the Checkout Session. Applies to Checkout Sessions with + `ui_mode: hosted`. Redirect customers to this URL to take them to + Checkout. If you’re using [Custom + Domains](https://docs.stripe.com/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.` @@ -6128,6 +6961,11 @@ components: maxLength: 5000 nullable: true type: string + wallet_options: + anyOf: + - $ref: '#/components/schemas/checkout_session_wallet_options' + description: Wallet-specific configuration for this Checkout Session. + nullable: true required: - automatic_tax - created @@ -6147,6 +6985,8 @@ components: - adaptive_pricing - after_expiration - automatic_tax + - branding_settings + - collected_information - consent - consent_collection - currency_conversion @@ -6158,20 +6998,24 @@ components: - invoice - invoice_creation - line_items + - name_collection + - optional_items - payment_intent - payment_link - payment_method_configuration_details - payment_method_options + - permissions - phone_number_collection + - presentment_details - saved_payment_method_options - setup_intent - shipping_address_collection - shipping_cost - - shipping_details - shipping_options - subscription - tax_id_collection - total_details + - wallet_options x-resourceId: checkout.session checkout_acss_debit_mandate_options: description: '' @@ -6257,6 +7101,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string verification_method: description: Bank account verification method. enum: @@ -6272,6 +7124,13 @@ components: checkout_affirm_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 @@ -6305,6 +7164,13 @@ components: checkout_afterpay_clearpay_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 @@ -6365,12 +7231,33 @@ components: enum: - none type: string + x-stripeBypassValidation: true title: CheckoutAlipayPaymentMethodOptions type: object x-expandableFields: [] + checkout_alma_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: CheckoutAlmaPaymentMethodOptions + type: object + x-expandableFields: [] checkout_amazon_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 @@ -6432,6 +7319,14 @@ components: enum: - none type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string title: CheckoutAuBecsDebitPaymentMethodOptions type: object x-expandableFields: [] @@ -6470,6 +7365,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string title: CheckoutBacsDebitPaymentMethodOptions type: object x-expandableFields: @@ -6507,6 +7410,19 @@ components: title: CheckoutBancontactPaymentMethodOptions type: object x-expandableFields: [] + checkout_billie_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: CheckoutBilliePaymentMethodOptions + type: object + x-expandableFields: [] checkout_boleto_payment_method_options: description: '' properties: @@ -6563,6 +7479,13 @@ components: checkout_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 installments: $ref: '#/components/schemas/checkout_card_installments_options' request_extended_authorization: @@ -6604,11 +7527,11 @@ components: 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). + requirements](https://docs.stripe.com/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) + Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: @@ -6617,6 +7540,9 @@ components: - challenge type: string x-stripeBypassValidation: true + restrictions: + $ref: >- + #/components/schemas/payment_pages_private_card_payment_method_options_resource_restrictions setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -6673,9 +7599,17 @@ components: type: object x-expandableFields: - installments + - restrictions checkout_cashapp_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 @@ -7005,6 +7939,13 @@ components: checkout_klarna_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 @@ -7122,6 +8063,13 @@ components: checkout_link_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 @@ -7153,9 +8101,28 @@ components: title: CheckoutLinkPaymentMethodOptions type: object x-expandableFields: [] + checkout_link_wallet_options: + description: '' + properties: + display: + description: Describes whether Checkout should display Link. Defaults to `auto`. + enum: + - auto + - never + type: string + title: CheckoutLinkWalletOptions + type: object + x-expandableFields: [] checkout_mobilepay_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 @@ -7229,6 +8196,34 @@ components: 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: CheckoutNaverPayPaymentMethodOptions type: object x-expandableFields: [] @@ -7438,69 +8433,160 @@ components: title: CheckoutPaypalPaymentMethodOptions type: object x-expandableFields: [] - checkout_pix_payment_method_options: - description: '' - properties: - expires_after_seconds: - description: The number of seconds after which Pix payment will expire. - nullable: true - type: integer - title: CheckoutPixPaymentMethodOptions - type: object - x-expandableFields: [] - checkout_revolut_pay_payment_method_options: - description: '' - properties: - setup_future_usage: - description: >- - Indicates that you intend to make future payments with this - PaymentIntent's payment method. - - - 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: 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: + checkout_payto_payment_method_options: description: '' properties: mandate_options: - $ref: >- - #/components/schemas/checkout_payment_method_options_mandate_options_sepa_debit + $ref: '#/components/schemas/mandate_options_payto' + 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: CheckoutPaytoPaymentMethodOptions + type: object + x-expandableFields: + - mandate_options + checkout_pix_payment_method_options: + description: '' + properties: + amount_includes_iof: + description: Determines if the amount includes the IOF tax. + enum: + - always + - never + type: string + expires_after_seconds: + description: The number of seconds after which Pix payment will expire. + nullable: true + type: integer + 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 + type: string + x-stripeBypassValidation: true + title: CheckoutPixPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_revolut_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: 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_satispay_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: CheckoutSatispayPaymentMethodOptions + 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 @@ -7530,6 +8616,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string title: CheckoutSepaDebitPaymentMethodOptions type: object x-expandableFields: @@ -7546,6 +8640,8 @@ components: #/components/schemas/checkout_afterpay_clearpay_payment_method_options alipay: $ref: '#/components/schemas/checkout_alipay_payment_method_options' + alma: + $ref: '#/components/schemas/checkout_alma_payment_method_options' amazon_pay: $ref: '#/components/schemas/checkout_amazon_pay_payment_method_options' au_becs_debit: @@ -7554,6 +8650,8 @@ components: $ref: '#/components/schemas/checkout_bacs_debit_payment_method_options' bancontact: $ref: '#/components/schemas/checkout_bancontact_payment_method_options' + billie: + $ref: '#/components/schemas/checkout_billie_payment_method_options' boleto: $ref: '#/components/schemas/checkout_boleto_payment_method_options' card: @@ -7599,18 +8697,24 @@ components: $ref: '#/components/schemas/checkout_paynow_payment_method_options' paypal: $ref: '#/components/schemas/checkout_paypal_payment_method_options' + payto: + $ref: '#/components/schemas/checkout_payto_payment_method_options' pix: $ref: '#/components/schemas/checkout_pix_payment_method_options' revolut_pay: $ref: '#/components/schemas/checkout_revolut_pay_payment_method_options' samsung_pay: $ref: '#/components/schemas/checkout_samsung_pay_payment_method_options' + satispay: + $ref: '#/components/schemas/checkout_satispay_payment_method_options' sepa_debit: $ref: '#/components/schemas/checkout_sepa_debit_payment_method_options' sofort: $ref: '#/components/schemas/checkout_sofort_payment_method_options' swish: $ref: '#/components/schemas/checkout_swish_payment_method_options' + twint: + $ref: '#/components/schemas/checkout_twint_payment_method_options' us_bank_account: $ref: '#/components/schemas/checkout_us_bank_account_payment_method_options' title: CheckoutSessionPaymentMethodOptions @@ -7620,10 +8724,12 @@ components: - affirm - afterpay_clearpay - alipay + - alma - amazon_pay - au_becs_debit - bacs_debit - bancontact + - billie - boleto - card - cashapp @@ -7646,13 +8752,25 @@ components: - payco - paynow - paypal + - payto - pix - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish + - twint - us_bank_account + checkout_session_wallet_options: + description: '' + properties: + link: + $ref: '#/components/schemas/checkout_link_wallet_options' + title: CheckoutSessionWalletOptions + type: object + x-expandableFields: + - link checkout_sofort_payment_method_options: description: '' properties: @@ -7699,11 +8817,45 @@ components: title: CheckoutSwishPaymentMethodOptions type: object x-expandableFields: [] + checkout_twint_payment_method_options: + description: '' + properties: + 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 + type: string + x-stripeBypassValidation: true + title: CheckoutTwintPaymentMethodOptions + type: object + x-expandableFields: [] checkout_us_bank_account_payment_method_options: description: '' properties: financial_connections: - $ref: '#/components/schemas/linked_account_options_us_bank_account' + $ref: '#/components/schemas/linked_account_options_common' setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -7733,6 +8885,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string verification_method: description: Bank account verification method. enum: @@ -7843,7 +9003,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -8156,10 +9316,10 @@ components: guides: - [Finalize payments on the - server](https://stripe.com/docs/payments/finalize-payments-on-the-server) + server](https://docs.stripe.com/payments/finalize-payments-on-the-server) - [Build two-step - confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation). + confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation). properties: created: description: >- @@ -8229,7 +9389,7 @@ components: The presence of this property will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the + method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. enum: @@ -8343,9 +9503,23 @@ components: maxLength: 5000 nullable: true type: string + installments: + $ref: >- + #/components/schemas/confirmation_tokens_resource_payment_method_options_resource_card_resource_installment title: ConfirmationTokensResourcePaymentMethodOptionsResourceCard type: object - x-expandableFields: [] + x-expandableFields: + - installments + confirmation_tokens_resource_payment_method_options_resource_card_resource_installment: + description: Installment configuration for payments. + properties: + plan: + $ref: '#/components/schemas/payment_method_details_card_installments_plan' + title: >- + ConfirmationTokensResourcePaymentMethodOptionsResourceCardResourceInstallment + type: object + x-expandableFields: + - plan confirmation_tokens_resource_payment_method_preview: description: Details of the PaymentMethod collected by Payment Element properties: @@ -8379,6 +9553,8 @@ components: $ref: '#/components/schemas/payment_method_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_bancontact' + billie: + $ref: '#/components/schemas/payment_method_billie' billing_details: $ref: '#/components/schemas/billing_details' blik: @@ -8391,6 +9567,8 @@ components: $ref: '#/components/schemas/payment_method_card_present' cashapp: $ref: '#/components/schemas/payment_method_cashapp' + crypto: + $ref: '#/components/schemas/payment_method_crypto' customer: anyOf: - maxLength: 5000 @@ -8404,6 +9582,10 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + maxLength: 5000 + nullable: true + type: string customer_balance: $ref: '#/components/schemas/payment_method_customer_balance' eps: @@ -8428,12 +9610,16 @@ components: $ref: '#/components/schemas/payment_method_kr_card' link: $ref: '#/components/schemas/payment_method_link' + mb_way: + $ref: '#/components/schemas/payment_method_mb_way' mobilepay: $ref: '#/components/schemas/payment_method_mobilepay' multibanco: $ref: '#/components/schemas/payment_method_multibanco' naver_pay: $ref: '#/components/schemas/payment_method_naver_pay' + nz_bank_account: + $ref: '#/components/schemas/payment_method_nz_bank_account' oxxo: $ref: '#/components/schemas/payment_method_oxxo' p24: @@ -8446,6 +9632,8 @@ components: $ref: '#/components/schemas/payment_method_paynow' paypal: $ref: '#/components/schemas/payment_method_paypal' + payto: + $ref: '#/components/schemas/payment_method_payto' pix: $ref: '#/components/schemas/payment_method_pix' promptpay: @@ -8454,6 +9642,8 @@ components: $ref: '#/components/schemas/payment_method_revolut_pay' samsung_pay: $ref: '#/components/schemas/payment_method_samsung_pay' + satispay: + $ref: '#/components/schemas/payment_method_satispay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: @@ -8477,11 +9667,14 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - card_present - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -8494,19 +9687,23 @@ components: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -8537,12 +9734,14 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - billing_details - blik - boleto - card - card_present - cashapp + - crypto - customer - customer_balance - eps @@ -8556,19 +9755,23 @@ components: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -8615,6 +9818,7 @@ components: - account - self type: string + x-stripeBypassValidation: true required: - type title: ConnectAccountReference @@ -8691,22 +9895,19 @@ components: properties: disable_stripe_user_authentication: description: >- - Disables Stripe user authentication for this embedded component. - This value can only be true for accounts where - `controller.requirement_collection` is `application`. The default - value is the opposite of the `external_account_collection` value. - For example, if you don’t set `external_account_collection`, it - defaults to true and `disable_stripe_user_authentication` defaults - to false. + Whether Stripe user authentication is disabled. This value can only + be `true` for accounts where `controller.requirement_collection` is + `application` for the account. The default value is the opposite of + the `external_account_collection` value. For example, if you don't + set `external_account_collection`, it defaults to `true` and + `disable_stripe_user_authentication` defaults to `false`. type: boolean external_account_collection: description: >- - Whether to allow platforms to control bank account collection for - their connected accounts. This feature can only be false for - accounts where you’re responsible for collecting updated information - when requirements are due or change, like custom accounts. - Otherwise, bank account collection is determined by compliance - requirements. The default value for this feature is `true`. + Whether external account collection is enabled. 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 `true`. type: boolean required: - disable_stripe_user_authentication @@ -8722,7 +9923,9 @@ components: account_onboarding: $ref: '#/components/schemas/connect_embedded_account_config_claim' balances: - $ref: '#/components/schemas/connect_embedded_payouts_config_claim' + $ref: '#/components/schemas/connect_embedded_payouts_config' + disputes_list: + $ref: '#/components/schemas/connect_embedded_disputes_list_config' documents: $ref: '#/components/schemas/connect_embedded_base_config_claim' financial_account: @@ -8730,6 +9933,9 @@ components: financial_account_transactions: $ref: >- #/components/schemas/connect_embedded_financial_account_transactions_config_claim + instant_payouts_promotion: + $ref: >- + #/components/schemas/connect_embedded_instant_payouts_promotion_config issuing_card: $ref: '#/components/schemas/connect_embedded_issuing_card_config_claim' issuing_cards_list: @@ -8739,10 +9945,14 @@ components: $ref: '#/components/schemas/connect_embedded_account_config_claim' payment_details: $ref: '#/components/schemas/connect_embedded_payments_config_claim' + payment_disputes: + $ref: '#/components/schemas/connect_embedded_payment_disputes_config' payments: $ref: '#/components/schemas/connect_embedded_payments_config_claim' + payout_details: + $ref: '#/components/schemas/connect_embedded_base_config_claim' payouts: - $ref: '#/components/schemas/connect_embedded_payouts_config_claim' + $ref: '#/components/schemas/connect_embedded_payouts_config' payouts_list: $ref: '#/components/schemas/connect_embedded_base_config_claim' tax_registrations: @@ -8753,14 +9963,18 @@ components: - account_management - account_onboarding - balances + - disputes_list - documents - financial_account - financial_account_transactions + - instant_payouts_promotion - issuing_card - issuing_cards_list - notification_banner - payment_details + - payment_disputes - payments + - payout_details - payouts - payouts_list - tax_registrations @@ -8771,14 +9985,18 @@ components: - account_management - account_onboarding - balances + - disputes_list - documents - financial_account - financial_account_transactions + - instant_payouts_promotion - issuing_card - issuing_cards_list - notification_banner - payment_details + - payment_disputes - payments + - payout_details - payouts - payouts_list - tax_registrations @@ -8804,6 +10022,50 @@ components: title: ConnectEmbeddedBaseFeatures type: object x-expandableFields: [] + connect_embedded_disputes_list_config: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_disputes_list_features' + required: + - enabled + - features + title: ConnectEmbeddedDisputesListConfig + type: object + x-expandableFields: + - features + connect_embedded_disputes_list_features: + description: '' + properties: + capture_payments: + description: >- + Whether to allow capturing and cancelling payment intents. This is + `true` by default. + type: boolean + destination_on_behalf_of_charge_management: + description: >- + Whether connected accounts can manage destination charges that are + created on behalf of them. This is `false` by default. + type: boolean + dispute_management: + description: >- + Whether responding to disputes is enabled, including submitting + evidence and accepting disputes. This is `true` by default. + type: boolean + refund_management: + description: Whether sending refunds is enabled. This is `true` by default. + type: boolean + required: + - capture_payments + - destination_on_behalf_of_charge_management + - dispute_management + - refund_management + title: ConnectEmbeddedDisputesListFeatures + type: object + x-expandableFields: [] connect_embedded_financial_account_config_claim: description: '' properties: @@ -8824,16 +10086,19 @@ components: properties: disable_stripe_user_authentication: description: >- - Disables Stripe user authentication for this embedded component. - This value can only be true for accounts where - `controller.requirement_collection` is `application`. The default - value is the opposite of the `external_account_collection` value. - For example, if you don’t set `external_account_collection`, it - defaults to true and `disable_stripe_user_authentication` defaults - to false. + Whether Stripe user authentication is disabled. This value can only + be `true` for accounts where `controller.requirement_collection` is + `application` for the account. The default value is the opposite of + the `external_account_collection` value. For example, if you don't + set `external_account_collection`, it defaults to `true` and + `disable_stripe_user_authentication` defaults to `false`. type: boolean external_account_collection: - description: Whether to allow external accounts to be linked for money transfer. + description: >- + Whether external account collection is enabled. 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 `true`. type: boolean send_money: description: Whether to allow sending money. @@ -8876,6 +10141,54 @@ components: title: ConnectEmbeddedFinancialAccountTransactionsFeatures type: object x-expandableFields: [] + connect_embedded_instant_payouts_promotion_config: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: >- + #/components/schemas/connect_embedded_instant_payouts_promotion_features + required: + - enabled + - features + title: ConnectEmbeddedInstantPayoutsPromotionConfig + type: object + x-expandableFields: + - features + connect_embedded_instant_payouts_promotion_features: + description: '' + properties: + disable_stripe_user_authentication: + description: >- + Whether Stripe user authentication is disabled. This value can only + be `true` for accounts where `controller.requirement_collection` is + `application` for the account. The default value is the opposite of + the `external_account_collection` value. For example, if you don't + set `external_account_collection`, it defaults to `true` and + `disable_stripe_user_authentication` defaults to `false`. + type: boolean + external_account_collection: + description: >- + Whether external account collection is enabled. 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 `true`. + type: boolean + instant_payouts: + description: >- + Whether to allow creation of instant payouts. The default value is + `enabled` when Stripe is responsible for negative account balances, + and `use_dashboard_rules` otherwise. + type: boolean + required: + - disable_stripe_user_authentication + - external_account_collection + - instant_payouts + title: ConnectEmbeddedInstantPayoutsPromotionFeatures + type: object + x-expandableFields: [] connect_embedded_issuing_card_config_claim: description: '' properties: @@ -8943,10 +10256,12 @@ components: type: boolean disable_stripe_user_authentication: description: >- - Disables Stripe user authentication for this embedded component. - This feature can only be false for accounts where you’re responsible - for collecting updated information when requirements are due or - change, like custom accounts. + Whether Stripe user authentication is disabled. This value can only + be `true` for accounts where `controller.requirement_collection` is + `application` for the account. The default value is the opposite of + the `external_account_collection` value. For example, if you don't + set `external_account_collection`, it defaults to `true` and + `disable_stripe_user_authentication` defaults to `false`. type: boolean spend_control_management: description: Whether to allow spend control management features. @@ -8960,6 +10275,44 @@ components: title: ConnectEmbeddedIssuingCardsListFeatures type: object x-expandableFields: [] + connect_embedded_payment_disputes_config: + description: '' + properties: + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_payment_disputes_features' + required: + - enabled + - features + title: ConnectEmbeddedPaymentDisputesConfig + type: object + x-expandableFields: + - features + connect_embedded_payment_disputes_features: + description: '' + properties: + destination_on_behalf_of_charge_management: + description: >- + Whether connected accounts can manage destination charges that are + created on behalf of them. This is `false` by default. + type: boolean + dispute_management: + description: >- + Whether responding to disputes is enabled, including submitting + evidence and accepting disputes. This is `true` by default. + type: boolean + refund_management: + description: Whether sending refunds is enabled. This is `true` by default. + type: boolean + required: + - destination_on_behalf_of_charge_management + - dispute_management + - refund_management + title: ConnectEmbeddedPaymentDisputesFeatures + type: object + x-expandableFields: [] connect_embedded_payments_config_claim: description: '' properties: @@ -8985,16 +10338,16 @@ components: type: boolean destination_on_behalf_of_charge_management: description: >- - Whether to allow connected accounts to manage destination charges - that are created on behalf of them. This is `false` by default. + Whether connected accounts can manage destination charges that are + created on behalf of them. This is `false` by default. type: boolean dispute_management: description: >- - Whether to allow responding to disputes, including submitting + Whether responding to disputes is enabled, including submitting evidence and accepting disputes. This is `true` by default. type: boolean refund_management: - description: Whether to allow sending refunds. This is `true` by default. + description: Whether sending refunds is enabled. This is `true` by default. type: boolean required: - capture_payments @@ -9004,7 +10357,7 @@ components: title: ConnectEmbeddedPaymentsFeatures type: object x-expandableFields: [] - connect_embedded_payouts_config_claim: + connect_embedded_payouts_config: description: '' properties: enabled: @@ -9015,7 +10368,7 @@ components: required: - enabled - features - title: ConnectEmbeddedPayoutsConfigClaim + title: ConnectEmbeddedPayoutsConfig type: object x-expandableFields: - features @@ -9024,37 +10377,37 @@ components: properties: disable_stripe_user_authentication: description: >- - Disables Stripe user authentication for this embedded component. - This value can only be true for accounts where - `controller.requirement_collection` is `application`. The default - value is the opposite of the `external_account_collection` value. - For example, if you don’t set `external_account_collection`, it - defaults to true and `disable_stripe_user_authentication` defaults - to false. + Whether Stripe user authentication is disabled. This value can only + be `true` for accounts where `controller.requirement_collection` is + `application` for the account. The default value is the opposite of + the `external_account_collection` value. For example, if you don't + set `external_account_collection`, it defaults to `true` and + `disable_stripe_user_authentication` defaults to `false`. type: boolean edit_payout_schedule: description: >- - Whether to allow payout schedule to be changed. Default `true` when - Stripe owns Loss Liability, default `false` otherwise. + Whether to allow payout schedule to be changed. Defaults to `true` + when `controller.losses.payments` is set to `stripe` for the + account, otherwise `false`. type: boolean external_account_collection: description: >- - Whether to allow platforms to control bank account collection for - their connected accounts. This feature can only be false for - accounts where you’re responsible for collecting updated information - when requirements are due or change, like custom accounts. - Otherwise, bank account collection is determined by compliance - requirements. The default value for this feature is `true`. + Whether external account collection is enabled. 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 `true`. type: boolean instant_payouts: description: >- - Whether to allow creation of instant payouts. Default `true` when - Stripe owns Loss Liability, default `false` otherwise. + Whether to allow creation of instant payouts. The default value is + `enabled` when Stripe is responsible for negative account balances, + and `use_dashboard_rules` otherwise. type: boolean standard_payouts: description: >- - Whether to allow creation of standard payouts. Default `true` when - Stripe owns Loss Liability, default `false` otherwise. + Whether to allow creation of standard payouts. Defaults to `true` + when `controller.losses.payments` is set to `stripe` for the + account, otherwise `false`. type: boolean required: - disable_stripe_user_authentication @@ -9192,14 +10545,14 @@ components: you might want to apply to a customer. Coupons may be applied to - [subscriptions](https://stripe.com/docs/api#subscriptions), - [invoices](https://stripe.com/docs/api#invoices), + [subscriptions](https://api.stripe.com#subscriptions), + [invoices](https://api.stripe.com#invoices), - [checkout sessions](https://stripe.com/docs/api/checkout/sessions), - [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not - work with conventional one-off - [charges](https://stripe.com/docs/api#create_charge) or [payment - intents](https://stripe.com/docs/api/payment_intents). + [checkout sessions](https://docs.stripe.com/api/checkout/sessions), + [quotes](https://api.stripe.com#quotes), and more. Coupons do not work + with conventional one-off + [charges](https://api.stripe.com#create_charge) or [payment + intents](https://docs.stripe.com/api/payment_intents). properties: amount_off: description: >- @@ -9234,7 +10587,7 @@ components: type: object duration: description: >- - One of `forever`, `once`, and `repeating`. Describes how long a + One of `forever`, `once`, or `repeating`. Describes how long a customer who applies this coupon will get the discount. enum: - forever @@ -9268,7 +10621,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -9371,7 +10724,7 @@ components: Related guide: [Credit - notes](https://stripe.com/docs/billing/invoices/credit-notes) + notes](https://docs.stripe.com/billing/invoices/credit-notes) properties: amount: description: >- @@ -9406,6 +10759,11 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: ID of the account representing the customer. + maxLength: 5000 + nullable: true + type: string customer_balance_transaction: anyOf: - maxLength: 5000 @@ -9495,7 +10853,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -9521,6 +10879,17 @@ components: description: The link to download the PDF of the credit note. maxLength: 5000 type: string + post_payment_amount: + description: >- + The amount of the credit note that was refunded to the customer, + credited to the customer's balance, credited outside of Stripe, or + any combination thereof. + type: integer + pre_payment_amount: + description: >- + The amount of the credit note by which the invoice's + `amount_remaining` and `amount_due` were reduced. + type: integer pretax_credit_amounts: description: >- The pretax credit amounts (ex: discount, credit grants, etc) for all @@ -9539,16 +10908,11 @@ components: - product_unsatisfactory nullable: true type: string - refund: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/refund' - description: Refund related to this credit note. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/refund' + refunds: + description: Refunds related to this credit note. + items: + $ref: '#/components/schemas/credit_note_refund' + type: array shipping_cost: anyOf: - $ref: '#/components/schemas/invoices_resource_shipping_cost' @@ -9560,7 +10924,7 @@ components: description: >- Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit - notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). + notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding). enum: - issued - void @@ -9579,11 +10943,6 @@ components: discounts. nullable: true type: integer - tax_amounts: - description: The aggregate amounts calculated per tax rate for all line items. - items: - $ref: '#/components/schemas/credit_note_tax_amount' - type: array total: description: >- The integer amount in cents (or local equivalent) representing the @@ -9596,6 +10955,12 @@ components: discounts. nullable: true type: integer + total_taxes: + description: The aggregate tax information for all line items. + items: + $ref: '#/components/schemas/billing_bill_resource_invoicing_taxes_tax' + nullable: true + type: array type: description: >- Type of this credit note, one of `pre_payment` or `post_payment`. A @@ -9603,6 +10968,7 @@ components: open. A `post_payment` credit note means it was issued when the invoice was paid. enum: + - mixed - post_payment - pre_payment type: string @@ -9626,10 +10992,12 @@ components: - number - object - pdf + - post_payment_amount + - pre_payment_amount - pretax_credit_amounts + - refunds - status - subtotal - - tax_amounts - total - type title: CreditNote @@ -9641,9 +11009,9 @@ components: - invoice - lines - pretax_credit_amounts - - refund + - refunds - shipping_cost - - tax_amounts + - total_taxes x-resourceId: credit_note credit_note_line_item: description: The credit note line item object @@ -9654,13 +11022,6 @@ components: gross amount being credited for this line item, excluding (exclusive) tax and discounts. type: integer - amount_excluding_tax: - description: >- - The integer amount in cents (or local equivalent) representing the - amount being credited for this line item, excluding all tax and - discounts. - nullable: true - type: integer description: description: Description of the item being credited. maxLength: 5000 @@ -9707,16 +11068,17 @@ components: description: The number of units of product being credited. nullable: true type: integer - tax_amounts: - description: The amount of tax calculated per tax rate for this line item - items: - $ref: '#/components/schemas/credit_note_tax_amount' - type: array tax_rates: description: The tax rates which apply to the line item. items: $ref: '#/components/schemas/tax_rate' type: array + taxes: + description: The tax information of the line item. + items: + $ref: '#/components/schemas/billing_bill_resource_invoicing_taxes_tax' + nullable: true + type: array type: description: >- The type of the credit note line item, one of `invoice_line_item` or @@ -9738,14 +11100,6 @@ components: format: decimal nullable: true type: string - unit_amount_excluding_tax: - description: >- - The amount in cents (or local equivalent) representing the unit - amount being credited for this line item, excluding all tax and - discounts. - format: decimal - nullable: true - type: string required: - amount - discount_amount @@ -9754,7 +11108,6 @@ components: - livemode - object - pretax_credit_amounts - - tax_amounts - tax_rates - type title: CreditNoteLineItem @@ -9762,65 +11115,65 @@ components: x-expandableFields: - discount_amounts - pretax_credit_amounts - - tax_amounts - tax_rates + - taxes x-resourceId: credit_note_line_item - credit_note_tax_amount: + credit_note_refund: description: '' properties: - amount: - description: 'The amount, in cents (or local equivalent), of the tax.' + amount_refunded: + description: >- + Amount of the refund that applies to this credit note, in cents (or + local equivalent). type: integer - inclusive: - description: Whether this tax amount is inclusive or exclusive. - type: boolean - tax_rate: + payment_record_refund: + anyOf: + - $ref: '#/components/schemas/credit_notes_payment_record_refund' + description: >- + The PaymentRecord refund details associated with this credit note + refund. + nullable: true + refund: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/tax_rate' - description: The tax rate that was applied to get this tax amount. + - $ref: '#/components/schemas/refund' + description: ID of the refund. x-expansionResources: oneOf: - - $ref: '#/components/schemas/tax_rate' - taxability_reason: - description: >- - The reasoning behind this tax, for example, if the product is tax - exempt. The possible values for this field may be extended as new - tax rules are supported. + - $ref: '#/components/schemas/refund' + type: + description: 'Type of the refund, one of `refund` or `payment_record_refund`.' enum: - - customer_exempt - - not_collecting - - not_subject_to_tax - - not_supported - - portion_product_exempt - - portion_reduced_rated - - portion_standard_rated - - product_exempt - - product_exempt_holiday - - proportionally_rated - - reduced_rated - - reverse_charge - - standard_rated - - taxable_basis_reduced - - zero_rated + - payment_record_refund + - refund nullable: true type: string - x-stripeBypassValidation: true - taxable_amount: - description: >- - The amount on which tax is calculated, in cents (or local - equivalent). - nullable: true - type: integer required: - - amount - - inclusive - - tax_rate - title: CreditNoteTaxAmount + - amount_refunded + - refund + title: CreditNoteRefund type: object x-expandableFields: - - tax_rate + - payment_record_refund + - refund + credit_notes_payment_record_refund: + description: '' + properties: + payment_record: + description: ID of the payment record. + maxLength: 5000 + type: string + refund_group: + description: ID of the refund group. + maxLength: 5000 + type: string + required: + - payment_record + - refund_group + title: CreditNotesPaymentRecordRefund + type: object + x-expandableFields: [] credit_notes_pretax_credit_amount: description: '' properties: @@ -9878,7 +11231,7 @@ components: tax_behavior: description: >- Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either @@ -9917,6 +11270,23 @@ components: x-expandableFields: - custom_unit_amount - tiers + custom_logo: + description: '' + properties: + content_type: + description: Content type of the Dashboard-only CustomPaymentMethodType logo. + maxLength: 5000 + nullable: true + type: string + url: + description: URL of the Dashboard-only CustomPaymentMethodType logo. + maxLength: 5000 + type: string + required: + - url + title: custom_logo + type: object + x-expandableFields: [] custom_unit_amount: description: '' properties: @@ -9940,8 +11310,8 @@ components: customer: description: >- This object represents a customer of your business. Use it to [create - recurring charges](https://stripe.com/docs/invoicing/customer), [save - payment](https://stripe.com/docs/payments/save-during-payment) and + recurring charges](https://docs.stripe.com/invoicing/customer), [save + payment](https://docs.stripe.com/payments/save-during-payment) and contact information, and track payments that belong to the same customer. @@ -9953,14 +11323,19 @@ components: nullable: true balance: description: >- - The current balance, if any, that's stored on the customer. If - negative, the customer has credit to apply to their next invoice. If - positive, the customer has an amount owed that's added to their next - invoice. The balance only considers amounts that Stripe hasn't - successfully applied to any invoice. It doesn't reflect unpaid - invoices. This balance is only taken into account after invoices - finalize. + The current balance, if any, that's stored on the customer in their + default currency. If negative, the customer has credit to apply to + their next invoice. If positive, the customer has an amount owed + that's added to their next invoice. The balance only considers + amounts that Stripe hasn't successfully applied to any invoice. It + doesn't reflect unpaid invoices. This balance is only taken into + account after invoices finalize. For multi-currency balances, see + [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance). type: integer + business_name: + description: The customer's business name. + maxLength: 150 + type: string cash_balance: anyOf: - $ref: '#/components/schemas/cash_balance' @@ -9985,6 +11360,13 @@ components: maxLength: 5000 nullable: true type: string + customer_account: + description: >- + The ID of an Account representing a customer. You can use this ID + with any v1 API that accepts a customer_account parameter. + maxLength: 5000 + nullable: true + type: string default_source: anyOf: - maxLength: 5000 @@ -9998,7 +11380,7 @@ components: If you use payment methods created through the PaymentMethods API, see the - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead. nullable: true x-expansionResources: @@ -10016,7 +11398,7 @@ components: If an invoice becomes uncollectible by - [dunning](https://stripe.com/docs/billing/automatic-collection), + [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`. @@ -10050,6 +11432,10 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string + individual_name: + description: The customer's individual name. + maxLength: 150 + type: string invoice_credit_balance: additionalProperties: type: integer @@ -10081,7 +11467,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -10329,7 +11715,7 @@ components: - $ref: '#/components/schemas/balance_transaction' description: >- The [Balance - Transaction](https://stripe.com/docs/api/balance_transactions/object) + Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance. x-expansionResources: oneOf: @@ -10341,7 +11727,7 @@ components: - $ref: '#/components/schemas/customer_cash_balance_transaction' description: >- The [Cash Balance - Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) + Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds. x-expansionResources: @@ -10366,7 +11752,7 @@ components: - $ref: '#/components/schemas/payment_intent' description: >- The [Payment - Intent](https://stripe.com/docs/api/payment_intents/object) that + Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to. x-expansionResources: oneOf: @@ -10529,7 +11915,7 @@ components: type: string - $ref: '#/components/schemas/refund' description: >- - The [Refund](https://stripe.com/docs/api/refunds/object) that moved + The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance. x-expansionResources: oneOf: @@ -10551,7 +11937,7 @@ components: - $ref: '#/components/schemas/balance_transaction' description: >- The [Balance - Transaction](https://stripe.com/docs/api/balance_transactions/object) + Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. x-expansionResources: oneOf: @@ -10573,7 +11959,7 @@ components: - $ref: '#/components/schemas/payment_intent' description: >- The [Payment - Intent](https://stripe.com/docs/api/payment_intents/object) that + Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from. x-expansionResources: oneOf: @@ -10588,21 +11974,21 @@ components: customer_balance_transaction: description: >- Each customer has a - [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) + [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value, which denotes a debit or credit that's automatically applied to their next invoice upon finalization. You may modify the value directly by using the [update customer - API](https://stripe.com/docs/api/customers/update), + API](https://docs.stripe.com/api/customers/update), or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`. Related guide: [Customer - balance](https://stripe.com/docs/billing/customer/balance) + balance](https://docs.stripe.com/billing/customer/balance) properties: amount: description: >- @@ -10610,6 +11996,18 @@ components: customer's balance, and a positive value is a debit to the customer's `balance`. type: integer + checkout_session: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/checkout.session' + description: >- + The ID of the checkout session (if any) that created the + transaction. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/checkout.session' created: description: >- Time at which the object was created. Measured in seconds since the @@ -10643,6 +12041,13 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + description: >- + The ID of an Account representing a customer that the transaction + belongs to. + maxLength: 5000 + nullable: true + type: string description: description: >- An arbitrary string attached to the object. Often useful for @@ -10681,7 +12086,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -10697,13 +12102,17 @@ components: description: >- Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, - `invoice_too_small`, `unspent_receiver_credit`, or - `unapplied_from_invoice`. See the [Customer Balance - page](https://stripe.com/docs/billing/customer/balance#types) to + `invoice_too_small`, `unspent_receiver_credit`, + `unapplied_from_invoice`, `checkout_session_subscription_payment`, + or `checkout_session_subscription_payment_canceled`. See the + [Customer Balance + page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types. enum: - adjustment - applied_to_invoice + - checkout_session_subscription_payment + - checkout_session_subscription_payment_canceled - credit_note - initial - invoice_overpaid @@ -10727,6 +12136,7 @@ components: title: CustomerBalanceTransaction type: object x-expandableFields: + - checkout_session - credit_note - customer - invoice @@ -10775,11 +12185,18 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + description: >- + The ID of an Account representing a customer whose available cash + balance changed as a result of this transaction. + maxLength: 5000 + nullable: true + type: string ending_balance: description: >- The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer funded: $ref: >- @@ -10797,7 +12214,7 @@ components: description: >- The amount by which the cash balance changed, represented in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). A positive + unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance. type: integer @@ -10818,7 +12235,7 @@ components: description: >- The type of the cash balance transaction. New types may be added in future. See [Customer - Balance](https://stripe.com/docs/payments/customer-balance#types) to + Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types. enum: - adjusted_for_overdraft @@ -10901,6 +12318,11 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + description: The Account that the Customer Session was created for. + maxLength: 5000 + nullable: true + type: string expires_at: description: The timestamp at which this Customer Session will expire. format: unix-time @@ -10936,6 +12358,12 @@ components: buy_button: $ref: >- #/components/schemas/customer_session_resource_components_resource_buy_button + customer_sheet: + $ref: >- + #/components/schemas/customer_session_resource_components_resource_customer_sheet + mobile_payment_element: + $ref: >- + #/components/schemas/customer_session_resource_components_resource_mobile_payment_element payment_element: $ref: >- #/components/schemas/customer_session_resource_components_resource_payment_element @@ -10944,12 +12372,16 @@ components: #/components/schemas/customer_session_resource_components_resource_pricing_table required: - buy_button + - customer_sheet + - mobile_payment_element - payment_element - pricing_table title: CustomerSessionResourceComponents type: object x-expandableFields: - buy_button + - customer_sheet + - mobile_payment_element - payment_element - pricing_table customer_session_resource_components_resource_buy_button: @@ -10963,6 +12395,180 @@ components: title: CustomerSessionResourceComponentsResourceBuyButton type: object x-expandableFields: [] + customer_session_resource_components_resource_customer_sheet: + description: >- + This hash contains whether the customer sheet is enabled and the + features it supports. + properties: + enabled: + description: Whether the customer sheet is enabled. + type: boolean + features: + anyOf: + - $ref: >- + #/components/schemas/customer_session_resource_components_resource_customer_sheet_resource_features + description: >- + This hash defines whether the customer sheet supports certain + features. + nullable: true + required: + - enabled + title: CustomerSessionResourceComponentsResourceCustomerSheet + type: object + x-expandableFields: + - features + customer_session_resource_components_resource_customer_sheet_resource_features: + description: This hash contains the features the customer sheet supports. + properties: + payment_method_allow_redisplay_filters: + description: >- + A list of + [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) + values that controls which saved payment methods the customer sheet + displays by filtering to only show payment methods with an + `allow_redisplay` value that is present in this list. + + + If not specified, defaults to ["always"]. In order to display all + saved payment methods, specify ["always", "limited", "unspecified"]. + items: + enum: + - always + - limited + - unspecified + type: string + nullable: true + type: array + payment_method_remove: + description: >- + Controls whether the customer sheet displays the option to remove a + saved payment method." + + + Allowing buyers to remove their saved payment methods impacts + subscriptions that depend on that payment method. Removing the + payment method detaches the [`customer` + object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) + from that + [PaymentMethod](https://docs.stripe.com/api/payment_methods). + enum: + - disabled + - enabled + nullable: true + type: string + x-stripeBypassValidation: true + title: CustomerSessionResourceComponentsResourceCustomerSheetResourceFeatures + type: object + x-expandableFields: [] + customer_session_resource_components_resource_mobile_payment_element: + description: >- + This hash contains whether the mobile payment element is enabled and the + features it supports. + properties: + enabled: + description: Whether the mobile payment element is enabled. + type: boolean + features: + anyOf: + - $ref: >- + #/components/schemas/customer_session_resource_components_resource_mobile_payment_element_resource_features + description: >- + This hash defines whether the mobile payment element supports + certain features. + nullable: true + required: + - enabled + title: CustomerSessionResourceComponentsResourceMobilePaymentElement + type: object + x-expandableFields: + - features + customer_session_resource_components_resource_mobile_payment_element_resource_features: + description: This hash contains the features the mobile payment element supports. + properties: + payment_method_allow_redisplay_filters: + description: >- + A list of + [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) + values that controls which saved payment methods the mobile payment + element displays by filtering to only show payment methods with an + `allow_redisplay` value that is present in this list. + + + If not specified, defaults to ["always"]. In order to display all + saved payment methods, specify ["always", "limited", "unspecified"]. + items: + enum: + - always + - limited + - unspecified + type: string + nullable: true + type: array + payment_method_redisplay: + description: >- + Controls whether or not the mobile payment element shows saved + payment methods. + enum: + - disabled + - enabled + nullable: true + type: string + x-stripeBypassValidation: true + payment_method_remove: + description: >- + Controls whether the mobile payment element displays the option to + remove a saved payment method." + + + Allowing buyers to remove their saved payment methods impacts + subscriptions that depend on that payment method. Removing the + payment method detaches the [`customer` + object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) + from that + [PaymentMethod](https://docs.stripe.com/api/payment_methods). + enum: + - disabled + - enabled + nullable: true + type: string + x-stripeBypassValidation: true + payment_method_save: + description: >- + Controls whether the mobile payment element displays a checkbox + offering to save a new payment method. + + + If a customer checks the box, the + [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) + value on the PaymentMethod is set to `'always'` at confirmation + time. For PaymentIntents, the + [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) + value is also set to the value defined in + `payment_method_save_usage`. + enum: + - disabled + - enabled + nullable: true + type: string + x-stripeBypassValidation: true + payment_method_save_allow_redisplay_override: + description: >- + Allows overriding the value of allow_override when saving a new + payment method when payment_method_save is set to disabled. Use + values: "always", "limited", or "unspecified". + + + If not specified, defaults to `nil` (no override value). + enum: + - always + - limited + - unspecified + nullable: true + type: string + title: >- + CustomerSessionResourceComponentsResourceMobilePaymentElementResourceFeatures + type: object + x-expandableFields: [] customer_session_resource_components_resource_payment_element: description: >- This hash contains whether the Payment Element is enabled and the @@ -11018,7 +12624,8 @@ components: payment_method_redisplay_limit: description: >- Determines the max number of saved payment methods for the Payment - Element to display. This parameter defaults to `3`. + Element to display. This parameter defaults to `3`. The maximum + redisplay limit is `10`. nullable: true type: integer payment_method_remove: @@ -11114,10 +12721,22 @@ components: location: anyOf: - $ref: '#/components/schemas/customer_tax_location' - description: The customer's location as identified by Stripe Tax. + description: The identified tax location of the customer. nullable: true + provider: + description: >- + The tax calculation provider used for location resolution. Defaults + to `stripe` when not using a [third-party + provider](/tax/third-party-apps). + enum: + - anrok + - avalara + - sphere + - stripe + type: string required: - automatic_tax + - provider title: CustomerTax type: object x-expandableFields: @@ -11126,7 +12745,7 @@ components: description: '' properties: country: - description: The customer's country as identified by Stripe Tax. + description: The identified tax country of the customer. maxLength: 5000 type: string source: @@ -11139,8 +12758,8 @@ components: type: string state: description: >- - The customer's state, county, province, or region as identified by - Stripe Tax. + The identified tax state, county, province, or region of the + customer. maxLength: 5000 nullable: true type: string @@ -11368,8 +12987,6 @@ components: maxLength: 5000 nullable: true type: string - coupon: - $ref: '#/components/schemas/coupon' customer: anyOf: - maxLength: 5000 @@ -11382,6 +12999,13 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + The ID of the account representing the customer associated with this + discount. + maxLength: 5000 + nullable: true + type: string deleted: description: Always true for a deleted object enum: @@ -11427,6 +13051,8 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' + source: + $ref: '#/components/schemas/discount_source' start: description: Date that the coupon was applied. format: unix-time @@ -11446,17 +13072,17 @@ components: nullable: true type: string required: - - coupon - deleted - id - object + - source - start title: DeletedDiscount type: object x-expandableFields: - - coupon - customer - promotion_code + - source x-resourceId: deleted_discount deleted_external_account: anyOf: @@ -11830,6 +13456,22 @@ components: enum: - true type: boolean + device_type: + description: Device type of the reader. + enum: + - bbpos_chipper2x + - bbpos_wisepad3 + - bbpos_wisepos_e + - mobile_phone_reader + - simulated_stripe_s700 + - simulated_stripe_s710 + - simulated_wisepos_e + - stripe_m2 + - stripe_s700 + - stripe_s710 + - verifone_P400 + type: string + x-stripeBypassValidation: true id: description: Unique identifier for the object. maxLength: 5000 @@ -11841,10 +13483,16 @@ components: enum: - terminal.reader type: string + serial_number: + description: Serial number of the reader. + maxLength: 5000 + type: string required: - deleted + - device_type - id - object + - serial_number title: TerminalReaderDeletedReader type: object x-expandableFields: [] @@ -11912,15 +13560,15 @@ components: discount: description: >- A discount represents the actual application of a - [coupon](https://stripe.com/docs/api#coupons) or [promotion - code](https://stripe.com/docs/api#promotion_codes). + [coupon](https://api.stripe.com#coupons) or [promotion + code](https://api.stripe.com#promotion_codes). It contains information about when the discount began, when it will end, and what it is applied to. Related guide: [Applying discounts to - subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + subscriptions](https://docs.stripe.com/billing/subscriptions/discounts) properties: checkout_session: description: >- @@ -11930,8 +13578,6 @@ components: maxLength: 5000 nullable: true type: string - coupon: - $ref: '#/components/schemas/coupon' customer: anyOf: - maxLength: 5000 @@ -11944,6 +13590,13 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + The ID of the account representing the customer associated with this + discount. + maxLength: 5000 + nullable: true + type: string end: description: >- If the coupon has a duration of `repeating`, the date that this @@ -11992,6 +13645,8 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' + source: + $ref: '#/components/schemas/discount_source' start: description: Date that the coupon was applied. format: unix-time @@ -12011,17 +13666,41 @@ components: nullable: true type: string required: - - coupon - id - object + - source - start title: Discount type: object x-expandableFields: - - coupon - customer - promotion_code + - source x-resourceId: discount + discount_source: + description: '' + properties: + coupon: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/coupon' + description: The coupon that was redeemed to create this discount. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/coupon' + type: + description: The source type of the discount. + enum: + - coupon + type: string + required: + - type + title: DiscountSource + type: object + x-expandableFields: + - coupon discounts_resource_discount_amount: description: '' properties: @@ -12046,7 +13725,7 @@ components: type: object x-expandableFields: - discount - discounts_resource_stackable_discount: + discounts_resource_stackable_discount_with_discount_end: description: '' properties: coupon: @@ -12081,7 +13760,7 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/promotion_code' - title: DiscountsResourceStackableDiscount + title: DiscountsResourceStackableDiscountWithDiscountEnd type: object x-expandableFields: - coupon @@ -12098,7 +13777,7 @@ components: evidence that shows that the charge is legitimate. - Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) + Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) properties: amount: description: >- @@ -12142,8 +13821,8 @@ components: items: enum: - visa_compelling_evidence_3 + - visa_compliance type: string - x-stripeBypassValidation: true type: array evidence: $ref: '#/components/schemas/dispute_evidence' @@ -12169,7 +13848,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -12198,26 +13877,29 @@ components: `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, - `insufficient_funds`, `product_not_received`, + `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute - reasons](https://stripe.com/docs/disputes/categories). + reasons](https://docs.stripe.com/disputes/categories). maxLength: 5000 type: string status: description: >- - Current status of dispute. Possible values are - `warning_needs_response`, `warning_under_review`, `warning_closed`, - `needs_response`, `under_review`, `won`, or `lost`. + The current status of a dispute. Possible values + include:`warning_needs_response`, `warning_under_review`, + `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, + or `prevented`. enum: - lost - needs_response + - prevented - under_review - warning_closed - warning_needs_response - warning_under_review - won type: string + x-stripeBypassValidation: true required: - amount - balance_transactions @@ -12694,8 +14376,9 @@ components: properties: brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 type: string case_type: @@ -12703,10 +14386,12 @@ components: The type of dispute opened. Different case types may have varying fees and financial impact. enum: + - block - chargeback + - compliance - inquiry + - resolution type: string - x-stripeBypassValidation: true network_reason_code: description: >- The card network's specific dispute reason code, which maps to one @@ -12726,6 +14411,12 @@ components: dispute_payment_method_details_klarna: description: '' properties: + chargeback_loss_reason_code: + description: >- + Chargeback loss reason mapped by Stripe from Klarna's chargeback + loss reason + maxLength: 5000 + type: string reason_code: description: The reason for the dispute as defined by Klarna maxLength: 5000 @@ -12766,12 +14457,12 @@ components: nullable: true type: string line1: - description: 'Address line 1 (e.g., street, PO Box, or company name).' + description: 'Address line 1, such as the street, PO Box, or company name.' maxLength: 5000 nullable: true type: string line2: - description: 'Address line 2 (e.g., apartment, suite, unit, or building).' + description: 'Address line 2, such as the apartment, suite, unit, or building.' maxLength: 5000 nullable: true type: string @@ -12781,7 +14472,9 @@ components: nullable: true type: string state: - description: 'State, county, province, or region.' + description: >- + State, county, province, or region ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). maxLength: 5000 nullable: true type: string @@ -12933,7 +14626,7 @@ components: type: string - $ref: '#/components/schemas/entitlements.feature' description: >- - The [Feature](https://stripe.com/docs/api/entitlements/feature) that + The [Feature](https://docs.stripe.com/api/entitlements/feature) that the customer is entitled to. x-expansionResources: oneOf: @@ -13091,67 +14784,47 @@ components: type: object event: description: >- - Events are our way of letting you know when something interesting - happens in - - your account. When an interesting event occurs, we create a new `Event` - - object. For example, when a charge succeeds, we create a - `charge.succeeded` - - event, and when an invoice payment attempt fails, we create an - - `invoice.payment_failed` event. Certain API requests might create - multiple - - events. For example, if you create a new subscription for a - - customer, you receive both a `customer.subscription.created` event and a - - `charge.succeeded` event. - + Snapshot events allow you to track and react to activity in your Stripe + integration. When - Events occur when the state of another API resource changes. The event's - data + the state of another API resource changes, Stripe creates an `Event` + object that contains - field embeds the resource's state at the time of the change. For + all the relevant information associated with that action, including the + affected API - example, a `charge.succeeded` event contains a charge, and an + resource. For example, a successful payment triggers a + `charge.succeeded` event, which - `invoice.payment_failed` event contains an invoice. + contains the `Charge` in the event's data property. Some actions trigger + multiple events. + For example, if you create a new subscription for a customer, it + triggers both a - As with other API resources, you can use endpoints to retrieve an + `customer.subscription.created` event and a `charge.succeeded` event. - [individual event](https://stripe.com/docs/api#retrieve_event) or a - [list of events](https://stripe.com/docs/api#list_events) - from the API. We also have a separate + Configure an event destination in your account to listen for events that + represent actions - [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the + your integration needs to respond to. Additionally, you can retrieve an + individual event or - `Event` objects directly to an endpoint on your server. You can manage + a list of events from the API. - webhooks in your - [account settings](https://dashboard.stripe.com/account/webhooks). Learn - how + [Connect](https://docs.stripe.com/connect) platforms can also receive + event notifications - to [listen for events](https://docs.stripe.com/webhooks) + that occur in their connected accounts. These events include an account + attribute that - so that your integration can automatically trigger reactions. + identifies the relevant connected account. - When using [Connect](https://docs.stripe.com/connect), you can also - receive event notifications - - that occur in connected accounts. For these events, there's an - - additional `account` attribute in the received `Event` object. - - - We only guarantee access to events through the [Retrieve Event - API](https://stripe.com/docs/api#retrieve_event) + You can access events through the [Retrieve Event + API](https://docs.stripe.com/api/events#retrieve_event) for 30 days. properties: @@ -13161,11 +14834,17 @@ components: type: string api_version: description: >- - The Stripe API version used to render `data`. This property is - populated only for events on or after October 31, 2014. + The Stripe API version used to render `data` when the event was + created. The contents of `data` never change, so this value remains + static regardless of the API version currently in use. This property + is populated only for events created on or after October 31, 2014. maxLength: 5000 nullable: true type: string + context: + description: Authentication context needed to fetch the event or related object. + maxLength: 5000 + type: string created: description: >- Time at which the object was created. Measured in seconds since the @@ -13222,6 +14901,12 @@ components: x-resourceId: event exchange_rate: description: >- + [Deprecated] The `ExchangeRate` APIs are deprecated. Please use the [FX + Quotes + API](https://docs.stripe.com/payments/currencies/localize-prices/fx-quotes-api) + instead. + + `ExchangeRate` objects allow you to determine the rates that Stripe is currently @@ -13238,7 +14923,7 @@ components: Please refer to our [Exchange Rates - API](https://stripe.com/docs/fx-rates) guide for more details. + API](https://docs.stripe.com/fx-rates) guide for more details. *[Note: this integration path is supported but no longer recommended]* @@ -13253,7 +14938,7 @@ components: value is no longer up to date, the charge won't go through. Please refer to our - [Using with charges](https://stripe.com/docs/exchange-rates) guide for + [Using with charges](https://docs.stripe.com/exchange-rates) guide for more details. @@ -13324,9 +15009,9 @@ components: properties: currently_due: description: >- - Fields that need to be collected to keep the external account - enabled. If not collected by `current_deadline`, these fields appear - in `past_due` as well, and the account is disabled. + Fields that need to be resolved to keep the external account + enabled. If not resolved by `current_deadline`, these fields will + appear in `past_due` as well, and the account is disabled. items: maxLength: 5000 type: string @@ -13334,16 +15019,16 @@ components: type: array errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' nullable: true type: array past_due: description: >- - Fields that weren't collected by `current_deadline`. These fields - need to be collected to enable the external account. + Fields that haven't been resolved by `current_deadline`. These + fields need to be resolved to enable the external account. items: maxLength: 5000 type: string @@ -13351,13 +15036,13 @@ components: type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due`, `currently_due`, or `past_due`. Fields might - appear in `eventually_due`, `currently_due`, or `past_due` and in - `pending_verification` if verification fails but another - verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -13418,7 +15103,7 @@ components: Related guide: [Refunding application - fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) + fees](https://docs.stripe.com/connect/destination-charges#refunding-app-fee) properties: amount: description: 'Amount, in cents (or local equivalent).' @@ -13467,7 +15152,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -13496,8 +15181,7 @@ components: description: >- This object represents files hosted on Stripe's servers. You can upload - files with the [create file](https://stripe.com/docs/api#create_file) - request + files with the [create file](https://api.stripe.com#create_file) request (for example, when uploading dispute evidence). Stripe also @@ -13507,7 +15191,7 @@ components: query](#scheduled_queries)). - Related guide: [File upload guide](https://stripe.com/docs/file-upload) + Related guide: [File upload guide](https://docs.stripe.com/file-upload) properties: created: description: >- @@ -13531,8 +15215,8 @@ components: type: string links: description: >- - A list of [file links](https://stripe.com/docs/api#file_links) that - point at this file. + A list of [file links](https://api.stripe.com#file_links) that point + at this file. nullable: true properties: data: @@ -13575,7 +15259,7 @@ components: type: string purpose: description: >- - The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) + The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. enum: - account_requirement @@ -13591,10 +15275,14 @@ components: - identity_document_downloadable - issuing_regulatory_reporting - pci_document + - platform_terms_of_service - selfie - sigma_scheduled_query - tax_document_user_upload + - terminal_android_apk - terminal_reader_splashscreen + - terminal_wifi_certificate + - terminal_wifi_private_key type: string x-stripeBypassValidation: true size: @@ -13669,7 +15357,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -13708,6 +15396,13 @@ components: - $ref: '#/components/schemas/bank_connections_resource_accountholder' description: The account holder that this account belongs to. nullable: true + account_numbers: + description: Details about the account numbers. + items: + $ref: >- + #/components/schemas/bank_connections_resource_account_number_details + nullable: true + type: array balance: anyOf: - $ref: '#/components/schemas/bank_connections_resource_balance' @@ -13792,6 +15487,7 @@ components: - payment_method - transactions type: string + x-stripeBypassValidation: true nullable: true type: array status: @@ -13837,13 +15533,14 @@ components: supported_payment_method_types: description: >- The [PaymentMethod - type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) + type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. items: enum: - link - us_bank_account type: string + x-stripeBypassValidation: true type: array transaction_refresh: anyOf: @@ -13867,6 +15564,7 @@ components: type: object x-expandableFields: - account_holder + - account_numbers - balance - balance_refresh - ownership @@ -14038,6 +15736,7 @@ components: A value that will be passed to the client to launch the authentication flow. maxLength: 5000 + nullable: true type: string filters: $ref: >- @@ -14089,7 +15788,6 @@ components: type: string required: - accounts - - client_secret - id - livemode - object @@ -14386,7 +16084,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -14414,6 +16112,7 @@ components: - cardholder_name - request_signature type: string + x-stripeBypassValidation: true type: array request_context: anyOf: @@ -14460,7 +16159,7 @@ components: funding_instructions: description: >- Each customer has a - [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) + [`balance`](https://docs.stripe.com/api/customers/object#customer_object-balance) that is automatically applied to future invoices and payments using the @@ -14472,7 +16171,7 @@ components: `financial_addresses` field. Related guide: [Customer balance funding - instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) + instructions](https://docs.stripe.com/payments/customer-balance/funding-instructions) properties: bank_transfer: $ref: '#/components/schemas/funding_instructions_bank_transfer' @@ -14949,7 +16648,7 @@ components: nullable: true files: description: >- - Array of [File](https://stripe.com/docs/api/files) ids containing + Array of [File](https://docs.stripe.com/api/files) ids containing images for this document. items: maxLength: 5000 @@ -14981,6 +16680,15 @@ components: maxLength: 5000 nullable: true type: string + sex: + description: Sex of the person in the document. + enum: + - '[redacted]' + - female + - male + - unknown + nullable: true + type: string status: description: Status of this `document` check. enum: @@ -14996,6 +16704,16 @@ components: - passport nullable: true type: string + unparsed_place_of_birth: + description: Place of birth as it appears in the document. + maxLength: 5000 + nullable: true + type: string + unparsed_sex: + description: Sex as it appears in the document. + maxLength: 5000 + nullable: true + type: string required: - status title: GelatoDocumentReport @@ -15221,6 +16939,25 @@ components: title: GelatoProvidedDetails type: object x-expandableFields: [] + gelato_related_person: + description: '' + properties: + account: + description: >- + Token referencing the associated Account of the related Person + resource. + maxLength: 5000 + type: string + person: + description: Token referencing the related Person resource. + maxLength: 5000 + type: string + required: + - account + - person + title: GelatoRelatedPerson + type: object + x-expandableFields: [] gelato_report_document_options: description: '' properties: @@ -15239,7 +16976,7 @@ components: require_id_number: description: >- Collect an ID number and perform an [ID number - check](https://stripe.com/docs/identity/verification-checks?type=id-number) + check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. type: boolean require_live_capture: @@ -15250,9 +16987,9 @@ components: require_matching_selfie: description: >- Capture a face image and perform a [selfie - check](https://stripe.com/docs/identity/verification-checks?type=selfie) + check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn - more](https://stripe.com/docs/identity/selfie). + more](https://docs.stripe.com/identity/selfie). type: boolean title: GelatoReportDocumentOptions type: object @@ -15268,7 +17005,7 @@ components: properties: document: description: >- - ID of the [File](https://stripe.com/docs/api/files) holding the + ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check. maxLength: 5000 nullable: true @@ -15282,7 +17019,7 @@ components: nullable: true selfie: description: >- - ID of the [File](https://stripe.com/docs/api/files) holding the + ID of the [File](https://docs.stripe.com/api/files) holding the image of the selfie used in this check. maxLength: 5000 nullable: true @@ -15314,6 +17051,7 @@ components: - selfie_unverified_other nullable: true type: string + x-stripeBypassValidation: true reason: description: >- A human-readable message giving the reason for the failure. These @@ -15342,7 +17080,7 @@ components: require_id_number: description: >- Collect an ID number and perform an [ID number - check](https://stripe.com/docs/identity/verification-checks?type=id-number) + check](https://docs.stripe.com/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth. type: boolean require_live_capture: @@ -15353,9 +17091,9 @@ components: require_matching_selfie: description: >- Capture a face image and perform a [selfie - check](https://stripe.com/docs/identity/verification-checks?type=selfie) + check](https://docs.stripe.com/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn - more](https://stripe.com/docs/identity/selfie). + more](https://docs.stripe.com/identity/selfie). type: boolean title: GelatoSessionDocumentOptions type: object @@ -15415,6 +17153,24 @@ components: title: GelatoSessionLastError type: object x-expandableFields: [] + gelato_session_matching_options: + description: '' + properties: + dob: + description: Strictness of the DOB matching policy to apply. + enum: + - none + - similar + type: string + name: + description: Strictness of the name matching policy to apply. + enum: + - none + - similar + type: string + title: GelatoSessionMatchingOptions + type: object + x-expandableFields: [] gelato_session_phone_options: description: '' properties: @@ -15445,6 +17201,8 @@ components: $ref: '#/components/schemas/gelato_session_email_options' id_number: $ref: '#/components/schemas/gelato_session_id_number_options' + matching: + $ref: '#/components/schemas/gelato_session_matching_options' phone: $ref: '#/components/schemas/gelato_session_phone_options' title: GelatoVerificationSessionOptions @@ -15453,6 +17211,7 @@ components: - document - email - id_number + - matching - phone gelato_verified_outputs: description: '' @@ -15500,6 +17259,25 @@ components: maxLength: 5000 nullable: true type: string + sex: + description: The user's verified sex. + enum: + - '[redacted]' + - female + - male + - unknown + nullable: true + type: string + unparsed_place_of_birth: + description: The user's verified place of birth as it appears in the document. + maxLength: 5000 + nullable: true + type: string + unparsed_sex: + description: The user's verified sex as it appears in the document. + maxLength: 5000 + nullable: true + type: string title: GelatoVerifiedOutputs type: object x-expandableFields: @@ -15523,16 +17301,16 @@ components: user as well as reference IDs which can be used to access collected images through the - [FileUpload](https://stripe.com/docs/api/files) + [FileUpload](https://docs.stripe.com/api/files) API. To configure and create VerificationReports, use the - [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) + [VerificationSession](https://docs.stripe.com/api/identity/verification_sessions) API. Related guide: [Accessing verification - results](https://stripe.com/docs/identity/verification-sessions#results). + results](https://docs.stripe.com/identity/verification-sessions#results). properties: client_reference_id: description: >- @@ -15635,7 +17413,7 @@ components: Related guide: [The Verification Sessions - API](https://stripe.com/docs/identity/verification-sessions) + API](https://docs.stripe.com/identity/verification-sessions) properties: client_reference_id: description: >- @@ -15648,13 +17426,13 @@ components: client_secret: description: >- The short-lived client secret used by Stripe.js to [show a - verification modal](https://stripe.com/docs/js/identity/modal) + verification modal](https://docs.stripe.com/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the - frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) + frontend](https://docs.stripe.com/identity/verification-sessions#client-secret) to learn more. maxLength: 5000 nullable: true @@ -15684,7 +17462,7 @@ components: description: >- ID of the most recent VerificationReport. [Learn more about accessing detailed verification - results.](https://stripe.com/docs/identity/verification-sessions#results) + results.](https://docs.stripe.com/identity/verification-sessions#results) nullable: true x-expansionResources: oneOf: @@ -15699,7 +17477,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -15730,14 +17508,21 @@ components: VerificationSession is not redacted, this field will be null. nullable: true related_customer: - description: Token referencing a Customer resource. + description: Customer ID maxLength: 5000 nullable: true type: string + related_customer_account: + description: The ID of the Account representing a customer. + maxLength: 5000 + nullable: true + type: string + related_person: + $ref: '#/components/schemas/gelato_related_person' status: description: >- Status of this VerificationSession. [Learn more about the lifecycle - of sessions](https://stripe.com/docs/identity/how-sessions-work). + of sessions](https://docs.stripe.com/identity/how-sessions-work). enum: - canceled - processing @@ -15747,7 +17532,7 @@ components: type: description: >- The type of [verification - check](https://stripe.com/docs/identity/verification-checks) to be + check](https://docs.stripe.com/identity/verification-checks) to be performed. enum: - document @@ -15762,7 +17547,7 @@ components: 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) + documents](https://docs.stripe.com/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. maxLength: 5000 nullable: true @@ -15792,6 +17577,7 @@ components: - options - provided_details - redaction + - related_person - verified_outputs x-resourceId: identity.verification_session inbound_transfers: @@ -15862,7 +17648,7 @@ components: network: description: >- The network rails used. See the - [docs](https://stripe.com/docs/treasury/money-movement/timelines) to + [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach @@ -15878,6 +17664,671 @@ components: type: object x-expandableFields: - mandate + insights_resources_payment_evaluation_address: + description: Address data. + 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, such as the street, PO Box, or company name.' + maxLength: 5000 + nullable: true + type: string + line2: + description: 'Address line 2, such as the 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 ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + maxLength: 5000 + nullable: true + type: string + title: InsightsResourcesPaymentEvaluationAddress + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_billing_details: + description: Billing details attached to this payment evaluation. + properties: + address: + $ref: '#/components/schemas/insights_resources_payment_evaluation_address' + email: + description: Email address. + maxLength: 5000 + nullable: true + type: string + name: + description: Full name. + maxLength: 5000 + nullable: true + type: string + phone: + description: Billing phone number (including extension). + maxLength: 5000 + nullable: true + type: string + required: + - address + title: InsightsResourcesPaymentEvaluationBillingDetails + type: object + x-expandableFields: + - address + insights_resources_payment_evaluation_client_device_metadata: + description: Client device metadata attached to this payment evaluation. + properties: + radar_session: + description: >- + ID for the Radar Session associated with the payment evaluation. A + [Radar Session](https://docs.stripe.com/radar/radar-session) is a + snapshot of the browser metadata and device details that help Radar + make more accurate predictions on your payments. + maxLength: 5000 + type: string + required: + - radar_session + title: InsightsResourcesPaymentEvaluationClientDeviceMetadata + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_customer_details: + description: Customer details attached to this payment evaluation. + properties: + customer: + description: The ID of the customer associated with the payment evaluation. + maxLength: 5000 + nullable: true + type: string + customer_account: + description: >- + The ID of the Account representing the customer associated with the + payment evaluation. + maxLength: 5000 + nullable: true + type: string + email: + description: The customer's email address. + maxLength: 5000 + nullable: true + type: string + name: + description: The customer's full name or business name. + maxLength: 5000 + nullable: true + type: string + phone: + description: The customer's phone number. + maxLength: 5000 + nullable: true + type: string + title: InsightsResourcesPaymentEvaluationCustomerDetails + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_dispute_opened: + description: Dispute opened event details attached to this payment evaluation. + properties: + amount: + description: >- + Amount to dispute for this payment. A positive integer representing + how much to charge in [the smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal) (for example, + 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a + zero-decimal currency). + type: integer + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + format: currency + type: string + reason: + description: Reason given by cardholder for dispute. + enum: + - account_not_available + - credit_not_processed + - customer_initiated + - duplicate + - fraudulent + - general + - noncompliant + - product_not_received + - product_unacceptable + - subscription_canceled + - unrecognized + type: string + required: + - amount + - currency + - reason + title: InsightsResourcesPaymentEvaluationDisputeOpened + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_early_fraud_warning_received: + description: >- + Early Fraud Warning Received event details attached to this payment + evaluation. + properties: + fraud_type: + description: The type of fraud labeled by the issuer. + enum: + - made_with_lost_card + - made_with_stolen_card + - other + - unauthorized_use_of_card + type: string + required: + - fraud_type + title: InsightsResourcesPaymentEvaluationEarlyFraudWarningReceived + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_event: + description: Event reported for this payment evaluation. + properties: + dispute_opened: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_dispute_opened + early_fraud_warning_received: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_early_fraud_warning_received + occurred_at: + description: Timestamp when the event occurred. + format: unix-time + type: integer + refunded: + $ref: '#/components/schemas/insights_resources_payment_evaluation_refunded' + type: + description: Indicates the type of event attached to the payment evaluation. + enum: + - dispute_opened + - early_fraud_warning_received + - refunded + - user_intervention_raised + - user_intervention_resolved + type: string + user_intervention_raised: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_user_intervention_raised + user_intervention_resolved: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_user_intervention_resolved + required: + - occurred_at + - type + title: InsightsResourcesPaymentEvaluationEvent + type: object + x-expandableFields: + - dispute_opened + - early_fraud_warning_received + - refunded + - user_intervention_raised + - user_intervention_resolved + insights_resources_payment_evaluation_insights: + description: Collection of scores and insights for this payment evaluation. + properties: + evaluated_at: + description: The timestamp when the evaluation was performed. + format: unix-time + type: integer + fraudulent_dispute: + $ref: '#/components/schemas/insights_resources_payment_evaluation_scorer' + required: + - evaluated_at + - fraudulent_dispute + title: InsightsResourcesPaymentEvaluationInsights + type: object + x-expandableFields: + - fraudulent_dispute + insights_resources_payment_evaluation_merchant_blocked: + description: >- + Details of a merchant_blocked outcome attached to this payment + evaluation. + properties: + reason: + description: The reason the payment was blocked by the merchant. + enum: + - authentication_required + - blocked_for_fraud + - invalid_payment + - other + type: string + required: + - reason + title: InsightsResourcesPaymentEvaluationMerchantBlocked + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_money_movement_card: + description: Money Movement card details attached to this payment. + properties: + customer_presence: + description: Describes the presence of the customer during the payment. + enum: + - off_session + - on_session + nullable: true + type: string + payment_type: + description: Describes the type of payment. + enum: + - one_off + - recurring + - setup_one_off + - setup_recurring + nullable: true + type: string + title: InsightsResourcesPaymentEvaluationMoneyMovementCard + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_money_movement_details: + description: Money Movement details attached to this payment. + properties: + card: + anyOf: + - $ref: >- + #/components/schemas/insights_resources_payment_evaluation_money_movement_card + description: Describes card money movement details for the payment evaluation. + nullable: true + money_movement_type: + description: >- + Describes the type of money movement. Currently only `card` is + supported. + enum: + - card + type: string + required: + - money_movement_type + title: InsightsResourcesPaymentEvaluationMoneyMovementDetails + type: object + x-expandableFields: + - card + insights_resources_payment_evaluation_outcome: + description: Outcome details for this payment evaluation. + properties: + merchant_blocked: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_merchant_blocked + payment_intent_id: + description: The PaymentIntent ID associated with the payment evaluation. + maxLength: 5000 + type: string + rejected: + $ref: '#/components/schemas/insights_resources_payment_evaluation_rejected' + succeeded: + $ref: '#/components/schemas/insights_resources_payment_evaluation_succeeded' + type: + description: Indicates the outcome of the payment evaluation. + enum: + - failed + - merchant_blocked + - rejected + - succeeded + type: string + required: + - type + title: InsightsResourcesPaymentEvaluationOutcome + type: object + x-expandableFields: + - merchant_blocked + - rejected + - succeeded + insights_resources_payment_evaluation_payment_details: + description: Payment details attached to this payment evaluation. + properties: + amount: + description: >- + Amount intended to be collected by this payment. A positive integer + representing how much to charge in the [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 + cents to charge $1.00 or 100 to charge ¥100, a zero-decimal + currency). The minimum amount is $0.50 US or [equivalent in charge + currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). + The amount value supports up to eight digits (e.g., a value of + 99999999 for a USD charge of $999,999.99). + type: integer + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + format: currency + type: string + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + nullable: true + type: string + money_movement_details: + anyOf: + - $ref: >- + #/components/schemas/insights_resources_payment_evaluation_money_movement_details + description: Details about the payment's customer presence and type. + nullable: true + payment_method_details: + anyOf: + - $ref: >- + #/components/schemas/insights_resources_payment_evaluation_payment_method_details + description: Details about the payment method used for the payment. + nullable: true + shipping_details: + anyOf: + - $ref: >- + #/components/schemas/insights_resources_payment_evaluation_shipping + description: Shipping details for the payment evaluation. + nullable: true + statement_descriptor: + description: Payment statement descriptor. + maxLength: 5000 + nullable: true + type: string + required: + - amount + - currency + title: InsightsResourcesPaymentEvaluationPaymentDetails + type: object + x-expandableFields: + - money_movement_details + - payment_method_details + - shipping_details + insights_resources_payment_evaluation_payment_method_details: + description: Payment method details attached to this payment evaluation. + properties: + billing_details: + anyOf: + - $ref: >- + #/components/schemas/insights_resources_payment_evaluation_billing_details + description: Billing information associated with the payment evaluation. + nullable: true + payment_method: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_method' + description: The payment method used in this payment evaluation. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_method' + required: + - payment_method + title: InsightsResourcesPaymentEvaluationPaymentMethodDetails + type: object + x-expandableFields: + - billing_details + - payment_method + insights_resources_payment_evaluation_refunded: + description: Refunded Event details attached to this payment evaluation. + properties: + amount: + description: >- + Amount refunded for this payment. A positive integer representing + how much to charge in [the smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal) (for example, + 100 cents to charge 1.00 USD or 100 to charge 100 Yen, a + zero-decimal currency). + type: integer + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + format: currency + type: string + reason: + description: Indicates the reason for the refund. + enum: + - duplicate + - fraudulent + - other + - requested_by_customer + type: string + required: + - amount + - currency + - reason + title: InsightsResourcesPaymentEvaluationRefunded + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_rejected: + description: Details of an rejected outcome attached to this payment evaluation. + properties: + card: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_rejected_card + title: InsightsResourcesPaymentEvaluationRejected + type: object + x-expandableFields: + - card + insights_resources_payment_evaluation_rejected_card: + description: Details of an rejected card outcome attached to this payment evaluation. + properties: + address_line1_check: + description: Result of the address line 1 check. + enum: + - fail + - pass + - unavailable + - unchecked + type: string + address_postal_code_check: + description: >- + Indicates whether the cardholder provided a postal code and if it + matched the cardholder’s billing address. + enum: + - fail + - pass + - unavailable + - unchecked + type: string + cvc_check: + description: Result of the CVC check. + enum: + - fail + - pass + - unavailable + - unchecked + type: string + reason: + description: Card issuer's reason for the network decline. + enum: + - authentication_failed + - do_not_honor + - expired + - incorrect_cvc + - incorrect_number + - incorrect_postal_code + - insufficient_funds + - invalid_account + - lost_card + - other + - processing_error + - reported_stolen + - try_again_later + type: string + required: + - address_line1_check + - address_postal_code_check + - cvc_check + - reason + title: InsightsResourcesPaymentEvaluationRejectedCard + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_scorer: + description: >- + Scores, insights and recommended action for one scorer for this + PaymentEvaluation. + properties: + recommended_action: + description: >- + Recommended action based on the risk score. Possible values are + `block` and `continue`. + enum: + - block + - continue + type: string + risk_score: + description: >- + Stripe Radar’s evaluation of the risk level of the payment. Possible + values for evaluated payments are between 0 and 100, with higher + scores indicating higher risk. + type: integer + required: + - recommended_action + - risk_score + title: InsightsResourcesPaymentEvaluationScorer + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_shipping: + description: Shipping details attached to this payment. + properties: + address: + $ref: '#/components/schemas/insights_resources_payment_evaluation_address' + name: + description: Shipping name. + maxLength: 5000 + nullable: true + type: string + phone: + description: Shipping phone number. + maxLength: 5000 + nullable: true + type: string + required: + - address + title: InsightsResourcesPaymentEvaluationShipping + type: object + x-expandableFields: + - address + insights_resources_payment_evaluation_succeeded: + description: Details of a succeeded outcome attached to this payment evaluation. + properties: + card: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_succeeded_card + title: InsightsResourcesPaymentEvaluationSucceeded + type: object + x-expandableFields: + - card + insights_resources_payment_evaluation_succeeded_card: + description: >- + Details of an succeeded card outcome attached to this payment + evaluation. + properties: + address_line1_check: + description: Result of the address line 1 check. + enum: + - fail + - pass + - unavailable + - unchecked + type: string + address_postal_code_check: + description: >- + Indicates whether the cardholder provided a postal code and if it + matched the cardholder’s billing address. + enum: + - fail + - pass + - unavailable + - unchecked + type: string + cvc_check: + description: Result of the CVC check. + enum: + - fail + - pass + - unavailable + - unchecked + type: string + required: + - address_line1_check + - address_postal_code_check + - cvc_check + title: InsightsResourcesPaymentEvaluationSucceededCard + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_user_intervention_raised: + description: >- + User intervention raised event details attached to this payment + evaluation + properties: + custom: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_user_intervention_raised_custom + key: + description: Unique identifier for the user intervention event. + maxLength: 5000 + type: string + type: + description: Type of user intervention raised. + enum: + - 3ds + - captcha + - custom + type: string + required: + - key + - type + title: InsightsResourcesPaymentEvaluationUserInterventionRaised + type: object + x-expandableFields: + - custom + insights_resources_payment_evaluation_user_intervention_raised_custom: + description: >- + User intervention raised custom event details attached to this payment + evaluation + properties: + type: + description: >- + Custom type of user intervention raised. The string must use a snake + case description for the type of intervention performed. + maxLength: 5000 + type: string + required: + - type + title: InsightsResourcesPaymentEvaluationUserInterventionRaisedCustom + type: object + x-expandableFields: [] + insights_resources_payment_evaluation_user_intervention_resolved: + description: >- + User Intervention Resolved Event details attached to this payment + evaluation + properties: + key: + description: Unique ID of this intervention. Use this to provide the result. + maxLength: 5000 + type: string + outcome: + description: Result of the intervention if it has been completed. + enum: + - abandoned + - failed + - passed + nullable: true + type: string + required: + - key + title: InsightsResourcesPaymentEvaluationUserInterventionResolved + type: object + x-expandableFields: [] internal_card: description: '' properties: @@ -15914,8 +18365,8 @@ components: generated one-off, or generated periodically from a subscription. - They contain [invoice items](https://stripe.com/docs/api#invoiceitems), - and proration adjustments + They contain [invoice items](https://api.stripe.com#invoiceitems), and + proration adjustments that may be caused by subscription upgrades/downgrades (if necessary). @@ -15927,7 +18378,7 @@ components: that finalizing the invoice, [when - automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), + automatic](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection), does not happen immediately as the invoice is created. Stripe waits @@ -15968,11 +18419,11 @@ components: More details on the customer's credit balance are - [here](https://stripe.com/docs/billing/customer/balance). + [here](https://docs.stripe.com/billing/customer/balance). Related guide: [Send invoices to - customers](https://stripe.com/docs/billing/invoices/sending) + customers](https://docs.stripe.com/billing/invoices/sending) properties: account_country: description: >- @@ -16014,6 +18465,11 @@ components: take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`. type: integer + amount_overpaid: + description: >- + Amount that was overpaid on the invoice. The amount overpaid is + credited to the customer's credit balance. + type: integer amount_paid: description: 'The amount, in cents (or local equivalent), that was paid.' type: integer @@ -16037,13 +18493,6 @@ components: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' - application_fee_amount: - description: >- - The fee in cents (or local equivalent) that will be applied to the - invoice and transferred to the application owner's Stripe account - when the invoice is paid. - nullable: true - type: integer attempt_count: description: >- Number of payment attempts made for this invoice, from the @@ -16067,7 +18516,7 @@ components: auto_advance: description: >- Controls whether Stripe performs [automatic - collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) + collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. type: boolean @@ -16105,8 +18554,9 @@ components: * `subscription_update`: A subscription was updated. - * `upcoming`: Reserved for simulated invoices, per the upcoming - invoice endpoint. + * `upcoming`: Reserved for upcoming invoices created through the + Create Preview Invoice API or when an `invoice.upcoming` event is + generated for an upcoming invoice on a subscription. enum: - automatic_pending_invoice_item_invoice - manual @@ -16119,16 +18569,6 @@ components: - upcoming nullable: true type: string - charge: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/charge' - description: 'ID of the latest charge generated for this invoice, if any.' - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/charge' collection_method: description: >- Either `charge_automatically`, or `send_invoice`. When charging @@ -16140,6 +18580,14 @@ components: - charge_automatically - send_invoice type: string + confirmation_secret: + anyOf: + - $ref: '#/components/schemas/invoices_resource_confirmation_secret' + description: >- + The confirmation secret associated with this invoice. Currently, + this contains the client_secret of the PaymentIntent that Stripe + creates during invoice finalization. + nullable: true created: description: >- Time at which the object was created. Measured in seconds since the @@ -16166,12 +18614,16 @@ components: type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' - description: The ID of the customer who will be billed. - nullable: true + description: The ID of the customer to bill. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: The ID of the account representing the customer to bill. + maxLength: 5000 + nullable: true + type: string customer_address: anyOf: - $ref: '#/components/schemas/address' @@ -16277,13 +18729,6 @@ components: maxLength: 5000 nullable: true type: string - discount: - anyOf: - - $ref: '#/components/schemas/discount' - description: >- - Describes the current discount applied to this invoice, if there is - one. Not populated if there are multiple discounts. - nullable: true discounts: description: >- The discounts applied to the invoice. Line item discounts are @@ -16335,7 +18780,7 @@ components: - $ref: '#/components/schemas/invoices_resource_from_invoice' description: >- Details of the invoice that was cloned. See the [revision - documentation](https://stripe.com/docs/invoicing/invoice-revisions) + documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details. nullable: true hosted_invoice_url: @@ -16348,10 +18793,10 @@ components: type: string id: description: >- - Unique identifier for the object. This property is always present - unless the invoice is an upcoming invoice. See [Retrieve an upcoming - invoice](https://stripe.com/docs/api/invoices/upcoming) for more - details. + Unique identifier for the object. For preview invoices created using + the [create + preview](https://stripe.com/docs/api/invoices/create_preview) + endpoint, this id will be prefixed with `upcoming_in`. maxLength: 5000 type: string invoice_pdf: @@ -16429,7 +18874,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -16465,39 +18910,55 @@ components: The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices - with Connect](https://stripe.com/docs/billing/invoices/connect) + with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' - paid: - description: >- - Whether payment was successfully collected for this invoice. An - invoice can be paid (most commonly) with a charge or with credit - from the customer's account balance. - type: boolean - paid_out_of_band: - description: >- - Returns true if the invoice was manually marked paid, returns false - if the invoice hasn't been paid yet or was paid on Stripe. - type: boolean - payment_intent: + parent: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_intent' - description: >- - The PaymentIntent associated with this invoice. The PaymentIntent is - generated when the invoice is finalized, and can then be used to pay - the invoice. Note that voiding an invoice will cancel the - PaymentIntent. + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_parents_invoice_parent + description: The parent that generated this invoice nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_intent' payment_settings: $ref: '#/components/schemas/invoices_payment_settings' + payments: + description: >- + Payments for this invoice. Use [invoice + payment](/api/invoice-payment) to get more details. + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/invoice_payment' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: InvoicesPaymentsListInvoicePayments + type: object + x-expandableFields: + - data period_end: description: >- End of the usage period during which invoice items were added to @@ -16526,16 +18987,6 @@ components: Total amount of all pre-payment credit notes issued for this invoice. type: integer - quote: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/quote' - description: The quote this invoice was generated from. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/quote' receipt_number: description: >- This is the transaction number that appears on email receipts sent @@ -16584,7 +19035,7 @@ components: description: >- The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn - more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) enum: - draft - open @@ -16596,26 +19047,6 @@ components: x-stripeBypassValidation: true status_transitions: $ref: '#/components/schemas/invoices_resource_status_transitions' - subscription: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/subscription' - description: 'The subscription that this invoice was prepared for, if any.' - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/subscription' - subscription_details: - anyOf: - - $ref: '#/components/schemas/subscription_details_data' - description: Details about the subscription that created this invoice. - nullable: true - subscription_proration_date: - description: >- - Only set for upcoming invoices that preview prorations. The time - used to calculate prorations. - type: integer subtotal: description: >- Total of all subscriptions, invoice items, and prorations on the @@ -16629,12 +19060,6 @@ components: applied. Item discounts are already incorporated nullable: true type: integer - tax: - description: >- - The amount of tax on this invoice. This is the sum of all the tax - amounts on this invoice. - nullable: true - type: integer test_clock: anyOf: - maxLength: 5000 @@ -16672,24 +19097,17 @@ components: $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. + total_taxes: + description: The aggregate tax information of all line items. items: - $ref: '#/components/schemas/invoice_tax_amount' - type: array - transfer_data: - anyOf: - - $ref: '#/components/schemas/invoice_transfer_data' - description: >- - The account (if any) the payment will be attributed to for tax - reporting, and where funds from the payment will be transferred to - for the invoice. + $ref: '#/components/schemas/billing_bill_resource_invoicing_taxes_tax' nullable: true + type: array webhooks_delivered_at: description: >- Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been - exhausted](https://stripe.com/docs/billing/webhooks#understand). + exhausted](https://docs.stripe.com/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created. @@ -16698,23 +19116,25 @@ components: type: integer required: - amount_due + - amount_overpaid - amount_paid - amount_remaining - amount_shipping - attempt_count - attempted + - auto_advance - automatic_tax - collection_method - created - currency + - customer - default_tax_rates - discounts + - id - issuer - lines - livemode - object - - paid - - paid_out_of_band - payment_settings - period_end - period_start @@ -16724,14 +19144,13 @@ components: - status_transitions - subtotal - total - - total_tax_amounts title: Invoice type: object x-expandableFields: - account_tax_ids - application - automatic_tax - - charge + - confirmation_secret - custom_fields - customer - customer_address @@ -16740,7 +19159,6 @@ components: - default_payment_method - default_source - default_tax_rates - - discount - discounts - from_invoice - issuer @@ -16748,21 +19166,18 @@ components: - latest_revision - lines - on_behalf_of - - payment_intent + - parent - payment_settings - - quote + - payments - rendering - shipping_cost - shipping_details - status_transitions - - subscription - - subscription_details - test_clock - threshold_reason - total_discount_amounts - total_pretax_credit_amounts - - total_tax_amounts - - transfer_data + - total_taxes x-resourceId: invoice invoice_installments_card: description: '' @@ -16839,6 +19254,155 @@ components: title: invoice_mandate_options_card type: object x-expandableFields: [] + invoice_mandate_options_payto: + description: '' + properties: + amount: + description: >- + The maximum amount that can be collected in a single invoice. If you + don't specify a maximum, then there is no limit. + nullable: true + type: integer + amount_type: + description: Only `maximum` is supported. + enum: + - fixed + - maximum + nullable: true + type: string + purpose: + description: >- + The purpose for which payments are made. Has a default value based + on your merchant category code. + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + nullable: true + type: string + title: invoice_mandate_options_payto + type: object + x-expandableFields: [] + invoice_payment: + description: >- + Invoice Payments represent payments made against invoices. Invoice + Payments can + + be accessed in two ways: + + 1. By expanding the `payments` field on the + [Invoice](https://api.stripe.com#invoice) resource. + + 2. By using the Invoice Payment retrieve and list endpoints. + + + Invoice Payments include the mapping between payment objects, such as + Payment Intent, and Invoices. + + This resource and its endpoints allows you to easily track if a payment + is associated with a specific invoice and + + monitor the allocation details of the payments. + properties: + amount_paid: + description: >- + Amount that was actually paid for this invoice, in cents (or local + equivalent). This field is null until the payment is `paid`. This + amount can be less than the `amount_requested` if the + PaymentIntent’s `amount_received` is not sufficient to pay all of + the invoices that it is attached to. + nullable: true + type: integer + amount_requested: + description: >- + Amount intended to be paid toward this invoice, in cents (or local + equivalent) + type: integer + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + maxLength: 5000 + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + - $ref: '#/components/schemas/deleted_invoice' + description: The invoice that was paid. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' + - $ref: '#/components/schemas/deleted_invoice' + is_default: + description: >- + Stripe automatically creates a default InvoicePayment when the + invoice is finalized, and keeps it synchronized with the invoice’s + `amount_remaining`. The PaymentIntent associated with the default + payment can’t be edited or canceled directly. + type: boolean + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - invoice_payment + type: string + payment: + $ref: >- + #/components/schemas/invoices_payments_invoice_payment_associated_payment + status: + description: 'The status of the payment, one of `open`, `paid`, or `canceled`.' + maxLength: 5000 + type: string + status_transitions: + $ref: >- + #/components/schemas/invoices_payments_invoice_payment_status_transitions + required: + - amount_requested + - created + - currency + - id + - invoice + - is_default + - livemode + - object + - payment + - status + - status_transitions + title: InvoicesInvoicePayment + type: object + x-expandableFields: + - invoice + - payment + - status_transitions + x-resourceId: invoice_payment invoice_payment_method_options_acss_debit: description: '' properties: @@ -16898,11 +19462,11 @@ components: 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). + requirements](https://docs.stripe.com/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) + Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: @@ -16956,7 +19520,7 @@ components: country: description: >- The desired country code of the bank account information. Permitted - values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + values include: `DE`, `FR`, `IE`, or `NL`. enum: - BE - DE @@ -16977,6 +19541,15 @@ components: title: invoice_payment_method_options_konbini type: object x-expandableFields: [] + invoice_payment_method_options_payto: + description: '' + properties: + mandate_options: + $ref: '#/components/schemas/invoice_mandate_options_payto' + title: invoice_payment_method_options_payto + type: object + x-expandableFields: + - mandate_options invoice_payment_method_options_sepa_debit: description: '' properties: {} @@ -17096,7 +19669,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -17135,6 +19708,26 @@ components: type: object x-expandableFields: [] x-resourceId: invoice_rendering_template + invoice_setting_checkout_rendering_options: + description: '' + properties: + amount_tax_display: + description: >- + How line-item prices and amounts will be displayed with respect to + tax on invoice PDFs. + maxLength: 5000 + nullable: true + type: string + template: + description: >- + ID of the invoice rendering template to be used for the generated + invoice. + maxLength: 5000 + nullable: true + type: string + title: invoice_setting_checkout_rendering_options + type: object + x-expandableFields: [] invoice_setting_custom_field: description: '' properties: @@ -17229,19 +19822,6 @@ components: type: object x-expandableFields: - issuer - invoice_setting_rendering_options: - description: '' - properties: - amount_tax_display: - description: >- - How line-item prices and amounts will be displayed with respect to - tax on invoice PDFs. - maxLength: 5000 - nullable: true - type: string - title: InvoiceSettingRenderingOptions - type: object - x-expandableFields: [] invoice_setting_subscription_schedule_phase_setting: description: '' properties: @@ -17317,62 +19897,6 @@ components: x-expandableFields: - account_tax_ids - issuer - invoice_tax_amount: - description: '' - properties: - amount: - description: 'The amount, in cents (or local equivalent), of the tax.' - type: integer - inclusive: - description: Whether this tax amount is inclusive or exclusive. - type: boolean - tax_rate: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/tax_rate' - description: The tax rate that was applied to get this tax amount. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/tax_rate' - taxability_reason: - description: >- - The reasoning behind this tax, for example, if the product is tax - exempt. The possible values for this field may be extended as new - tax rules are supported. - enum: - - customer_exempt - - not_collecting - - not_subject_to_tax - - not_supported - - portion_product_exempt - - portion_reduced_rated - - portion_standard_rated - - product_exempt - - product_exempt_holiday - - proportionally_rated - - reduced_rated - - reverse_charge - - standard_rated - - taxable_basis_reduced - - zero_rated - nullable: true - type: string - x-stripeBypassValidation: true - taxable_amount: - description: >- - The amount on which tax is calculated, in cents (or local - equivalent). - nullable: true - type: integer - required: - - amount - - inclusive - - tax_rate - title: InvoiceTaxAmount - type: object - x-expandableFields: - - tax_rate invoice_threshold_reason: description: '' properties: @@ -17393,56 +19917,24 @@ components: type: object x-expandableFields: - item_reasons - invoice_transfer_data: - description: '' - properties: - amount: - description: >- - The amount in cents (or local equivalent) that will be transferred - to the destination account when the invoice is paid. By default, the - entire amount is transferred to the destination. - nullable: true - type: integer - destination: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/account' - description: >- - The account where funds from the payment will be transferred to upon - payment success. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/account' - required: - - destination - title: InvoiceTransferData - type: object - x-expandableFields: - - destination invoiceitem: description: >- Invoice Items represent the component lines of an - [invoice](https://stripe.com/docs/api/invoices). An invoice item is - added to an - - invoice by creating or updating it with an `invoice` field, at which - point it will be included as - - [an invoice line item](https://stripe.com/docs/api/invoices/line_item) - within - - [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines). + [invoice](https://docs.stripe.com/api/invoices). When you create an + invoice item with an `invoice` field, it is attached to the specified + invoice and included as [an invoice line + item](https://docs.stripe.com/api/invoices/line_item) within + [invoice.lines](https://docs.stripe.com/api/invoices/object#invoice_object-lines). Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined - with a [subscription](https://stripe.com/docs/api/subscriptions). + with a [subscription](https://docs.stripe.com/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge - or credit the customer’s card only at the end of a regular billing + or credit the customer's card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your @@ -17450,8 +19942,8 @@ components: Related guides: [Integrate with the Invoicing - API](https://stripe.com/docs/invoicing/integration), [Subscription - Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). + API](https://docs.stripe.com/invoicing/integration), [Subscription + Invoices](https://docs.stripe.com/billing/invoices/subscription#adding-upcoming-invoice-items). properties: amount: description: >- @@ -17472,13 +19964,16 @@ components: type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' - description: >- - The ID of the customer who will be billed when this invoice item is - billed. + description: The ID of the customer to bill for this invoice item. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: The ID of the account to bill for this invoice item. + maxLength: 5000 + nullable: true + type: string date: description: >- Time at which the object was created. Measured in seconds since the @@ -17536,11 +20031,16 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 + net_amount: + description: >- + The amount after discounts, but before credits and taxes. This field + is `null` for `discountable=true` items. + type: integer object: description: >- String representing the object's type. Objects of the same type @@ -17548,42 +20048,33 @@ components: enum: - invoiceitem type: string + parent: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_parent + description: The parent that generated this invoice item. + nullable: true period: $ref: '#/components/schemas/invoice_line_item_period' - price: + pricing: anyOf: - - $ref: '#/components/schemas/price' - description: The price of the invoice item. + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_pricing_pricing + description: The pricing information of the invoice item. nullable: true proration: description: >- Whether the invoice item was created automatically as a proration adjustment when the customer switched plans. type: boolean + proration_details: + $ref: '#/components/schemas/proration_details' quantity: description: >- Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for. type: integer - subscription: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/subscription' - description: >- - The subscription that this invoice item has been created for, if - any. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/subscription' - subscription_item: - description: >- - The subscription item that this invoice item has been created for, - if any. - maxLength: 5000 - type: string tax_rates: description: >- The tax rates which apply to the invoice item. When set, the @@ -17603,17 +20094,6 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' - unit_amount: - description: Unit amount (in the `currency` specified) of the invoice item. - nullable: true - type: integer - unit_amount_decimal: - description: >- - Same as `unit_amount`, but contains a decimal value with at most 12 - decimal places. - format: decimal - nullable: true - type: string required: - amount - currency @@ -17632,9 +20112,10 @@ components: - customer - discounts - invoice + - parent - period - - price - - subscription + - pricing + - proration_details - tax_rates - test_clock x-resourceId: invoiceitem @@ -17681,6 +20162,13 @@ components: Konbini payment method options to pass to the invoice’s PaymentIntent. nullable: true + payto: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_payto' + description: >- + If paying by `payto`, this sub-hash contains details about the PayTo + payment method options to pass to the invoice’s PaymentIntent. + nullable: true sepa_debit: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_sepa_debit' @@ -17706,6 +20194,7 @@ components: - card - customer_balance - konbini + - payto - sepa_debit - us_bank_account invoices_payment_settings: @@ -17739,6 +20228,7 @@ components: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -17746,6 +20236,8 @@ components: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -17754,15 +20246,19 @@ components: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -17779,6 +20275,99 @@ components: type: object x-expandableFields: - payment_method_options + invoices_payments_invoice_payment_associated_payment: + description: '' + properties: + charge: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/charge' + description: >- + ID of the successful charge for this payment when `type` is + `charge`.Note: charge is only surfaced if the charge object is not + associated with a payment intent. If the charge object does have a + payment intent, the Invoice Payment surfaces the payment intent + instead. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/charge' + payment_intent: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_intent' + description: >- + ID of the PaymentIntent associated with this payment when `type` is + `payment_intent`. Note: This property is only populated for invoices + finalized on or after March 15th, 2019. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_intent' + payment_record: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_record' + description: >- + ID of the PaymentRecord associated with this payment when `type` is + `payment_record`. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_record' + type: + description: Type of payment object associated with this invoice payment. + enum: + - charge + - payment_intent + - payment_record + type: string + required: + - type + title: InvoicesPaymentsInvoicePaymentAssociatedPayment + type: object + x-expandableFields: + - charge + - payment_intent + - payment_record + invoices_payments_invoice_payment_status_transitions: + description: '' + properties: + canceled_at: + description: The time that the payment was canceled. + format: unix-time + nullable: true + type: integer + paid_at: + description: The time that the payment succeeded. + format: unix-time + nullable: true + type: integer + title: InvoicesPaymentsInvoicePaymentStatusTransitions + type: object + x-expandableFields: [] + invoices_resource_confirmation_secret: + description: '' + properties: + client_secret: + description: >- + The client_secret of the payment that Stripe creates for the invoice + after finalization. + maxLength: 5000 + type: string + type: + description: >- + The type of client_secret. Currently this is always payment_intent, + referencing the default payment_intent that Stripe creates during + invoice finalization + maxLength: 5000 + type: string + required: + - client_secret + - type + title: InvoicesResourceConfirmationSecret + type: object + x-expandableFields: [] invoices_resource_from_invoice: description: '' properties: @@ -17841,17 +20430,19 @@ components: `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, - `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, - `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, - `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, - `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, - `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, - `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, - `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, - `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, - `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, - `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or + `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, + `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, + `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, + `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, + `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, + `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, + `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, + `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, + `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, + `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, + `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, + `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` enum: - ad_nrt @@ -17862,10 +20453,15 @@ components: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -17881,14 +20477,17 @@ components: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -17905,11 +20504,14 @@ components: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -17927,6 +20529,7 @@ components: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -17966,39 +20569,6 @@ components: title: InvoicesResourceInvoiceTaxID type: object x-expandableFields: [] - invoices_resource_line_items_credited_items: - description: '' - properties: - invoice: - description: Invoice containing the credited invoice line items - maxLength: 5000 - type: string - invoice_line_items: - description: Credited invoice line items - items: - maxLength: 5000 - type: string - type: array - required: - - invoice - - invoice_line_items - title: InvoicesResourceLineItemsCreditedItems - type: object - x-expandableFields: [] - invoices_resource_line_items_proration_details: - description: '' - properties: - credited_items: - anyOf: - - $ref: '#/components/schemas/invoices_resource_line_items_credited_items' - description: >- - For a credit proration `line_item`, the original debit line_items to - which the credit proration applies. - nullable: true - title: InvoicesResourceLineItemsProrationDetails - type: object - x-expandableFields: - - credited_items invoices_resource_pretax_credit_amount: description: '' properties: @@ -18111,18 +20681,18 @@ components: x-expandableFields: [] issuing.authorization: description: >- - When an [issued card](https://stripe.com/docs/issuing) is used to make a + When an [issued card](https://docs.stripe.com/issuing) is used to make a purchase, an Issuing `Authorization` object is created. - [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + [Authorizations](https://docs.stripe.com/issuing/purchases/authorizations) must be approved for the purchase to be completed successfully. Related guide: [Issued card - authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + authorizations](https://docs.stripe.com/issuing/purchases/authorizations) properties: amount: description: >- @@ -18138,7 +20708,7 @@ components: 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). + unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true approved: description: Whether the authorization has been approved. @@ -18241,7 +20811,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -18282,17 +20852,17 @@ components: description: The current status of the authorization in its lifecycle. enum: - closed + - expired - pending - reversed type: string - x-stripeBypassValidation: true token: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/issuing.token' description: >- - [Token](https://stripe.com/docs/api/issuing/tokens/object) object + [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null. nullable: true @@ -18302,7 +20872,7 @@ components: transactions: description: >- List of - [transactions](https://stripe.com/docs/api/issuing/transactions) + [transactions](https://docs.stripe.com/api/issuing/transactions) associated with this authorization. items: $ref: '#/components/schemas/issuing.transaction' @@ -18311,9 +20881,9 @@ components: anyOf: - $ref: '#/components/schemas/issuing_authorization_treasury' description: >- - [Treasury](https://stripe.com/docs/api/treasury) details related to + [Treasury](https://docs.stripe.com/api/treasury) details related to this authorization if it was created on a - [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). + [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts). nullable: true verification_data: $ref: '#/components/schemas/issuing_authorization_verification_data' @@ -18373,7 +20943,7 @@ components: issuing.card: description: >- You can [create physical or virtual - cards](https://stripe.com/docs/issuing) that are issued to cardholders. + cards](https://docs.stripe.com/issuing) that are issued to cardholders. properties: brand: description: The brand of the card. @@ -18409,9 +20979,9 @@ components: The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` - parameter](https://stripe.com/docs/api/expanding_objects). + parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" - endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not + endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. maxLength: 5000 type: string @@ -18434,6 +21004,14 @@ components: description: The last 4 digits of the card number. maxLength: 5000 type: string + latest_fraud_warning: + anyOf: + - $ref: '#/components/schemas/issuing_card_fraud_warning' + description: >- + Stripe’s assessment of whether this card’s details have been + compromised. If this property isn't null, cancel and reissue the + card to prevent fraudulent activity risk. + nullable: true livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -18444,7 +21022,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -18453,9 +21031,9 @@ components: The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` - parameter](https://stripe.com/docs/api/expanding_objects). + parameter](https://docs.stripe.com/api/expanding_objects). Additionally, it's only available via the ["Retrieve a card" - endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not + endpoint](https://docs.stripe.com/api/issuing/cards/retrieve), not via "List all cards" or any other endpoint. maxLength: 5000 type: string @@ -18506,6 +21084,11 @@ components: nullable: true type: string x-stripeBypassValidation: true + second_line: + description: 'Text separate from cardholder name, printed on the card.' + maxLength: 5000 + nullable: true + type: string shipping: anyOf: - $ref: '#/components/schemas/issuing_card_shipping' @@ -18556,6 +21139,7 @@ components: type: object x-expandableFields: - cardholder + - latest_fraud_warning - personalization_design - replaced_by - replacement_for @@ -18566,11 +21150,11 @@ components: issuing.cardholder: description: >- An Issuing `Cardholder` object represents an individual or business - entity who is [issued](https://stripe.com/docs/issuing) cards. + entity who is [issued](https://docs.stripe.com/issuing) cards. Related guide: [How to create a - cardholder](https://stripe.com/docs/issuing/cards/virtual/issue-cards#create-cardholder) + cardholder](https://docs.stripe.com/issuing/cards/virtual/issue-cards#create-cardholder) properties: billing: $ref: '#/components/schemas/issuing_cardholder_address' @@ -18609,7 +21193,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -18628,7 +21212,7 @@ components: description: >- The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure - documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) + documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. maxLength: 5000 nullable: true @@ -18637,7 +21221,7 @@ components: description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. items: enum: - de @@ -18656,7 +21240,7 @@ components: description: >- Rules that control spending across this cardholder's cards. Refer to our - [documentation](https://stripe.com/docs/issuing/controls/spending-controls) + [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. nullable: true status: @@ -18671,7 +21255,7 @@ components: type: description: >- One of `individual` or `company`. See [Choose a cardholder - type](https://stripe.com/docs/issuing/other/choose-cardholder) for + type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. enum: - company @@ -18700,18 +21284,18 @@ components: x-resourceId: issuing.cardholder issuing.dispute: description: >- - As a [card issuer](https://stripe.com/docs/issuing), you can dispute + As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing - disputes](https://stripe.com/docs/issuing/purchases/disputes) + disputes](https://docs.stripe.com/issuing/purchases/disputes) properties: amount: description: >- Disputed amount in the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). Usually the + unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation). type: integer @@ -18774,7 +21358,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -18807,7 +21391,7 @@ components: anyOf: - $ref: '#/components/schemas/issuing_dispute_treasury' description: >- - [Treasury](https://stripe.com/docs/api/treasury) details related to + [Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts nullable: true @@ -18881,7 +21465,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -18997,7 +21581,7 @@ components: issuing.settlement: description: >- When a non-stripe BIN is used, any use of an [issued - card](https://stripe.com/docs/issuing) must be settled directly with the + card](https://docs.stripe.com/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. properties: @@ -19029,7 +21613,7 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string - interchange_fees: + interchange_fees_amount: description: >- The total interchange received as reimbursement for the transactions. @@ -19044,11 +21628,11 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object - net_total: + net_total_amount: description: The total net amount required to settle with the network. type: integer network: @@ -19059,7 +21643,7 @@ components: - maestro - visa type: string - network_fees: + network_fees_amount: description: The total amount of fees owed to the network. type: integer network_settlement_identifier: @@ -19083,30 +21667,30 @@ components: - complete - pending type: string + transaction_amount: + description: The total transaction amount reflected in this settlement. + type: integer transaction_count: description: The total number of transactions reflected in this settlement. type: integer - transaction_volume: - description: The total transaction amount reflected in this settlement. - type: integer required: - bin - clearing_date - created - currency - id - - interchange_fees + - interchange_fees_amount - livemode - metadata - - net_total + - net_total_amount - network - - network_fees + - network_fees_amount - network_settlement_identifier - object - settlement_service - status + - transaction_amount - transaction_count - - transaction_volume title: IssuingSettlement type: object x-expandableFields: [] @@ -19114,9 +21698,9 @@ components: issuing.token: description: >- An issuing token object is created when an issued card is added to a - digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you + digital wallet. As a [card issuer](https://docs.stripe.com/issuing), you can [view and manage these - tokens](https://stripe.com/docs/issuing/controls/token-management) + tokens](https://docs.stripe.com/issuing/controls/token-management) through Stripe. properties: card: @@ -19207,7 +21791,7 @@ components: x-resourceId: issuing.token issuing.transaction: description: >- - Any use of an [issued card](https://stripe.com/docs/issuing) that + Any use of an [issued card](https://docs.stripe.com/issuing) that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is @@ -19217,13 +21801,13 @@ components: Related guide: [Issued card - transactions](https://stripe.com/docs/issuing/purchases/transactions) + transactions](https://docs.stripe.com/issuing/purchases/transactions) properties: amount: description: >- The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer amount_details: anyOf: @@ -19231,7 +21815,7 @@ components: 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). + unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true authorization: anyOf: @@ -19250,7 +21834,7 @@ components: - $ref: '#/components/schemas/balance_transaction' description: >- ID of the [balance - transaction](https://stripe.com/docs/api/balance_transactions) + transaction](https://docs.stripe.com/api/balance_transactions) associated with this transaction. nullable: true x-expansionResources: @@ -19312,7 +21896,7 @@ components: description: >- The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). It will be + unit](https://docs.stripe.com/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency. type: integer @@ -19327,7 +21911,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -19358,7 +21942,7 @@ components: type: string - $ref: '#/components/schemas/issuing.token' description: >- - [Token](https://stripe.com/docs/api/issuing/tokens/object) object + [Token](https://docs.stripe.com/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null. nullable: true @@ -19369,7 +21953,7 @@ components: anyOf: - $ref: '#/components/schemas/issuing_transaction_treasury' description: >- - [Treasury](https://stripe.com/docs/api/treasury) details related to + [Treasury](https://docs.stripe.com/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts nullable: true @@ -19702,7 +22286,7 @@ components: description: >- A categorization of the seller's type of business. See our [merchant categories - guide](https://stripe.com/docs/issuing/merchant-categories) for a + guide](https://docs.stripe.com/issuing/merchant-categories) for a list of possible values. maxLength: 5000 type: string @@ -19802,9 +22386,9 @@ components: description: >- The additional amount Stripe will hold if the authorization is approved, in the card's - [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) + [currency](https://docs.stripe.com/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer amount_details: anyOf: @@ -19812,7 +22396,7 @@ components: 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). + unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true currency: description: >- @@ -19825,14 +22409,14 @@ components: is_amount_controllable: description: >- If set `true`, you may provide - [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) + [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean merchant_amount: description: >- The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer merchant_currency: description: The local currency the merchant is requesting to authorize. @@ -19861,7 +22445,7 @@ components: description: >- The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held + unit](https://docs.stripe.com/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved. type: integer @@ -19871,7 +22455,7 @@ components: 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). + unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true approved: description: Whether this request was approved. @@ -19905,7 +22489,7 @@ components: description: >- The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer merchant_currency: description: >- @@ -19937,6 +22521,7 @@ components: - cardholder_verification_required - insecure_authorization_method - insufficient_funds + - network_fallback - not_allowed - pin_blocked - spending_controls @@ -19999,7 +22584,7 @@ components: received_credits: description: >- The array of - [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) + [ReceivedCredits](https://docs.stripe.com/api/treasury/received_credits) associated with this authorization items: maxLength: 5000 @@ -20008,7 +22593,7 @@ components: received_debits: description: >- The array of - [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) + [ReceivedDebits](https://docs.stripe.com/api/treasury/received_debits) associated with this authorization items: maxLength: 5000 @@ -20017,7 +22602,7 @@ components: transaction: description: >- The Treasury - [Transaction](https://stripe.com/docs/api/treasury/transactions) + [Transaction](https://docs.stripe.com/api/treasury/transactions) associated with this authorization maxLength: 5000 nullable: true @@ -20120,7 +22705,7 @@ components: allowed_categories: description: >- Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. items: @@ -20441,7 +23026,7 @@ components: blocked_categories: description: >- Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. items: @@ -20778,6 +23363,29 @@ components: type: object x-expandableFields: - spending_limits + issuing_card_fraud_warning: + description: '' + properties: + started_at: + description: Timestamp of the most recent fraud warning. + format: unix-time + nullable: true + type: integer + type: + description: >- + The type of fraud warning that most recently took place on this + card. This field updates with every new fraud warning, so the value + changes over time. If populated, cancel and reissue the card. + enum: + - card_testing_exposure + - fraud_dispute_filed + - third_party_reported + - user_indicated_fraud + nullable: true + type: string + title: IssuingCardFraudWarning + type: object + x-expandableFields: [] issuing_card_google_pay: description: '' properties: @@ -20951,12 +23559,12 @@ components: description: >- Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer categories: description: >- Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. items: @@ -21314,7 +23922,7 @@ components: allowed_categories: description: >- Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. items: @@ -21635,7 +24243,7 @@ components: blocked_categories: description: >- Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. items: @@ -22005,8 +24613,8 @@ components: - $ref: '#/components/schemas/file' description: >- The back of a document returned by a [file - upload](https://stripe.com/docs/api#create_file) with a `purpose` - value of `identity_document`. + upload](https://api.stripe.com#create_file) with a `purpose` value + of `identity_document`. nullable: true x-expansionResources: oneOf: @@ -22018,8 +24626,8 @@ components: - $ref: '#/components/schemas/file' description: >- The front of a document returned by a [file - upload](https://stripe.com/docs/api#create_file) with a `purpose` - value of `identity_document`. + upload](https://api.stripe.com#create_file) with a `purpose` value + of `identity_document`. nullable: true x-expansionResources: oneOf: @@ -22132,12 +24740,12 @@ components: description: >- Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer categories: description: >- Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + [categories](https://docs.stripe.com/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories. items: @@ -22903,7 +25511,7 @@ components: debit_reversal: description: >- The Treasury - [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) + [DebitReversal](https://docs.stripe.com/api/treasury/debit_reversals) representing this Issuing dispute maxLength: 5000 nullable: true @@ -22911,7 +25519,7 @@ components: received_debit: description: >- The Treasury - [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) + [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) that is being disputed. maxLength: 5000 type: string @@ -23660,7 +26268,7 @@ components: received_credit: description: >- The Treasury - [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) + [ReceivedCredit](https://docs.stripe.com/api/treasury/received_credits) representing this Issuing transaction if it is a refund maxLength: 5000 nullable: true @@ -23668,7 +26276,7 @@ components: received_debit: description: >- The Treasury - [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) + [ReceivedDebit](https://docs.stripe.com/api/treasury/received_debits) representing this Issuing transaction if it is a capture maxLength: 5000 nullable: true @@ -23679,6 +26287,10 @@ components: item: description: A line item. properties: + adjustable_quantity: + anyOf: + - $ref: '#/components/schemas/line_items_adjustable_quantity' + nullable: true amount_discount: description: >- Total discount amount applied. If no discounts were applied, @@ -23717,6 +26329,16 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://docs.stripe.com/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 @@ -23749,6 +26371,7 @@ components: title: LineItem type: object x-expandableFields: + - adjustable_quantity - discounts - price - taxes @@ -23796,7 +26419,7 @@ components: Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` - parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided). + parameter](https://docs.stripe.com/api/accounts/update#update_account-company-directors_provided). type: boolean directorship_declaration: anyOf: @@ -23810,7 +26433,7 @@ components: Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` - parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), + parameter](https://docs.stripe.com/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided. type: boolean export_license_id: @@ -23824,17 +26447,28 @@ components: maxLength: 5000 type: string name: - description: The company's legal name. + description: >- + The company's legal name. Also available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string name_kana: - description: The Kana variation of the company's legal name (Japan only). + description: >- + The Kana variation of the company's legal name (Japan only). Also + available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string name_kanji: - description: The Kanji variation of the company's legal name (Japan only). + description: >- + The Kanji variation of the company's legal name (Japan only). Also + available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string @@ -23843,7 +26477,7 @@ components: Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` - parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), + parameter](https://docs.stripe.com/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the @@ -23857,6 +26491,13 @@ components: provided to Stripe is both current and correct. nullable: true ownership_exemption_reason: + description: >- + This value is used to determine if a business is exempt from + providing ultimate beneficial owners. See [this support + article](https://support.stripe.com/questions/exemption-from-providing-ownership-details) + and + [changelog](https://docs.stripe.com/changelog/acacia/2025-01-27/ownership-exemption-reason-accounts-api) + for more details. enum: - qualified_entity_exceeds_ownership_threshold - qualifies_as_financial_institution @@ -23866,11 +26507,22 @@ components: maxLength: 5000 nullable: true type: string + registration_date: + $ref: '#/components/schemas/legal_entity_registration_date' + representative_declaration: + anyOf: + - $ref: '#/components/schemas/legal_entity_representative_declaration' + description: >- + This hash is used to attest that the representative is authorized to + act as the representative of their legal entity. + nullable: true structure: description: >- The category identifying the legal structure of the company or legal - entity. See [Business - structure](https://stripe.com/docs/connect/identity-verification#business-structure) + entity. Also available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. See [Business + structure](https://docs.stripe.com/connect/identity-verification#business-structure) for more details. enum: - free_zone_establishment @@ -23923,6 +26575,8 @@ components: - address_kanji - directorship_declaration - ownership_declaration + - registration_date + - representative_declaration - verification legal_entity_company_verification: description: '' @@ -23945,8 +26599,9 @@ components: - $ref: '#/components/schemas/file' description: >- The back of a document returned by a [file - upload](https://stripe.com/docs/api#create_file) with a `purpose` - value of `additional_verification`. + upload](https://api.stripe.com#create_file) with a `purpose` value + of `additional_verification`. Note that `additional_verification` + files are [not downloadable](/file-upload#uploading-a-file). nullable: true x-expansionResources: oneOf: @@ -23978,8 +26633,9 @@ components: - $ref: '#/components/schemas/file' description: >- The front of a document returned by a [file - upload](https://stripe.com/docs/api#create_file) with a `purpose` - value of `additional_verification`. + upload](https://api.stripe.com#create_file) with a `purpose` value + of `additional_verification`. Note that `additional_verification` + files are [not downloadable](/file-upload#uploading-a-file). nullable: true x-expansionResources: oneOf: @@ -24110,7 +26766,9 @@ components: status: description: >- The state of verification for the person. Possible values are - `unverified`, `pending`, or `verified`. + `unverified`, `pending`, or `verified`. Please refer + [guide](https://docs.stripe.com/connect/handling-api-verification) + to handle verification updates. maxLength: 5000 type: string required: @@ -24130,8 +26788,8 @@ components: - $ref: '#/components/schemas/file' description: >- The back of an ID returned by a [file - upload](https://stripe.com/docs/api#create_file) with a `purpose` - value of `identity_document`. + upload](https://api.stripe.com#create_file) with a `purpose` value + of `identity_document`. nullable: true x-expansionResources: oneOf: @@ -24166,8 +26824,8 @@ components: - $ref: '#/components/schemas/file' description: >- The front of an ID returned by a [file - upload](https://stripe.com/docs/api#create_file) with a `purpose` - value of `identity_document`. + upload](https://api.stripe.com#create_file) with a `purpose` value + of `identity_document`. nullable: true x-expansionResources: oneOf: @@ -24177,6 +26835,51 @@ components: x-expandableFields: - back - front + legal_entity_registration_date: + description: '' + properties: + day: + description: 'The day of registration, between 1 and 31.' + nullable: true + type: integer + month: + description: 'The month of registration, between 1 and 12.' + nullable: true + type: integer + year: + description: The four-digit year of registration. + nullable: true + type: integer + title: LegalEntityRegistrationDate + type: object + x-expandableFields: [] + legal_entity_representative_declaration: + description: '' + properties: + date: + description: >- + The Unix timestamp marking when the representative declaration + attestation was made. + format: unix-time + nullable: true + type: integer + ip: + description: >- + The IP address from which the representative declaration attestation + was made. + maxLength: 5000 + nullable: true + type: string + user_agent: + description: >- + The user-agent string from the browser where the representative + declaration attestation was made. + maxLength: 5000 + nullable: true + type: string + title: LegalEntityRepresentativeDeclaration + type: object + x-expandableFields: [] legal_entity_ubo_declaration: description: '' properties: @@ -24205,23 +26908,17 @@ components: line_item: description: >- Invoice Line Items represent the individual lines within an - [invoice](https://stripe.com/docs/api/invoices) and only exist within + [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice. Each line item is backed by either an [invoice - item](https://stripe.com/docs/api/invoiceitems) or a [subscription - item](https://stripe.com/docs/api/subscription_items). + item](https://docs.stripe.com/api/invoiceitems) or a [subscription + item](https://docs.stripe.com/api/subscription_items). properties: amount: description: 'The amount, in cents (or local equivalent).' type: integer - amount_excluding_tax: - description: >- - The integer amount in cents (or local equivalent) representing the - amount for this line item, excluding all tax and discounts. - nullable: true - type: integer currency: description: >- Three-letter [ISO currency @@ -24271,18 +26968,6 @@ components: maxLength: 5000 nullable: true type: string - invoice_item: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoiceitem' - description: >- - The ID of the [invoice - item](https://stripe.com/docs/api/invoiceitems) associated with this - line item if any. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoiceitem' livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -24293,7 +26978,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects @@ -24308,6 +26993,12 @@ components: enum: - line_item type: string + parent: + anyOf: + - $ref: >- + #/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent + description: The parent that generated this line item. + nullable: true period: $ref: '#/components/schemas/invoice_line_item_period' pretax_credit_amounts: @@ -24318,19 +27009,11 @@ components: $ref: '#/components/schemas/invoices_resource_pretax_credit_amount' nullable: true type: array - price: - anyOf: - - $ref: '#/components/schemas/price' - description: The price of the line item. - nullable: true - proration: - description: Whether this is a proration. - type: boolean - proration_details: + pricing: anyOf: - $ref: >- - #/components/schemas/invoices_resource_line_items_proration_details - description: Additional details for proration line items + #/components/schemas/billing_bill_resource_invoicing_pricing_pricing + description: The pricing information of the line item. nullable: true quantity: description: >- @@ -24343,47 +27026,21 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/subscription' - description: 'The subscription that the invoice item pertains to, if any.' nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/subscription' - subscription_item: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/subscription_item' + subtotal: description: >- - The subscription item that generated this line item. Left empty if - the line item is not an explicit result of a subscription. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/subscription_item' - tax_amounts: - description: The amount of tax calculated per tax rate for this line item - items: - $ref: '#/components/schemas/invoice_tax_amount' - type: array - tax_rates: - description: The tax rates which apply to the line item. + The subtotal of the line item, in cents (or local equivalent), + before any discounts or taxes. + type: integer + taxes: + description: The tax information of the line item. items: - $ref: '#/components/schemas/tax_rate' - type: array - type: - description: >- - A string identifying the type of the source of this line item, - either an `invoiceitem` or a `subscription`. - enum: - - invoiceitem - - subscription - type: string - unit_amount_excluding_tax: - description: >- - The amount in cents (or local equivalent) representing the unit - amount for this line item, excluding all tax and discounts. - format: decimal + $ref: '#/components/schemas/billing_bill_resource_invoicing_taxes_tax' nullable: true - type: string + type: array required: - amount - currency @@ -24394,25 +27051,35 @@ components: - metadata - object - period - - proration - - tax_amounts - - tax_rates - - type + - subtotal title: InvoiceLineItem type: object x-expandableFields: - discount_amounts - discounts - - invoice_item + - parent - period - pretax_credit_amounts - - price - - proration_details + - pricing - subscription - - subscription_item - - tax_amounts - - tax_rates + - taxes x-resourceId: line_item + line_items_adjustable_quantity: + description: '' + properties: + enabled: + type: boolean + maximum: + nullable: true + type: integer + minimum: + nullable: true + type: integer + required: + - enabled + title: LineItemsAdjustableQuantity + type: object + x-expandableFields: [] line_items_discount_amount: description: '' properties: @@ -24473,12 +27140,12 @@ components: type: object x-expandableFields: - rate - linked_account_options_us_bank_account: + linked_account_options_common: description: '' properties: filters: $ref: >- - #/components/schemas/payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters + #/components/schemas/payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters permissions: description: >- The list of permissions to request. The `payment_method` permission @@ -24509,16 +27176,19 @@ components: your app. maxLength: 5000 type: string - title: linked_account_options_us_bank_account + title: linked_account_options_common type: object x-expandableFields: - filters login_link: description: >- - Login Links are single-use URLs for a connected account to access the - Express Dashboard. The connected account's - [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) - must be `express` to have access to the Express Dashboard. + Login Links are single-use URLs that takes an Express account to the + login page for their Stripe dashboard. + + A Login Link differs from an [Account + Link](https://docs.stripe.com/api/account_links) in that it takes the + user directly to their [Express dashboard for the specified + account](https://docs.stripe.com/connect/integrate-express-dashboard#create-login-link) properties: created: description: >- @@ -24683,6 +27353,11 @@ components: mandate_bacs_debit: description: '' properties: + display_name: + description: The display name for the account on this mandate. + maxLength: 5000 + nullable: true + type: string network_status: description: >- The status of the mandate on the Bacs network. Can be one of @@ -24709,6 +27384,11 @@ components: - debit_not_authorized nullable: true type: string + service_user_number: + description: The service user number for the account on this mandate. + maxLength: 5000 + nullable: true + type: string url: description: The URL that will contain the mandate that the customer has signed. maxLength: 5000 @@ -24732,6 +27412,12 @@ components: title: mandate_kakao_pay type: object x-expandableFields: [] + mandate_klarna: + description: '' + properties: {} + title: mandate_klarna + type: object + x-expandableFields: [] mandate_kr_card: description: '' properties: {} @@ -24750,6 +27436,94 @@ components: title: mandate_multi_use type: object x-expandableFields: [] + mandate_naver_pay: + description: '' + properties: {} + title: mandate_naver_pay + type: object + x-expandableFields: [] + mandate_nz_bank_account: + description: '' + properties: {} + title: mandate_nz_bank_account + type: object + x-expandableFields: [] + mandate_options_payto: + description: '' + properties: + amount: + description: >- + Amount that will be collected. It is required when `amount_type` is + `fixed`. + nullable: true + type: integer + amount_type: + description: >- + The type of amount that will be collected. The amount charged must + be exact or up to the value of `amount` param for `fixed` or + `maximum` type respectively. Defaults to `maximum`. + enum: + - fixed + - maximum + nullable: true + type: string + end_date: + description: >- + Date, in YYYY-MM-DD format, after which payments will not be + collected. Defaults to no end date. + maxLength: 5000 + nullable: true + type: string + payment_schedule: + description: >- + The periodicity at which payments will be collected. Defaults to + `adhoc`. + enum: + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + nullable: true + type: string + payments_per_period: + description: >- + The number of payments that will be made during a payment period. + Defaults to 1 except for when `payment_schedule` is `adhoc`. In that + case, it defaults to no limit. + nullable: true + type: integer + purpose: + description: >- + The purpose for which payments are made. Has a default value based + on your merchant category code. + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + nullable: true + type: string + start_date: + description: >- + Date, in YYYY-MM-DD format, from which payments will be collected. + Defaults to confirmation time. + maxLength: 5000 + nullable: true + type: string + title: mandate_options_payto + type: object + x-expandableFields: [] mandate_payment_method_details: description: '' properties: @@ -24767,12 +27541,20 @@ components: $ref: '#/components/schemas/mandate_cashapp' kakao_pay: $ref: '#/components/schemas/mandate_kakao_pay' + klarna: + $ref: '#/components/schemas/mandate_klarna' kr_card: $ref: '#/components/schemas/mandate_kr_card' link: $ref: '#/components/schemas/mandate_link' + naver_pay: + $ref: '#/components/schemas/mandate_naver_pay' + nz_bank_account: + $ref: '#/components/schemas/mandate_nz_bank_account' paypal: $ref: '#/components/schemas/mandate_paypal' + payto: + $ref: '#/components/schemas/mandate_payto' revolut_pay: $ref: '#/components/schemas/mandate_revolut_pay' sepa_debit: @@ -24799,9 +27581,13 @@ components: - card - cashapp - kakao_pay + - klarna - kr_card - link + - naver_pay + - nz_bank_account - paypal + - payto - revolut_pay - sepa_debit - us_bank_account @@ -24826,6 +27612,83 @@ components: title: mandate_paypal type: object x-expandableFields: [] + mandate_payto: + description: '' + properties: + amount: + description: >- + Amount that will be collected. It is required when `amount_type` is + `fixed`. + nullable: true + type: integer + amount_type: + description: >- + The type of amount that will be collected. The amount charged must + be exact or up to the value of `amount` param for `fixed` or + `maximum` type respectively. Defaults to `maximum`. + enum: + - fixed + - maximum + type: string + end_date: + description: >- + Date, in YYYY-MM-DD format, after which payments will not be + collected. Defaults to no end date. + maxLength: 5000 + nullable: true + type: string + payment_schedule: + description: >- + The periodicity at which payments will be collected. Defaults to + `adhoc`. + enum: + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + description: >- + The number of payments that will be made during a payment period. + Defaults to 1 except for when `payment_schedule` is `adhoc`. In that + case, it defaults to no limit. + nullable: true + type: integer + purpose: + description: >- + The purpose for which payments are made. Has a default value based + on your merchant category code. + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + nullable: true + type: string + start_date: + description: >- + Date, in YYYY-MM-DD format, from which payments will be collected. + Defaults to confirmation time. + maxLength: 5000 + nullable: true + type: string + required: + - amount_type + - payment_schedule + title: mandate_payto + type: object + x-expandableFields: [] mandate_revolut_pay: description: '' properties: {} @@ -24884,7 +27747,9 @@ components: description: '' properties: available: - description: All available networks for the card. + description: >- + All networks available for selection via + [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). items: maxLength: 5000 type: string @@ -24909,8 +27774,8 @@ components: description: >- Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice - object](https://stripe.com/docs/api#invoice_object) as the value of - the object key. + object](https://api.stripe.com#invoice_object) as the value of the + object key. type: object previous_attributes: description: >- @@ -25065,7 +27930,7 @@ components: network: description: >- The network rails used. See the - [docs](https://stripe.com/docs/treasury/money-movement/timelines) to + [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach @@ -25172,7 +28037,7 @@ components: network: description: >- The network rails used. See the - [docs](https://stripe.com/docs/treasury/money-movement/timelines) to + [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: - ach @@ -25212,15 +28077,219 @@ components: title: PackageDimensions type: object x-expandableFields: [] + payment_attempt_record: + description: >- + A Payment Attempt Record represents an individual attempt at making a + payment, on or off Stripe. + + Each payment attempt tries to collect a fixed amount of money from a + fixed customer and payment + + method. Payment Attempt Records are attached to Payment Records. Only + one attempt per Payment Record + + can have guaranteed funds. + properties: + amount: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_authorized: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_canceled: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_failed: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_guaranteed: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_refunded: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_requested: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + application: + description: ID of the Connect application that created the PaymentAttemptRecord. + maxLength: 5000 + nullable: true + type: string + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + customer_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_customer_details + description: Customer information for this payment. + nullable: true + customer_presence: + description: >- + Indicates whether the customer was present in your checkout flow + during this payment. + enum: + - off_session + - on_session + nullable: true + type: string + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + nullable: true + type: string + 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://docs.stripe.com/api/metadata) that + you can attach to an object. This can be useful for storing + additional information about the object in a structured format. + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - payment_attempt_record + type: string + payment_method_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_details + description: Information about the Payment Method debited for this payment. + nullable: true + payment_record: + description: ID of the Payment Record this Payment Attempt Record belongs to. + maxLength: 5000 + nullable: true + type: string + processor_details: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_processor_details + reported_by: + description: Indicates who reported the payment. + enum: + - self + - stripe + type: string + shipping_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_shipping_details + description: Shipping information for this payment. + nullable: true + required: + - amount + - amount_authorized + - amount_canceled + - amount_failed + - amount_guaranteed + - amount_refunded + - amount_requested + - created + - id + - livemode + - metadata + - object + - processor_details + - reported_by + title: PaymentAttemptRecord + type: object + x-expandableFields: + - amount + - amount_authorized + - amount_canceled + - amount_failed + - amount_guaranteed + - amount_refunded + - amount_requested + - customer_details + - payment_method_details + - processor_details + - shipping_details + x-resourceId: payment_attempt_record payment_flows_amount_details: description: '' properties: + discount_amount: + description: >- + The total discount applied on the transaction represented in the + [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal). An integer + greater than 0. + + + This field is mutually exclusive with the + `amount_details[line_items][#][discount_amount]` field. + type: integer + error: + $ref: '#/components/schemas/payment_flows_amount_details_resource_error' + line_items: + description: >- + A list of line items, each containing information about a product in + the PaymentIntent. There is a maximum of 200 line items. + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/payment_intent_amount_details_line_item' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: PaymentFlowsAmountDetailsResourceLineItemsList + type: object + x-expandableFields: + - data + shipping: + $ref: '#/components/schemas/payment_flows_amount_details_resource_shipping' + tax: + $ref: '#/components/schemas/payment_flows_amount_details_resource_tax' tip: $ref: >- #/components/schemas/payment_flows_amount_details_client_resource_tip title: PaymentFlowsAmountDetails type: object x-expandableFields: + - error + - line_items + - shipping + - tax - tip payment_flows_amount_details_client: description: '' @@ -25241,6 +28310,117 @@ components: title: PaymentFlowsAmountDetailsClientResourceTip type: object x-expandableFields: [] + payment_flows_amount_details_resource_error: + description: '' + properties: + code: + description: >- + The code of the error that occurred when validating the current + amount details. + enum: + - amount_details_amount_mismatch + - amount_details_tax_shipping_discount_greater_than_amount + nullable: true + type: string + message: + description: A message providing more details about the error. + maxLength: 5000 + nullable: true + type: string + title: PaymentFlowsAmountDetailsResourceError + type: object + x-expandableFields: [] + payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options: + description: '' + properties: + card: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options + card_present: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options + klarna: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options + paypal: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options + title: >- + PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions + type: object + x-expandableFields: + - card + - card_present + - klarna + - paypal + payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax: + description: '' + properties: + total_tax_amount: + description: >- + The total amount of tax on the transaction represented in the + [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal). Required for + L2 rates. An integer greater than or equal to 0. + + + This field is mutually exclusive with the + `amount_details[line_items][#][tax][total_tax_amount]` field. + type: integer + required: + - total_tax_amount + title: >- + PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourceTax + type: object + x-expandableFields: [] + payment_flows_amount_details_resource_shipping: + description: '' + properties: + amount: + description: >- + If a physical good is being shipped, the cost of shipping + represented in the [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal). An integer + greater than or equal to 0. + nullable: true + type: integer + from_postal_code: + description: >- + If a physical good is being shipped, the postal code of where it is + being shipped from. At most 10 alphanumeric characters long, hyphens + are allowed. + maxLength: 5000 + nullable: true + type: string + to_postal_code: + description: >- + If a physical good is being shipped, the postal code of where it is + being shipped to. At most 10 alphanumeric characters long, hyphens + are allowed. + maxLength: 5000 + nullable: true + type: string + title: PaymentFlowsAmountDetailsResourceShipping + type: object + x-expandableFields: [] + payment_flows_amount_details_resource_tax: + description: '' + properties: + total_tax_amount: + description: >- + The total amount of tax on the transaction represented in the + [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal). Required for + L2 rates. An integer greater than or equal to 0. + + + This field is mutually exclusive with the + `amount_details[line_items][#][tax][total_tax_amount]` field. + nullable: true + type: integer + title: PaymentFlowsAmountDetailsResourceTax + type: object + x-expandableFields: [] payment_flows_automatic_payment_methods_payment_intent: description: '' properties: @@ -25253,7 +28433,7 @@ components: Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To - [confirm](https://stripe.com/docs/api/payment_intents/confirm) this + [confirm](https://docs.stripe.com/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment. @@ -25281,7 +28461,7 @@ components: Redirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To - [confirm](https://stripe.com/docs/api/setup_intents/confirm) this + [confirm](https://docs.stripe.com/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup. @@ -25309,6 +28489,94 @@ components: type: object x-expandableFields: - plan + payment_flows_payment_details: + description: '' + properties: + customer_reference: + description: >- + A unique value to identify the customer. This field is available + only for card payments. + + + This field is truncated to 25 alphanumeric characters, excluding + spaces, before being sent to card networks. + maxLength: 5000 + nullable: true + type: string + order_reference: + description: >- + A unique value assigned by the business to identify the transaction. + Required for L2 and L3 rates. + + + Required when the Payment Method Types array contains `card`, + including when + [automatic_payment_methods.enabled](/api/payment_intents/create#create_payment_intent-automatic_payment_methods-enabled) + is set to `true`. + + + For Cards, this field is truncated to 25 alphanumeric characters, + excluding spaces, before being sent to card networks. For Klarna, + this field is truncated to 255 characters and is visible to + customers when they view the order in the Klarna app. + maxLength: 5000 + nullable: true + type: string + title: PaymentFlowsPaymentDetails + type: object + x-expandableFields: [] + payment_flows_payment_intent_async_workflows: + description: '' + properties: + inputs: + $ref: >- + #/components/schemas/payment_flows_payment_intent_async_workflows_resource_inputs + title: PaymentFlowsPaymentIntentAsyncWorkflows + type: object + x-expandableFields: + - inputs + payment_flows_payment_intent_async_workflows_resource_inputs: + description: '' + properties: + tax: + $ref: >- + #/components/schemas/payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax + title: PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputs + type: object + x-expandableFields: + - tax + payment_flows_payment_intent_async_workflows_resource_inputs_resource_tax: + description: '' + properties: + calculation: + description: >- + The [TaxCalculation](https://docs.stripe.com/api/tax/calculations) + id + maxLength: 5000 + type: string + required: + - calculation + title: PaymentFlowsPaymentIntentAsyncWorkflowsResourceInputsResourceTax + type: object + x-expandableFields: [] + payment_flows_payment_intent_presentment_details: + description: '' + properties: + presentment_amount: + description: >- + Amount intended to be collected by this payment, denominated in + `presentment_currency`. + type: integer + presentment_currency: + description: Currency presented to the customer during payment. + maxLength: 5000 + type: string + required: + - presentment_amount + - presentment_currency + title: PaymentFlowsPaymentIntentPresentmentDetails + type: object + x-expandableFields: [] payment_flows_private_payment_methods_alipay: description: '' properties: {} @@ -25406,6 +28674,28 @@ components: title: PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture type: object x-expandableFields: [] + payment_flows_private_payment_methods_card_payment_intent_amount_details_line_item_payment_method_options: + description: '' + properties: + commodity_code: + maxLength: 5000 + nullable: true + type: string + title: >- + PaymentFlowsPrivatePaymentMethodsCardPaymentIntentAmountDetailsLineItemPaymentMethodOptions + type: object + x-expandableFields: [] + payment_flows_private_payment_methods_card_present_amount_details_line_item_payment_method_options: + description: '' + properties: + commodity_code: + maxLength: 5000 + nullable: true + type: string + title: >- + PaymentFlowsPrivatePaymentMethodsCardPresentAmountDetailsLineItemPaymentMethodOptions + type: object + x-expandableFields: [] payment_flows_private_payment_methods_card_present_common_wallet: description: '' properties: @@ -25424,6 +28714,23 @@ components: title: PaymentFlowsPrivatePaymentMethodsCardPresentCommonWallet type: object x-expandableFields: [] + payment_flows_private_payment_methods_financial_connections_common_linked_account_options_filters: + description: '' + properties: + account_subcategories: + description: >- + The account subcategories to use to filter for possible accounts to + link. Valid subcategories are `checking` and `savings`. + items: + enum: + - checking + - savings + type: string + type: array + title: >- + PaymentFlowsPrivatePaymentMethodsFinancialConnectionsCommonLinkedAccountOptionsFilters + type: object + x-expandableFields: [] payment_flows_private_payment_methods_kakao_pay_payment_method_options: description: '' properties: @@ -25483,6 +28790,29 @@ components: title: PaymentFlowsPrivatePaymentMethodsKlarnaDOB type: object x-expandableFields: [] + payment_flows_private_payment_methods_klarna_payment_intent_amount_details_line_item_payment_method_options: + description: '' + properties: + image_url: + maxLength: 2048 + nullable: true + type: string + product_url: + maxLength: 2048 + nullable: true + type: string + reference: + maxLength: 255 + nullable: true + type: string + subscription_reference: + maxLength: 2048 + nullable: true + type: string + title: >- + PaymentFlowsPrivatePaymentMethodsKlarnaPaymentIntentAmountDetailsLineItemPaymentMethodOptions + type: object + x-expandableFields: [] payment_flows_private_payment_methods_naver_pay_payment_method_options: description: '' properties: @@ -25493,6 +28823,34 @@ components: 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: PaymentFlowsPrivatePaymentMethodsNaverPayPaymentMethodOptions type: object x-expandableFields: [] @@ -25509,6 +28867,31 @@ components: title: PaymentFlowsPrivatePaymentMethodsPaycoPaymentMethodOptions type: object x-expandableFields: [] + payment_flows_private_payment_methods_paypal_amount_details_line_item_payment_method_options: + description: '' + properties: + category: + description: Type of the line item. + enum: + - digital_goods + - donation + - physical_goods + type: string + description: + description: Description of the line item. + maxLength: 5000 + type: string + sold_by: + description: >- + The Stripe account ID of the connected account that sells the item. + This is only needed when using [Separate Charges and + Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers). + maxLength: 5000 + type: string + title: >- + PaymentFlowsPrivatePaymentMethodsPaypalAmountDetailsLineItemPaymentMethodOptions + type: object + x-expandableFields: [] payment_flows_private_payment_methods_samsung_pay_payment_method_options: description: '' properties: @@ -25522,23 +28905,6 @@ components: title: PaymentFlowsPrivatePaymentMethodsSamsungPayPaymentMethodOptions type: object x-expandableFields: [] - payment_flows_private_payment_methods_us_bank_account_linked_account_options_filters: - description: '' - properties: - account_subcategories: - description: >- - The account subcategories to use to filter for possible accounts to - link. Valid subcategories are `checking` and `savings`. - items: - enum: - - checking - - savings - type: string - type: array - title: >- - PaymentFlowsPrivatePaymentMethodsUsBankAccountLinkedAccountOptionsFilters - type: object - x-expandableFields: [] payment_intent: description: >- A PaymentIntent guides you through the process of collecting a payment @@ -25554,8 +28920,7 @@ components: A PaymentIntent transitions through - [multiple - statuses](https://stripe.com/docs/payments/intents#intent-statuses) + [multiple statuses](/payments/paymentintents/lifecycle) throughout its lifetime as it interfaces with Stripe.js to perform @@ -25564,16 +28929,16 @@ components: Related guide: [Payment Intents - API](https://stripe.com/docs/payments/payment-intents) + API](https://docs.stripe.com/payments/payment-intents) properties: amount: description: >- Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge - currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). + currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer @@ -25602,9 +28967,9 @@ components: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be - capped at the total payment amount. For more information, see the + capped at the total amount captured. For more information, see the PaymentIntents [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). nullable: true type: integer automatic_payment_methods: @@ -25628,11 +28993,12 @@ components: Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, - or `automatic`). + `automatic`, or `expired`). enum: - abandoned - automatic - duplicate + - expired - failed_invoice - fraudulent - requested_by_customer @@ -25661,7 +29027,7 @@ components: Refer to our docs to [accept a - payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) + payment](https://docs.stripe.com/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. maxLength: 5000 nullable: true @@ -25703,7 +29069,7 @@ components: If - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any required actions @@ -25717,6 +29083,29 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + ID of the Account representing the customer that this PaymentIntent + belongs to, if one exists. + + + Payment methods attached to other Accounts cannot be used with this + PaymentIntent. + + + If + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) + is set and this PaymentIntent's payment method is not + `card_present`, then the payment method attaches to the Account + after the PaymentIntent has been confirmed and any required actions + from the user are complete. If the payment method is `card_present` + and isn't a digital wallet, then a + [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached to the + Account instead. + maxLength: 5000 + nullable: true + type: string description: description: >- An arbitrary string attached to the object. Often useful for @@ -25724,20 +29113,71 @@ components: maxLength: 5000 nullable: true type: string + excluded_payment_method_types: + description: >- + The list of payment method types to exclude from use with this + payment. + items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + nullable: true + type: array + hooks: + $ref: '#/components/schemas/payment_flows_payment_intent_async_workflows' id: description: Unique identifier for the object. maxLength: 5000 type: string - invoice: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: 'ID of the invoice that created this PaymentIntent, if it exists.' - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' last_payment_error: anyOf: - $ref: '#/components/schemas/api_errors' @@ -25753,7 +29193,7 @@ components: - $ref: '#/components/schemas/charge' description: >- ID of the latest [Charge - object](https://stripe.com/docs/api/charges) created by this + object](https://docs.stripe.com/api/charges) created by this PaymentIntent. This property is `null` until PaymentIntent confirmation is attempted. nullable: true @@ -25770,11 +29210,11 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in - metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). + metadata](https://docs.stripe.com/payments/payment-intents/creating-payment-intents#storing-information-in-metadata). type: object next_action: anyOf: @@ -25797,14 +29237,17 @@ components: type: string - $ref: '#/components/schemas/account' description: >- - The account (if any) for which the funds of the PaymentIntent are - intended. See the PaymentIntents [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts) for - details. + You can specify the settlement merchant as the + + connected account using the `on_behalf_of` attribute on the charge. + See the PaymentIntents [use case for connected + accounts](/payments/connected-accounts) for details. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/account' + payment_details: + $ref: '#/components/schemas/payment_flows_payment_details' payment_method: anyOf: - maxLength: 5000 @@ -25821,7 +29264,7 @@ components: #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- Information about the [payment method - configuration](https://stripe.com/docs/api/payment_method_configurations) + configuration](https://docs.stripe.com/api/payment_method_configurations) used for this PaymentIntent. nullable: true payment_method_options: @@ -25832,11 +29275,16 @@ components: payment_method_types: description: >- The list of payment method types (e.g. card) that this PaymentIntent - is allowed to use. + is allowed to use. A comprehensive list of valid payment method + types can be found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string type: array + presentment_details: + $ref: >- + #/components/schemas/payment_flows_payment_intent_presentment_details processing: anyOf: - $ref: '#/components/schemas/payment_intent_processing' @@ -25929,7 +29377,7 @@ components: `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent - [status](https://stripe.com/docs/payments/intents#intent-statuses). + [status](https://docs.stripe.com/payments/intents#intent-statuses). enum: - canceled - processing @@ -25939,32 +29387,28 @@ components: - requires_payment_method - succeeded type: string + x-stripeBypassValidation: true transfer_data: anyOf: - $ref: '#/components/schemas/transfer_data' description: >- The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). nullable: true transfer_group: description: >- A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected - accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). + accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). maxLength: 5000 nullable: true type: string required: - - amount - - capture_method - - confirmation_method - created - - currency - id - livemode - object - - payment_method_types - status title: PaymentIntent type: object @@ -25973,19 +29417,106 @@ components: - application - automatic_payment_methods - customer - - invoice + - hooks - last_payment_error - latest_charge - next_action - on_behalf_of + - payment_details - payment_method - payment_method_configuration_details - payment_method_options + - presentment_details - processing - review - shipping - transfer_data x-resourceId: payment_intent + payment_intent_amount_details_line_item: + description: '' + properties: + discount_amount: + description: >- + The discount applied on this line item represented in the [smallest + currency unit](https://docs.stripe.com/currencies#zero-decimal). An + integer greater than 0. + + + This field is mutually exclusive with the + `amount_details[discount_amount]` field. + nullable: true + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - payment_intent_amount_details_line_item + type: string + payment_method_options: + anyOf: + - $ref: >- + #/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_payment_method_options + description: Payment method-specific information for line items. + nullable: true + product_code: + description: >- + The product code of the line item, such as an SKU. Required for L3 + rates. At most 12 characters long. + maxLength: 5000 + nullable: true + type: string + product_name: + description: >- + The product name of the line item. Required for L3 rates. At most + 1024 characters long. + + + For Cards, this field is truncated to 26 alphanumeric characters + before being sent to the card networks. For PayPal, this field is + truncated to 127 characters. + maxLength: 5000 + type: string + quantity: + description: >- + The quantity of items. Required for L3 rates. An integer greater + than 0. + type: integer + tax: + anyOf: + - $ref: >- + #/components/schemas/payment_flows_amount_details_resource_line_items_list_resource_line_item_resource_tax + description: Contains information about the tax on the item. + nullable: true + unit_cost: + description: >- + The unit cost of the line item represented in the [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal). Required for + L3 rates. An integer greater than or equal to 0. + type: integer + unit_of_measure: + description: >- + A unit of measure for the line item, such as gallons, feet, meters, + etc. Required for L3 rates. At most 12 alphanumeric characters long. + maxLength: 5000 + nullable: true + type: string + required: + - id + - object + - product_name + - quantity + - unit_cost + title: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItem + type: object + x-expandableFields: + - payment_method_options + - tax + x-resourceId: payment_intent_amount_details_line_item payment_intent_card_processing: description: '' properties: @@ -26034,9 +29565,11 @@ components: #/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code type: description: >- - Type of the next action to perform, one of `redirect_to_url`, - `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, - or `verify_with_microdeposits`. + Type of the next action to perform. Refer to the other child + attributes under `next_action` for available values. Examples + include: `redirect_to_url`, `use_stripe_sdk`, + `alipay_handle_redirect`, `oxxo_display_details`, or + `verify_with_microdeposits`. maxLength: 5000 type: string use_stripe_sdk: @@ -26758,6 +30291,11 @@ components: - $ref: '#/components/schemas/payment_method_options_bancontact' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + billie: + anyOf: + - $ref: '#/components/schemas/payment_method_options_billie' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client blik: anyOf: - $ref: '#/components/schemas/payment_intent_payment_method_options_blik' @@ -26783,6 +30321,11 @@ components: - $ref: '#/components/schemas/payment_method_options_cashapp' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + crypto: + anyOf: + - $ref: '#/components/schemas/payment_method_options_crypto' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client customer_balance: anyOf: - $ref: '#/components/schemas/payment_method_options_customer_balance' @@ -26844,6 +30387,11 @@ components: - $ref: '#/components/schemas/payment_intent_payment_method_options_link' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + mb_way: + anyOf: + - $ref: '#/components/schemas/payment_method_options_mb_way' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client mobilepay: anyOf: - $ref: >- @@ -26861,6 +30409,12 @@ components: #/components/schemas/payment_flows_private_payment_methods_naver_pay_payment_method_options - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + nz_bank_account: + anyOf: + - $ref: >- + #/components/schemas/payment_intent_payment_method_options_nz_bank_account + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client oxxo: anyOf: - $ref: '#/components/schemas/payment_method_options_oxxo' @@ -26892,6 +30446,11 @@ components: - $ref: '#/components/schemas/payment_method_options_paypal' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + payto: + anyOf: + - $ref: '#/components/schemas/payment_intent_payment_method_options_payto' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client pix: anyOf: - $ref: '#/components/schemas/payment_method_options_pix' @@ -26913,6 +30472,11 @@ components: #/components/schemas/payment_flows_private_payment_methods_samsung_pay_payment_method_options - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + satispay: + anyOf: + - $ref: '#/components/schemas/payment_method_options_satispay' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client sepa_debit: anyOf: - $ref: >- @@ -26962,11 +30526,13 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - card_present - cashapp + - crypto - customer_balance - eps - fpx @@ -26979,19 +30545,23 @@ components: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -27034,6 +30604,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string verification_method: description: Bank account verification method. enum: @@ -27078,6 +30656,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string title: payment_intent_payment_method_options_au_becs_debit type: object x-expandableFields: [] @@ -27116,6 +30702,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string title: payment_intent_payment_method_options_bacs_debit type: object x-expandableFields: @@ -27164,15 +30758,16 @@ components: enum: - manual type: string + x-stripeBypassValidation: true installments: anyOf: - $ref: '#/components/schemas/payment_method_options_card_installments' description: >- - Installment details for this payment (Mexico only). + Installment details for this payment. For more information, see the [installments integration - guide](https://stripe.com/docs/payments/installments). + guide](https://docs.stripe.com/payments/installments). nullable: true mandate_options: anyOf: @@ -27206,7 +30801,7 @@ components: description: >- Request ability to [capture beyond the standard authorization validity - window](https://stripe.com/docs/payments/extended-authorization) for + window](https://docs.stripe.com/payments/extended-authorization) for this PaymentIntent. enum: - if_available @@ -27215,7 +30810,7 @@ components: request_incremental_authorization: description: >- Request ability to [increment the - authorization](https://stripe.com/docs/payments/incremental-authorization) + authorization](https://docs.stripe.com/payments/incremental-authorization) for this PaymentIntent. enum: - if_available @@ -27224,7 +30819,7 @@ components: request_multicapture: description: >- Request ability to make [multiple - captures](https://stripe.com/docs/payments/multicapture) for this + captures](https://docs.stripe.com/payments/multicapture) for this PaymentIntent. enum: - if_available @@ -27233,7 +30828,7 @@ components: request_overcapture: description: >- Request ability to - [overcapture](https://stripe.com/docs/payments/overcapture) for this + [overcapture](https://docs.stripe.com/payments/overcapture) for this PaymentIntent. enum: - if_available @@ -27244,11 +30839,11 @@ components: 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). + requirements](https://docs.stripe.com/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) + Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: @@ -27439,6 +31034,75 @@ components: title: payment_intent_payment_method_options_mandate_options_bacs_debit type: object x-expandableFields: [] + payment_intent_payment_method_options_mandate_options_payto: + description: '' + properties: + amount: + description: >- + Amount that will be collected. It is required when `amount_type` is + `fixed`. + nullable: true + type: integer + amount_type: + description: >- + The type of amount that will be collected. The amount charged must + be exact or up to the value of `amount` param for `fixed` or + `maximum` type respectively. Defaults to `maximum`. + enum: + - fixed + - maximum + nullable: true + type: string + end_date: + description: >- + Date, in YYYY-MM-DD format, after which payments will not be + collected. Defaults to no end date. + maxLength: 5000 + nullable: true + type: string + payment_schedule: + description: >- + The periodicity at which payments will be collected. Defaults to + `adhoc`. + enum: + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + nullable: true + type: string + payments_per_period: + description: >- + The number of payments that will be made during a payment period. + Defaults to 1 except for when `payment_schedule` is `adhoc`. In that + case, it defaults to no limit. + nullable: true + type: integer + purpose: + description: >- + The purpose for which payments are made. Has a default value based + on your merchant category code. + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + nullable: true + type: string + title: payment_intent_payment_method_options_mandate_options_payto + type: object + x-expandableFields: [] payment_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: @@ -27493,6 +31157,87 @@ components: title: payment_intent_payment_method_options_mobilepay type: object x-expandableFields: [] + payment_intent_payment_method_options_nz_bank_account: + description: '' + properties: + 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 + - on_session + type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string + title: payment_intent_payment_method_options_nz_bank_account + type: object + x-expandableFields: [] + payment_intent_payment_method_options_payto: + description: '' + properties: + mandate_options: + $ref: >- + #/components/schemas/payment_intent_payment_method_options_mandate_options_payto + 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_intent_payment_method_options_payto + type: object + x-expandableFields: + - mandate_options payment_intent_payment_method_options_sepa_debit: description: '' properties: @@ -27528,6 +31273,14 @@ components: - off_session - on_session type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string title: payment_intent_payment_method_options_sepa_debit type: object x-expandableFields: @@ -27574,128 +31327,141 @@ components: description: '' properties: financial_connections: - $ref: '#/components/schemas/linked_account_options_us_bank_account' + $ref: '#/components/schemas/linked_account_options_common' mandate_options: $ref: >- #/components/schemas/payment_method_options_us_bank_account_mandate_options - preferred_settlement_speed: - description: Preferred transaction settlement speed + 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: - - fastest - - standard + - none + - off_session + - on_session + type: string + target_date: + description: >- + Controls when Stripe will attempt to debit the funds from the + customer's account. The date must be a string in YYYY-MM-DD format. + The date must be in the future and between 3 and 15 calendar days + from now. + maxLength: 5000 + type: string + transaction_purpose: + description: The purpose of the transaction. + enum: + - goods + - other + - services + - unspecified + type: string + verification_method: + description: Bank account verification method. + enum: + - automatic + - instant + - microdeposits + type: string + x-stripeBypassValidation: true + title: payment_intent_payment_method_options_us_bank_account + type: object + x-expandableFields: + - financial_connections + - mandate_options + payment_intent_processing: + description: '' + properties: + card: + $ref: '#/components/schemas/payment_intent_card_processing' + type: + description: >- + Type of the payment method for which payment is in `processing` + state, one of `card`. + enum: + - card type: string - 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 - - on_session - type: string - verification_method: - description: Bank account verification method. - enum: - - automatic - - instant - - microdeposits - type: string - x-stripeBypassValidation: true - title: payment_intent_payment_method_options_us_bank_account - type: object - x-expandableFields: - - financial_connections - - mandate_options - payment_intent_processing: - description: '' - properties: - card: - $ref: '#/components/schemas/payment_intent_card_processing' - type: - description: >- - Type of the payment method for which payment is in `processing` - state, one of `card`. - enum: - - card - type: string - required: - - type - title: PaymentIntentProcessing - type: object - x-expandableFields: - - card - payment_intent_processing_customer_notification: - description: '' - properties: - approval_requested: - description: >- - Whether customer approval has been requested for this payment. For - payments greater than INR 15000 or mandate amount, the customer must - provide explicit approval of the payment with their bank. - nullable: true - type: boolean - completes_at: - description: >- - If customer approval is required, they need to provide approval - before this time. - format: unix-time - nullable: true - type: integer - title: PaymentIntentProcessingCustomerNotification - type: object - x-expandableFields: [] - payment_intent_type_specific_payment_method_options_client: - description: '' - properties: - capture_method: - description: >- - Controls when the funds will be captured from the customer's - account. - enum: - - manual - - manual_preferred - type: string - installments: - $ref: '#/components/schemas/payment_flows_installment_options' - request_incremental_authorization_support: - description: >- - Request ability to - [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) - this PaymentIntent if the combination of MCC and card brand is - eligible. Check - [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) - in the - [Confirm](https://stripe.com/docs/api/payment_intents/confirm) - response to verify support. - type: boolean - require_cvc_recollection: - description: >- - When enabled, using a card that is attached to a customer will - require the CVC to be provided again (i.e. using the cvc_token - parameter). - type: boolean - routing: - $ref: '#/components/schemas/payment_method_options_card_present_routing' + required: + - type + title: PaymentIntentProcessing + type: object + x-expandableFields: + - card + payment_intent_processing_customer_notification: + description: '' + properties: + approval_requested: + description: >- + Whether customer approval has been requested for this payment. For + payments greater than INR 15000 or mandate amount, the customer must + provide explicit approval of the payment with their bank. + nullable: true + type: boolean + completes_at: + description: >- + If customer approval is required, they need to provide approval + before this time. + format: unix-time + nullable: true + type: integer + title: PaymentIntentProcessingCustomerNotification + type: object + x-expandableFields: [] + payment_intent_type_specific_payment_method_options_client: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + - manual_preferred + type: string + installments: + $ref: '#/components/schemas/payment_flows_installment_options' + mandate_options: + $ref: >- + #/components/schemas/payment_intent_payment_method_options_mandate_options_payto + request_incremental_authorization_support: + description: >- + Request ability to + [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) + this PaymentIntent if the combination of MCC and card brand is + eligible. Check + [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + in the + [Confirm](https://docs.stripe.com/api/payment_intents/confirm) + response to verify support. + type: boolean + require_cvc_recollection: + description: >- + When enabled, using a card that is attached to a customer will + require the CVC to be provided again (i.e. using the cvc_token + parameter). + type: boolean + routing: + $ref: '#/components/schemas/payment_method_options_card_present_routing' setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -27737,6 +31503,7 @@ components: type: object x-expandableFields: - installments + - mandate_options - routing payment_link: description: >- @@ -27746,14 +31513,14 @@ components: When a customer opens a payment link it will open a new [checkout - session](https://stripe.com/docs/api/checkout/sessions) to render the + session](https://docs.stripe.com/api/checkout/sessions) to render the payment page. You can use [checkout session - events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) + events](https://docs.stripe.com/api/events/types#event_types-checkout.session.completed) to track payments through payment links. Related guide: [Payment Links - API](https://stripe.com/docs/payment-links) + API](https://docs.stripe.com/payment-links) properties: active: description: >- @@ -27819,7 +31586,8 @@ components: custom_fields: description: >- Collect additional information from your customer using custom - fields. Up to 3 fields are supported. + fields. Up to 3 fields are supported. You can't set this parameter + if `ui_mode` is `custom`. items: $ref: '#/components/schemas/payment_links_resource_custom_fields' type: array @@ -27890,10 +31658,12 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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_collection: + $ref: '#/components/schemas/payment_links_resource_name_collection' object: description: >- String representing the object's type. Objects of the same type @@ -27914,6 +31684,12 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/account' + optional_items: + description: The optional items presented to the customer at checkout. + items: + $ref: '#/components/schemas/payment_links_resource_optional_item' + nullable: true + type: array payment_intent_data: anyOf: - $ref: '#/components/schemas/payment_links_resource_payment_intent_data' @@ -27944,6 +31720,7 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card @@ -27956,6 +31733,7 @@ components: - klarna - konbini - link + - mb_way - mobilepay - multibanco - oxxo @@ -27963,8 +31741,10 @@ components: - pay_by_bank - paynow - paypal + - payto - pix - promptpay + - satispay - sepa_debit - sofort - swish @@ -28057,7 +31837,9 @@ components: - custom_text - invoice_creation - line_items + - name_collection - on_behalf_of + - optional_items - payment_intent_data - phone_number_collection - restrictions @@ -28112,6 +31894,25 @@ components: type: object x-expandableFields: - liability + payment_links_resource_business_name: + description: '' + properties: + enabled: + description: >- + Indicates whether business name collection is enabled for the + payment link. + type: boolean + optional: + description: >- + Whether the customer is required to complete the field before + checking out. Defaults to `false`. + type: boolean + required: + - enabled + - optional + title: PaymentLinksResourceBusinessName + type: object + x-expandableFields: [] payment_links_resource_completed_sessions: description: '' properties: @@ -28238,6 +32039,11 @@ components: payment_links_resource_custom_fields_dropdown: description: '' properties: + default_value: + description: The value that pre-fills on the payment page. + maxLength: 5000 + nullable: true + type: string options: description: >- The options available for the customer to select. Up to 200 options @@ -28298,6 +32104,11 @@ components: payment_links_resource_custom_fields_numeric: description: '' properties: + default_value: + description: The value that pre-fills the field on the payment page. + maxLength: 5000 + nullable: true + type: string maximum_length: description: The maximum character length constraint for the customer's input. nullable: true @@ -28312,6 +32123,11 @@ components: payment_links_resource_custom_fields_text: description: '' properties: + default_value: + description: The value that pre-fills the field on the payment page. + maxLength: 5000 + nullable: true + type: string maximum_length: description: The maximum character length constraint for the customer's input. nullable: true @@ -28365,7 +32181,7 @@ components: description: '' properties: message: - description: Text may be up to 1200 characters in length. + description: Text can be up to 1200 characters in length. maxLength: 500 type: string required: @@ -28373,6 +32189,25 @@ components: title: PaymentLinksResourceCustomTextPosition type: object x-expandableFields: [] + payment_links_resource_individual_name: + description: '' + properties: + enabled: + description: >- + Indicates whether individual name collection is enabled for the + payment link. + type: boolean + optional: + description: >- + Whether the customer is required to complete the field before + checking out. Defaults to `false`. + type: boolean + required: + - enabled + - optional + title: PaymentLinksResourceIndividualName + type: object + x-expandableFields: [] payment_links_resource_invoice_creation: description: '' properties: @@ -28440,14 +32275,14 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. nullable: true type: object rendering_options: anyOf: - - $ref: '#/components/schemas/invoice_setting_rendering_options' + - $ref: '#/components/schemas/invoice_setting_checkout_rendering_options' description: Options for invoice PDF rendering. nullable: true title: PaymentLinksResourceInvoiceSettings @@ -28457,6 +32292,66 @@ components: - custom_fields - issuer - rendering_options + payment_links_resource_name_collection: + description: '' + properties: + business: + $ref: '#/components/schemas/payment_links_resource_business_name' + individual: + $ref: '#/components/schemas/payment_links_resource_individual_name' + title: PaymentLinksResourceNameCollection + type: object + x-expandableFields: + - business + - individual + payment_links_resource_optional_item: + description: '' + properties: + adjustable_quantity: + anyOf: + - $ref: >- + #/components/schemas/payment_links_resource_optional_item_adjustable_quantity + nullable: true + price: + maxLength: 5000 + type: string + quantity: + type: integer + required: + - price + - quantity + title: PaymentLinksResourceOptionalItem + type: object + x-expandableFields: + - adjustable_quantity + payment_links_resource_optional_item_adjustable_quantity: + description: '' + properties: + enabled: + description: >- + Set to true if the quantity can be adjusted to any non-negative + integer. + type: boolean + maximum: + description: >- + The maximum quantity of this item the customer can purchase. By + default this value is 99. + nullable: true + type: integer + minimum: + description: >- + The minimum quantity of this item the customer must purchase, if + they choose to purchase it. Because this item is optional, the + customer will always be able to remove it from their order, even if + the `minimum` configured here is greater than 0. By default this + value is 0. + nullable: true + type: integer + required: + - enabled + title: PaymentLinksResourceOptionalItemAdjustableQuantity + type: object + x-expandableFields: [] payment_links_resource_payment_intent_data: description: '' properties: @@ -28482,9 +32377,9 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on [Payment - Intents](https://stripe.com/docs/api/payment_intents) generated from + Intents](https://docs.stripe.com/api/payment_intents) generated from this payment link. type: object setup_future_usage: @@ -28517,7 +32412,7 @@ components: description: >- A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected - accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) + accounts](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. maxLength: 5000 nullable: true @@ -28868,9 +32763,9 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on - [Subscriptions](https://stripe.com/docs/api/subscriptions) generated + [Subscriptions](https://docs.stripe.com/api/subscriptions) generated from this payment link. type: object trial_period_days: @@ -28951,16 +32846,16 @@ components: PaymentMethod objects represent your customer's payment instruments. You can use them with - [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to + [PaymentIntents](https://docs.stripe.com/payments/payment-intents) to collect payments or save them to Customer objects to store instrument details for future payments. Related guides: [Payment - Methods](https://stripe.com/docs/payments/payment-methods) and [More + Methods](https://docs.stripe.com/payments/payment-methods) and [More Payment - Scenarios](https://stripe.com/docs/payments/more-payment-scenarios). + Scenarios](https://docs.stripe.com/payments/more-payment-scenarios). properties: acss_debit: $ref: '#/components/schemas/payment_method_acss_debit' @@ -28992,6 +32887,8 @@ components: $ref: '#/components/schemas/payment_method_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_bancontact' + billie: + $ref: '#/components/schemas/payment_method_billie' billing_details: $ref: '#/components/schemas/billing_details' blik: @@ -29010,6 +32907,10 @@ components: Unix epoch. format: unix-time type: integer + crypto: + $ref: '#/components/schemas/payment_method_crypto' + custom: + $ref: '#/components/schemas/payment_method_custom' customer: anyOf: - maxLength: 5000 @@ -29023,6 +32924,10 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + maxLength: 5000 + nullable: true + type: string customer_balance: $ref: '#/components/schemas/payment_method_customer_balance' eps: @@ -29056,12 +32961,14 @@ 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 + mb_way: + $ref: '#/components/schemas/payment_method_mb_way' metadata: additionalProperties: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -29072,6 +32979,8 @@ components: $ref: '#/components/schemas/payment_method_multibanco' naver_pay: $ref: '#/components/schemas/payment_method_naver_pay' + nz_bank_account: + $ref: '#/components/schemas/payment_method_nz_bank_account' object: description: >- String representing the object's type. Objects of the same type @@ -29091,6 +33000,8 @@ components: $ref: '#/components/schemas/payment_method_paynow' paypal: $ref: '#/components/schemas/payment_method_paypal' + payto: + $ref: '#/components/schemas/payment_method_payto' pix: $ref: '#/components/schemas/payment_method_pix' promptpay: @@ -29101,6 +33012,8 @@ components: $ref: '#/components/schemas/payment_method_revolut_pay' samsung_pay: $ref: '#/components/schemas/payment_method_samsung_pay' + satispay: + $ref: '#/components/schemas/payment_method_satispay' sepa_debit: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: @@ -29124,11 +33037,14 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - card_present - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -29141,19 +33057,23 @@ components: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -29188,12 +33108,15 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - billing_details - blik - boleto - card - card_present - cashapp + - crypto + - custom - customer - customer_balance - eps @@ -29207,20 +33130,24 @@ components: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - radar_options - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -29340,6 +33267,12 @@ components: title: payment_method_bancontact type: object x-expandableFields: [] + payment_method_billie: + description: '' + properties: {} + title: payment_method_billie + type: object + x-expandableFields: [] payment_method_blik: description: '' properties: {} @@ -29363,8 +33296,9 @@ components: properties: brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 type: string checks: @@ -29533,8 +33467,9 @@ components: properties: brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 nullable: true type: string @@ -29623,8 +33558,9 @@ components: nullable: true preferred_locales: description: >- - EMV tag 5F2D. Preferred languages specified by the integrated - circuit chip. + The languages that the issuing bank recommends using for localizing + any customer-facing text, as read from the card. Referenced from EMV + tag 5F2D, data encoded on the card's chip. items: maxLength: 5000 type: string @@ -29656,7 +33592,9 @@ components: description: '' properties: available: - description: All available networks for the card. + description: >- + All networks available for selection via + [payment_method_options.card.network](/api/payment_intents/confirm#confirm_payment_intent-payment_method_options-card-network). items: maxLength: 5000 type: string @@ -29925,7 +33863,7 @@ components: There are two types of PaymentMethodConfigurations. Which is used - depends on the [charge type](https://stripe.com/docs/connect/charges): + depends on the [charge type](https://docs.stripe.com/connect/charges): **Direct** configurations apply to payments created on your account, @@ -29950,13 +33888,13 @@ components: Related guides: - [Payment Method Configurations - API](https://stripe.com/docs/connect/payment-method-configurations) + API](https://docs.stripe.com/connect/payment-method-configurations) - [Multiple configurations on dynamic payment - methods](https://stripe.com/docs/payments/multiple-payment-method-configs) + methods](https://docs.stripe.com/payments/multiple-payment-method-configs) - [Multiple configurations for your Connect - accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations) + accounts](https://docs.stripe.com/connect/multiple-payment-method-configurations) properties: acss_debit: $ref: >- @@ -29998,6 +33936,9 @@ components: bancontact: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + billie: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties blik: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -30013,6 +33954,9 @@ components: cashapp: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + crypto: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties customer_balance: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -30046,12 +33990,18 @@ components: jcb: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + kakao_pay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties klarna: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties konbini: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + kr_card: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties link: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -30060,6 +34010,9 @@ 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 + mb_way: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties mobilepay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -30070,6 +34023,12 @@ components: description: The configuration's name. maxLength: 5000 type: string + naver_pay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + nz_bank_account: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties object: description: >- String representing the object's type. Objects of the same type @@ -30091,18 +34050,33 @@ components: pay_by_bank: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + payco: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties paynow: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties paypal: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + payto: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + pix: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties promptpay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties revolut_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + samsung_pay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties + satispay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties sepa_debit: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -30144,11 +34118,13 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - cartes_bancaires - cashapp + - crypto - customer_balance - eps - fpx @@ -30157,18 +34133,28 @@ components: - grabpay - ideal - jcb + - kakao_pay - klarna - konbini + - kr_card - link + - mb_way - mobilepay - multibanco + - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank + - payco - paynow - paypal + - payto + - pix - promptpay - revolut_pay + - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -30177,6 +34163,37 @@ components: - wechat_pay - zip x-resourceId: payment_method_configuration + payment_method_crypto: + description: '' + properties: {} + title: payment_method_crypto + type: object + x-expandableFields: [] + payment_method_custom: + description: '' + properties: + display_name: + description: Display name of the Dashboard-only CustomPaymentMethodType. + maxLength: 5000 + nullable: true + type: string + logo: + anyOf: + - $ref: '#/components/schemas/custom_logo' + description: >- + Contains information about the Dashboard-only + CustomPaymentMethodType logo. + nullable: true + type: + description: ID of the Dashboard-only CustomPaymentMethodType. Not expandable. + maxLength: 5000 + type: string + required: + - type + title: payment_method_custom + type: object + x-expandableFields: + - logo payment_method_customer_balance: description: '' properties: {} @@ -30209,6 +34226,8 @@ components: $ref: '#/components/schemas/payment_method_details_bacs_debit' bancontact: $ref: '#/components/schemas/payment_method_details_bancontact' + billie: + $ref: '#/components/schemas/payment_method_details_billie' blik: $ref: '#/components/schemas/payment_method_details_blik' boleto: @@ -30219,6 +34238,8 @@ components: $ref: '#/components/schemas/payment_method_details_card_present' cashapp: $ref: '#/components/schemas/payment_method_details_cashapp' + crypto: + $ref: '#/components/schemas/payment_method_details_crypto' customer_balance: $ref: '#/components/schemas/payment_method_details_customer_balance' eps: @@ -30243,12 +34264,16 @@ components: $ref: '#/components/schemas/payment_method_details_kr_card' link: $ref: '#/components/schemas/payment_method_details_link' + mb_way: + $ref: '#/components/schemas/payment_method_details_mb_way' 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' + nz_bank_account: + $ref: '#/components/schemas/payment_method_details_nz_bank_account' oxxo: $ref: '#/components/schemas/payment_method_details_oxxo' p24: @@ -30261,6 +34286,8 @@ components: $ref: '#/components/schemas/payment_method_details_paynow' paypal: $ref: '#/components/schemas/payment_method_details_paypal' + payto: + $ref: '#/components/schemas/payment_method_details_payto' pix: $ref: '#/components/schemas/payment_method_details_pix' promptpay: @@ -30269,6 +34296,8 @@ components: $ref: '#/components/schemas/payment_method_details_revolut_pay' samsung_pay: $ref: '#/components/schemas/payment_method_details_samsung_pay' + satispay: + $ref: '#/components/schemas/payment_method_details_satispay' sepa_debit: $ref: '#/components/schemas/payment_method_details_sepa_debit' sofort: @@ -30282,10 +34311,9 @@ components: type: description: >- The type of transaction-specific details of the payment method used - in the payment, one of `ach_credit_transfer`, `ach_debit`, - `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, - `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, - `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. + in the payment. See + [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) + for the full list of possible types. An additional hash is included on `payment_method_details` with a name matching this value. @@ -30317,11 +34345,13 @@ components: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - card_present - cashapp + - crypto - customer_balance - eps - fpx @@ -30334,19 +34364,23 @@ components: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - stripe_account @@ -30434,6 +34468,12 @@ components: maxLength: 5000 nullable: true type: string + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this @@ -30466,6 +34506,18 @@ components: payment_method_details_affirm: description: '' properties: + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string transaction_id: description: The Affirm transaction ID associated with this payment. maxLength: 5000 @@ -30492,16 +34544,29 @@ components: x-expandableFields: [] payment_method_details_alma: description: '' - properties: {} + properties: + installments: + $ref: '#/components/schemas/alma_installments' + transaction_id: + description: The Alma transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_alma type: object - x-expandableFields: [] + x-expandableFields: + - installments payment_method_details_amazon_pay: description: '' properties: funding: $ref: >- #/components/schemas/amazon_pay_underlying_payment_method_funding_details + transaction_id: + description: The Amazon Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_amazon_pay type: object x-expandableFields: @@ -30514,6 +34579,12 @@ components: maxLength: 5000 nullable: true type: string + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this @@ -30536,6 +34607,12 @@ components: payment_method_details_bacs_debit: description: '' properties: + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this @@ -30636,6 +34713,17 @@ components: x-expandableFields: - generated_sepa_debit - generated_sepa_debit_mandate + payment_method_details_billie: + description: '' + properties: + transaction_id: + description: The Billie transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_billie + type: object + x-expandableFields: [] payment_method_details_blik: description: '' properties: @@ -30675,8 +34763,9 @@ components: type: string brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 nullable: true type: string @@ -30740,11 +34829,11 @@ components: anyOf: - $ref: '#/components/schemas/payment_method_details_card_installments' description: >- - Installment details for this payment (Mexico only). + Installment details for this payment. For more information, see the [installments integration - guide](https://stripe.com/docs/payments/installments). + guide](https://docs.stripe.com/payments/installments). nullable: true last4: description: The last four digits of the card. @@ -30779,12 +34868,9 @@ components: 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. + ID, and American Express calls this the Acquirer Reference Data. + This value will be present if it is returned by the financial + network in the authorization response, and null otherwise. maxLength: 5000 nullable: true type: string @@ -30885,11 +34971,14 @@ components: nullable: true type: string type: - description: 'Type of installment plan, one of `fixed_count`.' + description: >- + Type of installment plan, one of `fixed_count`, `bonus`, or + `revolving`. enum: + - bonus - fixed_count + - revolving type: string - x-stripeBypassValidation: true required: - type title: payment_method_details_card_installments_plan @@ -30917,8 +35006,9 @@ components: type: integer brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 nullable: true type: string @@ -31006,9 +35096,9 @@ components: incremental_authorization_supported: description: >- Whether this - [PaymentIntent](https://stripe.com/docs/api/payment_intents) is + [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using - [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). + [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support). type: boolean issuer: description: The name of the card's issuing bank. @@ -31020,6 +35110,12 @@ components: maxLength: 5000 nullable: true type: string + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string network: description: >- Identifies which network this charge was processed on. Can be @@ -31033,12 +35129,9 @@ components: 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. + ID, and American Express calls this the Acquirer Reference Data. + This value will be present if it is returned by the financial + network in the authorization response, and null otherwise. maxLength: 5000 nullable: true type: string @@ -31052,8 +35145,9 @@ components: type: boolean preferred_locales: description: >- - EMV tag 5F2D. Preferred languages specified by the integrated - circuit chip. + The languages that the issuing bank recommends using for localizing + any customer-facing text, as read from the card. Referenced from EMV + tag 5F2D, data encoded on the card's chip. items: maxLength: 5000 type: string @@ -31069,6 +35163,12 @@ components: - magnetic_stripe_track2 nullable: true type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string receipt: anyOf: - $ref: '#/components/schemas/payment_method_details_card_present_receipt' @@ -31122,12 +35222,17 @@ components: type: string x-stripeBypassValidation: true application_cryptogram: - description: 'EMV tag 9F26, cryptogram generated by the integrated circuit chip.' + description: >- + The Application Cryptogram, a unique value generated by the card to + authenticate the transaction with issuers. maxLength: 5000 nullable: true type: string application_preferred_name: - description: Mnenomic of the Application Identifier. + description: >- + The Application Identifier (AID) on the card used to determine which + networks are eligible to process the transaction. Referenced from + EMV tag 9F12, data encoded on the card's chip. maxLength: 5000 nullable: true type: string @@ -31152,22 +35257,25 @@ components: type: string dedicated_file_name: description: >- - EMV tag 84. Similar to the application identifier stored on the - integrated circuit chip. + Similar to the application_preferred_name, identifying the + applications (AIDs) available on the card. Referenced from EMV tag + 84. maxLength: 5000 nullable: true type: string terminal_verification_results: description: >- - The outcome of a series of EMV functions performed by the card - reader. + A 5-byte string that records the checks and validations that occur + between the card and the terminal. These checks determine how the + terminal processes the transaction and what risk tolerance is + acceptable. Referenced from EMV Tag 95. maxLength: 5000 nullable: true type: string transaction_status_information: description: >- - An indication of various EMV functions performed during the - transaction. + An indication of which steps were completed during the card read + process. Referenced from EMV Tag 9B. maxLength: 5000 nullable: true type: string @@ -31353,9 +35461,44 @@ components: maxLength: 5000 nullable: true type: string + transaction_id: + description: A unique and immutable identifier of payments assigned by Cash App + maxLength: 5000 + nullable: true + type: string title: payment_method_details_cashapp type: object x-expandableFields: [] + payment_method_details_crypto: + description: '' + properties: + buyer_address: + description: The wallet address of the customer. + maxLength: 5000 + type: string + network: + description: The blockchain network that the transaction was sent on. + enum: + - base + - ethereum + - polygon + - solana + type: string + token_currency: + description: The token currency that the transaction was sent with. + enum: + - usdc + - usdg + - usdp + type: string + x-stripeBypassValidation: true + transaction_hash: + description: The blockchain transaction hash of the crypto payment. + maxLength: 5000 + type: string + title: payment_method_details_crypto + type: object + x-expandableFields: [] payment_method_details_customer_balance: description: '' properties: {} @@ -31525,17 +35668,21 @@ components: properties: bank: description: >- - The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, - `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, - `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, - or `yoursafe`. + The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, + `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, + `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, + `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -31552,13 +35699,17 @@ components: description: The Bank Identifier Code of the customer's bank. enum: - ABNANL2A + - ADYBNL2A - ASNBNL21 - BITSNL2A - BUNQNL2A + - BUUTNL2A + - FNOMNL22 - FVLBNL22 - HANDNL2A - INGBNL2A - KNABNL2H + - MLLENL2A - MOYONL21 - NNBANL2G - NTSBDEB1 @@ -31599,6 +35750,11 @@ components: maxLength: 5000 nullable: true type: string + transaction_id: + description: Unique transaction ID generated by iDEAL. + maxLength: 5000 + nullable: true + type: string verified_name: description: >- Owner's verified full name. Values are verified or provided by iDEAL @@ -31700,6 +35856,12 @@ components: maxLength: 5000 nullable: true type: string + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string network: description: >- Identifies which network this charge was processed on. Can be @@ -31713,19 +35875,17 @@ components: 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. + ID, and American Express calls this the Acquirer Reference Data. + This value will be present if it is returned by the financial + network in the authorization response, and null otherwise. maxLength: 5000 nullable: true type: string preferred_locales: description: >- - EMV tag 5F2D. Preferred languages specified by the integrated - circuit chip. + The languages that the issuing bank recommends using for localizing + any customer-facing text, as read from the card. Referenced from EMV + tag 5F2D, data encoded on the card's chip. items: maxLength: 5000 type: string @@ -31741,6 +35901,12 @@ components: - magnetic_stripe_track2 nullable: true type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string receipt: anyOf: - $ref: >- @@ -31768,12 +35934,17 @@ components: type: string x-stripeBypassValidation: true application_cryptogram: - description: 'EMV tag 9F26, cryptogram generated by the integrated circuit chip.' + description: >- + The Application Cryptogram, a unique value generated by the card to + authenticate the transaction with issuers. maxLength: 5000 nullable: true type: string application_preferred_name: - description: Mnenomic of the Application Identifier. + description: >- + The Application Identifier (AID) on the card used to determine which + networks are eligible to process the transaction. Referenced from + EMV tag 9F12, data encoded on the card's chip. maxLength: 5000 nullable: true type: string @@ -31798,22 +35969,25 @@ components: type: string dedicated_file_name: description: >- - EMV tag 84. Similar to the application identifier stored on the - integrated circuit chip. + Similar to the application_preferred_name, identifying the + applications (AIDs) available on the card. Referenced from EMV tag + 84. maxLength: 5000 nullable: true type: string terminal_verification_results: description: >- - The outcome of a series of EMV functions performed by the card - reader. + A 5-byte string that records the checks and validations that occur + between the card and the terminal. These checks determine how the + terminal processes the transaction and what risk tolerance is + acceptable. Referenced from EMV Tag 95. maxLength: 5000 nullable: true type: string transaction_status_information: description: >- - An indication of various EMV functions performed during the - transaction. + An indication of which steps were completed during the card read + process. Referenced from EMV Tag 9B. maxLength: 5000 nullable: true type: string @@ -31830,6 +36004,11 @@ components: maxLength: 5000 nullable: true type: string + transaction_id: + description: The Kakao Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_kakao_pay type: object x-expandableFields: [] @@ -31897,6 +36076,7 @@ components: - seicomart nullable: true type: string + x-stripeBypassValidation: true title: payment_method_details_konbini_store type: object x-expandableFields: [] @@ -31944,6 +36124,11 @@ components: maxLength: 4 nullable: true type: string + transaction_id: + description: The Korean Card transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_kr_card type: object x-expandableFields: [] @@ -31962,6 +36147,12 @@ components: title: payment_method_details_link type: object x-expandableFields: [] + payment_method_details_mb_way: + description: '' + properties: {} + title: payment_method_details_mb_way + type: object + x-expandableFields: [] payment_method_details_mobilepay: description: '' properties: @@ -32000,9 +36191,60 @@ components: maxLength: 5000 nullable: true type: string + transaction_id: + description: The Naver Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string title: payment_method_details_naver_pay type: object x-expandableFields: [] + payment_method_details_nz_bank_account: + description: '' + properties: + account_holder_name: + description: >- + The name on the bank account. Only present if the account holder + name is different from the name of the authorized signatory + collected in the PaymentMethod’s billing details. + maxLength: 5000 + nullable: true + type: string + bank_code: + description: The numeric code for the bank account's bank. + maxLength: 5000 + type: string + bank_name: + description: The name of the bank. + maxLength: 5000 + type: string + branch_code: + description: The numeric code for the bank account's bank branch. + maxLength: 5000 + type: string + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string + last4: + description: Last four digits of the bank account number. + maxLength: 5000 + type: string + suffix: + description: The suffix of the bank account number. + maxLength: 5000 + nullable: true + type: string + required: + - bank_code + - bank_name + - branch_code + - last4 + title: payment_method_details_nz_bank_account + type: object + x-expandableFields: [] payment_method_details_oxxo: description: '' properties: @@ -32082,8 +36324,9 @@ components: properties: brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 nullable: true type: string @@ -32134,162 +36377,50 @@ components: maxLength: 5000 nullable: true type: string - title: payment_method_details_payco - type: object - x-expandableFields: [] - payment_method_details_paynow: - description: '' - properties: - reference: - description: Reference number associated with this PayNow payment + transaction_id: + description: The Payco transaction ID associated with this payment. maxLength: 5000 nullable: true type: string - title: payment_method_details_paynow + title: payment_method_details_payco type: object x-expandableFields: [] - payment_method_details_paypal: + payment_method_details_payment_record_affirm: description: '' properties: - country: - description: >- - Two-letter ISO code representing the buyer's country. Values are - provided by PayPal directly (if supported) at the time of - authorization or settlement. They cannot be set or mutated. - maxLength: 5000 - nullable: true - type: string - payer_email: - description: >- - Owner's email. Values are provided by PayPal directly - - (if supported) at the time of authorization or settlement. They - cannot be set or mutated. - maxLength: 5000 - nullable: true - type: string - payer_id: - description: >- - PayPal account PayerID. This identifier uniquely identifies the - PayPal customer. + location: + description: ID of the location that this reader is assigned to. maxLength: 5000 - nullable: true type: string - payer_name: - description: >- - Owner's full name. Values provided by PayPal directly - - (if supported) at the time of authorization or settlement. They - cannot be set or mutated. + reader: + description: ID of the reader this transaction was made on. maxLength: 5000 - nullable: true type: string - seller_protection: - anyOf: - - $ref: '#/components/schemas/paypal_seller_protection' - description: >- - The level of protection offered as defined by PayPal Seller - Protection for Merchants, for this transaction. - nullable: true transaction_id: - description: A unique ID generated by PayPal for this transaction. - maxLength: 5000 - nullable: true - type: string - title: payment_method_details_paypal - type: object - x-expandableFields: - - seller_protection - payment_method_details_pix: - description: '' - properties: - bank_transaction_id: - description: Unique transaction id generated by BCB - maxLength: 5000 - nullable: true - type: string - title: payment_method_details_pix - type: object - x-expandableFields: [] - payment_method_details_promptpay: - description: '' - properties: - reference: - description: Bill reference generated by PromptPay - maxLength: 5000 - nullable: true - type: string - title: payment_method_details_promptpay - type: object - x-expandableFields: [] - payment_method_details_revolut_pay: - description: '' - properties: - funding: - $ref: >- - #/components/schemas/revolut_pay_underlying_payment_method_funding_details - title: payment_method_details_revolut_pay - type: object - x-expandableFields: - - funding - payment_method_details_samsung_pay: - description: '' - properties: - buyer_id: - description: >- - A unique identifier for the buyer as determined by the local payment - processor. + description: The Affirm transaction ID associated with this payment. maxLength: 5000 nullable: true type: string - title: payment_method_details_samsung_pay + title: payment_method_details_payment_record_affirm type: object x-expandableFields: [] - payment_method_details_sepa_debit: + payment_method_details_payment_record_afterpay_clearpay: description: '' properties: - bank_code: - description: Bank code of bank associated with the bank account. - maxLength: 5000 - nullable: true - type: string - branch_code: - description: Branch code of bank associated with the bank account. - maxLength: 5000 - nullable: true - type: string - country: - description: >- - Two-letter ISO code representing the country the bank account is - located in. - maxLength: 5000 - nullable: true - type: string - fingerprint: - description: >- - Uniquely identifies this particular bank account. You can use this - attribute to check whether two bank accounts are the same. - maxLength: 5000 - nullable: true - type: string - last4: - description: Last four characters of the IBAN. + order_id: + description: The Afterpay order ID associated with this payment intent. maxLength: 5000 nullable: true type: string - mandate: - description: >- - Find the ID of the mandate used for this payment under the - [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) - property on the Charge. Use this mandate ID to [retrieve the - Mandate](https://stripe.com/docs/api/mandates/retrieve). + reference: + description: Order identifier shown to the merchant in Afterpay's online portal. maxLength: 5000 nullable: true type: string - title: payment_method_details_sepa_debit + title: payment_method_details_payment_record_afterpay_clearpay type: object x-expandableFields: [] - payment_method_details_sofort: + payment_method_details_payment_record_bancontact: description: '' properties: bank_code: @@ -32307,13 +36438,587 @@ components: maxLength: 5000 nullable: true type: string - country: - description: >- - Two-letter ISO code representing the country the bank account is - located in. - maxLength: 5000 - nullable: true - type: string + generated_sepa_debit: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_method' + description: >- + The ID of the SEPA Direct Debit PaymentMethod which was generated by + this Charge. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_method' + generated_sepa_debit_mandate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/mandate' + description: >- + The mandate for the SEPA Direct Debit PaymentMethod which was + generated by this Charge. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/mandate' + iban_last4: + description: Last four characters of the IBAN. + maxLength: 5000 + nullable: true + type: string + preferred_language: + description: >- + Preferred language of the Bancontact authorization page that the + customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` + enum: + - de + - en + - fr + - nl + nullable: true + type: string + verified_name: + description: >- + Owner's verified full name. Values are verified or provided by + Bancontact directly (if supported) at the time of authorization or + settlement. They cannot be set or mutated. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_bancontact + type: object + x-expandableFields: + - generated_sepa_debit + - generated_sepa_debit_mandate + payment_method_details_payment_record_boleto: + description: '' + properties: + tax_id: + description: >- + The tax ID of the customer (CPF for individuals consumers or CNPJ + for businesses consumers) + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_boleto + type: object + x-expandableFields: [] + payment_method_details_payment_record_cashapp: + description: '' + properties: + buyer_id: + description: >- + A unique and immutable identifier assigned by Cash App to every + buyer. + maxLength: 5000 + nullable: true + type: string + cashtag: + description: A public identifier for buyers using Cash App. + maxLength: 5000 + nullable: true + type: string + transaction_id: + description: A unique and immutable identifier of payments assigned by Cash App. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_cashapp + type: object + x-expandableFields: [] + payment_method_details_payment_record_giropay: + description: '' + properties: + bank_code: + description: Bank code of bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + bank_name: + description: Name of the bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + bic: + description: Bank Identifier Code of the bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + verified_name: + description: >- + Owner's verified full name. Values are verified or provided by + Giropay directly (if supported) at the time of authorization or + settlement. They cannot be set or mutated. Giropay rarely provides + this information so the attribute is usually empty. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_giropay + type: object + x-expandableFields: [] + payment_method_details_payment_record_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 + transaction_id: + description: The Kakao Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_kakao_pay + type: object + x-expandableFields: [] + payment_method_details_payment_record_konbini: + description: '' + properties: + store: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store + description: >- + If the payment succeeded, this contains the details of the + convenience store where the payment was completed. + nullable: true + title: payment_method_details_payment_record_konbini + type: object + x-expandableFields: + - store + payment_method_details_payment_record_mb_way: + description: '' + properties: {} + title: payment_method_details_payment_record_mb_way + type: object + x-expandableFields: [] + payment_method_details_payment_record_multibanco: + description: '' + properties: + entity: + description: Entity number associated with this Multibanco payment. + maxLength: 5000 + nullable: true + type: string + reference: + description: Reference number associated with this Multibanco payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_multibanco + type: object + x-expandableFields: [] + payment_method_details_payment_record_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 + transaction_id: + description: The Naver Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_naver_pay + type: object + x-expandableFields: [] + payment_method_details_payment_record_oxxo: + description: '' + properties: + number: + description: OXXO reference number + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_oxxo + type: object + x-expandableFields: [] + payment_method_details_payment_record_paynow: + description: '' + properties: + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string + reference: + description: Reference number associated with this PayNow payment + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_paynow + type: object + x-expandableFields: [] + payment_method_details_payment_record_promptpay: + description: '' + properties: + reference: + description: Bill reference generated by PromptPay + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_promptpay + type: object + x-expandableFields: [] + payment_method_details_payment_record_us_bank_account: + description: '' + properties: + account_holder_type: + description: >- + The type of entity that holds the account. This can be either + 'individual' or 'company'. + enum: + - company + - individual + nullable: true + type: string + account_type: + description: >- + The type of the bank account. This can be either 'checking' or + 'savings'. + enum: + - checking + - savings + nullable: true + type: string + bank_name: + description: Name of the bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string + fingerprint: + description: >- + Uniquely identifies this particular bank account. You can use this + attribute to check whether two bank accounts are the same. + maxLength: 5000 + nullable: true + type: string + last4: + description: Last four digits of the bank account number. + maxLength: 5000 + nullable: true + type: string + mandate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/mandate' + description: ID of the mandate used to make this payment. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/mandate' + payment_reference: + description: The ACH payment reference for this transaction. + maxLength: 5000 + nullable: true + type: string + routing_number: + description: The routing number for the bank account. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_us_bank_account + type: object + x-expandableFields: + - mandate + payment_method_details_payment_record_wechat_pay: + description: '' + properties: + fingerprint: + description: >- + Uniquely identifies this particular WeChat Pay account. You can use + this attribute to check whether two WeChat accounts are the same. + maxLength: 5000 + nullable: true + type: string + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string + transaction_id: + description: Transaction ID of this particular WeChat Pay transaction. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payment_record_wechat_pay + type: object + x-expandableFields: [] + payment_method_details_payment_record_zip: + description: '' + properties: {} + title: payment_method_details_payment_record_zip + type: object + x-expandableFields: [] + payment_method_details_paynow: + description: '' + properties: + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string + reference: + description: Reference number associated with this PayNow payment + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_paynow + type: object + x-expandableFields: [] + payment_method_details_paypal: + description: '' + properties: + country: + description: >- + Two-letter ISO code representing the buyer's country. Values are + provided by PayPal directly (if supported) at the time of + authorization or settlement. They cannot be set or mutated. + maxLength: 5000 + nullable: true + type: string + payer_email: + description: >- + Owner's email. Values are provided by PayPal directly + + (if supported) at the time of authorization or settlement. They + cannot be set or mutated. + maxLength: 5000 + nullable: true + type: string + payer_id: + description: >- + PayPal account PayerID. This identifier uniquely identifies the + PayPal customer. + maxLength: 5000 + nullable: true + type: string + payer_name: + description: >- + Owner's full name. Values provided by PayPal directly + + (if supported) at the time of authorization or settlement. They + cannot be set or mutated. + maxLength: 5000 + nullable: true + type: string + seller_protection: + anyOf: + - $ref: '#/components/schemas/paypal_seller_protection' + description: >- + The level of protection offered as defined by PayPal Seller + Protection for Merchants, for this transaction. + nullable: true + transaction_id: + description: A unique ID generated by PayPal for this transaction. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_paypal + type: object + x-expandableFields: + - seller_protection + payment_method_details_payto: + description: '' + properties: + bsb_number: + description: Bank-State-Branch number of the bank account. + maxLength: 5000 + nullable: true + type: string + last4: + description: Last four digits of the bank account number. + maxLength: 5000 + nullable: true + type: string + mandate: + description: ID of the mandate used to make this payment. + maxLength: 5000 + type: string + pay_id: + description: The PayID alias for the bank account. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_payto + type: object + x-expandableFields: [] + payment_method_details_pix: + description: '' + properties: + bank_transaction_id: + description: Unique transaction id generated by BCB + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_pix + type: object + x-expandableFields: [] + payment_method_details_promptpay: + description: '' + properties: + reference: + description: Bill reference generated by PromptPay + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_promptpay + type: object + x-expandableFields: [] + payment_method_details_revolut_pay: + description: '' + properties: + funding: + $ref: >- + #/components/schemas/revolut_pay_underlying_payment_method_funding_details + transaction_id: + description: The Revolut Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_revolut_pay + type: object + x-expandableFields: + - funding + payment_method_details_samsung_pay: + description: '' + properties: + buyer_id: + description: >- + A unique identifier for the buyer as determined by the local payment + processor. + maxLength: 5000 + nullable: true + type: string + transaction_id: + description: The Samsung Pay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_samsung_pay + type: object + x-expandableFields: [] + payment_method_details_satispay: + description: '' + properties: + transaction_id: + description: The Satispay transaction ID associated with this payment. + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_satispay + type: object + x-expandableFields: [] + payment_method_details_sepa_debit: + description: '' + properties: + bank_code: + description: Bank code of bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + branch_code: + description: Branch code of bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + country: + description: >- + Two-letter ISO code representing the country the bank account is + located in. + maxLength: 5000 + nullable: true + type: string + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string + fingerprint: + description: >- + Uniquely identifies this particular bank account. You can use this + attribute to check whether two bank accounts are the same. + maxLength: 5000 + nullable: true + type: string + last4: + description: Last four characters of the IBAN. + maxLength: 5000 + nullable: true + type: string + mandate: + description: >- + Find the ID of the mandate used for this payment under the + [payment_method_details.sepa_debit.mandate](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) + property on the Charge. Use this mandate ID to [retrieve the + Mandate](https://docs.stripe.com/api/mandates/retrieve). + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_sepa_debit + type: object + x-expandableFields: [] + payment_method_details_sofort: + description: '' + properties: + bank_code: + description: Bank code of bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + bank_name: + description: Name of the bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + bic: + description: Bank Identifier Code of the bank associated with the bank account. + maxLength: 5000 + nullable: true + type: string + country: + description: >- + Two-letter ISO code representing the country the bank account is + located in. + maxLength: 5000 + nullable: true + type: string generated_sepa_debit: anyOf: - maxLength: 5000 @@ -32432,6 +37137,12 @@ components: maxLength: 5000 nullable: true type: string + expected_debit_date: + description: >- + Estimated date to debit the customer's bank account. A date string + in YYYY-MM-DD format. + maxLength: 5000 + type: string fingerprint: description: >- Uniquely identifies this particular bank account. You can use this @@ -32483,6 +37194,18 @@ components: maxLength: 5000 nullable: true type: string + location: + description: >- + ID of the [location](https://docs.stripe.com/api/terminal/locations) + that this transaction's reader is assigned to. + maxLength: 5000 + type: string + reader: + description: >- + ID of the [reader](https://docs.stripe.com/api/terminal/readers) + this transaction was made on. + maxLength: 5000 + type: string transaction_id: description: Transaction ID of this particular WeChat Pay transaction. maxLength: 5000 @@ -32507,7 +37230,7 @@ components: Related guide: [Payment method - domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + domains](https://docs.stripe.com/payments/payment-methods/pmd-registration). properties: amazon_pay: $ref: >- @@ -32538,6 +37261,9 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string + klarna: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status link: $ref: >- #/components/schemas/payment_method_domain_resource_payment_method_status @@ -32564,6 +37290,7 @@ components: - enabled - google_pay - id + - klarna - link - livemode - object @@ -32574,6 +37301,7 @@ components: - amazon_pay - apple_pay - google_pay + - klarna - link - paypal x-resourceId: payment_method_domain @@ -32723,17 +37451,22 @@ components: properties: bank: description: >- - The customer's bank, if provided. Can be one of `abn_amro`, - `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, - `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, - `triodos_bank`, `van_lanschot`, or `yoursafe`. + The customer's bank, if provided. Can be one of `abn_amro`, `adyen`, + `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, + `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, + `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or + `yoursafe`. enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -32752,13 +37485,17 @@ components: provided. enum: - ABNANL2A + - ADYBNL2A - ASNBNL21 - BITSNL2A - BUNQNL2A + - BUUTNL2A + - FNOMNL22 - FVLBNL22 - HANDNL2A - INGBNL2A - KNABNL2H + - MLLENL2A - MOYONL21 - NNBANL2G - NTSBDEB1 @@ -32854,8 +37591,9 @@ components: nullable: true preferred_locales: description: >- - EMV tag 5F2D. Preferred languages specified by the integrated - circuit chip. + The languages that the issuing bank recommends using for localizing + any customer-facing text, as read from the card. Referenced from EMV + tag 5F2D, data encoded on the card's chip. items: maxLength: 5000 type: string @@ -32954,6 +37692,12 @@ components: title: payment_method_link type: object x-expandableFields: [] + payment_method_mb_way: + description: '' + properties: {} + title: payment_method_mb_way + type: object + x-expandableFields: [] payment_method_mobilepay: description: '' properties: {} @@ -32969,6 +37713,13 @@ components: payment_method_naver_pay: description: '' properties: + buyer_id: + description: >- + Uniquely identifies this particular Naver Pay account. You can use + this attribute to check whether two Naver Pay accounts are the same. + maxLength: 5000 + nullable: true + type: string funding: description: Whether to fund this transaction with Naver Pay points or a card. enum: @@ -32981,6 +37732,46 @@ components: title: payment_method_naver_pay type: object x-expandableFields: [] + payment_method_nz_bank_account: + description: '' + properties: + account_holder_name: + description: >- + The name on the bank account. Only present if the account holder + name is different from the name of the authorized signatory + collected in the PaymentMethod’s billing details. + maxLength: 5000 + nullable: true + type: string + bank_code: + description: The numeric code for the bank account's bank. + maxLength: 5000 + type: string + bank_name: + description: The name of the bank. + maxLength: 5000 + type: string + branch_code: + description: The numeric code for the bank account's bank branch. + maxLength: 5000 + type: string + last4: + description: Last four digits of the bank account number. + maxLength: 5000 + type: string + suffix: + description: The suffix of the bank account number. + maxLength: 5000 + nullable: true + type: string + required: + - bank_code + - bank_name + - branch_code + - last4 + title: payment_method_nz_bank_account + type: object + x-expandableFields: [] payment_method_options_affirm: description: '' properties: @@ -33212,6 +38003,19 @@ components: title: payment_method_options_bancontact type: object x-expandableFields: [] + payment_method_options_billie: + 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_billie + type: object + x-expandableFields: [] payment_method_options_boleto: description: '' properties: @@ -33364,22 +38168,30 @@ components: payment_method_options_card_present: description: '' properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + - manual_preferred + type: string request_extended_authorization: description: >- Request ability to capture this payment beyond the standard [authorization validity - window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity) + window](https://docs.stripe.com/terminal/features/extended-authorizations#authorization-validity) nullable: true type: boolean request_incremental_authorization_support: description: >- Request ability to - [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) + [increment](https://docs.stripe.com/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check - [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) + [incremental_authorization_supported](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the - [Confirm](https://stripe.com/docs/api/payment_intents/confirm) + [Confirm](https://docs.stripe.com/api/payment_intents/confirm) response to verify support. nullable: true type: boolean @@ -33444,6 +38256,40 @@ components: title: payment_method_options_cashapp type: object x-expandableFields: [] + payment_method_options_crypto: + description: '' + properties: + 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 + type: string + x-stripeBypassValidation: true + title: payment_method_options_crypto + type: object + x-expandableFields: [] payment_method_options_customer_balance: description: '' properties: @@ -33540,7 +38386,7 @@ components: country: description: >- The desired country code of the bank account information. Permitted - values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + values include: `DE`, `FR`, `IE`, or `NL`. enum: - BE - DE @@ -33736,8 +38582,9 @@ components: [SCA](/strong-customer-authentication). enum: - none + - off_session + - on_session type: string - x-stripeBypassValidation: true title: payment_method_options_klarna type: object x-expandableFields: [] @@ -33844,6 +38691,39 @@ components: title: payment_method_options_kr_card type: object x-expandableFields: [] + payment_method_options_mb_way: + description: '' + properties: + 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 + type: string + title: payment_method_options_mb_way + type: object + x-expandableFields: [] payment_method_options_multibanco: description: '' properties: @@ -34051,6 +38931,12 @@ components: payment_method_options_pix: description: '' properties: + amount_includes_iof: + description: Determines if the amount includes the IOF tax. + enum: + - always + - never + type: string expires_after_seconds: description: >- The number of seconds (between 10 and 1209600) after which Pix @@ -34088,6 +38974,7 @@ components: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_pix type: object x-expandableFields: [] @@ -34165,6 +39052,19 @@ components: title: payment_method_options_revolut_pay type: object x-expandableFields: [] + payment_method_options_satispay: + 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_satispay + type: object + x-expandableFields: [] payment_method_options_sofort: description: '' properties: @@ -34243,6 +39143,7 @@ components: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_twint type: object x-expandableFields: [] @@ -34432,6 +39333,27 @@ components: title: payment_method_paypal type: object x-expandableFields: [] + payment_method_payto: + description: '' + properties: + bsb_number: + description: Bank-State-Branch number of the bank account. + maxLength: 5000 + nullable: true + type: string + last4: + description: Last four digits of the bank account number. + maxLength: 5000 + nullable: true + type: string + pay_id: + description: The PayID alias for the bank account. + maxLength: 5000 + nullable: true + type: string + title: payment_method_payto + type: object + x-expandableFields: [] payment_method_pix: description: '' properties: {} @@ -34456,6 +39378,12 @@ components: title: payment_method_samsung_pay type: object x-expandableFields: [] + payment_method_satispay: + description: '' + properties: {} + title: payment_method_satispay + type: object + x-expandableFields: [] payment_method_sepa_debit: description: '' properties: @@ -34617,6 +39545,7 @@ components: - bank_account_restricted - bank_account_unusable - debit_not_authorized + - tokenized_account_number_deactivated nullable: true type: string title: payment_method_us_bank_account_blocked @@ -34647,7 +39576,9 @@ components: description: '' properties: enabled: - description: Whether Adaptive Pricing is enabled. + description: >- + If enabled, Adaptive Pricing is available on [eligible + sessions](https://docs.stripe.com/payments/currencies/localize-prices/adaptive-pricing?payment-ui=stripe-hosted#restrictions). type: boolean required: - enabled @@ -34720,6 +39651,11 @@ components: from this account. The tax transaction is returned in the report of the connected account. nullable: true + provider: + description: The tax provider powering automatic tax. + maxLength: 5000 + nullable: true + type: string status: description: >- The status of the most recent automated tax calculation for this @@ -34736,6 +39672,176 @@ components: type: object x-expandableFields: - liability + payment_pages_checkout_session_branding_settings: + description: '' + properties: + background_color: + description: >- + A hex color value starting with `#` representing the background + color for the Checkout Session. + maxLength: 5000 + type: string + border_style: + description: >- + The border style for the Checkout Session. Must be one of `rounded`, + `rectangular`, or `pill`. + enum: + - pill + - rectangular + - rounded + type: string + button_color: + description: >- + A hex color value starting with `#` representing the button color + for the Checkout Session. + maxLength: 5000 + type: string + display_name: + description: The display name shown on the Checkout Session. + maxLength: 5000 + type: string + font_family: + description: >- + The font family for the Checkout Session. Must be one of the + [supported font + families](https://docs.stripe.com/payments/checkout/customization/appearance?payment-ui=stripe-hosted#font-compatibility). + maxLength: 5000 + type: string + icon: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_branding_settings_icon + description: >- + The icon for the Checkout Session. You cannot set both `logo` and + `icon`. + nullable: true + logo: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_branding_settings_logo + description: >- + The logo for the Checkout Session. You cannot set both `logo` and + `icon`. + nullable: true + required: + - background_color + - border_style + - button_color + - display_name + - font_family + title: PaymentPagesCheckoutSessionBrandingSettings + type: object + x-expandableFields: + - icon + - logo + payment_pages_checkout_session_branding_settings_icon: + description: '' + properties: + file: + description: >- + The ID of a [File upload](https://stripe.com/docs/api/files) + representing the icon. Purpose must be `business_icon`. Required if + `type` is `file` and disallowed otherwise. + maxLength: 5000 + type: string + type: + description: The type of image for the icon. Must be one of `file` or `url`. + enum: + - file + - url + type: string + url: + description: The URL of the image. Present when `type` is `url`. + maxLength: 5000 + type: string + required: + - type + title: PaymentPagesCheckoutSessionBrandingSettingsIcon + type: object + x-expandableFields: [] + payment_pages_checkout_session_branding_settings_logo: + description: '' + properties: + file: + description: >- + The ID of a [File upload](https://stripe.com/docs/api/files) + representing the logo. Purpose must be `business_logo`. Required if + `type` is `file` and disallowed otherwise. + maxLength: 5000 + type: string + type: + description: The type of image for the logo. Must be one of `file` or `url`. + enum: + - file + - url + type: string + url: + description: The URL of the image. Present when `type` is `url`. + maxLength: 5000 + type: string + required: + - type + title: PaymentPagesCheckoutSessionBrandingSettingsLogo + type: object + x-expandableFields: [] + payment_pages_checkout_session_business_name: + description: '' + properties: + enabled: + description: >- + Indicates whether business name collection is enabled for the + session + type: boolean + optional: + description: >- + Whether the customer is required to complete the field before + completing the Checkout Session. Defaults to `false`. + type: boolean + required: + - enabled + - optional + title: PaymentPagesCheckoutSessionBusinessName + type: object + x-expandableFields: [] + payment_pages_checkout_session_checkout_address_details: + description: '' + properties: + address: + $ref: '#/components/schemas/address' + name: + description: Customer name. + maxLength: 5000 + type: string + required: + - address + - name + title: PaymentPagesCheckoutSessionCheckoutAddressDetails + type: object + x-expandableFields: + - address + payment_pages_checkout_session_collected_information: + description: '' + properties: + business_name: + description: Customer’s business name for this Checkout Session + maxLength: 5000 + nullable: true + type: string + individual_name: + description: Customer’s individual name for this Checkout Session + maxLength: 5000 + nullable: true + type: string + shipping_details: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_checkout_address_details + description: Shipping information for this Checkout Session. + nullable: true + title: PaymentPagesCheckoutSessionCollectedInformation + type: object + x-expandableFields: + - shipping_details payment_pages_checkout_session_consent: description: '' properties: @@ -34882,7 +39988,7 @@ components: description: '' properties: default_value: - description: The value that will pre-fill on the payment page. + description: The value that pre-fills on the payment page. maxLength: 5000 nullable: true type: string @@ -34931,7 +40037,7 @@ components: description: '' properties: default_value: - description: The value that will pre-fill the field on the payment page. + description: The value that pre-fills the field on the payment page. maxLength: 5000 nullable: true type: string @@ -34978,7 +40084,7 @@ components: description: '' properties: default_value: - description: The value that will pre-fill the field on the payment page. + description: The value that pre-fills the field on the payment page. maxLength: 5000 nullable: true type: string @@ -35044,7 +40150,7 @@ components: description: '' properties: message: - description: Text may be up to 1200 characters in length. + description: Text can be up to 1200 characters in length. maxLength: 500 type: string required: @@ -35063,6 +40169,11 @@ components: This property is populated only for sessions on or after March 30, 2022. nullable: true + business_name: + description: The customer's business name after a completed Checkout Session. + maxLength: 150 + nullable: true + type: string email: description: >- The email associated with the Customer, if one exists, on the @@ -35075,6 +40186,11 @@ components: maxLength: 5000 nullable: true type: string + individual_name: + description: The customer's individual name after a completed Checkout Session. + maxLength: 150 + nullable: true + type: string name: description: >- The customer's name after a completed Checkout Session. Note: This @@ -35134,6 +40250,25 @@ components: x-expandableFields: - coupon - promotion_code + payment_pages_checkout_session_individual_name: + description: '' + properties: + enabled: + description: >- + Indicates whether individual name collection is enabled for the + session + type: boolean + optional: + description: >- + Whether the customer is required to complete the field before + completing the Checkout Session. Defaults to `false`. + type: boolean + required: + - enabled + - optional + title: PaymentPagesCheckoutSessionIndividualName + type: object + x-expandableFields: [] payment_pages_checkout_session_invoice_creation: description: '' properties: @@ -35199,14 +40334,14 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. nullable: true type: object rendering_options: anyOf: - - $ref: '#/components/schemas/invoice_setting_rendering_options' + - $ref: '#/components/schemas/invoice_setting_checkout_rendering_options' description: Options for invoice PDF rendering. nullable: true title: PaymentPagesCheckoutSessionInvoiceSettings @@ -35216,6 +40351,66 @@ components: - custom_fields - issuer - rendering_options + payment_pages_checkout_session_name_collection: + description: '' + properties: + business: + $ref: '#/components/schemas/payment_pages_checkout_session_business_name' + individual: + $ref: '#/components/schemas/payment_pages_checkout_session_individual_name' + title: PaymentPagesCheckoutSessionNameCollection + type: object + x-expandableFields: + - business + - individual + payment_pages_checkout_session_optional_item: + description: '' + properties: + adjustable_quantity: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_optional_item_adjustable_quantity + nullable: true + price: + maxLength: 5000 + type: string + quantity: + type: integer + required: + - price + - quantity + title: PaymentPagesCheckoutSessionOptionalItem + type: object + x-expandableFields: + - adjustable_quantity + payment_pages_checkout_session_optional_item_adjustable_quantity: + description: '' + properties: + enabled: + description: >- + Set to true if the quantity can be adjusted to any non-negative + integer. + type: boolean + maximum: + description: >- + The maximum quantity of this item the customer can purchase. By + default this value is 99. You can specify a value up to 999999. + nullable: true + type: integer + minimum: + description: >- + The minimum quantity of this item the customer must purchase, if + they choose to purchase it. Because this item is optional, the + customer will always be able to remove it from their order, even if + the `minimum` configured here is greater than 0. By default this + value is 0. + nullable: true + type: integer + required: + - enabled + title: PaymentPagesCheckoutSessionOptionalItemAdjustableQuantity + type: object + x-expandableFields: [] payment_pages_checkout_session_payment_method_reuse_agreement: description: '' properties: @@ -35237,6 +40432,31 @@ components: title: PaymentPagesCheckoutSessionPaymentMethodReuseAgreement type: object x-expandableFields: [] + payment_pages_checkout_session_permissions: + description: '' + properties: + update_shipping_details: + description: >- + Determines which entity is allowed to update the shipping details. + + + Default is `client_only`. Stripe Checkout client will automatically + update the shipping details. If set to `server_only`, only your + server is allowed to update the shipping details. + + + When set to `server_only`, you must add the onShippingDetailsChange + event handler when initializing the Stripe Checkout client and + manually update the shipping details from your server using the + Stripe API. + enum: + - client_only + - server_only + nullable: true + type: string + title: PaymentPagesCheckoutSessionPermissions + type: object + x-expandableFields: [] payment_pages_checkout_session_phone_number_collection: description: '' properties: @@ -35614,17 +40834,19 @@ components: `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, - `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, - `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, - `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, - `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, - `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, - `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, - `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, - `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, - `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, - `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or + `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, + `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, + `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, + `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, + `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, + `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, + `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, + `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, + `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, + `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, + `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, + `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` enum: - ad_nrt @@ -35635,10 +40857,15 @@ components: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -35654,14 +40881,17 @@ components: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -35678,11 +40908,14 @@ components: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -35700,6 +40933,7 @@ components: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -35801,6 +41035,176 @@ components: x-expandableFields: - discounts - taxes + payment_pages_private_card_payment_method_options_resource_restrictions: + description: '' + properties: + brands_blocked: + description: >- + Specify the card brands to block in the Checkout Session. If a + customer enters or selects a card belonging to a blocked brand, they + can't complete the Session. + items: + enum: + - american_express + - discover_global_network + - mastercard + - visa + type: string + type: array + title: PaymentPagesPrivateCardPaymentMethodOptionsResourceRestrictions + type: object + x-expandableFields: [] + payment_record: + description: >- + A Payment Record is a resource that allows you to represent payments + that occur on- or off-Stripe. + + For example, you can create a Payment Record to model a payment made on + a different payment processor, + + in order to mark an Invoice as paid and a Subscription as active. + Payment Records consist of one or + + more Payment Attempt Records, which represent individual attempts made + on a payment network. + properties: + amount: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_authorized: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_canceled: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_failed: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_guaranteed: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_refunded: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + amount_requested: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_amount + application: + description: ID of the Connect application that created the PaymentRecord. + maxLength: 5000 + nullable: true + type: string + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + customer_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_customer_details + description: Customer information for this payment. + nullable: true + customer_presence: + description: >- + Indicates whether the customer was present in your checkout flow + during this payment. + enum: + - off_session + - on_session + nullable: true + type: string + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + nullable: true + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + latest_payment_attempt_record: + description: >- + ID of the latest Payment Attempt Record attached to this Payment + Record. + maxLength: 5000 + nullable: true + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that + you can attach to an object. This can be useful for storing + additional information about the object in a structured format. + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - payment_record + type: string + payment_method_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_details + description: Information about the Payment Method debited for this payment. + nullable: true + processor_details: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_processor_details + reported_by: + description: Indicates who reported the payment. + enum: + - self + - stripe + type: string + shipping_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_shipping_details + description: Shipping information for this payment. + nullable: true + required: + - amount + - amount_authorized + - amount_canceled + - amount_failed + - amount_guaranteed + - amount_refunded + - amount_requested + - created + - id + - livemode + - metadata + - object + - processor_details + - reported_by + title: PaymentRecord + type: object + x-expandableFields: + - amount + - amount_authorized + - amount_canceled + - amount_failed + - amount_guaranteed + - amount_refunded + - amount_requested + - customer_details + - payment_method_details + - processor_details + - shipping_details + x-resourceId: payment_record payment_source: anyOf: - $ref: '#/components/schemas/account' @@ -35810,6 +41214,836 @@ components: title: Polymorphic x-resourceId: payment_source x-stripeBypassValidation: true + payments_primitives_payment_records_resource_address: + description: A representation of a physical address. + 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, such as the street, PO Box, or company name.' + maxLength: 5000 + nullable: true + type: string + line2: + description: 'Address line 2, such as the 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 ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). + maxLength: 5000 + nullable: true + type: string + title: PaymentsPrimitivesPaymentRecordsResourceAddress + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_amount: + description: >- + A representation of an amount of money, consisting of an amount and a + currency. + properties: + currency: + description: >- + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + format: currency + type: string + value: + description: >- + A positive integer representing the amount in the currency's [minor + unit](https://docs.stripe.com/currencies#zero-decimal). For example, + `100` can represent 1 USD or 100 JPY. + type: integer + required: + - currency + - value + title: PaymentsPrimitivesPaymentRecordsResourceAmount + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_billing_details: + description: Billing details used by the customer for this payment. + properties: + address: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_address + email: + description: The billing email associated with the method of payment. + maxLength: 5000 + nullable: true + type: string + name: + description: The billing name associated with the method of payment. + maxLength: 5000 + nullable: true + type: string + phone: + description: The billing phone number associated with the method of payment. + maxLength: 5000 + nullable: true + type: string + required: + - address + title: PaymentsPrimitivesPaymentRecordsResourceBillingDetails + type: object + x-expandableFields: + - address + payments_primitives_payment_records_resource_customer_details: + description: Information about the customer for this payment. + properties: + customer: + description: ID of the Stripe Customer associated with this payment. + maxLength: 5000 + nullable: true + type: string + email: + description: The customer's email address. + maxLength: 5000 + nullable: true + type: string + name: + description: The customer's name. + maxLength: 5000 + nullable: true + type: string + phone: + description: The customer's phone number. + maxLength: 5000 + nullable: true + type: string + title: PaymentsPrimitivesPaymentRecordsResourceCustomerDetails + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_card_details: + description: Details of the card used for this payment attempt. + properties: + authorization_code: + description: The authorization code of the payment. + maxLength: 5000 + nullable: true + type: string + brand: + description: >- + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. + enum: + - amex + - cartes_bancaires + - diners + - discover + - eftpos_au + - interac + - jcb + - link + - mastercard + - unionpay + - unknown + - visa + type: string + capture_before: + description: >- + When using manual capture, a future timestamp at which the charge + will be automatically refunded if uncaptured. + format: unix-time + type: integer + checks: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_checks + description: >- + Check results by Card networks on Card address and CVC at time of + payment. + nullable: true + country: + description: >- + Two-letter ISO code representing the country of the card. You could + use this attribute to get a sense of the international breakdown of + cards you've collected. + maxLength: 5000 + nullable: true + type: string + description: + description: A high-level description of the type of cards issued in this range. + maxLength: 5000 + nullable: true + type: string + exp_month: + description: Two-digit number representing the card's expiration month. + type: integer + exp_year: + description: Four-digit number representing the card's expiration year. + type: integer + fingerprint: + description: >- + Uniquely identifies this particular card number. You can use this + attribute to check whether two customers who’ve signed up with you + are using the same card number, for example. For payment methods + that tokenize card information (Apple Pay, Google Pay), the + tokenized number might be provided instead of the underlying card + number. + + + *As of May 1, 2021, card fingerprint in India for Connect changed to + allow two fingerprints for the same card---one for India and one for + the rest of the world.* + maxLength: 5000 + nullable: true + type: string + funding: + description: >- + Card funding type. Can be `credit`, `debit`, `prepaid`, or + `unknown`. + enum: + - credit + - debit + - prepaid + - unknown + type: string + iin: + description: Issuer identification number of the card. + maxLength: 5000 + nullable: true + type: string + installments: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_installments + description: Installment details for this payment. + nullable: true + issuer: + description: The name of the card's issuing bank. + maxLength: 5000 + nullable: true + type: string + last4: + description: The last four digits of the card. + maxLength: 5000 + type: string + network: + description: >- + Identifies which network this charge was processed on. Can be + `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, + `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or + `unknown`. + enum: + - amex + - cartes_bancaires + - diners + - discover + - eftpos_au + - interac + - jcb + - link + - mastercard + - unionpay + - unknown + - visa + nullable: true + type: string + network_advice_code: + description: Advice code from the card network for the failed payment. + maxLength: 5000 + nullable: true + type: string + network_decline_code: + description: Decline code from the card network for the failed payment. + maxLength: 5000 + nullable: true + type: string + network_token: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token + description: >- + If this card has network token credentials, this contains the + details of the network token credentials. + nullable: true + network_transaction_id: + description: >- + This is used by the financial networks to identify a transaction. + Visa calls this the Transaction ID, Mastercard calls this the Trace + ID, and American Express calls this the Acquirer Reference Data. + This value will be present if it is returned by the financial + network in the authorization response, and null otherwise. + maxLength: 5000 + nullable: true + type: string + stored_credential_usage: + description: >- + The transaction type that was passed for an off-session, + Merchant-Initiated transaction, one of `recurring` or `unscheduled`. + enum: + - recurring + - unscheduled + nullable: true + type: string + three_d_secure: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure + description: Populated if this transaction used 3D Secure authentication. + nullable: true + wallet: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet + description: >- + If this Card is part of a card wallet, this contains the details of + the card wallet. + nullable: true + required: + - brand + - exp_month + - exp_year + - funding + - last4 + title: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetails + type: object + x-expandableFields: + - checks + - installments + - network_token + - three_d_secure + - wallet + payments_primitives_payment_records_resource_payment_method_card_details_resource_checks: + description: '' + properties: + address_line1_check: + description: >- + If you provide a value for `address.line1`, the check result is one + of `pass`, `fail`, `unavailable`, or `unchecked`. + enum: + - fail + - pass + - unavailable + - unchecked + nullable: true + type: string + address_postal_code_check: + description: >- + If you provide a address postal code, the check result is one of + `pass`, `fail`, `unavailable`, or `unchecked`. + enum: + - fail + - pass + - unavailable + - unchecked + nullable: true + type: string + cvc_check: + description: >- + If you provide a CVC, the check results is one of `pass`, `fail`, + `unavailable`, or `unchecked`. + enum: + - fail + - pass + - unavailable + - unchecked + nullable: true + type: string + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceChecks + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan: + description: '' + properties: + count: + description: >- + For `fixed_count` installment plans, this is the number of + installment payments your customer will make to their credit card. + nullable: true + type: integer + interval: + description: >- + For `fixed_count` installment plans, this is the interval between + installment payments your customer will make to their credit card. + One of `month`. + enum: + - month + nullable: true + type: string + type: + description: >- + Type of installment plan, one of `fixed_count`, `revolving`, or + `bonus`. + enum: + - bonus + - fixed_count + - revolving + type: string + required: + - type + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallmentPlan + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_card_details_resource_installments: + description: '' + properties: + plan: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_installment_plan + description: Installment plan selected for the payment. + nullable: true + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceInstallments + type: object + x-expandableFields: + - plan + payments_primitives_payment_records_resource_payment_method_card_details_resource_network_token: + description: '' + properties: + used: + description: >- + Indicates if Stripe used a network token, either user provided or + Stripe managed when processing the transaction. + type: boolean + required: + - used + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceNetworkToken + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_card_details_resource_three_d_secure: + description: '' + properties: + authentication_flow: + description: >- + For authenticated transactions: Indicates how the issuing bank + authenticated the customer. + enum: + - challenge + - frictionless + nullable: true + type: string + result: + description: Indicates the outcome of 3D Secure authentication. + enum: + - attempt_acknowledged + - authenticated + - exempted + - failed + - not_supported + - processing_error + nullable: true + type: string + result_reason: + description: >- + Additional information about why 3D Secure succeeded or failed, + based on the `result`. + enum: + - abandoned + - bypassed + - canceled + - card_not_enrolled + - network_not_supported + - protocol_error + - rejected + nullable: true + type: string + version: + description: The version of 3D Secure that was used. + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + nullable: true + type: string + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceThreeDSecure + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet: + description: '' + properties: + apple_pay: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay + dynamic_last4: + description: >- + (For tokenized numbers only.) The last four digits of the device + account number. + maxLength: 5000 + type: string + google_pay: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay + type: + description: >- + The type of the card wallet, one of `apple_pay` or `google_pay`. An + additional hash is included on the Wallet subhash with a name + matching this value. It contains additional information specific to + the card wallet type. + maxLength: 5000 + type: string + required: + - type + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWallet + type: object + x-expandableFields: + - apple_pay + - google_pay + payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_apple_pay: + description: '' + properties: + type: + description: >- + Type of the apple_pay transaction, one of `apple_pay` or + `apple_pay_later`. + maxLength: 5000 + type: string + required: + - type + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceApplePay + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_card_details_resource_wallet_resource_google_pay: + description: '' + properties: {} + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCardDetailsResourceWalletResourceGooglePay + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_custom_details: + description: >- + Custom Payment Methods represent Payment Method types not modeled + directly in + + the Stripe API. This resource consists of details about the custom + payment method + + used for this payment attempt. + properties: + display_name: + description: >- + Display name for the custom (user-defined) payment method type used + to make this payment. + maxLength: 5000 + type: string + type: + description: The custom payment method type associated with this payment. + maxLength: 5000 + nullable: true + type: string + required: + - display_name + title: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodCustomDetails + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_payment_method_details: + description: Details about the Payment Method used in this payment attempt. + properties: + ach_credit_transfer: + $ref: '#/components/schemas/payment_method_details_ach_credit_transfer' + ach_debit: + $ref: '#/components/schemas/payment_method_details_ach_debit' + acss_debit: + $ref: '#/components/schemas/payment_method_details_acss_debit' + affirm: + $ref: '#/components/schemas/payment_method_details_payment_record_affirm' + afterpay_clearpay: + $ref: >- + #/components/schemas/payment_method_details_payment_record_afterpay_clearpay + alipay: + $ref: >- + #/components/schemas/payment_flows_private_payment_methods_alipay_details + alma: + $ref: '#/components/schemas/payment_method_details_alma' + amazon_pay: + $ref: '#/components/schemas/payment_method_details_amazon_pay' + au_becs_debit: + $ref: '#/components/schemas/payment_method_details_au_becs_debit' + bacs_debit: + $ref: '#/components/schemas/payment_method_details_bacs_debit' + bancontact: + $ref: >- + #/components/schemas/payment_method_details_payment_record_bancontact + billie: + $ref: '#/components/schemas/payment_method_details_billie' + billing_details: + anyOf: + - $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_billing_details + description: The billing details associated with the method of payment. + nullable: true + blik: + $ref: '#/components/schemas/payment_method_details_blik' + boleto: + $ref: '#/components/schemas/payment_method_details_payment_record_boleto' + card: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_card_details + card_present: + $ref: '#/components/schemas/payment_method_details_card_present' + cashapp: + $ref: '#/components/schemas/payment_method_details_payment_record_cashapp' + crypto: + $ref: '#/components/schemas/payment_method_details_crypto' + custom: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_payment_method_custom_details + customer_balance: + $ref: '#/components/schemas/payment_method_details_customer_balance' + eps: + $ref: '#/components/schemas/payment_method_details_eps' + fpx: + $ref: '#/components/schemas/payment_method_details_fpx' + giropay: + $ref: '#/components/schemas/payment_method_details_payment_record_giropay' + grabpay: + $ref: '#/components/schemas/payment_method_details_grabpay' + ideal: + $ref: '#/components/schemas/payment_method_details_ideal' + interac_present: + $ref: '#/components/schemas/payment_method_details_interac_present' + kakao_pay: + $ref: '#/components/schemas/payment_method_details_payment_record_kakao_pay' + klarna: + $ref: '#/components/schemas/payment_method_details_klarna' + konbini: + $ref: '#/components/schemas/payment_method_details_payment_record_konbini' + kr_card: + $ref: '#/components/schemas/payment_method_details_kr_card' + link: + $ref: '#/components/schemas/payment_method_details_link' + mb_way: + $ref: '#/components/schemas/payment_method_details_payment_record_mb_way' + mobilepay: + $ref: '#/components/schemas/payment_method_details_mobilepay' + multibanco: + $ref: >- + #/components/schemas/payment_method_details_payment_record_multibanco + naver_pay: + $ref: '#/components/schemas/payment_method_details_payment_record_naver_pay' + nz_bank_account: + $ref: '#/components/schemas/payment_method_details_nz_bank_account' + oxxo: + $ref: '#/components/schemas/payment_method_details_payment_record_oxxo' + p24: + $ref: '#/components/schemas/payment_method_details_p24' + pay_by_bank: + $ref: '#/components/schemas/payment_method_details_pay_by_bank' + payco: + $ref: '#/components/schemas/payment_method_details_payco' + payment_method: + description: ID of the Stripe PaymentMethod used to make this payment. + maxLength: 5000 + nullable: true + type: string + paynow: + $ref: '#/components/schemas/payment_method_details_payment_record_paynow' + paypal: + $ref: '#/components/schemas/payment_method_details_paypal' + payto: + $ref: '#/components/schemas/payment_method_details_payto' + pix: + $ref: '#/components/schemas/payment_method_details_pix' + promptpay: + $ref: '#/components/schemas/payment_method_details_payment_record_promptpay' + revolut_pay: + $ref: '#/components/schemas/payment_method_details_revolut_pay' + samsung_pay: + $ref: '#/components/schemas/payment_method_details_samsung_pay' + satispay: + $ref: '#/components/schemas/payment_method_details_satispay' + sepa_debit: + $ref: '#/components/schemas/payment_method_details_sepa_debit' + sofort: + $ref: '#/components/schemas/payment_method_details_sofort' + stripe_account: + $ref: '#/components/schemas/payment_method_details_stripe_account' + swish: + $ref: '#/components/schemas/payment_method_details_swish' + twint: + $ref: '#/components/schemas/payment_method_details_twint' + type: + description: >- + The type of transaction-specific details of the payment method used + in the payment. See + [PaymentMethod.type](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type) + for the full list of possible types. + + An additional hash is included on `payment_method_details` with a + name matching this value. + + It contains information specific to the payment method. + maxLength: 5000 + type: string + us_bank_account: + $ref: >- + #/components/schemas/payment_method_details_payment_record_us_bank_account + wechat: + $ref: '#/components/schemas/payment_method_details_wechat' + wechat_pay: + $ref: >- + #/components/schemas/payment_method_details_payment_record_wechat_pay + zip: + $ref: '#/components/schemas/payment_method_details_payment_record_zip' + required: + - type + title: PaymentsPrimitivesPaymentRecordsResourcePaymentMethodDetails + type: object + x-expandableFields: + - ach_credit_transfer + - ach_debit + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - billing_details + - blik + - boleto + - card + - card_present + - cashapp + - crypto + - custom + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - interac_present + - kakao_pay + - klarna + - konbini + - kr_card + - link + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - stripe_account + - swish + - twint + - us_bank_account + - wechat + - wechat_pay + - zip + payments_primitives_payment_records_resource_payment_method_konbini_details_resource_store: + description: '' + properties: + chain: + description: >- + The name of the convenience store chain where the payment was + completed. + enum: + - familymart + - lawson + - ministop + - seicomart + nullable: true + type: string + x-stripeBypassValidation: true + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentMethodKonbiniDetailsResourceStore + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_processor_details: + description: Processor information associated with this payment. + properties: + custom: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_processor_details_resource_custom_details + type: + description: The processor used for this payment attempt. + enum: + - custom + type: string + x-stripeBypassValidation: true + required: + - type + title: PaymentsPrimitivesPaymentRecordsResourceProcessorDetails + type: object + x-expandableFields: + - custom + payments_primitives_payment_records_resource_processor_details_resource_custom_details: + description: >- + Custom processors represent payment processors not modeled directly in + + the Stripe API. This resource consists of details about the custom + processor + + used for this payment attempt. + properties: + payment_reference: + description: >- + An opaque string for manual reconciliation of this payment, for + example a check number or a payment processor ID. + maxLength: 5000 + nullable: true + type: string + title: >- + PaymentsPrimitivesPaymentRecordsResourceProcessorDetailsResourceCustomDetails + type: object + x-expandableFields: [] + payments_primitives_payment_records_resource_shipping_details: + description: The customer's shipping information associated with this payment. + properties: + address: + $ref: >- + #/components/schemas/payments_primitives_payment_records_resource_address + name: + description: The shipping recipient's name. + maxLength: 5000 + nullable: true + type: string + phone: + description: The shipping recipient's phone number. + maxLength: 5000 + nullable: true + type: string + required: + - address + title: PaymentsPrimitivesPaymentRecordsResourceShippingDetails + type: object + x-expandableFields: + - address payout: description: >- A `Payout` object is created when you receive funds from Stripe, or when @@ -35828,7 +42062,7 @@ components: industry. - Related guide: [Receiving payouts](https://stripe.com/docs/payouts) + Related guide: [Receiving payouts](https://docs.stripe.com/payouts) properties: amount: description: >- @@ -35842,7 +42076,7 @@ components: - $ref: '#/components/schemas/application_fee' description: >- The application fee (if any) for the payout. [See the Connect - documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) + documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. nullable: true x-expansionResources: @@ -35852,7 +42086,7 @@ components: description: >- The amount of the application fee (if any) requested for the payout. [See the Connect - documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) + documentation](https://docs.stripe.com/connect/instant-payouts#monetization-and-fees) for details. nullable: true type: integer @@ -35865,7 +42099,7 @@ components: automatic: description: >- Returns `true` if the payout is created by an [automated payout - schedule](https://stripe.com/docs/payouts#payout-schedule) and + schedule](https://docs.stripe.com/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts). type: boolean @@ -35936,7 +42170,7 @@ components: description: >- Error code that provides a reason for a payout failure, if available. View our [list of failure - codes](https://stripe.com/docs/api#payout_failures). + codes](https://docs.stripe.com/api#payout_failures). maxLength: 5000 nullable: true type: string @@ -35959,7 +42193,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -35992,10 +42226,15 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/payout' + payout_method: + description: ID of the v2 FinancialAccount the funds are sent to. + maxLength: 5000 + nullable: true + type: string reconciliation_status: description: >- If `completed`, you can use the [Balance Transactions - API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) + API](https://docs.stripe.com/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout. enum: - completed @@ -36132,33 +42371,14 @@ components: title: paypal_seller_protection type: object x-expandableFields: [] - period: - description: '' - properties: - end: - description: >- - The end date of this usage period. All usage up to and including - this point in time is included. - format: unix-time - nullable: true - type: integer - start: - description: >- - The start date of this usage period. All usage after this point in - time is included. - format: unix-time - nullable: true - type: integer - title: Period - type: object - x-expandableFields: [] person: description: >- This is an object representing a person associated with a Stripe account. - A platform cannot access a person for an account where + A platform can only access a subset of data in a person for an account + where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. @@ -36195,27 +42415,45 @@ components: dob: $ref: '#/components/schemas/legal_entity_dob' email: - description: The person's email address. + description: >- + The person's email address. Also available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string first_name: - description: The person's first name. + description: >- + The person's first name. Also available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string first_name_kana: - description: The Kana variation of the person's first name (Japan only). + description: >- + The Kana variation of the person's first name (Japan only). Also + available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string first_name_kanji: - description: The Kanji variation of the person's first name (Japan only). + description: >- + The Kanji variation of the person's first name (Japan only). Also + available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string full_name_aliases: - description: A list of alternate names or aliases that the person is known by. + description: >- + A list of alternate names or aliases that the person is known by. + Also available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. items: maxLength: 5000 type: string @@ -36243,17 +42481,28 @@ components: description: Whether the person's `id_number_secondary` was provided. type: boolean last_name: - description: The person's last name. + description: >- + The person's last name. Also available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string last_name_kana: - description: The Kana variation of the person's last name (Japan only). + description: >- + The Kana variation of the person's last name (Japan only). Also + available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string last_name_kanji: - description: The Kanji variation of the person's last name (Japan only). + description: >- + The Kanji variation of the person's last name (Japan only). Also + available for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`. maxLength: 5000 nullable: true type: string @@ -36267,7 +42516,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -36311,6 +42560,11 @@ components: Whether the last four digits of the person's Social Security number have been provided (U.S. only). type: boolean + us_cfpb_data: + anyOf: + - $ref: '#/components/schemas/person_us_cfpb_data' + description: Demographic data related to the person. + nullable: true verification: $ref: '#/components/schemas/legal_entity_person_verification' required: @@ -36330,6 +42584,7 @@ components: - registered_address - relationship - requirements + - us_cfpb_data - verification x-resourceId: person person_additional_tos_acceptance: @@ -36373,21 +42628,50 @@ components: type: object x-expandableFields: - account + person_ethnicity_details: + description: '' + properties: + ethnicity: + description: The persons ethnicity + items: + enum: + - cuban + - hispanic_or_latino + - mexican + - not_hispanic_or_latino + - other_hispanic_or_latino + - prefer_not_to_answer + - puerto_rican + type: string + nullable: true + type: array + ethnicity_other: + description: 'Please specify your origin, when other is selected.' + maxLength: 5000 + nullable: true + type: string + title: PersonEthnicityDetails + type: object + x-expandableFields: [] person_future_requirements: description: '' properties: alternatives: description: >- - Fields that are due and can be satisfied by providing the - corresponding alternative fields instead. + Fields that are due and can be resolved by providing the + corresponding alternative fields instead. Many alternatives can list + the same `original_fields_due`, and any of these alternatives can + serve as a pathway for attempting to resolve the fields again. + Re-providing `original_fields_due` also serves as a pathway for + attempting to resolve the fields again. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array currently_due: description: >- - Fields that need to be collected to keep the person's account - enabled. If not collected by the account's + Fields that need to be resolved to keep the person's account + enabled. If not resolved by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period @@ -36398,8 +42682,8 @@ components: type: array errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' type: array @@ -36414,23 +42698,23 @@ components: type: array past_due: description: >- - Fields that weren't collected by the account's - `requirements.current_deadline`. These fields need to be collected - to enable the person's account. New fields will never appear here; - `future_requirements.past_due` will always be a subset of - `requirements.past_due`. + Fields that haven't been resolved by the account's + `requirements.current_deadline`. These fields need to be resolved to + enable the person's account. `future_requirements.past_due` is a + subset of `requirements.past_due`. items: maxLength: 5000 type: string type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due` or `currently_due`. Fields might appear in - `eventually_due` or `currently_due` and in `pending_verification` if - verification fails but another verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -36446,6 +42730,48 @@ components: x-expandableFields: - alternatives - errors + person_race_details: + description: '' + properties: + race: + description: The persons race. + items: + enum: + - african_american + - american_indian_or_alaska_native + - asian + - asian_indian + - black_or_african_american + - chinese + - ethiopian + - filipino + - guamanian_or_chamorro + - haitian + - jamaican + - japanese + - korean + - native_hawaiian + - native_hawaiian_or_other_pacific_islander + - nigerian + - other_asian + - other_black_or_african_american + - other_pacific_islander + - prefer_not_to_answer + - samoan + - somali + - vietnamese + - white + type: string + nullable: true + type: array + race_other: + description: 'Please specify your race, when other is selected.' + maxLength: 5000 + nullable: true + type: string + title: PersonRaceDetails + type: object + x-expandableFields: [] person_relationship: description: '' properties: @@ -36506,25 +42832,30 @@ components: properties: alternatives: description: >- - Fields that are due and can be satisfied by providing the - corresponding alternative fields instead. + Fields that are due and can be resolved by providing the + corresponding alternative fields instead. Many alternatives can list + the same `original_fields_due`, and any of these alternatives can + serve as a pathway for attempting to resolve the fields again. + Re-providing `original_fields_due` also serves as a pathway for + attempting to resolve the fields again. items: $ref: '#/components/schemas/account_requirements_alternative' nullable: true type: array currently_due: description: >- - Fields that need to be collected to keep the person's account - enabled. If not collected by the account's `current_deadline`, these - fields appear in `past_due` as well, and the account is disabled. + Fields that need to be resolved to keep the person's account + enabled. If not resolved by the account's `current_deadline`, these + fields will appear in `past_due` as well, and the account is + disabled. items: maxLength: 5000 type: string type: array errors: description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. + Details about validation and verification failures for `due` + requirements that must be resolved. items: $ref: '#/components/schemas/account_requirements_error' type: array @@ -36539,21 +42870,21 @@ components: type: array past_due: description: >- - Fields that weren't collected by the account's `current_deadline`. - These fields need to be collected to enable the person's account. + Fields that haven't been resolved by `current_deadline`. These + fields need to be resolved to enable the person's account. items: maxLength: 5000 type: string type: array pending_verification: description: >- - Fields that might become required depending on the results of - verification or review. It's an empty array unless an asynchronous - verification is pending. If verification fails, these fields move to - `eventually_due`, `currently_due`, or `past_due`. Fields might - appear in `eventually_due`, `currently_due`, or `past_due` and in - `pending_verification` if verification fails but another - verification is still pending. + Fields that are being reviewed, or might become required depending + on the results of a review. If the review fails, these fields can + move to `eventually_due`, `currently_due`, `past_due` or + `alternatives`. Fields might appear in `eventually_due`, + `currently_due`, `past_due` or `alternatives` and in + `pending_verification` if one verification fails but another is + still pending. items: maxLength: 5000 type: string @@ -36569,21 +42900,44 @@ components: x-expandableFields: - alternatives - errors + person_us_cfpb_data: + description: '' + properties: + ethnicity_details: + anyOf: + - $ref: '#/components/schemas/person_ethnicity_details' + description: The persons ethnicity details + nullable: true + race_details: + anyOf: + - $ref: '#/components/schemas/person_race_details' + description: The persons race details + nullable: true + self_identified_gender: + description: The persons self-identified gender + maxLength: 5000 + nullable: true + type: string + title: PersonUSCfpbData + type: object + x-expandableFields: + - ethnicity_details + - race_details plan: description: >- You can now model subscriptions more flexibly using the [Prices - API](https://stripe.com/docs/api#prices). It replaces the Plans API and - is backwards compatible to simplify your migration. + API](https://api.stripe.com#prices). It replaces the Plans API and is + backwards compatible to simplify your migration. Plans define the base price, currency, and billing cycle for recurring purchases of products. - [Products](https://stripe.com/docs/api#products) help you track - inventory or provisioning, and plans help you track pricing. Different - physical goods or levels of service should be represented by products, - and pricing options should be represented by plans. This approach lets - you change prices without having to change your provisioning scheme. + [Products](https://api.stripe.com#products) help you track inventory or + provisioning, and plans help you track pricing. Different physical goods + or levels of service should be represented by products, and pricing + options should be represented by plans. This approach lets you change + prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has plans for @@ -36591,29 +42945,13 @@ components: Related guides: [Set up a - subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) + subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription) and more about [products and - prices](https://stripe.com/docs/products-prices/overview). + prices](https://docs.stripe.com/products-prices/overview). properties: active: description: Whether the plan can be used for new purchases. type: boolean - aggregate_usage: - description: >- - Specifies a usage aggregation strategy for plans of - `usage_type=metered`. Allowed values are `sum` for summing up all - usage during a period, `last_during_period` for using the last usage - record reported within a period, `last_ever` for using the last - usage record ever (across period bounds) or `max` which uses the - usage record with the maximum reported usage during a period. - Defaults to `sum`. - enum: - - last_during_period - - last_ever - - max - - sum - nullable: true - type: string amount: description: >- The unit amount in cents (or local equivalent) to be charged, @@ -36686,7 +43024,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -36750,7 +43088,7 @@ components: description: >- Default number of trial days when subscribing a customer to this plan using - [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). nullable: true type: integer usage_type: @@ -36826,13 +43164,12 @@ components: maxLength: 5000 type: string type: - description: >- - Type of object that created the application fee, either `charge` or - `payout`. + description: Type of object that created the application fee. enum: - charge - payout type: string + x-stripeBypassValidation: true required: - type title: PlatformEarningFeeSource @@ -37052,9 +43389,7 @@ components: description: '' properties: discounts: - description: >- - The coupon or promotion code to apply to this subscription update. - Currently, only up to one may be specified. + description: The coupon or promotion code to apply to this subscription update. items: $ref: >- #/components/schemas/portal_flows_subscription_update_confirm_discount @@ -37063,7 +43398,7 @@ components: items: description: >- The [subscription - item](https://stripe.com/docs/api/subscription_items) to be updated + item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable. items: @@ -37122,7 +43457,7 @@ components: id: description: >- The ID of the [subscription - item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) + item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated. maxLength: 5000 nullable: true @@ -37131,13 +43466,13 @@ components: description: >- The price the customer should subscribe to through this flow. The price must also be included in the configuration's - [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). + [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products). maxLength: 5000 nullable: true type: string quantity: description: >- - [Quantity](https://stripe.com/docs/subscriptions/quantities) for + [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow. type: integer title: PortalFlowsSubscriptionUpdateConfirmItem @@ -37170,7 +43505,7 @@ components: description: >- A shareable URL to the hosted portal login page. Your customers will be able to log in with their - [email](https://stripe.com/docs/api/customers/object#customer_object-email) + [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal. maxLength: 5000 nullable: true @@ -37186,6 +43521,17 @@ components: enabled: description: Whether the feature is enabled. type: boolean + payment_method_configuration: + description: >- + The [Payment Method + Configuration](/api/payment_method_configurations) to use for this + portal session. When specified, customers will be able to update + their payment method to one of the options specified by the payment + method configuration. If not set, the default payment method + configuration is used. + maxLength: 5000 + nullable: true + type: string required: - enabled title: PortalPaymentMethodUpdate @@ -37285,6 +43631,19 @@ components: portal_subscription_update: description: '' properties: + billing_cycle_anchor: + description: >- + Determines the value to use for the billing cycle anchor on + subscription updates. Valid values are `now` or `unchanged`, and the + default value is `unchanged`. Setting the value to `now` resets the + subscription's billing cycle anchor to the current time (in UTC). + For more information, see the billing cycle + [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). + enum: + - now + - unchanged + nullable: true + type: string default_allowed_updates: description: >- The types of subscription updates that are supported for items @@ -37319,11 +43678,21 @@ components: type: string schedule_at_period_end: $ref: '#/components/schemas/portal_resource_schedule_update_at_period_end' + trial_update_behavior: + description: >- + Determines how handle updates to trialing subscriptions. Valid + values are `end_trial` and `continue_trial`. Defaults to a value of + `end_trial` if you don't set it during creation. + enum: + - continue_trial + - end_trial + type: string required: - default_allowed_updates - enabled - proration_behavior - schedule_at_period_end + - trial_update_behavior title: PortalSubscriptionUpdate type: object x-expandableFields: @@ -37332,6 +43701,9 @@ components: portal_subscription_update_product: description: '' properties: + adjustable_quantity: + $ref: >- + #/components/schemas/portal_subscription_update_product_adjustable_quantity prices: description: >- The list of price IDs which, when subscribed to, a subscription can @@ -37345,22 +43717,42 @@ components: maxLength: 5000 type: string required: + - adjustable_quantity - prices - product title: PortalSubscriptionUpdateProduct type: object + x-expandableFields: + - adjustable_quantity + portal_subscription_update_product_adjustable_quantity: + description: '' + properties: + enabled: + description: 'If true, the quantity can be adjusted to any non-negative integer.' + type: boolean + maximum: + description: The maximum quantity that can be set for the product. + nullable: true + type: integer + minimum: + description: The minimum quantity that can be set for the product. + type: integer + required: + - enabled + - minimum + title: PortalSubscriptionUpdateProductAdjustableQuantity + type: object x-expandableFields: [] price: description: >- Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. - [Products](https://stripe.com/docs/api#products) help you track - inventory or provisioning, and prices help you track payment terms. - Different physical goods or levels of service should be represented by - products, and pricing options should be represented by prices. This - approach lets you change prices without having to change your - provisioning scheme. + [Products](https://api.stripe.com#products) help you track inventory or + provisioning, and prices help you track payment terms. Different + physical goods or levels of service should be represented by products, + and pricing options should be represented by prices. This approach lets + you change prices without having to change your provisioning scheme. For example, you might have a single "gold" product that has prices for @@ -37368,10 +43760,10 @@ components: Related guides: [Set up a - subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), - [create an invoice](https://stripe.com/docs/billing/invoices/create), + subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), + [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and - prices](https://stripe.com/docs/products-prices/overview). + prices](https://docs.stripe.com/products-prices/overview). properties: active: description: Whether the price can be used for new purchases. @@ -37440,7 +43832,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -37477,7 +43869,7 @@ components: tax_behavior: description: >- Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either @@ -37599,20 +43991,20 @@ components: goods or service; each version would be a separate Product. They can be used in conjunction with - [Prices](https://stripe.com/docs/api#prices) to configure pricing in - Payment Links, Checkout, and Subscriptions. + [Prices](https://api.stripe.com#prices) to configure pricing in Payment + Links, Checkout, and Subscriptions. Related guides: [Set up a - subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), + subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), - [share a Payment Link](https://stripe.com/docs/payment-links), + [share a Payment Link](https://docs.stripe.com/payment-links), [accept payments with - Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront), + Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront), and more about [Products and - Prices](https://stripe.com/docs/products-prices/overview) + Prices](https://docs.stripe.com/products-prices/overview) properties: active: description: Whether the product is currently available for purchase. @@ -37629,7 +44021,7 @@ components: type: string - $ref: '#/components/schemas/price' description: >- - The ID of the [Price](https://stripe.com/docs/api/prices) object + The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. nullable: true x-expansionResources: @@ -37664,7 +44056,7 @@ components: description: >- A list of up to 15 marketing features for this product. These are displayed in [pricing - tables](https://stripe.com/docs/payments/checkout/pricing-table). + tables](https://docs.stripe.com/payments/checkout/pricing-table). items: $ref: '#/components/schemas/product_marketing_feature' type: array @@ -37673,7 +44065,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -37711,7 +44103,7 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/tax_code' - description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' + description: 'A [tax code](https://docs.stripe.com/tax/tax-categories) ID.' nullable: true x-expansionResources: oneOf: @@ -37802,10 +44194,19 @@ components: x-expandableFields: [] promotion_code: description: >- - A Promotion Code represents a customer-redeemable code for a - [coupon](https://stripe.com/docs/api#coupons). It can be used to + A Promotion Code represents a customer-redeemable code for an underlying + promotion. - create multiple codes for a single coupon. + You can create multiple codes for a single promotion. + + + If you enable promotion codes in your [customer portal + configuration](https://docs.stripe.com/customer-management/configure-portal), + then customers can redeem a code themselves when updating a subscription + in the portal. + + Customers can also view the currently active promotion codes and coupons + on each of their subscriptions in the portal. properties: active: description: >- @@ -37817,11 +44218,9 @@ components: 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). + digits (0-9), and dashes (-). maxLength: 5000 type: string - coupon: - $ref: '#/components/schemas/coupon' created: description: >- Time at which the object was created. Measured in seconds since the @@ -37834,12 +44233,19 @@ components: type: string - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' - description: The customer that this promotion code can be used by. + description: The customer who can use this promotion code. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + The account representing the customer who can use this promotion + code. + maxLength: 5000 + nullable: true + type: string expires_at: description: Date at which the promotion code can no longer be redeemed. format: unix-time @@ -37863,7 +44269,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -37875,6 +44281,8 @@ components: enum: - promotion_code type: string + promotion: + $ref: '#/components/schemas/promotion_codes_resource_promotion' restrictions: $ref: '#/components/schemas/promotion_codes_resource_restrictions' times_redeemed: @@ -37883,18 +44291,18 @@ components: required: - active - code - - coupon - created - id - livemode - object + - promotion - restrictions - times_redeemed title: PromotionCode type: object x-expandableFields: - - coupon - customer + - promotion - restrictions x-resourceId: promotion_code promotion_code_currency_option: @@ -37910,6 +44318,30 @@ components: title: PromotionCodeCurrencyOption type: object x-expandableFields: [] + promotion_codes_resource_promotion: + description: '' + properties: + coupon: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/coupon' + description: 'If promotion `type` is `coupon`, the coupon for this promotion.' + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/coupon' + type: + description: The type of promotion. + enum: + - coupon + type: string + required: + - type + title: PromotionCodesResourcePromotion + type: object + x-expandableFields: + - coupon promotion_codes_resource_restrictions: description: '' properties: @@ -37946,6 +44378,20 @@ components: type: object x-expandableFields: - currency_options + proration_details: + description: '' + properties: + discount_amounts: + description: Discount amounts applied when the proration was created. + items: + $ref: '#/components/schemas/discounts_resource_discount_amount' + type: array + required: + - discount_amounts + title: ProrationDetails + type: object + x-expandableFields: + - discount_amounts quote: description: >- A Quote is a way to model prices that you'd like to provide to a @@ -38028,13 +44474,21 @@ components: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' description: >- - The customer which this quote belongs to. A customer is required - before finalizing the quote. Once specified, it cannot be changed. + The customer who received this quote. A customer is required to + finalize the quote. Once specified, you can't change it. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + The account representing the customer who received this quote. A + customer or account is required to finalize the quote. Once + specified, you can't change it. + maxLength: 5000 + nullable: true + type: string default_tax_rates: description: The tax rates applied to this quote. items: @@ -38078,7 +44532,7 @@ components: - $ref: '#/components/schemas/quotes_resource_from_quote' description: >- Details of the quote that was cloned. See the [cloning - documentation](https://stripe.com/docs/quotes/clone) for more + documentation](https://docs.stripe.com/quotes/clone) for more details. nullable: true header: @@ -38147,7 +44601,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -38155,7 +44609,7 @@ components: description: >- A unique number that identifies this particular quote. This number is assigned once the quote is - [finalized](https://stripe.com/docs/quotes/overview#finalize). + [finalized](https://docs.stripe.com/quotes/overview#finalize). maxLength: 5000 nullable: true type: string @@ -38290,6 +44744,11 @@ components: from this account. The tax transaction is returned in the report of the connected account. nullable: true + provider: + description: The tax provider powering automatic tax. + maxLength: 5000 + nullable: true + type: string status: description: >- The status of the most recent automated tax calculation for this @@ -38413,9 +44872,30 @@ components: title: QuotesResourceStatusTransitions type: object x-expandableFields: [] + quotes_resource_subscription_data_billing_mode: + description: The billing mode of the quote. + properties: + flexible: + $ref: '#/components/schemas/subscriptions_resource_billing_mode_flexible' + type: + description: >- + Controls how prorations and invoices for subscriptions are + calculated and orchestrated. + enum: + - classic + - flexible + type: string + required: + - type + title: QuotesResourceSubscriptionDataBillingMode + type: object + x-expandableFields: + - flexible quotes_resource_subscription_data_subscription_data: description: '' properties: + billing_mode: + $ref: '#/components/schemas/quotes_resource_subscription_data_billing_mode' description: description: >- The subscription's description, meant to be displayable to the @@ -38439,7 +44919,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting @@ -38456,9 +44936,12 @@ components: customer is charged for the first time. nullable: true type: integer + required: + - billing_mode title: QuotesResourceSubscriptionDataSubscriptionData type: object - x-expandableFields: [] + x-expandableFields: + - billing_mode quotes_resource_total_details: description: '' properties: @@ -38603,7 +45086,7 @@ components: Related guide: [Early fraud - warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings) + warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings) properties: actionable: description: >- @@ -38677,6 +45160,87 @@ components: - charge - payment_intent x-resourceId: radar.early_fraud_warning + radar.payment_evaluation: + description: >- + Payment Evaluations represent the risk lifecycle of an externally + processed payment. It includes the Radar risk score from Stripe, payment + outcome taken by the merchant or processor, and any post transaction + events, such as refunds or disputes. See the [Radar API + guide](/radar/multiprocessor) for integration steps. + properties: + client_device_metadata_details: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_client_device_metadata + created_at: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + customer_details: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_customer_details + events: + description: >- + Event information associated with the payment evaluation, such as + refunds, dispute, early fraud warnings, or user interventions. + items: + $ref: '#/components/schemas/insights_resources_payment_evaluation_event' + type: array + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + insights: + $ref: '#/components/schemas/insights_resources_payment_evaluation_insights' + 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://docs.stripe.com/api/metadata) that + you can attach to an object. This can be useful for storing + additional information about the object in a structured format. + nullable: true + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - radar.payment_evaluation + type: string + outcome: + anyOf: + - $ref: >- + #/components/schemas/insights_resources_payment_evaluation_outcome + description: Indicates the final outcome for the payment evaluation. + nullable: true + payment_details: + $ref: >- + #/components/schemas/insights_resources_payment_evaluation_payment_details + required: + - created_at + - events + - id + - insights + - livemode + - object + title: InsightsResourcesPaymentEvaluation + type: object + x-expandableFields: + - client_device_metadata_details + - customer_details + - events + - insights + - outcome + - payment_details + x-resourceId: radar.payment_evaluation radar.value_list: description: >- Value lists allow you to group values together which can then be @@ -38684,7 +45248,7 @@ components: Related guide: [Default Stripe - lists](https://stripe.com/docs/radar/lists#managing-list-items) + lists](https://docs.stripe.com/radar/lists#managing-list-items) properties: alias: description: The name of the value list for use in rules. @@ -38707,9 +45271,9 @@ components: item_type: description: >- The type of items in the value list. One of `card_fingerprint`, - `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, - `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, - or `customer_id`. + `card_bin`, `email`, `ip_address`, `country`, `string`, + `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or + `us_bank_account_fingerprint`. enum: - card_bin - card_fingerprint @@ -38765,7 +45329,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -38803,7 +45367,7 @@ components: Related guide: [Managing list - items](https://stripe.com/docs/radar/lists#managing-list-items) + items](https://docs.stripe.com/radar/lists#managing-list-items) properties: created: description: >- @@ -38856,12 +45420,12 @@ components: radar_radar_options: description: >- Options to configure Radar. See [Radar - Session](https://stripe.com/docs/radar/radar-session) for more + Session](https://docs.stripe.com/radar/radar-session) for more information. properties: session: description: >- - A [Radar Session](https://stripe.com/docs/radar/radar-session) is a + A [Radar Session](https://docs.stripe.com/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments. maxLength: 5000 @@ -38951,17 +45515,6 @@ components: recurring: description: '' properties: - aggregate_usage: - description: >- - Specifies a usage aggregation strategy for prices of - `usage_type=metered`. Defaults to `sum`. - enum: - - last_during_period - - last_ever - - max - - sum - nullable: true - type: string interval: description: >- The frequency at which a subscription is billed. One of `day`, @@ -39011,7 +45564,7 @@ components: initially charged. - Related guide: [Refunds](https://stripe.com/docs/refunds) + Related guide: [Refunds](https://docs.stripe.com/refunds) properties: amount: description: 'Amount, in cents (or local equivalent).' @@ -39096,7 +45649,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -39120,6 +45673,18 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_intent' + pending_reason: + description: >- + Provides the reason for why the refund is pending. Possible values + are: `processing`, `insufficient_funds`, or `charge_pending`. + enum: + - charge_pending + - insufficient_funds + - processing + type: string + presentment_details: + $ref: >- + #/components/schemas/payment_flows_payment_intent_presentment_details reason: description: >- Reason for the refund, which is either user-provided (`duplicate`, @@ -39156,7 +45721,7 @@ components: description: >- Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed - refunds](https://stripe.com/docs/refunds#failed-refunds). + refunds](https://docs.stripe.com/refunds#failed-refunds). maxLength: 5000 nullable: true type: string @@ -39188,6 +45753,7 @@ components: - failure_balance_transaction - next_action - payment_intent + - presentment_details - source_transfer_reversal - transfer_reversal x-resourceId: refund @@ -39214,6 +45780,8 @@ components: $ref: '#/components/schemas/refund_destination_details_card' cashapp: $ref: '#/components/schemas/destination_details_unimplemented' + crypto: + $ref: '#/components/schemas/refund_destination_details_crypto' customer_cash_balance: $ref: '#/components/schemas/destination_details_unimplemented' eps: @@ -39230,16 +45798,20 @@ components: $ref: '#/components/schemas/refund_destination_details_jp_bank_transfer' klarna: $ref: '#/components/schemas/destination_details_unimplemented' + mb_way: + $ref: '#/components/schemas/refund_destination_details_mb_way' multibanco: $ref: '#/components/schemas/refund_destination_details_multibanco' mx_bank_transfer: $ref: '#/components/schemas/refund_destination_details_mx_bank_transfer' + nz_bank_transfer: + $ref: '#/components/schemas/destination_details_unimplemented' p24: $ref: '#/components/schemas/refund_destination_details_p24' paynow: $ref: '#/components/schemas/destination_details_unimplemented' paypal: - $ref: '#/components/schemas/destination_details_unimplemented' + $ref: '#/components/schemas/refund_destination_details_paypal' pix: $ref: '#/components/schemas/destination_details_unimplemented' revolut: @@ -39250,6 +45822,8 @@ components: $ref: '#/components/schemas/refund_destination_details_swish' th_bank_transfer: $ref: '#/components/schemas/refund_destination_details_th_bank_transfer' + twint: + $ref: '#/components/schemas/destination_details_unimplemented' type: description: >- The type of transaction-specific details of the payment method used @@ -39279,6 +45853,7 @@ components: - br_bank_transfer - card - cashapp + - crypto - customer_cash_balance - eps - eu_bank_transfer @@ -39287,8 +45862,10 @@ components: - grabpay - jp_bank_transfer - klarna + - mb_way - multibanco - mx_bank_transfer + - nz_bank_transfer - p24 - paynow - paypal @@ -39297,6 +45874,7 @@ components: - sofort - swish - th_bank_transfer + - twint - us_bank_transfer - wechat_pay - zip @@ -39372,6 +45950,17 @@ components: title: refund_destination_details_card type: object x-expandableFields: [] + refund_destination_details_crypto: + description: '' + properties: + reference: + description: The transaction hash of the refund. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_crypto + type: object + x-expandableFields: [] refund_destination_details_eu_bank_transfer: description: '' properties: @@ -39426,6 +46015,24 @@ components: title: refund_destination_details_jp_bank_transfer type: object x-expandableFields: [] + refund_destination_details_mb_way: + 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_mb_way + type: object + x-expandableFields: [] refund_destination_details_multibanco: description: '' properties: @@ -39480,6 +46087,19 @@ components: title: refund_destination_details_p24 type: object x-expandableFields: [] + refund_destination_details_paypal: + 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 + title: refund_destination_details_paypal + type: object + x-expandableFields: [] refund_destination_details_swish: description: '' properties: @@ -39586,14 +46206,14 @@ components: where you can retrieve your results. For an overview, see [API Access to - Reports](https://stripe.com/docs/reporting/statements/api). + Reports](https://docs.stripe.com/reporting/statements/api). Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a [live-mode API - key](https://stripe.com/docs/keys#test-live-modes). + key](https://docs.stripe.com/keys#test-live-modes). properties: created: description: >- @@ -39631,7 +46251,7 @@ components: report_type: description: >- The ID of the [report - type](https://stripe.com/docs/reports/report-types) to run, such as + type](https://docs.stripe.com/reports/report-types) to run, such as `"balance.summary.1"`. maxLength: 5000 type: string @@ -39682,7 +46302,7 @@ components: identified by an ID belonging to a set of enumerated values. See [API Access to Reports - documentation](https://stripe.com/docs/reporting/statements/api) + documentation](https://docs.stripe.com/reporting/statements/api) for those Report Type IDs, along with required and optional parameters. @@ -39691,7 +46311,7 @@ components: data (not test-mode data), and will error when queried without a [live-mode API - key](https://stripe.com/docs/keys#test-live-modes). + key](https://docs.stripe.com/keys#test-live-modes). properties: data_available_end: description: >- @@ -39718,7 +46338,7 @@ components: id: description: >- The [ID of the Report - Type](https://stripe.com/docs/reporting/statements/api#available-report-types), + Type](https://docs.stripe.com/reporting/statements/api#available-report-types), such as `balance.summary.1`. maxLength: 5000 type: string @@ -39810,7 +46430,7 @@ components: Learn more about [Radar](/radar) and reviewing payments - [here](https://stripe.com/docs/radar/reviews). + [here](https://docs.stripe.com/radar/reviews). properties: billing_zip: description: 'The ZIP or postal code of the card used, if applicable.' @@ -39831,10 +46451,14 @@ components: description: >- The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, - `disputed`, or `redacted`. + `disputed`, `redacted`, `canceled`, `payment_never_settled`, or + `acknowledged`. enum: + - acknowledged - approved + - canceled - disputed + - payment_never_settled - redacted - refunded - refunded_as_fraud @@ -39898,7 +46522,7 @@ components: description: >- The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, - or `redacted`. + `redacted`, `canceled`, `payment_never_settled`, or `acknowledged`. maxLength: 5000 type: string session: @@ -39964,7 +46588,7 @@ components: scheduled_query_run: description: >- If you have [scheduled a Sigma - query](https://stripe.com/docs/sigma/scheduled-queries), you'll + query](https://docs.stripe.com/sigma/scheduled-queries), you'll receive a `sigma.scheduled_query_run.created` webhook each time the query @@ -40136,7 +46760,7 @@ components: - $ref: '#/components/schemas/application' description: >- The value of - [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) + [application](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation. nullable: true x-expansionResources: @@ -40167,13 +46791,21 @@ components: - $ref: '#/components/schemas/deleted_customer' description: >- The value of - [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) + [customer](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation. nullable: true x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + The value of + [customer_account](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-customer_account) + on the SetupIntent at the time of this confirmation. + maxLength: 5000 + nullable: true + type: string flow_directions: description: >- Indicates the directions of money movement for which this payment @@ -40215,7 +46847,7 @@ components: - $ref: '#/components/schemas/account' description: >- The value of - [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) + [on_behalf_of](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation. nullable: true x-expansionResources: @@ -40258,7 +46890,7 @@ components: usage: description: >- The value of - [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) + [usage](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`. maxLength: 5000 @@ -40317,8 +46949,15 @@ components: $ref: '#/components/schemas/setup_attempt_payment_method_details_kr_card' link: $ref: '#/components/schemas/setup_attempt_payment_method_details_link' + naver_pay: + $ref: '#/components/schemas/setup_attempt_payment_method_details_naver_pay' + nz_bank_account: + $ref: >- + #/components/schemas/setup_attempt_payment_method_details_nz_bank_account paypal: $ref: '#/components/schemas/setup_attempt_payment_method_details_paypal' + payto: + $ref: '#/components/schemas/setup_attempt_payment_method_details_payto' revolut_pay: $ref: >- #/components/schemas/setup_attempt_payment_method_details_revolut_pay @@ -40356,7 +46995,10 @@ components: - klarna - kr_card - link + - naver_pay + - nz_bank_account - paypal + - payto - revolut_pay - sepa_debit - sofort @@ -40471,8 +47113,9 @@ components: properties: brand: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. + Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, + `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or + `unknown`. maxLength: 5000 nullable: true type: string @@ -40644,17 +47287,21 @@ components: properties: bank: description: >- - The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, - `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, - `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, - or `yoursafe`. + The customer's bank. Can be one of `abn_amro`, `adyen`, `asn_bank`, + `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, + `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, + `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -40671,13 +47318,17 @@ components: description: The Bank Identifier Code of the customer's bank. enum: - ABNANL2A + - ADYBNL2A - ASNBNL21 - BITSNL2A - BUNQNL2A + - BUUTNL2A + - FNOMNL22 - FVLBNL22 - HANDNL2A - INGBNL2A - KNABNL2H + - MLLENL2A - MOYONL21 - NNBANL2G - NTSBDEB1 @@ -40757,12 +47408,36 @@ components: title: setup_attempt_payment_method_details_link type: object x-expandableFields: [] + setup_attempt_payment_method_details_naver_pay: + description: '' + properties: + buyer_id: + description: >- + Uniquely identifies this particular Naver Pay account. You can use + this attribute to check whether two Naver Pay accounts are the same. + maxLength: 5000 + type: string + title: setup_attempt_payment_method_details_naver_pay + type: object + x-expandableFields: [] + setup_attempt_payment_method_details_nz_bank_account: + description: '' + properties: {} + title: setup_attempt_payment_method_details_nz_bank_account + type: object + x-expandableFields: [] setup_attempt_payment_method_details_paypal: description: '' properties: {} title: setup_attempt_payment_method_details_paypal type: object x-expandableFields: [] + setup_attempt_payment_method_details_payto: + description: '' + properties: {} + title: setup_attempt_payment_method_details_payto + type: object + x-expandableFields: [] setup_attempt_payment_method_details_revolut_pay: description: '' properties: {} @@ -40865,8 +47540,8 @@ components: customer's card without immediately collecting a payment. Later, you can use - [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive - the payment flow. + [PaymentIntents](https://api.stripe.com#payment_intents) to drive the + payment flow. Create a SetupIntent when you're ready to collect your customer's @@ -40897,13 +47572,13 @@ components: payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a - [Customer](https://stripe.com/docs/api#setup_intent_object-customer), + [Customer](https://api.stripe.com#setup_intent_object-customer), it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) on PaymentIntents to save payment methods to prevent saving invalid or @@ -40993,6 +47668,17 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + ID of the Account this SetupIntent belongs to, if one exists. + + + If present, the SetupIntent's payment method will be attached to the + Account on successful setup. Payment methods attached to other + Accounts cannot be used with this SetupIntent. + maxLength: 5000 + nullable: true + type: string description: description: >- An arbitrary string attached to the object. Often useful for @@ -41000,6 +47686,63 @@ components: maxLength: 5000 nullable: true type: string + excluded_payment_method_types: + description: Payment method types that are excluded from this SetupIntent. + items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + nullable: true + type: array flow_directions: description: >- Indicates the directions of money movement for which this payment @@ -41057,7 +47800,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -41107,7 +47850,7 @@ components: #/components/schemas/payment_method_config_biz_payment_method_configuration_details description: >- Information about the [payment method - configuration](https://stripe.com/docs/api/payment_method_configurations) + configuration](https://docs.stripe.com/api/payment_method_configurations) used for this Setup Intent. nullable: true payment_method_options: @@ -41118,7 +47861,9 @@ components: payment_method_types: description: >- The list of payment method types (e.g. card) that this SetupIntent - is allowed to set up. + is allowed to set up. A list of valid payment method types can be + found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string @@ -41135,7 +47880,7 @@ components: - $ref: '#/components/schemas/mandate' status: description: >- - [Status](https://stripe.com/docs/payments/intents#intent-statuses) + [Status](https://docs.stripe.com/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`. @@ -41193,9 +47938,11 @@ components: $ref: '#/components/schemas/setup_intent_next_action_redirect_to_url' type: description: >- - Type of the next action to perform, one of `redirect_to_url`, - `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, - or `verify_with_microdeposits`. + Type of the next action to perform. Refer to the other child + attributes under `next_action` for available values. Examples + include: `redirect_to_url`, `use_stripe_sdk`, + `alipay_handle_redirect`, `oxxo_display_details`, or + `verify_with_microdeposits`. maxLength: 5000 type: string use_stripe_sdk: @@ -41294,6 +48041,11 @@ components: #/components/schemas/setup_intent_payment_method_options_card_present - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client + klarna: + anyOf: + - $ref: '#/components/schemas/setup_intent_payment_method_options_klarna' + - $ref: >- + #/components/schemas/setup_intent_type_specific_payment_method_options_client link: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options_link' @@ -41304,6 +48056,11 @@ components: - $ref: '#/components/schemas/setup_intent_payment_method_options_paypal' - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client + payto: + anyOf: + - $ref: '#/components/schemas/setup_intent_payment_method_options_payto' + - $ref: >- + #/components/schemas/setup_intent_type_specific_payment_method_options_client sepa_debit: anyOf: - $ref: >- @@ -41324,8 +48081,10 @@ components: - bacs_debit - card - card_present + - klarna - link - paypal + - payto - sepa_debit - us_bank_account setup_intent_payment_method_options_acss_debit: @@ -41406,11 +48165,11 @@ components: 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). + requirements](https://docs.stripe.com/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) + Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: @@ -41519,6 +48278,24 @@ components: title: setup_intent_payment_method_options_card_present type: object x-expandableFields: [] + setup_intent_payment_method_options_klarna: + description: '' + properties: + currency: + description: The currency of the setup intent. Three letter ISO currency code. + format: currency + nullable: true + type: string + preferred_locale: + description: >- + Preferred locale of the Klarna checkout page that the customer is + redirected to. + maxLength: 5000 + nullable: true + type: string + title: setup_intent_payment_method_options_klarna + type: object + x-expandableFields: [] setup_intent_payment_method_options_link: description: '' properties: {} @@ -41581,6 +48358,82 @@ components: title: setup_intent_payment_method_options_mandate_options_bacs_debit type: object x-expandableFields: [] + setup_intent_payment_method_options_mandate_options_payto: + description: '' + properties: + amount: + description: >- + Amount that will be collected. It is required when `amount_type` is + `fixed`. + nullable: true + type: integer + amount_type: + description: >- + The type of amount that will be collected. The amount charged must + be exact or up to the value of `amount` param for `fixed` or + `maximum` type respectively. Defaults to `maximum`. + enum: + - fixed + - maximum + nullable: true + type: string + end_date: + description: >- + Date, in YYYY-MM-DD format, after which payments will not be + collected. Defaults to no end date. + maxLength: 5000 + nullable: true + type: string + payment_schedule: + description: >- + The periodicity at which payments will be collected. Defaults to + `adhoc`. + enum: + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + nullable: true + type: string + payments_per_period: + description: >- + The number of payments that will be made during a payment period. + Defaults to 1 except for when `payment_schedule` is `adhoc`. In that + case, it defaults to no limit. + nullable: true + type: integer + purpose: + description: >- + The purpose for which payments are made. Has a default value based + on your merchant category code. + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + nullable: true + type: string + start_date: + description: >- + Date, in YYYY-MM-DD format, from which payments will be collected. + Defaults to confirmation time. + maxLength: 5000 + nullable: true + type: string + title: setup_intent_payment_method_options_mandate_options_payto + type: object + x-expandableFields: [] setup_intent_payment_method_options_mandate_options_sepa_debit: description: '' properties: @@ -41609,6 +48462,16 @@ components: title: setup_intent_payment_method_options_paypal type: object x-expandableFields: [] + setup_intent_payment_method_options_payto: + description: '' + properties: + mandate_options: + $ref: >- + #/components/schemas/setup_intent_payment_method_options_mandate_options_payto + title: setup_intent_payment_method_options_payto + type: object + x-expandableFields: + - mandate_options setup_intent_payment_method_options_sepa_debit: description: '' properties: @@ -41623,7 +48486,7 @@ components: description: '' properties: financial_connections: - $ref: '#/components/schemas/linked_account_options_us_bank_account' + $ref: '#/components/schemas/linked_account_options_common' mandate_options: $ref: >- #/components/schemas/payment_method_options_us_bank_account_mandate_options @@ -41643,6 +48506,9 @@ components: setup_intent_type_specific_payment_method_options_client: description: '' properties: + mandate_options: + $ref: >- + #/components/schemas/setup_intent_payment_method_options_mandate_options_payto verification_method: description: Bank account verification method. enum: @@ -41653,7 +48519,8 @@ components: x-stripeBypassValidation: true title: SetupIntentTypeSpecificPaymentMethodOptionsClient type: object - x-expandableFields: [] + x-expandableFields: + - mandate_options shipping: description: '' properties: @@ -41693,7 +48560,7 @@ components: customers and applied to a purchase. For more information, see [Charge for - shipping](https://stripe.com/docs/payments/during-payment/charge-shipping). + shipping](https://docs.stripe.com/payments/during-payment/charge-shipping). properties: active: description: >- @@ -41736,7 +48603,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -41764,7 +48631,7 @@ components: type: string - $ref: '#/components/schemas/tax_code' description: >- - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. nullable: true x-expansionResources: @@ -41885,6 +48752,49 @@ components: type: object x-expandableFields: - currency_options + sigma.sigma_api_query: + description: A saved query object represents a query that can be executed for a run. + properties: + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + name: + description: The name of the query. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - sigma.sigma_api_query + type: string + sql: + description: The sql statement for the query. + maxLength: 5000 + type: string + required: + - created + - id + - livemode + - name + - object + - sql + title: SigmaSigmaResourcesSigmaAPIQuery + type: object + x-expandableFields: [] + x-resourceId: sigma.sigma_api_query sigma_scheduled_query_run_error: description: '' properties: @@ -41911,17 +48821,17 @@ components: Stripe doesn't recommend using the deprecated [Sources - API](https://stripe.com/docs/api/sources). + API](https://docs.stripe.com/api/sources). We recommend that you adopt the [PaymentMethods - API](https://stripe.com/docs/api/payment_methods). + API](https://docs.stripe.com/api/payment_methods). This newer API provides access to our latest features and payment method types. - Related guides: [Sources API](https://stripe.com/docs/sources) and - [Sources & Customers](https://stripe.com/docs/sources/customers). + Related guides: [Sources API](https://docs.stripe.com/sources) and + [Sources & Customers](https://docs.stripe.com/sources/customers). properties: ach_credit_transfer: $ref: '#/components/schemas/source_type_ach_credit_transfer' @@ -42018,7 +48928,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -42075,7 +48985,7 @@ components: `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment - method](https://stripe.com/docs/sources) used. + method](https://docs.stripe.com/sources) used. enum: - ach_credit_transfer - ach_debit @@ -42481,7 +49391,7 @@ components: description: >- The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` - (succesful authentication, cannot be reused) or `not_required` + (successful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused). maxLength: 5000 @@ -43197,13 +50107,95 @@ components: statement_descriptor: type: string type: object + stackable_discount_with_discount_settings: + description: '' + properties: + coupon: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/coupon' + description: ID of the coupon to create a new discount for. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/coupon' + discount: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + description: >- + ID of an existing discount on the object (or one of its ancestors) + to reuse. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + promotion_code: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/promotion_code' + description: ID of the promotion code to create a new discount for. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/promotion_code' + title: StackableDiscountWithDiscountSettings + type: object + x-expandableFields: + - coupon + - discount + - promotion_code + stackable_discount_with_discount_settings_and_discount_end: + description: '' + properties: + coupon: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/coupon' + description: ID of the coupon to create a new discount for. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/coupon' + discount: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + description: >- + ID of an existing discount on the object (or one of its ancestors) + to reuse. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + promotion_code: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/promotion_code' + description: ID of the promotion code to create a new discount for. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/promotion_code' + title: StackableDiscountWithDiscountSettingsAndDiscountEnd + type: object + x-expandableFields: + - coupon + - discount + - promotion_code subscription: description: >- Subscriptions allow you to charge a customer on a recurring basis. Related guide: [Creating - subscriptions](https://stripe.com/docs/billing/subscriptions/creating) + subscriptions](https://docs.stripe.com/billing/subscriptions/creating) properties: application: anyOf: @@ -43230,7 +50222,7 @@ components: billing_cycle_anchor: description: >- The reference point that aligns future [billing - cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. + cycle](https://docs.stripe.com/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. @@ -43242,6 +50234,8 @@ components: #/components/schemas/subscriptions_resource_billing_cycle_anchor_config description: The fixed values used to calculate the `billing_cycle_anchor`. nullable: true + billing_mode: + $ref: '#/components/schemas/subscriptions_resource_billing_mode' billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_billing_thresholds' @@ -43301,18 +50295,6 @@ components: currency](https://stripe.com/docs/currencies). format: currency type: string - current_period_end: - description: >- - End of the current period that the subscription has been invoiced - for. At the end of this period, a new invoice will be created. - format: unix-time - type: integer - current_period_start: - description: >- - Start of the current period that the subscription has been invoiced - for. - format: unix-time - type: integer customer: anyOf: - maxLength: 5000 @@ -43324,6 +50306,13 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: >- + ID of the account representing the customer who owns the + subscription. + maxLength: 5000 + nullable: true + type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by this @@ -43341,9 +50330,9 @@ components: belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). nullable: true x-expansionResources: oneOf: @@ -43361,9 +50350,9 @@ components: chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). nullable: true x-expansionResources: oneOf: @@ -43389,16 +50378,6 @@ components: maxLength: 500 nullable: true type: string - discount: - anyOf: - - $ref: '#/components/schemas/discount' - description: >- - Describes the current discount applied to this subscription, if - there is one. When billing, a discount applied to a subscription - overrides a discount applied on a customer-wide basis. This field - has been deprecated and will be removed in a future API version. Use - `discounts` instead. - nullable: true discounts: description: >- The discounts applied to the subscription. Subscription item @@ -43463,7 +50442,9 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/invoice' - description: The most recent invoice this subscription has generated. + description: >- + The most recent invoice this subscription has generated over its + lifecycle (for example, when it cycles or is updated). nullable: true x-expansionResources: oneOf: @@ -43478,7 +50459,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -43504,8 +50485,9 @@ components: - $ref: '#/components/schemas/account' description: >- The account (if any) the charge was made on behalf of for charges - associated with this subscription. See the Connect documentation for - details. + associated with this subscription. See the [Connect + documentation](https://docs.stripe.com/connect/subscriptions#on-behalf-of) + for details. nullable: true x-expansionResources: oneOf: @@ -43517,7 +50499,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](https://stripe.com/docs/billing/subscriptions/pause-payment). + collection](https://docs.stripe.com/billing/subscriptions/pause-payment). nullable: true payment_settings: anyOf: @@ -43530,7 +50512,7 @@ components: description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an - invoice](https://stripe.com/docs/api#create_invoice) for the given + invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. nullable: true pending_setup_intent: @@ -43540,11 +50522,11 @@ components: - $ref: '#/components/schemas/setup_intent' description: >- You can use this - [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect + [SetupIntent](https://docs.stripe.com/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2). + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication#scenario-2). nullable: true x-expansionResources: oneOf: @@ -43554,7 +50536,7 @@ components: - $ref: '#/components/schemas/subscriptions_resource_pending_update' description: >- If specified, [pending - updates](https://stripe.com/docs/billing/subscriptions/pending-updates) + updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid. nullable: true @@ -43596,11 +50578,11 @@ components: 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). + method](https://docs.stripe.com/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), + collection](https://docs.stripe.com/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. @@ -43656,7 +50638,7 @@ components: trial_settings: anyOf: - $ref: >- - #/components/schemas/subscriptions_trials_resource_trial_settings + #/components/schemas/subscriptions_resource_trial_settings_trial_settings description: Settings related to subscription trials. nullable: true trial_start: @@ -43667,12 +50649,11 @@ components: required: - automatic_tax - billing_cycle_anchor + - billing_mode - cancel_at_period_end - collection_method - created - currency - - current_period_end - - current_period_start - customer - discounts - id @@ -43689,13 +50670,13 @@ components: - application - automatic_tax - billing_cycle_anchor_config + - billing_mode - billing_thresholds - cancellation_details - customer - default_payment_method - default_source - default_tax_rates - - discount - discounts - invoice_settings - items @@ -43760,24 +50741,6 @@ components: title: SubscriptionBillingThresholds type: object x-expandableFields: [] - subscription_details_data: - description: '' - properties: - metadata: - additionalProperties: - maxLength: 500 - type: string - description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) - defined as subscription metadata when an invoice is created. Becomes - an immutable snapshot of the subscription metadata at the time of - invoice finalization. - *Note: This attribute is populated only for invoices created on or after June 29, 2023.* - nullable: true - type: object - title: SubscriptionDetailsData - type: object - x-expandableFields: [] subscription_item: description: >- Subscription items allow you to create customer subscriptions with more @@ -43797,6 +50760,14 @@ components: Time at which the object was created. Measured in seconds since the Unix epoch. type: integer + current_period_end: + description: The end time of this subscription item's current billing period. + format: unix-time + type: integer + current_period_start: + description: The start time of this subscription item's current billing period. + format: unix-time + type: integer discounts: description: >- The discounts applied to the subscription item. Subscription item @@ -43820,7 +50791,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -43835,7 +50806,7 @@ components: $ref: '#/components/schemas/price' quantity: description: >- - The [quantity](https://stripe.com/docs/subscriptions/quantities) of + The [quantity](https://docs.stripe.com/subscriptions/quantities) of the plan to which the customer should be subscribed. type: integer subscription: @@ -43853,6 +50824,8 @@ components: type: array required: - created + - current_period_end + - current_period_start - discounts - id - metadata @@ -43908,11 +50881,11 @@ components: 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). + requirements](https://docs.stripe.com/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) + Secure](https://docs.stripe.com/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: @@ -43958,7 +50931,7 @@ components: Related guide: [Subscription - schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules) + schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules) properties: application: anyOf: @@ -43972,6 +50945,8 @@ components: oneOf: - $ref: '#/components/schemas/application' - $ref: '#/components/schemas/deleted_application' + billing_mode: + $ref: '#/components/schemas/subscriptions_resource_billing_mode' canceled_at: description: >- Time at which the subscription schedule was canceled. Measured in @@ -44010,6 +50985,11 @@ components: oneOf: - $ref: '#/components/schemas/customer' - $ref: '#/components/schemas/deleted_customer' + customer_account: + description: ID of the account who owns the subscription schedule. + maxLength: 5000 + nullable: true + type: string default_settings: $ref: >- #/components/schemas/subscription_schedules_resource_default_settings @@ -44041,7 +51021,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -44077,7 +51057,7 @@ components: The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior - guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules). + guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules). enum: - active - canceled @@ -44106,6 +51086,7 @@ components: oneOf: - $ref: '#/components/schemas/test_helpers.test_clock' required: + - billing_mode - created - customer - default_settings @@ -44119,6 +51100,7 @@ components: type: object x-expandableFields: - application + - billing_mode - current_phase - customer - default_settings @@ -44134,8 +51116,21 @@ components: discounts: description: The stackable discounts that will be applied to the item. items: - $ref: '#/components/schemas/discounts_resource_stackable_discount' + $ref: >- + #/components/schemas/discounts_resource_stackable_discount_with_discount_end type: array + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://docs.stripe.com/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 + period: + $ref: '#/components/schemas/subscription_schedule_add_invoice_item_period' price: anyOf: - maxLength: 5000 @@ -44161,13 +51156,32 @@ components: type: array required: - discounts + - period - price title: SubscriptionScheduleAddInvoiceItem type: object x-expandableFields: - discounts + - period - price - tax_rates + subscription_schedule_add_invoice_item_period: + description: '' + properties: + end: + $ref: >- + #/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_end + start: + $ref: >- + #/components/schemas/subscription_schedules_resource_invoice_item_period_resource_period_start + required: + - end + - start + title: SubscriptionScheduleAddInvoiceItemPeriod + type: object + x-expandableFields: + - end + - start subscription_schedule_configuration_item: description: A phase item describes the price and quantity of a phase. properties: @@ -44184,14 +51198,14 @@ components: discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. items: - $ref: '#/components/schemas/discounts_resource_stackable_discount' + $ref: '#/components/schemas/stackable_discount_with_discount_settings' type: array metadata: additionalProperties: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. nullable: true @@ -44274,7 +51288,7 @@ components: the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle - [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). enum: - automatic - phase_start @@ -44300,20 +51314,6 @@ components: - send_invoice nullable: true type: string - coupon: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/coupon' - - $ref: '#/components/schemas/deleted_coupon' - description: >- - ID of the coupon to use during this phase of the subscription - schedule. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/coupon' - - $ref: '#/components/schemas/deleted_coupon' currency: description: >- Three-letter [ISO currency @@ -44359,7 +51359,8 @@ components: this phase. Subscription item discounts are applied before subscription discounts. items: - $ref: '#/components/schemas/discounts_resource_stackable_discount' + $ref: >- + #/components/schemas/stackable_discount_with_discount_settings_and_discount_end type: array end_date: description: The end of this phase of the subscription schedule. @@ -44383,7 +51384,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly @@ -44405,8 +51406,9 @@ components: - $ref: '#/components/schemas/account' proration_behavior: description: >- - If the subscription schedule will prorate when transitioning to this - phase. Possible values are `create_prorations` and `none`. + When transitioning phases, controls how prorations are handled (if + any). Possible values are `create_prorations`, `none`, and + `always_invoice`. enum: - always_invoice - create_prorations @@ -44443,7 +51445,6 @@ components: - add_invoice_items - automatic_tax - billing_thresholds - - coupon - default_payment_method - default_tax_rates - discounts @@ -44472,7 +51473,7 @@ components: the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle - [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). enum: - automatic - phase_start @@ -44583,6 +51584,50 @@ components: type: object x-expandableFields: - liability + subscription_schedules_resource_invoice_item_period_resource_period_end: + description: '' + properties: + timestamp: + description: >- + A precise Unix timestamp for the end of the invoice item period. + Must be greater than or equal to `period.start`. + format: unix-time + type: integer + type: + description: Select how to calculate the end of the invoice item period. + enum: + - min_item_period_end + - phase_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodEnd + type: object + x-expandableFields: [] + subscription_schedules_resource_invoice_item_period_resource_period_start: + description: '' + properties: + timestamp: + description: >- + A precise Unix timestamp for the start of the invoice item period. + Must be less than or equal to `period.end`. + format: unix-time + type: integer + type: + description: Select how to calculate the start of the invoice item period. + enum: + - max_item_period_start + - phase_start + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: SubscriptionSchedulesResourceInvoiceItemPeriodResourcePeriodStart + type: object + x-expandableFields: [] subscription_transfer_data: description: '' properties: @@ -44638,6 +51683,47 @@ components: title: SubscriptionsResourceBillingCycleAnchorConfig type: object x-expandableFields: [] + subscriptions_resource_billing_mode: + description: The billing mode of the subscription. + properties: + flexible: + anyOf: + - $ref: >- + #/components/schemas/subscriptions_resource_billing_mode_flexible + description: Configure behavior for flexible billing mode + nullable: true + type: + description: >- + Controls how prorations and invoices for subscriptions are + calculated and orchestrated. + enum: + - classic + - flexible + type: string + updated_at: + description: Details on when the current billing_mode was adopted. + format: unix-time + type: integer + required: + - type + title: SubscriptionsResourceBillingMode + type: object + x-expandableFields: + - flexible + subscriptions_resource_billing_mode_flexible: + description: '' + properties: + proration_discounts: + description: >- + Controls how invoices and invoice items display proration amounts + and discount amounts. + enum: + - included + - itemized + type: string + title: SubscriptionsResourceBillingModeFlexible + type: object + x-expandableFields: [] subscriptions_resource_pause_collection: description: >- The Pause Collection settings determine how we will pause collection for @@ -44654,6 +51740,7 @@ components: - mark_uncollectible - void type: string + x-stripeBypassValidation: true resumes_at: description: >- The time after which the subscription will resume collecting @@ -44706,6 +51793,13 @@ components: This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. nullable: true + payto: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_payto' + description: >- + This sub-hash contains details about the PayTo payment method + options to pass to invoices created by the subscription. + nullable: true sepa_debit: anyOf: - $ref: '#/components/schemas/invoice_payment_method_options_sepa_debit' @@ -44729,6 +51823,7 @@ components: - card - customer_balance - konbini + - payto - sepa_debit - us_bank_account subscriptions_resource_payment_settings: @@ -44755,6 +51850,7 @@ components: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -44762,6 +51858,8 @@ components: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -44770,15 +51868,19 @@ components: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -44848,7 +51950,7 @@ components: subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. nullable: true type: boolean @@ -44886,6 +51988,35 @@ components: x-expandableFields: - account_tax_ids - issuer + subscriptions_resource_trial_settings_end_behavior: + description: Defines how a subscription behaves when a trial ends. + properties: + missing_payment_method: + description: >- + Indicates how the subscription should change when the trial ends if + the user did not provide a payment method. + enum: + - cancel + - create_invoice + - pause + type: string + required: + - missing_payment_method + title: SubscriptionsResourceTrialSettingsEndBehavior + type: object + x-expandableFields: [] + subscriptions_resource_trial_settings_trial_settings: + description: Configures how this subscription behaves during the trial period. + properties: + end_behavior: + $ref: >- + #/components/schemas/subscriptions_resource_trial_settings_end_behavior + required: + - end_behavior + title: SubscriptionsResourceTrialSettingsTrialSettings + type: object + x-expandableFields: + - end_behavior subscriptions_trials_resource_end_behavior: description: Defines how a subscription behaves when a free trial ends. properties: @@ -44914,6 +52045,53 @@ components: type: object x-expandableFields: - end_behavior + tax.association: + description: >- + A Tax Association exposes the Tax Transactions that Stripe attempted to + create on your behalf based on the PaymentIntent input + properties: + calculation: + description: >- + The [Tax + Calculation](https://docs.stripe.com/api/tax/calculations/object) + that was included in PaymentIntent. + maxLength: 5000 + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - tax.association + type: string + payment_intent: + description: >- + The + [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) + that this Tax Association is tracking. + maxLength: 5000 + type: string + tax_transaction_attempts: + description: Information about the tax transactions linked to this payment intent + items: + $ref: >- + #/components/schemas/tax_product_resource_tax_association_transaction_attempts + nullable: true + type: array + required: + - calculation + - id + - object + - payment_intent + title: TaxProductResourceTaxAssociation + type: object + x-expandableFields: + - tax_transaction_attempts + x-resourceId: tax.association tax.calculation: description: >- A Tax Calculation allows you to calculate the tax to collect from your @@ -44921,12 +52099,12 @@ components: Related guide: [Calculate tax in your custom payment - flow](https://stripe.com/docs/tax/custom) + flow](https://docs.stripe.com/tax/custom) properties: amount_total: description: >- Total amount after taxes in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer currency: description: >- @@ -44939,7 +52117,7 @@ components: customer: description: >- The ID of an existing - [Customer](https://stripe.com/docs/api/customers/object) used for + [Customer](https://docs.stripe.com/api/customers/object) used for the resource. maxLength: 5000 nullable: true @@ -45056,14 +52234,14 @@ components: amount: description: >- The line item amount in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). If + unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for this line item, in the [smallest - currency unit](https://stripe.com/docs/currencies#zero-decimal). + currency unit](https://docs.stripe.com/currencies#zero-decimal). type: integer id: description: Unique identifier for the object. @@ -45074,6 +52252,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://docs.stripe.com/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 @@ -45084,7 +52272,7 @@ components: product: description: >- The ID of an existing - [Product](https://stripe.com/docs/api/products/object). + [Product](https://docs.stripe.com/api/products/object). maxLength: 5000 nullable: true type: string @@ -45096,7 +52284,6 @@ components: reference: description: A custom identifier for this line item. maxLength: 5000 - nullable: true type: string tax_behavior: description: >- @@ -45114,7 +52301,7 @@ components: type: array tax_code: description: >- - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. maxLength: 5000 type: string @@ -45125,6 +52312,7 @@ components: - livemode - object - quantity + - reference - tax_behavior - tax_code title: TaxProductResourceTaxCalculationLineItem @@ -45136,17 +52324,17 @@ components: description: >- A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically - collect tax](https://stripe.com/docs/tax). + collect tax](https://docs.stripe.com/tax). Stripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our - guide](https://stripe.com/docs/tax/registering). + guide](https://docs.stripe.com/tax/registering). Related guide: [Using the Registrations - API](https://stripe.com/docs/tax/registrations-api) + API](https://docs.stripe.com/tax/registrations-api) properties: active_from: description: >- @@ -45223,7 +52411,7 @@ components: Related guide: [Using the Settings - API](https://stripe.com/docs/tax/settings-api) + API](https://docs.stripe.com/tax/settings-api) properties: defaults: $ref: '#/components/schemas/tax_product_resource_tax_settings_defaults' @@ -45274,7 +52462,7 @@ components: Related guide: [Calculate tax in your custom payment - flow](https://stripe.com/docs/tax/custom#tax-transaction) + flow](https://docs.stripe.com/tax/custom#tax-transaction) properties: created: description: >- @@ -45293,7 +52481,7 @@ components: customer: description: >- The ID of an existing - [Customer](https://stripe.com/docs/api/customers/object) used for + [Customer](https://docs.stripe.com/api/customers/object) used for the resource. maxLength: 5000 nullable: true @@ -45349,7 +52537,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -45426,14 +52614,14 @@ components: amount: description: >- The line item amount in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). If + unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for this line item, in the [smallest - currency unit](https://stripe.com/docs/currencies#zero-decimal). + currency unit](https://docs.stripe.com/currencies#zero-decimal). type: integer id: description: Unique identifier for the object. @@ -45449,7 +52637,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -45464,7 +52652,7 @@ components: product: description: >- The ID of an existing - [Product](https://stripe.com/docs/api/products/object). + [Product](https://docs.stripe.com/api/products/object). maxLength: 5000 nullable: true type: string @@ -45493,7 +52681,7 @@ components: type: string tax_code: description: >- - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for this resource. maxLength: 5000 type: string @@ -45625,6 +52813,13 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + description: >- + The Account representing the customer being referenced when `type` + is `customer`. + maxLength: 5000 + nullable: true + type: string type: description: Type of owner referenced. enum: @@ -45644,15 +52839,15 @@ components: tax_id: description: >- You can add one or multiple tax IDs to a - [customer](https://stripe.com/docs/api/customers) or account. + [customer](https://docs.stripe.com/api/customers) or account. Customer and account tax IDs get displayed on related invoices and credit notes. Related guides: [Customer tax identification - numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax - IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids) + numbers](https://docs.stripe.com/billing/taxes/tax-ids), [Account tax + IDs](https://docs.stripe.com/invoicing/connect#account-tax-ids) properties: country: description: Two-letter ISO code representing the country of the tax ID. @@ -45675,6 +52870,11 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' + customer_account: + description: ID of the Account representing the customer. + maxLength: 5000 + nullable: true + type: string id: description: Unique identifier for the object. maxLength: 5000 @@ -45699,18 +52899,20 @@ components: type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, `am_tin`, - `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, `bb_tin`, - `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, - `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, - `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, - `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, - `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, - `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, - `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, - `kr_brn`, `kz_bin`, `li_uid`, `li_vat`, `ma_vat`, `md_vat`, - `me_pib`, `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, - `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, - `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, + `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, `az_tin`, + `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, `bh_vat`, + `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, `by_tin`, + `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, + `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, `cl_tin`, `cm_niu`, + `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, `de_stn`, `do_rcn`, + `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, `eu_oss_vat`, `eu_vat`, + `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, `hu_tin`, + `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, + `ke_pin`, `kg_tin`, `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, + `li_uid`, `li_vat`, `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, + `mk_vat`, `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, + `ng_tin`, `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, + `pe_ruc`, `ph_tin`, `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, @@ -45725,10 +52927,15 @@ components: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -45744,14 +52951,17 @@ components: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -45768,11 +52978,14 @@ components: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -45790,6 +53003,7 @@ components: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -45875,7 +53089,7 @@ components: properties: ae: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods al: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default @@ -45889,23 +53103,38 @@ components: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe au: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods + aw: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + az: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified ba: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default bb: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + bd: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default be: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + bf: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default bg: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe bh: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default + bj: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified bs: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default @@ -45920,16 +53149,22 @@ components: #/components/schemas/tax_product_registrations_resource_country_options_default ch: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods cl: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + cm: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified co: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified cr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + cv: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified cy: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -45954,6 +53189,9 @@ components: es: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + et: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default fi: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -45962,7 +53200,7 @@ components: #/components/schemas/tax_product_registrations_resource_country_options_europe gb: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods ge: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -45984,6 +53222,9 @@ components: ie: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe + in: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified is: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default @@ -45992,10 +53233,13 @@ components: #/components/schemas/tax_product_registrations_resource_country_options_europe jp: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods ke: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + kg: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified kh: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -46005,6 +53249,12 @@ components: kz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + la: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified + lk: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified lt: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -46046,19 +53296,22 @@ components: #/components/schemas/tax_product_registrations_resource_country_options_europe 'no': $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods np: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified nz: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods om: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_default pe: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + ph: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified pl: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -46082,7 +53335,7 @@ components: #/components/schemas/tax_product_registrations_resource_country_options_europe sg: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_default + #/components/schemas/tax_product_registrations_resource_country_options_default_inbound_goods si: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_europe @@ -46097,16 +53350,22 @@ components: #/components/schemas/tax_product_registrations_resource_country_options_default th: $ref: >- - #/components/schemas/tax_product_registrations_resource_country_options_simplified + #/components/schemas/tax_product_registrations_resource_country_options_thailand tj: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified tr: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + tw: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified tz: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified + ua: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_simplified ug: $ref: >- #/components/schemas/tax_product_registrations_resource_country_options_simplified @@ -46140,19 +53399,26 @@ components: - ao - at - au + - aw + - az - ba - bb + - bd - be + - bf - bg - bh + - bj - bs - by - ca - cd - ch - cl + - cm - co - cr + - cv - cy - cz - de @@ -46161,6 +53427,7 @@ components: - ee - eg - es + - et - fi - fr - gb @@ -46171,13 +53438,17 @@ components: - hu - id - ie + - in - is - it - jp - ke + - kg - kh - kr - kz + - la + - lk - lt - lu - lv @@ -46196,6 +53467,7 @@ components: - nz - om - pe + - ph - pl - pt - ro @@ -46211,7 +53483,9 @@ components: - th - tj - tr + - tw - tz + - ua - ug - us - uy @@ -46266,12 +53540,44 @@ components: title: TaxProductRegistrationsResourceCountryOptionsDefault type: object x-expandableFields: [] + tax_product_registrations_resource_country_options_default_inbound_goods: + description: '' + properties: + standard: + $ref: >- + #/components/schemas/tax_product_registrations_resource_country_options_default_standard + type: + description: Type of registration in `country`. + enum: + - standard + type: string + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsDefaultInboundGoods + type: object + x-expandableFields: + - standard + tax_product_registrations_resource_country_options_default_standard: + description: '' + properties: + place_of_supply_scheme: + description: Place of supply scheme used in an Default standard registration. + enum: + - inbound_goods + - standard + type: string + required: + - place_of_supply_scheme + title: TaxProductRegistrationsResourceCountryOptionsDefaultStandard + type: object + x-expandableFields: [] tax_product_registrations_resource_country_options_eu_standard: description: '' properties: place_of_supply_scheme: description: Place of supply scheme used in an EU standard registration. enum: + - inbound_goods - small_seller - standard type: string @@ -46313,6 +53619,20 @@ components: title: TaxProductRegistrationsResourceCountryOptionsSimplified type: object x-expandableFields: [] + tax_product_registrations_resource_country_options_thailand: + description: '' + properties: + type: + description: Type of registration in `country`. + enum: + - simplified + type: string + x-stripeBypassValidation: true + required: + - type + title: TaxProductRegistrationsResourceCountryOptionsThailand + type: object + x-expandableFields: [] tax_product_registrations_resource_country_options_united_states: description: '' properties: @@ -46469,17 +53789,19 @@ components: `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, - `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, - `li_uid`, `li_vat`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, - `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, - `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, - `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, - `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `al_tin`, - `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, `ch_uid`, - `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, `ma_vat`, `by_tin`, - `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, `mr_nif`, `me_pib`, - `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, `sr_fin`, `sn_ninea`, - `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, `zm_tin`, `kh_tin`, or + `hk_br`, `es_cif`, `pl_nip`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, + `jp_trn`, `li_uid`, `li_vat`, `lk_vat`, `my_itn`, `us_ein`, + `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, + `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, + `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, + `ph_tin`, `al_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, + `de_stn`, `ch_uid`, `tz_vat`, `uz_vat`, `uz_tin`, `md_vat`, + `ma_vat`, `by_tin`, `ao_tin`, `bs_tin`, `bb_tin`, `cd_nif`, + `mr_nif`, `me_pib`, `zw_tin`, `ba_tin`, `gn_nif`, `mk_vat`, + `sr_fin`, `sn_ninea`, `am_tin`, `np_pan`, `tj_tin`, `ug_tin`, + `zm_tin`, `kh_tin`, `aw_tin`, `az_tin`, `bd_bin`, `bj_ifu`, + `et_tin`, `kg_tin`, `la_tin`, `cm_niu`, `cv_nif`, `bf_ifu`, or `unknown` enum: - ad_nrt @@ -46490,10 +53812,15 @@ components: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -46509,14 +53836,17 @@ components: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -46533,11 +53863,14 @@ components: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -46555,6 +53888,7 @@ components: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -46619,7 +53953,7 @@ components: state: description: >- [ISO 3166-2 subdivision - code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country + code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. maxLength: 5000 nullable: true @@ -46637,7 +53971,7 @@ components: amount: description: >- The amount of tax, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer jurisdiction: $ref: '#/components/schemas/tax_product_resource_jurisdiction' @@ -46649,6 +53983,7 @@ components: - destination - origin type: string + x-stripeBypassValidation: true tax_rate_details: anyOf: - $ref: >- @@ -46683,7 +54018,7 @@ components: taxable_amount: description: >- The amount on which tax is calculated, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer required: - amount @@ -46753,12 +54088,12 @@ components: maxLength: 5000 type: string line1: - description: 'Address line 1 (e.g., street, PO Box, or company name).' + description: 'Address line 1, such as the street, PO Box, or company name.' maxLength: 5000 nullable: true type: string line2: - description: 'Address line 2 (e.g., apartment, suite, unit, or building).' + description: 'Address line 2, such as the apartment, suite, unit, or building.' maxLength: 5000 nullable: true type: string @@ -46771,7 +54106,7 @@ components: description: >- State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, - without country prefix. Example: "NY" or "TX". + without country prefix, such as "NY" or "TX". maxLength: 5000 nullable: true type: string @@ -46791,13 +54126,73 @@ components: type: object x-expandableFields: - address + tax_product_resource_tax_association_transaction_attempts: + description: '' + properties: + committed: + $ref: >- + #/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_committed + errored: + $ref: >- + #/components/schemas/tax_product_resource_tax_association_transaction_attempts_resource_errored + source: + description: >- + The source of the tax transaction attempt. This is either a refund + or a payment intent. + maxLength: 5000 + type: string + status: + description: >- + The status of the transaction attempt. This can be `errored` or + `committed`. + maxLength: 5000 + type: string + required: + - source + - status + title: TaxProductResourceTaxAssociationTransactionAttempts + type: object + x-expandableFields: + - committed + - errored + tax_product_resource_tax_association_transaction_attempts_resource_committed: + description: '' + properties: + transaction: + description: >- + The [Tax + Transaction](https://docs.stripe.com/api/tax/transaction/object) + maxLength: 5000 + type: string + required: + - transaction + title: TaxProductResourceTaxAssociationTransactionAttemptsResourceCommitted + type: object + x-expandableFields: [] + tax_product_resource_tax_association_transaction_attempts_resource_errored: + description: '' + properties: + reason: + description: Details on why we couldn't commit the tax transaction. + enum: + - another_payment_associated_with_calculation + - calculation_expired + - currency_mismatch + - original_transaction_voided + - unique_reference_violation + type: string + required: + - reason + title: TaxProductResourceTaxAssociationTransactionAttemptsResourceErrored + type: object + x-expandableFields: [] tax_product_resource_tax_breakdown: description: '' properties: amount: description: >- The amount of tax, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer inclusive: description: >- @@ -46831,7 +54226,7 @@ components: taxable_amount: description: >- The amount on which tax is calculated, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer required: - amount @@ -46849,19 +54244,19 @@ components: amount: description: >- The shipping amount in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). If + unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for shipping, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer shipping_rate: description: >- The ID of an existing - [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). + [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). maxLength: 5000 type: string tax_behavior: @@ -46879,7 +54274,7 @@ components: type: array tax_code: description: >- - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. maxLength: 5000 type: string @@ -46920,14 +54315,17 @@ components: 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. + value can be `null` when no tax applies to the location. This field + is only present for TaxRates created by Stripe Tax. enum: - flat_amount - percentage nullable: true type: string state: - description: 'State, county, province, or region.' + description: >- + State, county, province, or region ([ISO + 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)). maxLength: 5000 nullable: true type: string @@ -46960,6 +54358,16 @@ components: tax_product_resource_tax_settings_defaults: description: '' properties: + provider: + description: >- + The tax calculation provider this account uses. Defaults to `stripe` + when not using a [third-party provider](/tax/third-party-apps). + enum: + - anrok + - avalara + - sphere + - stripe + type: string tax_behavior: description: >- Default [tax @@ -46980,6 +54388,8 @@ components: maxLength: 5000 nullable: true type: string + required: + - provider title: TaxProductResourceTaxSettingsDefaults type: object x-expandableFields: [] @@ -47061,19 +54471,19 @@ components: amount: description: >- The shipping amount in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). If + unit](https://docs.stripe.com/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: description: >- The amount of tax calculated for shipping, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer shipping_rate: description: >- The ID of an existing - [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). + [ShippingRate](https://docs.stripe.com/api/shipping_rates/object). maxLength: 5000 type: string tax_behavior: @@ -47086,7 +54496,7 @@ components: type: string tax_code: description: >- - The [tax code](https://stripe.com/docs/tax/tax-categories) ID used + The [tax code](https://docs.stripe.com/tax/tax-categories) ID used for shipping. maxLength: 5000 type: string @@ -47100,16 +54510,12 @@ components: x-expandableFields: [] tax_rate: description: >- - Tax rates can be applied to - [invoices](https://stripe.com/docs/billing/invoices/tax-rates), - [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and - [Checkout - Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) - to collect tax. + Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), + [subscriptions](/billing/taxes/tax-rates) and [Checkout + Sessions](/payments/checkout/use-manual-tax-rates) to collect tax. - Related guide: [Tax - rates](https://stripe.com/docs/billing/taxes/tax-rates) + Related guide: [Tax rates](/billing/taxes/tax-rates) properties: active: description: >- @@ -47201,7 +54607,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -47222,7 +54628,8 @@ components: 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. + value can be `null` when no tax applies to the location. This field + is only present for TaxRates created by Stripe Tax. enum: - flat_amount - percentage @@ -47231,7 +54638,7 @@ components: state: description: >- [ISO 3166-2 subdivision - code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country + code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. maxLength: 5000 nullable: true @@ -47300,10 +54707,19 @@ components: description: >- A Configurations object represents how features should be configured for terminal readers. + + For information about how to use it, see the [Terminal configurations + documentation](https://docs.stripe.com/terminal/fleet/configurations-overview). properties: + bbpos_wisepad3: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config bbpos_wisepos_e: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config + cellular: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_cellular_config id: description: Unique identifier for the object. maxLength: 5000 @@ -47340,12 +54756,18 @@ components: stripe_s700: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config + stripe_s710: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config tipping: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_tipping verifone_p400: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config + wifi: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_wifi_config required: - id - livemode @@ -47353,12 +54775,16 @@ components: title: TerminalConfigurationConfiguration type: object x-expandableFields: + - bbpos_wisepad3 - bbpos_wisepos_e + - cellular - offline - reboot_window - stripe_s700 + - stripe_s710 - tipping - verifone_p400 + - wifi x-resourceId: terminal.configuration terminal.connection_token: description: >- @@ -47367,7 +54793,7 @@ components: Related guide: [Fleet - management](https://stripe.com/docs/terminal/fleet/locations) + management](https://docs.stripe.com/terminal/fleet/locations) properties: location: description: >- @@ -47401,10 +54827,14 @@ components: Related guide: [Fleet - management](https://stripe.com/docs/terminal/fleet/locations) + management](https://docs.stripe.com/terminal/fleet/locations) properties: address: $ref: '#/components/schemas/address' + address_kana: + $ref: '#/components/schemas/legal_entity_japan_address' + address_kanji: + $ref: '#/components/schemas/legal_entity_japan_address' configuration_overrides: description: >- The ID of a configuration that will be used to customize all readers @@ -47415,6 +54845,14 @@ components: description: The display name of the location. maxLength: 5000 type: string + display_name_kana: + description: The Kana variation of the display name of the location. + maxLength: 5000 + type: string + display_name_kanji: + description: The Kanji variation of the display name of the location. + maxLength: 5000 + type: string id: description: Unique identifier for the object. maxLength: 5000 @@ -47429,7 +54867,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -47440,6 +54878,10 @@ components: enum: - terminal.location type: string + phone: + description: The phone number of the location. + maxLength: 5000 + type: string required: - address - display_name @@ -47451,14 +54893,49 @@ components: type: object x-expandableFields: - address + - address_kana + - address_kanji x-resourceId: terminal.location + terminal.onboarding_link: + description: Returns redirect links used for onboarding onto Tap to Pay on iPhone. + properties: + link_options: + $ref: '#/components/schemas/terminal_onboarding_link_link_options' + link_type: + description: The type of link being generated. + enum: + - apple_terms_and_conditions + type: string + object: + enum: + - terminal.onboarding_link + type: string + on_behalf_of: + description: Stripe account ID to generate the link for. + maxLength: 5000 + nullable: true + type: string + redirect_url: + description: The link passed back to the user for their onboarding. + maxLength: 5000 + type: string + required: + - link_options + - link_type + - object + - redirect_url + title: TerminalOnboardingLinkOnboardingLink + type: object + x-expandableFields: + - link_options + x-resourceId: terminal.onboarding_link terminal.reader: description: >- A Reader represents a physical device for accepting payment details. Related guide: [Connecting to a - reader](https://stripe.com/docs/terminal/payments/connect-reader) + reader](https://docs.stripe.com/terminal/payments/connect-reader) properties: action: anyOf: @@ -47472,20 +54949,21 @@ components: nullable: true type: string device_type: - description: >- - Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `stripe_s700`, - `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, - `simulated_wisepos_e`, or `mobile_phone_reader`. + description: Device type of the reader. enum: - bbpos_chipper2x - bbpos_wisepad3 - bbpos_wisepos_e - mobile_phone_reader + - simulated_stripe_s700 + - simulated_stripe_s710 - simulated_wisepos_e - stripe_m2 - stripe_s700 + - stripe_s710 - verifone_P400 type: string + x-stripeBypassValidation: true id: description: Unique identifier for the object. maxLength: 5000 @@ -47499,6 +54977,15 @@ components: description: Custom label given to the reader for easier identification. maxLength: 5000 type: string + last_seen_at: + description: >- + The last time this reader reported to Stripe backend. Timestamp is + measured in milliseconds since the Unix epoch. Unlike most other + Stripe timestamp fields which use seconds, this field uses + milliseconds. + format: unix-time + nullable: true + type: integer livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -47519,7 +55006,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -47557,6 +55044,26 @@ components: - action - location x-resourceId: terminal.reader + terminal.refund: + description: A Refund object returned by the Terminal refunds API. + properties: {} + title: TerminalRefundsRefund + type: object + x-expandableFields: [] + x-resourceId: terminal.refund + terminal_configuration_configuration_resource_cellular_config: + description: '' + properties: + enabled: + description: >- + Whether a cellular-capable reader can connect to the internet over + cellular. + type: boolean + required: + - enabled + title: TerminalConfigurationConfigurationResourceCellularConfig + type: object + x-expandableFields: [] terminal_configuration_configuration_resource_currency_specific_config: description: '' properties: @@ -47588,9 +55095,7 @@ components: - maxLength: 5000 type: string - $ref: '#/components/schemas/file' - description: >- - A File ID representing an image you would like displayed on the - reader. + description: A File ID representing an image to display on the reader x-expansionResources: oneOf: - $ref: '#/components/schemas/file' @@ -47598,6 +55103,64 @@ components: type: object x-expandableFields: - splashscreen + terminal_configuration_configuration_resource_enterprise_peap_wifi: + description: '' + properties: + ca_certificate_file: + description: A File ID representing a PEM file containing the server certificate + maxLength: 5000 + type: string + password: + description: Password for connecting to the WiFi network + maxLength: 5000 + type: string + ssid: + description: Name of the WiFi network + maxLength: 5000 + type: string + username: + description: Username for connecting to the WiFi network + maxLength: 5000 + type: string + required: + - password + - ssid + - username + title: TerminalConfigurationConfigurationResourceEnterprisePEAPWifi + type: object + x-expandableFields: [] + terminal_configuration_configuration_resource_enterprise_tls_wifi: + description: '' + properties: + ca_certificate_file: + description: A File ID representing a PEM file containing the server certificate + maxLength: 5000 + type: string + client_certificate_file: + description: A File ID representing a PEM file containing the client certificate + maxLength: 5000 + type: string + private_key_file: + description: >- + A File ID representing a PEM file containing the client RSA private + key + maxLength: 5000 + type: string + private_key_file_password: + description: Password for the private key file + maxLength: 5000 + type: string + ssid: + description: Name of the WiFi network + maxLength: 5000 + type: string + required: + - client_certificate_file + - private_key_file + - ssid + title: TerminalConfigurationConfigurationResourceEnterpriseTLSWifi + type: object + x-expandableFields: [] terminal_configuration_configuration_resource_offline_config: description: '' properties: @@ -47610,6 +55173,23 @@ components: title: TerminalConfigurationConfigurationResourceOfflineConfig type: object x-expandableFields: [] + terminal_configuration_configuration_resource_personal_psk_wifi: + description: '' + properties: + password: + description: Password for connecting to the WiFi network + maxLength: 5000 + type: string + ssid: + description: Name of the WiFi network + maxLength: 5000 + type: string + required: + - password + - ssid + title: TerminalConfigurationConfigurationResourcePersonalPSKWifi + type: object + x-expandableFields: [] terminal_configuration_configuration_resource_reboot_window: description: '' properties: @@ -47632,6 +55212,9 @@ components: terminal_configuration_configuration_resource_tipping: description: '' properties: + aed: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config aud: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config @@ -47653,12 +55236,21 @@ components: gbp: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config + gip: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config hkd: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config + huf: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config jpy: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config + mxn: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config myr: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config @@ -47671,6 +55263,9 @@ components: pln: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config + ron: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config sek: $ref: >- #/components/schemas/terminal_configuration_configuration_resource_currency_specific_config @@ -47683,6 +55278,7 @@ components: title: TerminalConfigurationConfigurationResourceTipping type: object x-expandableFields: + - aed - aud - cad - chf @@ -47690,15 +55286,83 @@ components: - dkk - eur - gbp + - gip - hkd + - huf - jpy + - mxn - myr - nok - nzd - pln + - ron - sek - sgd - usd + terminal_configuration_configuration_resource_wifi_config: + description: '' + properties: + enterprise_eap_peap: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_enterprise_peap_wifi + enterprise_eap_tls: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_enterprise_tls_wifi + personal_psk: + $ref: >- + #/components/schemas/terminal_configuration_configuration_resource_personal_psk_wifi + type: + description: >- + Security type of the WiFi network. The hash with the corresponding + name contains the credentials for this security type. + enum: + - enterprise_eap_peap + - enterprise_eap_tls + - personal_psk + type: string + required: + - type + title: TerminalConfigurationConfigurationResourceWifiConfig + type: object + x-expandableFields: + - enterprise_eap_peap + - enterprise_eap_tls + - personal_psk + terminal_onboarding_link_apple_terms_and_conditions: + description: Options associated with the Apple Terms and Conditions link type. + properties: + allow_relinking: + description: >- + Whether the link should also support users relinking their Apple + account. + nullable: true + type: boolean + merchant_display_name: + description: >- + The business name of the merchant accepting Apple's Terms and + Conditions. + maxLength: 5000 + type: string + required: + - merchant_display_name + title: TerminalOnboardingLinkAppleTermsAndConditions + type: object + x-expandableFields: [] + terminal_onboarding_link_link_options: + description: Link type options associated with the current onboarding link object. + properties: + apple_terms_and_conditions: + anyOf: + - $ref: >- + #/components/schemas/terminal_onboarding_link_apple_terms_and_conditions + description: >- + The options associated with the Apple Terms and Conditions link + type. + nullable: true + title: TerminalOnboardingLinkLinkOptions + type: object + x-expandableFields: + - apple_terms_and_conditions terminal_reader_reader_resource_cart: description: Represents a cart to be displayed on the reader properties: @@ -47718,14 +55382,14 @@ components: tax: description: >- Tax amount for the entire cart. A positive integer in the [smallest - currency unit](https://stripe.com/docs/currencies#zero-decimal). + currency unit](https://docs.stripe.com/currencies#zero-decimal). nullable: true type: integer total: description: >- Total amount for the entire cart, including tax. A positive integer in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer required: - currency @@ -47735,13 +55399,230 @@ components: type: object x-expandableFields: - line_items + terminal_reader_reader_resource_choice: + description: Choice to be selected on a Reader + properties: + id: + description: The identifier for the selected choice. Maximum 50 characters. + maxLength: 5000 + nullable: true + type: string + style: + description: The button style for the choice. Can be `primary` or `secondary`. + enum: + - primary + - secondary + nullable: true + type: string + text: + description: The text to be selected. Maximum 30 characters. + maxLength: 5000 + type: string + required: + - text + title: TerminalReaderReaderResourceChoice + type: object + x-expandableFields: [] + terminal_reader_reader_resource_collect_config: + description: Represents a per-transaction override of a reader configuration + properties: + enable_customer_cancellation: + description: Enable customer-initiated cancellation when processing this payment. + type: boolean + skip_tipping: + description: Override showing a tipping selection screen on this transaction. + type: boolean + tipping: + $ref: '#/components/schemas/terminal_reader_reader_resource_tipping_config' + title: TerminalReaderReaderResourceCollectConfig + type: object + x-expandableFields: + - tipping + terminal_reader_reader_resource_collect_inputs_action: + description: Represents a reader action to collect customer inputs + properties: + inputs: + description: List of inputs to be collected. + items: + $ref: '#/components/schemas/terminal_reader_reader_resource_input' + type: array + metadata: + additionalProperties: + maxLength: 500 + type: string + description: >- + Set of [key-value pairs](https://docs.stripe.com/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 + required: + - inputs + title: TerminalReaderReaderResourceCollectInputsAction + type: object + x-expandableFields: + - inputs + terminal_reader_reader_resource_collect_payment_method_action: + description: Represents a reader action to collect a payment method + properties: + collect_config: + $ref: '#/components/schemas/terminal_reader_reader_resource_collect_config' + payment_intent: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_intent' + description: Most recent PaymentIntent processed by the reader. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_intent' + payment_method: + $ref: '#/components/schemas/payment_method' + required: + - payment_intent + title: TerminalReaderReaderResourceCollectPaymentMethodAction + type: object + x-expandableFields: + - collect_config + - payment_intent + - payment_method + terminal_reader_reader_resource_confirm_config: + description: Represents a per-transaction override of a reader configuration + properties: + return_url: + description: >- + If the customer doesn't abandon authenticating the payment, they're + redirected to this URL after completion. + maxLength: 5000 + type: string + title: TerminalReaderReaderResourceConfirmConfig + type: object + x-expandableFields: [] + terminal_reader_reader_resource_confirm_payment_intent_action: + description: Represents a reader action to confirm a payment + properties: + confirm_config: + $ref: '#/components/schemas/terminal_reader_reader_resource_confirm_config' + payment_intent: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_intent' + description: Most recent PaymentIntent processed by the reader. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_intent' + required: + - payment_intent + title: TerminalReaderReaderResourceConfirmPaymentIntentAction + type: object + x-expandableFields: + - confirm_config + - payment_intent + terminal_reader_reader_resource_custom_text: + description: >- + Represents custom text to be displayed when collecting the input using a + reader + properties: + description: + description: Customize the default description for this input + maxLength: 5000 + nullable: true + type: string + skip_button: + description: Customize the default label for this input's skip button + maxLength: 5000 + nullable: true + type: string + submit_button: + description: Customize the default label for this input's submit button + maxLength: 5000 + nullable: true + type: string + title: + description: Customize the default title for this input + maxLength: 5000 + nullable: true + type: string + title: TerminalReaderReaderResourceCustomText + type: object + x-expandableFields: [] + terminal_reader_reader_resource_email: + description: Information about a email being collected using a reader + properties: + value: + description: The collected email address + maxLength: 5000 + nullable: true + type: string + title: TerminalReaderReaderResourceEmail + type: object + x-expandableFields: [] + terminal_reader_reader_resource_input: + description: Represents an input to be collected using the reader + properties: + custom_text: + anyOf: + - $ref: '#/components/schemas/terminal_reader_reader_resource_custom_text' + description: Default text of input being collected. + nullable: true + email: + $ref: '#/components/schemas/terminal_reader_reader_resource_email' + numeric: + $ref: '#/components/schemas/terminal_reader_reader_resource_numeric' + phone: + $ref: '#/components/schemas/terminal_reader_reader_resource_phone' + required: + description: 'Indicate that this input is required, disabling the skip button.' + nullable: true + type: boolean + selection: + $ref: '#/components/schemas/terminal_reader_reader_resource_selection' + signature: + $ref: '#/components/schemas/terminal_reader_reader_resource_signature' + skipped: + description: Indicate that this input was skipped by the user. + type: boolean + text: + $ref: '#/components/schemas/terminal_reader_reader_resource_text' + toggles: + description: >- + List of toggles being collected. Values are present if collection is + complete. + items: + $ref: '#/components/schemas/terminal_reader_reader_resource_toggle' + nullable: true + type: array + type: + description: Type of input being collected. + enum: + - email + - numeric + - phone + - selection + - signature + - text + type: string + required: + - type + title: TerminalReaderReaderResourceInput + type: object + x-expandableFields: + - custom_text + - email + - numeric + - phone + - selection + - signature + - text + - toggles terminal_reader_reader_resource_line_item: description: Represents a line item to be displayed on the reader properties: amount: description: >- The amount of the line item. A positive integer in the [smallest - currency unit](https://stripe.com/docs/currencies#zero-decimal). + currency unit](https://docs.stripe.com/currencies#zero-decimal). type: integer description: description: Description of the line item. @@ -47757,12 +55638,40 @@ components: title: TerminalReaderReaderResourceLineItem type: object x-expandableFields: [] + terminal_reader_reader_resource_numeric: + description: Information about a number being collected using a reader + properties: + value: + description: The collected number + maxLength: 5000 + nullable: true + type: string + title: TerminalReaderReaderResourceNumeric + type: object + x-expandableFields: [] + terminal_reader_reader_resource_phone: + description: Information about a phone number being collected using a reader + properties: + value: + description: The collected phone number + maxLength: 5000 + nullable: true + type: string + title: TerminalReaderReaderResourcePhone + type: object + x-expandableFields: [] terminal_reader_reader_resource_process_config: description: Represents a per-transaction override of a reader configuration properties: enable_customer_cancellation: - description: Enable customer initiated cancellation when processing this payment. + description: Enable customer-initiated cancellation when processing this payment. type: boolean + return_url: + description: >- + If the customer doesn't abandon authenticating the payment, they're + redirected to this URL after completion. + maxLength: 5000 + type: string skip_tipping: description: Override showing a tipping selection screen on this transaction. type: boolean @@ -47798,7 +55707,7 @@ components: properties: enable_customer_cancellation: description: >- - Enable customer initiated cancellation when processing this + Enable customer-initiated cancellation when processing this SetupIntent. type: boolean title: TerminalReaderReaderResourceProcessSetupConfig @@ -47837,6 +55746,15 @@ components: terminal_reader_reader_resource_reader_action: description: Represents an action performed by the reader properties: + collect_inputs: + $ref: >- + #/components/schemas/terminal_reader_reader_resource_collect_inputs_action + collect_payment_method: + $ref: >- + #/components/schemas/terminal_reader_reader_resource_collect_payment_method_action + confirm_payment_intent: + $ref: >- + #/components/schemas/terminal_reader_reader_resource_confirm_payment_intent_action failure_code: description: 'Failure code, only set if status is `failed`.' maxLength: 5000 @@ -47869,6 +55787,9 @@ components: type: description: Type of action performed by the reader. enum: + - collect_inputs + - collect_payment_method + - confirm_payment_intent - process_payment_intent - process_setup_intent - refund_payment @@ -47881,6 +55802,9 @@ components: title: TerminalReaderReaderResourceReaderAction type: object x-expandableFields: + - collect_inputs + - collect_payment_method + - confirm_payment_intent - process_payment_intent - process_setup_intent - refund_payment @@ -47905,7 +55829,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -47965,21 +55889,49 @@ components: description: Represents a per-transaction override of a reader configuration properties: enable_customer_cancellation: - description: Enable customer initiated cancellation when refunding this payment. + description: Enable customer-initiated cancellation when refunding this payment. type: boolean title: TerminalReaderReaderResourceRefundPaymentConfig type: object x-expandableFields: [] + terminal_reader_reader_resource_selection: + description: Information about a selection being collected using a reader + properties: + choices: + description: List of possible choices to be selected + items: + $ref: '#/components/schemas/terminal_reader_reader_resource_choice' + type: array + id: + description: The id of the selected choice + maxLength: 5000 + nullable: true + type: string + text: + description: The text of the selected choice + maxLength: 5000 + nullable: true + type: string + required: + - choices + title: TerminalReaderReaderResourceSelection + type: object + x-expandableFields: + - choices terminal_reader_reader_resource_set_reader_display_action: description: Represents a reader action to set the reader display properties: cart: anyOf: - $ref: '#/components/schemas/terminal_reader_reader_resource_cart' - description: Cart object to be displayed by the reader. + description: >- + Cart object to be displayed by the reader, including line items, + amounts, and currency. nullable: true type: - description: Type of information to be displayed by the reader. + description: >- + Type of information to be displayed by the reader. Only `cart` is + currently supported. enum: - cart type: string @@ -47989,6 +55941,28 @@ components: type: object x-expandableFields: - cart + terminal_reader_reader_resource_signature: + description: Information about a signature being collected using a reader + properties: + value: + description: The File ID of a collected signature image + maxLength: 5000 + nullable: true + type: string + title: TerminalReaderReaderResourceSignature + type: object + x-expandableFields: [] + terminal_reader_reader_resource_text: + description: Information about text being collected using a reader + properties: + value: + description: The collected text value + maxLength: 5000 + nullable: true + type: string + title: TerminalReaderReaderResourceText + type: object + x-expandableFields: [] terminal_reader_reader_resource_tipping_config: description: Represents a per-transaction tipping configuration properties: @@ -48002,6 +55976,36 @@ components: title: TerminalReaderReaderResourceTippingConfig type: object x-expandableFields: [] + terminal_reader_reader_resource_toggle: + description: Information about an input's toggle + properties: + default_value: + description: The toggle's default value. Can be `enabled` or `disabled`. + enum: + - disabled + - enabled + nullable: true + type: string + description: + description: The toggle's description text. Maximum 50 characters. + maxLength: 5000 + nullable: true + type: string + title: + description: The toggle's title text. Maximum 50 characters. + maxLength: 5000 + nullable: true + type: string + value: + description: The toggle's collected value. Can be `enabled` or `disabled`. + enum: + - disabled + - enabled + nullable: true + type: string + title: TerminalReaderReaderResourceToggle + type: object + x-expandableFields: [] test_helpers.test_clock: description: >- A test clock enables deterministic control over objects in testmode. @@ -48139,6 +56143,8 @@ components: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 nullable: true type: string x-stripeBypassValidation: true @@ -48226,6 +56232,8 @@ components: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 nullable: true type: string x-stripeBypassValidation: true @@ -48319,7 +56327,7 @@ components: returned to your server to use. Use our - [recommended payments integrations](https://stripe.com/docs/payments) to + [recommended payments integrations](https://docs.stripe.com/payments) to perform this process on the client-side. This guarantees that no sensitive card data touches @@ -48349,11 +56357,11 @@ components: account information for later use, create - [Customer](https://stripe.com/docs/api#customers) + [Customer](https://docs.stripe.com/api#customers) objects or [External accounts](/api#external_accounts). - [Radar](https://stripe.com/docs/radar), our integrated solution for + [Radar](https://docs.stripe.com/radar), our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization. @@ -48437,7 +56445,7 @@ components: Related guide: [Topping up your platform - account](https://stripe.com/docs/connect/top-ups) + account](https://docs.stripe.com/connect/top-ups) properties: amount: description: Amount transferred. @@ -48486,7 +56494,7 @@ components: failure_code: description: >- Error code explaining reason for top-up failure if available (see - [the errors section](https://stripe.com/docs/api#errors) for a list + [the errors section](https://docs.stripe.com/api#errors) for a list of codes). maxLength: 5000 nullable: true @@ -48512,7 +56520,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -48582,16 +56590,16 @@ components: Stripe account to a card or bank account. This behavior has since been split - out into a [Payout](https://stripe.com/docs/api#payout_object) object, - with corresponding payout endpoints. For more + out into a [Payout](https://api.stripe.com#payout_object) object, with + corresponding payout endpoints. For more information, read about the - [transfer/payout split](https://stripe.com/docs/transfer-payout-split). + [transfer/payout split](https://docs.stripe.com/transfer-payout-split). Related guide: [Creating separate charges and - transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) + transfers](https://docs.stripe.com/connect/separate-charges-and-transfers) properties: amount: description: Amount in cents (or local equivalent) to be transferred. @@ -48667,7 +56675,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -48738,7 +56746,7 @@ components: description: >- A string that identifies this transaction as part of a group. See the [Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. maxLength: 5000 nullable: true @@ -48768,21 +56776,19 @@ components: properties: amount: description: >- - Amount intended to be collected by this PaymentIntent. A positive - integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 - cents to charge $1.00 or 100 to charge ¥100, a zero-decimal - currency). The minimum amount is $0.50 US or [equivalent in charge - currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). - The amount value supports up to eight digits (e.g., a value of - 99999999 for a USD charge of $999,999.99). + The amount transferred to the destination account. This transfer + will occur automatically after the payment succeeds. If no amount is + specified, by default the entire payment amount is transferred to + the destination account. + The amount must be less than or equal to the [amount](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer + representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00). type: integer destination: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/account' - description: |- + description: >- The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success. @@ -48797,7 +56803,7 @@ components: - destination transfer_reversal: description: >- - [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse + [Stripe Connect](https://docs.stripe.com/connect) platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify @@ -48815,7 +56821,7 @@ components: the charge. It is possible to reverse a - [transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + [transfer_group](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) transfer only if the destination account has enough balance to cover the @@ -48823,7 +56829,7 @@ components: Related guide: [Reverse - transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers) + transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#reverse-transfers) properties: amount: description: 'Amount, in cents (or local equivalent).' @@ -48873,7 +56879,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -48939,12 +56945,35 @@ components: `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months. type: integer + monthly_payout_days: + description: >- + The days of the month funds will be paid out. Only shown if + `interval` is monthly. Payouts scheduled between the 29th and 31st + of the month are sent on the last day of shorter months. + items: + type: integer + type: array weekly_anchor: description: >- The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly. maxLength: 5000 type: string + weekly_payout_days: + description: >- + The days of the week when available funds are paid out, specified as + an array, for example, [`monday`, `tuesday`]. Only shown if + `interval` is weekly. + items: + enum: + - friday + - monday + - thursday + - tuesday + - wednesday + type: string + x-stripeBypassValidation: true + type: array required: - delay_days - interval @@ -48990,9 +57019,9 @@ components: treasury.credit_reversal: description: >- You can reverse some - [ReceivedCredits](https://stripe.com/docs/api#received_credits) - depending on their network and source flow. Reversing a ReceivedCredit - leads to the creation of a new object known as a CreditReversal. + [ReceivedCredits](https://api.stripe.com#received_credits) depending on + their network and source flow. Reversing a ReceivedCredit leads to the + creation of a new object known as a CreditReversal. properties: amount: description: Amount (in cents) transferred. @@ -49018,7 +57047,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -49038,7 +57067,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -49101,8 +57130,8 @@ components: treasury.debit_reversal: description: >- You can reverse some - [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending - on their network and source flow. Reversing a ReceivedDebit leads to the + [ReceivedDebits](https://api.stripe.com#received_debits) depending on + their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal. properties: amount: @@ -49130,7 +57159,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -49156,7 +57185,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -49280,7 +57309,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -49433,7 +57462,7 @@ components: Use [InboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your - [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a + [FinancialAccount](https://api.stripe.com#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. @@ -49483,7 +57512,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -49506,7 +57535,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -49594,9 +57623,9 @@ components: Use [OutboundPayments](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-payments) to send funds to another party's external bank account or - [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To - send money to an account belonging to the same user, use an - [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers). + [FinancialAccount](https://api.stripe.com#financial_accounts). To send + money to an account belonging to the same user, use an + [OutboundTransfer](https://api.stripe.com#outbound_transfers). Simulate OutboundPayment state changes with the @@ -49629,7 +57658,7 @@ components: type: string customer: description: >- - ID of the [customer](https://stripe.com/docs/api/customers) to whom + ID of the [customer](https://docs.stripe.com/api/customers) to whom an OutboundPayment is sent. maxLength: 5000 nullable: true @@ -49673,7 +57702,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -49693,7 +57722,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -49783,10 +57812,9 @@ components: Use [OutboundTransfers](https://docs.stripe.com/docs/treasury/moving-money/financial-accounts/out-of/outbound-transfers) to transfer funds from a - [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a + [FinancialAccount](https://api.stripe.com#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different - party, use - [OutboundPayments](https://stripe.com/docs/api#outbound_payments) + party, use [OutboundPayments](https://api.stripe.com#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. @@ -49848,7 +57876,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -49868,7 +57896,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -49955,7 +57983,7 @@ components: treasury.received_credit: description: >- ReceivedCredits represent funds sent to a - [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for + [FinancialAccount](https://api.stripe.com#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount. properties: @@ -50002,7 +58030,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -50088,8 +58116,8 @@ components: treasury.received_debit: description: >- ReceivedDebits represent funds pulled from a - [FinancialAccount](https://stripe.com/docs/api#financial_accounts). - These are not initiated from the FinancialAccount. + [FinancialAccount](https://api.stripe.com#financial_accounts). These are + not initiated from the FinancialAccount. properties: amount: description: Amount (in cents) transferred. @@ -50135,7 +58163,7 @@ components: hosted_regulatory_receipt_url: description: >- A [hosted transaction - receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) + receipt](https://docs.stripe.com/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. maxLength: 5000 @@ -50218,8 +58246,7 @@ components: treasury.transaction: description: >- Transactions represent changes to a - [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) - balance. + [FinancialAccount's](https://api.stripe.com#financial_accounts) balance. properties: amount: description: Amount (in cents) transferred. @@ -50310,6 +58337,7 @@ components: - received_credit - received_debit type: string + x-stripeBypassValidation: true id: description: Unique identifier for the object. maxLength: 5000 @@ -50360,7 +58388,7 @@ components: treasury.transaction_entry: description: >- TransactionEntries represent individual units of money movements within - a single [Transaction](https://stripe.com/docs/api#transactions). + a single [Transaction](https://api.stripe.com#transactions). properties: balance_impact: $ref: '#/components/schemas/treasury_transactions_resource_balance_impact' @@ -50411,6 +58439,7 @@ components: - received_credit - received_debit type: string + x-stripeBypassValidation: true id: description: Unique identifier for the object. maxLength: 5000 @@ -51187,7 +59216,7 @@ components: issuing_authorization: description: >- Set if the ReceivedCredit was created due to an [Issuing - Authorization](https://stripe.com/docs/api#issuing_authorizations) + Authorization](https://api.stripe.com#issuing_authorizations) object. maxLength: 5000 nullable: true @@ -51195,8 +59224,7 @@ components: issuing_transaction: description: >- Set if the ReceivedCredit is also viewable as an [Issuing - transaction](https://stripe.com/docs/api#issuing_transactions) - object. + transaction](https://api.stripe.com#issuing_transactions) object. maxLength: 5000 nullable: true type: string @@ -51321,7 +59349,7 @@ components: issuing_authorization: description: >- Set if the ReceivedDebit was created due to an [Issuing - Authorization](https://stripe.com/docs/api#issuing_authorizations) + Authorization](https://api.stripe.com#issuing_authorizations) object. maxLength: 5000 nullable: true @@ -51329,14 +59357,21 @@ components: issuing_transaction: description: >- Set if the ReceivedDebit is also viewable as an [Issuing - Dispute](https://stripe.com/docs/api#issuing_disputes) object. + Dispute](https://api.stripe.com#issuing_disputes) object. maxLength: 5000 nullable: true type: string payout: description: >- Set if the ReceivedDebit was created due to a - [Payout](https://stripe.com/docs/api#payouts) object. + [Payout](https://api.stripe.com#payouts) object. + maxLength: 5000 + nullable: true + type: string + topup: + description: >- + Set if the ReceivedDebit was created due to a + [Topup](https://api.stripe.com#topups) object. maxLength: 5000 nullable: true type: string @@ -51414,7 +59449,7 @@ components: issuing_card: description: >- Set when `type` is `issuing_card`. This is an [Issuing - Card](https://stripe.com/docs/api#issuing_cards) ID. + Card](https://api.stripe.com#issuing_cards) ID. maxLength: 5000 type: string type: @@ -51539,6 +59574,7 @@ components: - received_credit - received_debit type: string + x-stripeBypassValidation: true required: - type title: TreasuryTransactionsResourceFlowDetails @@ -51573,108 +59609,6 @@ components: title: us_bank_account_networks type: object x-expandableFields: [] - usage_record: - description: >- - Usage records allow you to report customer usage and metrics to Stripe - for - - metered billing of subscription prices. - - - Related guide: [Metered - billing](https://stripe.com/docs/billing/subscriptions/metered-billing) - - - This is our legacy usage-based billing API. See the [updated usage-based - billing - docs](https://docs.stripe.com/billing/subscriptions/usage-based). - properties: - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - usage_record - type: string - quantity: - description: The usage quantity for the specified date. - type: integer - subscription_item: - description: The ID of the subscription item this usage record contains data for. - maxLength: 5000 - type: string - timestamp: - description: The timestamp when this usage occurred. - format: unix-time - type: integer - required: - - id - - livemode - - object - - quantity - - subscription_item - - timestamp - title: UsageRecord - type: object - x-expandableFields: [] - x-resourceId: usage_record - usage_record_summary: - description: >- - A usage record summary represents an aggregated view of how much usage - was accrued for a subscription item within a subscription billing - period. - properties: - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - invoice: - description: The invoice in which this usage period has been billed for. - maxLength: 5000 - nullable: true - type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - usage_record_summary - type: string - period: - $ref: '#/components/schemas/period' - subscription_item: - description: The ID of the subscription item this summary is describing. - maxLength: 5000 - type: string - total_usage: - description: The total usage within this usage period. - type: integer - required: - - id - - livemode - - object - - period - - subscription_item - - total_usage - title: UsageRecordSummary - type: object - x-expandableFields: - - period - x-resourceId: usage_record_summary verification_session_redaction: description: '' properties: @@ -51753,7 +59687,7 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -51816,7 +59750,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: 2025-01-27.acacia + version: 2026-02-25.clover x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -51933,8 +59867,20 @@ paths: type: string type: description: >- - The type of account link the user is requesting. Possible - values are `account_onboarding` or `account_update`. + The type of account link the user is requesting. + + + You can create Account Links of type `account_update` only + for connected accounts where your platform is responsible + for collecting requirements, including Custom accounts. You + can't create them for accounts that have access to a + Stripe-hosted Dashboard. If you use [Connect embedded + components](/connect/get-started-connect-embedded-components), + you can include components that allow your connected + accounts to update their own information. For an account + without Stripe-hosted Dashboard access where Stripe is + liable for negative balances, you must use embedded + components. enum: - account_onboarding - account_update @@ -52044,6 +59990,26 @@ paths: - enabled title: payouts_config_param type: object + disputes_list: + properties: + enabled: + type: boolean + features: + properties: + capture_payments: + type: boolean + destination_on_behalf_of_charge_management: + type: boolean + dispute_management: + type: boolean + refund_management: + type: boolean + title: disputes_list_features_param + type: object + required: + - enabled + title: disputes_list_config_param + type: object documents: properties: enabled: @@ -52090,6 +60056,24 @@ paths: - enabled title: financial_account_transactions_config_param type: object + instant_payouts_promotion: + properties: + enabled: + type: boolean + features: + properties: + disable_stripe_user_authentication: + type: boolean + external_account_collection: + type: boolean + instant_payouts: + type: boolean + title: instant_payouts_promotion_features_param + type: object + required: + - enabled + title: instant_payouts_promotion_config_param + type: object issuing_card: properties: enabled: @@ -52168,6 +60152,24 @@ paths: - enabled title: payments_config_param type: object + payment_disputes: + properties: + enabled: + type: boolean + features: + properties: + destination_on_behalf_of_charge_management: + type: boolean + dispute_management: + type: boolean + refund_management: + type: boolean + title: payment_disputes_features_param + type: object + required: + - enabled + title: payment_disputes_config_param + type: object payments: properties: enabled: @@ -52188,6 +60190,18 @@ paths: - enabled title: payments_config_param type: object + payout_details: + properties: + enabled: + type: boolean + features: + properties: {} + title: base_features_param + type: object + required: + - enabled + title: base_config_param + type: object payouts: properties: enabled: @@ -52466,8 +60480,8 @@ paths: account_token: description: >- An [account - token](https://stripe.com/docs/api#create_account_token), - used to securely provide details to the account. + token](https://api.stripe.com#create_account_token), used to + securely provide details to the account. maxLength: 5000 type: string bank_account: @@ -52555,6 +60569,16 @@ paths: mcc: maxLength: 4 type: string + minority_owned_business_designation: + items: + enum: + - lgbtqi_owned_business + - minority_owned_business + - none_of_these_apply + - prefer_not_to_answer + - women_owned_business + type: string + type: array monthly_estimated_revenue: properties: amount: @@ -52701,6 +60725,12 @@ paths: type: boolean title: capability_param type: object + billie_payments: + properties: + requested: + type: boolean + title: capability_param + type: object blik_payments: properties: requested: @@ -52737,6 +60767,12 @@ paths: type: boolean title: capability_param type: object + crypto_payments: + properties: + requested: + type: boolean + title: capability_param + type: object eps_payments: properties: requested: @@ -52827,6 +60863,12 @@ paths: type: boolean title: capability_param type: object + mb_way_payments: + properties: + requested: + type: boolean + title: capability_param + type: object mobilepay_payments: properties: requested: @@ -52851,6 +60893,12 @@ paths: type: boolean title: capability_param type: object + nz_bank_account_becs_debit_payments: + properties: + requested: + type: boolean + title: capability_param + type: object oxxo_payments: properties: requested: @@ -52881,6 +60929,18 @@ paths: type: boolean title: capability_param type: object + payto_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + pix_payments: + properties: + requested: + type: boolean + title: capability_param + type: object promptpay_payments: properties: requested: @@ -52899,6 +60959,12 @@ paths: type: boolean title: capability_param type: object + satispay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object sepa_bank_transfer_payments: properties: requested: @@ -53109,9 +61175,39 @@ paths: phone: maxLength: 5000 type: string + registration_date: + anyOf: + - properties: + day: + type: integer + month: + type: integer + year: + type: integer + required: + - day + - month + - year + title: registration_date_specs + type: object + - enum: + - '' + type: string registration_number: maxLength: 5000 type: string + representative_declaration: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + maxLength: 5000 + type: string + title: company_representative_declaration + type: object structure: enum: - '' @@ -53287,7 +61383,7 @@ paths: type: array title: documents_param type: object - proof_of_registration: + proof_of_address: properties: files: items: @@ -53296,6 +61392,22 @@ paths: type: array title: documents_param type: object + proof_of_registration: + properties: + files: + items: + maxLength: 500 + type: string + type: array + signer: + properties: + person: + maxLength: 5000 + type: string + title: signer_name_param + type: object + title: signer_param + type: object proof_of_ultimate_beneficial_ownership: properties: files: @@ -53303,7 +61415,14 @@ paths: maxLength: 500 type: string type: array - title: documents_param + signer: + properties: + person: + maxLength: 5000 + type: string + title: signer_name_param + type: object + title: signer_param type: object title: documents_specs type: object @@ -53595,7 +61714,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -53677,6 +61796,16 @@ paths: type: string title: card_payments_settings_specs type: object + invoices: + properties: + hosted_payment_method_save: + enum: + - always + - never + - offer + type: string + title: invoices_settings_specs_create + type: object payments: properties: statement_descriptor: @@ -53714,6 +61843,10 @@ paths: x-stripeBypassValidation: true monthly_anchor: type: integer + monthly_payout_days: + items: + type: integer + type: array weekly_anchor: enum: - friday @@ -53725,6 +61858,17 @@ paths: - wednesday maxLength: 5000 type: string + weekly_payout_days: + items: + enum: + - friday + - monday + - thursday + - tuesday + - wednesday + type: string + x-stripeBypassValidation: true + type: array title: transfer_schedule_specs type: object statement_descriptor: @@ -53810,11 +61954,11 @@ paths:

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.

+

Live-mode accounts that have access to the standard dashboard and + Stripe is responsible for negative account balances cannot be deleted, + which includes Standard accounts. All other Live-mode accounts, can be + deleted when all balances are + zero.

If you want to delete your own account, use the - An [account - token](https://stripe.com/docs/api#create_account_token), - used to securely provide details to the account. + token](https://api.stripe.com#create_account_token), used to + securely provide details to the account. maxLength: 5000 type: string business_profile: @@ -54009,6 +62153,16 @@ paths: mcc: maxLength: 4 type: string + minority_owned_business_designation: + items: + enum: + - lgbtqi_owned_business + - minority_owned_business + - none_of_these_apply + - prefer_not_to_answer + - women_owned_business + type: string + type: array monthly_estimated_revenue: properties: amount: @@ -54155,6 +62309,12 @@ paths: type: boolean title: capability_param type: object + billie_payments: + properties: + requested: + type: boolean + title: capability_param + type: object blik_payments: properties: requested: @@ -54191,6 +62351,12 @@ paths: type: boolean title: capability_param type: object + crypto_payments: + properties: + requested: + type: boolean + title: capability_param + type: object eps_payments: properties: requested: @@ -54281,6 +62447,12 @@ paths: type: boolean title: capability_param type: object + mb_way_payments: + properties: + requested: + type: boolean + title: capability_param + type: object mobilepay_payments: properties: requested: @@ -54305,6 +62477,12 @@ paths: type: boolean title: capability_param type: object + nz_bank_account_becs_debit_payments: + properties: + requested: + type: boolean + title: capability_param + type: object oxxo_payments: properties: requested: @@ -54335,6 +62513,18 @@ paths: type: boolean title: capability_param type: object + payto_payments: + properties: + requested: + type: boolean + title: capability_param + type: object + pix_payments: + properties: + requested: + type: boolean + title: capability_param + type: object promptpay_payments: properties: requested: @@ -54353,6 +62543,12 @@ paths: type: boolean title: capability_param type: object + satispay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object sepa_bank_transfer_payments: properties: requested: @@ -54563,9 +62759,39 @@ paths: phone: maxLength: 5000 type: string + registration_date: + anyOf: + - properties: + day: + type: integer + month: + type: integer + year: + type: integer + required: + - day + - month + - year + title: registration_date_specs + type: object + - enum: + - '' + type: string registration_number: maxLength: 5000 type: string + representative_declaration: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + maxLength: 5000 + type: string + title: company_representative_declaration + type: object structure: enum: - '' @@ -54686,7 +62912,7 @@ paths: type: array title: documents_param type: object - proof_of_registration: + proof_of_address: properties: files: items: @@ -54695,6 +62921,22 @@ paths: type: array title: documents_param type: object + proof_of_registration: + properties: + files: + items: + maxLength: 500 + type: string + type: array + signer: + properties: + person: + maxLength: 5000 + type: string + title: signer_name_param + type: object + title: signer_param + type: object proof_of_ultimate_beneficial_ownership: properties: files: @@ -54702,7 +62944,14 @@ paths: maxLength: 500 type: string type: array - title: documents_param + signer: + properties: + person: + maxLength: 5000 + type: string + title: signer_name_param + type: object + title: signer_param type: object title: documents_specs type: object @@ -54994,7 +63243,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -55087,6 +63336,12 @@ paths: - enum: - '' type: string + hosted_payment_method_save: + enum: + - always + - never + - offer + type: string title: invoices_settings_specs type: object payments: @@ -55126,6 +63381,10 @@ paths: x-stripeBypassValidation: true monthly_anchor: type: integer + monthly_payout_days: + items: + type: integer + type: array weekly_anchor: enum: - friday @@ -55137,6 +63396,17 @@ paths: - wednesday maxLength: 5000 type: string + weekly_payout_days: + items: + enum: + - friday + - monday + - thursday + - tuesday + - wednesday + type: string + x-stripeBypassValidation: true + type: array title: transfer_schedule_specs type: object statement_descriptor: @@ -55307,8 +63577,12 @@ paths: type: array external_account: description: >- - Please refer to full - [documentation](https://stripe.com/docs/api) instead. + A token, like the ones returned by + [Stripe.js](https://docs.stripe.com/js) or a dictionary + containing a user's external account details (with the + options shown below). Please refer to full + [documentation](https://stripe.com/docs/api/external_accounts) + instead. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -55317,7 +63591,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -55352,7 +63626,8 @@ paths: maxLength: 5000 type: string style: simple - - in: path + - description: Unique identifier for the external account to be deleted. + in: path name: id required: true schema: @@ -55403,7 +63678,8 @@ paths: type: string type: array style: deepObject - - in: path + - description: Unique identifier for the external account to be retrieved. + in: path name: id required: true schema: @@ -55581,7 +63857,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -56032,8 +64308,12 @@ paths: type: array external_account: description: >- - Please refer to full - [documentation](https://stripe.com/docs/api) instead. + A token, like the ones returned by + [Stripe.js](https://docs.stripe.com/js) or a dictionary + containing a user's external account details (with the + options shown below). Please refer to full + [documentation](https://stripe.com/docs/api/external_accounts) + instead. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -56042,7 +64322,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -56077,7 +64357,8 @@ paths: maxLength: 5000 type: string style: simple - - in: path + - description: Unique identifier for the external account to be deleted. + in: path name: id required: true schema: @@ -56128,7 +64409,8 @@ paths: type: string type: array style: deepObject - - in: path + - description: Unique identifier for the external account to be retrieved. + in: path name: id required: true schema: @@ -56306,7 +64588,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -56568,6 +64850,9 @@ paths: relationship: explode: true style: deepObject + us_cfpb_data: + explode: true + style: deepObject verification: explode: true style: deepObject @@ -56820,7 +65105,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -56850,7 +65135,9 @@ paths: family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - maxLength: 5000 + enum: + - existing + - none type: string registered_address: description: The person's registered address. @@ -56908,6 +65195,69 @@ paths: The last four digits of the person's Social Security number (U.S. only). type: string + us_cfpb_data: + description: Demographic data related to the person. + properties: + ethnicity_details: + properties: + ethnicity: + items: + enum: + - cuban + - hispanic_or_latino + - mexican + - not_hispanic_or_latino + - other_hispanic_or_latino + - prefer_not_to_answer + - puerto_rican + type: string + type: array + ethnicity_other: + maxLength: 5000 + type: string + title: us_cfpb_ethnicity_details_specs + type: object + race_details: + properties: + race: + items: + enum: + - african_american + - american_indian_or_alaska_native + - asian + - asian_indian + - black_or_african_american + - chinese + - ethiopian + - filipino + - guamanian_or_chamorro + - haitian + - jamaican + - japanese + - korean + - native_hawaiian + - native_hawaiian_or_other_pacific_islander + - nigerian + - other_asian + - other_black_or_african_american + - other_pacific_islander + - prefer_not_to_answer + - samoan + - somali + - vietnamese + - white + type: string + type: array + race_other: + maxLength: 5000 + type: string + title: us_cfpb_race_details_specs + type: object + self_identified_gender: + maxLength: 5000 + type: string + title: us_cfpb_data_specs + type: object verification: description: The person's verification status. properties: @@ -57104,6 +65454,9 @@ paths: relationship: explode: true style: deepObject + us_cfpb_data: + explode: true + style: deepObject verification: explode: true style: deepObject @@ -57356,7 +65709,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -57386,7 +65739,9 @@ paths: family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - maxLength: 5000 + enum: + - existing + - none type: string registered_address: description: The person's registered address. @@ -57444,6 +65799,69 @@ paths: The last four digits of the person's Social Security number (U.S. only). type: string + us_cfpb_data: + description: Demographic data related to the person. + properties: + ethnicity_details: + properties: + ethnicity: + items: + enum: + - cuban + - hispanic_or_latino + - mexican + - not_hispanic_or_latino + - other_hispanic_or_latino + - prefer_not_to_answer + - puerto_rican + type: string + type: array + ethnicity_other: + maxLength: 5000 + type: string + title: us_cfpb_ethnicity_details_specs + type: object + race_details: + properties: + race: + items: + enum: + - african_american + - american_indian_or_alaska_native + - asian + - asian_indian + - black_or_african_american + - chinese + - ethiopian + - filipino + - guamanian_or_chamorro + - haitian + - jamaican + - japanese + - korean + - native_hawaiian + - native_hawaiian_or_other_pacific_islander + - nigerian + - other_asian + - other_black_or_african_american + - other_pacific_islander + - prefer_not_to_answer + - samoan + - somali + - vietnamese + - white + type: string + type: array + race_other: + maxLength: 5000 + type: string + title: us_cfpb_race_details_specs + type: object + self_identified_gender: + maxLength: 5000 + type: string + title: us_cfpb_data_specs + type: object verification: description: The person's verification status. properties: @@ -57671,6 +66089,9 @@ paths: relationship: explode: true style: deepObject + us_cfpb_data: + explode: true + style: deepObject verification: explode: true style: deepObject @@ -57923,7 +66344,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -57953,7 +66374,9 @@ paths: family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - maxLength: 5000 + enum: + - existing + - none type: string registered_address: description: The person's registered address. @@ -58011,6 +66434,69 @@ paths: The last four digits of the person's Social Security number (U.S. only). type: string + us_cfpb_data: + description: Demographic data related to the person. + properties: + ethnicity_details: + properties: + ethnicity: + items: + enum: + - cuban + - hispanic_or_latino + - mexican + - not_hispanic_or_latino + - other_hispanic_or_latino + - prefer_not_to_answer + - puerto_rican + type: string + type: array + ethnicity_other: + maxLength: 5000 + type: string + title: us_cfpb_ethnicity_details_specs + type: object + race_details: + properties: + race: + items: + enum: + - african_american + - american_indian_or_alaska_native + - asian + - asian_indian + - black_or_african_american + - chinese + - ethiopian + - filipino + - guamanian_or_chamorro + - haitian + - jamaican + - japanese + - korean + - native_hawaiian + - native_hawaiian_or_other_pacific_islander + - nigerian + - other_asian + - other_black_or_african_american + - other_pacific_islander + - prefer_not_to_answer + - samoan + - somali + - vietnamese + - white + type: string + type: array + race_other: + maxLength: 5000 + type: string + title: us_cfpb_race_details_specs + type: object + self_identified_gender: + maxLength: 5000 + type: string + title: us_cfpb_data_specs + type: object verification: description: The person's verification status. properties: @@ -58207,6 +66693,9 @@ paths: relationship: explode: true style: deepObject + us_cfpb_data: + explode: true + style: deepObject verification: explode: true style: deepObject @@ -58459,7 +66948,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -58489,7 +66978,9 @@ paths: family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction. - maxLength: 5000 + enum: + - existing + - none type: string registered_address: description: The person's registered address. @@ -58547,6 +67038,69 @@ paths: The last four digits of the person's Social Security number (U.S. only). type: string + us_cfpb_data: + description: Demographic data related to the person. + properties: + ethnicity_details: + properties: + ethnicity: + items: + enum: + - cuban + - hispanic_or_latino + - mexican + - not_hispanic_or_latino + - other_hispanic_or_latino + - prefer_not_to_answer + - puerto_rican + type: string + type: array + ethnicity_other: + maxLength: 5000 + type: string + title: us_cfpb_ethnicity_details_specs + type: object + race_details: + properties: + race: + items: + enum: + - african_american + - american_indian_or_alaska_native + - asian + - asian_indian + - black_or_african_american + - chinese + - ethiopian + - filipino + - guamanian_or_chamorro + - haitian + - jamaican + - japanese + - korean + - native_hawaiian + - native_hawaiian_or_other_pacific_islander + - nigerian + - other_asian + - other_black_or_african_american + - other_pacific_islander + - prefer_not_to_answer + - samoan + - somali + - vietnamese + - white + type: string + type: array + race_other: + maxLength: 5000 + type: string + title: us_cfpb_race_details_specs + type: object + self_identified_gender: + maxLength: 5000 + type: string + title: us_cfpb_data_specs + type: object verification: description: The person's verification status. properties: @@ -59124,7 +67678,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -59422,7 +67976,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -59913,7 +68467,7 @@ paths: maxLength: 5000 type: string style: form - - description: Only returns the original transaction. + - description: Only returns transactions associated with the given object. in: query name: source required: false @@ -59948,9 +68502,11 @@ paths: `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, - `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, - `transfer`, `transfer_cancel`, `transfer_failure`, or - `transfer_refund`. + `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, + `stripe_balance_payment_debit`, + `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, + `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, + or `transfer_refund`. in: query name: type required: false @@ -60063,6 +68619,151 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Retrieve a balance transaction + /v1/balance_settings: + get: + description: |- +

Retrieves balance settings for a given connected account. + Related guide: Making API calls for connected accounts

+ operationId: GetBalanceSettings + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/balance_settings' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve balance settings + post: + description: |- +

Updates balance settings for a given connected account. + Related guide: Making API calls for connected accounts

+ operationId: PostBalanceSettings + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + payments: + 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 + payments: + description: >- + Settings that apply to the [Payments + Balance](https://docs.stripe.com/api/balance). + properties: + debit_negative_balances: + type: boolean + payouts: + properties: + minimum_balance_by_currency: + anyOf: + - additionalProperties: + anyOf: + - type: integer + - enum: + - '' + type: string + type: object + - enum: + - '' + type: string + schedule: + properties: + interval: + enum: + - daily + - manual + - monthly + - weekly + type: string + monthly_payout_days: + items: + type: integer + type: array + weekly_payout_days: + items: + enum: + - friday + - monday + - thursday + - tuesday + - wednesday + type: string + x-stripeBypassValidation: true + type: array + title: payout_schedule + type: object + statement_descriptor: + maxLength: 22 + type: string + title: payouts + type: object + settlement_timing: + properties: + delay_days_override: + anyOf: + - type: integer + - enum: + - '' + type: string + title: settlement_timing + type: object + title: payments + type: object + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/balance_settings' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Update balance settings /v1/balance_transactions: get: description: >- @@ -60153,7 +68854,7 @@ paths: maxLength: 5000 type: string style: form - - description: Only returns the original transaction. + - description: Only returns transactions associated with the given object. in: query name: source required: false @@ -60188,9 +68889,11 @@ paths: `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, - `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, - `transfer`, `transfer_cancel`, `transfer_failure`, or - `transfer_refund`. + `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, + `stripe_balance_payment_debit`, + `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, + `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, + or `transfer_refund`. in: query name: type required: false @@ -60488,6 +69191,7 @@ paths: x-stripeBypassValidation: true required: - gte + - meter - recurrence title: usage_threshold_config type: object @@ -60695,10 +69399,20 @@ paths: description:

Retrieves the credit balance summary for a customer.

operationId: GetBillingCreditBalanceSummary parameters: - - description: The customer for which to fetch credit balance summary. + - description: The customer whose credit balance summary you're retrieving. in: query name: customer - required: true + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + The account representing the customer whose credit balance summary + you're retrieving. + in: query + name: customer_account + required: false schema: maxLength: 5000 type: string @@ -60727,8 +69441,17 @@ paths: enum: - metered type: string - required: - - price_type + prices: + items: + properties: + id: + maxLength: 5000 + type: string + required: + - id + title: applicable_price_param + type: object + type: array title: scope_param type: object credit_grant: @@ -60780,10 +69503,20 @@ paths: maxLength: 5000 type: string style: form - - description: The customer for which to fetch credit balance transactions. + - description: The customer whose credit balance transactions you're retrieving. in: query name: customer - required: true + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + The account representing the customer whose credit balance + transactions you're retrieving. + in: query + name: customer_account + required: false schema: maxLength: 5000 type: string @@ -60948,6 +69681,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return credit grants for this account representing the + customer. + in: query + name: customer_account + 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 @@ -61089,12 +69832,17 @@ paths: enum: - monetary type: string + x-stripeBypassValidation: true required: - type title: amount_param type: object applicability_config: - description: Configuration specifying what this credit grant applies to. + description: >- + Configuration specifying what this credit grant applies to. + We currently only support `metered` prices that have a + [Billing Meter](https://docs.stripe.com/api/billing/meter) + attached to them. properties: scope: properties: @@ -61102,8 +69850,17 @@ paths: enum: - metered type: string - required: - - price_type + prices: + items: + properties: + id: + maxLength: 5000 + type: string + required: + - id + title: applicable_price_param + type: object + type: array title: scope_param type: object required: @@ -61111,13 +69868,21 @@ paths: title: applicability_config_param type: object category: - description: The category of this credit grant. + description: >- + The category of this credit grant. It defaults to `paid` if + not specified. enum: - paid - promotional type: string customer: - description: ID of the customer to receive the billing credits. + description: ID of the customer receiving the billing credits. + maxLength: 5000 + type: string + customer_account: + description: >- + ID of the account representing the customer receiving the + billing credits. maxLength: 5000 type: string effective_at: @@ -61151,11 +69916,15 @@ paths: description: A descriptive name shown in the Dashboard. maxLength: 100 type: string + priority: + description: >- + The desired priority for applying this credit grant. If not + specified, it will be set to the default value of 50. The + highest priority is 0 and the lowest is 100. + type: integer required: - amount - applicability_config - - category - - customer type: object required: true responses: @@ -61492,7 +70261,7 @@ paths: `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](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes). type: object timestamp: description: >- @@ -61679,8 +70448,10 @@ paths: formula: enum: - count + - last - sum type: string + x-stripeBypassValidation: true required: - formula title: aggregation_settings_param @@ -61696,7 +70467,9 @@ paths: maxLength: 100 type: string event_time_window: - description: 'The time window to pre-aggregate meter events for, if any.' + description: >- + The time window which meter events have been pre-aggregated + for, if any. enum: - day - hour @@ -61753,8 +70526,7 @@ paths: type: string type: array style: deepObject - - description: Unique identifier for the object. - in: path + - in: path name: id required: true schema: @@ -61788,8 +70560,7 @@ paths: description:

Updates a billing meter.

operationId: PostBillingMetersId parameters: - - description: Unique identifier for the object. - in: path + - in: path name: id required: true schema: @@ -61839,212 +70610,210 @@ paths: for this meter. You can’t attach a deactivated meter to a price.

operationId: PostBillingMetersIdDeactivate 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.meter' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Deactivate a billing meter + '/v1/billing/meters/{id}/event_summaries': + get: + description:

Retrieve a list of billing meter event summaries.

+ operationId: GetBillingMetersIdEventSummaries + parameters: + - description: The customer for which to fetch event summaries. + in: query + name: customer + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: >- + The timestamp from when to stop aggregating meter events + (exclusive). Must be aligned with minute boundaries. + in: query + name: end_time + required: true + schema: + format: unix-time + type: integer + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject - description: Unique identifier for the object. in: path - name: id - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing.meter' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: Deactivate a billing meter - '/v1/billing/meters/{id}/event_summaries': - get: - description:

Retrieve a list of billing meter event summaries.

- operationId: GetBillingMetersIdEventSummaries - parameters: - - description: The customer for which to fetch event summaries. - in: query - name: customer - required: true - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The timestamp from when to stop aggregating meter events - (exclusive). Must be aligned with minute boundaries. - in: query - name: end_time - required: true - schema: - format: unix-time - type: integer - style: form - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: Unique identifier for the object. - in: path - name: id - required: true - schema: - maxLength: 5000 - type: string - style: simple - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - The timestamp from when to start aggregating meter events - (inclusive). Must be aligned with minute boundaries. - in: query - name: start_time - required: true - schema: - format: unix-time - type: integer - style: form - - description: >- - A cursor for use in pagination. `starting_after` is an object ID - that defines your place in the list. For instance, if you make a - list request and receive 100 objects, ending with `obj_foo`, your - subsequent call can include `starting_after=obj_foo` in order to - fetch the next page of the list. - in: query - name: starting_after - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - Specifies what granularity to use when generating event summaries. - If not specified, a single event summary would be returned for the - specified time range. For hourly granularity, start and end times - must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). - For daily granularity, start and end times must align with UTC day - boundaries (00:00 UTC). - in: query - name: value_grouping_window - required: false - schema: - enum: - - day - - hour - type: string - style: form - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/billing.meter_event_summary' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: '^/v1/billing/meters/[^/]+/event_summaries' - type: string - required: - - data - - has_more - - object - - url - title: BillingMeterResourceBillingMeterEventSummaryList - type: object - x-expandableFields: - - data - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: List billing meter event summaries - '/v1/billing/meters/{id}/reactivate': - post: - description: >- -

When a meter is reactivated, events for this meter can be accepted - and you can attach the meter to a price.

- operationId: PostBillingMetersIdReactivate - parameters: - - description: Unique identifier for the object. - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + The timestamp from when to start aggregating meter events + (inclusive). Must be aligned with minute boundaries. + in: query + name: start_time + required: true + schema: + format: unix-time + type: integer + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Specifies what granularity to use when generating event summaries. + If not specified, a single event summary would be returned for the + specified time range. For hourly granularity, start and end times + must align with hour boundaries (e.g., 00:00, 01:00, ..., 23:00). + For daily granularity, start and end times must align with UTC day + boundaries (00:00 UTC). + in: query + name: value_grouping_window + required: false + schema: + enum: + - day + - hour + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/billing.meter_event_summary' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: '^/v1/billing/meters/[^/]+/event_summaries' + type: string + required: + - data + - has_more + - object + - url + title: BillingMeterResourceBillingMeterEventSummaryList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: List billing meter event summaries + '/v1/billing/meters/{id}/reactivate': + post: + description: >- +

When a meter is reactivated, events for this meter can be accepted + and you can attach the meter to a price.

+ operationId: PostBillingMetersIdReactivate + parameters: + - in: path name: id required: true schema: @@ -62235,6 +71004,9 @@ paths: metadata: explode: true style: deepObject + name: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -62263,7 +71035,7 @@ paths: description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. This can be - [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) + [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. expand: description: Specifies which fields in the response should be expanded. @@ -62309,6 +71081,13 @@ paths: properties: enabled: type: boolean + payment_method_configuration: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string required: - enabled title: payment_method_update_param @@ -62360,6 +71139,11 @@ paths: type: object subscription_update: properties: + billing_cycle_anchor: + enum: + - now + - unchanged + type: string default_allowed_updates: anyOf: - items: @@ -62378,6 +71162,19 @@ paths: anyOf: - items: properties: + adjustable_quantity: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + required: + - enabled + title: >- + subscription_update_product_adjustable_quantity_param + type: object prices: items: maxLength: 5000 @@ -62418,6 +71215,11 @@ paths: type: array title: schedule_update_at_period_end_creating_param type: object + trial_update_behavior: + enum: + - continue_trial + - end_trial + type: string required: - enabled title: subscription_update_creation_param @@ -62441,13 +71243,21 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. type: object + name: + anyOf: + - maxLength: 256 + type: string + - enum: + - '' + type: string + description: The name of the configuration. required: - features type: object @@ -62549,6 +71359,9 @@ paths: metadata: explode: true style: deepObject + name: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -62590,7 +71403,7 @@ paths: description: >- The default URL to redirect customers to when they click on the portal's link to return to your website. This can be - [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) + [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. expand: description: Specifies which fields in the response should be expanded. @@ -62634,6 +71447,13 @@ paths: properties: enabled: type: boolean + payment_method_configuration: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string required: - enabled title: payment_method_update_param @@ -62682,6 +71502,11 @@ paths: type: object subscription_update: properties: + billing_cycle_anchor: + enum: + - now + - unchanged + type: string default_allowed_updates: anyOf: - items: @@ -62700,6 +71525,19 @@ paths: anyOf: - items: properties: + adjustable_quantity: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + required: + - enabled + title: >- + subscription_update_product_adjustable_quantity_param + type: object prices: items: maxLength: 5000 @@ -62745,6 +71583,11 @@ paths: type: string title: schedule_update_at_period_end_updating_param type: object + trial_update_behavior: + enum: + - continue_trial + - end_trial + type: string title: subscription_update_updating_param type: object title: features_updating_param @@ -62771,12 +71614,20 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + name: + anyOf: + - maxLength: 256 + type: string + - enum: + - '' + type: string + description: The name of the configuration. type: object required: false responses: @@ -62813,7 +71664,7 @@ paths: configuration: description: >- The ID of an existing - [configuration](https://stripe.com/docs/api/customer_portal/configuration) + [configuration](https://docs.stripe.com/api/customer_portal/configurations) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. @@ -62823,6 +71674,10 @@ paths: description: The ID of an existing customer. maxLength: 5000 type: string + customer_account: + description: The ID of an existing account. + maxLength: 5000 + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -62833,7 +71688,7 @@ paths: description: >- Information about a specific flow for the customer to go through. See the - [docs](https://stripe.com/docs/customer-management/portal-deep-links) + [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. properties: @@ -63011,9 +71866,9 @@ paths: specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the - [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). + [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts - API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) + API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. type: string @@ -63022,10 +71877,8 @@ paths: The default URL to redirect customers to when they click on the portal's link to return to your website. type: string - required: - - customer type: object - required: true + required: false responses: '200': content: @@ -63237,11 +72090,11 @@ paths: Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge - currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). + currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer @@ -63254,18 +72107,18 @@ paths: account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees - [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees). + [documentation](https://docs.stripe.com/connect/direct-charges#collect-fees). type: integer capture: description: >- Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be - [captured](https://stripe.com/docs/api#capture_charge) - later. Uncaptured charges expire after a set number of days - (7 by default). For more information, see the [authorizing - charges and settling - later](https://stripe.com/docs/charges/placing-a-hold) + [captured](https://api.stripe.com#capture_charge) later. + Uncaptured charges expire after a set number of days (7 by + default). For more information, see the [authorizing charges + and settling + later](https://docs.stripe.com/charges/placing-a-hold) documentation. type: boolean card: @@ -63376,7 +72229,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -63385,15 +72238,16 @@ paths: on_behalf_of: description: >- The Stripe account ID for which these funds are intended. - Automatically set if you use the `destination` parameter. + You can specify the business of record as the connected + account using the `on_behalf_of` attribute on the charge. For details, see [Creating Separate Charges and - Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). + Transfers](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). maxLength: 5000 type: string radar_options: description: >- Options to configure Radar. See [Radar - Session](https://stripe.com/docs/radar/radar-session) for + Session](https://docs.stripe.com/radar/radar-session) for more information. properties: session: @@ -63404,11 +72258,11 @@ paths: receipt_email: description: >- The email address to which this charge's - [receipt](https://stripe.com/docs/dashboard/receipts) will + [receipt](https://docs.stripe.com/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a - [Customer](https://stripe.com/docs/api/customers/object), + [Customer](https://docs.stripe.com/api/customers/object), the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless @@ -63462,17 +72316,17 @@ paths: source: description: >- A payment source to be charged. This can be the ID of a - [card](https://stripe.com/docs/api#cards) (i.e., credit or + [card](https://docs.stripe.com/api#cards) (i.e., credit or debit card), a [bank - account](https://stripe.com/docs/api#bank_accounts), a - [source](https://stripe.com/docs/api#sources), a - [token](https://stripe.com/docs/api#tokens), or a [connected - account](https://stripe.com/docs/connect/account-debits#charging-a-connected-account). + account](https://docs.stripe.com/api#bank_accounts), a + [source](https://docs.stripe.com/api#sources), a + [token](https://docs.stripe.com/api#tokens), or a [connected + account](https://docs.stripe.com/connect/account-debits#charging-a-connected-account). For certain sources---namely, - [cards](https://stripe.com/docs/api#cards), [bank - accounts](https://stripe.com/docs/api#bank_accounts), and + [cards](https://docs.stripe.com/api#cards), [bank + accounts](https://docs.stripe.com/api#bank_accounts), and attached - [sources](https://stripe.com/docs/api#sources)---you must + [sources](https://docs.stripe.com/api#sources)---you must also pass the ID of the associated customer. maxLength: 5000 type: string @@ -63508,7 +72362,7 @@ paths: An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect - documentation](https://stripe.com/docs/connect/destination-charges) + documentation](https://docs.stripe.com/connect/destination-charges) for details. properties: amount: @@ -63524,7 +72378,7 @@ paths: description: >- A string that identifies this transaction as part of a group. For details, see [Grouping - transactions](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options). + transactions](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options). type: string type: object required: false @@ -63590,9 +72444,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for - charges](https://stripe.com/docs/search#query-fields-for-charges). + charges](https://docs.stripe.com/search#query-fields-for-charges). in: query name: query required: true @@ -63794,7 +72648,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -63856,7 +72710,7 @@ paths: A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. type: string type: object @@ -63915,8 +72769,7 @@ paths: amount: description: >- The amount to capture, which must be less than or equal to - the original amount. Any additional amount will be - automatically refunded. + the original amount. type: integer application_fee: description: An application fee to add on to this charge. @@ -63970,7 +72823,7 @@ paths: An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect - documentation](https://stripe.com/docs/connect/destination-charges) + documentation](https://docs.stripe.com/connect/destination-charges) for details. properties: amount: @@ -63982,7 +72835,7 @@ paths: A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. type: string type: object @@ -64386,7 +73239,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -64509,7 +73362,7 @@ paths: amount: description: >- A positive integer in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) + unit](https://docs.stripe.com/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. type: integer @@ -64535,7 +73388,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -64552,7 +73405,7 @@ paths: `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 + lists](https://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. enum: - duplicate @@ -64792,7 +73645,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -64814,7 +73667,7 @@ paths: `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 + lists](https://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. enum: - duplicate @@ -64999,6 +73852,14 @@ paths: maxLength: 5000 type: string style: form + - description: Only return the Checkout Sessions for the Account specified. + in: query + name: customer_account + required: false + schema: + maxLength: 5000 + type: string + style: form - description: >- Only return the Checkout Sessions for the Customer details specified. @@ -65150,7 +74011,7 @@ paths: description: Error response. summary: List all Checkout Sessions post: - description:

Creates a Session object.

+ description:

Creates a Checkout Session object.

operationId: PostCheckoutSessions requestBody: content: @@ -65165,6 +74026,9 @@ paths: automatic_tax: explode: true style: deepObject + branding_settings: + explode: true + style: deepObject consent_collection: explode: true style: deepObject @@ -65180,6 +74044,9 @@ paths: discounts: explode: true style: deepObject + excluded_payment_method_types: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -65192,6 +74059,12 @@ paths: metadata: explode: true style: deepObject + name_collection: + explode: true + style: deepObject + optional_items: + explode: true + style: deepObject payment_intent_data: explode: true style: deepObject @@ -65204,6 +74077,9 @@ paths: payment_method_types: explode: true style: deepObject + permissions: + explode: true + style: deepObject phone_number_collection: explode: true style: deepObject @@ -65225,6 +74101,9 @@ paths: tax_id_collection: explode: true style: deepObject + wallet_options: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -65238,7 +74117,9 @@ paths: title: adaptive_pricing_params type: object after_expiration: - description: Configure actions after a Checkout Session has expired. + description: >- + Configure actions after a Checkout Session has expired. You + can't set this parameter if `ui_mode` is `custom`. properties: recovery: properties: @@ -65271,6 +74152,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -65287,13 +74169,103 @@ paths: - auto - required type: string + branding_settings: + description: >- + The branding settings for the Checkout Session. This + parameter is not allowed if ui_mode is `custom`. + properties: + background_color: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + border_style: + enum: + - '' + - pill + - rectangular + - rounded + type: string + button_color: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + display_name: + maxLength: 5000 + type: string + font_family: + enum: + - '' + - be_vietnam_pro + - bitter + - chakra_petch + - default + - hahmlet + - inconsolata + - inter + - lato + - lora + - m_plus_1_code + - montserrat + - noto_sans + - noto_sans_jp + - noto_serif + - nunito + - open_sans + - pridi + - pt_sans + - pt_serif + - raleway + - roboto + - roboto_slab + - source_sans_pro + - titillium_web + - ubuntu_mono + - zen_maru_gothic + type: string + icon: + properties: + file: + type: string + type: + enum: + - file + - url + type: string + url: + type: string + required: + - type + title: icon_params + type: object + logo: + properties: + file: + type: string + type: + enum: + - file + - url + type: string + url: + type: string + required: + - type + title: logo_params + type: object + title: branding_settings_params + type: object cancel_url: description: >- If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website. This parameter is not allowed if - ui_mode is `embedded`. - maxLength: 5000 + ui_mode is `embedded` or `custom`. type: string client_reference_id: description: >- @@ -65346,7 +74318,8 @@ paths: custom_fields: description: >- Collect additional information from your customer using - custom fields. Up to 3 fields are supported. + custom fields. Up to 3 fields are supported. You can't set + this parameter if `ui_mode` is `custom`. items: properties: dropdown: @@ -65430,7 +74403,7 @@ paths: custom_text: description: >- Display additional text for your customers using custom - text. + text. You can't set this parameter if `ui_mode` is `custom`. properties: after_submit: anyOf: @@ -65496,7 +74469,7 @@ paths: on the Checkout page. In `subscription` mode, the customer’s [default payment - method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) will be used if it’s a card, otherwise the most recently saved card will be used. A valid billing address, billing @@ -65505,7 +74478,7 @@ paths: If the Customer already has a valid - [email](https://stripe.com/docs/api/customers/object#customer_object-email) + [email](https://docs.stripe.com/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout. @@ -65520,15 +74493,21 @@ paths: You can set - [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) + [`payment_intent_data.setup_future_usage`](https://docs.stripe.com/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse. maxLength: 5000 type: string + customer_account: + description: >- + ID of an existing Account, if one exists. Has the same + behavior as `customer`. + maxLength: 5000 + type: string customer_creation: description: >- Configure whether a Checkout Session creates a - [Customer](https://stripe.com/docs/api/customers) during + [Customer](https://docs.stripe.com/api/customers) during Session confirmation. @@ -65536,12 +74515,12 @@ paths: email, address, and other customer data entered in Checkout with - [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details). + [customer_details](https://docs.stripe.com/api/checkout/sessions/object#checkout_session_object-customer_details). Sessions that don't create Customers instead are grouped by [guest - customers](https://stripe.com/docs/payments/checkout/guest-customers) + customers](https://docs.stripe.com/payments/checkout/guest-customers) in the Dashboard. Promotion codes limited to first time customers will return invalid for these Sessions. @@ -65609,6 +74588,67 @@ paths: title: discount_params type: object type: array + excluded_payment_method_types: + description: >- + A list of the types of payment methods (e.g., `card`) that + should be excluded from this Checkout Session. This should + only be used when payment methods for this Checkout Session + are managed through the [Stripe + Dashboard](https://dashboard.stripe.com/settings/payment_methods). + items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + type: array expand: description: Specifies which fields in the response should be expanded. items: @@ -65673,6 +74713,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -65690,7 +74731,10 @@ paths: - exclude_tax - include_inclusive_tax type: string - title: rendering_options_param + template: + maxLength: 5000 + type: string + title: checkout_rendering_options_param type: object - enum: - '' @@ -65705,7 +74749,8 @@ paths: description: >- A list of items the customer is purchasing. Use this parameter to pass one-time or recurring - [Prices](https://stripe.com/docs/api/prices). + [Prices](https://docs.stripe.com/api/prices). The parameter + is required for `payment` and `subscription` mode. For `payment` mode, there is a maximum of 100 line items, @@ -65736,6 +74781,10 @@ paths: maxLength: 5000 type: string type: array + metadata: + additionalProperties: + type: string + type: object price: maxLength: 5000 type: string @@ -65766,6 +74815,9 @@ paths: tax_code: maxLength: 5000 type: string + unit_label: + maxLength: 12 + type: string required: - name title: product_data @@ -65863,7 +74915,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -65879,7 +74931,103 @@ paths: - setup - subscription type: string - x-stripeBypassValidation: true + name_collection: + description: >- + Controls name collection settings for the session. + + + You can configure Checkout to collect your customers' + business names, individual names, or both. Each name field + can be either required or optional. + + + If a [Customer](https://docs.stripe.com/api/customers) is + created or provided, the names can be saved to the Customer + object as well. + + + You can't set this parameter if `ui_mode` is `custom`. + properties: + business: + properties: + enabled: + type: boolean + optional: + type: boolean + required: + - enabled + title: name_collection_business_params + type: object + individual: + properties: + enabled: + type: boolean + optional: + type: boolean + required: + - enabled + title: name_collection_individual_params + type: object + title: name_collection_params + type: object + optional_items: + description: >- + A list of optional items the customer can add to their order + at checkout. Use this parameter to pass one-time or + recurring [Prices](https://docs.stripe.com/api/prices). + + + There is a maximum of 10 optional items allowed on a + Checkout Session, and the existing limits on the number of + line items allowed on a Checkout Session apply to the + combined number of line items and optional items. + + + For `payment` mode, there is a maximum of 100 combined line + items and optional items, however it is recommended to + consolidate items if there are more than a few dozen. + + + For `subscription` mode, there is a maximum of 20 line items + and optional items with recurring Prices and 20 line items + and optional items with one-time Prices. + + + You can't set this parameter if `ui_mode` is `custom`. + items: + properties: + adjustable_quantity: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + required: + - enabled + title: optional_item_adjustable_quantity_params + type: object + price: + maxLength: 5000 + type: string + quantity: + type: integer + required: + - price + - quantity + title: optional_item_params + type: object + type: array + origin_context: + description: >- + Where the user is coming from. This informs the + optimizations that are applied to the session. You can't set + this parameter if `ui_mode` is `custom`. + enum: + - mobile_app + - web + type: string payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent @@ -65989,7 +75137,7 @@ paths: If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free - trial](https://stripe.com/docs/payments/checkout/free-trials). + trial](https://docs.stripe.com/payments/checkout/free-trials). enum: - always - if_required @@ -66060,6 +75208,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string verification_method: enum: - automatic @@ -66071,6 +75222,10 @@ paths: type: object affirm: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66079,6 +75234,10 @@ paths: type: object afterpay_clearpay: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66091,10 +75250,23 @@ paths: enum: - none type: string + x-stripeBypassValidation: true + title: payment_method_options_param + type: object + alma: + properties: + capture_method: + enum: + - manual + type: string title: payment_method_options_param type: object amazon_pay: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66108,6 +75280,9 @@ paths: enum: - none type: string + target_date: + maxLength: 5000 + type: string title: payment_method_options_param type: object bacs_debit: @@ -66129,6 +75304,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_method_options_param type: object bancontact: @@ -66139,6 +75317,14 @@ paths: type: string title: payment_method_options_param type: object + billie: + properties: + capture_method: + enum: + - manual + type: string + title: payment_method_options_param + type: object boleto: properties: expires_after_days: @@ -66153,6 +75339,10 @@ paths: type: object card: properties: + capture_method: + enum: + - manual + type: string installments: properties: enabled: @@ -66186,6 +75376,19 @@ paths: - challenge type: string x-stripeBypassValidation: true + restrictions: + properties: + brands_blocked: + items: + enum: + - american_express + - discover_global_network + - mastercard + - visa + type: string + type: array + title: restrictions_param + type: object setup_future_usage: enum: - off_session @@ -66201,6 +75404,10 @@ paths: type: object cashapp: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66258,6 +75465,15 @@ paths: type: string title: payment_method_options_param type: object + demo_pay: + properties: + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object eps: properties: setup_future_usage: @@ -66313,10 +75529,55 @@ paths: type: object klarna: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none type: string + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - next_billing + - reference + title: setup_intent_subscription_param + type: object + type: array + - enum: + - '' + type: string title: payment_method_options_param type: object konbini: @@ -66344,6 +75605,10 @@ paths: type: object link: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66353,6 +75618,10 @@ paths: type: object mobilepay: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66466,14 +75735,101 @@ paths: type: string title: payment_method_options_param type: object + payto: + properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + start_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: >- + setup_intent_payment_method_options_mandate_options_param + type: object + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object pix: properties: + amount_includes_iof: + enum: + - always + - never + type: string expires_after_seconds: type: integer + setup_future_usage: + enum: + - none + type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object revolut_pay: properties: + capture_method: + enum: + - manual + type: string setup_future_usage: enum: - none @@ -66489,6 +75845,14 @@ paths: type: string title: payment_method_options_param type: object + satispay: + properties: + capture_method: + enum: + - manual + type: string + title: payment_method_options_param + type: object sepa_debit: properties: mandate_options: @@ -66508,6 +75872,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_method_options_param type: object sofort: @@ -66525,6 +75892,15 @@ paths: type: string title: payment_method_options_param type: object + twint: + properties: + setup_future_usage: + enum: + - none + type: string + x-stripeBypassValidation: true + title: payment_method_options_param + type: object us_bank_account: properties: financial_connections: @@ -66557,6 +75933,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string verification_method: enum: - automatic @@ -66598,7 +75977,7 @@ paths: Dashboard](https://dashboard.stripe.com/settings/payment_methods). See [Dynamic Payment - Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) + Methods](https://docs.stripe.com/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details. @@ -66627,10 +76006,12 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - cashapp + - crypto - customer_balance - eps - fpx @@ -66642,19 +76023,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -66665,6 +76050,23 @@ paths: type: string x-stripeBypassValidation: true type: array + permissions: + description: >- + This property is used to set up permissions for various + actions (e.g., update) on the CheckoutSession object. Can + only be set when creating `embedded` or `custom` sessions. + + + For specific permissions, please refer to their dedicated + subsections, such as `permissions.update_shipping_details`. + properties: + update_shipping_details: + enum: + - client_only + - server_only + type: string + title: permissions_param + type: object phone_number_collection: description: >- Controls phone number collection settings for the session. @@ -66675,7 +76077,7 @@ paths: before using this feature. Learn more about [collecting phone numbers with - Checkout](https://stripe.com/docs/payments/checkout/phone-numbers). + Checkout](https://docs.stripe.com/payments/checkout/phone-numbers). properties: enabled: type: boolean @@ -66687,7 +76089,7 @@ paths: description: >- This parameter applies to `ui_mode: embedded`. Learn more about the [redirect - behavior](https://stripe.com/docs/payments/checkout/custom-success-page?payment-ui=embedded-form) + behavior](https://docs.stripe.com/payments/checkout/custom-success-page?payment-ui=embedded-form) of embedded sessions. Defaults to `always`. enum: - always @@ -66700,11 +76102,10 @@ paths: authenticate or cancel their payment on the payment method's app or site. This parameter is required if - ui_mode is `embedded` + `ui_mode` is `embedded` or `custom` and redirect-based payment methods are enabled on the session. - maxLength: 5000 type: string saved_payment_method_options: description: >- @@ -66719,6 +76120,11 @@ paths: - unspecified type: string type: array + payment_method_remove: + enum: + - disabled + - enabled + type: string payment_method_save: enum: - disabled @@ -67100,13 +76506,15 @@ paths: submit_type: description: >- Describes the type of transaction being performed by - Checkout in order to customize + Checkout in order - relevant text on the page, such as the submit button. - `submit_type` can only be + to customize relevant text on the page, such as the submit + button. + `submit_type` can only be specified on Checkout Sessions in + `payment` or `subscription` mode. If blank or `auto`, `pay` + is used. - specified on Checkout Sessions in `payment` mode. If blank - or `auto`, `pay` is used. + You can't set this parameter if `ui_mode` is `custom`. enum: - auto - book @@ -67124,6 +76532,26 @@ paths: billing_cycle_anchor: format: unix-time type: integer + billing_mode: + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - classic + - flexible + type: string + required: + - type + title: billing_mode + type: object default_tax_rates: items: maxLength: 5000 @@ -67143,6 +76571,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -67202,15 +76631,14 @@ paths: is complete. - This parameter is not allowed if ui_mode is `embedded`. If - you’d like to use + This parameter is not allowed if ui_mode is `embedded` or + `custom`. If you'd like to use information from the successful Checkout Session on your page, read the guide on [customizing your success - page](https://stripe.com/docs/payments/checkout/custom-success-page). - maxLength: 5000 + page](https://docs.stripe.com/payments/checkout/custom-success-page). type: string tax_id_collection: description: Controls tax ID collection during checkout. @@ -67229,10 +76657,24 @@ paths: ui_mode: description: The UI mode of the Session. Defaults to `hosted`. enum: + - custom - embedded - hosted type: string - x-stripeBypassValidation: true + wallet_options: + description: Wallet-specific configuration. + properties: + link: + properties: + display: + enum: + - auto + - never + type: string + title: wallet_options_param + type: object + title: wallet_options_param + type: object type: object required: false responses: @@ -67248,10 +76690,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - summary: Create a Session + summary: Create a Checkout Session '/v1/checkout/sessions/{session}': get: - description:

Retrieves a Session object.

+ description:

Retrieves a Checkout Session object.

operationId: GetCheckoutSessionsSession parameters: - description: Specifies which fields in the response should be expanded. @@ -67294,9 +76736,15 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - summary: Retrieve a Session + summary: Retrieve a Checkout Session post: - description:

Updates a Session object.

+ description: >- +

Updates a Checkout Session object.

+ + +

Related guide: Dynamically update a Checkout + Session

operationId: PostCheckoutSessionsSession parameters: - in: path @@ -67310,21 +76758,205 @@ paths: content: application/x-www-form-urlencoded: encoding: + collected_information: + explode: true + style: deepObject expand: explode: true style: deepObject + line_items: + explode: true + style: deepObject metadata: explode: true style: deepObject + shipping_options: + explode: true + style: deepObject schema: additionalProperties: false properties: + collected_information: + description: >- + Information about the customer collected within the Checkout + Session. Can only be set when updating `embedded` or + `custom` sessions. + properties: + shipping_details: + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + required: + - country + - line1 + title: address + type: object + name: + maxLength: 255 + type: string + required: + - address + - name + title: shipping_details_params + type: object + title: collected_information_params + type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + line_items: + description: >- + A list of items the customer is purchasing. + + + When updating line items, you must retransmit the entire + array of line items. + + + To retain an existing line item, specify its `id`. + + + To update an existing line item, specify its `id` along with + the new values of the fields to update. + + + To add a new line item, specify one of `price` or + `price_data` and `quantity`. + + + To remove an existing line item, omit the line item's ID + from the retransmitted array. + + + To reorder a line item, specify it at the desired position + in the retransmitted array. + items: + properties: + adjustable_quantity: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + required: + - enabled + title: adjustable_quantity_params + type: object + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + format: currency + type: string + product: + maxLength: 5000 + type: string + product_data: + properties: + description: + maxLength: 40000 + type: string + images: + items: + type: string + type: array + metadata: + additionalProperties: + type: string + type: object + name: + maxLength: 5000 + type: string + tax_code: + maxLength: 5000 + type: string + unit_label: + maxLength: 12 + type: string + required: + - name + title: product_data + type: object + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + title: price_data_with_product_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: line_item_params + type: object + type: array metadata: anyOf: - additionalProperties: @@ -67335,12 +76967,119 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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`. + shipping_options: + anyOf: + - items: + properties: + shipping_rate: + maxLength: 5000 + type: string + shipping_rate_data: + properties: + delivery_estimate: + properties: + maximum: + properties: + unit: + enum: + - business_day + - day + - hour + - month + - week + type: string + value: + type: integer + required: + - unit + - value + title: delivery_estimate_bound + type: object + minimum: + properties: + unit: + enum: + - business_day + - day + - hour + - month + - week + type: string + value: + type: integer + required: + - unit + - value + title: delivery_estimate_bound + type: object + title: delivery_estimate + type: object + display_name: + maxLength: 100 + type: string + fixed_amount: + properties: + amount: + type: integer + currency: + format: currency + type: string + currency_options: + additionalProperties: + properties: + amount: + type: integer + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + required: + - amount + title: currency_option + type: object + type: object + required: + - amount + - currency + title: fixed_amount + type: object + metadata: + additionalProperties: + type: string + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + tax_code: + type: string + type: + enum: + - fixed_amount + type: string + required: + - display_name + title: method_params + type: object + title: shipping_option_params + type: object + type: array + - enum: + - '' + type: string + description: >- + The shipping rate options to apply to this Session. Up to a + maximum of 5. type: object required: false responses: @@ -67356,16 +77095,17 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - summary: Update a Session + summary: Update a Checkout Session '/v1/checkout/sessions/{session}/expire': post: description: >- -

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

+

A Checkout 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 Checkout Session and + customers loading the Checkout Session see a message saying the Checkout + Session is expired.

operationId: PostCheckoutSessionsSessionExpire parameters: - in: path @@ -67406,7 +77146,7 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - summary: Expire a Session + summary: Expire a Checkout Session '/v1/checkout/sessions/{session}/line_items': get: description: >- @@ -67693,7 +77433,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -67838,7 +77578,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -68669,7 +78409,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -68691,8 +78431,9 @@ paths: redeem_by: description: >- Unix timestamp specifying the last time at which the coupon - can be redeemed. After the redeem_by date, the coupon can no - longer be applied to new customers. + can be redeemed (cannot be set to more than 5 years in the + future). After the redeem_by date, the coupon can no longer + be applied to new customers. format: unix-time type: integer type: object @@ -68858,7 +78599,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -68924,6 +78665,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return credit notes for the account representing the customer + specified by this account ID. + in: query + name: customer_account + 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 @@ -69035,20 +78786,21 @@ paths: summary: List all credit notes post: description: >- -

Issue a credit note to adjust the amount of a finalized invoice. For - a status=open invoice, a credit note reduces +

Issue a credit note to adjust the amount of a finalized invoice. A + credit note will first reduce the invoice’s + amount_remaining (and amount_due), but not + below zero. - 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:

+ This amount is indicated by the credit note’s + pre_payment_amount. The excess amount is indicated by + post_payment_amount, and it can result in any combination + of the following:

    -
  • Refund: create a new refund (using refund_amount) or - link an existing refund (using refund).
    • +
  • Refunds: create a new refund (using refund_amount) or + link existing refunds (using refunds).
  • Customer balance credit: credit the customer’s balance (using credit_amount) which will be automatically applied to their @@ -69060,16 +78812,17 @@ paths:
-

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

+

The sum of refunds, customer balance credits, and outside of Stripe + credits must equal the post_payment_amount.

You may issue multiple credit notes for an invoice. Each credit note - will increment the invoice’s - pre_payment_credit_notes_amount + may 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.

+ post_payment_credit_notes_amount, or both, depending on the + invoice’s amount_remaining at the time of credit note + creation.

operationId: PostCreditNotes requestBody: content: @@ -69084,6 +78837,9 @@ paths: metadata: explode: true style: deepObject + refunds: + explode: true + style: deepObject shipping_cost: explode: true style: deepObject @@ -69093,7 +78849,8 @@ paths: amount: description: >- The integer amount in cents (or local equivalent) - representing the total amount of the credit note. + representing the total amount of the credit note. One of + `amount`, `lines`, or `shipping_cost` must be provided. type: integer credit_amount: description: >- @@ -69128,7 +78885,9 @@ paths: maxLength: 5000 type: string lines: - description: Line items that make up the credit note. + description: >- + Line items that make up the credit note. One of `amount`, + `lines`, or `shipping_cost` must be provided. items: properties: amount: @@ -69195,7 +78954,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -69217,19 +78976,47 @@ paths: - order_change - product_unsatisfactory type: string - refund: - description: ID of an existing refund to link this credit note to. - type: string refund_amount: description: >- The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice. type: integer + refunds: + description: Refunds to link to this credit note. + items: + properties: + amount_refunded: + type: integer + payment_record_refund: + properties: + payment_record: + maxLength: 5000 + type: string + refund_group: + maxLength: 5000 + type: string + required: + - payment_record + - refund_group + title: payment_record_refund_params + type: object + refund: + type: string + type: + enum: + - payment_record_refund + - refund + type: string + title: credit_note_refund_params + type: object + type: array shipping_cost: description: >- When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. + One of `amount`, `lines`, or `shipping_cost` must be + provided. properties: shipping_rate: maxLength: 5000 @@ -69261,7 +79048,8 @@ paths: parameters: - description: >- The integer amount in cents (or local equivalent) representing the - total amount of the credit note. + total amount of the credit note. One of `amount`, `lines`, or + `shipping_cost` must be provided. in: query name: amount required: false @@ -69320,7 +79108,9 @@ paths: maxLength: 5000 type: string style: form - - description: Line items that make up the credit note. + - description: >- + Line items that make up the credit note. One of `amount`, `lines`, + or `shipping_cost` must be provided. explode: true in: query name: lines @@ -69393,7 +79183,7 @@ paths: type: string style: form - description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -69430,13 +79220,6 @@ paths: - product_unsatisfactory type: string style: form - - description: ID of an existing refund to link this credit note to. - in: query - name: refund - required: false - schema: - type: string - style: form - description: >- The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge @@ -69447,9 +79230,44 @@ paths: schema: type: integer style: form + - description: Refunds to link to this credit note. + explode: true + in: query + name: refunds + required: false + schema: + items: + properties: + amount_refunded: + type: integer + payment_record_refund: + properties: + payment_record: + maxLength: 5000 + type: string + refund_group: + maxLength: 5000 + type: string + required: + - payment_record + - refund_group + title: payment_record_refund_params + type: object + refund: + type: string + type: + enum: + - payment_record_refund + - refund + type: string + title: credit_note_refund_params + type: object + type: array + style: deepObject - description: >- When shipping_cost contains the shipping_rate from the invoice, the - shipping_cost is included in the credit note. + shipping_cost is included in the credit note. One of `amount`, + `lines`, or `shipping_cost` must be provided. explode: true in: query name: shipping_cost @@ -69496,7 +79314,8 @@ paths: parameters: - description: >- The integer amount in cents (or local equivalent) representing the - total amount of the credit note. + total amount of the credit note. One of `amount`, `lines`, or + `shipping_cost` must be provided. in: query name: amount required: false @@ -69577,7 +79396,9 @@ paths: schema: type: integer style: form - - description: Line items that make up the credit note. + - description: >- + Line items that make up the credit note. One of `amount`, `lines`, + or `shipping_cost` must be provided. explode: true in: query name: lines @@ -69650,7 +79471,7 @@ paths: type: string style: form - description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that + Set of [key-value pairs](https://docs.stripe.com/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 @@ -69687,13 +79508,6 @@ paths: - product_unsatisfactory type: string style: form - - description: ID of an existing refund to link this credit note to. - in: query - name: refund - required: false - schema: - type: string - style: form - description: >- The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge @@ -69704,9 +79518,44 @@ paths: schema: type: integer style: form + - description: Refunds to link to this credit note. + explode: true + in: query + name: refunds + required: false + schema: + items: + properties: + amount_refunded: + type: integer + payment_record_refund: + properties: + payment_record: + maxLength: 5000 + type: string + refund_group: + maxLength: 5000 + type: string + required: + - payment_record + - refund_group + title: payment_record_refund_params + type: object + refund: + type: string + type: + enum: + - payment_record_refund + - refund + type: string + title: credit_note_refund_params + type: object + type: array + style: deepObject - description: >- When shipping_cost contains the shipping_rate from the invoice, the - shipping_cost is included in the credit note. + shipping_cost is included in the credit note. One of `amount`, + `lines`, or `shipping_cost` must be provided. explode: true in: query name: shipping_cost @@ -69986,7 +79835,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -70078,7 +79927,7 @@ paths: properties: components: description: >- - Configuration for each component. Exactly 1 component must + Configuration for each component. At least 1 component must be enabled. properties: buy_button: @@ -70089,6 +79938,76 @@ paths: - enabled title: buy_button_param type: object + customer_sheet: + properties: + enabled: + type: boolean + features: + properties: + payment_method_allow_redisplay_filters: + items: + enum: + - always + - limited + - unspecified + type: string + type: array + payment_method_remove: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + title: features_param + type: object + required: + - enabled + title: customer_sheet_param + type: object + mobile_payment_element: + properties: + enabled: + type: boolean + features: + properties: + payment_method_allow_redisplay_filters: + items: + enum: + - always + - limited + - unspecified + type: string + type: array + payment_method_redisplay: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_remove: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_save: + enum: + - disabled + - enabled + type: string + x-stripeBypassValidation: true + payment_method_save_allow_redisplay_override: + enum: + - always + - limited + - unspecified + type: string + title: features_param + type: object + required: + - enabled + title: mobile_payment_element_param + type: object payment_element: properties: enabled: @@ -70150,6 +80069,12 @@ paths: Customer Session. maxLength: 5000 type: string + customer_account: + description: >- + The ID of an existing Account for which to create the + Customer Session. + maxLength: 5000 + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -70158,7 +80083,6 @@ paths: type: array required: - components - - customer type: object required: true responses: @@ -70335,12 +80259,18 @@ paths: address: explode: true style: deepObject + business_name: + explode: true + style: deepObject cash_balance: explode: true style: deepObject expand: explode: true style: deepObject + individual_name: + explode: true + style: deepObject invoice_settings: explode: true style: deepObject @@ -70388,7 +80318,10 @@ paths: - enum: - '' type: string - description: The customer's address. + description: >- + The customer's address. Learn about [country-specific + requirements for calculating + tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). balance: description: >- An integer amount in cents (or local equivalent) that @@ -70397,6 +80330,16 @@ paths: credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. type: integer + business_name: + anyOf: + - maxLength: 150 + type: string + - enum: + - '' + type: string + description: >- + The customer's business name. This may be up to *150 + characters*. cash_balance: description: >- Balance information and default balance settings for this @@ -70414,9 +80357,6 @@ paths: type: object title: cash_balance_param type: object - coupon: - maxLength: 5000 - type: string description: description: >- An arbitrary string that you can attach to a customer @@ -70437,6 +80377,16 @@ paths: maxLength: 5000 type: string type: array + individual_name: + anyOf: + - maxLength: 150 + type: string + - enum: + - '' + type: string + description: >- + The customer's full name. This may be up to *150 + characters*. invoice_prefix: description: >- The prefix for the customer used to generate unique invoice @@ -70500,7 +80450,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -70528,14 +80478,6 @@ paths: maxLength: 5000 type: string type: array - promotion_code: - description: >- - The ID of a promotion code to apply to the customer. The - customer will have a discount applied on all recurring - payments. Charges you create through the API will not have - the discount. - maxLength: 5000 - type: string shipping: anyOf: - properties: @@ -70622,10 +80564,15 @@ paths: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -70641,14 +80588,17 @@ paths: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -70665,11 +80615,14 @@ paths: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -70687,6 +80640,7 @@ paths: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -70794,9 +80748,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for - customers](https://stripe.com/docs/search#query-fields-for-customers). + customers](https://docs.stripe.com/search#query-fields-for-customers). in: query name: query required: true @@ -70949,18 +80903,18 @@ paths: post: 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 + parameters passed. Any parameters not provided are left unchanged. For + example, if you pass the source parameter, that becomes + the customer’s active source (such as 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.

+ open invoice for the subscription with automatic collection enabled is + retried. This retry doesn’t count as an automatic retry, and doesn’t + affect the next regularly scheduled payment for the invoice. Changing + the default_source for a customer doesn’t trigger this + behavior.

This request accepts mostly the same arguments as the customer @@ -70984,6 +80938,9 @@ paths: bank_account: explode: true style: deepObject + business_name: + explode: true + style: deepObject card: explode: true style: deepObject @@ -70993,6 +80950,9 @@ paths: expand: explode: true style: deepObject + individual_name: + explode: true + style: deepObject invoice_settings: explode: true style: deepObject @@ -71037,7 +80997,10 @@ paths: - enum: - '' type: string - description: The customer's address. + description: >- + The customer's address. Learn about [country-specific + requirements for calculating + tax](https://docs.stripe.com/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer). balance: description: >- An integer amount in cents (or local equivalent) that @@ -71086,6 +81049,16 @@ paths: Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. + business_name: + anyOf: + - maxLength: 150 + type: string + - enum: + - '' + type: string + description: >- + The customer's business name. This may be up to *150 + characters*. card: anyOf: - properties: @@ -71158,9 +81131,6 @@ paths: type: object title: cash_balance_param type: object - coupon: - maxLength: 5000 - type: string default_alipay_account: description: >- ID of Alipay account to make the customer's new default for @@ -71183,7 +81153,7 @@ paths: description: >- If you are using payment methods created via the PaymentMethods API, see the - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. @@ -71193,7 +81163,7 @@ paths: If you want to add a new payment source and make it the default, see the - [source](https://stripe.com/docs/api/customers/update#update_customer-source) + [source](https://docs.stripe.com/api/customers/update#update_customer-source) property. maxLength: 500 type: string @@ -71217,6 +81187,16 @@ paths: maxLength: 5000 type: string type: array + individual_name: + anyOf: + - maxLength: 150 + type: string + - enum: + - '' + type: string + description: >- + The customer's full name. This may be up to *150 + characters*. invoice_prefix: description: >- The prefix for the customer used to generate unique invoice @@ -71280,7 +81260,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -71305,14 +81285,6 @@ paths: maxLength: 5000 type: string type: array - promotion_code: - description: >- - The ID of a promotion code to apply to the customer. The - customer will have a discount applied on all recurring - payments. Charges you create through the API will not have - the discount. - maxLength: 5000 - type: string shipping: anyOf: - properties: @@ -71409,6 +81381,28 @@ paths: href="/docs/billing/customer/balance">balances.

operationId: GetCustomersCustomerBalanceTransactions parameters: + - description: >- + Only return customer balance transactions that were created during + the given date interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject - in: path name: customer required: true @@ -71440,6 +81434,14 @@ paths: type: string type: array style: deepObject + - description: Only return transactions that are related to the specified invoice. + in: query + name: invoice + required: false + schema: + maxLength: 5000 + type: string + style: form - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @@ -71553,7 +81555,7 @@ paths: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Specifies the - [`invoice_credit_balance`](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance) + [`invoice_credit_balance`](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance) that this transaction will apply to. If the customer's `currency` is not set, it will be updated to this value. format: currency @@ -71580,7 +81582,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -71714,7 +81716,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -72006,7 +82008,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -72015,8 +82017,8 @@ paths: type: object source: description: >- - Please refer to full - [documentation](https://stripe.com/docs/api) instead. + Please refer to full [documentation](https://api.stripe.com) + instead. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -72241,7 +82243,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -72636,7 +82638,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -72645,8 +82647,8 @@ paths: type: object source: description: >- - Please refer to full - [documentation](https://stripe.com/docs/api) instead. + Please refer to full [documentation](https://api.stripe.com) + instead. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -72871,7 +82873,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -73410,8 +83412,7 @@ paths: This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method - can be shown as a saved payment method in a checkout flow. The field - defaults to `unspecified`. + can be shown as a saved payment method in a checkout flow. in: query name: allow_redisplay required: false @@ -73495,10 +83496,13 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -73510,19 +83514,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -73915,7 +83923,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -73924,8 +83932,8 @@ paths: type: object source: description: >- - Please refer to full - [documentation](https://stripe.com/docs/api) instead. + Please refer to full [documentation](https://api.stripe.com) + instead. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -74145,7 +84153,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -74412,6 +84420,9 @@ paths: billing_thresholds: explode: true style: deepObject + cancel_at: + explode: true + style: deepObject default_tax_rates: explode: true style: deepObject @@ -74470,6 +84481,48 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - now + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -74527,10 +84580,7 @@ paths: application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). automatic_tax: - description: >- - Automatic tax settings for this subscription. We recommend - you only include this parameter when the existing value is - being changed. + description: Automatic tax settings for this subscription. properties: enabled: type: boolean @@ -74543,6 +84593,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -74553,18 +84604,17 @@ paths: type: object backdate_start_date: description: >- - For new subscriptions, a past timestamp to backdate the - subscription's start date to. If set, the first invoice will - contain a proration for the timespan between the start date - and the current time. Can be combined with trials and the - billing cycle anchor. + A past timestamp to backdate the subscription's start date + to. If set, the first invoice will contain line items for + the timespan between the start date and the current time. + Can be combined with trials and the billing cycle anchor. format: unix-time type: integer billing_cycle_anchor: description: >- A future timestamp in UTC format to anchor the subscription's [billing - cycle](https://stripe.com/docs/subscriptions/billing-cycle). + cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the @@ -74586,17 +84636,23 @@ paths: type: string description: >- Define thresholds at which an invoice will be sent, and the - subscription advanced to a new billing period. Pass an empty - string to remove previously-defined thresholds. + subscription advanced to a new billing period. When + updating, pass an empty string to remove previously-defined + thresholds. cancel_at: + anyOf: + - format: unix-time + type: integer + - enum: + - max_period_end + - min_period_end + type: string description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - format: unix-time - type: integer cancel_at_period_end: description: >- Indicate whether this subscription should cancel at the end @@ -74616,15 +84672,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - description: >- - The ID of the coupon to apply to this subscription. A coupon - applied to a subscription will only affect invoices created - for that particular subscription. This field has been - deprecated and will be removed in a future API version. Use - `discounts` instead. - maxLength: 5000 - type: string currency: description: >- Three-letter [ISO currency @@ -74645,9 +84692,9 @@ paths: must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). maxLength: 5000 type: string default_source: @@ -74657,9 +84704,9 @@ paths: and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). maxLength: 5000 type: string default_tax_rates: @@ -74725,6 +84772,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -74839,7 +84887,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -74864,7 +84912,7 @@ paths: pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -74876,7 +84924,7 @@ paths: management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA - regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, @@ -74890,7 +84938,7 @@ paths: action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See - the [changelog](https://stripe.com/docs/upgrades#2019-03-14) + the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more. @@ -75032,6 +85080,34 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + type: integer + purpose: + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: mandate_options_param + type: object + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: {} @@ -75100,6 +85176,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -75107,6 +85184,8 @@ paths: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -75115,15 +85194,19 @@ paths: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -75167,21 +85250,12 @@ paths: description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an - invoice](https://stripe.com/docs/api#create_invoice) for the + invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. - promotion_code: - description: >- - The promotion code to apply to this subscription. A - promotion code applied to a subscription will only affect - invoices created for that particular subscription. This - field has been deprecated and will be removed in a future - API version. Use `discounts` instead. - maxLength: 5000 - type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. enum: @@ -75219,7 +85293,7 @@ paths: value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. trial_from_plan: description: >- @@ -75228,7 +85302,7 @@ paths: preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. type: boolean trial_period_days: @@ -75237,7 +85311,7 @@ paths: the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. type: integer trial_settings: @@ -75525,6 +85599,48 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - now + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -75598,6 +85714,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -75611,7 +85728,7 @@ paths: Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle - [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). enum: - now - unchanged @@ -75632,8 +85749,9 @@ paths: type: string description: >- Define thresholds at which an invoice will be sent, and the - subscription advanced to a new billing period. Pass an empty - string to remove previously-defined thresholds. + subscription advanced to a new billing period. When + updating, pass an empty string to remove previously-defined + thresholds. cancel_at: anyOf: - format: unix-time @@ -75641,6 +85759,10 @@ paths: - enum: - '' type: string + - enum: + - max_period_end + - min_period_end + type: string description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a @@ -75690,15 +85812,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - description: >- - The ID of the coupon to apply to this subscription. A coupon - applied to a subscription will only affect invoices created - for that particular subscription. This field has been - deprecated and will be removed in a future API version. Use - `discounts` instead. - maxLength: 5000 - type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by @@ -75711,9 +85824,9 @@ paths: must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). maxLength: 5000 type: string default_source: @@ -75729,9 +85842,9 @@ paths: and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). default_tax_rates: anyOf: - items: @@ -75796,6 +85909,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -75921,7 +86035,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -75957,7 +86071,7 @@ paths: 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). + collection](https://docs.stripe.com/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to @@ -75966,7 +86080,7 @@ paths: user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -75976,16 +86090,16 @@ paths: allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA - regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending - updates](https://stripe.com/docs/billing/subscriptions/pending-updates). + updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending - updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an @@ -75995,7 +86109,7 @@ paths: is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the - [changelog](https://stripe.com/docs/upgrades#2019-03-14) to + [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. enum: - allow_incomplete @@ -76128,6 +86242,34 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + type: integer + purpose: + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: mandate_options_param + type: object + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: {} @@ -76196,6 +86338,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -76203,6 +86346,8 @@ paths: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -76211,15 +86356,19 @@ paths: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -76263,21 +86412,12 @@ paths: description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an - invoice](https://stripe.com/docs/api#create_invoice) for the + invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. - promotion_code: - description: >- - The promotion code to apply to this subscription. A - promotion code applied to a subscription will only affect - invoices created for that particular subscription. This - field has been deprecated and will be removed in a future - API version. Use `discounts` instead. - maxLength: 5000 - type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -76289,15 +86429,15 @@ paths: type: string proration_date: description: >- - If set, the proration will be calculated as though the + If set, prorations will be calculated as though the subscription was updated at the given time. This can be used - to apply exactly the same proration that was previewed with - [upcoming - invoice](https://stripe.com/docs/api#upcoming_invoice) - endpoint. It can also be used to implement custom proration - logic, such as prorating by day instead of by second, by - providing the time that you wish to use for proration - calculations. + to apply exactly the same prorations that were previewed + with the [create + preview](https://stripe.com/docs/api/invoices/create_preview) + endpoint. `proration_date` can also be used to implement + custom proration logic, such as prorating by day instead of + by second, by providing the time that you wish to use for + proration calculations. format: unix-time type: integer transfer_data: @@ -76343,7 +86483,7 @@ paths: preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. type: boolean trial_settings: @@ -76616,19 +86756,21 @@ paths: type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, - `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, - `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, - `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, - `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, - `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, - `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, - `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, - `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, - `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, - `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, - `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, - `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, + `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, + `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, + `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, + `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, + `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, + `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, + `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, + `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, + `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, + `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, + `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, + `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, + `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, + `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, @@ -76642,10 +86784,15 @@ paths: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -76661,14 +86808,17 @@ paths: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -76685,11 +86835,14 @@ paths: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -76707,6 +86860,7 @@ paths: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -77397,7 +87551,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -78261,6 +88415,12 @@ paths: /v1/exchange_rates: get: description: >- +

[Deprecated] The ExchangeRate APIs are deprecated. + Please use the FX + Quotes API instead.

+ +

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.

@@ -78370,6 +88530,12 @@ paths: '/v1/exchange_rates/{rate_id}': get: description: >- +

[Deprecated] The ExchangeRate APIs are deprecated. + Please use the FX + Quotes API instead.

+ +

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

operationId: GetExchangeRatesRateId @@ -78415,6 +88581,174 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Retrieve an exchange rate + '/v1/external_accounts/{id}': + post: + description: >- +

Updates the metadata, account holder name, account holder type of a + bank account belonging to + + a connected account and optionally sets it as the default for its + currency. Other bank account + + details are not editable by design.

+ + +

You can only update bank accounts when account.controller.requirement_collection + is application, which includes Custom accounts.

+ + +

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

+ operationId: PostExternalAccountsId + parameters: + - in: path + name: id + required: true + schema: + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + documents: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + account_holder_name: + description: >- + The name of the person or business that owns the bank + account. + maxLength: 5000 + type: string + account_holder_type: + description: >- + The type of entity that holds the account. This can be + either `individual` or `company`. + enum: + - '' + - company + - individual + maxLength: 5000 + type: string + account_type: + description: >- + The bank account type. This can only be `checking` or + `savings` in most countries. In Japan, this can only be + `futsu` or `toza`. + enum: + - checking + - futsu + - savings + - toza + maxLength: 5000 + type: string + address_city: + description: City/District/Suburb/Town/Village. + maxLength: 5000 + type: string + address_country: + description: 'Billing address country, if provided when creating card.' + maxLength: 5000 + type: string + address_line1: + description: Address line 1 (Street address/PO Box/Company name). + maxLength: 5000 + type: string + address_line2: + description: Address line 2 (Apartment/Suite/Unit/Building). + maxLength: 5000 + type: string + address_state: + description: State/County/Province/Region. + maxLength: 5000 + type: string + address_zip: + description: ZIP or postal code. + maxLength: 5000 + type: string + default_for_currency: + description: >- + When set to true, this becomes the default external account + for its currency. + type: boolean + documents: + description: >- + Documents that may be submitted to satisfy various + informational requests. + properties: + bank_account_ownership_verification: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + title: external_account_documents_param + type: object + exp_month: + description: Two digit number representing the card’s expiration month. + maxLength: 5000 + type: string + exp_year: + description: Four digit number representing the card’s expiration year. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + name: + description: Cardholder name. + maxLength: 5000 + type: string + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/external_account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/file_links: get: description:

Returns a list of file links.

@@ -78590,8 +88924,8 @@ paths: `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`. + `sigma_scheduled_query`, `tax_document_user_upload`, + `terminal_android_apk`, or `terminal_reader_splashscreen`. maxLength: 5000 type: string metadata: @@ -78604,7 +88938,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -78731,7 +89065,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -78835,10 +89169,14 @@ paths: - identity_document_downloadable - issuing_regulatory_reporting - pci_document + - platform_terms_of_service - selfie - sigma_scheduled_query - tax_document_user_upload + - terminal_android_apk - terminal_reader_splashscreen + - terminal_wifi_certificate + - terminal_wifi_private_key maxLength: 5000 type: string x-stripeBypassValidation: true @@ -78949,7 +89287,7 @@ paths: file_link_data: description: >- Optional parameters that automatically create a [file - link](https://stripe.com/docs/api#file_links) for the newly + link](https://api.stripe.com#file_links) for the newly created file. properties: create: @@ -78972,7 +89310,7 @@ paths: purpose: description: >- The - [purpose](https://stripe.com/docs/file-upload#uploading-a-file) + [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. enum: - account_requirement @@ -78984,8 +89322,12 @@ paths: - identity_document - issuing_regulatory_reporting - pci_document + - platform_terms_of_service - tax_document_user_upload + - terminal_android_apk - terminal_reader_splashscreen + - terminal_wifi_certificate + - terminal_wifi_private_key type: string x-stripeBypassValidation: true required: @@ -79082,6 +89424,9 @@ paths: customer: maxLength: 5000 type: string + customer_account: + maxLength: 5000 + type: string title: accountholder_params type: object style: deepObject @@ -79476,7 +89821,8 @@ paths: post: description: >-

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

+ Connections Account. When the account status is active, + data is typically refreshed once a day.

operationId: PostFinancialConnectionsAccountsAccountSubscribe parameters: - in: path @@ -79632,6 +89978,9 @@ paths: customer: maxLength: 5000 type: string + customer_account: + maxLength: 5000 + type: string type: enum: - account @@ -80128,7 +90477,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -80151,6 +90500,7 @@ paths: - cardholder_name - request_signature type: string + x-stripeBypassValidation: true type: array request: description: >- @@ -80525,13 +90875,22 @@ paths: schema: type: integer style: form - - in: query + - description: Customer ID + in: query name: related_customer required: false schema: maxLength: 5000 type: string style: form + - description: The ID of the Account representing a customer. + in: query + name: related_customer_account + 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 @@ -80548,7 +90907,7 @@ paths: - description: >- Only return VerificationSessions with this status. [Learn more about the lifecycle of - sessions](https://stripe.com/docs/identity/how-sessions-work). + sessions](https://docs.stripe.com/identity/how-sessions-work). in: query name: status required: false @@ -80648,6 +91007,9 @@ paths: provided_details: explode: true style: deepObject + related_person: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -80669,7 +91031,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -80715,9 +91077,29 @@ paths: title: provided_details_param type: object related_customer: - description: Token referencing a Customer resource. + description: Customer ID + maxLength: 5000 + type: string + related_customer_account: + description: The ID of the Account representing a customer. maxLength: 5000 type: string + related_person: + description: >- + Tokens referencing a Person resource and it's associated + account. + properties: + account: + maxLength: 5000 + type: string + person: + maxLength: 5000 + type: string + required: + - account + - person + title: related_person_param + type: object return_url: description: >- The URL that the user will be redirected to upon completing @@ -80726,7 +91108,7 @@ paths: type: description: >- The type of [verification - check](https://stripe.com/docs/identity/verification-checks) + check](https://docs.stripe.com/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. enum: @@ -80859,7 +91241,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -80907,7 +91289,7 @@ paths: type: description: >- The type of [verification - check](https://stripe.com/docs/identity/verification-checks) + check](https://docs.stripe.com/identity/verification-checks) to be performed. enum: - document @@ -81070,6 +91452,224 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Redact a VerificationSession + /v1/invoice_payments: + get: + description: >- +

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

+ operationId: GetInvoicePayments + parameters: + - description: >- + Only return invoice payments that were created during the given date + interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The identifier of the invoice whose payments to return. + in: query + name: invoice + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: The payment details of the invoice payments to return. + explode: true + in: query + name: payment + required: false + schema: + properties: + payment_intent: + maxLength: 5000 + type: string + payment_record: + maxLength: 5000 + type: string + type: + enum: + - payment_intent + - payment_record + type: string + required: + - type + title: payment_param + type: object + style: deepObject + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: The status of the invoice payments to return. + in: query + name: status + required: false + schema: + enum: + - canceled + - open + - paid + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/invoice_payment' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: InvoicesPaymentsListInvoicePayments + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: List all payments for an invoice + '/v1/invoice_payments/{invoice_payment}': + get: + description:

Retrieves the invoice payment with the given ID.

+ operationId: GetInvoicePaymentsInvoicePayment + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: invoice_payment + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice_payment' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve an InvoicePayment /v1/invoice_rendering_templates: get: description: >- @@ -81368,7 +91968,7 @@ paths: style: deepObject - description: >- The identifier of the customer whose invoice items to return. If - none is provided, all invoice items will be returned. + none is provided, returns all invoice items. in: query name: customer required: false @@ -81376,6 +91976,17 @@ paths: maxLength: 5000 type: string style: form + - description: >- + The identifier of the account representing the customer whose + invoice items to return. If none is provided, returns all invoice + items. + in: query + name: customer_account + 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 @@ -81522,6 +92133,9 @@ paths: price_data: explode: true style: deepObject + pricing: + explode: true + style: deepObject tax_code: explode: true style: deepObject @@ -81547,9 +92161,13 @@ paths: format: currency type: string customer: + description: The ID of the customer to bill for this invoice item. + maxLength: 5000 + type: string + customer_account: description: >- - The ID of the customer who will be billed when this invoice - item is billed. + The ID of the account representing the customer to bill for + this invoice item. maxLength: 5000 type: string description: @@ -81596,11 +92214,14 @@ paths: invoice: description: >- The ID of an existing invoice to add this invoice item to. - When left blank, the invoice item will be added to the next - upcoming scheduled invoice. This is useful when adding - invoice items in response to an invoice.created webhook. You - can only add invoice items to draft invoices and there is a - maximum of 250 items per invoice. + For subscription invoices, when left blank, the invoice item + will be added to the next upcoming scheduled invoice. For + standalone invoices, the invoice item won't be automatically + added unless you pass `pending_invoice_item_behavior: + 'include'` when creating the invoice. This is useful when + adding invoice items in response to an invoice.created + webhook. You can only add invoice items to draft invoices + and there is a maximum of 250 items per invoice. maxLength: 5000 type: string metadata: @@ -81613,7 +92234,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -81624,10 +92245,10 @@ paths: The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue - Recognition](https://stripe.com/docs/revenue-recognition) + Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition - documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) + documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. properties: end: @@ -81641,17 +92262,10 @@ paths: - start title: period type: object - price: - description: >- - The ID of the price object. One of `price` or `price_data` - is required. - maxLength: 5000 - type: string price_data: description: >- Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object inline. - One of `price` or `price_data` is required. + [Price](https://docs.stripe.com/api/prices) object inline. properties: currency: format: currency @@ -81675,6 +92289,14 @@ paths: - product title: one_time_price_data type: object + pricing: + description: The pricing information for the invoice item. + properties: + price: + maxLength: 5000 + type: string + title: pricing_param + type: object quantity: description: >- Non-negative integer. The quantity of units for the invoice @@ -81694,7 +92316,7 @@ paths: tax_behavior: description: >- Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or @@ -81711,7 +92333,7 @@ paths: - enum: - '' type: string - description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' + description: 'A [tax code](https://docs.stripe.com/tax/tax-categories) ID.' tax_rates: description: >- The tax rates which apply to the invoice item. When set, the @@ -81721,25 +92343,18 @@ paths: maxLength: 5000 type: string type: array - unit_amount: - description: >- - The integer unit amount in cents (or local equivalent) of - the charge to be applied to the upcoming invoice. This - `unit_amount` will be multiplied by the quantity to get the - full amount. Passing in a negative `unit_amount` will reduce - the `amount_due` on the invoice. - type: integer unit_amount_decimal: description: >- - Same as `unit_amount`, but accepts a decimal value in cents - (or local equivalent) with at most 12 decimal places. Only - one of `unit_amount` and `unit_amount_decimal` can be set. + The decimal unit amount in cents (or local equivalent) of + the charge to be applied to the upcoming invoice. This + `unit_amount_decimal` will be multiplied by the quantity to + get the full amount. Passing in a negative + `unit_amount_decimal` will reduce the `amount_due` on the + invoice. Accepts at most 12 decimal places. format: decimal type: string - required: - - customer type: object - required: true + required: false responses: '200': content: @@ -81870,6 +92485,9 @@ paths: price_data: explode: true style: deepObject + pricing: + explode: true + style: deepObject tax_code: explode: true style: deepObject @@ -81940,7 +92558,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -81951,10 +92569,10 @@ paths: The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue - Recognition](https://stripe.com/docs/revenue-recognition) + Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition - documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) + documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. properties: end: @@ -81968,17 +92586,10 @@ paths: - start title: period type: object - price: - description: >- - The ID of the price object. One of `price` or `price_data` - is required. - maxLength: 5000 - type: string price_data: description: >- Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object inline. - One of `price` or `price_data` is required. + [Price](https://docs.stripe.com/api/prices) object inline. properties: currency: format: currency @@ -82002,6 +92613,14 @@ paths: - product title: one_time_price_data type: object + pricing: + description: The pricing information for the invoice item. + properties: + price: + maxLength: 5000 + type: string + title: pricing_param + type: object quantity: description: >- Non-negative integer. The quantity of units for the invoice @@ -82010,7 +92629,7 @@ paths: tax_behavior: description: >- Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or @@ -82027,7 +92646,7 @@ paths: - enum: - '' type: string - description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' + description: 'A [tax code](https://docs.stripe.com/tax/tax-categories) ID.' tax_rates: anyOf: - items: @@ -82042,19 +92661,14 @@ paths: `default_tax_rates` on the invoice do not apply to this invoice item. Pass an empty string to remove previously-defined tax rates. - unit_amount: - description: >- - The integer unit amount in cents (or local equivalent) of - the charge to be applied to the upcoming invoice. This - unit_amount will be multiplied by the quantity to get the - full amount. If you want to apply a credit to the customer's - account, pass a negative unit_amount. - type: integer unit_amount_decimal: description: >- - Same as `unit_amount`, but accepts a decimal value in cents - (or local equivalent) with at most 12 decimal places. Only - one of `unit_amount` and `unit_amount_decimal` can be set. + The decimal unit amount in cents (or local equivalent) of + the charge to be applied to the upcoming invoice. This + `unit_amount_decimal` will be multiplied by the quantity to + get the full amount. Passing in a negative + `unit_amount_decimal` will reduce the `amount_due` on the + invoice. Accepts at most 12 decimal places. format: decimal type: string type: object @@ -82123,6 +92737,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return invoices for the account representing the customer + specified by this account ID. + in: query + name: customer_account + required: false + schema: + maxLength: 5000 + type: string + style: form - explode: true in: query name: due_date @@ -82191,7 +92815,7 @@ paths: - description: >- The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn - more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + more](https://docs.stripe.com/billing/invoices/workflow#workflow-overview) in: query name: status required: false @@ -82203,7 +92827,6 @@ paths: - uncollectible - void type: string - x-stripeBypassValidation: true style: form - description: >- Only return invoices for the subscription specified by this @@ -82274,8 +92897,8 @@ paths:

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.

+ pay or send the invoice to your customers.

operationId: PostInvoices requestBody: content: @@ -82345,14 +92968,15 @@ paths: Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees - [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). + [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees). type: integer auto_advance: description: >- Controls whether Stripe performs [automatic - collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) + collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't - automatically advance without an explicit action. + automatically advance without an explicit action. Defaults + to false. type: boolean automatic_tax: description: Settings for automatic tax lookup for this invoice. @@ -82368,6 +92992,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -82378,9 +93003,9 @@ paths: 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. + The time when this invoice should be scheduled to finalize + (up to 5 years in the future). The invoice is finalized at + this time if it's still in draft state. format: unix-time type: integer collection_method: @@ -82424,7 +93049,11 @@ paths: A list of up to 4 custom fields to be displayed on the invoice. customer: - description: The ID of the customer who will be billed. + description: The ID of the customer to bill. + maxLength: 5000 + type: string + customer_account: + description: The ID of the account to bill. maxLength: 5000 type: string days_until_due: @@ -82517,7 +93146,7 @@ paths: description: >- Revise an existing invoice. The new invoice will be created in `status=draft`. See the [revision - documentation](https://stripe.com/docs/invoicing/invoice-revisions) + documentation](https://docs.stripe.com/invoicing/invoice-revisions) for more details. properties: action: @@ -82546,6 +93175,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -82560,7 +93190,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -82585,7 +93215,7 @@ paths: payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with - Connect](https://stripe.com/docs/billing/invoices/connect) + Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. type: string payment_settings: @@ -82659,9 +93289,10 @@ paths: type: string type: enum: + - bonus - fixed_count + - revolving type: string - x-stripeBypassValidation: true required: - type title: installment_plan @@ -82715,6 +93346,34 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + type: integer + purpose: + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: mandate_options_param + type: object + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: {} @@ -82783,6 +93442,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -82790,6 +93450,8 @@ paths: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -82798,15 +93460,19 @@ paths: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -83057,10 +93723,25 @@ paths: /v1/invoices/create_preview: post: 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.

+

At any time, you can preview the upcoming invoice for a subscription + or subscription schedule. 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.

+ + +

You can also preview the effects of creating or updating a + subscription or subscription schedule, including a preview of any + prorations that 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 on the + invoice is to consider line items where + parent.subscription_item_details.proration is + true.

Note that when you are viewing an upcoming invoice, you are simply @@ -83071,17 +93752,6 @@ paths: 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. - - The ID of the coupon to apply to this phase of the - subscription schedule. This field has been deprecated and - will be removed in a future API version. Use `discounts` - instead. - maxLength: 5000 - type: string currency: description: >- The currency to preview this invoice in. Defaults to that of @@ -83159,12 +93822,21 @@ paths: type: string customer: description: >- - The identifier of the customer whose upcoming invoice you'd - like to retrieve. If `automatic_tax` is enabled then one of + The identifier of the customer whose upcoming invoice you're + retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. maxLength: 5000 type: string + customer_account: + description: >- + The identifier of the account representing the customer + whose upcoming invoice you're retrieving. If `automatic_tax` + is enabled then one of `customer`, `customer_account`, + `customer_details`, `subscription`, or `schedule` must be + set. + maxLength: 5000 + type: string customer_details: description: >- Details about the customer you want to invoice or overrides @@ -83267,10 +93939,15 @@ paths: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -83286,14 +93963,17 @@ paths: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -83310,11 +93990,14 @@ paths: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -83332,6 +94015,7 @@ paths: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -83534,6 +94218,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -83549,7 +94234,7 @@ paths: payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with - Connect](https://stripe.com/docs/billing/invoices/connect) + Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. preview_mode: description: >- @@ -83572,6 +94257,26 @@ paths: preview. Cannot be used with `subscription` or `subscription_` prefixed fields. properties: + billing_mode: + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - classic + - flexible + type: string + required: + - type + title: billing_mode + type: object end_behavior: enum: - cancel @@ -83598,6 +94303,49 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - phase_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - phase_start + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -83654,6 +94402,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -83684,9 +94433,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - maxLength: 5000 - type: string default_payment_method: maxLength: 5000 type: string @@ -83719,12 +94465,27 @@ paths: promotion_code: maxLength: 5000 type: string - title: discounts_data_param + title: schedule_discounts_data_param type: object type: array - enum: - '' type: string + duration: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: duration_params + type: object end_date: anyOf: - format: unix-time @@ -83755,6 +94516,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -83789,7 +94551,7 @@ paths: promotion_code: maxLength: 5000 type: string - title: discounts_data_param + title: schedule_discounts_data_param type: object type: array - enum: @@ -83856,8 +94618,6 @@ paths: title: configuration_item_params type: object type: array - iterations: - type: integer metadata: additionalProperties: type: string @@ -83937,6 +94697,26 @@ paths: type: string - format: unix-time type: integer + billing_mode: + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - classic + - flexible + type: string + required: + - type + title: billing_mode + type: object cancel_at: anyOf: - format: unix-time @@ -83944,6 +94724,10 @@ paths: - enum: - '' type: string + - enum: + - max_period_end + - min_period_end + type: string cancel_at_period_end: type: boolean cancel_now: @@ -84155,9 +94939,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for - invoices](https://stripe.com/docs/search#query-fields-for-invoices). + invoices](https://docs.stripe.com/search#query-fields-for-invoices). in: query name: query required: true @@ -84223,341 +95007,49 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Search invoices - /v1/invoices/upcoming: - get: + '/v1/invoices/{invoice}': + delete: 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

- operationId: GetInvoicesUpcoming +

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.

+ operationId: DeleteInvoicesInvoice parameters: - - description: Settings for automatic tax lookup for this invoice preview. - explode: true - in: query - name: automatic_tax - required: false - schema: - properties: - enabled: - type: boolean - liability: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - required: - - enabled - title: automatic_tax_param - type: object - style: deepObject - - description: >- - The ID of the coupon to apply to this phase of the subscription - schedule. This field has been deprecated and will be removed in a - future API version. Use `discounts` instead. - in: query - name: coupon - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The currency to preview this invoice in. Defaults to that of - `customer` if not specified. - in: query - name: currency - required: false - schema: - format: currency - type: string - style: form - - description: >- - The identifier of the customer whose upcoming invoice you'd like to - retrieve. If `automatic_tax` is enabled then one of `customer`, - `customer_details`, `subscription`, or `schedule` must be set. - in: query - name: customer - required: false + - in: path + name: invoice + required: true schema: maxLength: 5000 type: string - style: form - - description: >- - Details about the customer you want to invoice or overrides for an - existing customer. If `automatic_tax` is enabled then one of - `customer`, `customer_details`, `subscription`, or `schedule` must - be set. - explode: true - in: query - name: customer_details - required: false - schema: - properties: - address: - anyOf: - - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: optional_fields_address - type: object - - enum: - - '' - type: string - shipping: - anyOf: - - properties: - address: - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: optional_fields_customer_address - type: object - name: - maxLength: 5000 - type: string - phone: - maxLength: 5000 - type: string - required: - - address - - name - title: customer_shipping - type: object - - enum: - - '' - type: string - tax: - properties: - ip_address: - anyOf: - - type: string - - enum: - - '' - type: string - title: tax_param - type: object - tax_exempt: - enum: - - '' - - exempt - - none - - reverse - type: string - tax_ids: - items: - properties: - type: - enum: - - ad_nrt - - ae_trn - - al_tin - - am_tin - - ao_tin - - ar_cuit - - au_abn - - au_arn - - ba_tin - - bb_tin - - bg_uic - - bh_vat - - bo_tin - - br_cnpj - - br_cpf - - bs_tin - - by_tin - - ca_bn - - ca_gst_hst - - ca_pst_bc - - ca_pst_mb - - ca_pst_sk - - ca_qst - - cd_nif - - ch_uid - - ch_vat - - cl_tin - - cn_tin - - co_nit - - cr_tin - - de_stn - - do_rcn - - ec_ruc - - eg_tin - - es_cif - - eu_oss_vat - - eu_vat - - gb_vat - - ge_vat - - gn_nif - - hk_br - - hr_oib - - hu_tin - - id_npwp - - il_vat - - in_gst - - is_vat - - jp_cn - - jp_rn - - jp_trn - - ke_pin - - kh_tin - - kr_brn - - kz_bin - - li_uid - - li_vat - - ma_vat - - md_vat - - me_pib - - mk_vat - - mr_nif - - mx_rfc - - my_frp - - my_itn - - my_sst - - ng_tin - - no_vat - - no_voec - - np_pan - - nz_gst - - om_vat - - pe_ruc - - ph_tin - - ro_tin - - rs_pib - - ru_inn - - ru_kpp - - sa_vat - - sg_gst - - sg_uen - - si_tin - - sn_ninea - - sr_fin - - sv_nit - - th_vat - - tj_tin - - tr_tin - - tw_vat - - tz_vat - - ua_vat - - ug_tin - - us_ein - - uy_ruc - - uz_tin - - uz_vat - - ve_rif - - vn_tin - - za_vat - - zm_tin - - zw_tin - maxLength: 5000 - type: string - x-stripeBypassValidation: true - value: - type: string - required: - - type - - value - title: data_params - type: object - type: array - title: customer_details_param - type: object - style: deepObject - - description: >- - The coupons to redeem into discounts for the invoice preview. If not - specified, inherits the discount from the subscription or customer. - This works for both coupons directly applied to an invoice and - coupons applied to a subscription. Pass an empty string to avoid - inheriting any discounts. - explode: true - in: query - name: discounts - required: false - schema: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - style: deepObject + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/deleted_invoice' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Delete a draft invoice + get: + description:

Retrieves the invoice with the given ID.

+ operationId: GetInvoicesInvoice + parameters: - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -84569,111 +95061,241 @@ paths: type: string type: array style: deepObject - - description: >- - List of invoice items to add or update in the upcoming invoice - preview (up to 250). - explode: true - in: query - name: invoice_items - required: false + - in: path + name: invoice + required: true schema: - items: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve an invoice + post: + description: >- +

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.

+ operationId: PostInvoicesInvoice + parameters: + - in: path + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + account_tax_ids: + explode: true + style: deepObject + automatic_tax: + explode: true + style: deepObject + custom_fields: + explode: true + style: deepObject + default_source: + explode: true + style: deepObject + default_tax_rates: + explode: true + style: deepObject + discounts: + explode: true + style: deepObject + effective_at: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + issuer: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + number: + explode: true + style: deepObject + on_behalf_of: + explode: true + style: deepObject + payment_settings: + explode: true + style: deepObject + rendering: + explode: true + style: deepObject + shipping_cost: + explode: true + style: deepObject + shipping_details: + explode: true + style: deepObject + transfer_data: + explode: true + style: deepObject + schema: + additionalProperties: false properties: - amount: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: >- + The account tax IDs associated with the invoice. Only + editable when the invoice is a draft. + application_fee_amount: + description: >- + A fee in cents (or local equivalent) that will be applied to + the invoice and transferred to the application owner's + Stripe account. The request must be made with an OAuth key + or the Stripe-Account header in order to take an application + fee. For more information, see the application fees + [documentation](https://docs.stripe.com/billing/invoices/connect#collecting-fees). type: integer - currency: - format: currency - type: string - description: - maxLength: 5000 - type: string - discountable: + auto_advance: + description: >- + Controls whether Stripe performs [automatic + collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) + of the invoice. type: boolean - discounts: + automatic_tax: + description: Settings for automatic tax lookup for this invoice. + properties: + enabled: + type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + x-stripeBypassValidation: true + required: + - type + title: param + type: object + required: + - enabled + title: automatic_tax_param + type: object + automatically_finalizes_at: + description: >- + The time when this invoice should be scheduled to finalize + (up to 5 years in the future). The invoice is finalized at + this time if it's still in draft state. To turn off + automatic finalization, set `auto_advance` to false. + format: unix-time + type: integer + collection_method: + description: >- + Either `charge_automatically` or `send_invoice`. This field + can be updated only on `draft` invoices. + enum: + - charge_automatically + - send_invoice + type: string + custom_fields: anyOf: - items: properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 + name: + maxLength: 40 type: string - promotion_code: - maxLength: 5000 + value: + maxLength: 140 type: string - title: discounts_data_param + required: + - name + - value + title: custom_field_params type: object type: array - enum: - '' type: string - invoiceitem: + description: >- + A list of up to 4 custom fields to be displayed on the + invoice. If a value for `custom_fields` is specified, the + list specified will replace the existing custom field list + on this invoice. Pass an empty string to remove + previously-defined fields. + days_until_due: + description: >- + The number of days from which the invoice is created until + it is due. Only valid for invoices where + `collection_method=send_invoice`. This field can only be + updated on `draft` invoices. + type: integer + default_payment_method: + description: >- + ID of the default payment method for the invoice. It must + belong to the customer associated with the invoice. If not + set, defaults to the subscription's default payment method, + if any, or to the default payment method in the customer's + invoice settings. maxLength: 5000 type: string - metadata: + default_source: anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - period: - properties: - end: - format: unix-time - type: integer - start: - format: unix-time - type: integer - required: - - end - - start - title: period - type: object - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal + - maxLength: 5000 type: string - required: - - currency - - product - title: one_time_price_data - type: object - quantity: - type: integer - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - tax_code: - anyOf: - - type: string - enum: - '' type: string - tax_rates: + description: >- + ID of the default payment source for the invoice. It must + belong to the customer associated with the invoice and be in + a chargeable state. If not set, defaults to the + subscription's default source, if any, or to the customer's + default source. + default_tax_rates: anyOf: - items: maxLength: 5000 @@ -84682,2694 +95304,81 @@ paths: - enum: - '' type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal + description: >- + The tax rates that will apply to any line item that does not + have `tax_rates` set. Pass an empty string to remove + previously-defined tax rates. + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. Referenced as 'memo' in the Dashboard. + maxLength: 1500 type: string - title: invoice_item_preview_params - type: object - type: array - style: deepObject - - description: >- - The connected account that issues the invoice. The invoice is - presented with the branding and support information of the specified - account. - explode: true - in: query - name: issuer - required: false - schema: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - style: deepObject - - description: >- - The account (if any) for which the funds of the invoice payment are - intended. If set, the invoice will be presented with the branding - and support information of the specified account. See the [Invoices - with Connect](https://stripe.com/docs/billing/invoices/connect) - documentation for details. - explode: true - in: query - name: on_behalf_of - required: false - schema: - anyOf: - - type: string - - enum: - - '' - type: string - style: deepObject - - description: >- - Customizes the types of values to include when calculating the - invoice. Defaults to `next` if unspecified. - in: query - name: preview_mode - required: false - schema: - enum: - - next - - recurring - type: string - style: form - - description: >- - The identifier of the schedule whose upcoming invoice you'd like to - retrieve. Cannot be used with subscription or subscription fields. - in: query - name: schedule - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The schedule creation or modification params to apply as a preview. - Cannot be used with `subscription` or `subscription_` prefixed - fields. - explode: true - in: query - name: schedule_details - required: false - schema: - properties: - end_behavior: - enum: - - cancel - - release - type: string - phases: - items: - properties: - add_invoice_items: - items: + discounts: + anyOf: + - items: properties: - discounts: - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - price: + coupon: maxLength: 5000 type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - title: one_time_price_data_with_negative_amounts - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: add_invoice_item_entry - type: object - type: array - application_fee_percent: - type: number - automatic_tax: - properties: - enabled: - type: boolean - liability: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - required: - - enabled - title: automatic_tax_config - type: object - billing_cycle_anchor: - enum: - - automatic - - phase_start - type: string - billing_thresholds: - anyOf: - - properties: - amount_gte: - type: integer - reset_billing_cycle_anchor: - type: boolean - title: billing_thresholds_param - type: object - - enum: - - '' - type: string - collection_method: - enum: - - charge_automatically - - send_invoice - type: string - coupon: - maxLength: 5000 - type: string - default_payment_method: - maxLength: 5000 - type: string - default_tax_rates: - anyOf: - - items: + discount: maxLength: 5000 type: string - type: array - - enum: - - '' - type: string - description: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - end_date: - anyOf: - - format: unix-time - type: integer - - enum: - - now - maxLength: 5000 - type: string - invoice_settings: - properties: - account_tax_ids: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - days_until_due: - type: integer - issuer: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - title: invoice_settings - type: object - items: - items: - properties: - billing_thresholds: - anyOf: - - properties: - usage_gte: - type: integer - required: - - usage_gte - title: item_billing_thresholds_param - type: object - - enum: - - '' - type: string - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - metadata: - additionalProperties: - type: string - type: object - price: + promotion_code: maxLength: 5000 type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - recurring: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - title: recurring_adhoc - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - - recurring - title: recurring_price_data - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: configuration_item_params + title: discounts_data_param type: object type: array - iterations: + - enum: + - '' + type: string + description: >- + The discounts that will apply to the invoice. Pass an empty + string to remove previously-defined discounts. + due_date: + description: >- + The date on which payment for this invoice is due. Only + valid for invoices where `collection_method=send_invoice`. + This field can only be updated on `draft` invoices. + format: unix-time + type: integer + effective_at: + anyOf: + - format: unix-time type: integer - metadata: - additionalProperties: - type: string - type: object - on_behalf_of: + - enum: + - '' type: string - proration_behavior: + description: >- + The date when this invoice is in effect. Same as + `finalized_at` unless overwritten. When defined, this value + replaces the system-generated 'Date of issue' printed on the + invoice PDF and receipt. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + footer: + description: Footer to be displayed on the invoice. + maxLength: 5000 + type: string + issuer: + description: >- + The connected account that issues the invoice. The invoice + is presented with the branding and support information of + the specified account. + properties: + account: + type: string + type: enum: - - always_invoice - - create_prorations - - none - type: string - start_date: - anyOf: - - format: unix-time - type: integer - - enum: - - now - maxLength: 5000 - type: string - transfer_data: - properties: - amount_percent: - type: number - destination: - type: string - required: - - destination - title: transfer_data_specs - type: object - trial: - type: boolean - trial_end: - anyOf: - - format: unix-time - type: integer - - enum: - - now - maxLength: 5000 - type: string - required: - - items - title: phase_configuration_params - type: object - type: array - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - title: schedule_details_params - type: object - style: deepObject - - description: >- - The identifier of the subscription for which you'd like to retrieve - the upcoming invoice. If not provided, but a - `subscription_details.items` is provided, you will preview creating - a subscription with those items. If neither `subscription` nor - `subscription_details.items` is provided, you will retrieve the next - upcoming invoice from among the customer's subscriptions. - in: query - name: subscription - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - For new subscriptions, a future timestamp to anchor the - subscription's [billing - cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is - used to determine the date of the first full invoice, and, for plans - with `month` or `year` intervals, the day of the month for - subsequent invoices. For existing subscriptions, the value can only - be set to `now` or `unchanged`. This field has been deprecated and - will be removed in a future API version. Use - `subscription_details.billing_cycle_anchor` instead. - explode: true - in: query - name: subscription_billing_cycle_anchor - required: false - schema: - anyOf: - - enum: - - now - - unchanged - maxLength: 5000 - type: string - - format: unix-time - type: integer - style: deepObject - - description: >- - A timestamp at which the subscription should cancel. If set to a - date before the current period ends, this will cause a proration if - prorations have been enabled using `proration_behavior`. If set - during a future period, this will always cause a proration for that - period. This field has been deprecated and will be removed in a - future API version. Use `subscription_details.cancel_at` instead. - explode: true - in: query - name: subscription_cancel_at - required: false - schema: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - style: deepObject - - description: >- - Indicate whether this subscription should cancel at the end of the - current period (`current_period_end`). Defaults to `false`. This - field has been deprecated and will be removed in a future API - version. Use `subscription_details.cancel_at_period_end` instead. - in: query - name: subscription_cancel_at_period_end - required: false - schema: - type: boolean - style: form - - description: >- - This simulates the subscription being canceled or expired - immediately. This field has been deprecated and will be removed in a - future API version. Use `subscription_details.cancel_now` instead. - in: query - name: subscription_cancel_now - required: false - schema: - type: boolean - style: form - - description: >- - If provided, the invoice returned will preview updating or creating - a subscription with these default tax rates. The default tax rates - will apply to any line item that does not have `tax_rates` set. This - field has been deprecated and will be removed in a future API - version. Use `subscription_details.default_tax_rates` instead. - explode: true - in: query - name: subscription_default_tax_rates - required: false - schema: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - style: deepObject - - description: >- - The subscription creation or modification params to apply as a - preview. Cannot be used with `schedule` or `schedule_details` - fields. - explode: true - in: query - name: subscription_details - required: false - schema: - properties: - billing_cycle_anchor: - anyOf: - - enum: - - now - - unchanged - maxLength: 5000 - type: string - - format: unix-time - type: integer - cancel_at: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - cancel_at_period_end: - type: boolean - cancel_now: - type: boolean - default_tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - items: - items: - properties: - billing_thresholds: - anyOf: - - properties: - usage_gte: - type: integer - required: - - usage_gte - title: item_billing_thresholds_param - type: object - - enum: - - '' - type: string - clear_usage: - type: boolean - deleted: - type: boolean - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - id: - maxLength: 5000 - type: string - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - recurring: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - title: recurring_adhoc - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - - recurring - title: recurring_price_data - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: subscription_item_update_params - type: object - type: array - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - proration_date: - format: unix-time - type: integer - resume_at: - enum: - - now - maxLength: 5000 - type: string - start_date: - format: unix-time - type: integer - trial_end: - anyOf: - - enum: - - now - maxLength: 5000 - type: string - - format: unix-time - type: integer - title: subscription_details_params - type: object - style: deepObject - - description: >- - A list of up to 20 subscription items, each with an attached price. - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.items` instead. - explode: true - in: query - name: subscription_items - required: false - schema: - items: - properties: - billing_thresholds: - anyOf: - - properties: - usage_gte: - type: integer - required: - - usage_gte - title: item_billing_thresholds_param - type: object - - enum: - - '' - type: string - clear_usage: - type: boolean - deleted: - type: boolean - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - id: - maxLength: 5000 - type: string - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - recurring: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - title: recurring_adhoc - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - - recurring - title: recurring_price_data - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: subscription_item_update_params - type: object - type: array - style: deepObject - - description: >- - Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) - when the billing cycle changes (e.g., when switching plans, - resetting `billing_cycle_anchor=now`, or starting a trial), or if an - item's `quantity` changes. The default value is `create_prorations`. - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.proration_behavior` instead. - in: query - name: subscription_proration_behavior - required: false - schema: - enum: - - always_invoice - - create_prorations - - none - type: string - style: form - - description: >- - If previewing an update to a subscription, and doing proration, - `subscription_proration_date` forces the proration to be calculated - as though the update was done at the specified time. The time given - must be within the current subscription period and within the - current phase of the schedule backing this subscription, if the - schedule exists. If set, `subscription`, and one of - `subscription_items`, or `subscription_trial_end` are required. - Also, `subscription_proration_behavior` cannot be set to 'none'. - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.proration_date` instead. - in: query - name: subscription_proration_date - required: false - schema: - format: unix-time - type: integer - style: form - - description: >- - For paused subscriptions, setting `subscription_resume_at` to `now` - will preview the invoice that will be generated if the subscription - is resumed. This field has been deprecated and will be removed in a - future API version. Use `subscription_details.resume_at` instead. - in: query - name: subscription_resume_at - required: false - schema: - enum: - - now - maxLength: 5000 - type: string - style: form - - description: >- - Date a subscription is intended to start (can be future or past). - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.start_date` instead. - in: query - name: subscription_start_date - required: false - schema: - format: unix-time - type: integer - style: form - - description: >- - If provided, the invoice returned will preview updating or creating - a subscription with that trial end. If set, one of - `subscription_items` or `subscription` is required. This field has - been deprecated and will be removed in a future API version. Use - `subscription_details.trial_end` instead. - explode: true - in: query - name: subscription_trial_end - required: false - schema: - anyOf: - - enum: - - now - maxLength: 5000 - type: string - - format: unix-time - type: integer - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/invoice' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: Retrieve an upcoming invoice - /v1/invoices/upcoming/lines: - get: - description: >- -

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.

- operationId: GetInvoicesUpcomingLines - parameters: - - description: Settings for automatic tax lookup for this invoice preview. - explode: true - in: query - name: automatic_tax - required: false - schema: - properties: - enabled: - type: boolean - liability: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - required: - - enabled - title: automatic_tax_param - type: object - style: deepObject - - description: >- - The ID of the coupon to apply to this phase of the subscription - schedule. This field has been deprecated and will be removed in a - future API version. Use `discounts` instead. - in: query - name: coupon - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The currency to preview this invoice in. Defaults to that of - `customer` if not specified. - in: query - name: currency - required: false - schema: - format: currency - type: string - style: form - - description: >- - The identifier of the customer whose upcoming invoice you'd like to - retrieve. If `automatic_tax` is enabled then one of `customer`, - `customer_details`, `subscription`, or `schedule` must be set. - in: query - name: customer - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - Details about the customer you want to invoice or overrides for an - existing customer. If `automatic_tax` is enabled then one of - `customer`, `customer_details`, `subscription`, or `schedule` must - be set. - explode: true - in: query - name: customer_details - required: false - schema: - properties: - address: - anyOf: - - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: optional_fields_address - type: object - - enum: - - '' - type: string - shipping: - anyOf: - - properties: - address: - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: optional_fields_customer_address - type: object - name: - maxLength: 5000 - type: string - phone: - maxLength: 5000 - type: string - required: - - address - - name - title: customer_shipping - type: object - - enum: - - '' - type: string - tax: - properties: - ip_address: - anyOf: - - type: string - - enum: - - '' - type: string - title: tax_param - type: object - tax_exempt: - enum: - - '' - - exempt - - none - - reverse - type: string - tax_ids: - items: - properties: - type: - enum: - - ad_nrt - - ae_trn - - al_tin - - am_tin - - ao_tin - - ar_cuit - - au_abn - - au_arn - - ba_tin - - bb_tin - - bg_uic - - bh_vat - - bo_tin - - br_cnpj - - br_cpf - - bs_tin - - by_tin - - ca_bn - - ca_gst_hst - - ca_pst_bc - - ca_pst_mb - - ca_pst_sk - - ca_qst - - cd_nif - - ch_uid - - ch_vat - - cl_tin - - cn_tin - - co_nit - - cr_tin - - de_stn - - do_rcn - - ec_ruc - - eg_tin - - es_cif - - eu_oss_vat - - eu_vat - - gb_vat - - ge_vat - - gn_nif - - hk_br - - hr_oib - - hu_tin - - id_npwp - - il_vat - - in_gst - - is_vat - - jp_cn - - jp_rn - - jp_trn - - ke_pin - - kh_tin - - kr_brn - - kz_bin - - li_uid - - li_vat - - ma_vat - - md_vat - - me_pib - - mk_vat - - mr_nif - - mx_rfc - - my_frp - - my_itn - - my_sst - - ng_tin - - no_vat - - no_voec - - np_pan - - nz_gst - - om_vat - - pe_ruc - - ph_tin - - ro_tin - - rs_pib - - ru_inn - - ru_kpp - - sa_vat - - sg_gst - - sg_uen - - si_tin - - sn_ninea - - sr_fin - - sv_nit - - th_vat - - tj_tin - - tr_tin - - tw_vat - - tz_vat - - ua_vat - - ug_tin - - us_ein - - uy_ruc - - uz_tin - - uz_vat - - ve_rif - - vn_tin - - za_vat - - zm_tin - - zw_tin - maxLength: 5000 + - account + - self type: string x-stripeBypassValidation: true - value: - type: string - required: - - type - - value - title: data_params - type: object - type: array - title: customer_details_param - type: object - style: deepObject - - description: >- - The coupons to redeem into discounts for the invoice preview. If not - specified, inherits the discount from the subscription or customer. - This works for both coupons directly applied to an invoice and - coupons applied to a subscription. Pass an empty string to avoid - inheriting any discounts. - explode: true - in: query - name: discounts - required: false - schema: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - style: deepObject - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: >- - List of invoice items to add or update in the upcoming invoice - preview (up to 250). - explode: true - in: query - name: invoice_items - required: false - schema: - items: - properties: - amount: - type: integer - currency: - format: currency - type: string - description: - maxLength: 5000 - type: string - discountable: - type: boolean - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - invoiceitem: - maxLength: 5000 - type: string - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - period: - properties: - end: - format: unix-time - type: integer - start: - format: unix-time - type: integer - required: - - end - - start - title: period - type: object - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - title: one_time_price_data - type: object - quantity: - type: integer - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - tax_code: - anyOf: - - type: string - - enum: - - '' - type: string - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - title: invoice_item_preview_params - type: object - type: array - style: deepObject - - description: >- - The connected account that issues the invoice. The invoice is - presented with the branding and support information of the specified - account. - explode: true - in: query - name: issuer - required: false - schema: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - The account (if any) for which the funds of the invoice payment are - intended. If set, the invoice will be presented with the branding - and support information of the specified account. See the [Invoices - with Connect](https://stripe.com/docs/billing/invoices/connect) - documentation for details. - explode: true - in: query - name: on_behalf_of - required: false - schema: - anyOf: - - type: string - - enum: - - '' - type: string - style: deepObject - - description: >- - Customizes the types of values to include when calculating the - invoice. Defaults to `next` if unspecified. - in: query - name: preview_mode - required: false - schema: - enum: - - next - - recurring - type: string - style: form - - description: >- - The identifier of the schedule whose upcoming invoice you'd like to - retrieve. Cannot be used with subscription or subscription fields. - in: query - name: schedule - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The schedule creation or modification params to apply as a preview. - Cannot be used with `subscription` or `subscription_` prefixed - fields. - explode: true - in: query - name: schedule_details - required: false - schema: - properties: - end_behavior: - enum: - - cancel - - release - type: string - phases: - items: - properties: - add_invoice_items: - items: - properties: - discounts: - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - title: one_time_price_data_with_negative_amounts - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: add_invoice_item_entry - type: object - type: array - application_fee_percent: - type: number - automatic_tax: - properties: - enabled: - type: boolean - liability: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - required: - - enabled - title: automatic_tax_config - type: object - billing_cycle_anchor: - enum: - - automatic - - phase_start - type: string - billing_thresholds: - anyOf: - - properties: - amount_gte: - type: integer - reset_billing_cycle_anchor: - type: boolean - title: billing_thresholds_param - type: object - - enum: - - '' - type: string - collection_method: - enum: - - charge_automatically - - send_invoice - type: string - coupon: - maxLength: 5000 - type: string - default_payment_method: - maxLength: 5000 - type: string - default_tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - end_date: - anyOf: - - format: unix-time - type: integer - - enum: - - now - maxLength: 5000 - type: string - invoice_settings: - properties: - account_tax_ids: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - days_until_due: - type: integer - issuer: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - title: invoice_settings - type: object - items: - items: - properties: - billing_thresholds: - anyOf: - - properties: - usage_gte: - type: integer - required: - - usage_gte - title: item_billing_thresholds_param - type: object - - enum: - - '' - type: string - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - metadata: - additionalProperties: - type: string - type: object - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - recurring: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - title: recurring_adhoc - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - - recurring - title: recurring_price_data - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: configuration_item_params - type: object - type: array - iterations: - type: integer - metadata: - additionalProperties: - type: string - type: object - on_behalf_of: - type: string - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - start_date: - anyOf: - - format: unix-time - type: integer - - enum: - - now - maxLength: 5000 - type: string - transfer_data: - properties: - amount_percent: - type: number - destination: - type: string - required: - - destination - title: transfer_data_specs - type: object - trial: - type: boolean - trial_end: - anyOf: - - format: unix-time - type: integer - - enum: - - now - maxLength: 5000 - type: string - required: - - items - title: phase_configuration_params - type: object - type: array - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - title: schedule_details_params - type: object - style: deepObject - - description: >- - A cursor for use in pagination. `starting_after` is an object ID - that defines your place in the list. For instance, if you make a - list request and receive 100 objects, ending with `obj_foo`, your - subsequent call can include `starting_after=obj_foo` in order to - fetch the next page of the list. - in: query - name: starting_after - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The identifier of the subscription for which you'd like to retrieve - the upcoming invoice. If not provided, but a - `subscription_details.items` is provided, you will preview creating - a subscription with those items. If neither `subscription` nor - `subscription_details.items` is provided, you will retrieve the next - upcoming invoice from among the customer's subscriptions. - in: query - name: subscription - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - For new subscriptions, a future timestamp to anchor the - subscription's [billing - cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is - used to determine the date of the first full invoice, and, for plans - with `month` or `year` intervals, the day of the month for - subsequent invoices. For existing subscriptions, the value can only - be set to `now` or `unchanged`. This field has been deprecated and - will be removed in a future API version. Use - `subscription_details.billing_cycle_anchor` instead. - explode: true - in: query - name: subscription_billing_cycle_anchor - required: false - schema: - anyOf: - - enum: - - now - - unchanged - maxLength: 5000 - type: string - - format: unix-time - type: integer - style: deepObject - - description: >- - A timestamp at which the subscription should cancel. If set to a - date before the current period ends, this will cause a proration if - prorations have been enabled using `proration_behavior`. If set - during a future period, this will always cause a proration for that - period. This field has been deprecated and will be removed in a - future API version. Use `subscription_details.cancel_at` instead. - explode: true - in: query - name: subscription_cancel_at - required: false - schema: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - style: deepObject - - description: >- - Indicate whether this subscription should cancel at the end of the - current period (`current_period_end`). Defaults to `false`. This - field has been deprecated and will be removed in a future API - version. Use `subscription_details.cancel_at_period_end` instead. - in: query - name: subscription_cancel_at_period_end - required: false - schema: - type: boolean - style: form - - description: >- - This simulates the subscription being canceled or expired - immediately. This field has been deprecated and will be removed in a - future API version. Use `subscription_details.cancel_now` instead. - in: query - name: subscription_cancel_now - required: false - schema: - type: boolean - style: form - - description: >- - If provided, the invoice returned will preview updating or creating - a subscription with these default tax rates. The default tax rates - will apply to any line item that does not have `tax_rates` set. This - field has been deprecated and will be removed in a future API - version. Use `subscription_details.default_tax_rates` instead. - explode: true - in: query - name: subscription_default_tax_rates - required: false - schema: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - style: deepObject - - description: >- - The subscription creation or modification params to apply as a - preview. Cannot be used with `schedule` or `schedule_details` - fields. - explode: true - in: query - name: subscription_details - required: false - schema: - properties: - billing_cycle_anchor: - anyOf: - - enum: - - now - - unchanged - maxLength: 5000 - type: string - - format: unix-time - type: integer - cancel_at: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - cancel_at_period_end: - type: boolean - cancel_now: - type: boolean - default_tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - items: - items: - properties: - billing_thresholds: - anyOf: - - properties: - usage_gte: - type: integer - required: - - usage_gte - title: item_billing_thresholds_param - type: object - - enum: - - '' - type: string - clear_usage: - type: boolean - deleted: - type: boolean - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - id: - maxLength: 5000 - type: string - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - recurring: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - title: recurring_adhoc - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - - recurring - title: recurring_price_data - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: subscription_item_update_params - type: object - type: array - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - proration_date: - format: unix-time - type: integer - resume_at: - enum: - - now - maxLength: 5000 - type: string - start_date: - format: unix-time - type: integer - trial_end: - anyOf: - - enum: - - now - maxLength: 5000 - type: string - - format: unix-time - type: integer - title: subscription_details_params - type: object - style: deepObject - - description: >- - A list of up to 20 subscription items, each with an attached price. - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.items` instead. - explode: true - in: query - name: subscription_items - required: false - schema: - items: - properties: - billing_thresholds: - anyOf: - - properties: - usage_gte: - type: integer - required: - - usage_gte - title: item_billing_thresholds_param - type: object - - enum: - - '' - type: string - clear_usage: - type: boolean - deleted: - type: boolean - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - id: - maxLength: 5000 - type: string - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string - price: - maxLength: 5000 - type: string - price_data: - properties: - currency: - format: currency - type: string - product: - maxLength: 5000 - type: string - recurring: - properties: - interval: - enum: - - day - - month - - week - - year - type: string - interval_count: - type: integer - required: - - interval - title: recurring_adhoc - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - - recurring - title: recurring_price_data - type: object - quantity: - type: integer - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - title: subscription_item_update_params - type: object - type: array - style: deepObject - - description: >- - Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) - when the billing cycle changes (e.g., when switching plans, - resetting `billing_cycle_anchor=now`, or starting a trial), or if an - item's `quantity` changes. The default value is `create_prorations`. - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.proration_behavior` instead. - in: query - name: subscription_proration_behavior - required: false - schema: - enum: - - always_invoice - - create_prorations - - none - type: string - style: form - - description: >- - If previewing an update to a subscription, and doing proration, - `subscription_proration_date` forces the proration to be calculated - as though the update was done at the specified time. The time given - must be within the current subscription period and within the - current phase of the schedule backing this subscription, if the - schedule exists. If set, `subscription`, and one of - `subscription_items`, or `subscription_trial_end` are required. - Also, `subscription_proration_behavior` cannot be set to 'none'. - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.proration_date` instead. - in: query - name: subscription_proration_date - required: false - schema: - format: unix-time - type: integer - style: form - - description: >- - For paused subscriptions, setting `subscription_resume_at` to `now` - will preview the invoice that will be generated if the subscription - is resumed. This field has been deprecated and will be removed in a - future API version. Use `subscription_details.resume_at` instead. - in: query - name: subscription_resume_at - required: false - schema: - enum: - - now - maxLength: 5000 - type: string - style: form - - description: >- - Date a subscription is intended to start (can be future or past). - This field has been deprecated and will be removed in a future API - version. Use `subscription_details.start_date` instead. - in: query - name: subscription_start_date - required: false - schema: - format: unix-time - type: integer - style: form - - description: >- - If provided, the invoice returned will preview updating or creating - a subscription with that trial end. If set, one of - `subscription_items` or `subscription` is required. This field has - been deprecated and will be removed in a future API version. Use - `subscription_details.trial_end` instead. - explode: true - in: query - name: subscription_trial_end - required: false - schema: - anyOf: - - enum: - - now - maxLength: 5000 - type: string - - format: unix-time - type: integer - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - description: '' - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/line_item' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: InvoiceLinesList - type: object - x-expandableFields: - - data - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: Retrieve an upcoming invoice's line items - '/v1/invoices/{invoice}': - delete: - description: >- -

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.

- operationId: DeleteInvoicesInvoice - parameters: - - in: path - name: invoice - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deleted_invoice' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: Delete a draft invoice - get: - description:

Retrieves the invoice with the given ID.

- operationId: GetInvoicesInvoice - parameters: - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - in: path - name: invoice - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/invoice' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: Retrieve an invoice - post: - description: >- -

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.

- operationId: PostInvoicesInvoice - parameters: - - in: path - name: invoice - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - account_tax_ids: - explode: true - style: deepObject - automatic_tax: - explode: true - style: deepObject - custom_fields: - explode: true - style: deepObject - default_source: - explode: true - style: deepObject - default_tax_rates: - explode: true - style: deepObject - discounts: - explode: true - style: deepObject - effective_at: - explode: true - style: deepObject - expand: - explode: true - style: deepObject - issuer: - explode: true - style: deepObject - metadata: - explode: true - style: deepObject - number: - explode: true - style: deepObject - on_behalf_of: - explode: true - style: deepObject - payment_settings: - explode: true - style: deepObject - rendering: - explode: true - style: deepObject - shipping_cost: - explode: true - style: deepObject - shipping_details: - explode: true - style: deepObject - transfer_data: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - account_tax_ids: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: >- - The account tax IDs associated with the invoice. Only - editable when the invoice is a draft. - application_fee_amount: - description: >- - A fee in cents (or local equivalent) that will be applied to - the invoice and transferred to the application owner's - Stripe account. The request must be made with an OAuth key - or the Stripe-Account header in order to take an application - fee. For more information, see the application fees - [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). - type: integer - auto_advance: - description: >- - Controls whether Stripe performs [automatic - collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) - of the invoice. - type: boolean - automatic_tax: - description: Settings for automatic tax lookup for this invoice. - properties: - enabled: - type: boolean - liability: - properties: - account: - type: string - type: - enum: - - account - - self - type: string - required: - - type - title: param - type: object - required: - - enabled - title: automatic_tax_param - type: object - automatically_finalizes_at: - description: >- - The time when this invoice should be scheduled to finalize. - The invoice will be finalized at this time if it is still in - draft state. To turn off automatic finalization, set - `auto_advance` to false. - format: unix-time - type: integer - collection_method: - description: >- - Either `charge_automatically` or `send_invoice`. This field - can be updated only on `draft` invoices. - enum: - - charge_automatically - - send_invoice - type: string - custom_fields: - anyOf: - - items: - properties: - name: - maxLength: 40 - type: string - value: - maxLength: 140 - type: string - required: - - name - - value - title: custom_field_params - type: object - type: array - - enum: - - '' - type: string - description: >- - A list of up to 4 custom fields to be displayed on the - invoice. If a value for `custom_fields` is specified, the - list specified will replace the existing custom field list - on this invoice. Pass an empty string to remove - previously-defined fields. - days_until_due: - description: >- - The number of days from which the invoice is created until - it is due. Only valid for invoices where - `collection_method=send_invoice`. This field can only be - updated on `draft` invoices. - type: integer - default_payment_method: - description: >- - ID of the default payment method for the invoice. It must - belong to the customer associated with the invoice. If not - set, defaults to the subscription's default payment method, - if any, or to the default payment method in the customer's - invoice settings. - maxLength: 5000 - type: string - default_source: - anyOf: - - maxLength: 5000 - type: string - - enum: - - '' - type: string - description: >- - ID of the default payment source for the invoice. It must - belong to the customer associated with the invoice and be in - a chargeable state. If not set, defaults to the - subscription's default source, if any, or to the customer's - default source. - default_tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: >- - The tax rates that will apply to any line item that does not - have `tax_rates` set. Pass an empty string to remove - previously-defined tax rates. - description: - description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. Referenced as 'memo' in the Dashboard. - maxLength: 1500 - type: string - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - promotion_code: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: - - '' - type: string - description: >- - The discounts that will apply to the invoice. Pass an empty - string to remove previously-defined discounts. - due_date: - description: >- - The date on which payment for this invoice is due. Only - valid for invoices where `collection_method=send_invoice`. - This field can only be updated on `draft` invoices. - format: unix-time - type: integer - effective_at: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - description: >- - The date when this invoice is in effect. Same as - `finalized_at` unless overwritten. When defined, this value - replaces the system-generated 'Date of issue' printed on the - invoice PDF and receipt. - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - footer: - description: Footer to be displayed on the invoice. - maxLength: 5000 - type: string - issuer: - description: >- - The connected account that issues the invoice. The invoice - is presented with the branding and support information of - the specified account. - properties: - account: - type: string - type: - enum: - - account - - self - type: string required: - type title: param @@ -87384,7 +95393,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -87418,7 +95427,7 @@ paths: payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with - Connect](https://stripe.com/docs/billing/invoices/connect) + Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details. payment_settings: description: >- @@ -87491,9 +95500,10 @@ paths: type: string type: enum: + - bonus - fixed_count + - revolving type: string - x-stripeBypassValidation: true required: - type title: installment_plan @@ -87547,6 +95557,34 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + type: integer + purpose: + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: mandate_options_param + type: object + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: {} @@ -87615,6 +95653,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -87622,6 +95661,8 @@ paths: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -87630,15 +95671,19 @@ paths: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -87928,7 +95973,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -87988,9 +96033,6 @@ paths: - start title: period type: object - price: - maxLength: 5000 - type: string price_data: properties: currency: @@ -88018,6 +96060,9 @@ paths: tax_code: maxLength: 5000 type: string + unit_label: + maxLength: 12 + type: string required: - name title: product_data @@ -88037,6 +96082,13 @@ paths: - currency title: one_time_price_data_with_product_data type: object + pricing: + properties: + price: + maxLength: 5000 + type: string + title: pricing_param + type: object quantity: type: integer tax_amounts: @@ -88061,10 +96113,19 @@ paths: jurisdiction: maxLength: 200 type: string + jurisdiction_level: + enum: + - city + - country + - county + - district + - multiple + - state + type: string percentage: type: number state: - maxLength: 2 + maxLength: 5000 type: string tax_type: enum: @@ -88090,6 +96151,25 @@ paths: - percentage title: tax_rate_data_param type: object + taxability_reason: + enum: + - customer_exempt + - not_collecting + - not_subject_to_tax + - not_supported + - portion_product_exempt + - portion_reduced_rated + - portion_standard_rated + - product_exempt + - product_exempt_holiday + - proportionally_rated + - reduced_rated + - reverse_charge + - standard_rated + - taxable_basis_reduced + - zero_rated + type: string + x-stripeBypassValidation: true taxable_amount: type: integer required: @@ -88132,6 +96212,79 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Bulk add invoice line items + '/v1/invoices/{invoice}/attach_payment': + post: + description: >- +

Attaches a PaymentIntent or an Out of Band Payment to the invoice, + adding it to the list of payments.

+ + +

For the PaymentIntent, when the PaymentIntent’s status changes to + succeeded, the payment is credited + + to the invoice, increasing its amount_paid. When the + invoice is fully paid, the + + invoice’s status becomes paid.

+ + +

If the PaymentIntent’s status is already succeeded when + it’s attached, it’s + + credited to the invoice immediately.

+ + +

See: Partial payments + to learn more.

+ operationId: PostInvoicesInvoiceAttachPayment + parameters: + - in: path + name: invoice + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + payment_intent: + description: The ID of the PaymentIntent to attach to the invoice. + maxLength: 5000 + type: string + payment_record: + description: The ID of the PaymentRecord to attach to the invoice. + maxLength: 5000 + type: string + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoice' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Attach a payment to an Invoice '/v1/invoices/{invoice}/finalize': post: description: >- @@ -88160,7 +96313,7 @@ paths: auto_advance: description: >- Controls whether Stripe performs [automatic - collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) + collection](https://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. type: boolean @@ -88353,6 +96506,9 @@ paths: price_data: explode: true style: deepObject + pricing: + explode: true + style: deepObject tax_amounts: explode: true style: deepObject @@ -88422,13 +96578,13 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For - [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) + [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) @@ -88439,10 +96595,10 @@ paths: The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue - Recognition](https://stripe.com/docs/revenue-recognition) + Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition - documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) + documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details. properties: end: @@ -88456,17 +96612,10 @@ paths: - start title: period type: object - price: - description: >- - The ID of the price object. One of `price` or `price_data` - is required. - maxLength: 5000 - type: string price_data: description: >- Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object inline. - One of `price` or `price_data` is required. + [Price](https://docs.stripe.com/api/prices) object inline. properties: currency: format: currency @@ -88493,6 +96642,9 @@ paths: tax_code: maxLength: 5000 type: string + unit_label: + maxLength: 12 + type: string required: - name title: product_data @@ -88512,6 +96664,14 @@ paths: - currency title: one_time_price_data_with_product_data type: object + pricing: + description: The pricing information for the invoice item. + properties: + price: + maxLength: 5000 + type: string + title: pricing_param + type: object quantity: description: >- Non-negative integer. The quantity of units for the line @@ -88539,10 +96699,19 @@ paths: jurisdiction: maxLength: 200 type: string + jurisdiction_level: + enum: + - city + - country + - county + - district + - multiple + - state + type: string percentage: type: number state: - maxLength: 2 + maxLength: 5000 type: string tax_type: enum: @@ -88568,6 +96737,25 @@ paths: - percentage title: tax_rate_data_param type: object + taxability_reason: + enum: + - customer_exempt + - not_collecting + - not_subject_to_tax + - not_supported + - portion_product_exempt + - portion_reduced_rated + - portion_standard_rated + - product_exempt + - product_exempt_holiday + - proportionally_rated + - reduced_rated + - reverse_charge + - standard_rated + - taxable_basis_reduced + - zero_rated + type: string + x-stripeBypassValidation: true taxable_amount: type: integer required: @@ -88585,11 +96773,11 @@ paths: be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has - [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) + [tax_rates](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has - [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) + [default_tax_rates](https://docs.stripe.com/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic - tax](https://stripe.com/docs/tax/invoicing). Pass an empty + tax](https://docs.stripe.com/tax/invoicing). Pass an empty string to remove previously defined tax amounts. tax_rates: anyOf: @@ -88821,7 +97009,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -88964,13 +97152,13 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For - [type=subscription](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-type) + [type=subscription](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-type) line items, the incoming metadata specified on the request is directly used to set this value, in contrast to [type=invoiceitem](api/invoices/line_item#invoice_line_item_object-type) @@ -89030,9 +97218,6 @@ paths: - start title: period type: object - price: - maxLength: 5000 - type: string price_data: properties: currency: @@ -89060,6 +97245,9 @@ paths: tax_code: maxLength: 5000 type: string + unit_label: + maxLength: 12 + type: string required: - name title: product_data @@ -89079,6 +97267,13 @@ paths: - currency title: one_time_price_data_with_product_data type: object + pricing: + properties: + price: + maxLength: 5000 + type: string + title: pricing_param + type: object quantity: type: integer tax_amounts: @@ -89103,10 +97298,19 @@ paths: jurisdiction: maxLength: 200 type: string + jurisdiction_level: + enum: + - city + - country + - county + - district + - multiple + - state + type: string percentage: type: number state: - maxLength: 2 + maxLength: 5000 type: string tax_type: enum: @@ -89132,6 +97336,25 @@ paths: - percentage title: tax_rate_data_param type: object + taxability_reason: + enum: + - customer_exempt + - not_collecting + - not_subject_to_tax + - not_supported + - portion_product_exempt + - portion_reduced_rated + - portion_standard_rated + - product_exempt + - product_exempt_holiday + - proportionally_rated + - reduced_rated + - reverse_charge + - standard_rated + - taxable_basis_reduced + - zero_rated + type: string + x-stripeBypassValidation: true taxable_amount: type: integer required: @@ -89333,10 +97556,10 @@ paths: schema: enum: - closed + - expired - pending - reversed type: string - x-stripeBypassValidation: true style: form requestBody: content: @@ -89481,7 +97704,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -89543,7 +97766,7 @@ paths: `pending_request.is_amount_controllable` property is `true`, you may provide this value to control how much to hold for the authorization. Must be positive (use - [`decline`](https://stripe.com/docs/api/issuing/authorizations/decline) + [`decline`](https://docs.stripe.com/api/issuing/authorizations/decline) to decline an authorization request). type: integer expand: @@ -89562,7 +97785,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -89634,7 +97857,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -89972,7 +98195,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -89992,14 +98215,14 @@ paths: provided in that format already. This is required for all cardholders who will be creating EU cards. See the [3D Secure - documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) + documentation](https://docs.stripe.com/issuing/3d-secure#when-is-3d-secure-applied) for more details. type: string preferred_locales: description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. items: enum: - de @@ -90013,7 +98236,7 @@ paths: description: >- Rules that control spending across this cardholder's cards. Refer to our - [documentation](https://stripe.com/docs/issuing/controls/spending-controls) + [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. properties: allowed_categories: @@ -90995,7 +99218,7 @@ paths: type: description: >- One of `individual` or `company`. See [Choose a cardholder - type](https://stripe.com/docs/issuing/other/choose-cardholder) + type](https://docs.stripe.com/issuing/other/choose-cardholder) for more details. enum: - company @@ -91222,7 +99445,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -91234,14 +99457,14 @@ paths: The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure - documentation](https://stripe.com/docs/issuing/3d-secure) + documentation](https://docs.stripe.com/issuing/3d-secure) for more details. type: string preferred_locales: description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + This changes the language of the [3D Secure flow](https://docs.stripe.com/issuing/3d-secure) and one-time password messages sent to the cardholder. items: enum: - de @@ -91255,7 +99478,7 @@ paths: description: >- Rules that control spending across this cardholder's cards. Refer to our - [documentation](https://stripe.com/docs/issuing/controls/spending-controls) + [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. properties: allowed_categories: @@ -92472,13 +100695,25 @@ paths: cardholder: description: >- The - [Cardholder](https://stripe.com/docs/api#issuing_cardholder_object) + [Cardholder](https://docs.stripe.com/api#issuing_cardholder_object) object with which the card will be associated. maxLength: 5000 type: string currency: description: The currency for the card. type: string + exp_month: + description: >- + The desired expiration month (1-12) for this card if + [specifying a custom expiration + date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates). + type: integer + exp_year: + description: >- + The desired 4-digit expiration year for this card if + [specifying a custom expiration + date](/issuing/cards/virtual/issue-cards?testing-method=with-code#exp-dates). + type: integer expand: description: Specifies which fields in the response should be expanded. items: @@ -92486,13 +100721,17 @@ paths: type: string type: array financial_account: + description: >- + The new financial account ID the card will be associated + with. This field allows a card to be reassigned to a + different financial account. type: string metadata: additionalProperties: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -92612,7 +100851,7 @@ paths: spending_controls: description: >- Rules that control spending for this card. Refer to our - [documentation](https://stripe.com/docs/issuing/controls/spending-controls) + [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. properties: allowed_categories: @@ -93722,7 +101961,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -93815,7 +102054,7 @@ paths: spending_controls: description: >- Rules that control spending for this card. Refer to our - [documentation](https://stripe.com/docs/issuing/controls/spending-controls) + [documentation](https://docs.stripe.com/issuing/controls/spending-controls) for more details. properties: allowed_categories: @@ -94998,7 +103237,7 @@ paths: description: >- The dispute amount in the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). If + unit](https://docs.stripe.com/currencies#zero-decimal). If not set, defaults to the full transaction amount. type: integer evidence: @@ -95352,7 +103591,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -95473,7 +103712,7 @@ paths: description: >- The dispute amount in the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer evidence: description: Evidence provided for the dispute. @@ -95831,7 +104070,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -95899,7 +104138,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -96147,7 +104386,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -96355,7 +104594,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -96670,7 +104909,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -97187,7 +105426,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -97247,6 +105486,9 @@ paths: customer: maxLength: 5000 type: string + customer_account: + maxLength: 5000 + type: string type: enum: - account @@ -97409,6 +105651,9 @@ paths: customer: maxLength: 5000 type: string + customer_account: + maxLength: 5000 + type: string title: accountholder_params type: object style: deepObject @@ -97844,6 +106089,155 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Retrieve a Mandate + /v1/payment_attempt_records: + get: + description: >- +

List all the Payment Attempt Records attached to the specified + Payment Record.

+ operationId: GetPaymentAttemptRecords + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: The ID of the Payment Record. + in: query + name: payment_record + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: A list of PaymentAttemptRecords. + properties: + data: + items: + $ref: '#/components/schemas/payment_attempt_record' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: >- + PaymentsPrimitivesPaymentRecordsResourcePaymentAttemptRecordList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: List Payment Attempt Records + '/v1/payment_attempt_records/{id}': + get: + description:

Retrieves a Payment Attempt Record with the given ID

+ operationId: GetPaymentAttemptRecordsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The ID of the Payment Attempt Record. + 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/payment_attempt_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve a Payment Attempt Record /v1/payment_intents: get: description:

Returns a list of PaymentIntents.

@@ -97882,6 +106276,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return PaymentIntents for the account representing the customer + that this ID specifies. + in: query + name: customer_account + 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 @@ -98011,12 +106415,21 @@ paths: content: application/x-www-form-urlencoded: encoding: + amount_details: + explode: true + style: deepObject automatic_payment_methods: explode: true style: deepObject + excluded_payment_method_types: + explode: true + style: deepObject expand: explode: true style: deepObject + hooks: + explode: true + style: deepObject mandate_data: explode: true style: deepObject @@ -98026,6 +106439,9 @@ paths: off_session: explode: true style: deepObject + payment_details: + explode: true + style: deepObject payment_method_data: explode: true style: deepObject @@ -98052,23 +106468,168 @@ paths: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge - currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). + currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer + amount_details: + description: Provides industry-specific information about the amount. + properties: + discount_amount: + anyOf: + - type: integer + - enum: + - '' + type: string + enforce_arithmetic_validation: + type: boolean + line_items: + anyOf: + - items: + properties: + discount_amount: + type: integer + payment_method_options: + properties: + card: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + card_present: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + klarna: + properties: + image_url: + maxLength: 4096 + type: string + product_url: + maxLength: 4096 + type: string + reference: + maxLength: 255 + type: string + subscription_reference: + maxLength: 255 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + paypal: + properties: + category: + enum: + - digital_goods + - donation + - physical_goods + type: string + description: + maxLength: 127 + type: string + sold_by: + maxLength: 127 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + title: >- + amount_details_line_item_payment_method_options_param + type: object + product_code: + maxLength: 12 + type: string + product_name: + maxLength: 1024 + type: string + quantity: + type: integer + tax: + properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_line_item_tax_param + type: object + unit_cost: + type: integer + unit_of_measure: + maxLength: 12 + type: string + required: + - product_name + - quantity + - unit_cost + title: amount_details_line_item_param + type: object + type: array + - enum: + - '' + type: string + shipping: + anyOf: + - properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + from_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + to_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + title: amount_details_shipping_param + type: object + - enum: + - '' + type: string + tax: + anyOf: + - properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_tax_param + type: object + - enum: + - '' + type: string + title: amount_details_param + type: object application_fee_amount: description: >- The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the - application fee collected will be capped at the total - payment amount. For more information, see the PaymentIntents - [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + application fee collected will be capped at the total amount + captured. For more information, see the PaymentIntents [use + case for connected + accounts](https://docs.stripe.com/payments/connected-accounts). type: integer automatic_payment_methods: description: >- @@ -98099,12 +106660,12 @@ paths: confirm: description: >- Set to `true` to attempt to [confirm this - PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) + PaymentIntent](https://docs.stripe.com/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm - API](https://stripe.com/docs/api/payment_intents/confirm). + API](https://docs.stripe.com/api/payment_intents/confirm). type: boolean confirmation_method: description: >- @@ -98146,7 +106707,7 @@ paths: If - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any @@ -98157,6 +106718,28 @@ paths: to the Customer instead. maxLength: 5000 type: string + customer_account: + description: >- + ID of the Account representing the customer that this + PaymentIntent belongs to, if one exists. + + + Payment methods attached to other Accounts cannot be used + with this PaymentIntent. + + + If + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) + is set and this PaymentIntent's payment method is not + `card_present`, then the payment method attaches to the + Account after the PaymentIntent has been confirmed and any + required actions from the user are complete. If the payment + method is `card_present` and isn't a digital wallet, then a + [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Account instead. + maxLength: 5000 + type: string description: description: >- An arbitrary string attached to the object. Often useful for @@ -98169,21 +106752,101 @@ paths: PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without - authentication](https://stripe.com/docs/payments/save-card-without-authentication). + authentication](https://docs.stripe.com/payments/save-card-without-authentication). This parameter can only be used with - [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). type: boolean + excluded_payment_method_types: + description: >- + The list of payment method types to exclude from use with + this payment. + items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + type: array expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + hooks: + description: Automations to be run during the PaymentIntent lifecycle + properties: + inputs: + properties: + tax: + properties: + calculation: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - calculation + title: async_workflows_inputs_tax_param + type: object + title: async_workflows_inputs_param + type: object + title: async_workflows_param + type: object mandate: description: >- ID of the mandate that's used for this payment. This parameter can only be used with - [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). maxLength: 5000 type: string mandate_data: @@ -98230,13 +106893,13 @@ paths: description: >- This hash contains details about the Mandate to create. This parameter can only be used with - [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). metadata: additionalProperties: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -98256,20 +106919,39 @@ paths: checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them - later](https://stripe.com/docs/payments/cards/charging-saved-cards). + later](https://docs.stripe.com/payments/cards/charging-saved-cards). This parameter can only be used with - [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). on_behalf_of: description: >- The Stripe account ID that these funds are intended for. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). type: string + payment_details: + description: Provides industry-specific information about the charge. + properties: + customer_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + order_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: payment_details + type: object payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or [compatible - Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) + Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. @@ -98278,12 +106960,17 @@ paths: payment instrument to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward. + + If the payment method is attached to a Customer, you must + also provide the ID of that Customer as the + [customer](https://api.stripe.com#create_payment_intent-customer) + parameter of this PaymentIntent. maxLength: 5000 type: string payment_method_configuration: description: >- The ID of the [payment method - configuration](https://stripe.com/docs/api/payment_method_configurations) + configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. maxLength: 100 type: string @@ -98293,7 +106980,7 @@ paths: PaymentMethod. The new PaymentMethod will appear in the - [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. properties: @@ -98367,6 +107054,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -98415,6 +107106,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -98434,6 +107128,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -98520,11 +107218,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -98577,6 +107279,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -98599,6 +107305,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -98653,6 +107386,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -98676,6 +107422,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -98719,9 +107469,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -98733,19 +107485,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -98830,6 +107586,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string verification_method: enum: - automatic @@ -98939,6 +107698,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -98965,6 +107727,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -98991,6 +107756,19 @@ paths: - enum: - '' type: string + billie: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string blik: anyOf: - properties: @@ -99033,6 +107811,7 @@ paths: - '' - manual type: string + x-stripeBypassValidation: true cvc_token: maxLength: 5000 type: string @@ -99051,9 +107830,10 @@ paths: type: string type: enum: + - bonus - fixed_count + - revolving type: string - x-stripeBypassValidation: true required: - type title: installment_plan @@ -99240,6 +108020,8 @@ paths: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 type: string x-stripeBypassValidation: true required: @@ -99256,6 +108038,11 @@ paths: card_present: anyOf: - properties: + capture_method: + enum: + - manual + - manual_preferred + type: string request_extended_authorization: type: boolean request_incremental_authorization_support: @@ -99294,6 +108081,19 @@ paths: - enum: - '' type: string + crypto: + anyOf: + - properties: + setup_future_usage: + enum: + - none + type: string + x-stripeBypassValidation: true + title: payment_method_options_param + type: object + - enum: + - '' + type: string customer_balance: anyOf: - properties: @@ -99444,6 +108244,25 @@ paths: - '' - manual type: string + on_demand: + properties: + average_amount: + type: integer + maximum_amount: + type: integer + minimum_amount: + type: integer + purchase_interval: + enum: + - day + - month + - week + - year + type: string + purchase_interval_count: + type: integer + title: on_demand_param + type: object preferred_locale: enum: - cs-CZ @@ -99497,8 +108316,49 @@ paths: setup_future_usage: enum: - none + - off_session + - on_session type: string - x-stripeBypassValidation: true + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - reference + title: subscription_param + type: object + type: array + - enum: + - '' + type: string title: payment_method_options_param type: object - enum: @@ -99581,6 +108441,18 @@ paths: - enum: - '' type: string + mb_way: + anyOf: + - properties: + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string mobilepay: anyOf: - properties: @@ -99618,11 +108490,35 @@ paths: - '' - manual type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string title: payment_method_options_param type: object - enum: - '' type: string + nz_bank_account: + anyOf: + - properties: + setup_future_usage: + enum: + - '' + - none + - off_session + - on_session + type: string + target_date: + maxLength: 5000 + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -99734,9 +108630,85 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: >- + payment_intent_payment_method_options_mandate_options_param + type: object + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string pix: anyOf: - properties: + amount_includes_iof: + enum: + - always + - never + type: string expires_after_seconds: type: integer expires_at: @@ -99746,6 +108718,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -99795,6 +108768,19 @@ paths: - enum: - '' type: string + satispay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -99816,6 +108802,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -99872,6 +108861,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -99940,12 +108930,6 @@ paths: type: array title: networks_options_param type: object - preferred_settlement_speed: - enum: - - '' - - fastest - - standard - type: string setup_future_usage: enum: - '' @@ -99953,6 +108937,17 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string + transaction_purpose: + enum: + - '' + - goods + - other + - services + - unspecified + type: string verification_method: enum: - automatic @@ -99982,8 +108977,6 @@ paths: enum: - none type: string - required: - - client title: payment_method_options_param type: object - enum: @@ -100010,6 +109003,8 @@ paths: Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + A list of valid payment method types can be found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string @@ -100017,12 +109012,12 @@ paths: radar_options: description: >- Options to configure Radar. Learn more about [Radar - Sessions](https://stripe.com/docs/radar/radar-session). + Sessions](https://docs.stripe.com/radar/radar-session). properties: session: maxLength: 5000 type: string - title: radar_options_with_hidden_options + title: radar_options_with_peval_options type: object receipt_email: description: >- @@ -100038,7 +109033,7 @@ paths: app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with - [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm). + [`confirm=true`](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-confirm). type: string setup_future_usage: description: >- @@ -100143,7 +109138,7 @@ paths: Transfer. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). properties: amount: type: integer @@ -100157,7 +109152,7 @@ paths: description: >- A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected - accounts](https://stripe.com/docs/connect/separate-charges-and-transfers). + accounts](https://docs.stripe.com/connect/separate-charges-and-transfers). type: string use_stripe_sdk: description: >- @@ -100233,9 +109228,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for payment - intents](https://stripe.com/docs/search#query-fields-for-payment-intents). + intents](https://docs.stripe.com/search#query-fields-for-payment-intents). in: query name: query required: true @@ -100400,15 +109395,27 @@ paths: content: application/x-www-form-urlencoded: encoding: + amount_details: + explode: true + style: deepObject application_fee_amount: explode: true style: deepObject + excluded_payment_method_types: + explode: true + style: deepObject expand: explode: true style: deepObject + hooks: + explode: true + style: deepObject metadata: explode: true style: deepObject + payment_details: + explode: true + style: deepObject payment_method_data: explode: true style: deepObject @@ -100435,14 +109442,163 @@ paths: Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge - currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). + currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). type: integer + amount_details: + anyOf: + - properties: + discount_amount: + anyOf: + - type: integer + - enum: + - '' + type: string + enforce_arithmetic_validation: + type: boolean + line_items: + anyOf: + - items: + properties: + discount_amount: + type: integer + payment_method_options: + properties: + card: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + card_present: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + klarna: + properties: + image_url: + maxLength: 4096 + type: string + product_url: + maxLength: 4096 + type: string + reference: + maxLength: 255 + type: string + subscription_reference: + maxLength: 255 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + paypal: + properties: + category: + enum: + - digital_goods + - donation + - physical_goods + type: string + description: + maxLength: 127 + type: string + sold_by: + maxLength: 127 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + title: >- + amount_details_line_item_payment_method_options_param + type: object + product_code: + maxLength: 12 + type: string + product_name: + maxLength: 1024 + type: string + quantity: + type: integer + tax: + properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_line_item_tax_param + type: object + unit_cost: + type: integer + unit_of_measure: + maxLength: 12 + type: string + required: + - product_name + - quantity + - unit_cost + title: amount_details_line_item_param + type: object + type: array + - enum: + - '' + type: string + shipping: + anyOf: + - properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + from_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + to_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + title: amount_details_shipping_param + type: object + - enum: + - '' + type: string + tax: + anyOf: + - properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_tax_param + type: object + - enum: + - '' + type: string + title: amount_details_param + type: object + - enum: + - '' + type: string + description: Provides industry-specific information about the amount. application_fee_amount: anyOf: - type: integer @@ -100453,10 +109609,10 @@ paths: The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the - application fee collected will be capped at the total - payment amount. For more information, see the PaymentIntents - [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + application fee collected will be capped at the total amount + captured. For more information, see the PaymentIntents [use + case for connected + accounts](https://docs.stripe.com/payments/connected-accounts). capture_method: description: >- Controls when the funds will be captured from the customer's @@ -100485,7 +109641,7 @@ paths: If - [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) is set and this PaymentIntent's payment method is not `card_present`, then the payment method attaches to the Customer after the PaymentIntent has been confirmed and any @@ -100496,18 +109652,124 @@ paths: to the Customer instead. maxLength: 5000 type: string + customer_account: + description: >- + ID of the Account representing the customer that this + PaymentIntent belongs to, if one exists. + + + Payment methods attached to other Accounts cannot be used + with this PaymentIntent. + + + If + [setup_future_usage](https://api.stripe.com#payment_intent_object-setup_future_usage) + is set and this PaymentIntent's payment method is not + `card_present`, then the payment method attaches to the + Account after the PaymentIntent has been confirmed and any + required actions from the user are complete. If the payment + method is `card_present` and isn't a digital wallet, then a + [generated_card](https://docs.stripe.com/api/charges/object#charge_object-payment_method_details-card_present-generated_card) + payment method representing the card is created and attached + to the Account instead. + maxLength: 5000 + type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string + excluded_payment_method_types: + anyOf: + - items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + type: array + - enum: + - '' + type: string + description: >- + The list of payment method types to exclude from use with + this payment. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + hooks: + description: Automations to be run during the PaymentIntent lifecycle + properties: + inputs: + properties: + tax: + properties: + calculation: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - calculation + title: async_workflows_inputs_tax_param + type: object + title: async_workflows_inputs_param + type: object + title: async_workflows_param + type: object metadata: anyOf: - additionalProperties: @@ -100518,17 +109780,40 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + payment_details: + anyOf: + - properties: + customer_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + order_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: payment_details + type: object + - enum: + - '' + type: string + description: Provides industry-specific information about the charge. payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or [compatible - Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) + Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. To unset this field to null, pass in an empty string. maxLength: 5000 @@ -100536,7 +109821,7 @@ paths: payment_method_configuration: description: >- The ID of the [payment method - configuration](https://stripe.com/docs/api/payment_method_configurations) + configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this PaymentIntent. maxLength: 100 type: string @@ -100546,7 +109831,7 @@ paths: PaymentMethod. The new PaymentMethod will appear in the - [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. properties: @@ -100620,6 +109905,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -100668,6 +109957,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -100687,6 +109979,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -100773,11 +110069,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -100830,6 +110130,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -100852,6 +110156,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -100906,6 +110237,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -100929,6 +110273,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -100972,9 +110320,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -100986,19 +110336,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -101083,6 +110437,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string verification_method: enum: - automatic @@ -101192,6 +110549,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -101218,6 +110578,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -101244,6 +110607,19 @@ paths: - enum: - '' type: string + billie: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string blik: anyOf: - properties: @@ -101286,6 +110662,7 @@ paths: - '' - manual type: string + x-stripeBypassValidation: true cvc_token: maxLength: 5000 type: string @@ -101304,9 +110681,10 @@ paths: type: string type: enum: + - bonus - fixed_count + - revolving type: string - x-stripeBypassValidation: true required: - type title: installment_plan @@ -101493,6 +110871,8 @@ paths: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 type: string x-stripeBypassValidation: true required: @@ -101509,6 +110889,11 @@ paths: card_present: anyOf: - properties: + capture_method: + enum: + - manual + - manual_preferred + type: string request_extended_authorization: type: boolean request_incremental_authorization_support: @@ -101547,6 +110932,19 @@ paths: - enum: - '' type: string + crypto: + anyOf: + - properties: + setup_future_usage: + enum: + - none + type: string + x-stripeBypassValidation: true + title: payment_method_options_param + type: object + - enum: + - '' + type: string customer_balance: anyOf: - properties: @@ -101697,6 +111095,25 @@ paths: - '' - manual type: string + on_demand: + properties: + average_amount: + type: integer + maximum_amount: + type: integer + minimum_amount: + type: integer + purchase_interval: + enum: + - day + - month + - week + - year + type: string + purchase_interval_count: + type: integer + title: on_demand_param + type: object preferred_locale: enum: - cs-CZ @@ -101750,8 +111167,49 @@ paths: setup_future_usage: enum: - none + - off_session + - on_session type: string - x-stripeBypassValidation: true + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - reference + title: subscription_param + type: object + type: array + - enum: + - '' + type: string title: payment_method_options_param type: object - enum: @@ -101834,6 +111292,18 @@ paths: - enum: - '' type: string + mb_way: + anyOf: + - properties: + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string mobilepay: anyOf: - properties: @@ -101871,11 +111341,35 @@ paths: - '' - manual type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string title: payment_method_options_param type: object - enum: - '' type: string + nz_bank_account: + anyOf: + - properties: + setup_future_usage: + enum: + - '' + - none + - off_session + - on_session + type: string + target_date: + maxLength: 5000 + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -101987,9 +111481,85 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: >- + payment_intent_payment_method_options_mandate_options_param + type: object + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string pix: anyOf: - properties: + amount_includes_iof: + enum: + - always + - never + type: string expires_after_seconds: type: integer expires_at: @@ -101999,6 +111569,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -102048,6 +111619,19 @@ paths: - enum: - '' type: string + satispay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -102069,6 +111653,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -102125,6 +111712,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -102193,12 +111781,6 @@ paths: type: array title: networks_options_param type: object - preferred_settlement_speed: - enum: - - '' - - fastest - - standard - type: string setup_future_usage: enum: - '' @@ -102206,6 +111788,17 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string + transaction_purpose: + enum: + - '' + - goods + - other + - services + - unspecified + type: string verification_method: enum: - automatic @@ -102235,8 +111828,6 @@ paths: enum: - none type: string - required: - - client title: payment_method_options_param type: object - enum: @@ -102262,6 +111853,8 @@ paths: this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). + A list of valid payment method types can be found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string @@ -102390,7 +111983,7 @@ paths: Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). properties: amount: type: integer @@ -102401,7 +111994,7 @@ paths: A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). type: string type: object required: false @@ -102419,6 +112012,119 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Update a PaymentIntent + '/v1/payment_intents/{intent}/amount_details_line_items': + get: + description:

Lists all LineItems of a given PaymentIntent.

+ operationId: GetPaymentIntentsIntentAmountDetailsLineItems + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: intent + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + A cursor for use in pagination. `starting_after` is an object ID + that defines your place in the list. For instance, if you make a + list request and receive 100 objects, ending with `obj_foo`, your + subsequent call can include `starting_after=obj_foo` in order to + fetch the next page of the list. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: >- + #/components/schemas/payment_intent_amount_details_line_item + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: PaymentFlowsAmountDetailsResourceLineItemsList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: List all PaymentIntent LineItems '/v1/payment_intents/{intent}/apply_customer_balance': post: description: >- @@ -102453,7 +112159,7 @@ paths: A positive integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) (for + unit](https://docs.stripe.com/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. @@ -102592,34 +112298,187 @@ paths: content: application/x-www-form-urlencoded: encoding: + amount_details: + explode: true + style: deepObject expand: explode: true style: deepObject + hooks: + explode: true + style: deepObject metadata: explode: true style: deepObject + payment_details: + explode: true + style: deepObject transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: + amount_details: + description: Provides industry-specific information about the amount. + properties: + discount_amount: + anyOf: + - type: integer + - enum: + - '' + type: string + enforce_arithmetic_validation: + type: boolean + line_items: + anyOf: + - items: + properties: + discount_amount: + type: integer + payment_method_options: + properties: + card: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + card_present: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + klarna: + properties: + image_url: + maxLength: 4096 + type: string + product_url: + maxLength: 4096 + type: string + reference: + maxLength: 255 + type: string + subscription_reference: + maxLength: 255 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + paypal: + properties: + category: + enum: + - digital_goods + - donation + - physical_goods + type: string + description: + maxLength: 127 + type: string + sold_by: + maxLength: 127 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + title: >- + amount_details_line_item_payment_method_options_param + type: object + product_code: + maxLength: 12 + type: string + product_name: + maxLength: 1024 + type: string + quantity: + type: integer + tax: + properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_line_item_tax_param + type: object + unit_cost: + type: integer + unit_of_measure: + maxLength: 12 + type: string + required: + - product_name + - quantity + - unit_cost + title: amount_details_line_item_param + type: object + type: array + - enum: + - '' + type: string + shipping: + anyOf: + - properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + from_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + to_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + title: amount_details_shipping_param + type: object + - enum: + - '' + type: string + tax: + anyOf: + - properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_tax_param + type: object + - enum: + - '' + type: string + title: amount_details_param + type: object amount_to_capture: description: >- The amount to capture from the PaymentIntent, which must be - less than or equal to the original amount. Any additional - amount is automatically refunded. Defaults to the full - `amount_capturable` if it's not provided. + less than or equal to the original amount. Defaults to the + full `amount_capturable` if it's not provided. type: integer application_fee_amount: description: >- The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the - application fee collected will be capped at the total - payment amount. For more information, see the PaymentIntents - [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + application fee collected will be capped at the total amount + captured. For more information, see the PaymentIntents [use + case for connected + accounts](https://docs.stripe.com/payments/connected-accounts). type: integer expand: description: Specifies which fields in the response should be expanded. @@ -102634,9 +112493,31 @@ paths: the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when - [multicapture](https://stripe.com/docs/payments/multicapture) + [multicapture](https://docs.stripe.com/payments/multicapture) is available for PaymentIntents. type: boolean + hooks: + description: Automations to be run during the PaymentIntent lifecycle + properties: + inputs: + properties: + tax: + properties: + calculation: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - calculation + title: async_workflows_inputs_tax_param + type: object + title: async_workflows_inputs_param + type: object + title: async_workflows_param + type: object metadata: anyOf: - additionalProperties: @@ -102647,12 +112528,35 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + payment_details: + anyOf: + - properties: + customer_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + order_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: payment_details_capture_params + type: object + - enum: + - '' + type: string + description: Provides industry-specific information about the charge. statement_descriptor: description: >- Text that appears on the customer's statement as the @@ -102684,11 +112588,11 @@ paths: transfer after the payment is captured. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). properties: amount: type: integer - title: transfer_data_update_params + title: transfer_data_capture_params type: object type: object required: false @@ -102714,10 +112618,11 @@ paths: payment method. Upon confirmation, the PaymentIntent will attempt to initiate - a payment. + a payment.

- If the selected payment method requires additional authentication steps, - the + +

If the selected payment method requires additional authentication + steps, the PaymentIntent will transition to the requires_action status and @@ -102734,9 +112639,10 @@ paths: succeeded status (or requires_capture, if capture_method - is set to manual). + is set to manual).

- If the confirmation_method is automatic, + +

If the confirmation_method is automatic, payment may be attempted using our next_actions are handled by the client, no additional - confirmation is required to complete the payment. + confirmation is required to complete the payment.

+ - If the confirmation_method is manual, all +

If the confirmation_method is manual, all payment attempts must be - initiated using a secret key. + initiated using a secret key.

- If any actions are required for the payment, the PaymentIntent will + +

If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state @@ -102763,10 +112671,11 @@ paths: explicitly re-confirm the PaymentIntent to initiate the next payment - attempt. + attempt.

+ - There is a variable upper limit on how many times a PaymentIntent can be - confirmed. +

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 @@ -102784,15 +112693,27 @@ paths: content: application/x-www-form-urlencoded: encoding: + amount_details: + explode: true + style: deepObject + excluded_payment_method_types: + explode: true + style: deepObject expand: explode: true style: deepObject + hooks: + explode: true + style: deepObject mandate_data: explode: true style: deepObject off_session: explode: true style: deepObject + payment_details: + explode: true + style: deepObject payment_method_data: explode: true style: deepObject @@ -102814,6 +112735,155 @@ paths: schema: additionalProperties: false properties: + amount_details: + anyOf: + - properties: + discount_amount: + anyOf: + - type: integer + - enum: + - '' + type: string + enforce_arithmetic_validation: + type: boolean + line_items: + anyOf: + - items: + properties: + discount_amount: + type: integer + payment_method_options: + properties: + card: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + card_present: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + klarna: + properties: + image_url: + maxLength: 4096 + type: string + product_url: + maxLength: 4096 + type: string + reference: + maxLength: 255 + type: string + subscription_reference: + maxLength: 255 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + paypal: + properties: + category: + enum: + - digital_goods + - donation + - physical_goods + type: string + description: + maxLength: 127 + type: string + sold_by: + maxLength: 127 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + title: >- + amount_details_line_item_payment_method_options_param + type: object + product_code: + maxLength: 12 + type: string + product_name: + maxLength: 1024 + type: string + quantity: + type: integer + tax: + properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_line_item_tax_param + type: object + unit_cost: + type: integer + unit_of_measure: + maxLength: 12 + type: string + required: + - product_name + - quantity + - unit_cost + title: amount_details_line_item_param + type: object + type: array + - enum: + - '' + type: string + shipping: + anyOf: + - properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + from_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + to_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + title: amount_details_shipping_param + type: object + - enum: + - '' + type: string + tax: + anyOf: + - properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_tax_param + type: object + - enum: + - '' + type: string + title: amount_details_param + type: object + - enum: + - '' + type: string + description: Provides industry-specific information about the amount. capture_method: description: >- Controls when the funds will be captured from the customer's @@ -102845,14 +112915,98 @@ paths: PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without - authentication](https://stripe.com/docs/payments/save-card-without-authentication). + authentication](https://docs.stripe.com/payments/save-card-without-authentication). type: boolean + excluded_payment_method_types: + anyOf: + - items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + type: array + - enum: + - '' + type: string + description: >- + The list of payment method types to exclude from use with + this payment. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + hooks: + description: Automations to be run during the PaymentIntent lifecycle + properties: + inputs: + properties: + tax: + properties: + calculation: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - calculation + title: async_workflows_inputs_tax_param + type: object + title: async_workflows_inputs_param + type: object + title: async_workflows_param + type: object mandate: description: ID of the mandate that's used for this payment. maxLength: 5000 @@ -102938,13 +113092,41 @@ paths: checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them - later](https://stripe.com/docs/payments/cards/charging-saved-cards). + later](https://docs.stripe.com/payments/cards/charging-saved-cards). + payment_details: + anyOf: + - properties: + customer_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + order_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: payment_details + type: object + - enum: + - '' + type: string + description: Provides industry-specific information about the charge. payment_method: description: >- ID of the payment method (a PaymentMethod, Card, or [compatible - Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) + Source](https://docs.stripe.com/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent. + + If the payment method is attached to a Customer, it must + match the + [customer](https://api.stripe.com#create_payment_intent-customer) + that is set on this PaymentIntent. maxLength: 5000 type: string payment_method_data: @@ -102953,7 +113135,7 @@ paths: PaymentMethod. The new PaymentMethod will appear in the - [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method) + [payment_method](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-payment_method) property on the PaymentIntent. properties: @@ -103027,6 +113209,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -103075,6 +113261,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -103094,6 +113283,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -103180,11 +113373,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -103237,6 +113434,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -103259,6 +113460,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -103313,6 +113541,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -103336,6 +113577,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -103379,9 +113624,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -103393,19 +113640,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -103490,6 +113741,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string verification_method: enum: - automatic @@ -103599,6 +113853,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -103625,6 +113882,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -103651,6 +113911,19 @@ paths: - enum: - '' type: string + billie: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string blik: anyOf: - properties: @@ -103693,6 +113966,7 @@ paths: - '' - manual type: string + x-stripeBypassValidation: true cvc_token: maxLength: 5000 type: string @@ -103711,9 +113985,10 @@ paths: type: string type: enum: + - bonus - fixed_count + - revolving type: string - x-stripeBypassValidation: true required: - type title: installment_plan @@ -103900,6 +114175,8 @@ paths: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 type: string x-stripeBypassValidation: true required: @@ -103916,6 +114193,11 @@ paths: card_present: anyOf: - properties: + capture_method: + enum: + - manual + - manual_preferred + type: string request_extended_authorization: type: boolean request_incremental_authorization_support: @@ -103954,6 +114236,19 @@ paths: - enum: - '' type: string + crypto: + anyOf: + - properties: + setup_future_usage: + enum: + - none + type: string + x-stripeBypassValidation: true + title: payment_method_options_param + type: object + - enum: + - '' + type: string customer_balance: anyOf: - properties: @@ -104104,6 +114399,25 @@ paths: - '' - manual type: string + on_demand: + properties: + average_amount: + type: integer + maximum_amount: + type: integer + minimum_amount: + type: integer + purchase_interval: + enum: + - day + - month + - week + - year + type: string + purchase_interval_count: + type: integer + title: on_demand_param + type: object preferred_locale: enum: - cs-CZ @@ -104157,8 +114471,49 @@ paths: setup_future_usage: enum: - none + - off_session + - on_session type: string - x-stripeBypassValidation: true + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - reference + title: subscription_param + type: object + type: array + - enum: + - '' + type: string title: payment_method_options_param type: object - enum: @@ -104241,6 +114596,18 @@ paths: - enum: - '' type: string + mb_way: + anyOf: + - properties: + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string mobilepay: anyOf: - properties: @@ -104278,11 +114645,35 @@ paths: - '' - manual type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string title: payment_method_options_param type: object - enum: - '' type: string + nz_bank_account: + anyOf: + - properties: + setup_future_usage: + enum: + - '' + - none + - off_session + - on_session + type: string + target_date: + maxLength: 5000 + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -104394,9 +114785,85 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: >- + payment_intent_payment_method_options_mandate_options_param + type: object + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string pix: anyOf: - properties: + amount_includes_iof: + enum: + - always + - never + type: string expires_after_seconds: type: integer expires_at: @@ -104406,6 +114873,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -104455,6 +114923,19 @@ paths: - enum: - '' type: string + satispay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: @@ -104476,6 +114957,9 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string title: payment_intent_payment_method_options_param type: object - enum: @@ -104532,6 +115016,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -104600,12 +115085,6 @@ paths: type: array title: networks_options_param type: object - preferred_settlement_speed: - enum: - - '' - - fastest - - standard - type: string setup_future_usage: enum: - '' @@ -104613,6 +115092,17 @@ paths: - off_session - on_session type: string + target_date: + maxLength: 5000 + type: string + transaction_purpose: + enum: + - '' + - goods + - other + - services + - unspecified + type: string verification_method: enum: - automatic @@ -104642,8 +115132,6 @@ paths: enum: - none type: string - required: - - client title: payment_method_options_param type: object - enum: @@ -104669,6 +115157,8 @@ paths: this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods). + A list of valid payment method types can be found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string @@ -104676,12 +115166,12 @@ paths: radar_options: description: >- Options to configure Radar. Learn more about [Radar - Sessions](https://stripe.com/docs/radar/radar-session). + Sessions](https://docs.stripe.com/radar/radar-session). properties: session: maxLength: 5000 type: string - title: radar_options_with_hidden_options + title: radar_options_with_peval_options type: object receipt_email: anyOf: @@ -104879,12 +115369,21 @@ paths: content: application/x-www-form-urlencoded: encoding: + amount_details: + explode: true + style: deepObject expand: explode: true style: deepObject + hooks: + explode: true + style: deepObject metadata: explode: true style: deepObject + payment_details: + explode: true + style: deepObject transfer_data: explode: true style: deepObject @@ -104897,15 +115396,160 @@ paths: cardholder. This amount must be greater than the currently authorized amount. type: integer + amount_details: + description: Provides industry-specific information about the amount. + properties: + discount_amount: + anyOf: + - type: integer + - enum: + - '' + type: string + enforce_arithmetic_validation: + type: boolean + line_items: + anyOf: + - items: + properties: + discount_amount: + type: integer + payment_method_options: + properties: + card: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + card_present: + properties: + commodity_code: + maxLength: 12 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + klarna: + properties: + image_url: + maxLength: 4096 + type: string + product_url: + maxLength: 4096 + type: string + reference: + maxLength: 255 + type: string + subscription_reference: + maxLength: 255 + type: string + title: >- + payment_intent_amount_details_line_item_payment_method_options_param + type: object + paypal: + properties: + category: + enum: + - digital_goods + - donation + - physical_goods + type: string + description: + maxLength: 127 + type: string + sold_by: + maxLength: 127 + type: string + title: >- + amount_details_line_item_payment_method_options_param + type: object + title: >- + amount_details_line_item_payment_method_options_param + type: object + product_code: + maxLength: 12 + type: string + product_name: + maxLength: 1024 + type: string + quantity: + type: integer + tax: + properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_line_item_tax_param + type: object + unit_cost: + type: integer + unit_of_measure: + maxLength: 12 + type: string + required: + - product_name + - quantity + - unit_cost + title: amount_details_line_item_param + type: object + type: array + - enum: + - '' + type: string + shipping: + anyOf: + - properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + from_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + to_postal_code: + anyOf: + - maxLength: 10 + type: string + - enum: + - '' + type: string + title: amount_details_shipping_param + type: object + - enum: + - '' + type: string + tax: + anyOf: + - properties: + total_tax_amount: + type: integer + required: + - total_tax_amount + title: amount_details_tax_param + type: object + - enum: + - '' + type: string + title: amount_details_param + type: object application_fee_amount: description: >- The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the - application fee collected will be capped at the total - payment amount. For more information, see the PaymentIntents - [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + application fee collected will be capped at the total amount + captured. For more information, see the PaymentIntents [use + case for connected + accounts](https://docs.stripe.com/payments/connected-accounts). type: integer description: description: >- @@ -104919,18 +115563,59 @@ paths: maxLength: 5000 type: string type: array + hooks: + description: Automations to be run during the PaymentIntent lifecycle + properties: + inputs: + properties: + tax: + properties: + calculation: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - calculation + title: async_workflows_inputs_tax_param + type: object + title: async_workflows_inputs_param + type: object + title: async_workflows_param + type: object metadata: additionalProperties: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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_details: + description: Provides industry-specific information about the charge. + properties: + customer_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + order_reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: payment_details_order_customer_reference_param + type: object statement_descriptor: description: >- Text that appears on the customer's statement as the @@ -104947,11 +115632,11 @@ paths: the payment is captured. Learn more about the [use case for connected - accounts](https://stripe.com/docs/payments/connected-accounts). + accounts](https://docs.stripe.com/payments/connected-accounts). properties: amount: type: integer - title: transfer_data_update_params + title: transfer_data_update_auth_params type: object required: - amount @@ -105183,6 +115868,12 @@ paths: metadata: explode: true style: deepObject + name_collection: + explode: true + style: deepObject + optional_items: + explode: true + style: deepObject payment_intent_data: explode: true style: deepObject @@ -105226,7 +115917,6 @@ paths: redirect: properties: url: - maxLength: 2048 type: string required: - url @@ -105273,6 +115963,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -105327,11 +116018,15 @@ paths: custom_fields: description: >- Collect additional information from your customer using - custom fields. Up to 3 fields are supported. + custom fields. Up to 3 fields are supported. You can't set + this parameter if `ui_mode` is `custom`. items: properties: dropdown: properties: + default_value: + maxLength: 100 + type: string options: items: properties: @@ -105370,6 +116065,9 @@ paths: type: object numeric: properties: + default_value: + maxLength: 255 + type: string maximum_length: type: integer minimum_length: @@ -105380,6 +116078,9 @@ paths: type: boolean text: properties: + default_value: + maxLength: 255 + type: string maximum_length: type: integer minimum_length: @@ -105402,7 +116103,7 @@ paths: custom_text: description: >- Display additional text for your customers using custom - text. + text. You can't set this parameter if `ui_mode` is `custom`. properties: after_submit: anyOf: @@ -105461,9 +116162,9 @@ paths: customer_creation: description: >- Configures whether [checkout - sessions](https://stripe.com/docs/api/checkout/sessions) + sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a - [Customer](https://stripe.com/docs/api/customers). + [Customer](https://docs.stripe.com/api/customers). enum: - always - if_required @@ -105530,6 +116231,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -105551,7 +116253,10 @@ paths: - exclude_tax - include_inclusive_tax type: string - title: rendering_options_param + template: + maxLength: 5000 + type: string + title: checkout_rendering_options_param type: object - enum: - '' @@ -105584,10 +116289,73 @@ paths: price: maxLength: 5000 type: string + price_data: + properties: + currency: + format: currency + type: string + product: + maxLength: 5000 + type: string + product_data: + properties: + description: + maxLength: 40000 + type: string + images: + items: + type: string + type: array + metadata: + additionalProperties: + type: string + type: object + name: + maxLength: 5000 + type: string + tax_code: + maxLength: 5000 + type: string + unit_label: + maxLength: 12 + type: string + required: + - name + title: product_data + type: object + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + title: custom_amount_price_data_with_product_data + type: object quantity: type: integer required: - - price - quantity title: line_items_create_params type: object @@ -105597,19 +116365,84 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout - sessions](https://stripe.com/docs/api/checkout/sessions) + sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. type: object + name_collection: + description: >- + Controls settings applied for collecting the customer's + name. + properties: + business: + properties: + enabled: + type: boolean + optional: + type: boolean + required: + - enabled + title: name_collection_business_params + type: object + individual: + properties: + enabled: + type: boolean + optional: + type: boolean + required: + - enabled + title: name_collection_individual_params + type: object + title: name_collection_params + type: object on_behalf_of: description: The account on behalf of which to charge. type: string + optional_items: + description: >- + A list of optional items the customer can add to their order + at checkout. Use this parameter to pass one-time or + recurring [Prices](https://docs.stripe.com/api/prices). + + There is a maximum of 10 optional items allowed on a payment + link, and the existing limits on the number of line items + allowed on a payment link apply to the combined number of + line items and optional items. + + There is a maximum of 20 combined line items and optional + items. + items: + properties: + adjustable_quantity: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + required: + - enabled + title: optional_item_adjustable_quantity_params + type: object + price: + maxLength: 5000 + type: string + quantity: + type: integer + required: + - price + - quantity + title: optional_item_params + type: object + type: array payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent @@ -105660,7 +116493,7 @@ paths: If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free - trial](https://stripe.com/docs/payments/checkout/free-trials). + trial](https://docs.stripe.com/payments/checkout/free-trials). enum: - always - if_required @@ -105672,7 +116505,7 @@ paths: 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)). + [supported](https://docs.stripe.com/payments/payment-methods/integration-options#payment-method-product-support)). items: enum: - affirm @@ -105682,6 +116515,7 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card @@ -105694,6 +116528,7 @@ paths: - klarna - konbini - link + - mb_way - mobilepay - multibanco - oxxo @@ -105701,8 +116536,10 @@ paths: - pay_by_bank - paynow - paypal + - payto - pix - promptpay + - satispay - sepa_debit - sofort - swish @@ -105997,7 +116834,7 @@ paths: shipping_options: description: >- The shipping rate options to apply to [checkout - sessions](https://stripe.com/docs/api/checkout/sessions) + sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. items: properties: @@ -106013,7 +116850,7 @@ paths: 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) + [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). enum: - auto @@ -106042,6 +116879,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -106208,6 +117046,12 @@ paths: metadata: explode: true style: deepObject + name_collection: + explode: true + style: deepObject + optional_items: + explode: true + style: deepObject payment_intent_data: explode: true style: deepObject @@ -106251,7 +117095,6 @@ paths: redirect: properties: url: - maxLength: 2048 type: string required: - url @@ -106283,6 +117126,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -106305,6 +117149,9 @@ paths: properties: dropdown: properties: + default_value: + maxLength: 100 + type: string options: items: properties: @@ -106343,6 +117190,9 @@ paths: type: object numeric: properties: + default_value: + maxLength: 255 + type: string maximum_length: type: integer minimum_length: @@ -106353,6 +117203,9 @@ paths: type: boolean text: properties: + default_value: + maxLength: 255 + type: string maximum_length: type: integer minimum_length: @@ -106377,11 +117230,12 @@ paths: type: string description: >- Collect additional information from your customer using - custom fields. Up to 3 fields are supported. + custom fields. Up to 3 fields are supported. You can't set + this parameter if `ui_mode` is `custom`. custom_text: description: >- Display additional text for your customers using custom - text. + text. You can't set this parameter if `ui_mode` is `custom`. properties: after_submit: anyOf: @@ -106440,9 +117294,9 @@ paths: customer_creation: description: >- Configures whether [checkout - sessions](https://stripe.com/docs/api/checkout/sessions) + sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link create a - [Customer](https://stripe.com/docs/api/customers). + [Customer](https://docs.stripe.com/api/customers). enum: - always - if_required @@ -106513,6 +117367,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -106534,7 +117389,10 @@ paths: - exclude_tax - include_inclusive_tax type: string - title: rendering_options_param + template: + maxLength: 5000 + type: string + title: checkout_rendering_options_param type: object - enum: - '' @@ -106579,16 +117437,89 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout - sessions](https://stripe.com/docs/api/checkout/sessions) + sessions](https://docs.stripe.com/api/checkout/sessions) created by this payment link. type: object + name_collection: + anyOf: + - properties: + business: + properties: + enabled: + type: boolean + optional: + type: boolean + required: + - enabled + title: name_collection_business_params + type: object + individual: + properties: + enabled: + type: boolean + optional: + type: boolean + required: + - enabled + title: name_collection_individual_params + type: object + title: name_collection_params + type: object + - enum: + - '' + type: string + description: >- + Controls settings applied for collecting the customer's + name. + optional_items: + anyOf: + - items: + properties: + adjustable_quantity: + properties: + enabled: + type: boolean + maximum: + type: integer + minimum: + type: integer + required: + - enabled + title: optional_item_adjustable_quantity_params + type: object + price: + maxLength: 5000 + type: string + quantity: + type: integer + required: + - price + - quantity + title: optional_item_params + type: object + type: array + - enum: + - '' + type: string + description: >- + A list of optional items the customer can add to their order + at checkout. Use this parameter to pass one-time or + recurring [Prices](https://docs.stripe.com/api/prices). + + There is a maximum of 10 optional items allowed on a payment + link, and the existing limits on the number of line items + allowed on a payment link apply to the combined number of + line items and optional items. + + There is a maximum of 20 combined line items and optional + items. payment_intent_data: description: >- A subset of parameters to be passed to PaymentIntent @@ -106648,7 +117579,7 @@ paths: If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free - trial](https://stripe.com/docs/payments/checkout/free-trials). + trial](https://docs.stripe.com/payments/checkout/free-trials). enum: - always - if_required @@ -106664,6 +117595,7 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card @@ -106676,6 +117608,7 @@ paths: - klarna - konbini - link + - mb_way - mobilepay - multibanco - oxxo @@ -106683,8 +117616,10 @@ paths: - pay_by_bank - paynow - paypal + - payto - pix - promptpay + - satispay - sepa_debit - sofort - swish @@ -106998,7 +117933,7 @@ paths: 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) + [url](https://docs.stripe.com/api/payment_links/payment_links/object#url) property (example: `donate.stripe.com`). enum: - auto @@ -107024,6 +117959,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -107372,6 +118308,9 @@ paths: bancontact: explode: true style: deepObject + billie: + explode: true + style: deepObject blik: explode: true style: deepObject @@ -107387,6 +118326,9 @@ paths: cashapp: explode: true style: deepObject + crypto: + explode: true + style: deepObject customer_balance: explode: true style: deepObject @@ -107399,6 +118341,9 @@ paths: fpx: explode: true style: deepObject + fr_meal_voucher_conecs: + explode: true + style: deepObject giropay: explode: true style: deepObject @@ -107414,21 +118359,36 @@ paths: jcb: explode: true style: deepObject + kakao_pay: + explode: true + style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject + kr_card: + explode: true + style: deepObject link: explode: true style: deepObject + mb_way: + explode: true + style: deepObject mobilepay: explode: true style: deepObject multibanco: explode: true style: deepObject + naver_pay: + explode: true + style: deepObject + nz_bank_account: + explode: true + style: deepObject oxxo: explode: true style: deepObject @@ -107438,18 +118398,33 @@ paths: pay_by_bank: explode: true style: deepObject + payco: + explode: true + style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject + payto: + explode: true + style: deepObject + pix: + explode: true + style: deepObject promptpay: explode: true style: deepObject revolut_pay: explode: true style: deepObject + samsung_pay: + explode: true + style: deepObject + satispay: + explode: true + style: deepObject sepa_debit: explode: true style: deepObject @@ -107477,7 +118452,7 @@ paths: acss_debit: description: >- Canadian pre-authorized debit payments, check this - [page](https://stripe.com/docs/payments/acss-debit) for more + [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. properties: display_preference: @@ -107499,7 +118474,7 @@ paths: the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this - [page](https://stripe.com/docs/payments/affirm) for more + [page](https://docs.stripe.com/payments/affirm) for more details like country availability. properties: display_preference: @@ -107518,7 +118493,7 @@ paths: description: >- Afterpay gives your customers a way to pay for purchases in installments, check this - [page](https://stripe.com/docs/payments/afterpay-clearpay) + [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. @@ -107543,7 +118518,7 @@ paths: Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this - [page](https://stripe.com/docs/payments/alipay) for more + [page](https://docs.stripe.com/payments/alipay) for more details. properties: display_preference: @@ -107594,13 +118569,14 @@ paths: type: object apple_pay: description: >- - Stripe users can accept [Apple Pay](/payments/apple-pay) in - iOS applications in iOS 9 and later, and on the web in - Safari starting with iOS 10 or macOS Sierra. There are no + Stripe users can accept [Apple + Pay](https://stripe.com/payments/apple-pay) in iOS + applications in iOS 9 and later, and on the web in Safari + starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the - [pricing](/pricing) is the same as other card transactions. - Check this [page](https://stripe.com/docs/apple-pay) for - more details. + [pricing](https://stripe.com/pricing) is the same as other + card transactions. Check this + [page](https://docs.stripe.com/apple-pay) for more details. properties: display_preference: properties: @@ -107637,7 +118613,7 @@ paths: Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this - [page](https://stripe.com/docs/payments/au-becs-debit) for + [page](https://docs.stripe.com/payments/au-becs-debit) for more details. properties: display_preference: @@ -107656,7 +118632,7 @@ paths: description: >- Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this - [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) + [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. properties: display_preference: @@ -107675,11 +118651,11 @@ paths: description: >- Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. - [Customers](https://stripe.com/docs/api/customers) use a + [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this - [page](https://stripe.com/docs/payments/bancontact) for more + [page](https://docs.stripe.com/payments/bancontact) for more details. properties: display_preference: @@ -107694,15 +118670,39 @@ paths: type: object title: payment_method_param type: object + billie: + description: >- + Billie is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage) + payment method that offers businesses Pay by Invoice where + they offer payment terms ranging from 7-120 days. Customers + are redirected from your website or app, authorize the + payment with Billie, then return to your website or app. You + get [immediate + notification](/payments/payment-methods#payment-notification) + of whether the payment succeeded or failed. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object blik: description: >- BLIK is a [single - use](https://stripe.com/docs/payments/payment-methods#usage) + use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this - [page](https://stripe.com/docs/payments/blik) for more + [page](https://docs.stripe.com/payments/blik) for more details. properties: display_preference: @@ -107721,7 +118721,7 @@ paths: description: >- Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this - [page](https://stripe.com/docs/payments/boleto) for more + [page](https://docs.stripe.com/payments/boleto) for more details. properties: display_preference: @@ -107761,7 +118761,7 @@ paths: Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this - [page](https://stripe.com/docs/payments/cartes-bancaires) + [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. properties: display_preference: @@ -107781,7 +118781,7 @@ paths: Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this - [page](https://stripe.com/docs/payments/cash-app-pay) for + [page](https://docs.stripe.com/payments/cash-app-pay) for more details. properties: display_preference: @@ -107796,13 +118796,32 @@ paths: type: object title: payment_method_param type: object + crypto: + description: >- + [Stablecoin + payments](https://docs.stripe.com/payments/stablecoin-payments) + enable customers to pay in stablecoins like USDC from 100s + of wallets including Phantom and Metamask. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object customer_balance: description: >- Uses a customer’s [cash - balance](https://stripe.com/docs/payments/customer-balance) + balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this - [page](https://stripe.com/docs/payments/bank-transfers) for + [page](https://docs.stripe.com/payments/bank-transfers) for more details. properties: display_preference: @@ -107823,7 +118842,7 @@ paths: to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check - this [page](https://stripe.com/docs/payments/eps) for more + this [page](https://docs.stripe.com/payments/eps) for more details. properties: display_preference: @@ -107854,7 +118873,7 @@ paths: Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this - [page](https://stripe.com/docs/payments/fpx) for more + [page](https://docs.stripe.com/payments/fpx) for more details. properties: display_preference: @@ -107869,6 +118888,27 @@ paths: type: object title: payment_method_param type: object + fr_meal_voucher_conecs: + description: >- + Meal vouchers in France, or “titres-restaurant”, is a local + benefits program commonly offered by employers for their + employees to purchase prepared food and beverages on working + days. Check this + [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) + for more details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object giropay: description: >- giropay is a German payment method based on online banking, @@ -107878,7 +118918,7 @@ paths: their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this - [page](https://stripe.com/docs/payments/giropay) for more + [page](https://docs.stripe.com/payments/giropay) for more details. properties: display_preference: @@ -107901,7 +118941,7 @@ paths: or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this - [page](https://stripe.com/docs/google-pay) for more details. + [page](https://docs.stripe.com/google-pay) for more details. properties: display_preference: properties: @@ -107921,7 +118961,7 @@ paths: [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this - [page](https://stripe.com/docs/payments/grabpay) for more + [page](https://docs.stripe.com/payments/grabpay) for more details. properties: display_preference: @@ -107944,7 +118984,7 @@ paths: the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this - [page](https://stripe.com/docs/payments/ideal) for more + [page](https://docs.stripe.com/payments/ideal) for more details. properties: display_preference: @@ -107982,15 +119022,32 @@ paths: type: object title: payment_method_param type: object + kakao_pay: + description: >- + Kakao Pay is a popular local wallet available in South + Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object klarna: description: >- Klarna gives customers a range of [payment - options](https://stripe.com/docs/payments/klarna#payment-options) + options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this - [page](https://stripe.com/docs/payments/klarna) for more + [page](https://docs.stripe.com/payments/klarna) for more details. properties: display_preference: @@ -108009,7 +119066,7 @@ paths: description: >- Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this - [page](https://stripe.com/docs/payments/konbini) for more + [page](https://docs.stripe.com/payments/konbini) for more details. properties: display_preference: @@ -108024,9 +119081,26 @@ paths: type: object title: payment_method_param type: object + kr_card: + description: >- + Korean cards let users pay using locally issued cards from + South Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object link: description: >- - [Link](https://stripe.com/docs/payments/link) is a payment + [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. @@ -108043,15 +119117,35 @@ paths: type: object title: payment_method_param type: object + mb_way: + description: >- + MB WAY is the most popular wallet in Portugal. After + entering their phone number in your checkout, customers + approve the payment directly in their MB WAY app. Check this + [page](https://docs.stripe.com/payments/mb-way) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object mobilepay: description: >- MobilePay is a - [single-use](https://stripe.com/docs/payments/payment-methods#usage) + [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and - approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this - [page](https://stripe.com/docs/payments/mobilepay) for more + [page](https://docs.stripe.com/payments/mobilepay) for more details. properties: display_preference: @@ -108090,13 +119184,50 @@ paths: description: Configuration name. maxLength: 100 type: string + naver_pay: + description: >- + Naver Pay is a popular local wallet available in South + Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + nz_bank_account: + description: >- + Stripe users in New Zealand can accept Bulk Electronic + Clearing System (BECS) direct debit payments from customers + with a New Zeland bank account. Check this + [page](https://docs.stripe.com/payments/nz-bank-account) for + more details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object oxxo: description: >- OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check - this [page](https://stripe.com/docs/payments/oxxo) for more + this [page](https://docs.stripe.com/payments/oxxo) for more details. properties: display_preference: @@ -108118,7 +119249,7 @@ paths: transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this - [page](https://stripe.com/docs/payments/p24) for more + [page](https://docs.stripe.com/payments/p24) for more details. properties: display_preference: @@ -108160,13 +119291,31 @@ paths: type: object title: payment_method_param type: object + payco: + description: >- + PAYCO is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage + local wallet available in South Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object paynow: description: >- PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this - [page](https://stripe.com/docs/payments/paynow) for more + [page](https://docs.stripe.com/payments/paynow) for more details. properties: display_preference: @@ -108186,7 +119335,49 @@ paths: PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this - [page](https://stripe.com/docs/payments/paypal) for more + [page](https://docs.stripe.com/payments/paypal) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + payto: + description: >- + PayTo is a + [real-time](https://docs.stripe.com/payments/real-time) + payment method that enables customers in Australia to pay by + providing their bank account details. Customers must accept + a mandate authorizing you to debit their account. Check this + [page](https://docs.stripe.com/payments/payto) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + pix: + description: >- + Pix is a payment method popular in Brazil. When paying with + Pix, customers authenticate and approve payments by scanning + a QR code in their preferred banking app. Check this + [page](https://docs.stripe.com/payments/pix) for more details. properties: display_preference: @@ -108206,7 +119397,7 @@ paths: PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this - [page](https://stripe.com/docs/payments/promptpay) for more + [page](https://docs.stripe.com/payments/promptpay) for more details. properties: display_preference: @@ -108241,6 +119432,48 @@ paths: type: object title: payment_method_param type: object + samsung_pay: + description: >- + Samsung Pay is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage + local wallet available in South Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + satispay: + description: >- + Satispay is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage) + payment method where customers are required to + [authenticate](/payments/payment-methods#customer-actions) + their payment. Customers pay by being redirected from your + website or app, authorizing the payment with Satispay, then + returning to your website or app. You get [immediate + notification](/payments/payment-methods#payment-notification) + of whether the payment succeeded or failed. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object sepa_debit: description: >- The [Single Euro Payments Area @@ -108250,7 +119483,7 @@ paths: enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this - [page](https://stripe.com/docs/payments/sepa-debit) for more + [page](https://docs.stripe.com/payments/sepa-debit) for more details. properties: display_preference: @@ -108273,7 +119506,7 @@ paths: single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this - [page](https://stripe.com/docs/payments/sofort) for more + [page](https://docs.stripe.com/payments/sofort) for more details. properties: display_preference: @@ -108291,13 +119524,13 @@ paths: swish: description: >- Swish is a - [real-time](https://stripe.com/docs/payments/real-time) + [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and - approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this - [page](https://stripe.com/docs/payments/swish) for more + [page](https://docs.stripe.com/payments/swish) for more details. properties: display_preference: @@ -108337,7 +119570,7 @@ 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-direct-debit) + [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. properties: display_preference: @@ -108360,7 +119593,7 @@ paths: businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this - [page](https://stripe.com/docs/payments/wechat-pay) for more + [page](https://docs.stripe.com/payments/wechat-pay) for more details. properties: display_preference: @@ -108379,7 +119612,7 @@ paths: description: >- Zip gives your customers a way to split purchases over a series of payments. Check this - [page](https://stripe.com/docs/payments/zip) for more + [page](https://docs.stripe.com/payments/zip) for more details like country availability. properties: display_preference: @@ -108504,6 +119737,9 @@ paths: bancontact: explode: true style: deepObject + billie: + explode: true + style: deepObject blik: explode: true style: deepObject @@ -108519,6 +119755,9 @@ paths: cashapp: explode: true style: deepObject + crypto: + explode: true + style: deepObject customer_balance: explode: true style: deepObject @@ -108531,6 +119770,9 @@ paths: fpx: explode: true style: deepObject + fr_meal_voucher_conecs: + explode: true + style: deepObject giropay: explode: true style: deepObject @@ -108546,21 +119788,36 @@ paths: jcb: explode: true style: deepObject + kakao_pay: + explode: true + style: deepObject klarna: explode: true style: deepObject konbini: explode: true style: deepObject + kr_card: + explode: true + style: deepObject link: explode: true style: deepObject + mb_way: + explode: true + style: deepObject mobilepay: explode: true style: deepObject multibanco: explode: true style: deepObject + naver_pay: + explode: true + style: deepObject + nz_bank_account: + explode: true + style: deepObject oxxo: explode: true style: deepObject @@ -108570,18 +119827,33 @@ paths: pay_by_bank: explode: true style: deepObject + payco: + explode: true + style: deepObject paynow: explode: true style: deepObject paypal: explode: true style: deepObject + payto: + explode: true + style: deepObject + pix: + explode: true + style: deepObject promptpay: explode: true style: deepObject revolut_pay: explode: true style: deepObject + samsung_pay: + explode: true + style: deepObject + satispay: + explode: true + style: deepObject sepa_debit: explode: true style: deepObject @@ -108609,7 +119881,7 @@ paths: acss_debit: description: >- Canadian pre-authorized debit payments, check this - [page](https://stripe.com/docs/payments/acss-debit) for more + [page](https://docs.stripe.com/payments/acss-debit) for more details like country availability. properties: display_preference: @@ -108634,7 +119906,7 @@ paths: the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this - [page](https://stripe.com/docs/payments/affirm) for more + [page](https://docs.stripe.com/payments/affirm) for more details like country availability. properties: display_preference: @@ -108653,7 +119925,7 @@ paths: description: >- Afterpay gives your customers a way to pay for purchases in installments, check this - [page](https://stripe.com/docs/payments/afterpay-clearpay) + [page](https://docs.stripe.com/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products. @@ -108678,7 +119950,7 @@ paths: Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this - [page](https://stripe.com/docs/payments/alipay) for more + [page](https://docs.stripe.com/payments/alipay) for more details. properties: display_preference: @@ -108729,13 +120001,14 @@ paths: type: object apple_pay: description: >- - Stripe users can accept [Apple Pay](/payments/apple-pay) in - iOS applications in iOS 9 and later, and on the web in - Safari starting with iOS 10 or macOS Sierra. There are no + Stripe users can accept [Apple + Pay](https://stripe.com/payments/apple-pay) in iOS + applications in iOS 9 and later, and on the web in Safari + starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the - [pricing](/pricing) is the same as other card transactions. - Check this [page](https://stripe.com/docs/apple-pay) for - more details. + [pricing](https://stripe.com/pricing) is the same as other + card transactions. Check this + [page](https://docs.stripe.com/apple-pay) for more details. properties: display_preference: properties: @@ -108772,7 +120045,7 @@ paths: Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this - [page](https://stripe.com/docs/payments/au-becs-debit) for + [page](https://docs.stripe.com/payments/au-becs-debit) for more details. properties: display_preference: @@ -108791,7 +120064,7 @@ paths: description: >- Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this - [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) + [page](https://docs.stripe.com/payments/payment-methods/bacs-debit) for more details. properties: display_preference: @@ -108810,11 +120083,11 @@ paths: description: >- Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. - [Customers](https://stripe.com/docs/api/customers) use a + [Customers](https://docs.stripe.com/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this - [page](https://stripe.com/docs/payments/bancontact) for more + [page](https://docs.stripe.com/payments/bancontact) for more details. properties: display_preference: @@ -108829,15 +120102,39 @@ paths: type: object title: payment_method_param type: object + billie: + description: >- + Billie is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage) + payment method that offers businesses Pay by Invoice where + they offer payment terms ranging from 7-120 days. Customers + are redirected from your website or app, authorize the + payment with Billie, then return to your website or app. You + get [immediate + notification](/payments/payment-methods#payment-notification) + of whether the payment succeeded or failed. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object blik: description: >- BLIK is a [single - use](https://stripe.com/docs/payments/payment-methods#usage) + use](https://docs.stripe.com/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this - [page](https://stripe.com/docs/payments/blik) for more + [page](https://docs.stripe.com/payments/blik) for more details. properties: display_preference: @@ -108856,7 +120153,7 @@ paths: description: >- Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this - [page](https://stripe.com/docs/payments/boleto) for more + [page](https://docs.stripe.com/payments/boleto) for more details. properties: display_preference: @@ -108896,7 +120193,7 @@ paths: Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this - [page](https://stripe.com/docs/payments/cartes-bancaires) + [page](https://docs.stripe.com/payments/cartes-bancaires) for more details. properties: display_preference: @@ -108916,7 +120213,7 @@ paths: Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this - [page](https://stripe.com/docs/payments/cash-app-pay) for + [page](https://docs.stripe.com/payments/cash-app-pay) for more details. properties: display_preference: @@ -108931,13 +120228,32 @@ paths: type: object title: payment_method_param type: object + crypto: + description: >- + [Stablecoin + payments](https://docs.stripe.com/payments/stablecoin-payments) + enable customers to pay in stablecoins like USDC from 100s + of wallets including Phantom and Metamask. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object customer_balance: description: >- Uses a customer’s [cash - balance](https://stripe.com/docs/payments/customer-balance) + balance](https://docs.stripe.com/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this - [page](https://stripe.com/docs/payments/bank-transfers) for + [page](https://docs.stripe.com/payments/bank-transfers) for more details. properties: display_preference: @@ -108958,7 +120274,7 @@ paths: to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check - this [page](https://stripe.com/docs/payments/eps) for more + this [page](https://docs.stripe.com/payments/eps) for more details. properties: display_preference: @@ -108989,7 +120305,7 @@ paths: Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this - [page](https://stripe.com/docs/payments/fpx) for more + [page](https://docs.stripe.com/payments/fpx) for more details. properties: display_preference: @@ -109004,6 +120320,27 @@ paths: type: object title: payment_method_param type: object + fr_meal_voucher_conecs: + description: >- + Meal vouchers in France, or “titres-restaurant”, is a local + benefits program commonly offered by employers for their + employees to purchase prepared food and beverages on working + days. Check this + [page](https://docs.stripe.com/payments/meal-vouchers/fr-meal-vouchers) + for more details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object giropay: description: >- giropay is a German payment method based on online banking, @@ -109013,7 +120350,7 @@ paths: their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this - [page](https://stripe.com/docs/payments/giropay) for more + [page](https://docs.stripe.com/payments/giropay) for more details. properties: display_preference: @@ -109036,7 +120373,7 @@ paths: or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this - [page](https://stripe.com/docs/google-pay) for more details. + [page](https://docs.stripe.com/google-pay) for more details. properties: display_preference: properties: @@ -109056,7 +120393,7 @@ paths: [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this - [page](https://stripe.com/docs/payments/grabpay) for more + [page](https://docs.stripe.com/payments/grabpay) for more details. properties: display_preference: @@ -109079,7 +120416,7 @@ paths: the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this - [page](https://stripe.com/docs/payments/ideal) for more + [page](https://docs.stripe.com/payments/ideal) for more details. properties: display_preference: @@ -109117,15 +120454,32 @@ paths: type: object title: payment_method_param type: object + kakao_pay: + description: >- + Kakao Pay is a popular local wallet available in South + Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object klarna: description: >- Klarna gives customers a range of [payment - options](https://stripe.com/docs/payments/klarna#payment-options) + options](https://docs.stripe.com/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this - [page](https://stripe.com/docs/payments/klarna) for more + [page](https://docs.stripe.com/payments/klarna) for more details. properties: display_preference: @@ -109144,7 +120498,7 @@ paths: description: >- Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this - [page](https://stripe.com/docs/payments/konbini) for more + [page](https://docs.stripe.com/payments/konbini) for more details. properties: display_preference: @@ -109159,9 +120513,26 @@ paths: type: object title: payment_method_param type: object + kr_card: + description: >- + Korean cards let users pay using locally issued cards from + South Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object link: description: >- - [Link](https://stripe.com/docs/payments/link) is a payment + [Link](https://docs.stripe.com/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network. @@ -109178,15 +120549,35 @@ paths: type: object title: payment_method_param type: object + mb_way: + description: >- + MB WAY is the most popular wallet in Portugal. After + entering their phone number in your checkout, customers + approve the payment directly in their MB WAY app. Check this + [page](https://docs.stripe.com/payments/mb-way) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object mobilepay: description: >- MobilePay is a - [single-use](https://stripe.com/docs/payments/payment-methods#usage) + [single-use](https://docs.stripe.com/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and - approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this - [page](https://stripe.com/docs/payments/mobilepay) for more + [page](https://docs.stripe.com/payments/mobilepay) for more details. properties: display_preference: @@ -109225,13 +120616,50 @@ paths: description: Configuration name. maxLength: 100 type: string + naver_pay: + description: >- + Naver Pay is a popular local wallet available in South + Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + nz_bank_account: + description: >- + Stripe users in New Zealand can accept Bulk Electronic + Clearing System (BECS) direct debit payments from customers + with a New Zeland bank account. Check this + [page](https://docs.stripe.com/payments/nz-bank-account) for + more details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object oxxo: description: >- OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check - this [page](https://stripe.com/docs/payments/oxxo) for more + this [page](https://docs.stripe.com/payments/oxxo) for more details. properties: display_preference: @@ -109253,7 +120681,7 @@ paths: transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this - [page](https://stripe.com/docs/payments/p24) for more + [page](https://docs.stripe.com/payments/p24) for more details. properties: display_preference: @@ -109289,13 +120717,31 @@ paths: type: object title: payment_method_param type: object + payco: + description: >- + PAYCO is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage + local wallet available in South Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object paynow: description: >- PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this - [page](https://stripe.com/docs/payments/paynow) for more + [page](https://docs.stripe.com/payments/paynow) for more details. properties: display_preference: @@ -109315,7 +120761,49 @@ paths: PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this - [page](https://stripe.com/docs/payments/paypal) for more + [page](https://docs.stripe.com/payments/paypal) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + payto: + description: >- + PayTo is a + [real-time](https://docs.stripe.com/payments/real-time) + payment method that enables customers in Australia to pay by + providing their bank account details. Customers must accept + a mandate authorizing you to debit their account. Check this + [page](https://docs.stripe.com/payments/payto) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + pix: + description: >- + Pix is a payment method popular in Brazil. When paying with + Pix, customers authenticate and approve payments by scanning + a QR code in their preferred banking app. Check this + [page](https://docs.stripe.com/payments/pix) for more details. properties: display_preference: @@ -109335,7 +120823,7 @@ paths: PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this - [page](https://stripe.com/docs/payments/promptpay) for more + [page](https://docs.stripe.com/payments/promptpay) for more details. properties: display_preference: @@ -109370,6 +120858,48 @@ paths: type: object title: payment_method_param type: object + samsung_pay: + description: >- + Samsung Pay is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage + local wallet available in South Korea. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object + satispay: + description: >- + Satispay is a + [single-use](https://docs.stripe.com/payments/payment-methods#usage) + payment method where customers are required to + [authenticate](/payments/payment-methods#customer-actions) + their payment. Customers pay by being redirected from your + website or app, authorizing the payment with Satispay, then + returning to your website or app. You get [immediate + notification](/payments/payment-methods#payment-notification) + of whether the payment succeeded or failed. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object sepa_debit: description: >- The [Single Euro Payments Area @@ -109379,7 +120909,7 @@ paths: enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this - [page](https://stripe.com/docs/payments/sepa-debit) for more + [page](https://docs.stripe.com/payments/sepa-debit) for more details. properties: display_preference: @@ -109402,7 +120932,7 @@ paths: single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this - [page](https://stripe.com/docs/payments/sofort) for more + [page](https://docs.stripe.com/payments/sofort) for more details. properties: display_preference: @@ -109420,13 +120950,13 @@ paths: swish: description: >- Swish is a - [real-time](https://stripe.com/docs/payments/real-time) + [real-time](https://docs.stripe.com/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and - approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + approve](https://docs.stripe.com/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this - [page](https://stripe.com/docs/payments/swish) for more + [page](https://docs.stripe.com/payments/swish) for more details. properties: display_preference: @@ -109466,7 +120996,7 @@ 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-direct-debit) + [page](https://docs.stripe.com/payments/ach-direct-debit) for more details. properties: display_preference: @@ -109489,7 +121019,7 @@ paths: businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this - [page](https://stripe.com/docs/payments/wechat-pay) for more + [page](https://docs.stripe.com/payments/wechat-pay) for more details. properties: display_preference: @@ -109508,7 +121038,7 @@ paths: description: >- Zip gives your customers a way to split purchases over a series of payments. Check this - [page](https://stripe.com/docs/payments/zip) for more + [page](https://docs.stripe.com/payments/zip) for more details like country availability. properties: display_preference: @@ -109554,7 +121084,8 @@ paths: style: form - description: >- Whether this payment method domain is enabled. If the domain is not - enabled, payment methods will not appear in Elements + enabled, payment methods will not appear in Elements or Embedded + Checkout in: query name: enabled required: false @@ -109684,7 +121215,8 @@ paths: description: >- Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment - method domain will not appear in Elements. + method domain will not appear in Elements or Embedded + Checkout. type: boolean expand: description: Specifies which fields in the response should be expanded. @@ -109781,7 +121313,8 @@ paths: description: >- Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment - method domain will not appear in Elements. + method domain will not appear in Elements or Embedded + Checkout. type: boolean expand: description: Specifies which fields in the response should be expanded. @@ -109808,16 +121341,16 @@ paths: '/v1/payment_method_domains/{payment_method_domain}/validate': post: description: >- -

Some payment methods such as Apple Pay require additional steps to - verify a domain. If the requirements weren’t satisfied when the domain - was created, the payment method will be inactive on the domain. +

Some payment methods might require additional steps to register 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.

+ The payment method doesn’t appear in Elements or Embedded Checkout 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, + complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.

@@ -109867,13 +121400,24 @@ paths: summary: Validate an existing payment method domain /v1/payment_methods: get: - description: >- -

Returns a list of PaymentMethods for Treasury flows. If you want to - list the PaymentMethods attached to a Customer for payments, you should - use the List a - Customer’s PaymentMethods API instead.

+ description:

Returns a list of all PaymentMethods.

operationId: GetPaymentMethods parameters: + - description: >- + This field indicates whether this payment method can be shown again + to its customer in a checkout flow. Stripe products such as Checkout + and Elements use this field to determine whether a payment method + can be shown as a saved payment method in a checkout flow. + in: query + name: allow_redisplay + required: false + schema: + enum: + - always + - limited + - unspecified + type: string + style: form - description: The ID of the customer whose PaymentMethods will be retrieved. in: query name: customer @@ -109882,6 +121426,14 @@ paths: maxLength: 5000 type: string style: form + - description: The ID of the Account whose PaymentMethods will be retrieved. + in: query + name: customer_account + 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 @@ -109929,11 +121481,10 @@ paths: type: string style: form - description: >- - An optional filter on the list, based on the object `type` field. - Without the filter, the list includes all current and future payment - method types. If your integration expects only one type of payment - method in the response, make sure to provide a type value in the - request. + Filters the list by the object `type` field. Unfiltered, the list + returns all payment method types except `custom`. If your + integration expects only one type of payment method in the response, + specify that type value in the request to reduce your payload. in: query name: type required: false @@ -109948,10 +121499,13 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -109963,19 +121517,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -110084,6 +121642,9 @@ paths: bancontact: explode: true style: deepObject + billie: + explode: true + style: deepObject billing_details: explode: true style: deepObject @@ -110099,6 +121660,12 @@ paths: cashapp: explode: true style: deepObject + crypto: + explode: true + style: deepObject + custom: + explode: true + style: deepObject customer_balance: explode: true style: deepObject @@ -110138,6 +121705,9 @@ paths: link: explode: true style: deepObject + mb_way: + explode: true + style: deepObject metadata: explode: true style: deepObject @@ -110150,6 +121720,9 @@ paths: naver_pay: explode: true style: deepObject + nz_bank_account: + explode: true + style: deepObject oxxo: explode: true style: deepObject @@ -110168,6 +121741,9 @@ paths: paypal: explode: true style: deepObject + payto: + explode: true + style: deepObject pix: explode: true style: deepObject @@ -110183,6 +121759,9 @@ paths: samsung_pay: explode: true style: deepObject + satispay: + explode: true + style: deepObject sepa_debit: explode: true style: deepObject @@ -110311,6 +121890,13 @@ paths: properties: {} title: param type: object + billie: + description: >- + If this is a `billie` PaymentMethod, this hash contains + details about the Billie payment method. + properties: {} + title: param + type: object billing_details: description: >- Billing information associated with the PaymentMethod that @@ -110363,6 +121949,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -110439,6 +122028,25 @@ paths: properties: {} title: param type: object + crypto: + description: >- + If this is a Crypto PaymentMethod, this hash contains + details about the Crypto payment method. + properties: {} + title: param + type: object + custom: + description: >- + If this is a `custom` PaymentMethod, this hash contains + details about the Custom payment method. + properties: + type: + maxLength: 5000 + type: string + required: + - type + title: create_param + type: object customer: description: >- The `Customer` to whom the original PaymentMethod is @@ -110555,11 +122163,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -110630,12 +122242,19 @@ paths: properties: {} title: param type: object + mb_way: + description: >- + If this is a MB WAY PaymentMethod, this hash contains + details about the MB WAY payment method. + properties: {} + title: param + type: object metadata: additionalProperties: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -110669,6 +122288,36 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + description: >- + If this is an nz_bank_account PaymentMethod, this hash + contains details about the nz_bank_account payment method. + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: description: >- If this is an `oxxo` PaymentMethod, this hash contains @@ -110745,6 +122394,22 @@ paths: properties: {} title: param type: object + payto: + description: >- + If this is a `payto` PaymentMethod, this hash contains + details about the PayTo payment method. + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: description: >- If this is a `pix` PaymentMethod, this hash contains details @@ -110762,7 +122427,7 @@ paths: radar_options: description: >- Options to configure Radar. See [Radar - Session](https://stripe.com/docs/radar/radar-session) for + Session](https://docs.stripe.com/radar/radar-session) for more information. properties: session: @@ -110772,7 +122437,7 @@ paths: type: object revolut_pay: description: >- - If this is a `Revolut Pay` PaymentMethod, this hash contains + If this is a `revolut_pay` PaymentMethod, this hash contains details about the Revolut Pay payment method. properties: {} title: param @@ -110784,6 +122449,13 @@ paths: properties: {} title: param type: object + satispay: + description: >- + If this is a `satispay` PaymentMethod, this hash contains + details about the Satispay payment method. + properties: {} + title: param + type: object sepa_debit: description: >- If this is a `sepa_debit` PaymentMethod, this hash contains @@ -110844,10 +122516,13 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -110859,19 +122534,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -110989,7 +122668,7 @@ paths: summary: Retrieve a PaymentMethod post: description: >- -

Updates a PaymentMethod object. A PaymentMethod must be attached a +

Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.

operationId: PostPaymentMethodsPaymentMethod parameters: @@ -111013,16 +122692,10 @@ paths: expand: explode: true style: deepObject - link: - explode: true - style: deepObject metadata: explode: true style: deepObject - naver_pay: - explode: true - style: deepObject - pay_by_bank: + payto: explode: true style: deepObject us_bank_account: @@ -111096,6 +122769,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object card: @@ -111126,13 +122802,6 @@ paths: maxLength: 5000 type: string type: array - link: - description: >- - If this is an `Link` PaymentMethod, this hash contains - details about the Link payment method. - properties: {} - title: param - type: object metadata: anyOf: - additionalProperties: @@ -111143,30 +122812,26 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - naver_pay: + payto: description: >- - If this is a `naver_pay` PaymentMethod, this hash contains - details about the Naver Pay payment method. + If this is a `payto` PaymentMethod, this hash contains + details about the PayTo payment method. properties: - funding: - enum: - - card - - points + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 type: string - x-stripeBypassValidation: true - title: param - type: object - pay_by_bank: - description: >- - If this is a `pay_by_bank` PaymentMethod, this hash contains - details about the PayByBank payment method. - properties: {} title: param type: object us_bank_account: @@ -111259,16 +122924,20 @@ paths: description: The ID of the customer to which to attach the PaymentMethod. maxLength: 5000 type: string + customer_account: + description: >- + The ID of the Account representing the customer to which to + attach the PaymentMethod. + maxLength: 5000 + type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - required: - - customer type: object - required: true + required: false responses: '200': content: @@ -111330,6 +122999,1024 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Detach a PaymentMethod from a Customer + /v1/payment_records/report_payment: + post: + description: |- +

Report a new Payment Record. You may report a Payment Record as it is + initialized and later report updates through the other report_* methods, or report Payment + Records in a terminal state directly, through this method.

+ operationId: PostPaymentRecordsReportPayment + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + amount_requested: + explode: true + style: deepObject + customer_details: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + failed: + explode: true + style: deepObject + guaranteed: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + payment_method_details: + explode: true + style: deepObject + processor_details: + explode: true + style: deepObject + shipping_details: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount_requested: + description: The amount you initially requested for this payment. + properties: + currency: + format: currency + type: string + value: + type: integer + required: + - currency + - value + title: amount + type: object + customer_details: + description: Customer information for this payment. + properties: + customer: + maxLength: 5000 + type: string + email: + type: string + name: + maxLength: 5000 + type: string + phone: + type: string + title: customer_details + type: object + customer_presence: + description: >- + Indicates whether the customer was present in your checkout + flow during this payment. + enum: + - off_session + - on_session + type: string + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + failed: + description: Information about the payment attempt failure. + properties: + failed_at: + format: unix-time + type: integer + required: + - failed_at + title: failed + type: object + guaranteed: + description: Information about the payment attempt guarantee. + properties: + guaranteed_at: + format: unix-time + type: integer + required: + - guaranteed_at + title: guaranteed + type: object + initiated_at: + description: >- + When the reported payment was initiated. Measured in seconds + since the Unix epoch. + format: unix-time + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/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`. + outcome: + description: The outcome of the reported payment. + enum: + - failed + - guaranteed + type: string + payment_method_details: + description: >- + Information about the Payment Method debited for this + payment. + properties: + billing_details: + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + email: + type: string + name: + maxLength: 5000 + type: string + phone: + type: string + title: billing_details + type: object + custom: + properties: + display_name: + maxLength: 5000 + type: string + type: + maxLength: 5000 + type: string + title: custom + type: object + payment_method: + maxLength: 5000 + type: string + type: + enum: + - custom + type: string + title: payment_method_details + type: object + processor_details: + description: Processor information for this payment. + properties: + custom: + properties: + payment_reference: + maxLength: 5000 + type: string + required: + - payment_reference + title: custom + type: object + type: + enum: + - custom + type: string + required: + - type + title: processor_details + type: object + shipping_details: + description: Shipping information for this payment. + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + name: + maxLength: 5000 + type: string + phone: + type: string + title: shipping_details + type: object + required: + - amount_requested + - initiated_at + - payment_method_details + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report a payment + '/v1/payment_records/{id}': + get: + description:

Retrieves a Payment Record with the given ID

+ operationId: GetPaymentRecordsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The ID of the Payment Record. + 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/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Retrieve a Payment Record + '/v1/payment_records/{id}/report_payment_attempt': + post: + description: >- +

Report a new payment attempt on the specified Payment Record. A new + payment + attempt can only be specified if all other payment attempts are canceled or failed.

+ operationId: PostPaymentRecordsIdReportPaymentAttempt + parameters: + - description: The ID of the Payment Record. + 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 + failed: + explode: true + style: deepObject + guaranteed: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + payment_method_details: + explode: true + style: deepObject + shipping_details: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + failed: + description: Information about the payment attempt failure. + properties: + failed_at: + format: unix-time + type: integer + required: + - failed_at + title: failed + type: object + guaranteed: + description: Information about the payment attempt guarantee. + properties: + guaranteed_at: + format: unix-time + type: integer + required: + - guaranteed_at + title: guaranteed + type: object + initiated_at: + description: >- + When the reported payment was initiated. Measured in seconds + since the Unix epoch. + format: unix-time + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/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`. + outcome: + description: The outcome of the reported payment. + enum: + - failed + - guaranteed + type: string + payment_method_details: + description: >- + Information about the Payment Method debited for this + payment. + properties: + billing_details: + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + email: + type: string + name: + maxLength: 5000 + type: string + phone: + type: string + title: billing_details + type: object + custom: + properties: + display_name: + maxLength: 5000 + type: string + type: + maxLength: 5000 + type: string + title: custom + type: object + payment_method: + maxLength: 5000 + type: string + type: + enum: + - custom + type: string + title: payment_method_details + type: object + shipping_details: + description: Shipping information for this payment. + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + name: + maxLength: 5000 + type: string + phone: + type: string + title: shipping_details + type: object + required: + - initiated_at + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report a payment attempt + '/v1/payment_records/{id}/report_payment_attempt_canceled': + post: + description: >- +

Report that the most recent payment attempt on the specified Payment + Record + was canceled.

+ operationId: PostPaymentRecordsIdReportPaymentAttemptCanceled + parameters: + - description: The ID of the Payment Record. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + canceled_at: + description: >- + When the reported payment was canceled. Measured in seconds + since the Unix epoch. + format: unix-time + type: integer + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + required: + - canceled_at + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report payment attempt canceled + '/v1/payment_records/{id}/report_payment_attempt_failed': + post: + description: >- +

Report that the most recent payment attempt on the specified Payment + Record + failed or errored.

+ operationId: PostPaymentRecordsIdReportPaymentAttemptFailed + parameters: + - description: The ID of the Payment Record. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + failed_at: + description: >- + When the reported payment failed. Measured in seconds since + the Unix epoch. + format: unix-time + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + required: + - failed_at + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report payment attempt failed + '/v1/payment_records/{id}/report_payment_attempt_guaranteed': + post: + description: >- +

Report that the most recent payment attempt on the specified Payment + Record + was guaranteed.

+ operationId: PostPaymentRecordsIdReportPaymentAttemptGuaranteed + parameters: + - description: The ID of the Payment Record. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + guaranteed_at: + description: >- + When the reported payment was guaranteed. Measured in + seconds since the Unix epoch. + format: unix-time + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + required: + - guaranteed_at + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report payment attempt guaranteed + '/v1/payment_records/{id}/report_payment_attempt_informational': + post: + description:

Report informational updates on the specified Payment Record.

+ operationId: PostPaymentRecordsIdReportPaymentAttemptInformational + parameters: + - description: The ID of the Payment Record. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + customer_details: + explode: true + style: deepObject + description: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + shipping_details: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + customer_details: + description: Customer information for this payment. + properties: + customer: + maxLength: 5000 + type: string + email: + type: string + name: + maxLength: 5000 + type: string + phone: + type: string + title: customer_details + type: object + description: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/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`. + shipping_details: + anyOf: + - properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + name: + maxLength: 5000 + type: string + phone: + type: string + title: shipping_details + type: object + - enum: + - '' + type: string + description: Shipping information for this payment. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report payment attempt informational + '/v1/payment_records/{id}/report_refund': + post: + description: >- +

Report that the most recent payment attempt on the specified Payment + Record + was refunded.

+ operationId: PostPaymentRecordsIdReportRefund + parameters: + - description: The ID of the Payment Record. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + amount: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + processor_details: + explode: true + style: deepObject + refunded: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + description: >- + A positive integer in the [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal) + representing how much of this payment to refund. Can refund + only up to the remaining, unrefunded amount of the payment. + properties: + currency: + format: currency + type: string + value: + type: integer + required: + - currency + - value + title: amount + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + initiated_at: + description: >- + When the reported refund was initiated. Measured in seconds + since the Unix epoch. + format: unix-time + type: integer + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/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`. + outcome: + description: The outcome of the reported refund. + enum: + - refunded + type: string + processor_details: + description: Processor information for this refund. + properties: + custom: + properties: + refund_reference: + maxLength: 5000 + type: string + required: + - refund_reference + title: custom + type: object + type: + enum: + - custom + type: string + required: + - type + title: processor_details + type: object + refunded: + description: Information about the payment attempt refund. + properties: + refunded_at: + format: unix-time + type: integer + required: + - refunded_at + title: refunded + type: object + required: + - outcome + - processor_details + - refunded + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_record' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Report a refund /v1/payouts: get: description: >- @@ -111564,7 +124251,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -111584,6 +124271,9 @@ paths: maxLength: 5000 type: string x-stripeBypassValidation: true + payout_method: + description: The ID of a v2 FinancialAccount to send funds to. + type: string source_type: description: >- The balance type of your Stripe balance to draw this payout @@ -111718,7 +124408,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -111791,9 +124481,10 @@ paths: post: 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.

+ time, you can only reverse payouts for connected accounts to US and + Canadian bank accounts. If the payout is manual and in the + pending status, use /v1/payouts/:id/cancel + instead.

By requesting a reversal through @@ -111833,7 +124524,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -112035,21 +124726,6 @@ paths: Whether the plan is currently available for new subscriptions. Defaults to `true`. type: boolean - aggregate_usage: - description: >- - Specifies a usage aggregation strategy for plans of - `usage_type=metered`. Allowed values are `sum` for summing - up all usage during a period, `last_during_period` for using - the last usage record reported within a period, `last_ever` - for using the last usage record ever (across period bounds) - or `max` which uses the usage record with the maximum - reported usage during a period. Defaults to `sum`. - enum: - - last_during_period - - last_ever - - max - - sum - type: string amount: description: >- A positive integer in cents (or local equivalent) (or 0 for @@ -112127,7 +124803,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -112148,7 +124824,7 @@ paths: represent. This can either be the ID of an existing product, or a dictionary containing fields used to create a [service - product](https://stripe.com/docs/api#product_object-type). + product](https://docs.stripe.com/api#product_object-type). properties: active: type: boolean @@ -112243,7 +124919,7 @@ paths: description: >- Default number of trial days when subscribing a customer to this plan using - [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). type: integer usage_type: description: >- @@ -112405,7 +125081,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -112425,7 +125101,7 @@ paths: description: >- Default number of trial days when subscribing a customer to this plan using - [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan). + [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). type: integer type: object required: false @@ -112651,8 +125327,10 @@ paths: summary: List all prices post: description: >- -

Creates a new price for an existing product. The price can be - recurring or one-time.

+

Creates a new Price + for an existing Product. The Price can + be recurring or one-time.

operationId: PostPrices requestBody: content: @@ -112808,7 +125486,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -112820,7 +125498,10 @@ paths: maxLength: 5000 type: string product: - description: The ID of the product that this price will belong to. + description: >- + The ID of the + [Product](https://docs.stripe.com/api/products) that this + [Price](https://docs.stripe.com/api/prices) will belong to. maxLength: 5000 type: string product_data: @@ -112859,13 +125540,6 @@ paths: The recurring components of a price such as `interval` and `usage_type`. properties: - aggregate_usage: - enum: - - last_during_period - - last_ever - - max - - sum - type: string interval: enum: - day @@ -112890,7 +125564,7 @@ paths: tax_behavior: description: >- Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or @@ -113046,9 +125720,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for - prices](https://stripe.com/docs/search#query-fields-for-prices). + prices](https://docs.stripe.com/search#query-fields-for-prices). in: query name: query required: true @@ -113281,7 +125955,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -113294,7 +125968,7 @@ paths: tax_behavior: description: >- Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or @@ -113391,9 +126065,9 @@ paths: style: deepObject - description: >- Only return products with the given IDs. Cannot be used with - [starting_after](https://stripe.com/docs/api#list_products-starting_after) + [starting_after](https://api.stripe.com#list_products-starting_after) or - [ending_before](https://stripe.com/docs/api#list_products-ending_before). + [ending_before](https://api.stripe.com#list_products-ending_before). explode: true in: query name: ids @@ -113534,7 +126208,7 @@ paths: default_price_data: description: >- Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object. This + [Price](https://docs.stripe.com/api/prices) object. This Price will be set as the default price for this product. properties: currency: @@ -113610,6 +126284,10 @@ paths: - enabled title: custom_unit_amount type: object + metadata: + additionalProperties: + type: string + type: object recurring: properties: interval: @@ -113638,7 +126316,7 @@ paths: type: string required: - currency - title: price_data_without_product + title: price_data_without_product_with_metadata type: object description: description: >- @@ -113672,7 +126350,7 @@ paths: description: >- A list of up to 15 marketing features for this product. These are displayed in [pricing - tables](https://stripe.com/docs/payments/checkout/pricing-table). + tables](https://docs.stripe.com/payments/checkout/pricing-table). items: properties: name: @@ -113688,7 +126366,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -113736,7 +126414,7 @@ paths: maxLength: 22 type: string tax_code: - description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' + description: 'A [tax code](https://docs.stripe.com/tax/tax-categories) ID.' type: string unit_label: description: >- @@ -113816,9 +126494,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for - products](https://stripe.com/docs/search#query-fields-for-products). + products](https://docs.stripe.com/search#query-fields-for-products). in: query name: query required: true @@ -114023,7 +126701,7 @@ paths: type: boolean default_price: description: >- - The ID of the [Price](https://stripe.com/docs/api/prices) + The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product. maxLength: 5000 type: string @@ -114074,7 +126752,7 @@ paths: description: >- A list of up to 15 marketing features for this product. These are displayed in [pricing - tables](https://stripe.com/docs/payments/checkout/pricing-table). + tables](https://docs.stripe.com/payments/checkout/pricing-table). metadata: anyOf: - additionalProperties: @@ -114085,7 +126763,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -114141,7 +126819,7 @@ paths: - enum: - '' type: string - description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' + description: 'A [tax code](https://docs.stripe.com/tax/tax-categories) ID.' unit_label: anyOf: - maxLength: 12 @@ -114314,7 +126992,7 @@ paths: entitlement_feature: description: >- The ID of the - [Feature](https://stripe.com/docs/api/entitlements/feature) + [Feature](https://docs.stripe.com/api/entitlements/feature) object attached to this product. maxLength: 5000 type: string @@ -114499,6 +127177,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return promotion codes that are restricted to this account + representing the customer. + in: query + name: customer_account + 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 @@ -114601,8 +127289,9 @@ paths: summary: List all promotion codes post: description: >- -

A promotion code points to a coupon. You can optionally restrict the - code to a specific customer, redemption limit, and expiration date.

+

A promotion code points to an underlying promotion. You can + optionally restrict the code to a specific customer, redemption limit, + and expiration date.

operationId: PostPromotionCodes requestBody: content: @@ -114614,6 +127303,9 @@ paths: metadata: explode: true style: deepObject + promotion: + explode: true + style: deepObject restrictions: explode: true style: deepObject @@ -114628,20 +127320,23 @@ paths: 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). + upper case letters (A-Z), digits (0-9), and dashes (-). If left blank, we will generate one automatically. maxLength: 500 type: string - coupon: - description: The coupon for this promotion code. + customer: + description: >- + The customer who can use this promotion code. If not set, + all customers can use the promotion code. maxLength: 5000 type: string - customer: + customer_account: description: >- - The customer that this promotion code can be used by. If not - set, the promotion code can be used by all customers. + The account representing the customer who can use this + promotion code. If not set, all customers can use the + promotion code. maxLength: 5000 type: string expand: @@ -114669,13 +127364,27 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 + promotion: + description: The promotion referenced by this promotion code. + properties: + coupon: + maxLength: 5000 + type: string + type: + enum: + - coupon + type: string + required: + - type + title: promotion + type: object restrictions: description: Settings that restrict the redemption of the promotion code. properties: @@ -114697,7 +127406,7 @@ paths: title: restrictions_params type: object required: - - coupon + - promotion type: object required: true responses: @@ -114815,7 +127524,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -114855,7 +127564,7 @@ paths: description:

Returns a list of your quotes.

operationId: GetQuotes parameters: - - description: The ID of the customer whose quotes will be retrieved. + - description: The ID of the customer whose quotes you're retrieving. in: query name: customer required: false @@ -114863,6 +127572,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + The ID of the account representing the customer whose quotes you're + retrieving. + in: query + name: customer_account + 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 @@ -115089,6 +127808,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -115118,6 +127838,13 @@ paths: cannot be changed. maxLength: 5000 type: string + customer_account: + description: >- + The account for which this quote belongs to. A customer or + account is required before finalizing the quote. Once + specified, it cannot be changed. + maxLength: 5000 + type: string default_tax_rates: anyOf: - items: @@ -115234,6 +127961,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -115327,7 +128055,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -115351,6 +128079,26 @@ paths: `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created. properties: + billing_mode: + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - classic + - flexible + type: string + required: + - type + title: billing_mode + type: object description: maxLength: 500 type: string @@ -115564,6 +128312,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -115593,6 +128342,13 @@ paths: cannot be changed. maxLength: 5000 type: string + customer_account: + description: >- + The account for which this quote belongs to. A customer or + account is required before finalizing the quote. Once + specified, it cannot be changed. + maxLength: 5000 + type: string default_tax_rates: anyOf: - items: @@ -115676,6 +128432,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -115772,7 +128529,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -116483,6 +129240,222 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Retrieve an early fraud warning + /v1/radar/payment_evaluations: + post: + description: >- +

Request a Radar API fraud risk score from Stripe for a payment before + sending it for external processor authorization.

+ operationId: PostRadarPaymentEvaluations + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + client_device_metadata_details: + explode: true + style: deepObject + customer_details: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + payment_details: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + client_device_metadata_details: + description: >- + Details about the Client Device Metadata to associate with + the payment evaluation. + properties: + radar_session: + maxLength: 5000 + type: string + required: + - radar_session + title: client_device_metadata_wrapper + type: object + customer_details: + description: >- + Details about the customer associated with the payment + evaluation. + properties: + customer: + maxLength: 5000 + type: string + customer_account: + maxLength: 5000 + type: string + email: + type: string + name: + maxLength: 5000 + type: string + phone: + type: string + title: customer_details + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + additionalProperties: + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/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_details: + description: Details about the payment. + properties: + amount: + type: integer + currency: + format: currency + type: string + description: + maxLength: 5000 + type: string + money_movement_details: + properties: + card: + properties: + customer_presence: + enum: + - off_session + - on_session + type: string + payment_type: + enum: + - one_off + - recurring + - setup_one_off + - setup_recurring + type: string + title: money_movement_card_additional_data + type: object + money_movement_type: + enum: + - card + type: string + required: + - money_movement_type + title: money_movement_details + type: object + payment_method_details: + properties: + billing_details: + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + email: + type: string + name: + maxLength: 5000 + type: string + phone: + type: string + title: billing_details + type: object + payment_method: + maxLength: 5000 + type: string + required: + - payment_method + title: payment_method_details + type: object + shipping_details: + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address + type: object + name: + maxLength: 5000 + type: string + phone: + type: string + title: shipping_details + type: object + statement_descriptor: + maxLength: 5000 + type: string + required: + - amount + - currency + - payment_method_details + title: payment_details + type: object + required: + - customer_details + - payment_details + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/radar.payment_evaluation' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Create a Payment Evaluation /v1/radar/value_list_items: get: description: >- @@ -116942,11 +129915,10 @@ paths: item_type: description: >- Type of the items in the value list. One of - `card_fingerprint`, `us_bank_account_fingerprint`, - `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, - `country`, `string`, `case_sensitive_string`, or - `customer_id`. Use `string` if the item type is unknown or - mixed. + `card_fingerprint`, `card_bin`, `email`, `ip_address`, + `country`, `string`, `case_sensitive_string`, `customer_id`, + `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. + Use `string` if the item type is unknown or mixed. enum: - card_bin - card_fingerprint @@ -116965,7 +129937,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -117120,7 +130092,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -117369,7 +130341,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -117391,7 +130363,7 @@ paths: `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 + lists](https://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms. enum: - duplicate @@ -117523,7 +130495,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -117754,7 +130726,7 @@ paths: Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the [API Access to - Reports](https://stripe.com/docs/reporting/statements/api) + Reports](https://docs.stripe.com/reporting/statements/api) documentation. properties: columns: @@ -117918,6 +130890,7 @@ paths: - America/Coral_Harbour - America/Cordoba - America/Costa_Rica + - America/Coyhaique - America/Creston - America/Cuiaba - America/Curacao @@ -118424,7 +131397,7 @@ paths: report_type: description: >- The ID of the [report - type](https://stripe.com/docs/reporting/statements/api#report-types) + type](https://docs.stripe.com/reporting/statements/api#report-types) to run, such as `"balance.summary.1"`. type: string required: @@ -119023,6 +131996,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return SetupIntents for the account specified by this customer + ID. + in: query + name: customer_account + 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 @@ -119151,6 +132134,9 @@ paths: automatic_payment_methods: explode: true style: deepObject + excluded_payment_method_types: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -119238,12 +132224,82 @@ paths: SetupIntent. maxLength: 5000 type: string + customer_account: + description: >- + ID of the Account this SetupIntent belongs to, if one + exists. + + + If present, the SetupIntent's payment method will be + attached to the Account on successful setup. Payment methods + attached to other Accounts cannot be used with this + SetupIntent. + maxLength: 5000 + type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string + excluded_payment_method_types: + description: >- + The list of payment method types to exclude from use with + this SetupIntent. + items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + type: array expand: description: Specifies which fields in the response should be expanded. items: @@ -119311,13 +132367,13 @@ paths: description: >- This hash contains details about the mandate to create. This parameter can only be used with - [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm). + [`confirm=true`](https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm). metadata: additionalProperties: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -119336,7 +132392,7 @@ paths: payment_method_configuration: description: >- The ID of the [payment method - configuration](https://stripe.com/docs/api/payment_method_configurations) + configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. maxLength: 100 type: string @@ -119344,7 +132400,7 @@ paths: description: >- When included, this hash creates a PaymentMethod that is set as the - [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. properties: @@ -119418,6 +132474,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -119466,6 +132526,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -119485,6 +132548,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -119571,11 +132638,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -119628,6 +132699,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -119650,6 +132725,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -119704,6 +132806,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -119727,6 +132842,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -119770,9 +132889,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -119784,19 +132905,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -120046,6 +133171,8 @@ paths: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param @@ -120056,6 +133183,123 @@ paths: properties: {} title: setup_intent_payment_method_options_param type: object + klarna: + properties: + currency: + format: currency + type: string + on_demand: + properties: + average_amount: + type: integer + maximum_amount: + type: integer + minimum_amount: + type: integer + purchase_interval: + enum: + - day + - month + - week + - year + type: string + purchase_interval_count: + type: integer + title: on_demand_param + type: object + preferred_locale: + enum: + - cs-CZ + - da-DK + - de-AT + - de-CH + - de-DE + - el-GR + - en-AT + - en-AU + - en-BE + - en-CA + - en-CH + - en-CZ + - en-DE + - en-DK + - en-ES + - en-FI + - en-FR + - en-GB + - en-GR + - en-IE + - en-IT + - en-NL + - en-NO + - en-NZ + - en-PL + - en-PT + - en-RO + - en-SE + - en-US + - es-ES + - es-US + - fi-FI + - fr-BE + - fr-CA + - fr-CH + - fr-FR + - it-CH + - it-IT + - nb-NO + - nl-BE + - nl-NL + - pl-PL + - pt-PT + - ro-RO + - sv-FI + - sv-SE + type: string + x-stripeBypassValidation: true + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - next_billing + - reference + title: setup_intent_subscription_param + type: object + type: array + - enum: + - '' + type: string + title: setup_intent_payment_method_options_param + type: object link: properties: {} title: setup_intent_payment_method_options_param @@ -120067,6 +133311,74 @@ paths: type: string title: payment_method_options_param type: object + payto: + properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + start_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: >- + setup_intent_payment_method_options_mandate_options_param + type: object + title: setup_intent_payment_method_options_param + type: object sepa_debit: properties: mandate_options: @@ -120162,6 +133474,8 @@ paths: will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + A list of valid payment method types can be found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string @@ -120173,12 +133487,18 @@ paths: 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). + [`confirm=true`](https://docs.stripe.com/api/setup_intents/create#create_setup_intent-confirm). type: string single_use: description: >- If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion. + + + Single-use mandates are only valid for the following payment + methods: `acss_debit`, `alipay`, `au_becs_debit`, + `bacs_debit`, `bancontact`, `boleto`, `ideal`, `link`, + `sepa_debit`, and `us_bank_account`. properties: amount: type: integer @@ -120304,6 +133624,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + excluded_payment_method_types: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -120349,12 +133672,86 @@ paths: SetupIntent. maxLength: 5000 type: string + customer_account: + description: >- + ID of the Account this SetupIntent belongs to, if one + exists. + + + If present, the SetupIntent's payment method will be + attached to the Account on successful setup. Payment methods + attached to other Accounts cannot be used with this + SetupIntent. + maxLength: 5000 + type: string description: description: >- An arbitrary string attached to the object. Often useful for displaying to users. maxLength: 1000 type: string + excluded_payment_method_types: + anyOf: + - items: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - alma + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billie + - blik + - boleto + - card + - cashapp + - crypto + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - kakao_pay + - klarna + - konbini + - kr_card + - mb_way + - mobilepay + - multibanco + - naver_pay + - nz_bank_account + - oxxo + - p24 + - pay_by_bank + - payco + - paynow + - paypal + - payto + - pix + - promptpay + - revolut_pay + - samsung_pay + - satispay + - sepa_debit + - sofort + - swish + - twint + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + type: array + - enum: + - '' + type: string + description: >- + The list of payment method types to exclude from use with + this SetupIntent. expand: description: Specifies which fields in the response should be expanded. items: @@ -120388,7 +133785,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -120404,7 +133801,7 @@ paths: payment_method_configuration: description: >- The ID of the [payment method - configuration](https://stripe.com/docs/api/payment_method_configurations) + configuration](https://docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent. maxLength: 100 type: string @@ -120412,7 +133809,7 @@ paths: description: >- When included, this hash creates a PaymentMethod that is set as the - [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. properties: @@ -120486,6 +133883,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -120534,6 +133935,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -120553,6 +133957,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -120639,11 +134047,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -120696,6 +134108,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -120718,6 +134134,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -120772,6 +134215,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -120795,6 +134251,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -120838,9 +134298,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -120852,19 +134314,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -121114,6 +134580,8 @@ paths: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param @@ -121124,6 +134592,123 @@ paths: properties: {} title: setup_intent_payment_method_options_param type: object + klarna: + properties: + currency: + format: currency + type: string + on_demand: + properties: + average_amount: + type: integer + maximum_amount: + type: integer + minimum_amount: + type: integer + purchase_interval: + enum: + - day + - month + - week + - year + type: string + purchase_interval_count: + type: integer + title: on_demand_param + type: object + preferred_locale: + enum: + - cs-CZ + - da-DK + - de-AT + - de-CH + - de-DE + - el-GR + - en-AT + - en-AU + - en-BE + - en-CA + - en-CH + - en-CZ + - en-DE + - en-DK + - en-ES + - en-FI + - en-FR + - en-GB + - en-GR + - en-IE + - en-IT + - en-NL + - en-NO + - en-NZ + - en-PL + - en-PT + - en-RO + - en-SE + - en-US + - es-ES + - es-US + - fi-FI + - fr-BE + - fr-CA + - fr-CH + - fr-FR + - it-CH + - it-IT + - nb-NO + - nl-BE + - nl-NL + - pl-PL + - pt-PT + - ro-RO + - sv-FI + - sv-SE + type: string + x-stripeBypassValidation: true + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - next_billing + - reference + title: setup_intent_subscription_param + type: object + type: array + - enum: + - '' + type: string + title: setup_intent_payment_method_options_param + type: object link: properties: {} title: setup_intent_payment_method_options_param @@ -121135,6 +134720,74 @@ paths: type: string title: payment_method_options_param type: object + payto: + properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + start_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: >- + setup_intent_payment_method_options_mandate_options_param + type: object + title: setup_intent_payment_method_options_param + type: object sepa_debit: properties: mandate_options: @@ -121230,6 +134883,8 @@ paths: Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + A list of valid payment method types can be found + [here](https://docs.stripe.com/api/payment_methods/object#payment_method_object-type). items: maxLength: 5000 type: string @@ -121472,7 +135127,7 @@ paths: description: >- When included, this hash creates a PaymentMethod that is set as the - [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method) + [`payment_method`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent. properties: @@ -121546,6 +135201,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -121594,6 +135253,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -121613,6 +135275,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -121699,11 +135365,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -121756,6 +135426,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -121778,6 +135452,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -121832,6 +135533,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -121855,6 +135569,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -121898,9 +135616,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -121912,19 +135632,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -122174,6 +135898,8 @@ paths: - 1.0.2 - 2.1.0 - 2.2.0 + - 2.3.0 + - 2.3.1 type: string x-stripeBypassValidation: true title: setup_intent_payment_method_options_param @@ -122184,6 +135910,123 @@ paths: properties: {} title: setup_intent_payment_method_options_param type: object + klarna: + properties: + currency: + format: currency + type: string + on_demand: + properties: + average_amount: + type: integer + maximum_amount: + type: integer + minimum_amount: + type: integer + purchase_interval: + enum: + - day + - month + - week + - year + type: string + purchase_interval_count: + type: integer + title: on_demand_param + type: object + preferred_locale: + enum: + - cs-CZ + - da-DK + - de-AT + - de-CH + - de-DE + - el-GR + - en-AT + - en-AU + - en-BE + - en-CA + - en-CH + - en-CZ + - en-DE + - en-DK + - en-ES + - en-FI + - en-FR + - en-GB + - en-GR + - en-IE + - en-IT + - en-NL + - en-NO + - en-NZ + - en-PL + - en-PT + - en-RO + - en-SE + - en-US + - es-ES + - es-US + - fi-FI + - fr-BE + - fr-CA + - fr-CH + - fr-FR + - it-CH + - it-IT + - nb-NO + - nl-BE + - nl-NL + - pl-PL + - pt-PT + - ro-RO + - sv-FI + - sv-SE + type: string + x-stripeBypassValidation: true + subscriptions: + anyOf: + - items: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + name: + maxLength: 255 + type: string + next_billing: + properties: + amount: + type: integer + date: + maxLength: 5000 + type: string + required: + - amount + - date + title: subscription_next_billing_param + type: object + reference: + maxLength: 255 + type: string + required: + - interval + - next_billing + - reference + title: setup_intent_subscription_param + type: object + type: array + - enum: + - '' + type: string + title: setup_intent_payment_method_options_param + type: object link: properties: {} title: setup_intent_payment_method_options_param @@ -122195,6 +136038,74 @@ paths: type: string title: payment_method_options_param type: object + payto: + properties: + mandate_options: + properties: + amount: + anyOf: + - type: integer + - enum: + - '' + type: string + amount_type: + enum: + - '' + - fixed + - maximum + type: string + end_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_schedule: + enum: + - '' + - adhoc + - annual + - daily + - fortnightly + - monthly + - quarterly + - semi_annual + - weekly + type: string + payments_per_period: + anyOf: + - type: integer + - enum: + - '' + type: string + purpose: + enum: + - '' + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + start_date: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: >- + setup_intent_payment_method_options_mandate_options_param + type: object + title: setup_intent_payment_method_options_param + type: object sepa_debit: properties: mandate_options: @@ -122635,7 +136546,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -122654,7 +136565,7 @@ paths: type: string tax_code: description: >- - A [tax code](https://stripe.com/docs/tax/tax-categories) ID. + A [tax code](https://docs.stripe.com/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`. type: string type: @@ -122795,7 +136706,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -122827,6 +136738,64 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Update a shipping rate + '/v1/sigma/saved_queries/{id}': + post: + description:

Update an existing Sigma query that previously exists

+ operationId: PostSigmaSavedQueriesId + parameters: + - description: >- + The `id` of the saved query to update. This should be a valid `id` + that was previously created. + 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 + name: + description: The name of the query to update. + maxLength: 5000 + type: string + sql: + description: >- + The sql statement to update the specified query statement + with. This should be a valid Trino SQL statement that can be + run in Sigma. + maxLength: 100000 + type: string + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/sigma.sigma_api_query' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Update an existing Sigma Query /v1/sigma/scheduled_query_runs: get: description:

Returns a list of scheduled query runs.

@@ -123302,7 +137271,7 @@ paths: The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Cloning card - Sources](https://stripe.com/docs/sources/connect#cloning-card-sources) + Sources](https://docs.stripe.com/sources/connect#cloning-card-sources) guide) maxLength: 5000 type: string @@ -123528,7 +137497,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -124095,9 +138064,8 @@ paths: type: string description: >- Define thresholds at which an invoice will be sent, and the - subscription advanced to a new billing period. When - updating, pass an empty string to remove previously-defined - thresholds. + subscription advanced to a new billing period. Pass an empty + string to remove previously-defined thresholds. discounts: anyOf: - items: @@ -124131,7 +138099,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -124146,7 +138114,7 @@ paths: user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -124156,16 +138124,16 @@ paths: allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA - regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending - updates](https://stripe.com/docs/billing/subscriptions/pending-updates). + updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending - updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an @@ -124175,7 +138143,7 @@ paths: is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the - [changelog](https://stripe.com/docs/upgrades#2019-03-14) to + [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. enum: - allow_incomplete @@ -124190,7 +138158,7 @@ paths: price_data: description: >- Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object inline. + [Price](https://docs.stripe.com/api/prices) object inline. properties: currency: format: currency @@ -124233,7 +138201,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -124249,7 +138217,7 @@ paths: subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming - invoice](https://stripe.com/docs/api#retrieve_customer_invoice) + invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. format: unix-time type: integer @@ -124272,9 +138240,9 @@ paths: - '' type: string description: >- - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the - [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) + [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. required: @@ -124321,10 +138289,55 @@ paths: Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. type: boolean + payment_behavior: + description: >- + Use `allow_incomplete` to transition the subscription to + `status=past_due` if a payment is required but cannot be + paid. This allows you to manage scenarios where additional + user actions are needed to pay a subscription's invoice. For + example, SCA regulation may require 3DS authentication to + complete payment. See the [SCA Migration + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) + for Billing to learn more. This is the default behavior. + + + Use `default_incomplete` to transition the subscription to + `status=past_due` when payment is required and await + explicit confirmation of the invoice's payment intent. This + allows simpler management of scenarios where additional user + actions are needed to pay a subscription’s invoice. Such as + failed payments, [SCA + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), + or collecting a mandate for a bank debit payment method. + + + Use `pending_if_incomplete` to update the subscription using + [pending + updates](https://docs.stripe.com/billing/subscriptions/pending-updates). + When you use `pending_if_incomplete` you can only pass the + parameters [supported by pending + updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). + + + Use `error_if_incomplete` if you want Stripe to return an + HTTP 402 status code if a subscription's invoice cannot be + paid. For example, if a payment method requires 3DS + authentication due to SCA regulation and further user action + is needed, this parameter does not update the subscription + and returns an error instead. This was the default behavior + for API versions prior to 2019-03-14. See the + [changelog](https://docs.stripe.com/changelog/2019-03-14) to + learn more. + enum: + - allow_incomplete + - default_incomplete + - error_if_incomplete + - pending_if_incomplete + type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -124340,7 +138353,7 @@ paths: subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming - invoice](https://stripe.com/docs/api#retrieve_customer_invoice) + invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. format: unix-time type: integer @@ -124457,9 +138470,8 @@ paths: type: string description: >- Define thresholds at which an invoice will be sent, and the - subscription advanced to a new billing period. When - updating, pass an empty string to remove previously-defined - thresholds. + subscription advanced to a new billing period. Pass an empty + string to remove previously-defined thresholds. discounts: anyOf: - items: @@ -124498,7 +138510,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -124518,7 +138530,7 @@ paths: user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -124528,16 +138540,16 @@ paths: allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA - regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending - updates](https://stripe.com/docs/billing/subscriptions/pending-updates). + updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending - updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an @@ -124547,7 +138559,7 @@ paths: is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the - [changelog](https://stripe.com/docs/upgrades#2019-03-14) to + [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. enum: - allow_incomplete @@ -124566,7 +138578,7 @@ paths: price_data: description: >- Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object inline. + [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required. properties: currency: @@ -124610,7 +138622,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -124626,7 +138638,7 @@ paths: subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming - invoice](https://stripe.com/docs/api#retrieve_customer_invoice) + invoice](https://api.stripe.com#retrieve_customer_invoice) endpoint. format: unix-time type: integer @@ -124645,9 +138657,9 @@ paths: - '' type: string description: >- - A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) + A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the - [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) + [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates. type: object @@ -124666,234 +138678,6 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Update a subscription item - '/v1/subscription_items/{subscription_item}/usage_record_summaries': - get: - 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.

- operationId: GetSubscriptionItemsSubscriptionItemUsageRecordSummaries - parameters: - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - A cursor for use in pagination. `starting_after` is an object ID - that defines your place in the list. For instance, if you make a - list request and receive 100 objects, ending with `obj_foo`, your - subsequent call can include `starting_after=obj_foo` in order to - fetch the next page of the list. - in: query - name: starting_after - required: false - schema: - maxLength: 5000 - type: string - style: form - - in: path - name: subscription_item - required: true - schema: - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/usage_record_summary' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: UsageEventsResourceUsageRecordSummaryList - type: object - x-expandableFields: - - data - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: List all subscription item period summaries - '/v1/subscription_items/{subscription_item}/usage_records': - post: - description: >- -

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.

- operationId: PostSubscriptionItemsSubscriptionItemUsageRecords - parameters: - - in: path - name: subscription_item - required: true - schema: - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - timestamp: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - action: - description: >- - Valid values are `increment` (default) or `set`. When using - `increment` the specified `quantity` will be added to the - usage at the specified timestamp. The `set` action will - overwrite the usage quantity at that timestamp. If the - subscription has [billing - thresholds](https://stripe.com/docs/api/subscriptions/object#subscription_object-billing_thresholds), - `increment` is the only allowed value. - enum: - - increment - - set - type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - quantity: - description: The usage quantity for the specified timestamp. - type: integer - timestamp: - anyOf: - - enum: - - now - maxLength: 5000 - type: string - - format: unix-time - type: integer - description: >- - The timestamp for the usage event. This timestamp must be - within the current billing period of the subscription of the - provided `subscription_item`, and must not be in the future. - When passing `"now"`, Stripe records usage for the current - time. Default is `"now"` if a value is not provided. - required: - - quantity - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/usage_record' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - summary: Create a usage record /v1/subscription_schedules: get: description:

Retrieves the list of your subscription schedules.

@@ -124973,6 +138757,14 @@ paths: maxLength: 5000 type: string style: form + - description: Only return subscription schedules for the given account. + in: query + name: customer_account + 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 @@ -125111,6 +138903,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + billing_mode: + explode: true + style: deepObject default_settings: explode: true style: deepObject @@ -125129,12 +138924,41 @@ paths: schema: additionalProperties: false properties: + billing_mode: + description: >- + Controls how prorations and invoices for subscriptions are + calculated and orchestrated. + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - classic + - flexible + type: string + required: + - type + title: billing_mode + type: object customer: description: >- The identifier of the customer to create the subscription schedule for. maxLength: 5000 type: string + customer_account: + description: >- + The identifier of the account to create the subscription + schedule for. + maxLength: 5000 + type: string default_settings: description: >- Object representing the subscription schedule's default @@ -125155,6 +138979,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125217,6 +139042,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125287,7 +139113,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -125320,6 +139146,49 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - phase_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - phase_start + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -125376,6 +139245,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125406,9 +139276,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - maxLength: 5000 - type: string currency: format: currency type: string @@ -125444,12 +139311,27 @@ paths: promotion_code: maxLength: 5000 type: string - title: discounts_data_param + title: schedule_discounts_data_param type: object type: array - enum: - '' type: string + duration: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: duration_params + type: object end_date: format: unix-time type: integer @@ -125475,6 +139357,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125509,7 +139392,7 @@ paths: promotion_code: maxLength: 5000 type: string - title: discounts_data_param + title: schedule_discounts_data_param type: object type: array - enum: @@ -125576,8 +139459,6 @@ paths: title: configuration_item_params type: object type: array - iterations: - type: integer metadata: additionalProperties: type: string @@ -125739,6 +139620,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125801,6 +139683,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125859,7 +139742,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -125892,6 +139775,49 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - phase_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - phase_start + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -125948,6 +139874,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -125978,9 +139905,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - maxLength: 5000 - type: string default_payment_method: maxLength: 5000 type: string @@ -126013,12 +139937,27 @@ paths: promotion_code: maxLength: 5000 type: string - title: discounts_data_param + title: schedule_discounts_data_param type: object type: array - enum: - '' type: string + duration: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: duration_params + type: object end_date: anyOf: - format: unix-time @@ -126049,6 +139988,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -126083,7 +140023,7 @@ paths: promotion_code: maxLength: 5000 type: string - title: discounts_data_param + title: schedule_discounts_data_param type: object type: array - enum: @@ -126150,8 +140090,6 @@ paths: title: configuration_item_params type: object type: array - iterations: - type: integer metadata: additionalProperties: type: string @@ -126199,9 +140137,10 @@ paths: type: array proration_behavior: description: >- - If the update changes the current phase, indicates whether - the changes should be prorated. The default value is - `create_prorations`. + If the update changes the billing configuration (item price, + quantity, etc.) of the current phase, indicates how + prorations from this change should be handled. The default + value is `create_prorations`. enum: - always_invoice - create_prorations @@ -126396,8 +140335,8 @@ paths: - type: integer style: deepObject - description: >- - Only return subscriptions whose current_period_end falls within the - given date interval. + Only return subscriptions whose minimum item current_period_end + falls within the given date interval. explode: true in: query name: current_period_end @@ -126418,8 +140357,8 @@ paths: - type: integer style: deepObject - description: >- - Only return subscriptions whose current_period_start falls within - the given date interval. + Only return subscriptions whose maximum item current_period_start + falls within the given date interval. explode: true in: query name: current_period_start @@ -126439,7 +140378,7 @@ paths: type: object - type: integer style: deepObject - - description: The ID of the customer whose subscriptions will be retrieved. + - description: The ID of the customer whose subscriptions you're retrieving. in: query name: customer required: false @@ -126447,6 +140386,16 @@ paths: maxLength: 5000 type: string style: form + - description: >- + The ID of the account representing the customer whose subscriptions + you're retrieving. + in: query + name: customer_account + 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 @@ -126507,7 +140456,7 @@ paths: belonging to deleted customers. Pass `ended` to find subscriptions that are canceled and subscriptions that are expired due to [incomplete - payment](https://stripe.com/docs/billing/subscriptions/overview#subscription-statuses). + payment](https://docs.stripe.com/billing/subscriptions/overview#subscription-statuses). Passing in a value of `all` will return subscriptions of all statuses. If no value is supplied, all subscriptions that have not been canceled are returned. @@ -126631,9 +140580,15 @@ paths: billing_cycle_anchor_config: explode: true style: deepObject + billing_mode: + explode: true + style: deepObject billing_thresholds: explode: true style: deepObject + cancel_at: + explode: true + style: deepObject default_tax_rates: explode: true style: deepObject @@ -126695,6 +140650,48 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - now + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -126752,10 +140749,7 @@ paths: application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). automatic_tax: - description: >- - Automatic tax settings for this subscription. We recommend - you only include this parameter when the existing value is - being changed. + description: Automatic tax settings for this subscription. properties: enabled: type: boolean @@ -126768,6 +140762,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -126778,18 +140773,17 @@ paths: type: object backdate_start_date: description: >- - For new subscriptions, a past timestamp to backdate the - subscription's start date to. If set, the first invoice will - contain a proration for the timespan between the start date - and the current time. Can be combined with trials and the - billing cycle anchor. + A past timestamp to backdate the subscription's start date + to. If set, the first invoice will contain line items for + the timespan between the start date and the current time. + Can be combined with trials and the billing cycle anchor. format: unix-time type: integer billing_cycle_anchor: description: >- A future timestamp in UTC format to anchor the subscription's [billing - cycle](https://stripe.com/docs/subscriptions/billing-cycle). + cycle](https://docs.stripe.com/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the @@ -126801,7 +140795,7 @@ paths: description: >- Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the - billing_cycle_anchor is set to the next occurence of the + billing_cycle_anchor is set to the next occurrence of the day_of_month at the hour, minute, and second UTC. properties: day_of_month: @@ -126816,7 +140810,30 @@ paths: type: integer required: - day_of_month - title: billing_cycle_anchor_config_param + title: cycle_anchor_config_param + type: object + billing_mode: + description: >- + Controls how prorations and invoices for subscriptions are + calculated and orchestrated. + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - classic + - flexible + type: string + required: + - type + title: billing_mode type: object billing_thresholds: anyOf: @@ -126832,17 +140849,23 @@ paths: type: string description: >- Define thresholds at which an invoice will be sent, and the - subscription advanced to a new billing period. Pass an empty - string to remove previously-defined thresholds. + subscription advanced to a new billing period. When + updating, pass an empty string to remove previously-defined + thresholds. cancel_at: + anyOf: + - format: unix-time + type: integer + - enum: + - max_period_end + - min_period_end + type: string description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. - format: unix-time - type: integer cancel_at_period_end: description: >- Indicate whether this subscription should cancel at the end @@ -126862,15 +140885,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - description: >- - The ID of the coupon to apply to this subscription. A coupon - applied to a subscription will only affect invoices created - for that particular subscription. This field has been - deprecated and will be removed in a future API version. Use - `discounts` instead. - maxLength: 5000 - type: string currency: description: >- Three-letter [ISO currency @@ -126883,6 +140897,12 @@ paths: description: The identifier of the customer to subscribe. maxLength: 5000 type: string + customer_account: + description: >- + The identifier of the account representing the customer to + subscribe. + maxLength: 5000 + type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by @@ -126895,9 +140915,9 @@ paths: must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). maxLength: 5000 type: string default_source: @@ -126907,9 +140927,9 @@ paths: and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). maxLength: 5000 type: string default_tax_rates: @@ -126983,6 +141003,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -127097,7 +141118,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -127131,7 +141152,7 @@ paths: pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -127143,7 +141164,7 @@ paths: management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA - regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, @@ -127157,7 +141178,7 @@ paths: action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See - the [changelog](https://stripe.com/docs/upgrades#2019-03-14) + the [changelog](https://docs.stripe.com/upgrades#2019-03-14) to learn more. @@ -127299,6 +141320,34 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + type: integer + purpose: + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: mandate_options_param + type: object + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: {} @@ -127367,6 +141416,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -127374,6 +141424,8 @@ paths: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -127382,15 +141434,19 @@ paths: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -127434,21 +141490,12 @@ paths: description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an - invoice](https://stripe.com/docs/api#create_invoice) for the + invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. - promotion_code: - description: >- - The promotion code to apply to this subscription. A - promotion code applied to a subscription will only affect - invoices created for that particular subscription. This - field has been deprecated and will be removed in a future - API version. Use `discounts` instead. - maxLength: 5000 - type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. enum: @@ -127486,7 +141533,7 @@ paths: value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. trial_from_plan: description: >- @@ -127495,7 +141542,7 @@ paths: preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. type: boolean trial_period_days: @@ -127504,7 +141551,7 @@ paths: the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. type: integer trial_settings: @@ -127526,10 +141573,8 @@ paths: - end_behavior title: trial_settings_config type: object - required: - - customer type: object - required: true + required: false responses: '200': content: @@ -127593,9 +141638,9 @@ paths: style: form - description: >- The search query string. See [search query - language](https://stripe.com/docs/search#search-query-language) and + language](https://docs.stripe.com/search#search-query-language) and the list of supported [query fields for - subscriptions](https://stripe.com/docs/search#query-fields-for-subscriptions). + subscriptions](https://docs.stripe.com/search#query-fields-for-subscriptions). in: query name: query required: true @@ -127675,7 +141720,9 @@ paths: href="#delete_invoiceitem">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.

+ is set to cancel immediately, pending prorations are removed if + invoice_now and prorate are both set to + true.

By default, upon subscription cancellation, Stripe stops automatic @@ -127982,6 +142029,48 @@ paths: title: discounts_data_param type: object type: array + metadata: + additionalProperties: + type: string + type: object + period: + properties: + end: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - min_item_period_end + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_end + type: object + start: + properties: + timestamp: + format: unix-time + type: integer + type: + enum: + - max_item_period_start + - now + - timestamp + type: string + x-stripeBypassValidation: true + required: + - type + title: invoice_item_period_start + type: object + required: + - end + - start + title: invoice_item_period + type: object price: maxLength: 5000 type: string @@ -128055,6 +142144,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -128069,7 +142159,7 @@ paths: resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle - [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). + [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). enum: - now - unchanged @@ -128090,8 +142180,9 @@ paths: type: string description: >- Define thresholds at which an invoice will be sent, and the - subscription advanced to a new billing period. Pass an empty - string to remove previously-defined thresholds. + subscription advanced to a new billing period. When + updating, pass an empty string to remove previously-defined + thresholds. cancel_at: anyOf: - format: unix-time @@ -128099,6 +142190,10 @@ paths: - enum: - '' type: string + - enum: + - max_period_end + - min_period_end + type: string description: >- A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a @@ -128148,15 +142243,6 @@ paths: - charge_automatically - send_invoice type: string - coupon: - description: >- - The ID of the coupon to apply to this subscription. A coupon - applied to a subscription will only affect invoices created - for that particular subscription. This field has been - deprecated and will be removed in a future API version. Use - `discounts` instead. - maxLength: 5000 - type: string days_until_due: description: >- Number of days a customer has to pay invoices generated by @@ -128169,9 +142255,9 @@ paths: must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). maxLength: 5000 type: string default_source: @@ -128187,9 +142273,9 @@ paths: and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) or - [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source). + [default_source](https://docs.stripe.com/api/customers/object#customer_object-default_source). default_tax_rates: anyOf: - items: @@ -128266,6 +142352,7 @@ paths: - account - self type: string + x-stripeBypassValidation: true required: - type title: param @@ -128391,7 +142478,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -128436,7 +142523,7 @@ paths: 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). + collection](https://docs.stripe.com/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to @@ -128445,7 +142532,7 @@ paths: user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration - Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) + Guide](https://docs.stripe.com/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -128455,16 +142542,16 @@ paths: allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA - regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), + regulation](https://docs.stripe.com/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. Use `pending_if_incomplete` to update the subscription using [pending - updates](https://stripe.com/docs/billing/subscriptions/pending-updates). + updates](https://docs.stripe.com/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending - updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes). + updates](https://docs.stripe.com/billing/pending-updates-reference#supported-attributes). Use `error_if_incomplete` if you want Stripe to return an @@ -128474,7 +142561,7 @@ paths: is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the - [changelog](https://stripe.com/docs/upgrades#2019-03-14) to + [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more. enum: - allow_incomplete @@ -128607,6 +142694,34 @@ paths: - enum: - '' type: string + payto: + anyOf: + - properties: + mandate_options: + properties: + amount: + type: integer + purpose: + enum: + - dependant_support + - government + - loan + - mortgage + - other + - pension + - personal + - retail + - salary + - tax + - utility + type: string + title: mandate_options_param + type: object + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string sepa_debit: anyOf: - properties: {} @@ -128675,6 +142790,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - affirm - amazon_pay - au_becs_debit - bacs_debit @@ -128682,6 +142798,8 @@ paths: - boleto - card - cashapp + - crypto + - custom - customer_balance - eps - fpx @@ -128690,15 +142808,19 @@ paths: - ideal - jp_credit_transfer - kakao_pay + - klarna - konbini - kr_card - link - multibanco - naver_pay + - nz_bank_account - p24 + - pay_by_bank - payco - paynow - paypal + - payto - promptpay - revolut_pay - sepa_credit_transfer @@ -128742,21 +142864,12 @@ paths: description: >- Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an - invoice](https://stripe.com/docs/api#create_invoice) for the + invoice](https://docs.stripe.com/api#create_invoice) for the given subscription at the specified interval. - promotion_code: - description: >- - The promotion code to apply to this subscription. A - promotion code applied to a subscription will only affect - invoices created for that particular subscription. This - field has been deprecated and will be removed in a future - API version. Use `discounts` instead. - maxLength: 5000 - type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -128768,15 +142881,15 @@ paths: type: string proration_date: description: >- - If set, the proration will be calculated as though the + If set, prorations will be calculated as though the subscription was updated at the given time. This can be used - to apply exactly the same proration that was previewed with - [upcoming - invoice](https://stripe.com/docs/api#upcoming_invoice) - endpoint. It can also be used to implement custom proration - logic, such as prorating by day instead of by second, by - providing the time that you wish to use for proration - calculations. + to apply exactly the same prorations that were previewed + with the [create + preview](https://stripe.com/docs/api/invoices/create_preview) + endpoint. `proration_date` can also be used to implement + custom proration logic, such as prorating by day instead of + by second, by providing the time that you wish to use for + proration calculations. format: unix-time type: integer transfer_data: @@ -128810,11 +142923,12 @@ paths: Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a - subscribed plan. If set, trial_end will override the default - trial period of the plan the customer is being subscribed - to. The special value `now` can be provided to end the - customer's trial immediately. Can be at most two years from - `billing_cycle_anchor`. + subscribed plan. If set, `trial_end` will override the + default trial period of the plan the customer is being + subscribed to. The `billing_cycle_anchor` will be updated to + the `trial_end` value. The special value `now` can be + provided to end the customer's trial immediately. Can be at + most two years from `billing_cycle_anchor`. trial_from_plan: description: >- Indicates if a plan's `trial_period_days` should be applied @@ -128822,7 +142936,7 @@ paths: preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) + subscriptions](https://docs.stripe.com/billing/subscriptions/trials) to learn more. type: boolean trial_settings: @@ -128895,16 +143009,87 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Delete a subscription discount + '/v1/subscriptions/{subscription}/migrate': + post: + description:

Upgrade the billing_mode of an existing subscription.

+ operationId: PostSubscriptionsSubscriptionMigrate + parameters: + - in: path + name: subscription + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + billing_mode: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + billing_mode: + description: >- + Controls how prorations and invoices for subscriptions are + calculated and orchestrated. + properties: + flexible: + properties: + proration_discounts: + enum: + - included + - itemized + type: string + title: flexible_params + type: object + type: + enum: + - flexible + type: string + required: + - type + title: billing_mode_migrate + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - billing_mode + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/subscription' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Migrate a subscription '/v1/subscriptions/{subscription}/resume': post: 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.

+ the billing cycle anchor and creating prorations. If no resumption + invoice is generated, the subscription becomes active + immediately. If a resumption invoice is generated, the subscription + remains paused until the invoice is paid or marked + uncollectible. If the invoice is not paid by the expiration date, it is + voided and the subscription remains paused.

operationId: PostSubscriptionsSubscriptionResume parameters: - in: path @@ -128929,7 +143114,7 @@ paths: 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). + [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle). enum: - now - unchanged @@ -128943,11 +143128,11 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/billing/subscriptions/prorations) - when the billing cycle changes (e.g., when switching plans, - resetting `billing_cycle_anchor=now`, or starting a trial), - or if an item's `quantity` changes. The default value is - `create_prorations`. + [prorations](https://docs.stripe.com/billing/subscriptions/prorations) + resulting from the `billing_cycle_anchor` being `unchanged`. + When the `billing_cycle_anchor` is set to `now` (default + value), no prorations are generated. If no value is passed, + the default is `create_prorations`. enum: - always_invoice - create_prorations @@ -128955,11 +143140,11 @@ paths: type: string proration_date: description: >- - If set, the proration will be calculated as though the + If set, prorations will be calculated as though the subscription was resumed at the given time. This can be used - to apply exactly the same proration that was previewed with - [upcoming - invoice](https://stripe.com/docs/api#retrieve_customer_invoice) + to apply exactly the same prorations that were previewed + with the [create + preview](https://stripe.com/docs/api/invoices/create_preview) endpoint. format: unix-time type: integer @@ -128979,6 +143164,56 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Resume a subscription + /v1/tax/associations/find: + get: + description:

Finds a tax association object by PaymentIntent id.

+ operationId: GetTaxAssociationsFind + 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: >- + Valid + [PaymentIntent](https://docs.stripe.com/api/payment_intents/object) + id + in: query + name: payment_intent + required: true + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax.association' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Find a Tax Association /v1/tax/calculations: post: description: >- @@ -129089,10 +143324,15 @@ paths: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -129108,14 +143348,17 @@ paths: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -129132,11 +143375,14 @@ paths: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -129154,6 +143400,7 @@ paths: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -129212,6 +143459,10 @@ paths: properties: amount: type: integer + metadata: + additionalProperties: + type: string + type: object product: maxLength: 5000 type: string @@ -129652,6 +143903,15 @@ paths: properties: ae: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129662,6 +143922,15 @@ paths: type: object al: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129682,6 +143951,15 @@ paths: type: object ao: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129696,6 +143974,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -129716,6 +143995,15 @@ paths: type: object au: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129724,8 +144012,46 @@ paths: - type title: default type: object + aw: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + az: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object ba: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129736,6 +144062,34 @@ paths: type: object bb: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object + type: + enum: + - standard + type: string + required: + - type + title: default + type: object + bd: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129750,6 +144104,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -129768,12 +144123,32 @@ paths: - type title: europe type: object + bf: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object + type: + enum: + - standard + type: string + required: + - type + title: default + type: object bg: properties: standard: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -129794,6 +144169,15 @@ paths: type: object bh: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129802,8 +144186,27 @@ paths: - type title: default type: object + bj: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object bs: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129845,6 +144248,15 @@ paths: type: object cd: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129855,6 +144267,15 @@ paths: type: object ch: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -129873,6 +144294,16 @@ paths: - type title: simplified type: object + cm: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object co: properties: type: @@ -129893,12 +144324,23 @@ paths: - type title: simplified type: object + cv: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object cy: properties: standard: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -129923,6 +144365,127 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + de: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + dk: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + ec: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + ee: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - small_seller + - standard + type: string + required: + - place_of_supply_scheme + title: standard + type: object + type: + enum: + - ioss + - oss_non_union + - oss_union + - standard + type: string + required: + - type + title: europe + type: object + eg: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + es: + properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods - small_seller - standard type: string @@ -129941,36 +144504,32 @@ paths: - type title: europe type: object - de: + et: properties: standard: properties: place_of_supply_scheme: enum: - - small_seller + - inbound_goods - 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 - dk: + fi: properties: standard: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -129989,22 +144548,13 @@ paths: - type title: europe type: object - ec: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified - type: object - ee: + fr: properties: standard: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130023,110 +144573,46 @@ paths: - type title: europe type: object - eg: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified - type: object - es: + gb: properties: standard: properties: place_of_supply_scheme: enum: - - small_seller + - inbound_goods - 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 - fi: + ge: 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 + - simplified type: string required: - type - title: europe + title: simplified type: object - fr: + gn: properties: standard: properties: place_of_supply_scheme: enum: - - small_seller + - inbound_goods - standard type: string - required: - - place_of_supply_scheme title: standard type: object - type: - enum: - - ioss - - oss_non_union - - oss_union - - standard - type: string - required: - - type - title: europe - type: object - gb: - properties: - type: - enum: - - standard - type: string - required: - - type - title: default - type: object - ge: - properties: - type: - enum: - - simplified - type: string - required: - - type - title: simplified - type: object - gn: - properties: type: enum: - standard @@ -130141,6 +144627,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130165,6 +144652,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130189,6 +144677,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130223,6 +144712,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130241,8 +144731,27 @@ paths: - type title: europe type: object + in: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object is: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130257,6 +144766,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130277,6 +144787,15 @@ paths: type: object jp: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130295,6 +144814,16 @@ paths: - type title: simplified type: object + kg: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object kh: properties: type: @@ -130325,12 +144854,33 @@ paths: - type title: simplified type: object + la: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object + lk: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object lt: properties: standard: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130355,6 +144905,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130379,6 +144930,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130419,6 +144971,15 @@ paths: type: object me: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130429,6 +144990,15 @@ paths: type: object mk: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130439,6 +145009,15 @@ paths: type: object mr: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130453,6 +145032,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130507,6 +145087,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130527,6 +145108,15 @@ paths: type: object 'no': properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130547,6 +145137,15 @@ paths: type: object nz: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130557,6 +145156,15 @@ paths: type: object om: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130575,12 +145183,23 @@ paths: - type title: simplified type: object + ph: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object pl: properties: standard: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130605,6 +145224,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130629,6 +145249,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130649,6 +145270,15 @@ paths: type: object rs: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130683,6 +145313,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130703,6 +145334,15 @@ paths: type: object sg: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130717,6 +145357,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130741,6 +145382,7 @@ paths: properties: place_of_supply_scheme: enum: + - inbound_goods - small_seller - standard type: string @@ -130771,6 +145413,15 @@ paths: type: object sr: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130785,9 +145436,10 @@ paths: enum: - simplified type: string + x-stripeBypassValidation: true required: - type - title: simplified + title: thailand type: object tj: properties: @@ -130809,6 +145461,16 @@ paths: - type title: simplified type: object + tw: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object tz: properties: type: @@ -130819,6 +145481,16 @@ paths: - type title: simplified type: object + ua: + properties: + type: + enum: + - simplified + type: string + required: + - type + title: simplified + type: object ug: properties: type: @@ -130891,6 +145563,15 @@ paths: type: object uy: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130921,6 +145602,15 @@ paths: type: object za: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -130941,6 +145631,15 @@ paths: type: object zw: properties: + standard: + properties: + place_of_supply_scheme: + enum: + - inbound_goods + - standard + type: string + title: standard + type: object type: enum: - standard @@ -131275,7 +145974,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -131352,7 +146051,7 @@ paths: description: >- A flat amount to reverse across the entire transaction, in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) in + unit](https://docs.stripe.com/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. type: integer @@ -131389,7 +146088,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -131415,7 +146114,7 @@ paths: `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax - reports](https://stripe.com/docs/tax/reports). + reports](https://docs.stripe.com/tax/reports). maxLength: 500 type: string shipping_cost: @@ -131817,6 +146516,9 @@ paths: customer: maxLength: 5000 type: string + customer_account: + maxLength: 5000 + type: string type: enum: - account @@ -131928,6 +146630,9 @@ paths: customer: maxLength: 5000 type: string + customer_account: + maxLength: 5000 + type: string type: enum: - account @@ -131942,19 +146647,21 @@ paths: type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `al_tin`, - `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `ba_tin`, - `bb_tin`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, - `bs_tin`, `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, - `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, - `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, - `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, - `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, `hk_br`, `hr_oib`, - `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, - `jp_rn`, `jp_trn`, `ke_pin`, `kh_tin`, `kr_brn`, `kz_bin`, - `li_uid`, `li_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, - `mr_nif`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, - `no_vat`, `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, - `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, + `am_tin`, `ao_tin`, `ar_cuit`, `au_abn`, `au_arn`, `aw_tin`, + `az_tin`, `ba_tin`, `bb_tin`, `bd_bin`, `bf_ifu`, `bg_uic`, + `bh_vat`, `bj_ifu`, `bo_tin`, `br_cnpj`, `br_cpf`, `bs_tin`, + `by_tin`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `ca_qst`, `cd_nif`, `ch_uid`, `ch_vat`, + `cl_tin`, `cm_niu`, `cn_tin`, `co_nit`, `cr_tin`, `cv_nif`, + `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `et_tin`, + `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `gn_nif`, + `hk_br`, `hr_oib`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, + `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kg_tin`, + `kh_tin`, `kr_brn`, `kz_bin`, `la_tin`, `li_uid`, `li_vat`, + `lk_vat`, `ma_vat`, `md_vat`, `me_pib`, `mk_vat`, `mr_nif`, + `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, + `no_voec`, `np_pan`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, + `pl_nip`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sn_ninea`, `sr_fin`, `sv_nit`, `th_vat`, `tj_tin`, `tr_tin`, `tw_vat`, `tz_vat`, `ua_vat`, `ug_tin`, `us_ein`, `uy_ruc`, `uz_tin`, `uz_vat`, @@ -131968,10 +146675,15 @@ paths: - ar_cuit - au_abn - au_arn + - aw_tin + - az_tin - ba_tin - bb_tin + - bd_bin + - bf_ifu - bg_uic - bh_vat + - bj_ifu - bo_tin - br_cnpj - br_cpf @@ -131987,14 +146699,17 @@ paths: - ch_uid - ch_vat - cl_tin + - cm_niu - cn_tin - co_nit - cr_tin + - cv_nif - de_stn - do_rcn - ec_ruc - eg_tin - es_cif + - et_tin - eu_oss_vat - eu_vat - gb_vat @@ -132011,11 +146726,14 @@ paths: - jp_rn - jp_trn - ke_pin + - kg_tin - kh_tin - kr_brn - kz_bin + - la_tin - li_uid - li_vat + - lk_vat - ma_vat - md_vat - me_pib @@ -132033,6 +146751,7 @@ paths: - om_vat - pe_ruc - ph_tin + - pl_nip - ro_tin - rs_pib - ru_inn @@ -132375,7 +147094,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -132388,10 +147107,10 @@ paths: state: description: >- [ISO 3166-2 subdivision - code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without + code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - maxLength: 2 + maxLength: 5000 type: string tax_type: description: 'The high-level tax type, such as `vat` or `sales_tax`.' @@ -132550,7 +147269,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -132559,10 +147278,10 @@ paths: state: description: >- [ISO 3166-2 subdivision - code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without + code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States. - maxLength: 2 + maxLength: 5000 type: string tax_type: description: 'The high-level tax type, such as `vat` or `sales_tax`.' @@ -132720,9 +147439,15 @@ paths: content: application/x-www-form-urlencoded: encoding: + bbpos_wisepad3: + explode: true + style: deepObject bbpos_wisepos_e: explode: true style: deepObject + cellular: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -132735,19 +147460,38 @@ paths: stripe_s700: explode: true style: deepObject + stripe_s710: + explode: true + style: deepObject tipping: explode: true style: deepObject verifone_p400: explode: true style: deepObject + wifi: + explode: true + style: deepObject schema: additionalProperties: false properties: + bbpos_wisepad3: + description: >- + An object containing device type specific settings for BBPOS + WisePad 3 readers. + properties: + splashscreen: + anyOf: + - type: string + - enum: + - '' + type: string + title: bbpos_wise_pad3 + type: object bbpos_wisepos_e: description: >- An object containing device type specific settings for BBPOS - WisePOS E readers + WisePOS E readers. properties: splashscreen: anyOf: @@ -132757,6 +147501,19 @@ paths: type: string title: bbpos_wise_pose type: object + cellular: + anyOf: + - properties: + enabled: + type: boolean + required: + - enabled + title: cellular + type: object + - enum: + - '' + type: string + description: Configuration for cellular connectivity. expand: description: Specifies which fields in the response should be expanded. items: @@ -132782,7 +147539,7 @@ paths: description: Configurations for collecting transactions offline. reboot_window: description: >- - Reboot time settings for readers that support customized + Reboot time settings for readers. that support customized reboot time configuration. properties: end_hour: @@ -132797,7 +147554,7 @@ paths: stripe_s700: description: >- An object containing device type specific settings for - Stripe S700 readers + Stripe S700 readers. properties: splashscreen: anyOf: @@ -132807,9 +147564,36 @@ paths: type: string title: stripe_s700 type: object + stripe_s710: + description: >- + An object containing device type specific settings for + Stripe S710 readers. + properties: + splashscreen: + anyOf: + - type: string + - enum: + - '' + type: string + title: stripe_s710 + type: object tipping: anyOf: - properties: + aed: + 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 aud: properties: fixed_amounts: @@ -132908,6 +147692,20 @@ paths: type: integer title: currency_specific_config type: object + gip: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object hkd: properties: fixed_amounts: @@ -132922,6 +147720,20 @@ paths: type: integer title: currency_specific_config type: object + huf: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object jpy: properties: fixed_amounts: @@ -132936,6 +147748,20 @@ paths: type: integer title: currency_specific_config type: object + mxn: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object myr: properties: fixed_amounts: @@ -132992,6 +147818,20 @@ paths: type: integer title: currency_specific_config type: object + ron: + 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: @@ -133039,11 +147879,13 @@ paths: - enum: - '' type: string - description: Tipping configurations for readers supporting on-reader tips + description: >- + Tipping configurations for readers that support on-reader + tips. verifone_p400: description: >- An object containing device type specific settings for - Verifone P400 readers + Verifone P400 readers. properties: splashscreen: anyOf: @@ -133053,6 +147895,75 @@ paths: type: string title: verifone_p400 type: object + wifi: + anyOf: + - properties: + enterprise_eap_peap: + properties: + ca_certificate_file: + type: string + password: + maxLength: 5000 + type: string + ssid: + maxLength: 5000 + type: string + username: + maxLength: 5000 + type: string + required: + - password + - ssid + - username + title: enterprise_peap_config + type: object + enterprise_eap_tls: + properties: + ca_certificate_file: + type: string + client_certificate_file: + type: string + private_key_file: + type: string + private_key_file_password: + maxLength: 5000 + type: string + ssid: + maxLength: 5000 + type: string + required: + - client_certificate_file + - private_key_file + - ssid + title: enterprise_tls_config + type: object + personal_psk: + properties: + password: + maxLength: 63 + type: string + ssid: + maxLength: 5000 + type: string + required: + - password + - ssid + title: personal_psk_config + type: object + type: + enum: + - enterprise_eap_peap + - enterprise_eap_tls + - personal_psk + type: string + required: + - type + title: wifi + type: object + - enum: + - '' + type: string + description: Configurations for connecting to a WiFi network. type: object required: false responses: @@ -133166,9 +148077,15 @@ paths: content: application/x-www-form-urlencoded: encoding: + bbpos_wisepad3: + explode: true + style: deepObject bbpos_wisepos_e: explode: true style: deepObject + cellular: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -133181,15 +148098,38 @@ paths: stripe_s700: explode: true style: deepObject + stripe_s710: + explode: true + style: deepObject tipping: explode: true style: deepObject verifone_p400: explode: true style: deepObject + wifi: + explode: true + style: deepObject schema: additionalProperties: false properties: + bbpos_wisepad3: + anyOf: + - properties: + splashscreen: + anyOf: + - type: string + - enum: + - '' + type: string + title: bbpos_wise_pad3 + type: object + - enum: + - '' + type: string + description: >- + An object containing device type specific settings for BBPOS + WisePad 3 readers. bbpos_wisepos_e: anyOf: - properties: @@ -133206,7 +148146,20 @@ paths: type: string description: >- An object containing device type specific settings for BBPOS - WisePOS E readers + WisePOS E readers. + cellular: + anyOf: + - properties: + enabled: + type: boolean + required: + - enabled + title: cellular + type: object + - enum: + - '' + type: string + description: Configuration for cellular connectivity. expand: description: Specifies which fields in the response should be expanded. items: @@ -133246,7 +148199,7 @@ paths: - '' type: string description: >- - Reboot time settings for readers that support customized + Reboot time settings for readers. that support customized reboot time configuration. stripe_s700: anyOf: @@ -133264,10 +148217,41 @@ paths: type: string description: >- An object containing device type specific settings for - Stripe S700 readers + Stripe S700 readers. + stripe_s710: + anyOf: + - properties: + splashscreen: + anyOf: + - type: string + - enum: + - '' + type: string + title: stripe_s710 + type: object + - enum: + - '' + type: string + description: >- + An object containing device type specific settings for + Stripe S710 readers. tipping: anyOf: - properties: + aed: + 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 aud: properties: fixed_amounts: @@ -133366,6 +148350,20 @@ paths: type: integer title: currency_specific_config type: object + gip: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object hkd: properties: fixed_amounts: @@ -133380,6 +148378,20 @@ paths: type: integer title: currency_specific_config type: object + huf: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object jpy: properties: fixed_amounts: @@ -133394,6 +148406,20 @@ paths: type: integer title: currency_specific_config type: object + mxn: + properties: + fixed_amounts: + items: + type: integer + type: array + percentages: + items: + type: integer + type: array + smart_tip_threshold: + type: integer + title: currency_specific_config + type: object myr: properties: fixed_amounts: @@ -133450,6 +148476,20 @@ paths: type: integer title: currency_specific_config type: object + ron: + 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: @@ -133497,7 +148537,9 @@ paths: - enum: - '' type: string - description: Tipping configurations for readers supporting on-reader tips + description: >- + Tipping configurations for readers that support on-reader + tips. verifone_p400: anyOf: - properties: @@ -133514,7 +148556,76 @@ paths: type: string description: >- An object containing device type specific settings for - Verifone P400 readers + Verifone P400 readers. + wifi: + anyOf: + - properties: + enterprise_eap_peap: + properties: + ca_certificate_file: + type: string + password: + maxLength: 5000 + type: string + ssid: + maxLength: 5000 + type: string + username: + maxLength: 5000 + type: string + required: + - password + - ssid + - username + title: enterprise_peap_config + type: object + enterprise_eap_tls: + properties: + ca_certificate_file: + type: string + client_certificate_file: + type: string + private_key_file: + type: string + private_key_file_password: + maxLength: 5000 + type: string + ssid: + maxLength: 5000 + type: string + required: + - client_certificate_file + - private_key_file + - ssid + title: enterprise_tls_config + type: object + personal_psk: + properties: + password: + maxLength: 63 + type: string + ssid: + maxLength: 5000 + type: string + required: + - password + - ssid + title: personal_psk_config + type: object + type: + enum: + - enterprise_eap_peap + - enterprise_eap_tls + - personal_psk + type: string + required: + - type + title: wifi + type: object + - enum: + - '' + type: string + description: Configurations for connecting to a WiFi network. type: object required: false responses: @@ -133704,6 +148815,12 @@ paths: address: explode: true style: deepObject + address_kana: + explode: true + style: deepObject + address_kanji: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -133738,6 +148855,62 @@ paths: - country title: create_location_address_param type: object + address_kana: + description: >- + The Kana variation of the full address of the location + (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kana_specs + type: object + address_kanji: + description: >- + The Kanji variation of the full address of the location + (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kanji_specs + type: object configuration_overrides: description: >- The ID of a configuration that will be used to customize all @@ -133748,6 +148921,18 @@ paths: description: A name for the location. Maximum length is 1000 characters. maxLength: 1000 type: string + display_name_kana: + description: >- + The Kana variation of the name for the location (Japan + only). Maximum length is 1000 characters. + maxLength: 1000 + type: string + display_name_kanji: + description: >- + The Kanji variation of the name for the location (Japan + only). Maximum length is 1000 characters. + maxLength: 1000 + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -133764,17 +148949,17 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - required: - - address - - display_name + phone: + description: The phone number for the location. + type: string type: object - required: true + required: false responses: '200': content: @@ -133892,15 +149077,33 @@ paths: address: explode: true style: deepObject + address_kana: + explode: true + style: deepObject + address_kanji: + explode: true + style: deepObject configuration_overrides: explode: true style: deepObject + display_name: + explode: true + style: deepObject + display_name_kana: + explode: true + style: deepObject + display_name_kanji: + explode: true + style: deepObject expand: explode: true style: deepObject metadata: explode: true style: deepObject + phone: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -133931,6 +149134,62 @@ paths: type: string title: optional_fields_address type: object + address_kana: + description: >- + The Kana variation of the full address of the location + (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kana_specs + type: object + address_kanji: + description: >- + The Kanji variation of the full address of the location + (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kanji_specs + type: object configuration_overrides: anyOf: - maxLength: 1000 @@ -133942,9 +149201,33 @@ paths: The ID of a configuration that will be used to customize all readers in this location. display_name: + anyOf: + - maxLength: 1000 + type: string + - enum: + - '' + type: string description: A name for the location. - maxLength: 1000 - type: string + display_name_kana: + anyOf: + - maxLength: 1000 + type: string + - enum: + - '' + type: string + description: >- + The Kana variation of the name for the location (Japan + only). + display_name_kanji: + anyOf: + - maxLength: 1000 + type: string + - enum: + - '' + type: string + description: >- + The Kanji variation of the name for the location (Japan + only). expand: description: Specifies which fields in the response should be expanded. items: @@ -133961,12 +149244,19 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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`. + phone: + anyOf: + - type: string + - enum: + - '' + type: string + description: The phone number for the location. type: object required: false responses: @@ -133985,6 +149275,75 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Update a Location + /v1/terminal/onboarding_links: + post: + description: >- +

Creates a new OnboardingLink object that contains a + redirect_url used for onboarding onto Tap to Pay on iPhone.

+ operationId: PostTerminalOnboardingLinks + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + link_options: + 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 + link_options: + description: Specific fields needed to generate the desired link type. + properties: + apple_terms_and_conditions: + properties: + allow_relinking: + type: boolean + merchant_display_name: + maxLength: 5000 + type: string + required: + - merchant_display_name + title: apple_terms_and_conditions_params + type: object + title: link_options_params + type: object + link_type: + description: The type of link being generated. + enum: + - apple_terms_and_conditions + type: string + on_behalf_of: + description: Stripe account ID to generate the link for. + maxLength: 5000 + type: string + required: + - link_options + - link_type + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.onboarding_link' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Create an Onboarding Link /v1/terminal/readers: get: description:

Returns a list of Reader objects.

@@ -134000,9 +149359,12 @@ paths: - bbpos_wisepad3 - bbpos_wisepos_e - mobile_phone_reader + - simulated_stripe_s700 + - simulated_stripe_s710 - simulated_wisepos_e - stripe_m2 - stripe_s700 + - stripe_s710 - verifone_P400 type: string x-stripeBypassValidation: true @@ -134178,7 +149540,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -134344,7 +149706,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -134370,7 +149732,10 @@ paths: summary: Update a Reader '/v1/terminal/readers/{reader}/cancel_action': post: - description:

Cancels the current reader action.

+ description: >- +

Cancels the current reader action. See Programmatic + Cancellation for more details.

operationId: PostTerminalReadersReaderCancelAction parameters: - in: path @@ -134412,9 +149777,308 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Cancel the current reader action + '/v1/terminal/readers/{reader}/collect_inputs': + post: + description: >- +

Initiates an input + collection flow on a Reader to display input forms and collect + information from your customers.

+ operationId: PostTerminalReadersReaderCollectInputs + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + inputs: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + inputs: + description: >- + List of inputs to be collected from the customer using the + Reader. Maximum 5 inputs. + items: + properties: + custom_text: + properties: + description: + maxLength: 500 + type: string + skip_button: + maxLength: 14 + type: string + submit_button: + maxLength: 30 + type: string + title: + maxLength: 40 + type: string + required: + - title + title: custom_text_params + type: object + required: + type: boolean + selection: + properties: + choices: + items: + properties: + id: + maxLength: 50 + type: string + style: + enum: + - primary + - secondary + type: string + text: + maxLength: 30 + type: string + required: + - id + - text + title: choice_params + type: object + type: array + required: + - choices + title: selection_params + type: object + toggles: + items: + properties: + default_value: + enum: + - disabled + - enabled + type: string + description: + maxLength: 50 + type: string + title: + maxLength: 50 + type: string + title: toggle_params + type: object + type: array + type: + enum: + - email + - numeric + - phone + - selection + - signature + - text + type: string + required: + - custom_text + - type + title: input_params + type: object + type: array + metadata: + additionalProperties: + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + required: + - inputs + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Collect inputs using a Reader + '/v1/terminal/readers/{reader}/collect_payment_method': + post: + description: >- +

Initiates a payment flow on a Reader and updates the PaymentIntent + with card details before manual confirmation. See Collecting + a Payment method for more details.

+ operationId: PostTerminalReadersReaderCollectPaymentMethod + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + collect_config: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + collect_config: + description: >- + Configuration overrides for this collection, such as + tipping, surcharging, and customer cancellation settings. + properties: + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + enable_customer_cancellation: + type: boolean + skip_tipping: + type: boolean + tipping: + properties: + amount_eligible: + type: integer + title: tipping_config + type: object + title: collect_config + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + payment_intent: + description: The ID of the PaymentIntent to collect a payment method for. + maxLength: 5000 + type: string + required: + - payment_intent + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Hand off a PaymentIntent to a Reader and collect card details + '/v1/terminal/readers/{reader}/confirm_payment_intent': + post: + description: >- +

Finalizes a payment on a Reader. See Confirming + a Payment for more details.

+ operationId: PostTerminalReadersReaderConfirmPaymentIntent + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + confirm_config: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + confirm_config: + description: >- + Configuration overrides for this confirmation, such as + surcharge settings and return URL. + properties: + return_url: + type: string + title: confirm_config + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + payment_intent: + description: The ID of the PaymentIntent to confirm. + maxLength: 5000 + type: string + required: + - payment_intent + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Confirm a PaymentIntent on the Reader '/v1/terminal/readers/{reader}/process_payment_intent': post: - description:

Initiates a payment flow on a Reader.

+ description: >- +

Initiates a payment flow on a Reader. See process + the payment for more details.

operationId: PostTerminalReadersReaderProcessPaymentIntent parameters: - in: path @@ -134444,11 +150108,13 @@ paths: type: string type: array payment_intent: - description: PaymentIntent ID + description: The ID of the PaymentIntent to process on the reader. maxLength: 5000 type: string process_config: - description: Configuration overrides + description: >- + Configuration overrides for this transaction, such as + tipping and customer cancellation settings. properties: allow_redisplay: enum: @@ -134458,6 +150124,8 @@ paths: type: string enable_customer_cancellation: type: boolean + return_url: + type: string skip_tipping: type: boolean tipping: @@ -134488,7 +150156,10 @@ paths: 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.

+ description: >- +

Initiates a SetupIntent flow on a Reader. See Save + directly without charging for more details.

operationId: PostTerminalReadersReaderProcessSetupIntent parameters: - in: path @@ -134530,14 +150201,16 @@ paths: type: string type: array process_config: - description: Configuration overrides + description: >- + Configuration overrides for this setup, such as MOTO and + customer cancellation settings. properties: enable_customer_cancellation: type: boolean title: process_setup_config type: object setup_intent: - description: SetupIntent ID + description: The ID of the SetupIntent to process on the reader. maxLength: 5000 type: string required: @@ -134561,7 +150234,10 @@ paths: summary: Hand-off a SetupIntent to a Reader '/v1/terminal/readers/{reader}/refund_payment': post: - description:

Initiates a refund on a Reader

+ description: >- +

Initiates an in-person refund on a Reader. See Refund + an Interac Payment for more details.

operationId: PostTerminalReadersReaderRefundPayment parameters: - in: path @@ -134607,7 +150283,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -134629,7 +150305,9 @@ paths: created the charge. type: boolean refund_payment_config: - description: Configuration overrides + description: >- + Configuration overrides for this refund, such as customer + cancellation settings. properties: enable_customer_cancellation: type: boolean @@ -134661,7 +150339,9 @@ paths: 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.

+ description: >- +

Sets the reader display to show cart details.

operationId: PostTerminalReadersReaderSetReaderDisplay parameters: - in: path @@ -134685,7 +150365,9 @@ paths: additionalProperties: false properties: cart: - description: Cart + description: >- + Cart details to display on the reader screen, including line + items, amounts, and currency. properties: currency: format: currency @@ -134724,7 +150406,9 @@ paths: type: string type: array type: - description: Type + description: >- + Type of information to display. Only `cart` is currently + supported. enum: - cart type: string @@ -134746,6 +150430,113 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Set reader display + /v1/terminal/refunds: + post: + description: >- +

Internal endpoint for terminal use to create a refund for a + card_present charge. + + This endpoint only supports card_present payment method types (excludes + interac_present).

+ + +

You can optionally refund only part of a charge.

+ operationId: PostTerminalRefunds + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + description: >- + A positive integer in the [smallest currency + unit](https://docs.stripe.com/currencies#zero-decimal) + representing how much of this charge to refund. Can refund + only up to the remaining, unrefunded amount of the charge. + type: integer + charge: + description: The identifier of the charge to refund. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + additionalProperties: + type: string + description: >- + Set of [key-value + pairs](https://docs.stripe.com/api/metadata) that you can + attach to an object. This can be useful for storing + additional information about the object in a structured + format. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + payment_intent: + description: The identifier of the PaymentIntent to refund. + maxLength: 5000 + type: string + reason: + description: >- + String indicating the reason for the refund. If set, + possible values are `duplicate`, `fraudulent`, and + `requested_by_customer`. If you believe the charge to be + fraudulent, specifying `fraudulent` as the reason will add + the associated card and email to your [block + lists](https://docs.stripe.com/radar/lists), and will also + help us improve our fraud detection algorithms. + enum: + - duplicate + - fraudulent + - requested_by_customer + maxLength: 5000 + type: string + refund_application_fee: + description: >- + Boolean indicating whether the application fee should be + refunded when refunding this charge. If a full charge refund + is given, the full application fee will be refunded. + Otherwise, the application fee will be refunded in an amount + proportional to the amount of the charge refunded. An + application fee can be refunded only by the application that + created the charge. + type: boolean + reverse_transfer: + description: >- + Boolean indicating whether the transfer should be reversed + when refunding this charge. The transfer will be reversed + proportionally to the amount being refunded (either the + entire or partial amount).

A transfer can be reversed + only by the application that created the charge. + type: boolean + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.refund' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Create a refund using a Terminal-supported device. /v1/test_helpers/confirmation_tokens: post: description: >- @@ -134762,6 +150553,9 @@ paths: payment_method_data: explode: true style: deepObject + payment_method_options: + explode: true + style: deepObject shipping: explode: true style: deepObject @@ -134853,6 +150647,10 @@ paths: properties: {} title: param type: object + billie: + properties: {} + title: param + type: object billing_details: properties: address: @@ -134901,6 +150699,9 @@ paths: - enum: - '' type: string + tax_id: + maxLength: 5000 + type: string title: billing_details_inner_params type: object blik: @@ -134920,6 +150721,10 @@ paths: properties: {} title: param type: object + crypto: + properties: {} + title: param + type: object customer_balance: properties: {} title: param @@ -135006,11 +150811,15 @@ paths: bank: enum: - abn_amro + - adyen - asn_bank - bunq + - buut + - finom - handelsbanken - ing - knab + - mollie - moneyou - n26 - nn @@ -135063,6 +150872,10 @@ paths: properties: {} title: param type: object + mb_way: + properties: {} + title: param + type: object metadata: additionalProperties: type: string @@ -135085,6 +150898,33 @@ paths: x-stripeBypassValidation: true title: param type: object + nz_bank_account: + properties: + account_holder_name: + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + bank_code: + maxLength: 5000 + type: string + branch_code: + maxLength: 5000 + type: string + reference: + maxLength: 128 + type: string + suffix: + maxLength: 5000 + type: string + required: + - account_number + - bank_code + - branch_code + - suffix + title: param + type: object oxxo: properties: {} title: param @@ -135139,6 +150979,19 @@ paths: properties: {} title: param type: object + payto: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + pay_id: + maxLength: 5000 + type: string + title: param + type: object pix: properties: {} title: param @@ -135162,6 +151015,10 @@ paths: properties: {} title: param type: object + satispay: + properties: {} + title: param + type: object sepa_debit: properties: iban: @@ -135205,9 +151062,11 @@ paths: - au_becs_debit - bacs_debit - bancontact + - billie - blik - boleto - cashapp + - crypto - customer_balance - eps - fpx @@ -135219,19 +151078,23 @@ paths: - konbini - kr_card - link + - mb_way - mobilepay - multibanco - naver_pay + - nz_bank_account - oxxo - p24 - pay_by_bank - payco - paynow - paypal + - payto - pix - promptpay - revolut_pay - samsung_pay + - satispay - sepa_debit - sofort - swish @@ -135276,6 +151139,41 @@ paths: - type title: payment_method_data_params type: object + payment_method_options: + description: >- + Payment-method-specific configuration for this + ConfirmationToken. + properties: + card: + properties: + installments: + properties: + plan: + properties: + count: + type: integer + interval: + enum: + - month + type: string + type: + enum: + - bonus + - fixed_count + - revolving + type: string + required: + - type + title: installment_plan + type: object + required: + - plan + title: installments_param + type: object + title: card_param + type: object + title: test_payment_method_options_param + type: object return_url: description: Return URL used to confirm the Intent. type: string @@ -135286,7 +151184,7 @@ paths: The presence of this property will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) + method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. @@ -135377,7 +151275,7 @@ paths: Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal) + unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency). type: integer @@ -135401,7 +151299,7 @@ paths: references supplied by customers when making bank transfers to their cash balance. You can use this to test how Stripe's [reconciliation - algorithm](https://stripe.com/docs/payments/customer-balance/reconciliation) + algorithm](https://docs.stripe.com/payments/customer-balance/reconciliation) applies to different user inputs. maxLength: 5000 type: string @@ -135450,6 +151348,9 @@ paths: network_data: explode: true style: deepObject + risk_assessment: + explode: true + style: deepObject verification_data: explode: true style: deepObject @@ -135461,13 +151362,13 @@ paths: 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). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer amount_details: description: >- Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). properties: atm_fee: type: integer @@ -135570,6 +151471,17 @@ paths: type: string title: fleet_testmode_authorization_specs type: object + fraud_disputability_likelihood: + description: >- + Probability that this transaction can be disputed in the + event of fraud. Assessed by comparing the characteristics of + the authorization to card network rules. + enum: + - neutral + - unknown + - very_likely + - very_unlikely + type: string fuel: description: >- Information about fuel that was purchased with this @@ -135610,7 +151522,7 @@ paths: is_amount_controllable: description: >- If set `true`, you may provide - [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) + [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean merchant_amount: @@ -135618,7 +151530,7 @@ paths: 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). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer merchant_currency: description: >- @@ -135975,6 +151887,69 @@ paths: type: string title: network_data_specs type: object + risk_assessment: + description: >- + Stripe’s assessment of the fraud risk for this + authorization. + properties: + card_testing_risk: + properties: + invalid_account_number_decline_rate_past_hour: + type: integer + invalid_credentials_decline_rate_past_hour: + type: integer + risk_level: + enum: + - elevated + - highest + - low + - normal + - not_assessed + - unknown + type: string + x-stripeBypassValidation: true + required: + - risk_level + title: card_testing_risk_specs + type: object + fraud_risk: + properties: + level: + enum: + - elevated + - highest + - low + - normal + - not_assessed + - unknown + type: string + x-stripeBypassValidation: true + score: + type: number + required: + - level + title: fraud_risk_specs + type: object + merchant_dispute_risk: + properties: + dispute_rate: + type: integer + risk_level: + enum: + - elevated + - highest + - low + - normal + - not_assessed + - unknown + type: string + x-stripeBypassValidation: true + required: + - risk_level + title: merchant_dispute_risk_specs + type: object + title: risk_assessment_specs + type: object verification_data: description: >- Verifications that Stripe performed on information that the @@ -136098,7 +152073,7 @@ paths: provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer close_authorization: description: >- @@ -136383,7 +152358,7 @@ paths: The final authorization amount that will be captured by the merchant. This amount is in the authorization currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer fleet: description: >- @@ -136594,12 +152569,12 @@ paths: description: >- The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer is_amount_controllable: description: >- If set `true`, you may provide - [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) + [amount](https://docs.stripe.com/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. type: boolean required: @@ -136654,7 +152629,7 @@ paths: provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer type: object required: false @@ -137117,33 +153092,41 @@ paths: maxLength: 5000 type: string type: array - interchange_fees: + interchange_fees_amount: description: >- The total interchange received as reimbursement for the transactions. type: integer - net_total: + net_total_amount: description: The total net amount required to settle with the network. type: integer + network: + description: >- + The card network for this settlement. One of ["visa", + "maestro"] + enum: + - maestro + - visa + type: string network_settlement_identifier: description: >- The Settlement Identification Number assigned by the network. maxLength: 5000 type: string + transaction_amount: + description: The total transaction amount reflected in this settlement. + type: integer transaction_count: description: >- The total number of transactions reflected in this settlement. type: integer - transaction_volume: - description: The total transaction amount reflected in this settlement. - type: integer required: - bin - clearing_date - currency - - net_total + - net_total_amount type: object required: true responses: @@ -137159,7 +153142,52 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - summary: Create a test-mode settleemnt + summary: Create a test-mode settlement + '/v1/test_helpers/issuing/settlements/{settlement}/complete': + post: + description:

Allows the user to mark an Issuing settlement as complete.

+ operationId: PostTestHelpersIssuingSettlementsSettlementComplete + parameters: + - description: The settlement token to mark as complete. + in: path + name: settlement + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.settlement' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Complete a test-mode settlement /v1/test_helpers/issuing/transactions/create_force_capture: post: description: >- @@ -137187,7 +153215,7 @@ paths: The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer card: description: Card associated with this transaction. @@ -137761,7 +153789,7 @@ paths: The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer card: description: Card associated with this unlinked refund transaction. @@ -138342,7 +154370,7 @@ paths: The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer type: object required: false @@ -138422,6 +154450,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + card: + explode: true + style: deepObject card_present: explode: true style: deepObject @@ -138437,6 +154468,25 @@ paths: amount_tip: description: Simulated on-reader tip amount. type: integer + card: + description: Simulated data for the card payment method. + properties: + cvc: + maxLength: 5000 + type: string + exp_month: + type: integer + exp_year: + type: integer + number: + maxLength: 5000 + type: string + required: + - exp_month + - exp_year + - number + title: card + type: object card_present: description: Simulated data for the card_present payment method. properties: @@ -138462,10 +154512,10 @@ paths: type: description: Simulated payment type. enum: + - card - card_present - interac_present type: string - x-stripeBypassValidation: true type: object required: false responses: @@ -138482,6 +154532,106 @@ paths: $ref: '#/components/schemas/error' description: Error response. summary: Simulate presenting a payment method + '/v1/test_helpers/terminal/readers/{reader}/succeed_input_collection': + post: + description: >- +

Use this endpoint to trigger a successful input collection on a + simulated reader.

+ operationId: PostTestHelpersTerminalReadersReaderSucceedInputCollection + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + skip_non_required_inputs: + description: >- + This parameter defines the skip behavior for input + collection. + enum: + - all + - none + type: string + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Simulate a successful input collection + '/v1/test_helpers/terminal/readers/{reader}/timeout_input_collection': + post: + description: >- +

Use this endpoint to complete an input collection with a timeout + error on a simulated reader.

+ operationId: PostTestHelpersTerminalReadersReaderTimeoutInputCollection + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + summary: Simulate an input collection timeout /v1/test_helpers/test_clocks: get: description:

Returns a list of your test clocks.

@@ -139506,7 +155656,7 @@ paths: description: >- Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the - [docs](https://stripe.com/docs/treasury/money-movement/timelines) + [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: @@ -139608,7 +155758,7 @@ paths: description: >- Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the - [docs](https://stripe.com/docs/treasury/money-movement/timelines) + [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. enum: @@ -139815,9 +155965,39 @@ paths: phone: maxLength: 5000 type: string + registration_date: + anyOf: + - properties: + day: + type: integer + month: + type: integer + year: + type: integer + required: + - day + - month + - year + title: registration_date_specs + type: object + - enum: + - '' + type: string registration_number: maxLength: 5000 type: string + representative_declaration: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + maxLength: 5000 + type: string + title: company_representative_declaration + type: object structure: enum: - '' @@ -140202,11 +156382,11 @@ paths: Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access - token](https://stripe.com/docs/connect/standard-accounts) or + token](https://docs.stripe.com/connect/standard-accounts) or [Stripe-Account - header](https://stripe.com/docs/connect/authentication). + header](https://docs.stripe.com/connect/authentication). Learn more about [cloning saved payment - methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). + methods](https://docs.stripe.com/connect/cloning-saved-payment-methods). maxLength: 5000 type: string cvc_update: @@ -140435,7 +156615,9 @@ paths: phone: type: string political_exposure: - maxLength: 5000 + enum: + - existing + - none type: string registered_address: properties: @@ -140486,6 +156668,68 @@ paths: type: object ssn_last_4: type: string + us_cfpb_data: + properties: + ethnicity_details: + properties: + ethnicity: + items: + enum: + - cuban + - hispanic_or_latino + - mexican + - not_hispanic_or_latino + - other_hispanic_or_latino + - prefer_not_to_answer + - puerto_rican + type: string + type: array + ethnicity_other: + maxLength: 5000 + type: string + title: us_cfpb_ethnicity_details_specs + type: object + race_details: + properties: + race: + items: + enum: + - african_american + - american_indian_or_alaska_native + - asian + - asian_indian + - black_or_african_american + - chinese + - ethiopian + - filipino + - guamanian_or_chamorro + - haitian + - jamaican + - japanese + - korean + - native_hawaiian + - native_hawaiian_or_other_pacific_islander + - nigerian + - other_asian + - other_black_or_african_american + - other_pacific_islander + - prefer_not_to_answer + - samoan + - somali + - vietnamese + - white + type: string + type: array + race_other: + maxLength: 5000 + type: string + title: us_cfpb_race_details_specs + type: object + self_identified_gender: + maxLength: 5000 + type: string + title: us_cfpb_data_specs + type: object verification: properties: additional_document: @@ -140793,7 +157037,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -140806,7 +157050,7 @@ paths: account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing - Top-ups](https://stripe.com/docs/connect/testing#testing-top-ups)). + Top-ups](https://docs.stripe.com/connect/testing#testing-top-ups)). maxLength: 5000 type: string statement_descriptor: @@ -140935,7 +157179,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -141206,7 +157450,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -141220,7 +157464,7 @@ paths: balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-availability) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-availability) for details. type: string source_type: @@ -141239,7 +157483,7 @@ paths: description: >- A string that identifies this transaction as part of a group. See the [Connect - documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) + documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. type: string required: @@ -141445,7 +157689,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -141577,7 +157821,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -141708,7 +157952,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -141888,7 +158132,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -142134,7 +158378,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -142270,6 +158514,19 @@ paths: maxLength: 5000 type: string style: form + - description: >- + Only return FinancialAccounts that have the given status: `open` or + `closed` + in: query + name: status + required: false + schema: + enum: + - closed + - open + type: string + x-stripeBypassValidation: true + style: form requestBody: content: application/x-www-form-urlencoded: @@ -142326,8 +158583,8 @@ paths: summary: List all FinancialAccounts post: description: >- -

Creates a new FinancialAccount. For now, each connected account can - only have one FinancialAccount.

+

Creates a new FinancialAccount. Each connected account can have up to + three FinancialAccounts by default.

operationId: PostTreasuryFinancialAccounts requestBody: content: @@ -142402,7 +158659,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_inbound type: object title: inbound_transfers type: object @@ -142422,7 +158679,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_outbound type: object us_domestic_wire: properties: @@ -142442,7 +158699,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_outbound type: object us_domestic_wire: properties: @@ -142461,7 +158718,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -142648,7 +158905,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_inbound type: object title: inbound_transfers type: object @@ -142668,7 +158925,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_outbound type: object us_domestic_wire: properties: @@ -142688,7 +158945,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_outbound type: object us_domestic_wire: properties: @@ -142727,7 +158984,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -142991,7 +159248,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_inbound type: object title: inbound_transfers type: object @@ -143018,7 +159275,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_outbound type: object us_domestic_wire: properties: @@ -143042,7 +159299,7 @@ paths: type: boolean required: - requested - title: access_with_ach_details + title: access_with_ach_details_outbound type: object us_domestic_wire: properties: @@ -143246,7 +159503,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -143262,7 +159519,8 @@ paths: statement_descriptor: description: >- The complete description that appears on your customers' - statements. Maximum 10 characters. + statements. Maximum 10 characters. Can only include -#.$&*, + spaces, and alphanumeric characters. maxLength: 10 type: string required: @@ -143732,7 +159990,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -143745,8 +160003,9 @@ paths: OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 - characters for `stripe` network transfers. The default value - is "payment". + characters for `stripe` network transfers. Can only include + -#.$&*, spaces, and alphanumeric characters. The default + value is "payment". maxLength: 5000 type: string required: @@ -144084,7 +160343,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -144096,7 +160355,8 @@ paths: Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The - default value is "transfer". + default value is "transfer". Can only include -#.$&*, + spaces, and alphanumeric characters. maxLength: 5000 type: string required: @@ -145282,6 +161542,20 @@ paths: - 2024-11-20.acacia - 2024-12-18.acacia - 2025-01-27.acacia + - 2025-02-24.acacia + - 2025-03-01.dashboard + - 2025-03-31.basil + - 2025-04-30.basil + - 2025-05-28.basil + - 2025-06-30.basil + - 2025-07-30.basil + - 2025-08-27.basil + - 2025-09-30.clover + - 2025-10-29.clover + - 2025-11-17.clover + - 2025-12-15.clover + - 2026-01-28.clover + - 2026-02-25.clover maxLength: 5000 type: string x-stripeBypassValidation: true @@ -145317,7 +161591,9 @@ paths: - application_fee.refund.updated - application_fee.refunded - balance.available + - balance_settings.updated - billing.alert.triggered + - billing.credit_grant.created - billing_portal.configuration.created - billing_portal.configuration.updated - billing_portal.session.created @@ -145377,6 +161653,7 @@ paths: - customer_cash_balance_transaction.created - entitlements.active_entitlement_summary.updated - file.created + - financial_connections.account.account_numbers_updated - financial_connections.account.created - financial_connections.account.deactivated - financial_connections.account.disconnected @@ -145384,6 +161661,8 @@ paths: - financial_connections.account.refreshed_balance - financial_connections.account.refreshed_ownership - financial_connections.account.refreshed_transactions + - >- + financial_connections.account.upcoming_account_number_expiry - identity.verification_session.canceled - identity.verification_session.created - identity.verification_session.processing @@ -145396,8 +161675,10 @@ paths: - invoice.finalized - invoice.marked_uncollectible - invoice.overdue + - invoice.overpaid - invoice.paid - invoice.payment_action_required + - invoice.payment_attempt_required - invoice.payment_failed - invoice.payment_succeeded - invoice.sent @@ -145405,6 +161686,7 @@ paths: - invoice.updated - invoice.voided - invoice.will_be_due + - invoice_payment.paid - invoiceitem.created - invoiceitem.deleted - issuing_authorization.created @@ -145476,6 +161758,13 @@ paths: - reporting.report_run.failed - reporting.report_run.succeeded - reporting.report_type.updated + - reserve.hold.created + - reserve.hold.updated + - reserve.plan.created + - reserve.plan.disabled + - reserve.plan.expired + - reserve.plan.updated + - reserve.release.created - review.closed - review.opened - setup_intent.canceled @@ -145503,6 +161792,7 @@ paths: - tax_rate.updated - terminal.reader.action_failed - terminal.reader.action_succeeded + - terminal.reader.action_updated - test_helpers.test_clock.advancing - test_helpers.test_clock.created - test_helpers.test_clock.deleted @@ -145565,7 +161855,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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 @@ -145738,7 +162028,9 @@ paths: - application_fee.refund.updated - application_fee.refunded - balance.available + - balance_settings.updated - billing.alert.triggered + - billing.credit_grant.created - billing_portal.configuration.created - billing_portal.configuration.updated - billing_portal.session.created @@ -145798,6 +162090,7 @@ paths: - customer_cash_balance_transaction.created - entitlements.active_entitlement_summary.updated - file.created + - financial_connections.account.account_numbers_updated - financial_connections.account.created - financial_connections.account.deactivated - financial_connections.account.disconnected @@ -145805,6 +162098,8 @@ paths: - financial_connections.account.refreshed_balance - financial_connections.account.refreshed_ownership - financial_connections.account.refreshed_transactions + - >- + financial_connections.account.upcoming_account_number_expiry - identity.verification_session.canceled - identity.verification_session.created - identity.verification_session.processing @@ -145817,8 +162112,10 @@ paths: - invoice.finalized - invoice.marked_uncollectible - invoice.overdue + - invoice.overpaid - invoice.paid - invoice.payment_action_required + - invoice.payment_attempt_required - invoice.payment_failed - invoice.payment_succeeded - invoice.sent @@ -145826,6 +162123,7 @@ paths: - invoice.updated - invoice.voided - invoice.will_be_due + - invoice_payment.paid - invoiceitem.created - invoiceitem.deleted - issuing_authorization.created @@ -145897,6 +162195,13 @@ paths: - reporting.report_run.failed - reporting.report_run.succeeded - reporting.report_type.updated + - reserve.hold.created + - reserve.hold.updated + - reserve.plan.created + - reserve.plan.disabled + - reserve.plan.expired + - reserve.plan.updated + - reserve.release.created - review.closed - review.opened - setup_intent.canceled @@ -145924,6 +162229,7 @@ paths: - tax_rate.updated - terminal.reader.action_failed - terminal.reader.action_succeeded + - terminal.reader.action_updated - test_helpers.test_clock.advancing - test_helpers.test_clock.created - test_helpers.test_clock.deleted @@ -145986,7 +162292,7 @@ paths: type: string description: >- Set of [key-value - pairs](https://stripe.com/docs/api/metadata) that you can + pairs](https://docs.stripe.com/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